Merge pull request #23 from JaviCerveraIngram/tier-config-requests

Tier Config Requests

Author: vgrebenschikov

README.md

@@ -37,7 +37,7 @@ $ pip install connect-sdk
 
 ### Example
 ```python
-from connect import FulfillmentAutomation
+from connect import FulfillmentAutomation, TierConfigAutomation
 from connect.logger import logger
 from connect.models import ActivationTemplateResponse, ActivationTileResponse
 from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip
@@ -83,8 +83,16 @@ class ExampleRequestProcessor(FulfillmentAutomation):
             raise Skip()
 
 
+class ExampleTierConfigRequestProcessor(TierConfigAutomation):
+    def process_request(self, request):
+        pass
+
+
 if __name__ == '__main__':
     request_processor = ExampleRequestProcessor()
     request_processor.process()
+
+    tier_config_request_processor = ExampleTierConfigRequestProcessor()
+    tier_config_request_processor.process()
 ```
 

connect/__init__.py

@@ -5,7 +5,7 @@
 Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 """
 
-from .resource import FulfillmentAutomation
+from .resource import FulfillmentAutomation, TierConfigAutomation
 
 name = 'connect'
 
@@ -14,5 +14,6 @@
     'resource',
     'models',
     'logger',
-    'FulfillmentAutomation'
+    'FulfillmentAutomation',
+    'TierConfigAutomation',
 ]

connect/models/activation_response.py

@@ -11,7 +11,7 @@
 class ActivationTileResponse(object):
     tile = 'Activation succeeded'  # type: str
 
-    def __init__(self, markdown=None):
+    def __init__(self, markdown=''):
         # type: (str) -> None
         try:
             self.tile = json.loads(markdown)

connect/models/asset.py

@@ -6,7 +6,7 @@
 """
 
 from marshmallow import fields, post_load
-from typing import List
+from typing import List, Optional
 
 from .base import BaseModel, BaseSchema
 from .connection import Connection, ConnectionSchema
@@ -26,12 +26,14 @@ class Asset(BaseModel):
     tiers = None  # type: Tiers
 
     def get_param_by_id(self, id_):
+        # type: (str) -> Optional[Param]
         try:
             return list(filter(lambda param: param.id == id_, self.params))[0]
         except IndexError:
             return None
 
     def get_item_by_mpn(self, mpn):
+        # type: (str) -> Optional[Item]
         try:
             return list(filter(lambda item: item.mpn == mpn, self.items))[0]
         except IndexError:

connect/models/marketplace.py

@@ -78,7 +78,6 @@ class Contract(BaseModel):
     agreement = None  # type: Agreement
     marketplace = None  # type: Marketplace
     owner = None  # type: Company
-    creater = None  # type: Company
     created = None  # type: str
     updated = None  # type: str
     enrolled = None  # type: str
@@ -95,7 +94,6 @@ class ContractSchema(BaseSchema):
     agreement = fields.Nested(AgreementSchema, only=('id', 'name'))
     marketplace = fields.Nested(MarketplaceSchema, only=('id', 'name'))
     owner = fields.Nested(CompanySchema, only=('id', 'name'))
-    creater = fields.Nested(CompanySchema, only=('id', 'name'))
     created = fields.DateTime()
     updated = fields.DateTime()
     enrolled = fields.Str()

connect/models/parameters.py

@@ -16,6 +16,25 @@ class ValueChoice(BaseModel):
     label = None  # type: str
 
 
+class Constraints(BaseModel):
+    hidden = None  # type: bool
+    required = None  # type: bool
+    choices = None  # type: List[ValueChoice]
+
+
+class Param(BaseModel):
+    name = None  # type: str
+    type = None  # type: str
+    value = None  # type: str
+    value_choices = None  # type: List[ValueChoice]
+    value_error = None  # type: str
+
+    # Undocumented fields (they appear in PHP SDK)
+    title = None  # type: str
+    scope = None  # type: str
+    constraints = None  # type: Constraints
+
+
 class ValueChoiceSchema(Schema):
     value = fields.Str()
     label = fields.Str()
@@ -25,12 +44,14 @@ def make_object(self, data):
         return ValueChoice(**data)
 
 
