Add NestedResource class to handle nested collections

Extend the product Item object with missing attributes
Switch automation engines to rql
Store server error response in ServerError exception

Author: Francesco Faraone

connect/exceptions.py

@@ -84,6 +84,7 @@ class ServerError(Exception):
     """
 
     def __init__(self, error):
+        self.error = error
         super(ServerError, self).__init__(str(error), error.error_code)
 
 

connect/models/__init__.py

@@ -13,6 +13,7 @@
 from .asset import Asset
 from .base import BaseModel
 from .billing import Billing
+from .commitment import Commitment
 from .company import Company
 from .configuration import Configuration
 from .connection import Connection
@@ -55,6 +56,8 @@
 from .tier_account_request import TierAccountRequest
 from .tier_config import TierConfig
 from .tier_config_request import TierConfigRequest
+from .ui import UI
+from .unit import Unit
 from .usage_file import UsageFile
 from .usage_listing import UsageListing
 from .usage_record import UsageRecord
@@ -83,6 +86,7 @@
     'BillingRequest',
     'Company',
     'Configuration',
+    'Commitment',
     'Connection',
     'Constraints',
     'Contact',
@@ -125,6 +129,8 @@
     'TierAccounts',
     'TierConfig',
     'TierConfigRequest',
+    'UI',
+    'Unit',
     'UsageFile',
     'UsageListing',
     'UsageRecord',

connect/models/commitment.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+from .base import BaseModel
+from .schemas import CommitmentSchema
+
+
+class Commitment(BaseModel):
+    """ Billing commitment object. """
+
+    _schema = CommitmentSchema()
+
+    multiplier = None  # type: str
+    """ (str) Commitment multiplier. """
+
+    count = None  # type: int
+    """ (int) Number of commitments. """

connect/models/item.py

@@ -6,9 +6,12 @@
 from typing import List, Optional, Union
 
 from .base import BaseModel
+from .commitment import Commitment
 from .param import Param
 from .renewal import Renewal
 from .schemas import ItemSchema
+from .ui import UI
+from .unit import Unit
 
 
 class Item(BaseModel):
@@ -55,6 +58,15 @@ class Item(BaseModel):
     name = None  # type: str
     """ (str) Name. """
 
+    unit = None  # type: Unit
+    """ (Unit) Measure unit. """
+
+    commitment = None  # type: Optional[Commitment]
+    """ (Commitment) item billing commitment. """
+
+    ui = None  # type: UI
+    """ (UI) UI visibility. """
+
     def get_param_by_id(self, param_id):
         """ Get a parameter of the item.
 

connect/models/schemas.py

@@ -9,6 +9,11 @@
 
 
 class BaseSchema(Schema):
+
+    def __init__(self, *args, **kwargs):
+        # kwargs['strict'] = True
+        super(BaseSchema, self).__init__(*args, **kwargs)
+
     id = fields.Str()
 
     # Set allow_none to True in all fields
@@ -334,18 +339,50 @@ def make_object(self, data):
         return Param(**data)
 
 
+class UISchema(BaseSchema):
+    visibility = fields.Bool()
+    @post_load
+    def make_object(self, data):
+        from connect.models import UI
+        return UI(**data)
+
+
+class UnitSchema(BaseSchema):
+    title = fields.Str()
+    unit = fields.Str()
+
+    @post_load
+    def make_object(self, data):
+        from connect.models import Unit
+        return Unit(**data)
+
+
+class CommitmentSchema(BaseSchema):
+    multiplier = fields.Str()
+    count = fields.Int()
+
+    @post_load
+    def make_object(self, data):
+        from connect.models import Commitment
+        return Commitment(**data)
+
+
 class ItemSchema(BaseSchema):
     mpn = fields.Str()
     quantity = QuantityField()
     old_quantity = QuantityField()
     renewal = fields.Nested(RenewalSchema)
+    unit = fields.Nested(UnitSchema)
+    commitment = fields.Nested(CommitmentSchema)
     params = fields.Nested(ParamSchema, many=True)
     display_name = fields.Str()
     global_id = fields.Str()
     item_type = fields.Str()
+    description = fields.Str()
     period = fields.Str()
     type = fields.Str()
     name = fields.Str()
