Merge branch 'CPS-21-deserialize' into CPS-8-get-tier-config

Author: JaviCerveraIngram

connect/models/__init__.py

@@ -6,7 +6,7 @@
 from .activation_response import ActivationTemplateResponse, ActivationTileResponse
 from .asset import Asset
 from .base import BaseModel
-from .company import Company
+from .company import Company, User
 from .connection import Connection
 from .contact import Contact, ContactInfo, PhoneNumber
 from .event import EventInfo, Events
@@ -63,5 +63,6 @@
     'UsageListing',
     'UsageRecord',
     'UsageRecords',
+    'User',
     'ValueChoice',
 ]

connect/models/company.py

@@ -4,7 +4,7 @@
 # Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 
 from .base import BaseModel
-from connect.models.schemas import CompanySchema
+from connect.models.schemas import CompanySchema, UserSchema
 
 
 class Company(BaseModel):
@@ -14,3 +14,12 @@ class Company(BaseModel):
 
     name = None  # type: str
     """ (str) Company name. """
+
+
+class User(BaseModel):
+    """ Represents a user within the platform. """
+
+    _schema = UserSchema()
+
+    name = None  # type: str
+    """ (str) User name. """

connect/models/event.py

@@ -7,7 +7,7 @@
 from typing import Optional
 
 from .base import BaseModel
-from .company import Company
+from .company import User
 from connect.models.schemas import EventInfoSchema, EventsSchema
 
 
@@ -19,8 +19,8 @@ class EventInfo(BaseModel):
     at = None  # type: Optional[datetime.datetime]
     """ (datetime.datetime|None) Date when the event occurred. """
 
-    by = None  # type: Optional[Company]
-    """ (:py:class:`.Company`) User that caused the event. """
+    by = None  # type: Optional[User]
+    """ (:py:class:`.User`) User that caused the event. """
 
 
 class Events(BaseModel):

connect/models/marketplace.py

@@ -7,7 +7,7 @@
 from typing import Optional, List
 
 from .base import BaseModel
-from .company import Company
+from .company import Company, User
 from .hub import ExtIdHub
 from connect.models.schemas import MarketplaceSchema, AgreementStatsSchema, AgreementSchema, \
     ActivationSchema, ContractSchema
@@ -88,8 +88,8 @@ class Agreement(BaseModel):
     stats = None  # type: Optional[AgreementStats]
     """ (:py:class:`.AgreementStats` | None) Agreement stats. """
 
-    author = None  # type: Optional[Company]
-    """ (:py:class:`.Company` | None) Reference to the user who created the version. """
+    author = None  # type: Optional[User]
+    """ (:py:class:`.User` | None) Reference to the user who created the version. """
 
     version = None  # type: int
     """ (int) Chronological number of the version. """
@@ -165,8 +165,8 @@ class Contract(BaseModel):
     owner = None  # type: Optional[Company]
     """ (:py:class:`.Company` | None) Reference object to the owner company. """
 
-    creator = None  # type: Company
-    """ (:py:class:`.Company`) Reference object to the creator company. """
+    creator = None  # type: User
+    """ (:py:class:`.User`) Reference object to the creator. """
 
     created = None  # type: datetime.datetime
     """ (datetime.datetime) Contract creation date. """
@@ -183,7 +183,7 @@ class Contract(BaseModel):
     activation = None  # type: Activation
     """ (:py:class:`.Activation`) Activation information. """
 
