Merge branch 'master' into fix-attachment-actions

Author: jianchen2580

docs/contributing.rst

@@ -31,11 +31,11 @@ Notes on the Test Suite
 
 To test all the API endpoints, the account that you use for testing must be an *admin* user for your Webex Teams Organization.  Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite. We strongly recommend *NOT* running the test suite using your personal Webex Teams account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).
 
-If you cannot create a test account with *admin* privileges or configure your environment to run the test suite locally, you may always submit your code via a pull request.  Our GitHub/Travis CI setup runs the test suite against all pull requests.  All tests must pass before your pull request is accepted.
+If you cannot create a test account with *admin* privileges or configure your environment to run the test suite locally, you may always submit your code via a pull request.  We will test your code before merging and releasing the changes.
 
 
-Contributing Code - Using the CI Automated Testing
---------------------------------------------------
+Contributing Code
+-----------------
 
 1. Check for open `issues`_ or create a new *issue* for the item you want to work on and make sure to comment and let us know that you are working on it.
 
@@ -57,54 +57,33 @@ Contributing Code - Using the CI Automated Testing
 
 7. Commit your changes.
 
-8. Submit a `pull request`_.  The GitHub/Travis CI system runs the test suite against your pull request code.  If any tests fail, please review your changes.  If everything looks good, we will gladly merge your request!
-
-
-Contributing Code - Running the Test Suite Locally
---------------------------------------------------
-
-1. Check for open `issues`_ or create a new 'issue' for the item you want to work on and make sure to comment and let us know that you are working on it.
-
-2. Fork a copy of the `repository`_ and clone your forked repository to your development environment.
-
-   Run ``script/setup`` to install the development dependencies and setup your environment.
-
-3. Configure the following environment variables in your development environment:
+8. Submit a `pull request`_.
 
-   * ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
-
-   * ``WEBEX_TEAMS_TEST_DOMAIN`` - The test suite creates some users as part of the testing process. The test suite uses this domain name as the e-mail suffix of for the user's e-mail addresses.
-
-   * ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
-
-   * ``WEBEX_TEAMS_TEST_FILE_URL`` - Configure this environment variable with a URL referencing a file that can be downloaded and posted to Webex Teams as part of the testing process.
 
-   *Example:*
+Running the Test Suite Locally
+------------------------------
 
-   .. code-block:: bash
+Configure the following environment variables in your development environment:
 
-       #!/usr/bin/env bash
-       export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
-       export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
-       export WEBEX_TEAMS_TEST_ID_START=42
-       export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
+* ``WEBEX_TEAMS_ACCESS_TOKEN`` - Your test account's Webex Teams access token.
 
+* ``WEBEX_TEAMS_TEST_DOMAIN`` - The test suite creates some users as part of the testing process. The test suite uses this domain name as the e-mail suffix of for the user's e-mail addresses.
 
-4. Add your code to your forked repository.
+* ``WEBEX_TEAMS_TEST_ID_START`` - The test suite uses this integer as the starting number for creating test user accounts (example: "test42@domain.com").
 
-   If you are creating some new feature or functionality (excellent!), please also write a `test`_ to verify that your code works as expected.
-
-5. We follow `PEP8`_ reasonably strictly for this project.  Please make sure your code passes the linter.
-
-   Run ``script/test lint`` or simply run ``flake8`` from the project root.
+* ``WEBEX_TEAMS_TEST_FILE_URL`` - Configure this environment variable with a URL referencing a file that can be downloaded and posted to Webex Teams as part of the testing process.
 
-6. Commit your changes.
+*Example:*
 
-7. Ensure your code passes all of the default tests.
+.. code-block:: bash
 
-   Run ``script/test`` and ensure all tests execute successfully.
+   #!/usr/bin/env bash
+   export WEBEX_TEAMS_ACCESS_TOKEN="<test account's access token>"
+   export WEBEX_TEAMS_TEST_DOMAIN="domain.com"
+   export WEBEX_TEAMS_TEST_ID_START=42
+   export WEBEX_TEAMS_TEST_FILE_URL="https://www.webex.com/content/dam/wbx/us/images/dg-integ/teams_icon.png"
 
-8. Submit a `pull request`_.  If everything looks good, we will gladly merge your request!
+Ensure your code passes all of the default tests.  Run ``script/test`` and ensure all tests execute successfully.
 
 
 .. _script: https://github.com/CiscoDevNet/webexteamssdk/tree/master/script

webexteamssdk/api/__init__.py

