Merge pull request #62 from JaviCerveraIngram/CPS-34-reporting-usage-files

CPS-34-reporting-usage-files

Author: vgrebenschikov

connect/config.py

@@ -57,7 +57,7 @@ def __init__(self, api_url=None, api_key=None, products=None, file=None):
 
         # Initialize
         self._api_key = api_key
-        self._api_url = api_url
+        self._api_url = api_url if api_url.endswith('/') else api_url + '/'
         self._products = [products] \
             if isinstance(products, str) \
             else products or []

connect/models/asset.py

@@ -47,7 +47,7 @@ class Asset(BaseModel):
     - new: First purchase requested.
     - processing: Until first purchase request is either completed or rejected.
     - active: After the first purchase request is completed.
-       NOTE: Asset stays active regardless of any other requests except cancel.
+      NOTE: Asset stays active regardless of any other requests except cancel.
     - rejected: Asset becomes rejected once the first purchase request is rejected.
     - terminated: Asset becomes terminated once the 'cancel' request type is fulfilled.
     - suspended: Asset becomes suspended once 'suspend' request type is fulfilled.

connect/models/schemas.py

@@ -368,7 +368,7 @@ def make_object(self, data):
 
 class ServerErrorResponseSchema(Schema):
     error_code = fields.Str()
-    params = fields.Dict()
+    params = fields.Dict(allow_none=True)
     errors = fields.List(fields.Str())
 
     @post_load
@@ -556,7 +556,7 @@ def make_object(self, data):
 
 
 class UsageRecordSchema(BaseSchema):
-    record_id = fields.Str()
+    usage_record_id = fields.Str()
     item_search_criteria = fields.Str()
     item_search_value = fields.Str()
     quantity = fields.Int()

connect/models/usage.py

@@ -149,8 +149,8 @@ class UsageRecord(BaseModel):
 
     _schema = UsageRecordSchema()
 
-    record_id = None  # type: str
-    """ (str) Record id. """
+    usage_record_id = None  # type: str
+    """ (str) Usage record id. """
 
     item_search_criteria = None  # type: str
     """ (str) Item search criteria. """

connect/resources/automation_engine.py

@@ -18,9 +18,9 @@ def filters(self, status='pending', **kwargs):
         # type: (str, Dict[str, Any]) -> Dict[str, Any]
         return super(AutomationEngine, self).filters(status=status, **kwargs)
 
-    def process(self):
-        # type: () -> None
-        for request in self.list():
+    def process(self, filters=None):
+        # type: (Dict[str, Any]) -> None
+        for request in self.list(filters):
             self.dispatch(request)
 
     def dispatch(self, request):

connect/resources/base.py

@@ -102,7 +102,12 @@ def _check_and_pack_response(response):
                 )
 
         if not response.ok:
-            error = ServerErrorResponse.deserialize(response.text)
+            try:
+                error = ServerErrorResponse.deserialize(response.text)
+            except ValueError:
+                error = None
+            if not error or not error.error_code:
+                error = ServerErrorResponse(errors=[response.text])
             raise ServerError(error)
 
         return response.text, response.status_code

connect/resources/fulfillment_automation.py

@@ -39,6 +39,26 @@ class FulfillmentAutomation(AutomationEngine):
 
     def filters(self, status='pending', **kwargs):
         """
+        Returns the default set of filters for Fulfillment request, plus any others that you might
+        specify. The allowed filters are:
+
+        - status
+        - created
+        - id (List support)
+        - type (purchase|renew|change|cancel)
+        - asset.id (asset_id) - (List support)
+        - asset.product.id (product_id)
+        - asset.product.name - (List support)
+        - asset.hub.id
+        - asset.connection.hub.name - (List support)
+        - asset.connection.provider.id
+        - asset.connection.provider.name - (List support)
+        - asset.connection.vendor.name - (List support)
+        - asset.tiers.customer.id (Customer ID)
+        - asset.tiers.tier1.id
+        - asset.tiers.tier2.id
+        - asset.connection.type (test|production|preview)
+
         :param str status: Status of the requests. Default: ``'pending'``.
         :param dict[str,Any] kwargs: Additional filters to add to the default ones.
         :return: The set of filters for this resource.

connect/resources/usage_automation.py

@@ -24,7 +24,7 @@ class UsageAutomation(AutomationEngine):
     """
 
     __metaclass__ = ABCMeta
