Merge pull request #817 from hugapi/develop

Release 2.5.6

Author: timothycrosley

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.5.5
+current_version = 2.5.6
 
 [bumpversion:file:.env]
 

.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:

.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

ACKNOWLEDGEMENTS.md

@@ -51,7 +51,7 @@ Code Contributors
 - Stanislav (@atmo)
 - Lordran (@xzycn)
 - Stephan Fitzpatrick (@knowsuchagency)
-
+- Edvard Majakari (@EdvardM)
 
 Documenters
 ===================

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

hug/_version.py

@@ -21,4 +21,4 @@
 """
 from __future__ import absolute_import
 
-current = "2.5.5"
+current = "2.5.6"

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)

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
 

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"]

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,