@@ -122,15 +122,15 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                 access_token argument or an environment variable.
 
         """
-        check_type(access_token, basestring)
-        check_type(base_url, basestring)
-        check_type(single_request_timeout, int)
-        check_type(wait_on_rate_limit, bool)
-        check_type(client_id, basestring, may_be_none=True)
-        check_type(client_secret, basestring, may_be_none=True)
-        check_type(oauth_code, basestring, may_be_none=True)
-        check_type(redirect_uri, basestring, may_be_none=True)
-        check_type(proxies, dict, may_be_none=True)
+        check_type(access_token, basestring, optional=True)
+        check_type(base_url, basestring, optional=True)
+        check_type(single_request_timeout, int, optional=True)
+        check_type(wait_on_rate_limit, bool, optional=True)
+        check_type(client_id, basestring, optional=True)
+        check_type(client_secret, basestring, optional=True)
+        check_type(oauth_code, basestring, optional=True)
+        check_type(redirect_uri, basestring, optional=True)
+        check_type(proxies, dict, optional=True)
 
         access_token = access_token or WEBEX_TEAMS_ACCESS_TOKEN
 

webexteamssdk/api/access_tokens.py

@@ -79,8 +79,8 @@ def __init__(self, base_url, object_factory, single_request_timeout=None):
             TypeError: If the parameter types are incorrect.
 
         """
-        check_type(base_url, basestring, may_be_none=False)
-        check_type(single_request_timeout, int)
+        check_type(base_url, basestring)
+        check_type(single_request_timeout, int, optional=True)
 
         super(AccessTokensAPI, self).__init__()
 
