Merge pull request #68 from JaviCerveraIngram/CPS-44-product

Cps 44 Product Configuration params, templates and other updates

Author: vgrebenschikov

connect/config.py

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

connect/logger/logger.py

@@ -7,8 +7,9 @@
 import json
 import logging
 import os
+
 from logging.config import dictConfig
-from connect.models import BaseModel, Fulfillment
+from connect.models.base import BaseModel
 
 with open(os.path.join(os.path.dirname(__file__), 'config.json')) as config_file:
     config = json.load(config_file)
@@ -23,7 +24,7 @@ def log_request_data(args):
         base = " %(levelname)-6s; %(asctime)s; %(name)-6s; %(module)s:%(funcName)s:line"\
                "-%(lineno)d: %(message)s"
         sformat = args[0].id + base
-        if isinstance(args[0], Fulfillment):
+        if hasattr(args[0], 'asset') and hasattr(args[0].asset, 'id'):
             sformat = args[0].asset.id + "  " + sformat
         [handler.setFormatter(logging.Formatter(sformat, "%I:%M:%S"))
          for handler in logger.handlers]

connect/models/__init__.py

@@ -17,6 +17,7 @@
 from .contact import Contact
 from .contact_info import ContactInfo
 from .contract import Contract
+from .country import Country
 from .conversation import Conversation
 from .conversation_message import ConversationMessage
 from .customer_ui_settings import CustomerUiSettings
@@ -36,6 +37,7 @@
 from .product import Product
 from .product_category import ProductCategory
 from .product_configuration import ProductConfiguration
+from .product_configuration_parameter import ProductConfigurationParameter
 from .product_family import ProductFamily
 from .product_stats import ProductStats
 from .product_stats_info import ProductStatsInfo
@@ -68,6 +70,7 @@
     'Contact',
     'ContactInfo',
     'Contract',
+    'Country',
     'Conversation',
     'ConversationMessage',
     'CustomerUiSettings',
@@ -87,6 +90,7 @@
     'Product',
     'ProductCategory',
     'ProductConfiguration',
+    'ProductConfigurationParameter',
     'ProductFamily',
     'ProductStats',
     'ProductStatsInfo',

connect/models/agreement.py

@@ -74,3 +74,8 @@ class Agreement(BaseModel):
     """ (:py:class:`.Marketplace` | None) Reference to marketplace object
     (for distribution agreement).
     """
+
+    # Undocumented fields (they appear in PHP SDK)
+
+    name = None  # type: str
+    """ (str) Name of Agreement. """

connect/models/asset.py

@@ -6,8 +6,11 @@
 from typing import List, Optional
 
 from .base import BaseModel
+from .configuration import Configuration
 from .connection import Connection
+from .contract import Contract
 from .item import Item
+from .marketplace import Marketplace
 from .param import Param
 from .product import Product
 from .tier_accounts import TierAccounts
@@ -58,32 +61,57 @@ class Asset(BaseModel):
     """ (str) Identification for asset object on eCommerce. """
 
     external_uid = None  # type: Optional[str]
-    """ (str|None) Id of asset in eCommerce system """
+    """ (str|None) Id of asset in eCommerce system. """
+
+    external_name = None  # type: Optional[str]
+    """ (str|None) Name of asset. """
 
     product = None  # type: Product
     """ (:py:class:`.Product`) Product object reference. """
 
     connection = None  # type: Connection
     """ (:py:class:`.Connection`) Connection object. """
 
-    items = None  # type: List[Item]
-    """ (List[:py:class:`.Item`]) List of asset product items. """
+    contract = None  # type: Contract
+    """ (:py:class:`.Contract`) Contract Object reference. """
+
+    marketplace = None  # type: Marketplace
+    """ (:py:class:`.Marketplace`) Marketplace Object reference. """
 
     params = None  # type: List[Param]
     """ (List[:py:class:`.Param`]) List of product parameter objects. """
 
     tiers = None  # type: TierAccounts
     """ (:py:class:`.TierAccounts`) Supply chain accounts. """
 
-    def get_param_by_id(self, id_):
+    items = None  # type: List[Item]
+    """ (List[:py:class:`.Item`]) List of asset product items. """
+
+    configuration = None  # type: Configuration
+    """ (:py:class:`.Configuration`) List of Product and Marketplace Configuration Phase Parameter
+    Context-Bound Object. """
+
+    def get_param_by_id(self, param_id):
         """ Get a parameter of the asset.
 
-        :param str id_: Id of the the parameter to get.
+        :param str param_id: Id of the the parameter to get.
         :return: The parameter with the given id, or ``None`` if it was not found.
         :rtype: :py:class:`.Param` | None
         """
         try:
-            return list(filter(lambda param: param.id == id_, self.params))[0]
+            return list(filter(lambda param: param.id == param_id, self.params))[0]
+        except IndexError:
+            return None
+
+    def get_item_by_id(self, item_id):
+        """ Get an item of the asset.
+
+        :param str item_id: Id of the item to get.
+        :return: The item with the given id, or ``None`` if it was not found.
+        :rtype: :py:class:`.Item` | None
+        """
+        try:
+            return list(filter(lambda item: item.id == item_id, self.items))[0]
         except IndexError:
             return None
 
@@ -98,3 +126,30 @@ def get_item_by_mpn(self, mpn):
             return list(filter(lambda item: item.mpn == mpn, self.items))[0]
         except IndexError:
             return None
+
+    def get_item_by_global_id(self, global_id):
+        """ Get an item of the asset.
+
+        :param str global_id: Global id of the item to get.
+        :return: The item with the given global id, or ``None`` if it was not found.
+        :rtype: :py:class:`.Item` | None
+        """
+        try:
+            return list(filter(lambda item: item.global_id == global_id, self.items))[0]
+        except IndexError:
+            return None
+
+    def get_requests(self, config=None):
+        """ Get the requests for this asset.
+
+        :param Config config: Config object or ``None`` to use environment config (default).
+        :return: The requests for this asset.
+        :rtype: List[Fulfillment]
+        """
+        from connect.config import Config
+        from connect.resources.base import ApiClient
+        from .fulfillment import Fulfillment
+        text, _ = ApiClient(
+            config or Config.get_instance(),
+            'assets/' + self.id + '/requests').get()
+        return Fulfillment.deserialize(text)

connect/models/configuration.py

@@ -25,3 +25,15 @@ class Configuration(BaseModel):
 
     params = None  # type: List[Param]
     """ (List[:py:class:`.Param`])  """
+
+    def get_param_by_id(self, param_id):
+        """ Get a parameter of the configuration.
+
+        :param str param_id: Id of the the parameter to get.
+        :return: The parameter with the given id, or ``None`` if it was not found.
+        :rtype: :py:class:`.Param` | None
+        """
+        try:
+            return list(filter(lambda param: param.id == param_id, self.params))[0]
+        except IndexError:
+            return None

connect/models/contact_info.py

@@ -24,7 +24,7 @@ class ContactInfo(BaseModel):
     country = None  # type: str
     """ (str) Country code. """
 
-    state = None  # type: str
+    state = None  # type: Optional[str]
     """ (str) State name. """
 
     city = None  # type: str

connect/models/country.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019 Ingram Micro. All Rights Reserved.
+
+from .base import BaseModel
+from .schemas import CountrySchema
+
+
+class Country(BaseModel):
+    """ An instance of a hub. """
+
+    _schema = CountrySchema()
+
+    name = None  # type: str
+    """ (str) Country name """
+
+    icon = None  # type: str
+    """ (str) Icon path. """
+
+    zone = None  # type: str
+    """ (str) Geographical zone. """

connect/models/fulfillment.py

@@ -10,6 +10,7 @@
 from .contract import Contract
 from .conversation import Conversation
 from .marketplace import Marketplace
+from .user import User
 from .schemas import FulfillmentSchema
 
 
@@ -72,6 +73,9 @@ class Fulfillment(BaseModel):
     marketplace = None  # type: Marketplace
     """ (:py:class:`.Marketplace`) Marketplace object. """
 
+    assignee = None  # type: User
+    """ (:py:class:`.User`) Details of the user assigned to the request. """
+
     @property
     def new_items(self):
         """

connect/models/item.py

@@ -54,3 +54,15 @@ class Item(BaseModel):
 
     name = None  # type: str
     """ (str) Name. """
+
+    def get_param_by_id(self, param_id):
+        """ Get a parameter of the item.
+
+        :param str param_id: Id of the the parameter to get.
+        :return: The parameter with the given id, or ``None`` if it was not found.
+        :rtype: :py:class:`.Param` | None
+        """
+        try:
+            return list(filter(lambda param: param.id == param_id, self.params))[0]
+        except IndexError:
+            return None