-    signee = None  # type: Optional[Company]
-    """ (:py:class:`.Company` | None) Reference object to the user of the owner company,
+    signee = None  # type: Optional[User]
+    """ (:py:class:`.User` | None) Reference object to the user of the owner company,
     who signed the contract.
     """

connect/models/schemas.py

@@ -4,6 +4,7 @@
 # Copyright (c) 2019 Ingram Micro. All Rights Reserved.
 
 from marshmallow import Schema, fields, post_load
+import six
 
 
 class BaseSchema(Schema):
@@ -138,9 +139,18 @@ def make_object(self, data):
         return DownloadLink(**data)
 
 
+class UserSchema(BaseSchema):
+    name = fields.Str()
+
+    @post_load
+    def make_object(self, data):
+        from connect.models import User
+        return User(**data)
+
+
 class EventInfoSchema(BaseSchema):
     at = fields.DateTime(allow_none=True)
-    by = fields.Nested(CompanySchema, allow_none=True)
+    by = fields.Nested(UserSchema, allow_none=True)
 
     @post_load
     def make_object(self, data):
@@ -216,25 +226,36 @@ def make_object(self, data):
         return Renewal(**data)
 
 
+class QuantityField(fields.Field):
+    def _deserialize(self, value, attr, obj, **kwargs):
+        if isinstance(value, six.string_types):
+            if value == 'unlimited':
+                return -1
+            else:
+                try:
+                    float_val = float(value)
+                    int_val = int(float_val)
+                    return int_val if int_val == float_val else float_val
+                except ValueError:
+                    raise ValueError({
+                        attr: [u'Not a valid string encoded number nor "unlimited".']
+                    })
+        elif isinstance(value, (int, float)):
+            return value
+        else:
+            raise ValueError({attr: [u'Not a valid int, float or string.']})
+
+
 class ItemSchema(BaseSchema):
     mpn = fields.Str()
-    quantity = fields.Str()
-    old_quantity = fields.Str(allow_none=True)
+    quantity = QuantityField()
+    old_quantity = QuantityField(allow_none=True)
     renewal = fields.Nested(RenewalSchema, allow_none=True)
     global_id = fields.Str()
 
     @post_load
     def make_object(self, data):
         from connect.models import Item
-        params = ('quantity', 'old_quantity')
-        for param in params:
-            if param in data:
-                if data[param] != 'unlimited':
-                    float_val = float(data[param])
-                    int_val = int(float_val)
-                    data[param] = int_val if float_val == int_val else float_val
-                else:
-                    data[param] = -1
         return Item(**data)
 
 
@@ -261,7 +282,7 @@ class AgreementSchema(BaseSchema):
     updated = fields.DateTime()
     owner = fields.Nested(CompanySchema)
     stats = fields.Nested(AgreementStatsSchema, allow_none=True)
-    author = fields.Nested(CompanySchema, allow_none=True)
+    author = fields.Nested(UserSchema, allow_none=True)
     version = fields.Int()
     active = fields.Bool()
     link = fields.Str()
@@ -285,13 +306,13 @@ class ContractSchema(BaseSchema):
     agreement = fields.Nested(AgreementSchema, only=('id', 'name'))
     marketplace = fields.Nested(MarketplaceSchema, only=('id', 'name'), allow_none=True)
     owner = fields.Nested(CompanySchema, only=('id', 'name'), allow_none=True)
-    creator = fields.Nested(CompanySchema, only=('id', 'name'))
+    creator = fields.Nested(UserSchema, only=('id', 'name'))
     created = fields.DateTime()
     updated = fields.DateTime()
     enrolled = fields.DateTime(allow_none=True)
     version_created = fields.DateTime()
     activation = fields.Nested(ActivationSchema)
-    signee = fields.Nested(CompanySchema, only=('id', 'name'), allow_none=True)
+    signee = fields.Nested(UserSchema, only=('id', 'name'), allow_none=True)
 
     @post_load
     def make_object(self, data):
@@ -471,7 +492,7 @@ class TierConfigRequestSchema(BaseSchema):
     configuration = fields.Nested(TierConfigSchema)
     events = fields.Nested(EventsSchema, allow_none=True)
     params = fields.Nested(ParamSchema, many=True)
-    assignee = fields.Nested(CompanySchema, allow_none=True)
+    assignee = fields.Nested(UserSchema, allow_none=True)
     template = fields.Nested(TemplateSchema, allow_none=True)
     reason = fields.Str(allow_none=True)
     activation = fields.Nested(ActivationSchema, allow_none=True)

connect/models/tier_config.py

@@ -6,7 +6,7 @@
 from typing import Optional, List
 
 from .base import BaseModel
-from .company import Company
+from .company import User
 from .connection import Connection
 from .contact import ContactInfo
 from .event import Events
@@ -139,8 +139,8 @@ class TierConfigRequest(BaseModel):
     Params can be modified only in Pending state.
     """
 
-    assignee = None  # type: Optional[Company]
-    """ (:py:class:`.Company` | None) TCR environment. One of: test, prod, preview. """
+    assignee = None  # type: Optional[User]
+    """ (:py:class:`.User` | None) TCR environment. One of: test, prod, preview. """
 
     template = None  # type: Optional[Template]
     """ (:py:class:`.Template` | None) Template Object. This is filled only if TCR is approved. """

tests/test_tier_config.py

@@ -13,7 +13,7 @@
 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
+    Template, Activation, Account, User
 from connect.resources import TierConfigAutomation
 from .common import Response, load_str
 
@@ -95,7 +95,7 @@ def test_create_resource():
     assert isinstance(events.updated, EventInfo)
     assert isinstance(events.updated.at, datetime)
     assert str(events.updated.at) == '2018-11-21 11:10:29'
-    assert isinstance(events.updated.by, Company)
+    assert isinstance(events.updated.by, User)
     assert events.updated.by.id == 'PA-000-000'
     assert events.updated.by.name == 'Username'
 
@@ -124,13 +124,13 @@ def test_create_resource():
     assert isinstance(events.inquired, EventInfo)
     assert isinstance(events.inquired.at, datetime)
     assert str(events.inquired.at) == '2018-11-21 11:10:29'
-    assert isinstance(events.inquired.by, Company)
+    assert isinstance(events.inquired.by, User)
     assert events.inquired.by.id == 'PA-000-000'
     assert events.inquired.by.name == 'Username'
     assert isinstance(events.pended, EventInfo)
     assert isinstance(events.pended.at, datetime)
     assert str(events.pended.at) == '2018-11-21 11:10:29'
-    assert isinstance(events.pended.by, Company)
+    assert isinstance(events.pended.by, User)
     assert events.pended.by.id == 'PA-000-001'
     assert events.pended.by.name == 'Username1'
     assert not events.validated
@@ -144,7 +144,7 @@ def test_create_resource():
     assert request.params[0].value == 'param_a_value'
 
     assignee = request.assignee
-    assert isinstance(assignee, Company)
+    assert isinstance(assignee, User)
     assert assignee.id == 'PA-000-000'
     assert assignee.name == 'Username'