-    resource = 'usage/files'
+    resource = 'listings'
     model_class = UsageFile
 
     def filters(self, status='draft', **kwargs):
@@ -104,7 +104,7 @@ def submit_usage(self, usage_file, usage_records):
     def _get_usage_template_download_location(self, product_id):
         # type: (str) -> str
         try:
-            response, _ = self._api.get(url='{}/usage/products/{}/template/'
+            response, _ = self._api.get(url='{}usage/products/{}/template/'
                                         .format(self.config.api_url, product_id))
             response_dict = json.loads(response)
             return response_dict['template_link']
@@ -127,7 +127,8 @@ def _create_usage_file(self, usage_file):
         if not usage_file.description:
             # Could be because description is empty or None, so make sure it is empty
             usage_file.description = ''
-        response, _ = self._api.post(json=usage_file.json)
+        response, _ = self._api.post(url='{}usage/files/'
+                                     .format(self.config.api_url), json=usage_file.json)
         return self.model_class.deserialize(response)
 
     def _upload_usage_records(self, usage_file, usage_records):
@@ -152,7 +153,7 @@ def _create_spreadsheet(usage_records):
         sheet['H1'] = 'asset_search_value'
         for index, record in enumerate(usage_records):
             row = str(index + 2)
-            sheet['A' + row] = record.record_id
+            sheet['A' + row] = record.usage_record_id
             sheet['B' + row] = record.item_search_criteria
             sheet['C' + row] = record.item_search_value
             sheet['D' + row] = record.quantity
@@ -172,7 +173,7 @@ def _upload_spreadsheet(self, usage_file, spreadsheet):
             file_contents = tmp.read()
 
         # Setup request
-        url = self._api.get_url(usage_file.id + '/upload/')
+        url = '{}usage/files/{}/upload/'.format(self.config.api_url, usage_file.id)
         headers = self._api.headers
         headers['Accept'] = 'application/json'
         del headers['Content-Type']  # This must NOT be set for multipart post requests
@@ -182,7 +183,7 @@ def _upload_spreadsheet(self, usage_file, spreadsheet):
         # Post request
         try:
             content, status = self._api.post(
-                path=usage_file.id + '/upload/',
+                url=url,
                 headers=headers,
                 files=multipart)
         except requests.RequestException as ex:

connect/resources/usage_file_automation.py

@@ -21,6 +21,18 @@ class UsageFileAutomation(AutomationEngine):
     resource = 'usage/files'
     model_class = UsageFile
 
+    def filters(self, status='ready', **kwargs):
+        """
+        :param str status: Status of the requests. Default: ``'ready'``.
+        :param dict[str,Any] kwargs: Additional filters to add to the default ones.
+        :return: The set of filters for this resource.
+        :rtype: dict[str,Any]
+        """
+        filters = super(UsageFileAutomation, self).filters(status, **kwargs)
+        if self.config.products:
+            filters['product__id'] = ','.join(self.config.products)
+        return filters
+
     def dispatch(self, request):
         # type: (UsageFile) -> str
         try:

tests/test_usage.py

@@ -53,7 +53,7 @@ def test_get_usage_template_ok(get_mock):
     assert resource.get_usage_template(Product(id='PRD-638-321-603')) == b'template_contents'
     get_mock.assert_has_calls([
         call(
-            url='http://localhost:8080/api/public/v1//usage/products/PRD-638-321-603/template/',
+            url='http://localhost:8080/api/public/v1/usage/products/PRD-638-321-603/template/',
             headers={'Content-Type': 'application/json', 'Authorization': 'ApiKey XXXX:YYYYY'}),
         call('...')
     ])