Update the API classes to use an object factory

Update the API classes to use an object factory to create Python objects from returned Cisco Spark JSON data objects.

Author: cmlccie

ciscosparkapi/__init__.py

@@ -29,18 +29,10 @@
 from .exceptions import (
     SparkApiError, SparkRateLimitError, ciscosparkapiException,
 )
-from .models.access_token import AccessToken
-from .models.license import License
-from .models.membership import Membership
-from .models.message import Message
-from .models.organization import Organization
-from .models.person import Person
-from .models.role import Role
-from .models.room import Room
-from .models.team import Team
-from .models.team_membership import TeamMembership
-from .models.webhook import Webhook
-from .models.webhook_event import WebhookEvent
+from .models import (
+    AccessToken, License, Membership, Message, Organization, Person, Role,
+    Room, Team, TeamMembership, Webhook, WebhookEvent, sparkdata_factory,
+)
 from .restsession import (
     DEFAULT_SINGLE_REQUEST_TIMEOUT,
     DEFAULT_WAIT_ON_RATE_LIMIT,
@@ -82,34 +74,35 @@ class CiscoSparkAPI(object):
     CiscoSparkAPI wraps all of the individual Cisco Spark APIs and represents
     them in a simple hierarchical structure.
 
-    :CiscoSparkAPI: :class:`people <PeopleAPI>`
+    :CiscoSparkAPI: :class:`people <_PeopleAPI>`
 
-                    :class:`rooms <RoomsAPI>`
+                    :class:`rooms <_RoomsAPI>`
 
-                    :class:`memberships <MembershipsAPI>`
+                    :class:`memberships <_MembershipsAPI>`
 
-                    :class:`messages <MessagesAPI>`
+                    :class:`messages <_MessagesAPI>`
 
-                    :class:`teams <TeamsAPI>`
+                    :class:`teams <_TeamsAPI>`
 
-                    :class:`team_memberships <TeamMembershipsAPI>`
+                    :class:`team_memberships <_TeamMembershipsAPI>`
 
-                    :class:`webhooks <WebhooksAPI>`
+                    :class:`webhooks <_WebhooksAPI>`
 
-                    :class:`organizations <OrganizationsAPI>`
+                    :class:`organizations <_OrganizationsAPI>`
 
-                    :class:`licenses <LicensesAPI>`
+                    :class:`licenses <_LicensesAPI>`
 
-                    :class:`roles <RolesAPI>`
+                    :class:`roles <_RolesAPI>`
 
-                    :class:`access_tokens <AccessTokensAPI>`
+                    :class:`access_tokens <_AccessTokensAPI>`
 
     """
 
     def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                  timeout=None,
                  single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
-                 wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT):
+                 wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT,
+                 object_factory=sparkdata_factory):
         """Create a new CiscoSparkAPI object.
 
         An access token must be used when interacting with the Cisco Spark API.
@@ -138,6 +131,8 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                 ciscosparkapi.DEFAULT_SINGLE_REQUEST_TIMEOUT.
             wait_on_rate_limit(bool): Enables or disables automatic rate-limit
                 handling. Defaults to ciscosparkapi.DEFAULT_WAIT_ON_RATE_LIMIT.
+            object_factory(callable): The factory function to use to create
+                Python objects from the returned Cisco Spark JSON data objects.
 
         Returns:
             CiscoSparkAPI: A new CiscoSparkAPI object.
@@ -176,17 +171,21 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
         )
 
         # Spark API wrappers
