Rename module to adobe_umapi_client.py. Bump version to 1.0.0rc2

I also added a description of the Adobe UMAPI to the setup.py file and the README.

Author: brotskydotcom

README.md

@@ -1,21 +1,25 @@
-# adobe-umapi.py
+# adobe-umapi-client.py
 
-Python client for the Adobe User Management API, aka the
-[Adobe UMAPI](https://www.adobe.io/products/usermanagement/docs/gettingstarted.html)
+This is a Python client for the Adobe User Management API, aka the
+[Adobe UMAPI](https://www.adobe.io/products/usermanagement/docs/gettingstarted.html).
+
+The Adobe User Management API is an Adobe-hosted network service 
+which provides Adobe Enterprise customers the ability to manage their users.  This
+client makes it easy to access the Adobe UMAPI from a local Python application.
+
+This client is open source, maintained by Adobe, and distributed under the terms
+of the OSI-approved MIT license.  Copyright (c) 2016 Adobe Systems Incorporated.
 
 # Installation
 
-You can get this package from PyPI: `pip install adobe-umapi`.
+You can get this package from PyPI: `pip install adobe-umapi-client`.
 Or you can download the posted package from GitHub and use pip
 to install from the download.
 
-(Note: as of 13 Dec 2016, there was an issue with the PyPI posting.
-We are working to fix that problem.)
-
 # Building
 
 1. Clone this repository or download the latest stable release.
-2. From the command line, change to the `adobe-umapi.py` directory.
+2. From the command line, change to the `adobe-umapi-client.py` directory.
 3. To install, run the command `python setup.py install`.
 [**NOTE**: You may need admin/root privileges to install new packages in your environment.
 It is recommended that you use `virtualenv` to make a virtual python environment.
@@ -62,7 +66,7 @@ The JSON Web Token (JWT) is used to get an authorization token for using the API
 The `JWT` object will build the JWT for use with the `AccessRequest` object.
 
 ```python
-from adobe_umapi.auth import JWT
+from adobe_umapi_client.auth import JWT
 
 jwt = JWT(
   org_id,     # Organization ID
@@ -79,7 +83,7 @@ The `AccessRequest` object uses the JWT to call an IMS endpoint to obtain an acc
 token is then used in all later UMAPI calls to authenticate and authorize the request.
 
 ```python
-from adobe_umapi.auth import AccessRequest
+from adobe_umapi_client.auth import AccessRequest
 
 token = AccessRequest(
   "https://" + ims_host + ims_endpoint_jwt,   # Access Request Endpoint (IMS Host + JWT Endpoint)
@@ -103,7 +107,7 @@ Once you have an access `token`, you use it to create an Auth object.  This Auth
 is used to build the necessary authentication headers for making an API call.
 
 ```python
-from adobe_umapi.auth import Auth
+from adobe_umapi_client.auth import Auth
 
 auth = Auth(api_key, token())
 ```
@@ -114,7 +118,7 @@ Once the `auth` object is built, you use it to construct a UMAPI object.  This U
 object can then be used over and over to make your desired API calls.
 
 ```python
-from adobe_umapi import UMAPI
+from adobe_umapi_client import UMAPI
 
 api_endpoint = 'https://usermanagement.adobe.io/v2/usermanagement'
 api = UMAPI(api_endpoint, auth)
@@ -124,15 +128,15 @@ api = UMAPI(api_endpoint, auth)
 
 These snippets presume you have constructed a UMAPI object named `api` as detailed in the last section.
 The query APIs return data in paginated form, each page contaning up to 200 results.
-The `adobe_umapi.helper`
+The `adobe_umapi_client.helper`
 module has a `paginate` utility which can will concatenate and return the results from all pages.
 
 ## Get a List of Users
 
 ```python
 users = api.users(org_id, page=0)           # optional arg page defaults to 0
 
-from adobe_umapi.helper import paginate
+from adobe_umapi_client.helper import paginate
 all_users = paginate(api.users, org_id)     # optional args for max_pages and max_records
 ```
 
@@ -158,7 +162,7 @@ To create the action object, we name the user we wish to operate on.
 (As above, `api` here in a UMAPI object.)
 
 ```python
-from adobe_umapi import Action
+from adobe_umapi_client import Action
 
 action = Action(user="[email protected]")
 ```
@@ -443,9 +447,9 @@ The "add" portion of the JSON looks like this:
 "add": {"product": ["product1"]}
 ```
 
-## adobe_umapi.auth
+## adobe_umapi_client.auth
 
-The submodule `adobe_umapi.auth` contains the components needed to build
+The submodule `adobe_umapi_client.auth` contains the components needed to build
 the authentication headers needed for API communication.
 
 ### JWT
@@ -466,7 +470,7 @@ The `JWT` object is callable.  Calling it returns the encoded JWT.
 Example:
 
 ```python
-from adobe_umapi.auth import JWT
+from adobe_umapi_client.auth import JWT
 
 jwt = JWT(
   org_id,     # Organization ID
@@ -495,7 +499,7 @@ Like the `JWT` object, the `AccessRequest` object is callable.  Calling it retur
 Basic Usage Example:
 
 ```python
-from adobe_umapi.auth import AccessRequest
+from adobe_umapi_client.auth import AccessRequest
 
 token = AccessRequest(
   "https://" + ims_host + ims_endpoint_jwt,   # Access Request Endpoint (IMS Host + JWT Endpoint)
@@ -529,15 +533,15 @@ It is a subclass of the
 Example:
 
 ```python
-from adobe_umapi.auth import Auth
+from adobe_umapi_client.auth import Auth
 
 token = AccessRequest( ... )
 auth = Auth(api_key, token())
 ```
 
-## adobe_umapi.error
+## adobe_umapi_client.error
 
-The `adobe_umapi.error` submodule contains all custom Exceptions for the UMAPI library.
+The `adobe_umapi_client.error` submodule contains all custom Exceptions for the UMAPI library.
 
 ### UMAPIError
 

adobe_umapi/__init__.py renamed to adobe_umapi_client/__init__.py

@@ -1,9 +1,14 @@
 from setuptools import setup, find_packages
 
 
-setup(name='adobe-umapi',
-      version='1.0.0rc1',
+setup(name='adobe-umapi-client',
+      version='1.0.0rc2',
       description='Adobe User Management API (UMAPI) client - see http://bit.ly/2hwkVrs',
+      long_description=('The Adobe User Management API (aka the Adobe UMAPI) is an Adobe-hosted network service '
+                        'which provides Adobe Enterprise customers the ability to manage their users.  This '
+                        'client makes it easy to access the Adobe UMAPI from a local Python application.  '
+                        'This client is open source, maintained by Adobe, and distributed under the terms '
+                        'of the OSI-approved MIT license.  Copyright (c) 2016 Adobe Systems Incorporated.'),
       classifiers=[
           'Development Status :: 5 - Production/Stable',
           'Programming Language :: Python :: 2.7',
@@ -12,7 +17,7 @@
           'Intended Audience :: Developers',
           'Intended Audience :: System Administrators',
       ],
-      url='https://github.com/adobe-apiplatform/adobe-umapi.py',
+      url='https://github.com/adobe-apiplatform/adobe-umapi-client.py',
       maintainer='Daniel Brotsky',
       maintainer_email='[email protected]',
       license='MIT',

adobe_umapi/api.py renamed to adobe_umapi_client/api.py

@@ -2,9 +2,9 @@
 import json
 import pytest
 
-from adobe_umapi import UMAPI, Action
-from adobe_umapi.error import UMAPIError, UMAPIRetryError, UMAPIRequestError, ActionFormatError
-from adobe_umapi.auth import Auth
+from adobe_umapi_client import UMAPI, Action
+from adobe_umapi_client.error import UMAPIError, UMAPIRetryError, UMAPIRequestError, ActionFormatError
+from adobe_umapi_client.auth import Auth
 
 
 # This method will be used by the mock to replace requests.get / requests.post
@@ -27,23 +27,23 @@ def json(self):
         return MockResponse(404, {})
 
 
-@mock.patch('adobe_umapi.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
 def test_list_users_success(_):
     """Test Users List - SUCCESS"""
     auth = mock.create_autospec(Auth)
     api = UMAPI('http://example.com/success', auth)
     assert api.users(None) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
 def test_list_users_error(_):
     """Test Users List - ERROR"""
     auth = mock.create_autospec(Auth)
     api = UMAPI('http://example.com/error', auth)
     pytest.raises(UMAPIRequestError, api.users, None)
 
 
-@mock.patch('adobe_umapi.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
 def test_list_users_failure(_):
     """Test Users List - FAILURE"""
     auth = mock.create_autospec(Auth)
@@ -53,15 +53,15 @@ def test_list_users_failure(_):
     pytest.raises(UMAPIRetryError, api.users, None)
 
 
-@mock.patch('adobe_umapi.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
 def test_list_groups_success(_):
     """Test Groups List - SUCCESS"""
     auth = mock.create_autospec(Auth)
     api = UMAPI('http://example.com/success', auth)
     assert api.groups(None) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_success(_):
     """Test User Creation - SUCCESS"""
     auth = mock.create_autospec(Auth)
@@ -74,7 +74,7 @@ def test_user_create_success(_):
     assert api.action(None, action) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_error(_):
     """Test User Creation - ERROR"""
     auth = mock.create_autospec(Auth)
@@ -86,7 +86,7 @@ def test_user_create_error(_):
     pytest.raises(UMAPIRequestError, api.action, None, action)
 
 
-@mock.patch('adobe_umapi.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_failure(_):
     """Test User Creation - FAILURE"""
     auth = mock.create_autospec(Auth)
@@ -101,7 +101,7 @@ def test_user_create_failure(_):
     pytest.raises(UMAPIRetryError, api.action, None, action)
 
 
-@mock.patch('adobe_umapi.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_product_add(_):
     """Test Product Add - SUCCESS"""
     auth = mock.create_autospec(Auth)
@@ -114,7 +114,7 @@ def test_product_add(_):
     assert api.action(None, action) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_action_format_error(_):
     """Test Action Format Error"""
     auth = mock.create_autospec(Auth)

adobe_umapi/auth.py renamed to adobe_umapi_client/auth.py

@@ -6,9 +6,9 @@
 import pytest
 from six import StringIO
 
-import adobe_umapi.helper
-from adobe_umapi import UMAPI
-from adobe_umapi.error import UMAPIError, UMAPIRetryError
+import adobe_umapi_client.helper
+from adobe_umapi_client import UMAPI
+from adobe_umapi_client.error import UMAPIError, UMAPIRetryError
 
 
 # This method will be used by the mock to replace UMAPI.users
@@ -39,53 +39,53 @@ def __init__(self, status_code, headers):
 
 
 # test the pagination on success
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_success(_):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'success') == ["user0", "user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'success') == ["user0", "user1", "user2"]
 
 
 @pytest.fixture
 def reduce_attempts():
     # reduce the number of retry attempts
-    adobe_umapi.helper.retry_max_attempts = 3
+    adobe_umapi_client.helper.retry_max_attempts = 3
 
 
 # test the retry logic with seconds in the header
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_seconds(_, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
 
 
 # test the retry logic with a time in the header
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_fail_date(_, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'retryTime') == ["user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'retryTime') == ["user1", "user2"]
 
 
 # the default retry waits are really long, so don't use them while testing
 @pytest.fixture
 def reduce_delay():
     # reduce the wait on retry attempts
-    adobe_umapi.helper.retry_max_attempts = 3
-    adobe_umapi.helper.retry_exponential_backoff_factor = 1
-    adobe_umapi.helper.retry_random_delay_max = 3
+    adobe_umapi_client.helper.retry_max_attempts = 3
+    adobe_umapi_client.helper.retry_exponential_backoff_factor = 1
+    adobe_umapi_client.helper.retry_random_delay_max = 3
 
 
 # test the retry logic with a zero delay in the header
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_zero(_, reduce_delay, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'retryNone') == ["user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'retryNone') == ["user1", "user2"]
 
 
 # test the retry logic with no header
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_noheader(_, reduce_delay, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'retryNull') == ["user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'retryNull') == ["user1", "user2"]
 
 
 # py.test doesn't divert string logging, so use it
@@ -96,18 +96,18 @@ def log_stream():
     logger = logging.getLogger('test_logger')
     logger.setLevel(logging.WARNING)
     logger.addHandler(handler)
-    prior_logger = adobe_umapi.helper.logger
-    adobe_umapi.helper.logger = logger
+    prior_logger = adobe_umapi_client.helper.logger
+    adobe_umapi_client.helper.logger = logger
     yield stream
-    adobe_umapi.helper.logger = prior_logger
+    adobe_umapi_client.helper.logger = prior_logger
     handler.close()
 
 
 # test the retry logic with a custom logger
-@mock.patch('adobe_umapi.UMAPI.users', side_effect=mocked_users)
+@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_logging(_, log_stream, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
+    assert adobe_umapi_client.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
     log_stream.flush()
     log = log_stream.getvalue()  # save as a local so can do pytest -l to see exact log
     assert log == '''UMAPI service temporarily unavailable (attempt 1) -- 429