@@ -125,10 +125,10 @@ def get(self, client_id, client_secret, code, redirect_uri):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(client_id, basestring, may_be_none=False)
-        check_type(client_secret, basestring, may_be_none=False)
-        check_type(code, basestring, may_be_none=False)
-        check_type(redirect_uri, basestring, may_be_none=False)
+        check_type(client_id, basestring)
+        check_type(client_secret, basestring)
+        check_type(code, basestring)
+        check_type(redirect_uri, basestring)
 
         post_data = dict_from_items_with_values(
             grant_type="authorization_code",
@@ -166,9 +166,9 @@ def refresh(self, client_id, client_secret, refresh_token):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(client_id, basestring, may_be_none=False)
-        check_type(client_secret, basestring, may_be_none=False)
-        check_type(refresh_token, basestring, may_be_none=False)
+        check_type(client_id, basestring)
+        check_type(client_secret, basestring)
+        check_type(refresh_token, basestring)
 
         post_data = dict_from_items_with_values(
             grant_type="refresh_token",

webexteamssdk/api/attachment_actions.py

@@ -33,14 +33,10 @@
 from builtins import *
 
 from past.builtins import basestring
-from requests_toolbelt import MultipartEncoder
 
-from ..generator_containers import generator_container
+from ..models.immutable import AttachmentAction
 from ..restsession import RestSession
-from ..utils import (
-    check_type, dict_from_items_with_values, is_local_file, is_web_url,
-    open_local_file,
-)
+from ..utils import check_type, dict_from_items_with_values
 
 
 API_ENDPOINT = 'attachment/actions'
@@ -56,7 +52,7 @@ class AttachmentActionsAPI(object):
     """
 
     def __init__(self, session, object_factory):
-        """Init a new AttachmentActionsAPI object with the provided RestSession.
+        """Initialize a new AttachmentActionsAPI object.
 
         Args:
             session(RestSession): The RESTful session object to be used for
@@ -66,26 +62,25 @@ def __init__(self, session, object_factory):
             TypeError: If the parameter types are incorrect.
 
         """
-        check_type(session, RestSession, may_be_none=False)
+        check_type(session, RestSession)
         super(AttachmentActionsAPI, self).__init__()
         self._session = session
         self._object_factory = object_factory
 
-    def create(self, type=None, messageId=None, inputs=None,
-               **request_parameters):
-        """Create an attachment action.
+    def create(self, type, messageId, inputs, **request_parameters):
+        """Create a new attachment action.
 
         Args:
-            type(attachment action enum): The type of attachment action.
-            messageId(basestring): The ID of parent message the attachment
-                action is to be performed on.
-            inputs(dict): inputs to attachment fields
+            type(basestring): The type of action to perform.
+            messageId(basestring): The ID of the message which contains the
+                attachment.
+            inputs(dict): The attachment action's inputs.
             **request_parameters: Additional request parameters (provides
                 support for parameters that may be added in the future).
 
         Returns:
-            Attachment action: A attachment action object with the details
-            of the created attachment action.
+            AttachmentAction: A attachment action object with the details of
+            the created attachment action.
 
         Raises:
             TypeError: If the parameter types are incorrect.
@@ -95,10 +90,9 @@ def create(self, type=None, messageId=None, inputs=None,
                 contain a valid URL or path to a local file.
 
         """
-
-        check_type(type, basestring, may_be_none=False)
-        check_type(messageId, basestring, may_be_none=False)
-        check_type(inputs, dict, may_be_none=False)
+        check_type(type, basestring)
+        check_type(messageId, basestring)
+        check_type(inputs, dict)
 
         post_data = dict_from_items_with_values(
             request_parameters,
@@ -128,7 +122,7 @@ def get(self, attachmentId):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(attachmentId, basestring, may_be_none=False)
+        check_type(attachmentId, basestring)
 
         # API request
         json_data = self._session.get(API_ENDPOINT + '/' + attachmentId)

webexteamssdk/api/events.py

@@ -65,7 +65,7 @@ def __init__(self, session, object_factory):
             TypeError: If the parameter types are incorrect.
 
         """
-        check_type(session, RestSession, may_be_none=False)
+        check_type(session, RestSession)
 
         super(EventsAPI, self).__init__()
 
@@ -118,12 +118,12 @@ def list(self, resource=None, type=None, actorId=None, _from=None, to=None,
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(resource, basestring)
-        check_type(type, basestring)
-        check_type(actorId, basestring)
-        check_type(_from, basestring)
-        check_type(to, basestring)
-        check_type(max, int)
+        check_type(resource, basestring, optional=True)
+        check_type(type, basestring, optional=True)
+        check_type(actorId, basestring, optional=True)
+        check_type(_from, basestring, optional=True)
+        check_type(to, basestring, optional=True)
+        check_type(max, int, optional=True)
 
         params = dict_from_items_with_values(
             request_parameters,
@@ -159,7 +159,7 @@ def get(self, eventId):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(eventId, basestring, may_be_none=False)
+        check_type(eventId, basestring)
 
         # API request
         json_data = self._session.get(API_ENDPOINT + '/' + eventId)

webexteamssdk/api/guest_issuer.py

@@ -95,11 +95,11 @@ def create(self, subject, displayName, issuerToken, expiration, secret):
             TypeError: If the parameter types are incorrect
             ApiError: If the webex teams cloud returns an error.
         """
-        check_type(subject, basestring)
-        check_type(displayName, basestring)
-        check_type(issuerToken, basestring)
-        check_type(expiration, basestring)
-        check_type(secret, basestring)
+        check_type(subject, basestring, optional=True)
+        check_type(displayName, basestring, optional=True)
+        check_type(issuerToken, basestring, optional=True)
+        check_type(expiration, basestring, optional=True)
+        check_type(secret, basestring, optional=True)
 
         payload = {
             "sub": subject,

webexteamssdk/api/licenses.py

@@ -65,7 +65,7 @@ def __init__(self, session, object_factory):
             TypeError: If the input object is not a dictionary or string.
 
         """
-        check_type(session, RestSession, may_be_none=False)
+        check_type(session, RestSession)
 
         super(LicensesAPI, self).__init__()
 
@@ -93,7 +93,7 @@ def list(self, orgId=None, **request_parameters):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(orgId, basestring)
+        check_type(orgId, basestring, optional=True)
 
         params = dict_from_items_with_values(
             request_parameters,
@@ -122,7 +122,7 @@ def get(self, licenseId):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(licenseId, basestring, may_be_none=False)
+        check_type(licenseId, basestring)
 
         # API request
         json_data = self._session.get(API_ENDPOINT + '/' + licenseId)

webexteamssdk/api/memberships.py

@@ -115,10 +115,10 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None,
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(roomId, basestring)
-        check_type(personId, basestring)
-        check_type(personEmail, basestring)
-        check_type(max, int)
+        check_type(roomId, basestring, optional=True)
+        check_type(personId, basestring, optional=True)
+        check_type(personEmail, basestring, optional=True)
+        check_type(max, int, optional=True)
 
         params = dict_from_items_with_values(
             request_parameters,
@@ -159,10 +159,10 @@ def create(self, roomId, personId=None, personEmail=None,
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(roomId, basestring, may_be_none=False)
-        check_type(personId, basestring)
-        check_type(personEmail, basestring)
-        check_type(isModerator, bool)
+        check_type(roomId, basestring)
+        check_type(personId, basestring, optional=True)
+        check_type(personEmail, basestring, optional=True)
+        check_type(isModerator, bool, optional=True)
 
         post_data = dict_from_items_with_values(
             request_parameters,
@@ -193,7 +193,7 @@ def get(self, membershipId):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(membershipId, basestring, may_be_none=False)
+        check_type(membershipId, basestring)
 
         # API request
         json_data = self._session.get(API_ENDPOINT + '/' + membershipId)
@@ -219,8 +219,8 @@ def update(self, membershipId, isModerator=None, **request_parameters):
             ApiError: If the Webex Teams cloud returns an error.
 
         """
-        check_type(membershipId, basestring, may_be_none=False)
-        check_type(isModerator, bool)
+        check_type(membershipId, basestring)
+        check_type(isModerator, bool, optional=True)
 
         put_data = dict_from_items_with_values(
             request_parameters,