Merge pull request #817 from hugapi/develop

timothycrosley · web-flow · commit 180ee00a5ae5 · 2019-06-20T19:19:43.000-07:00
Release 2.5.6
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.5.5
+current_version = 2.5.6
 
 [bumpversion:file:.env]
 
diff --git a/.coveragerc b/.coveragerc
@@ -7,3 +7,5 @@ exclude_lines = def hug
                 sys.stdout.buffer.write
                 class Socket
                 pragma: no cover
+                except ImportError:
+                if MARSHMALLOW_MAJOR_VERSION is None or MARSHMALLOW_MAJOR_VERSION == 2:
diff --git a/.env b/.env
@@ -11,7 +11,7 @@ fi
 
 export PROJECT_NAME=$OPEN_PROJECT_NAME
 export PROJECT_DIR="$PWD"
-export PROJECT_VERSION="2.5.5"
+export PROJECT_VERSION="2.5.6"
 
 if [ ! -d "venv" ]; then
      if ! hash pyvenv 2>/dev/null; then
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
@@ -51,7 +51,7 @@ Code Contributors
 - Stanislav (@atmo)
 - Lordran (@xzycn)
 - Stephan Fitzpatrick (@knowsuchagency)
-
+- Edvard Majakari (@EdvardM)
 
 Documenters
 ===================
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,10 @@ Ideally, within a virtual environment.
 
 Changelog
 =========
+### 2.5.6 - June 20, 2019
+- Fixed issue #815: map_params() causes api documentation to lose param type information
+- Improved project testing: restoring 100% coverage
+
 ### 2.5.5 - June 13, 2019
 - Fixed issue #808: Problems with command line invocation via hug CLI
 - Fixed issue #647: Support for arbitrary URL complexity when using CORS middleware
diff --git a/hug/_version.py b/hug/_version.py
@@ -21,4 +21,4 @@
 """
 from __future__ import absolute_import
 
-current = "2.5.5"
+current = "2.5.6"
diff --git a/hug/api.py b/hug/api.py
@@ -348,8 +348,7 @@ def version_router(
         self, request, response, api_version=None, versions=None, not_found=None, **kwargs
     ):
         """Intelligently routes a request to the correct handler based on the version being requested"""
-        if versions is None:
-            versions = {}
+        versions = {} if versions is None else versions
         request_version = self.determine_version(request, api_version)
         if request_version:
             request_version = int(request_version)
diff --git a/hug/interface.py b/hug/interface.py
@@ -212,6 +212,7 @@ def __init__(self, route, function):
                 for name, transform in self.interface.input_transformations.items()
             }
         else:
+            self.map_params = {}
             self.input_transformations = self.interface.input_transformations
 
         if "output" in route:
@@ -323,7 +324,7 @@ def documentation(self, add_to=None):
             inputs = doc.setdefault("inputs", OrderedDict())
             types = self.interface.spec.__annotations__
             for argument in parameters:
-                kind = types.get(argument, text)
+                kind = types.get(self._remap_entry(argument), text)
                 if getattr(kind, "directive", None) is True:
                     continue
 
@@ -340,6 +341,9 @@ def _rewrite_params(self, params):
             if interface_name in params:
                 params[internal_name] = params.pop(interface_name)
 
+    def _remap_entry(self, interface_name):
+        return self.map_params.get(interface_name, interface_name)
+
     @staticmethod
     def cleanup_parameters(parameters, exception=None):
         for _parameter, directive in parameters.items():
@@ -417,8 +421,7 @@ def __call__(self, *args, **kwargs):
                 self.api.delete_context(context, errors=errors)
                 return outputs(errors) if outputs else errors
 
-        if getattr(self, "map_params", None):
-            self._rewrite_params(kwargs)
+        self._rewrite_params(kwargs)
         try:
             result = self.interface(**kwargs)
             if self.transform:
@@ -617,8 +620,7 @@ def exit_callback(message):
                     elif add_options_to:
                         pass_to_function[add_options_to].append(option)
 
-        if getattr(self, "map_params", None):
-            self._rewrite_params(pass_to_function)
+        self._rewrite_params(pass_to_function)
 
         try:
             if args:
@@ -816,8 +818,7 @@ def call_function(self, parameters):
             parameters = {
                 key: value for key, value in parameters.items() if key in self.all_parameters
             }
-        if getattr(self, "map_params", None):
-            self._rewrite_params(parameters)
+        self._rewrite_params(parameters)
 
         return self.interface(**parameters)
 
@@ -854,7 +855,7 @@ def render_content(self, content, context, request, response, **kwargs):
                 if size:
                     response.set_stream(content, size)
                 else:
-                    response.stream = content
+                    response.stream = content  # pragma: no cover
         else:
             response.data = content
 
diff --git a/hug/routing.py b/hug/routing.py
@@ -317,7 +317,7 @@ def allow_origins(
         response_headers = {}
         if origins:
 
-            @hug.response_middleware()
+            @hug.response_middleware(api=self.route.get("api", None))
             def process_data(request, response, resource):
                 if "ORIGIN" in request.headers:
                     origin = request.headers["ORIGIN"]
diff --git a/setup.py b/setup.py
@@ -78,7 +78,7 @@ def list_modules(dirname):
 
 setup(
     name="hug",
-    version="2.5.5",
+    version="2.5.6",
     description="A Python framework that makes developing APIs "
     "as simple as possible, but no simpler.",
     long_description=long_description,
diff --git a/tests/test_decorators.py b/tests/test_decorators.py
@@ -1042,17 +1042,14 @@ def extend_with():
     def extend_with():
         return (tests.module_fake_http_and_cli,)
 
-    assert hug.test.cli("sub_api", "made_up_go", api=api)
-
     # But not both
     with pytest.raises(ValueError):
-
         @hug.extend_api(sub_command="sub_api", command_prefix="api_", http=False)
         def extend_with():
             return (tests.module_fake_http_and_cli,)
 
 
-def test_extending_api_with_http_and_cli():
+def test_extending_api_with_http_and_cli_sub_module():
     """Test to ensure it's possible to extend the current API so both HTTP and CLI APIs are extended"""
     import tests.module_fake_http_and_cli
 
