Move data models to ciscosparkapi.models

Separate the data models from the API modules by moving them into their own modules and package.

Author: cmlccie

ciscosparkapi/__init__.py

@@ -2,71 +2,59 @@
 """Python API wrapper for the Cisco Spark APIs."""
 
 
-# Use future for Python v2 and v3 compatibility
 from __future__ import (
     absolute_import,
     division,
     print_function,
     unicode_literals,
 )
-from builtins import *
-from past.builtins import basestring
-
-
-__author__ = "Chris Lunsford"
-__author_email__ = "[email protected]"
-__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
-__license__ = "MIT"
-__all__ = [
-    "CiscoSparkAPI", "ciscosparkapiException", "SparkApiError",
-    "SparkRateLimitError", "Person", "Room", "Membership", "Message", "Team",
-    "TeamMembership", "Webhook", "WebhookEvent", "Organization", "License",
-    "Role", "AccessToken"
-]
-
 
+from builtins import *
 import logging
 import os
 
-from .api.people import Person
-from .api.rooms import Room
-from .api.memberships import Membership
-from .api.messages import Message
-from .api.teams import Team
-from .api.team_memberships import TeamMembership
-from .api.webhooks import Webhook, WebhookEvent
-from .api.organizations import Organization
-from .api.licenses import License
-from .api.roles import Role
-from .api.access_tokens import AccessToken
+from past.builtins import basestring
 
-from .api.people import PeopleAPI as _PeopleAPI
-from .api.rooms import RoomsAPI as _RoomsAPI
+from .api.access_tokens import AccessTokensAPI as _AccessTokensAPI
+from .api.licenses import LicensesAPI as _LicensesAPI
 from .api.memberships import MembershipsAPI as _MembershipsAPI
 from .api.messages import MessagesAPI as _MessagesAPI
-from .api.teams import TeamsAPI as _TeamsAPI
-from .api.team_memberships import TeamMembershipsAPI as _TeamMembershipsAPI
-from .api.webhooks import WebhooksAPI as _WebhooksAPI
 from .api.organizations import OrganizationsAPI as _OrganizationsAPI
-from .api.licenses import LicensesAPI as _LicensesAPI
+from .api.people import PeopleAPI as _PeopleAPI
 from .api.roles import RolesAPI as _RolesAPI
-from .api.access_tokens import AccessTokensAPI as _AccessTokensAPI
-
+from .api.rooms import RoomsAPI as _RoomsAPI
+from .api.team_memberships import TeamMembershipsAPI as _TeamMembershipsAPI
+from .api.teams import TeamsAPI as _TeamsAPI
+from .api.webhooks import WebhooksAPI as _WebhooksAPI
 from .exceptions import (
-    ciscosparkapiException,
-    SparkApiError,
-    SparkRateLimitError,
+    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 .restsession import (
     DEFAULT_SINGLE_REQUEST_TIMEOUT,
     DEFAULT_WAIT_ON_RATE_LIMIT,
     RestSession as _RestSession,
 )
-
 from .utils import check_type
 
 
+__author__ = "Chris Lunsford"
+__author_email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
+__license__ = "MIT"
+
+
 # Versioneer version control
 from ._version import get_versions
 __version__ = get_versions()['version']

ciscosparkapi/api/access_tokens.py

@@ -1,40 +1,23 @@
 # -*- coding: utf-8 -*-
-"""Cisco Spark Access-Tokens API wrapper.
+"""Cisco Spark Access-Tokens API."""
 
-Classes:
-    AccessToken: Models a Spark 'access token' JSON object as a native Python
-        object.
-    AccessTokensAPI: Wraps the Cisco Spark Access-Tokens API and exposes the
-        API as native Python methods that return native Python objects.
 
-"""
-
-
-# Use future for Python v2 and v3 compatibility
 from __future__ import (
     absolute_import,
     division,
     print_function,
     unicode_literals,
 )
-from builtins import *
-from past.builtins import basestring
-from future import standard_library
-standard_library.install_aliases()
-
-
-__author__ = "Chris Lunsford"
-__author_email__ = "[email protected]"
-__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
-__license__ = "MIT"
-
 
+from builtins import *
 import urllib.parse
 
+from future import standard_library
+from past.builtins import basestring
 import requests
 
+from ..models.access_token import AccessToken
 from ..response_codes import EXPECTED_RESPONSE_CODE
-from ..sparkdata import SparkData
 from ..utils import (
     check_response_code,
     check_type,
@@ -44,47 +27,20 @@
 )
 
 
-API_ENDPOINT = "access_token"
-
-
-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)
+__author__ = "Chris Lunsford"
+__author_email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
+__license__ = "MIT"
 
