Refactor SparkData sub-classes to mixins and create composed data model classes and factory function

Refactor the SparkData sub-classes (Room, Message, Webhook, etc.) containing basic data attributes to be mixin classes.  Then create the actual data model classes as classes composed from the SparkData base class and the appropriate mixins.  This will enable further composability in the ciscosparksdk package and in user implementations of custom data models.

Then create a factory function for generating objects from the set of data model classes.  The API methods will be updated to use factory functions to enable data model selection at run time.

Author: cmlccie

ciscosparkapi/models/__init__.py

@@ -1 +1,108 @@
 # -*- coding: utf-8 -*-
+"""Cisco Spark data models."""
+
+
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals,
+)
+
+from collections import defaultdict
+
+from .access_token import AccessTokenBasicPropertiesMixin
+from .license import LicenseBasicPropertiesMixin
+from .membership import MembershipBasicPropertiesMixin
+from .message import MessageBasicPropertiesMixin
+from .organization import OrganizationBasicPropertiesMixin
+from .person import PersonBasicPropertiesMixin
+from .role import RoleBasicPropertiesMixin
+from .room import RoomBasicPropertiesMixin
+from .sparkdata import SparkData
+from .team import TeamBasicPropertiesMixin
+from .team_membership import TeamMembershipBasicPropertiesMixin
+from .webhook import WebhookBasicPropertiesMixin
+from .webhook_event import WebhookEventBasicPropertiesMixin
+
+
+__author__ = "Chris Lunsford"
+__author_email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
+__license__ = "MIT"
+
+
+class AccessToken(SparkData, AccessTokenBasicPropertiesMixin):
+    """Cisco Spark Access-Token data model."""
+
+
+class License(SparkData, LicenseBasicPropertiesMixin):
+    """Cisco Spark License data model."""
+
+
+class Membership(SparkData, MembershipBasicPropertiesMixin):
+    """Cisco Spark Membership data model."""
+
+
+class Message(SparkData, MessageBasicPropertiesMixin):
+    """Cisco Spark Message data model."""
+
+
+class Organization(SparkData, OrganizationBasicPropertiesMixin):
+    """Cisco Spark Organization data model."""
+
+
+class Person(SparkData, PersonBasicPropertiesMixin):
+    """Cisco Spark Person data model."""
+
+
+class Role(SparkData, RoleBasicPropertiesMixin):
+    """Cisco Spark Role data model."""
+
+
+class Team(SparkData, TeamBasicPropertiesMixin):
+    """Cisco Spark Team data model."""
+
+
+class TeamMembership(SparkData, TeamMembershipBasicPropertiesMixin):
+    """Cisco Spark Team-Membership data model."""
+
+
+class Webhook(SparkData, WebhookBasicPropertiesMixin):
+    """Cisco Spark Webhook data model."""
+
+
+class WebhookEvent(SparkData, WebhookEventBasicPropertiesMixin):
+    """Cisco Spark Webhook-Events data model."""
+
+
+sparkdata_models = defaultdict(
+    lambda: SparkData,
+    access_token=AccessToken,
+    license=License,
+    membership=Membership,
+    message=Message,
+    organization=Organization,
+    person=Person,
+    role=Role,
+    team=Team,
+    team_membership=TeamMembership,
+    webhook=Webhook,
+    webhook_event=WebhookEvent,
+)
+
+
+def sparkdata_factory(model, json_data):
+    """Factory function for creating SparkData objects.
+
+    Args:
+        model(basestring): The data model to use when creating the SparkData
+            object (message, room, membership, etc.).
+        json_data(basestring, dict): The JSON string or dictionary data with
+            which to initialize the object.
+
+    Returns:
+        SparkData: The created SparkData object.
+
+    """
+    return sparkdata_models[model](json_data)

ciscosparkapi/models/access_token.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class AccessToken(SparkData):
-    """Model a Spark 'access token' JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Init a new AccessToken data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(AccessToken, self).__init__(json)
+class AccessTokenBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def access_token(self):

ciscosparkapi/models/license.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class License(SparkData):
-    """Model a Spark License JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a License data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(License, self).__init__(json)
+class LicenseBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):

ciscosparkapi/models/membership.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class Membership(SparkData):
-    """Model a Spark 'membership' JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a Membership object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Membership, self).__init__(json)
+class MembershipBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):

ciscosparkapi/models/message.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class Message(SparkData):
-    """Model a Spark 'message' JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a Message data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Message, self).__init__(json)
+class MessageBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):

ciscosparkapi/models/organization.py

@@ -20,20 +20,8 @@
 __license__ = "MIT"
 
 
-class Organization(SparkData):
-    """Model a Spark Organization JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Init a Organization data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Organization, self).__init__(json)
+class OrganizationBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):

ciscosparkapi/models/person.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class Person(SparkData):
-    """Model a Spark person JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a Person data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Person, self).__init__(json)
+class PersonBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def type(self):

ciscosparkapi/models/role.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class Role(SparkData):
-    """Model a Spark Role JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a new Role data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Role, self).__init__(json)
+class RoleBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):

ciscosparkapi/models/room.py

@@ -11,29 +11,15 @@
 
 from builtins import *
 
-from .sparkdata import SparkData
-
 
 __author__ = "Chris Lunsford"
 __author_email__ = "[email protected]"
 __copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
 __license__ = "MIT"
 
 
-class Room(SparkData):
-    """Model a Spark 'room' JSON object as a native Python object."""
-
-    def __init__(self, json):
-        """Initialize a Room data object from a dictionary or JSON string.
-
-        Args:
-            json(dict, basestring): Input dictionary or JSON string.
-
-        Raises:
-            TypeError: If the input object is not a dictionary or string.
-
-        """
-        super(Room, self).__init__(json)
+class RoomBasicPropertiesMixin(object):
+    """A mixin for :class:`SparkData` classes."""
 
     @property
     def id(self):
@@ -52,7 +38,7 @@ def type(self):
 
     @property
     def isLocked(self):
-        """Whether or not the room is locked and controled by moderator(s)."""
+        """Whether or not the room is locked and controlled by moderator(s)."""
         return self._json_data.get('isLocked')
 
     @property