Adding Service Subscription and Service Plan resources and tests for Service Subscription

Author: joscasta

tests/integration/conftest.py

@@ -11,9 +11,9 @@
 import threescale_api
 from threescale_api.resources import (Service, ApplicationPlan, Application,
                                       Proxy, Backend, Metric, MappingRule,
-                                      BackendMappingRule, BackendUsage,
+                                      BackendMappingRule, Account, BackendUsage,
                                       ActiveDoc, Webhooks, InvoiceState,
-                                      ApplicationKey, ApplicationPlans, AccountUser, AccountUsers)
+                                      ApplicationKey, ApplicationPlans, AccountUser, AccountUsers, ServiceSubscription)
 
 load_dotenv()
 
@@ -148,6 +148,16 @@ def account_user(account,account_user_params) -> AccountUser:
     yield user
     cleanup(user)
 
+@pytest.fixture(scope='module')
+def service_subscription_params(account) -> dict:
+    #suffix = get_suffix()
+    return dict(plan_id=account['id'])
+
+@pytest.fixture(scope='module')
+def service_subscription(account, service_subscription_params) -> ServiceSubscription:
+    resource = account.service_subscriptions.create(params=service_subscription_params)
+    yield resource
+
 @pytest.fixture(scope='module')
 def application_plan_params() -> dict:
     suffix = get_suffix()

tests/integration/test_integration_service_subscriptions.py

@@ -0,0 +1,39 @@
+import pytest
+import backoff
+
+from tests.integration.conftest import account
+from threescale_api.errors import ApiClientError
+
+from tests.integration import asserts
+
+def test_should_create_service_subscription(account, service_subscription, service_subscription_params):
+
+    account.service_subscriptions.create(params=service_subscription_params)
+    resource = service_subscription.get(service_subscription_params)
+    asserts.assert_resource(resource)
+    asserts.assert_resource_params(account, service_subscription_params, [param for param in service_subscription_params.keys() if param != 'id'])
+
+def test_should_read_service_subscription(account, service_subscription, service_subscription_params):
+    resource = account.service_subscriptions.get(params=service_subscription_params)
+    asserts.assert_resource(resource)
+    asserts.assert_resource_params(resource, service_subscription_params, [param for param in service_subscription_params.keys() if param != 'id'])
+
+#def test_should_update_service_subscription(account, service_subscription, service_subscription_params):
+#    service_subscription_params['plan_id'] = 100
+#    resource = account.service_subscriptions.update(service_subscription.entity_id, service_subscription_params)
+#    asserts.assert_resource(resource)
+#    asserts.assert_resource_params(resource, service_subscription_params, [param for param in service_subscription_params.keys() if param != 'id'])
+#    resource_updated = account.service_subscription.read(params=service_subscription_params)
+#    asserts.assert_resource(resource_updated)
+#    asserts.assert_resource_params(resource_updated, service_subscription_params, [param for param in service_subscription_params.keys() if param != 'id'])
+
+#def test_should_approve_service_subscription(account, service_subscription, service_subscription_params):
+#    resource = account.service_subscriptions.approve_service_subscription(params=service_subscription_params)
+#    asserts.assert_resource(resource)
+#    read = account.service_subscriptions.read(service_subscription.entity_id)
+#    asserts.assert_resource(read)
+
+def test_list_service_subscriptions(account):
+    resource = account.service_subscriptions.list()
+    assert len(resource) >= 1
+

threescale_api/resources.py

@@ -3,6 +3,8 @@
 from typing import Dict, Union, List, Iterable
 from urllib.parse import quote_plus
 
+from dill.pointers import parent
+
 from threescale_api import auth
 from threescale_api import utils
 from threescale_api import errors
