Merge pull request #16 from Moesif/add-subscriptions-support

matthewtanner91 · web-flow · commit 302f2a536d71 · 2024-02-29T15:05:44.000-05:00
add subscriptions support and move from Nose to pytest
diff --git a/README.md b/README.md
@@ -309,6 +309,84 @@ companies = [{
 update_company = api_client.update_companies(companies)
 ```
 
+## Update a Single Subscription
+
+Create or update a subscription profile in Moesif. The metadata field can store any subscription-related information you wish to keep. The `subscription_id`, `company_id`, and `status` fields are all required. This method is a convenient helper that calls the Moesif API library. For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-a-subscription).
+
+```python
+from moesifapi.moesif_api_client import *
+from moesifapi.models import *
+from datetime import datetime, timedelta
+
+api_client = MoesifAPIClient("YOUR_COLLECTOR_APPLICATION_ID").api
+
+# Required fields for a subscription update
+subscription = {
+  'subscription_id': 'sub_3456',
+  'company_id': '67890',
+  'current_period_start': datetime.utcnow(),
+  'current_period_end': datetime.utcnow() + timedelta(days=30),
+  'status': 'active',
+  # Optional metadata can be any custom object
+  'metadata': {
+    'string_field': 'value_1',
+    'number_field': 0,
+    'object_field': {
+      'field_1': 'value_1',
+      'field_2': 'value_2'
+    }
+  }
+}
+
+update_subscription = api_client.update_subscription(subscription)
+```
+
+## Update Subscriptions in Batch
+
+Similar to `updateSubscription`, but used to update a list of subscriptions in one batch. The `subscription_id`, `company_id`, and `status` fields are required for each subscription in the list. This method is a convenient helper that calls the Moesif API library. For details, visit the [Python API Reference](https://www.moesif.com/docs/api?python#update-subscriptions-in-batch).
+
+```python
+from moesifapi.moesif_api_client import *
+from moesifapi.models import *
+from datetime import datetime, timedelta
+
+api_client = MoesifAPIClient("YOUR_COLLECTOR_APPLICATION_ID").api
+
+# Required fields for subscription updates in a batch
+subscriptions = [{
+  'subscription_id': 'sub_3456',
+  'company_id': '67890',
+  'current_period_start': datetime.utcnow(),
+  'current_period_end': datetime.utcnow() + timedelta(days=30),
+  'status': 'active',
+  # Optional metadata can be any custom object
+  'metadata': {
+    'string_field': 'value_1',
+    'number_field': 0,
+    'object_field': {
+      'field_1': 'value_1',
+      'field_2': 'value_2'
+    }
+  }
+}, {
+  'subscription_id': 'sub_34567',
+  'company_id': '6789',
+  'current_period_start': datetime.utcnow(),
+  'current_period_end': datetime.utcnow() + timedelta(days=30),
+  'status': 'active',
+  'metadata': {
+    'string_field': 'value_1',
+    'number_field': 0,
+    'object_field': {
+      'field_1': 'value_1',
+      'field_2': 'value_2'
+    }
+  }
+}]
+
+update_subscriptions = api_client.update_subscriptions_batch(subscriptions)
+```
+
 ## How to test:
 
 You can test the SDK with automatically generated test
@@ -319,7 +397,7 @@ runner. You can run the tests as follows:
   2. From terminal/cmd navigate to the root directory of the SDK.
   3. Invoke 'pip install -r requirements.txt'
   4. Add your own application id to 'test/controllers/controller_test_base'
-  5. Invoke 'nosetests tests/controllers/test_api_controller.py'
+  5. Invoke 'pytest tests/controllers/test_api_controller.py'
 
   [ico-built-for]: https://img.shields.io/badge/built%20for-python-blue.svg
   [ico-version]: https://img.shields.io/pypi/v/moesifapi.svg
diff --git a/moesifapi/controllers/api_controller.py b/moesifapi/controllers/api_controller.py
@@ -458,3 +458,116 @@ def update_companies_batch(self,
 
         # Global error handling using HTTP status codes.
         self.validate_response(_context)
+
+    def update_subscription(self,
+                            body):
+        """Does a POST request to /v1/subscriptions.
+
+        Update a single subscription
+
+        Args:
+            body (SubscriptionModel): TODO: type description here. Example:
+
+        Returns:
+            void: Response from the API. success
+
+        Raises:
+            APIException: When an error occurs while fetching the data from
+                the remote API. This exception includes the HTTP Response
+                code, an error message, and the HTTP body that was received in
+                the request.
+
+        """
+
+        # The base uri for api requests
+        _query_builder = Configuration.BASE_URI
+
+        # Prepare query string for API call
+        _query_builder += '/v1/subscriptions'
+
+        # Validate and preprocess url
+        _query_url = APIHelper.clean_url(_query_builder)
+
+        # Prepare headers
+        _headers = {
+            'content-type': 'application/json; charset=utf-8',
+            'X-Moesif-Application-Id': Configuration.application_id,
+            'User-Agent': Configuration.version,
+        }
+
+        # Prepare the API call.
+        _request = self.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
+
+        # Invoke the on before request HttpCallBack if specified
+        if self.http_call_back is not None:
+            self.http_call_back.on_before_request(_request)
+
+        # Invoke the API call  to fetch the response.
+        _response = self.http_client.execute_as_string(_request)
+
+        # Wrap the request and the response in an HttpContext object
+        _context = HttpContext(_request, _response)
+
+        # Invoke the on after response HttpCallBack if specified
+        if self.http_call_back is not None:
+            self.http_call_back.on_after_response(_context)
+
+        # Global error handling using HTTP status codes.
+        self.validate_response(_context)
+
+    def update_subscriptions_batch(self, body):
+        """Does a POST request to /v1/subscriptions/batch.
+
+        Update multiple subscriptions in a single batch (batch size must be less
+        than 250kb)
+
+        Args:
+            body (list of SubscriptionModel): TODO: type description here.
+                Example:
+
+        Returns:
+            void: Response from the API. success
+
+        Raises:
+            APIException: When an error occurs while fetching the data from
+                the remote API. This exception includes the HTTP Response
+                code, an error message, and the HTTP body that was received in
+                the request.
+
+        """
+
+        # The base uri for api requests
+        _query_builder = Configuration.BASE_URI
+
+        # Prepare query string for API call
+        _query_builder += '/v1/subscriptions/batch'
+
+        # Validate and preprocess url
+        _query_url = APIHelper.clean_url(_query_builder)
+
+        # Prepare headers
+        _headers = {
+            'content-type': 'application/json; charset=utf-8',
+            'X-Moesif-Application-Id': Configuration.application_id,
+            'User-Agent': Configuration.version,
+        }
+
+        # Prepare the API call.
+        _request = self.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
+
+        # Invoke the on before request HttpCallBack if specified
+        if self.http_call_back is not None:
+            self.http_call_back.on_before_request(_request)
+
+        # Invoke the API call  to fetch the response.
+        _response = self.http_client.execute_as_string(_request)
+
+        # Wrap the request and the response in an HttpContext object
+        _context = HttpContext(_request, _response)
+
+        # Invoke the on after response HttpCallBack if specified
+        if self.http_call_back is not None:
+            self.http_call_back.on_after_response(_context)
+
+        # Global error handling using HTTP status codes.
+        self.validate_response(_context)
diff --git a/moesifapi/models/__init__.py b/moesifapi/models/__init__.py
@@ -5,3 +5,4 @@
 from .user_model import *
 from .company_model import *
 from .campaign_model import *
+from .subscription_model import *
diff --git a/moesifapi/models/subscription_model.py b/moesifapi/models/subscription_model.py
@@ -0,0 +1,86 @@
+
+# -*- coding: utf-8 -*-
+
+"""
+    moesifapi.models.subscription_model
+
+
+"""
+import dateutil.parser
+from .base_model import BaseModel
+
+class SubscriptionModel(BaseModel):
+
+    """Implementation of the 'models.SubscriptionModel' model.
+
+    API Request
+
+    Attributes:
+        subscription_id (string): the id of the subscription.
+        company_id (string): the id of the company.
+        current_period_start (DateTime): Time when current subscription period started.
+        mcurrent_period_end (DateTime): Time when current subscription period ends.
+        status (string): the status of the subscription.
+        metadata (object): any custom data for the subscription .
+
+    """
+
+    def __init__(self,
+                 subscription_id=None,
+                 company_id=None,
+                 current_period_start=None,
+                 current_period_end=None,
+                 status=None,
+                 metadata=None):
+        """Constructor for the SubscriptionModel class"""
+
+        # Initialize members of the class
+        self.subscription_id = subscription_id
+        self.company_id = company_id
+        self.current_period_start = current_period_start
+        self.current_period_end = current_period_end
+        self.status = status
+        self.metadata = metadata
+
+        # Create a mapping from Model property names to API property names
+        self.names = {
+            "subscription_id": "subscription_id",
+            "company_id": "company_id",
+            "current_period_start": "current_period_start",
+            "current_period_end": "current_period_end",
+            "status": "status",
+            "metadata": "metadata",
+        }
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Creates an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object as
+            obtained from the deserialization of the server's response. The keys
+            MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if dictionary is None:
+            return None
+        else:
+            # Extract variables from the dictionary
+            subscription_id = dictionary.get("subscription_id")
+            company_id = dictionary.get("company_id")
+            current_period_start = dateutil.parser.parse(dictionary.get("current_period_start")) if dictionary.get("current_period_start") else None
+            current_period_end = dateutil.parser.parse(dictionary.get("current_period_end")) if dictionary.get("current_period_end") else None
+            status = dictionary.get("status")
+            metadata = dictionary.get("metadata")
+
+            # Return an object of this model
+            return cls(subscription_id,
+                       company_id,
+                       current_period_start,
+                       current_period_end,
+                       status,
+                       metadata)
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,6 @@
-requests==2.20.0
+requests>=2.25.1
+urllib3>=1.26.5
 jsonpickle==0.7.1
-python-dateutil==2.5.3
-nose==1.3.7
+python-dateutil>=2.8.2
 isodatetimehandler==1.0.2
+pytest>=6.0
diff --git a/tests/controllers/test_api_controller.py b/tests/controllers/test_api_controller.py