-        self.people = _PeopleAPI(self._session)
-        self.rooms = _RoomsAPI(self._session)
-        self.memberships = _MembershipsAPI(self._session)
-        self.messages = _MessagesAPI(self._session)
-        self.teams = _TeamsAPI(self._session)
-        self.team_memberships = _TeamMembershipsAPI(self._session)
-        self.webhooks = _WebhooksAPI(self._session)
-        self.organizations = _OrganizationsAPI(self._session)
-        self.licenses = _LicensesAPI(self._session)
-        self.roles = _RolesAPI(self._session)
-        self.access_tokens = _AccessTokensAPI(self.base_url, timeout=timeout)
+        self.people = _PeopleAPI(self._session, object_factory)
+        self.rooms = _RoomsAPI(self._session, object_factory)
+        self.memberships = _MembershipsAPI(self._session, object_factory)
+        self.messages = _MessagesAPI(self._session, object_factory)
+        self.teams = _TeamsAPI(self._session, object_factory)
+        self.team_memberships = _TeamMembershipsAPI(
+            self._session, object_factory
+        )
+        self.webhooks = _WebhooksAPI(self._session, object_factory)
+        self.organizations = _OrganizationsAPI(self._session, object_factory)
+        self.licenses = _LicensesAPI(self._session, object_factory)
+        self.roles = _RolesAPI(self._session, object_factory)
+        self.access_tokens = _AccessTokensAPI(
+            self.base_url, object_factory, timeout=single_request_timeout
+        )
 
     @property
     def access_token(self):

ciscosparkapi/api/access_tokens.py

@@ -16,7 +16,6 @@
 from past.builtins import basestring
 import requests
 
-from ..models.access_token import AccessToken
 from ..response_codes import EXPECTED_RESPONSE_CODE
 from ..utils import (
     check_response_code,
@@ -36,7 +35,8 @@
 standard_library.install_aliases()
 
 
-API_ENDPOINT = "access_token"
+API_ENDPOINT = 'access_token'
+OBJECT_TYPE = 'access_token'
 
 
 class AccessTokensAPI(object):
@@ -47,7 +47,7 @@ class AccessTokensAPI(object):
 
     """
 
-    def __init__(self, base_url, timeout=None):
+    def __init__(self, base_url, object_factory, timeout=None):
         """Initialize an AccessTokensAPI object with the provided RestSession.
 
         Args:
@@ -68,6 +68,8 @@ def __init__(self, base_url, timeout=None):
         self._endpoint_url = urllib.parse.urljoin(self.base_url, API_ENDPOINT)
         self._request_kwargs = {"timeout": timeout}
 
+        self._object_factory = object_factory
+
     @property
     def base_url(self):
         """The base URL the API endpoints."""
@@ -121,8 +123,8 @@ def get(self, client_id, client_secret, code, redirect_uri):
         check_response_code(response, EXPECTED_RESPONSE_CODE['POST'])
         json_data = extract_and_parse_json(response)
 
-        # Return a AccessToken object created from the response JSON data
-        return AccessToken(json_data)
+        # Return a access_token object created from the response JSON data
+        return self._object_factory(OBJECT_TYPE, json_data)
 
     def refresh(self, client_id, client_secret, refresh_token):
         """Return a refreshed Access Token from the provided refresh_token.
@@ -161,4 +163,4 @@ def refresh(self, client_id, client_secret, refresh_token):
         json_data = extract_and_parse_json(response)
 
         # Return a AccessToken object created from the response JSON data
-        return AccessToken(json_data)
+        return self._object_factory(OBJECT_TYPE, json_data)

ciscosparkapi/api/licenses.py

@@ -14,7 +14,6 @@
 from past.builtins import basestring
 
 from ..generator_containers import generator_container
-from ..models.license import License
 from ..restsession import RestSession
 from ..utils import (
     check_type,
@@ -28,6 +27,10 @@
 __license__ = "MIT"
 
 
+API_ENDPOINT = 'licenses'
+OBJECT_TYPE = 'license'
+
+
 class LicensesAPI(object):
     """Cisco Spark Licenses API.
 
@@ -36,7 +39,7 @@ class LicensesAPI(object):
 
     """
 
-    def __init__(self, session):
+    def __init__(self, session, object_factory):
         """Initialize a new LicensesAPI object with the provided RestSession.
 
         Args:
@@ -52,6 +55,7 @@ def __init__(self, session):
         super(LicensesAPI, self).__init__()
 
         self._session = session
+        self._object_factory = object_factory
 
     @generator_container
     def list(self, orgId=None, max=None, **request_parameters):
@@ -96,11 +100,11 @@ def list(self, orgId=None, max=None, **request_parameters):
         )
 
         # API request - get items
-        items = self._session.get_items('licenses', params=params)
+        items = self._session.get_items(API_ENDPOINT, params=params)
 