@@ -1579,20 +1576,25 @@ def test_multiple_cli(ints: hug.types.Multiple[int]() = []):
     assert hug.test.cli(test_multiple_cli, ints=["1", "2", "3"]) == [1, 2, 3]
 
 
-def test_startup():
+def test_startup(hug_api):
     """Test to ensure hug startup decorators work as expected"""
+    happened_on_startup = []
 
-    @hug.startup()
+    @hug.startup(api=hug_api)
     def happens_on_startup(api):
-        pass
+        happened_on_startup.append("non-async")
 
-    @hug.startup()
+    @hug.startup(api=hug_api)
     @asyncio.coroutine
     def async_happens_on_startup(api):
-        pass
+        happened_on_startup.append("async")
+
+    assert happens_on_startup in hug_api.startup_handlers
+    assert async_happens_on_startup in hug_api.startup_handlers
 
-    assert happens_on_startup in api.startup_handlers
-    assert async_happens_on_startup in api.startup_handlers
+    hug_api._ensure_started()
+    assert "async" in happened_on_startup
+    assert "non-async" in happened_on_startup
 
 
 @pytest.mark.skipif(sys.platform == "win32", reason="Currently failing on Windows build")
diff --git a/tests/test_documentation.py b/tests/test_documentation.py
@@ -185,3 +185,11 @@ def marshtest() -> Returns():
     doc = api.http.documentation()
 
     assert doc["handlers"]["/marshtest"]["POST"]["outputs"]["type"] == "Return docs"
+
+def test_map_params_documentation_preserves_type():
+    @hug.get(map_params={"from": "from_mapped"})
+    def map_params_test(from_mapped: hug.types.number):
+        pass
+
+    doc = api.http.documentation()
+    assert doc["handlers"]["/map_params_test"]["GET"]["inputs"]["from"]["type"] == "A whole number"
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -0,0 +1,28 @@
+"""tests/test_main.py.
+
+Basic testing of hug's `__main__` module
+
+Copyright (C) 2016 Timothy Edmund Crosley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+"""
+import pytest
+
+
+def test_main(capsys):
+    """Main module should be importable, but should raise a SystemExit after CLI docs print"""
+    with pytest.raises(SystemExit):
+        from hug import __main__
diff --git a/tests/test_routing.py b/tests/test_routing.py
@@ -406,3 +406,16 @@ def test_prefixes(self):
     def test_suffixes(self):
         """Test to ensure setting suffixes works as expected"""
         assert self.route.suffixes(".js", ".xml").route["suffixes"] == (".js", ".xml")
+
+    def test_allow_origins_request_handling(self, hug_api):
+        """Test to ensure a route with allowed origins works as expected"""
+        route = URLRouter(api=hug_api)
+        test_headers = route.allow_origins(
+            "google.com", methods=("GET", "POST"), credentials=True, headers="OPTIONS", max_age=10
+        )
+
+        @test_headers.get()
+        def my_endpoint():
+            return "Success"
+
+        assert hug.test.get(hug_api, "/my_endpoint", headers={'ORIGIN': 'google.com'}).data == "Success"
diff --git a/tests/test_types.py b/tests/test_types.py
@@ -320,6 +320,10 @@ def test_json():
     with pytest.raises(ValueError):
         hug.types.json("Invalid JSON")
 
+    assert hug.types.json(json.dumps(["a", "b"]).split(",")) == ["a", "b"]
+    with pytest.raises(ValueError):
+        assert hug.types.json(["Invalid JSON", "Invalid JSON"])
+
 
 def test_multi():
     """Test to ensure that the multi type correctly handles a variety of value types"""
diff --git a/tox.ini b/tox.ini
@@ -5,23 +5,23 @@ envlist=py{35,36,37,py3}-marshmallow{2,3}, cython-marshmallow{2,3}
 deps=
     -rrequirements/build_common.txt
     marshmallow2: marshmallow <3.0
-    marshmallow3: marshmallow >=3.0.0rc5
+    marshmallow3: marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
-commands=py.test --cov-report html --cov hug -n auto tests
+commands=py.test --durations 3 --cov-report html --cov hug -n auto tests
 
 [testenv:py37-black]
 deps=
     -rrequirements/build_style_tools.txt
-    marshmallow >=3.0.0rc5
+    marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
 commands=black --check --verbose -l 100 hug
 
 [testenv:py37-vulture]
 deps=
     -rrequirements/build_style_tools.txt
-    marshmallow >=3.0.0rc5
+    marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
 commands=vulture hug --min-confidence 100 --ignore-names req_succeeded
@@ -30,23 +30,23 @@ commands=vulture hug --min-confidence 100 --ignore-names req_succeeded
 [testenv:py37-flake8]
 deps=
     -rrequirements/build_style_tools.txt
-    marshmallow >=3.0.0rc5
+    marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
 commands=flake8 hug
 
 [testenv:py37-bandit]
 deps=
     -rrequirements/build_style_tools.txt
-    marshmallow >=3.0.0rc5
+    marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
 commands=bandit -r hug/ -ll
 
 [testenv:py37-isort]
 deps=
     -rrequirements/build_style_tools.txt
-    marshmallow >=3.0.0rc5
+    marshmallow==3.0.0rc6
 
 whitelist_externals=flake8
 commands=isort -c --diff --recursive hug