+    ui = fields.Nested(UISchema)
 
     @post_load
     def make_object(self, data):
@@ -828,8 +865,8 @@ def make_object(self, data):
 
 
 class AttributesSchema(BaseSchema):
-    provider = fields.Nested(CompanySchema, only=('external_id'))
-    vendor = fields.Nested(CompanySchema, only=('external_id'))
+    provider = fields.Nested(CompanySchema, only=('external_id',))
+    vendor = fields.Nested(CompanySchema, only=('external_id',))
 
     @post_load
     def make_object(self, data):

connect/models/ui.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+from .base import BaseModel
+from .schemas import UISchema
+
+
+class UI(BaseModel):
+    """ UI object. """
+
+    _schema = UISchema()
+
+    visibility = None  # type: bool
+    """ (str) Item UI visibility. """

connect/models/unit.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+from .base import BaseModel
+from .schemas import UnitSchema
+
+
+class Unit(BaseModel):
+    """ Unit object. """
+
+    _schema = UnitSchema()
+
+    title = None  # type: str
+    """ (str) Name of measure unit. """
+
+    unit = None  # type: str
+    """ (str) unit code of measure unit. """

connect/resources/base.py

@@ -140,11 +140,11 @@ class BaseResource(object):
 
     def __init__(self, config=None):
         # Set client
-        if not self.__class__.resource:
+        if not self.resource:
             raise AttributeError('Resource name not specified in class {}. '
                                  'Add an attribute `resource` with the name of the resource'
                                  .format(self.__class__.__name__))
-        self._api = ApiClient(config, self.__class__.resource)
+        self._api = ApiClient(config, self.resource)
 
     @property
     def config(self):
@@ -161,12 +161,15 @@ def get(self, pk):
 
     def filters(self, **kwargs):
         # type: (Dict[str, Any]) -> Dict[str, Any]
-        filters = {}
+        query = Query()
         if self.limit:
-            filters['limit'] = self.limit
+            query = query.limit(self.limit)
         for key, val in kwargs.items():
-            filters[key] = val
-        return filters
+            if isinstance(val, (list, tuple)):
+                query = query.in_(key, val)
+            else:
+                query = query.equal(key, val)
+        return query
 
     @function_log
     def search(self, filters=None):
@@ -208,3 +211,14 @@ def update(self, id_obj, body):
 
     def list(self, filters=None):
         return self.search(filters)
+
+
+class NestedResource(BaseResource):
+    """Base class for all nested resources"""
+
+    def __init__(self, config=None, parent_path=''):
+        self.resource = '{}/{}'.format(
+            parent_path,
+            self.__class__.resource,
+        )
+        super(NestedResource, self).__init__(config)

connect/resources/fulfillment_automation.py

@@ -68,10 +68,10 @@ def filters(self, status='pending', **kwargs):
         :return: The set of filters for this resource.
         :rtype: dict[str,Any]
         """
-        filters = super(FulfillmentAutomation, self).filters(status=status, **kwargs)
+        query = super(FulfillmentAutomation, self).filters(status=status, **kwargs)
         if self.config.products:
-            filters['asset.product.id__in'] = ','.join(self.config.products)
-        return filters
+            query.in_('asset.product.id', self.config.products)
+        return query
 
     @function_log
     def dispatch(self, request):

connect/resources/product.py

@@ -1,12 +1,20 @@
 import json
-from .base import BaseResource
+
+from .base import BaseResource, NestedResource
+from ..models import Product, Item
+
+
+class ProductItemResource(NestedResource):
+    resource = 'items'
+    model_class = Item
 
 
 class ProductsResource(BaseResource):
     """ Allows listing and obtaining several types of objects.
         :param Config config: Config object or ``None`` to use environment config (default).
     """
     resource = 'products'
+    model_class = Product
 
     def list_parameters(self, product_id):
         """ List parameters for a product.
@@ -75,3 +83,7 @@ def delete_parameter(self, product_id, parameter_id):
             path=path
         )
         return response
+
+    def items(self, product_id):
+        """Returns the ProductItemResource resource"""
+        return ProductItemResource(self.config, 'products/{}'.format(product_id))