Updated with Vladimir's proposals (and fixed an important bug I missed out on FulfillmentAutomation.process!)

Author: JaviCerveraIngram

connect/config.py

@@ -18,20 +18,19 @@ class Config(object):
     # noinspection PyShadowingBuiltins
     def __init__(
             self,
-            api_url=None,
-            api_key=None,
-            products=None,
-            file=None
+            api_url=None,  # type: str
+            api_key=None,  # type: str
+            products=None,  # type: Union[str, List[str]]
+            file=None  # type: str
     ):
-        # type: (str, str, Union[str, List[str]], str) -> None
-
         """
-        initialization config for public api
+        Initialization config for public api
         :param api_url: Public api url
         :param api_key: Service user ApiKey
         :param products (optional): Id products
-        :param file: Config file path
+        :param file: Config file name
         """
+
         # Check arguments
         if not file and not any([api_key, api_url]):
             raise ValueError('Filename or api_key and api_url are expected'

connect/models/exception.py

@@ -6,6 +6,7 @@
 """
 from typing import List
 
+from connect.models import Param
 from .server_error import ServerError
 
 
@@ -29,7 +30,7 @@ def __init__(self, *args, **kwargs):
 
 
 class FulfillmentInquire(Message):
-    params = None  # type: List[str]
+    params = None  # type: List[Param]
 
     def __init__(self, *args, **kwargs):
         # type: (*any, **any) -> None

connect/resource/base.py

@@ -6,11 +6,12 @@
 """
 
 import requests
-from typing import Any
+from typing import Any, List, Dict
 
 from connect.config import Config
 from connect.logger import function_log, logger
 from connect.models import BaseSchema, ServerErrorSchema
+from connect.models.base import BaseModel
 from connect.models.exception import ServerErrorException
 from .utils import join_url
 
@@ -33,7 +34,7 @@ def config(self):
 
     @property
     def headers(self):
-        # type: () -> dict
+        # type: () -> Dict[str, str]
         return {
             "Authorization": self.config.api_key,
             "Content-Type": "application/json",
@@ -99,8 +100,23 @@ def config(self):
         # type: () -> Config
         return self._config
 
+    @property
+    def list(self):
+        # type: () -> List[Any]
+        filters = self.build_filter()
+        logger.info('Get list request by filter - {}'.format(filters))
+        response = self.api.get(url=self._list_url, params=filters)
+        return self.__loads_schema(response)
+
+    def get(self, pk):
+        # type: (str) -> Any
+        response = self.api.get(url=self._obj_url(pk))
+        objects = self.__loads_schema(response)
+        if isinstance(objects, list) and len(objects) > 0:
+            return objects[0]
+
     def build_filter(self):
-        # type: () -> dict
+        # type: () -> Dict[str, Any]
         res_filter = {}
         if self.limit:
             res_filter['limit'] = self.limit
@@ -117,7 +133,7 @@ def _obj_url(self, pk):
         return join_url(self._list_url, pk)
 
     def __loads_schema(self, response):
-        # type: (str) -> Any
+        # type: (str) -> List[BaseModel]
         objects, error = self.schema.loads(response, many=True)
         if error:
             raise TypeError(
@@ -126,17 +142,3 @@ def __loads_schema(self, response):
             )
 
         return objects
-
-    def get(self, pk):
-        # type: (str) -> Any
-        response = self.api.get(url=self._obj_url(pk))
-        objects = self.__loads_schema(response)
-        if isinstance(objects, list) and len(objects) > 0:
-            return objects[0]
-
-    def list(self):
-        # type: () -> Any
-        filters = self.build_filter()
-        logger.info('Get list request by filter - {}'.format(filters))
-        response = self.api.get(url=self._list_url, params=filters)
-        return self.__loads_schema(response)

connect/resource/fulfillment.py

@@ -7,6 +7,8 @@
 
 import json
 
+from typing import List
+
 from connect.logger import function_log
 from connect.models import FulfillmentSchema, Param, ActivationTileResponse
 from .base import BaseResource
@@ -52,7 +54,7 @@ def render_template(self, pk, template_id):
 
     @function_log
     def update_parameters(self, pk, params):
-        # type: (str, list) -> str
+        # type: (str, List[Param]) -> str
         list_dict = []
         for _ in params:
             list_dict.append(_.__dict__ if isinstance(_, Param) else _)

connect/resource/fulfillment_automation.py

@@ -4,7 +4,6 @@
 This file is part of the Ingram Micro Cloud Blue Connect SDK.
 Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 """
-from typing import Any
 
 from connect.logger import logger
 from connect.models import ActivationTemplateResponse, ActivationTileResponse
@@ -16,19 +15,19 @@
 class FulfillmentAutomation(FulfillmentResource):
 
     def process(self):
-        # type: () -> Any
-        for _ in self.list():
-            return self.dispatch(_)
+        # type: () -> None
+        for _ in self.list:
+            self.dispatch(_)
 
     def dispatch(self, request):
-        # type: (Fulfillment) -> Any
+        # type: (Fulfillment) -> str
         try:
             logger.info('Start request process / ID request - {}'.format(request.id))
             result = self.process_request(request)
 
             if not result:
                 logger.info('Method `process_request` did not return result')
-                return
+                return ''
 
             params = {}
             if isinstance(result, ActivationTileResponse):
@@ -48,8 +47,6 @@ def dispatch(self, request):
         except Skip as skip:
             return skip.code
 
-        return
-
     def process_request(self, request):
-        # type: (Fulfillment) -> Any
+        # type: (Fulfillment) -> str
         raise NotImplementedError('Please implement `process_request` logic')

connect/resource/template.py

@@ -4,7 +4,7 @@
 This file is part of the Ingram Micro Cloud Blue Connect SDK.
 Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 """
-from typing import Any
+from typing import List, Any
 
 from connect.models import ActivationTemplateResponse, ActivationTileResponse
 from .base import BaseResource
@@ -18,6 +18,11 @@ class TemplateResource(BaseResource):
     """
     resource = 'templates'
 
+    @property
+    def list(self):
+        # type: () -> List[Any]
+        raise AttributeError('This resource do not have method `list`')
+
     def render(self, pk, request_id):
         # type: (str, str) -> ActivationTileResponse
         if not all([pk, request_id]):
@@ -31,7 +36,3 @@ def render(self, pk, request_id):
     def get(self, pk):
         # type: (str) -> ActivationTemplateResponse
         return ActivationTemplateResponse(template_id=pk)
-
-    def list(self):
-        # type: () -> Any
-        raise AttributeError('This resource do not have method `list`')

example/example.py

@@ -4,6 +4,7 @@
 This file is part of the Ingram Micro Cloud Blue Connect SDK.
 Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 """
+from typing import Union
 
 from connect import FulfillmentAutomation
 from connect.config import Config
@@ -21,7 +22,7 @@
 
 class ExampleRequestProcessor(FulfillmentAutomation):
     def process_request(self, request):
-        # type: (Fulfillment) -> object
+        # type: (Fulfillment) -> Union[ActivationTemplateResponse, ActivationTileResponse]
 
         logger.info('Processing request {} for contract {}, product {}, marketplace {}'
                     .format(request.id,

tests/test_models.py

@@ -40,7 +40,7 @@ def test_create_model_from_response():
 
     # Get requests from response
     resource = FulfillmentResource()
-    requests = resource.list()
+    requests = resource.list
     request_obj = resource.get(pk='PR-000-000-000')
 
     # Assert that all properties exist
@@ -86,7 +86,7 @@ def test_create_model_from_response():
 @patch('requests.get', MagicMock(return_value=_get_response2_ok()))
 def test_fulfillment_items():
     # Get request
-    requests = FulfillmentResource().list()
+    requests = FulfillmentResource().list
     assert len(requests) == 1
     request = requests[0]
     assert isinstance(request, Fulfillment)
@@ -116,7 +116,7 @@ def test_fulfillment_items():
 @patch('requests.get', MagicMock(return_value=_get_response2_ok()))
 def test_asset_methods():
     # Get asset
-    requests = FulfillmentResource().list()
+    requests = FulfillmentResource().list
     assert len(requests) == 1
     assert isinstance(requests[0], Fulfillment)
     asset = requests[0].asset