Merge branch 'CPS-20-deprecated'

connect/__init__.py

@@ -3,19 +3,43 @@
 # This file is part of the Ingram Micro Cloud Blue Connect SDK.
 # Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 
-from .resources import FulfillmentAutomation, TierConfigAutomation
+from abc import ABCMeta
+
+from deprecation import deprecated
+
+import resources
+
+
+# TODO: These classes will be removed in the future.
+# They are now located in connect.reousrces package.
+
+
+class FulfillmentAutomation(resources.FulfillmentAutomation):
+    __metaclass__ = ABCMeta
+
+    @deprecated(deprecated_in='16.0', details='Import class from ``connect.resources`` package instead.')
+    def __init__(self, config=None):
+        super(FulfillmentAutomation, self).__init__(config)
+
+
+class TierConfigAutomation(resources.TierConfigAutomation):
+    __metaclass__ = ABCMeta
+
+    @deprecated(deprecated_in='16.0', details='Import class from ``connect.resources`` package instead.')
+    def __init__(self, config=None):
+        super(TierConfigAutomation, self).__init__(config)
+
 
 name = 'connect'
 
+
 __all__ = [
     'config',
     'exceptions',
     'logger',
     'migration_handler',
     'models',
     'resources',
-
-    # TODO: Provided for backwards compatibility
     'FulfillmentAutomation',
     'TierConfigAutomation',
 ]

connect/exceptions.py

@@ -5,7 +5,8 @@
 
 from typing import List
 
-from connect.deprecated import deprecated
+from deprecation import deprecated
+
 from .models.parameters import Param
 
 
@@ -29,10 +30,9 @@ def __init__(self, message='', code='', obj=None):
         self.obj = obj
 
     @property
-    @deprecated('16.0', 'str(exception)')
+    @deprecated(deprecated_in='16.0', details='Use ``str(exception)`` instead.')
     def message(self):
-        """ Deprecated property to get the exception message. Use ``str(exception)`` instead.
-
+        """
         :return: The exception message.
         :rtype: str
         """

connect/resources/base.py

@@ -109,6 +109,11 @@ def _check_and_pack_response(response):
 
 
 class BaseResource(object):
+    """ Base class of all resources.
+
+    :param Config config: Config object or ``None`` to use environment config (default).
+    """
+
     resource = None  # type: str
     limit = 100  # type: int
     schema = BaseSchema()  # type: BaseSchema

connect/resources/fulfillment_automation.py

@@ -73,7 +73,7 @@ def dispatch(self, request):
             return self.inquire(request.id)
 
         except FailRequest as fail:
-            return self.fail(request.id, reason=fail.message)
+            return self.fail(request.id, reason=str(fail))
 
         except SkipRequest as skip:
             return skip.code

connect/resources/tier_config_automation.py

@@ -62,7 +62,7 @@ def dispatch(self, request):
             return self.inquire(request.id)
 
         except FailRequest as fail:
-            return self.fail(request.id, reason=fail.message)
+            return self.fail(request.id, reason=str(fail))
 
         except SkipRequest as skip:
             return skip.code

requirements/sdk.txt

@@ -1,3 +1,4 @@
+deprecation==2.0.6
 marshmallow==2.18.0
 openpyxl==2.5.14
 requests==2.21.0

tests/test_models.py

@@ -9,8 +9,8 @@
 import six
 from mock import MagicMock, patch
 
-from connect import FulfillmentAutomation
 from connect.models import Asset, Param, Fulfillment, Item, TierConfig
+from connect.resources import FulfillmentAutomation
 from .common import Response, load_str
 
 

tests/test_tier_config.py

@@ -10,11 +10,11 @@
 from mock import MagicMock, patch
 from typing import Union
 
-from connect import TierConfigAutomation
 from connect.exceptions import FailRequest, InquireRequest, SkipRequest
 from connect.models import Param, ActivationTileResponse, ActivationTemplateResponse, BaseModel, \
     Company, Connection, EventInfo, Hub, Product, TierConfigRequest, TierConfig, Events, \
     Template, Activation, Account
+from connect.resources import TierConfigAutomation
 from .common import Response, load_str