@@ -273,6 +275,59 @@ def pending(self, entity_id, **kwargs) -> 'Account':
         """
         return self.set_state(entity_id=entity_id, state='make_pending', **kwargs)
 
+class ServiceSubscriptions(DefaultClient):
+    def __init__(self, *args, entity_name='service_subscription', entity_collection='service_subscriptions',
+                 per_page=None, **kwargs):
+        super().__init__(*args, entity_name=entity_name,
+                         entity_collection=entity_collection, **kwargs)
+
+    @property
+    def url(self) -> str:
+        return self.parent.url + '/service_subscriptions'
+
+    def approve_service_subscription(self, entity_id: int, **kwargs):
+        url = self.url + f"/{entity_id}/approve.json"
+        response = self.rest.put(url=url, **kwargs)
+        instance = utils.extract_response(response=response)
+        return instance
+
+    def change_plan_service_subscription(self, entity_id: int, plan_id: int, **kwargs):
+        params = dict(plan_id=plan_id)
+        url = self.url + f"/{entity_id}/change_plan.json"
+        response = self.rest.put(url=url, json=params, **kwargs)
+        instance = utils.extract_response(response=response)
+        return instance
+
+class ServicePlans(DefaultClient):
+    def __init__(self, *args, entity_name='service_plan', entity_collection='service_plans', per_page=None, **kwargs):
+        super().__init__(*args, entity_name=entity_name,
+                         entity_collection=entity_collection, **kwargs)
+
+    def url(self) -> str:
+        if type(self.parent) is Service:
+            return self.parent.url + '/service_plans'
+        return self.threescale_client.admin_api_url + '/service_plans'
+
+    def service_plans_features_list(self, entity_id: int, **kwargs):
+        url = self.url + f"/{entity_id}/features.xml"
+        response = self.rest.get(url=url)
+        instance = utils.extract_response(response)
+        return instance
+
+    def service_plan_add_feature(self, entity_id: int, feature_id: int, **kwargs):
+        params = dict(feature_id=feature_id)
+        url = self.url + f"/{entity_id}/features.xml"
+        response = self.rest.post(url=url, json=params, **kwargs)
+        instance = utils.extract_response(response=response)
+        return instance
+
+    def service_plan_delete_feature(self, entity_id: int, id: int, **kwargs):
+        params = dict(id=id)
+        url = self.url + f"/{entity_id}/features/{id}.xml"
+        response = self.rest.delete(url=url, json=params, **kwargs)
+        instance = utils.extract_response(response=response)
+        return instance
+
 
 class Applications(DefaultStateClient):
     def __init__(self, *args, entity_name='application', entity_collection='applications',
@@ -1138,6 +1193,16 @@ def service(self) -> 'Service':
     def backend(self) -> 'Backend':
         return self.metric.parent
 
+class ServiceSubscription(DefaultResource):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    def approve_service_subscription(self, entity_id: int, **kwargs):
+        return self.client.approve_service_subscription(entity_id=self.entity_id, **kwargs)
+
+    def change_plan_service_subscription(self, entity_id: int, **kwargs):
+        return self.client.change_plan_service_subscription(entity_id=self.entity_id, **kwargs)
+
 
 class Metric(DefaultResource):
     def __init__(self, entity_name='system_name', **kwargs):
@@ -1249,6 +1314,10 @@ def app_plans(self) -> ApplicationPlans:
     def metrics(self) -> Metrics:
         return Metrics(parent=self, instance_klass=Metric)
 
+    @property
+    def service_plans(self) -> ServicePlans:
+        return ServicePlans(parent=self, instance_klass=ServicePlan)
+
     @property
     def proxy(self) -> 'Proxies':
         return Proxies(parent=self, instance_klass=Proxy)
@@ -1455,6 +1524,22 @@ def test_request(self, relpath=None, verify: bool = None):
 
         return client.get(relpath)
 
+class ServicePlan(DefaultResource):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    def service_plan_list(self, **kwargs):
+        return self.client.service_plan_list(self, **kwargs)
+
+    def service_plan_features_list(self, entity_id: int, **kwargs):
+        return self.client.service_plan_features_list(entity_id=self.entity_id, **kwargs)
+
+    def service_plan_add_feature(self, entity_id: int, id: int, **kwargs):
+        return self.client.service_plan_add_feature(entity_id=id, id=id, **kwargs)
+
+    def service_plan_delete_feature(self, entity_id: int, id: int, **kwargs):
+        return self.client.service_plan_delete_feature(entity_id=entity_id, id=id, **kwargs)
+
 
 class ApplicationKey(DefaultResource):
     def __init__(self, entity_name='', **kwargs):
@@ -1473,6 +1558,10 @@ def applications(self) -> Applications:
     def users(self) -> AccountUsers:
         return AccountUsers(parent=self, instance_klass=AccountUser)
 
+    @property
+    def service_subscriptions(self) -> ServiceSubscriptions:
+        return ServiceSubscriptions(parent=self, instance_klass=ServiceSubscription)
+
     def credit_card_set(self, params: dict = None, **kwargs):
         url = self.url + "/credit_card"
         response = self.client.rest.put(url=url, json=params, **kwargs)