-    @property
-    def access_token(self):
-        """Cisco Spark access token."""
-        return self._json_data.get('access_token')
 
-    @property
-    def expires_in(self):
-        """Access token expiry time (in seconds)."""
-        return self._json_data.get('expires_in')
+standard_library.install_aliases()
 
-    @property
-    def refresh_token(self):
-        """Refresh token used to request a new/refreshed access token."""
-        return self._json_data.get('refresh_token')
 
-    @property
-    def refresh_token_expires_in(self):
-        """Refresh token expiry time (in seconds)."""
-        return self._json_data.get('refresh_token_expires_in')
+API_ENDPOINT = "access_token"
 
 
 class AccessTokensAPI(object):
-    """Cisco Spark Access-Tokens API wrapper.
+    """Cisco Spark Access-Tokens API.
 
     Wraps the Cisco Spark Access-Tokens API and exposes the API as native
     Python methods that return native Python objects.
@@ -138,7 +94,7 @@ def get(self, client_id, client_secret, code, redirect_uri):
                 process.
 
         Returns:
-            AccessToken: An AccessToken object with the access token provided
+            ciscosparkapi.AccessToken: An AccessToken object with the access token provided
                 by the Cisco Spark cloud.
 
         Raises:

ciscosparkapi/api/licenses.py

@@ -1,78 +1,35 @@
 # -*- coding: utf-8 -*-
-"""Cisco Spark Licenses API wrapper.
+"""Cisco Spark Licenses API."""
 
-Classes:
-    License: Models a Spark License JSON object as a native Python object.
-    LicensesAPI: Wraps the Cisco Spark Licenses API and exposes the API as
-        native Python methods that return native Python objects.
 
-"""
-
-
-# Use future for Python v2 and v3 compatibility
 from __future__ import (
     absolute_import,
     division,
     print_function,
     unicode_literals,
 )
-from builtins import *
-from past.builtins import basestring
 
+from builtins import *
 
-__author__ = "Chris Lunsford"
-__author_email__ = "[email protected]"
-__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
-__license__ = "MIT"
-
+from past.builtins import basestring
 
 from ..generator_containers import generator_container
+from ..models.license import License
 from ..restsession import RestSession
-from ..sparkdata import SparkData
 from ..utils import (
     check_type,
     dict_from_items_with_values,
 )
 
 
-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)
-
-    @property
-    def id(self):
-        """The unique ID for the License."""
-        return self._json_data.get('id')
-
-    @property
-    def name(self):
-        """The name of the License."""
-        return self._json_data.get('name')
-
-    @property
-    def totalUnits(self):
-        """The total number of license units."""
-        return self._json_data.get('totalUnits')
-
-    @property
-    def consumedUnits(self):
-        """The total number of license units consumed."""
-        return self._json_data.get('consumedUnits')
+__author__ = "Chris Lunsford"
+__author_email__ = "[email protected]"
+__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
+__license__ = "MIT"
 
 
 class LicensesAPI(object):
-    """Cisco Spark Licenses API wrapper.
+    """Cisco Spark Licenses API.
 
     Wraps the Cisco Spark Licenses API and exposes the API as native Python
     methods that return native Python objects.