-class Param(BaseModel):
-    name = None  # type: str
-    type = None  # type: str
-    value = None  # type: str
-    value_choices = None  # type: List[ValueChoice]
-    value_error = None  # type: str
+class ConstraintsSchema(BaseSchema):
+    hidden = fields.Bool()
+    required = fields.Bool()
+    choices = fields.List(fields.Nested(ValueChoiceSchema))
+
+    @post_load
+    def make_object(self, data):
+        return Constraints(**data)
 
 
 class ParamSchema(BaseSchema):
@@ -40,6 +61,11 @@ class ParamSchema(BaseSchema):
     value_choices = fields.List(fields.Nested(ValueChoiceSchema))
     value_error = fields.Str()
 
+    # Undocumented fields (they appear in PHP SDK)
+    title = fields.Str(required=False)
+    scope = fields.Str(required=False)
+    constraints = fields.Nested(ConstraintsSchema, required=False)
+
     @post_load
     def make_object(self, data):
         return Param(**data)

connect/models/tier_config.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+
+"""
+This file is part of the Ingram Micro Cloud Blue Connect SDK.
+Copyright (c) 2019 Ingram Micro. All Rights Reserved.
+"""
+from marshmallow import fields, post_load
+from typing import Optional, List
+
+from connect.models import Param, ParamSchema
+from connect.models.base import BaseModel, BaseSchema
+from connect.models.company import Company, CompanySchema
+from connect.models.connection import Connection, ConnectionSchema
+from connect.models.contact import ContactInfo, ContactInfoSchema
+from connect.models.product import Product, ProductSchema
+
+
+class Account(BaseModel):
+    name = None  # type: str
+    external_id = None  # type: str
+    external_uid = None  # type: str
+    contact_info = None  # type: ContactInfo
+
+
+class EventInfo(BaseModel):
+    at = None  # type: str
+    by = None  # type: Company
+
+
+class Events(BaseModel):
+    created = None  # type: EventInfo
+    inquired = None  # type: EventInfo
+    pended = None  # type: EventInfo
+    validated = None  # type: EventInfo
+    updated = None  # type: EventInfo
+
+
+class Template(BaseModel):
+    representation = None  # type: str
+
+
+class TierConfig(BaseModel):
+    name = None  # type: str
+    account = None  # type: Account
+    product = None  # type: Product
+    tier_level = None  # type: int
+    connection = None  # type: Connection
+    events = None  # type: Events
+    params = None  # type: List[Param]
+    template = None  # type: Template
+
+    # Undocumented fields (they appear in PHP SDK)
+    open_request = None  # type: BaseModel
+
+    def get_param_by_id(self, id_):
+        # type: (str) -> Optional[Param]
+        try:
+            return list(filter(lambda param: param.id == id_, self.params))[0]
+        except IndexError:
+            return None
+
+
+class Activation(BaseModel):
+    link = None  # type: str
+
+
+class TierConfigRequest(BaseModel):
+    type = None  # type: str
+    status = None  # type: str
+    configuration = None  # type: TierConfig
+    events = None  # type: Events
+    params = None  # type: List[Param]
+    assignee = None  # type: Company
+    template = None  # type: Template
+    activation = None  # type: Activation
+
+    def get_param_by_id(self, id_):
+        # type: (str) -> Optional[Param]
+        try:
+            return list(filter(lambda param: param.id == id_, self.params))[0]
+        except IndexError:
+            return None
+
+
+class AccountSchema(BaseSchema):
+    name = fields.Str()
+    external_id = fields.Str()
+    external_uid = fields.Str()
+    contact_info = fields.Nested(ContactInfoSchema)
+
+    @post_load
+    def make_object(self, data):
+        return Account(**data)
+
+
+class EventInfoSchema(BaseSchema):
+    at = fields.Str()
+    by = fields.Nested(CompanySchema)
+
+    @post_load
+    def make_object(self, data):
+        return EventInfo(**data)
+
+
+class EventsSchema(BaseSchema):
+    created = fields.Nested(EventInfoSchema)
+    inquired = fields.Nested(EventInfoSchema, required=False)
+    pended = fields.Nested(EventInfoSchema, required=False)
+    validated = fields.Nested(EventInfoSchema, required=False)
+    updated = fields.Nested(EventInfoSchema, required=False)
+
+    @post_load
+    def make_object(self, data):
+        return Events(**data)
+
+
+class TemplateSchema(BaseSchema):
+    representation = fields.Str()
+
+    @post_load
+    def make_object(self, data):
+        return Template(**data)
+
+
+class TierConfigSchema(BaseSchema):
+    name = fields.Str()
+    account = fields.Nested(AccountSchema)
+    product = fields.Nested(ProductSchema)
+    tier_level = fields.Int()
+    connection = fields.Nested(ConnectionSchema)
+    events = fields.Nested(EventsSchema)
+    params = fields.List(fields.Nested(ParamSchema))
+    template = fields.Nested(TemplateSchema)
+
+    # Undocumented fields (they appear in PHP SDK)
+    open_request = fields.Nested(BaseSchema)
+
+    @post_load
+    def make_object(self, data):
+        return TierConfig(**data)
+
+
+class ActivationSchema(BaseSchema):
+    link = fields.Str()
+
+    @post_load
+    def make_object(self, data):
+        return Activation(**data)
+
+
+class TierConfigRequestSchema(BaseSchema):
+    type = fields.Str()
+    status = fields.Str()
+    configuration = fields.Nested(TierConfigSchema)
+    events = fields.Nested(EventsSchema)
+    params = fields.List(fields.Nested(ParamSchema))
+    assignee = fields.Nested(CompanySchema)
+    template = fields.Nested(TemplateSchema)
+    activation = fields.Nested(ActivationSchema)
+
+    @post_load
+    def make_object(self, data):
+        return TierConfigRequest(**data)

