Merge branch 'upstream'

# Conflicts:
#	connect/models/__init__.py
#	connect/models/event.py

Author: JaviCerveraIngram

connect/config.py

@@ -14,6 +14,10 @@ class Config(object):
     :param str api_key: Service user ApiKey.
     :param str|list[str] products: Optional product ids.
     :param str file: Config file name.
+    :raises ValueError: Raised if either ``file`` or one of ``api_url`` or ``api_key`` are missing.
+    :raises TypeError: Raised if ``products`` is not a string or list of strings, or if config file
+        does not contain JSON data.
+    :raises IOError: Raised if the specified ``file`` could not be opened.
     """
 
     # Global instance
@@ -23,8 +27,7 @@ class Config(object):
     def __init__(self, api_url=None, api_key=None, products=None, file=None):
         # Check arguments
         if not file and not any([api_key, api_url]):
-            raise ValueError('Filename or api_key and api_url are expected'
-                             'in Config initialization')
+            raise ValueError('Expected file or api_key and api_url in Config initialization')
         if products and not isinstance(products, (str, list)):
             raise TypeError('Products can be string or string list. Found type '
                             + type(products).__name__)

connect/models/fulfillment.py

@@ -101,5 +101,15 @@ def removed_items(self):
             self.asset.items))
 
     def needs_migration(self, migration_key='migration_info'):
-        # type: (str) -> bool
+        """
+        Indicates whether the request contains data to be migrated from a legacy product.
+        Migration is performed by an external service. All you have to do for a request that
+        needs migration is to skip processing by raising a
+        :py:class:`connect.exceptions.SkipRequest` exception.
+
+        :param str migration_key: The name of the parameter that contains the migration data
+            (optional; default value is ``migration_info``).
+        :return: Whether the request needs migrating.
+        :rtype: bool
+        """
         return self.asset.get_param_by_id(migration_key) is not None

connect/resources/usage_automation.py

@@ -73,6 +73,7 @@ def get_usage_template(self, product):
         :param Product product: Specific product.
         :return: The template file contents.
         :rtype: bytes
+        :raises FileRetrievalError: Raised if the file contents could not be retrieved.
         """
         location = self._get_usage_template_download_location(product.id)
         if not location:
@@ -94,6 +95,7 @@ def submit_usage(self, usage_file, usage_records):
         :param list[UsageRecord] usage_records: Records.
         :return: Usage file.
         :rtype: UsageFile
+        :raises FileCreationError: Raised if creation or uploading of the file fails.
         """
         usage_file = self._create_usage_file(usage_file)
         self._upload_usage_records(usage_file, usage_records)

docs/api_reference.rst

@@ -13,12 +13,6 @@ exceptions
 .. automodule:: connect.exceptions
    :members:
 
-logger
-======
-
-.. automodule:: connect.logger
-   :members:
-
 models
 ======
 
@@ -30,9 +24,3 @@ resources
 
 .. automodule:: connect.resources
    :members:
-
-migration_handler
-=================
-
-.. automodule:: connect.migration_handler
-   :members:

examples/fulfillment.py

@@ -26,41 +26,47 @@ class FulfillmentExample(FulfillmentAutomation):
     def process_request(self, request):
         # type: (Fulfillment) -> Union[ActivationTemplateResponse, ActivationTileResponse]
 
-        logger.info('Processing request {} for contract {}, product {}, marketplace {}'
-                    .format(request.id,
-                            request.contract.id,
-                            request.asset.product.name,
-                            request.marketplace.name))
-
-        # Custom logic
-        if request.type == 'purchase':
-            for item in request.asset.items:
-                if item.quantity > 100000:
-                    raise FailRequest(
-                        message='Is Not possible to purchase product')
-
-            for param in request.asset.params:
-                if param.name == 'email' and not param.value:
-                    param.value_error = 'Email address has not been provided, please provide one'
-                    raise InquireRequest(params=[param])
-
-            # Approve by ActivationTile
-            return ActivationTileResponse('\n  # Welcome to Fallball!\n\nYes, you decided '
-                                          'to have an account in our amazing service!')
-            # Or
-            # return TemplateResource().render(pk='TEMPLATE_ID', request_id=request.id)
-
-            # Approve by Template
-            # return ActivationTemplateResponse('TL-497-535-242')
-            # Or
-            # return TemplateResource().get(pk='TEMPLATE_ID')
-
-        elif request.type == 'change':
-            # Fail
-            raise FailRequest()
-        else:
-            # Skip request
+        if request.needs_migration():
+            # Skip request if it needs migration (migration is performed by an external service)
+            logger.info('Skipping request {} because it needs migration.'.format(request.id))
             raise SkipRequest()
+        else:
+            logger.info('Processing request {} for contract {}, product {}, marketplace {}'
+                        .format(request.id,
+                                request.contract.id,
+                                request.asset.product.name,
+                                request.marketplace.name))
+
+            # Custom logic
+            if request.type == 'purchase':
+                for item in request.asset.items:
+                    if item.quantity > 100000:
+                        raise FailRequest(
+                            message='Is Not possible to purchase product')
+
+                for param in request.asset.params:
+                    if param.name == 'email' and not param.value:
+                        param.value_error = 'Email address has not been provided, ' \
+                                            'please provide one'
+                        raise InquireRequest(params=[param])
+
+                # Approve by ActivationTile
+                return ActivationTileResponse('\n  # Welcome to Fallball!\n\nYes, you decided '
+                                              'to have an account in our amazing service!')
+                # Or
+                # return TemplateResource().render(pk='TEMPLATE_ID', request_id=request.id)
+
+                # Approve by Template
+                # return ActivationTemplateResponse('TL-497-535-242')
+                # Or
+                # return TemplateResource().get(pk='TEMPLATE_ID')
+
+            elif request.type == 'change':
+                # Fail
+                raise FailRequest()
+            else:
+                # Skip request
+                raise SkipRequest()
 
 
 if __name__ == '__main__':