fb

stripe/api_resources/abstract/test_helpers.py

@@ -2,9 +2,15 @@
 
 from stripe import error, util, six
 from stripe.six.moves.urllib.parse import quote_plus
+from stripe.api_resources.abstract import APIResource
 
 
 class APIResourceTestHelpers:
+    """
+    The base type for the TestHelper nested classes.
+    Handles request URL generation for test_helper custom methods.
+    """
+
     def __init__(self, resource):
         self.resource = resource
 
@@ -38,9 +44,28 @@ def instance_url(self):
 
 
 def test_helpers(cls):
+    """
+    test_helpers decorator adds a test_helpers property and
+    wires the parent resource class to the nested TestHelpers class.
+
+    Should only be used on types that inherit from APIResource
+
+    @test_helpers
+    class Foo(APIResource):
+
+      class TestHelpers(APIResourceTestHelpers):
+
+    """
+
     def test_helpers_getter(self):
         return self.TestHelpers(self)
 
+    if not issubclass(cls, APIResource):
+        raise ValueError(
+            "Could not apply @test_helpers decorator to %r."
+            " The class should a subclass of APIResource." % cls
+        )
+
     cls.TestHelpers._resource_cls = cls
     cls.TestHelpers._static_request = cls._static_request
     cls.TestHelpers._static_request_stream = cls._static_request_stream

tests/api_resources/abstract/test_test_helpers_api_resource.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, division, print_function
 
 import stripe
+import pytest
 from stripe import util
 from stripe.api_resources.abstract import APIResourceTestHelpers
 
@@ -42,7 +43,7 @@ def test_call_custom_method_class(self, request_mock):
         )
         assert obj.thing_done is True
 
-    def test_call_custom_method_instance(self, request_mock):
+    def test_call_custom_method_instance_via_property(self, request_mock):
         request_mock.stub_request(
             "post",
             "/v1/test_helpers/myresources/mid/do_the_thing",
@@ -59,3 +60,7 @@ def test_call_custom_method_instance(self, request_mock):
             {"foo": "bar"},
         )
         assert obj.thing_done is True
+
+    def test_helper_decorator_raises_for_non_resource(self):
+        with pytest.raises(ValueError):
+            stripe.api_resources.abstract.test_helpers(str)