-        # Yield License objects created from the returned JSON objects
+        # Yield license objects created from the returned JSON objects
         for item in items:
-            yield License(item)
+            yield self._object_factory(OBJECT_TYPE, item)
 
     def get(self, licenseId):
         """Get the details of a License, by ID.
@@ -120,7 +124,7 @@ def get(self, licenseId):
         check_type(licenseId, basestring, may_be_none=False)
 
         # API request
-        json_data = self._session.get('licenses/' + licenseId)
+        json_data = self._session.get(API_ENDPOINT + '/' + licenseId)
 
-        # Return a License object created from the returned JSON object
-        return License(json_data)
+        # Return a license object created from the returned JSON object
+        return self._object_factory(OBJECT_TYPE, json_data)

ciscosparkapi/api/memberships.py

@@ -14,7 +14,6 @@
 from past.builtins import basestring
 
 from ..generator_containers import generator_container
-from ..models.membership import Membership
 from ..restsession import RestSession
 from ..utils import (
     check_type,
@@ -28,6 +27,10 @@
 __license__ = "MIT"
 
 
+API_ENDPOINT = 'memberships'
+OBJECT_TYPE = 'membership'
+
+
 class MembershipsAPI(object):
     """Cisco Spark Memberships API.
 
@@ -36,7 +39,7 @@ class MembershipsAPI(object):
 
     """
 
-    def __init__(self, session):
+    def __init__(self, session, object_factory):
         """Init a new MembershipsAPI object with the provided RestSession.
 
         Args:
@@ -52,6 +55,7 @@ def __init__(self, session):
         super(MembershipsAPI, self).__init__()
 
         self._session = session
+        self._object_factory = object_factory
 
     @generator_container
     def list(self, roomId=None, personId=None, personEmail=None, max=None,
@@ -110,11 +114,11 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None,
         )
 
         # API request - get items
-        items = self._session.get_items('memberships', params=params)
+        items = self._session.get_items(API_ENDPOINT, params=params)
 
-        # Yield Person objects created from the returned items JSON objects
+        # Yield membership objects created from the returned items JSON objects
         for item in items:
-            yield Membership(item)
+            yield self._object_factory(OBJECT_TYPE, item)
 
     def create(self, roomId, personId=None, personEmail=None,
                isModerator=False, **request_parameters):
@@ -154,10 +158,10 @@ def create(self, roomId, personId=None, personEmail=None,
         )
 
         # API request
-        json_data = self._session.post('memberships', json=post_data)
+        json_data = self._session.post(API_ENDPOINT, json=post_data)
 
-        # Return a Membership object created from the response JSON data
-        return Membership(json_data)
+        # Return a membership object created from the response JSON data
+        return self._object_factory(OBJECT_TYPE, json_data)
 
     def get(self, membershipId):
         """Get details for a membership, by ID.
@@ -177,10 +181,10 @@ def get(self, membershipId):
         check_type(membershipId, basestring, may_be_none=False)
 
         # API request
-        json_data = self._session.get('memberships/' + membershipId)
+        json_data = self._session.get(API_ENDPOINT + '/' + membershipId)
 
-        # Return a Membership object created from the response JSON data
-        return Membership(json_data)
+        # Return a membership object created from the response JSON data
+        return self._object_factory(OBJECT_TYPE, json_data)
 
     def update(self, membershipId, isModerator=None, **request_parameters):
         """Update properties for a membership, by ID.
@@ -209,11 +213,11 @@ def update(self, membershipId, isModerator=None, **request_parameters):
         )
 
         # API request
-        json_data = self._session.put('memberships/' + membershipId,
+        json_data = self._session.put(API_ENDPOINT + '/' + membershipId,
                                       json=put_data)
 
-        # Return a Membership object created from the response JSON data
-        return Membership(json_data)
+        # Return a membership object created from the response JSON data
+        return self._object_factory(OBJECT_TYPE, json_data)
 
     def delete(self, membershipId):
         """Delete a membership, by ID.
@@ -229,4 +233,4 @@ def delete(self, membershipId):
         check_type(membershipId, basestring)
 
         # API request
-        self._session.delete('memberships/' + membershipId)
+        self._session.delete(API_ENDPOINT + '/' + membershipId)