Add support for Falcon Resource suffixes (#19)

Author: henryh9n

.gitignore

@@ -108,3 +108,7 @@ venv.bak/
 .vscode
 .envrc
 todo.md
+
+# PYCharm
+.idea/
+

falcon_apispec/falcon_plugin.py

@@ -2,7 +2,6 @@
 import re
 from apispec import BasePlugin, yaml_utils
 from apispec.exceptions import APISpecError
-import falcon
 
 
 class FalconPlugin(BasePlugin):
@@ -20,7 +19,17 @@ def _generate_resource_uri_mapping(app):
         for route in routes_to_check:
             uri = route.uri_template
             resource = route.resource
-            mapping[resource] = uri
+            mapping[resource] = {
+                "uri": uri,
+                "methods": {}
+            }
+
+            if route.method_map:
+                for method_name, method_handler in route.method_map.items():
+                    if method_handler.__dict__.get("__module__") == "falcon.responders":
+                        continue
+                    mapping[resource]["methods"][method_name.lower()] = method_handler
+
             routes_to_check.extend(route.children)
         return mapping
 
@@ -32,19 +41,17 @@ def path_helper(self, operations, resource, base_path=None, **kwargs):
             raise APISpecError("Could not find endpoint for resource {0}".format(resource))
 
         operations.update(yaml_utils.load_operations_from_docstring(resource.__doc__) or {})
-        path = resource_uri_mapping[resource]
+        path = resource_uri_mapping[resource]["uri"]
 
         if base_path is not None:
             # make sure base_path accept either with or without leading slash
             # swagger 2 usually come with leading slash but not in openapi 3.x.x
             base_path = '/' + base_path.strip('/')
             path = re.sub(base_path, "", path, 1)
 
-        for method in falcon.constants.HTTP_METHODS:
-            http_verb = method.lower()
-            method_name = "on_" + http_verb
-            if getattr(resource, method_name, None) is not None:
-                method = getattr(resource, method_name)
-                docstring_yaml = yaml_utils.load_yaml_from_docstring(method.__doc__)
-                operations[http_verb] = docstring_yaml or dict()
+        methods = resource_uri_mapping[resource]["methods"]
+
+        for method_name, method_handler in methods.items():
+            docstring_yaml = yaml_utils.load_yaml_from_docstring(method_handler.__doc__)
+            operations[method_name] = docstring_yaml or dict()
         return path

tests/falcon_test.py

@@ -1,7 +1,8 @@
-import pytest
-
 import falcon
+import pytest
 from apispec import APISpec
+from apispec.exceptions import APISpecError
+
 from falcon_apispec import FalconPlugin
 
 
@@ -137,3 +138,56 @@ def on_get(self, req, resp):
         spec.path(resource=hello_resource, base_path=base_path)
 
         assert spec._paths["/foo/v1"]["get"] == expected
+
+    def test_path_with_suffix(self, app, spec_factory):
+        class HelloResource:
+            def on_get_hello(self):
+                """A greeting endpoint.
+                ---
+                description: get a greeting
+                responses:
+                    200:
+                        description: said hi
+                """
+                return "dummy"
+
+            def on_get(self):
+                """An invalid method.
+                ---
+                description: this should not pass
+                responses:
+                    200:
+                        description: said hi
+                """
+                return "invalid"
+
+        expected = {
+            "description": "get a greeting",
+            "responses": {"200": {"description": "said hi"}},
+        }
+
+        hello_resource_with_suffix = HelloResource()
+        app.add_route("/hi", hello_resource_with_suffix, suffix="hello")
+
+        spec = spec_factory(app)
+        spec.path(resource=hello_resource_with_suffix)
+
+        assert spec._paths["/hi"]["get"] == expected
+
+    def test_resource_without_endpoint(self, app, spec_factory):
+        class HelloResource:
+            def on_get(self, req, resp):
+                """A greeting endpoint.
+                ---
+                description: get a greeting
+                responses:
+                    200:
+                        description: said hi
+                """
+                return "dummy"
+
+        hello_resource = HelloResource()
+        spec = spec_factory(app)
+
+        with pytest.raises(APISpecError):
+            spec.path(resource=hello_resource)