connect/resource/__init__.py

@@ -6,12 +6,14 @@
 """
 
 from .fulfillment_automation import FulfillmentAutomation
-from .fulfillment import FulfillmentResource
+from .automation import AutomationResource
 from .template import TemplateResource
+from .tier_config_automation import TierConfigAutomation
 
 
 __all__ = [
     'FulfillmentAutomation',
-    'FulfillmentResource',
-    'TemplateResource'
+    'AutomationResource',
+    'TemplateResource',
+    'TierConfigAutomation',
 ]

connect/resource/fulfillment.py connect/resource/automation.pyconnect/resource/fulfillment.py renamed to connect/resource/automation.py

@@ -7,29 +7,37 @@
 
 import json
 
-from typing import List
+from typing import Any, List, Dict
 
 from connect.logger import function_log
-from connect.models import FulfillmentSchema, Param, ActivationTileResponse
+from connect.models import Param, ActivationTileResponse
 from .base import BaseResource
 from .template import TemplateResource
 from .utils import join_url
 
 
-class FulfillmentResource(BaseResource):
-    resource = 'requests'
+class AutomationResource(BaseResource):
     limit = 1000
-    schema = FulfillmentSchema()
 
     def build_filter(self):
-        # type: () -> dict
-        filters = super(FulfillmentResource, self).build_filter()
-        if self.config.products:
-            filters['asset.product.id__in'] = ','.join(self.config.products)
-
+        # type: () -> Dict[str, Any]
+        filters = super(AutomationResource, self).build_filter()
         filters['status'] = 'pending'
         return filters
 
+    def process(self):
+        # type: () -> None
+        for request in self.list:
+            self.dispatch(request)
+
+    def dispatch(self, request):
+        raise NotImplementedError('Please implement `{}.dispatch` method'
+                                  .format(self.__class__.__name__))
+
+    def process_request(self, request):
+        raise NotImplementedError('Please implement `{}.process_request` method'
+                                  .format(self.__class__.__name__))
+
     @function_log
     def approve(self, pk, data):
         # type: (str, dict) -> str
@@ -39,7 +47,8 @@ def approve(self, pk, data):
     @function_log
     def inquire(self, pk):
         # type: (str) -> str
-        return self.api.post(url=join_url(self._obj_url(pk), 'inquire/'), data=json.dumps({}))
+        url = join_url(self._obj_url(pk), 'inquire/')
+        return self.api.post(url=url, data=json.dumps({}))
 
     @function_log
     def fail(self, pk, reason):