Merge pull request #6 from adobe-apiplatform/v1

Yet another rename!  This time to the approved (and final) name!  So ... now at 1.0.0rc4

Author: adobeDan

README.md

@@ -1,25 +1,25 @@
-# adobe-umapi-client.py
+# umapi-client.py
 
-This is a 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 User Management API from Adobe, aka the
+[UMAPI](https://www.adobe.io/products/usermanagement/docs/gettingstarted.html).
 
-The Adobe User Management API is an Adobe-hosted network service 
+The 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.
+client makes it easy to access the 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-client`.
+You can get this package from PyPI: `pip install umapi-client`.
 Or you can download the posted package from GitHub and use pip
 to install from the download.
 
 # Building
 
 1. Clone this repository or download the latest stable release.
-2. From the command line, change to the `adobe-umapi-client.py` directory.
+2. From the command line, change to the `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.

setup.py

@@ -21,8 +21,8 @@
 from setuptools import setup, find_packages
 
 
-setup(name='adobe-umapi-client',
-      version='1.0.0rc3',
+setup(name='umapi-client',
+      version='1.0.0rc4',
       description='Adobe User Management API (UMAPI) client - see https://adobe.ly/2h1pHgV',
       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 '
@@ -37,7 +37,7 @@
           'Intended Audience :: Developers',
           'Intended Audience :: System Administrators',
       ],
-      url='https://github.com/adobe-apiplatform/adobe-umapi-client.py',
+      url='https://github.com/adobe-apiplatform/umapi-client.py',
       maintainer='Daniel Brotsky',
       maintainer_email='[email protected]',
       license='MIT',

tests/test_actions.py

@@ -22,9 +22,9 @@
 import json
 import pytest
 
-from adobe_umapi_client import UMAPI, Action
-from adobe_umapi_client.error import UMAPIError, UMAPIRetryError, UMAPIRequestError, ActionFormatError
-from adobe_umapi_client.auth import Auth
+from umapi_client import UMAPI, Action
+from umapi_client.error import UMAPIError, UMAPIRetryError, UMAPIRequestError, ActionFormatError
+from umapi_client.auth import Auth
 
 
 # This method will be used by the mock to replace requests.get / requests.post
@@ -47,23 +47,23 @@ def json(self):
         return MockResponse(404, {})
 
 
-@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('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_client.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('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_client.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.get', side_effect=mocked_requests_call)
 def test_list_users_failure(_):
     """Test Users List - FAILURE"""
     auth = mock.create_autospec(Auth)
@@ -73,15 +73,15 @@ def test_list_users_failure(_):
     pytest.raises(UMAPIRetryError, api.users, None)
 
 
-@mock.patch('adobe_umapi_client.api.requests.get', side_effect=mocked_requests_call)
+@mock.patch('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_client.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_success(_):
     """Test User Creation - SUCCESS"""
     auth = mock.create_autospec(Auth)
@@ -94,7 +94,7 @@ def test_user_create_success(_):
     assert api.action(None, action) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_error(_):
     """Test User Creation - ERROR"""
     auth = mock.create_autospec(Auth)
@@ -106,7 +106,7 @@ def test_user_create_error(_):
     pytest.raises(UMAPIRequestError, api.action, None, action)
 
 
-@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_user_create_failure(_):
     """Test User Creation - FAILURE"""
     auth = mock.create_autospec(Auth)
@@ -121,7 +121,7 @@ def test_user_create_failure(_):
     pytest.raises(UMAPIRetryError, api.action, None, action)
 
 
-@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_product_add(_):
     """Test Product Add - SUCCESS"""
     auth = mock.create_autospec(Auth)
@@ -134,7 +134,7 @@ def test_product_add(_):
     assert api.action(None, action) == {"result": "success"}
 
 
-@mock.patch('adobe_umapi_client.api.requests.post', side_effect=mocked_requests_call)
+@mock.patch('umapi_client.api.requests.post', side_effect=mocked_requests_call)
 def test_action_format_error(_):
     """Test Action Format Error"""
     auth = mock.create_autospec(Auth)

tests/test_helper.py

@@ -26,9 +26,9 @@
 import pytest
 from six import StringIO
 
-import adobe_umapi_client.helper
-from adobe_umapi_client import UMAPI
-from adobe_umapi_client.error import UMAPIError, UMAPIRetryError
+import umapi_client.helper
+from umapi_client import UMAPI
+from umapi_client.error import UMAPIError, UMAPIRetryError
 
 
 # This method will be used by the mock to replace UMAPI.users
@@ -59,53 +59,53 @@ def __init__(self, status_code, headers):
 
 
 # test the pagination on success
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_success(_):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'success') == ["user0", "user1", "user2"]
+    assert umapi_client.helper.paginate(api.users, 'success') == ["user0", "user1", "user2"]
 
 
 @pytest.fixture
 def reduce_attempts():
     # reduce the number of retry attempts
-    adobe_umapi_client.helper.retry_max_attempts = 3
+    umapi_client.helper.retry_max_attempts = 3
 
 
 # test the retry logic with seconds in the header
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_seconds(_, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
+    assert umapi_client.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
 
 
 # test the retry logic with a time in the header
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_fail_date(_, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'retryTime') == ["user1", "user2"]
+    assert 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_client.helper.retry_max_attempts = 3
-    adobe_umapi_client.helper.retry_exponential_backoff_factor = 1
-    adobe_umapi_client.helper.retry_random_delay_max = 3
+    umapi_client.helper.retry_max_attempts = 3
+    umapi_client.helper.retry_exponential_backoff_factor = 1
+    umapi_client.helper.retry_random_delay_max = 3
 
 
 # test the retry logic with a zero delay in the header
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_zero(_, reduce_delay, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'retryNone') == ["user1", "user2"]
+    assert umapi_client.helper.paginate(api.users, 'retryNone') == ["user1", "user2"]
 
 
 # test the retry logic with no header
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_noheader(_, reduce_delay, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'retryNull') == ["user1", "user2"]
+    assert umapi_client.helper.paginate(api.users, 'retryNull') == ["user1", "user2"]
 
 
 # py.test doesn't divert string logging, so use it
@@ -116,18 +116,18 @@ def log_stream():
     logger = logging.getLogger('test_logger')
     logger.setLevel(logging.WARNING)
     logger.addHandler(handler)
-    prior_logger = adobe_umapi_client.helper.logger
-    adobe_umapi_client.helper.logger = logger
+    prior_logger = umapi_client.helper.logger
+    umapi_client.helper.logger = logger
     yield stream
-    adobe_umapi_client.helper.logger = prior_logger
+    umapi_client.helper.logger = prior_logger
     handler.close()
 
 
 # test the retry logic with a custom logger
-@mock.patch('adobe_umapi_client.UMAPI.users', side_effect=mocked_users)
+@mock.patch('umapi_client.UMAPI.users', side_effect=mocked_users)
 def test_helper_retry_logging(_, log_stream, reduce_attempts):
     api = UMAPI('', None)
-    assert adobe_umapi_client.helper.paginate(api.users, 'retrySecs') == ["user1", "user2"]
+    assert 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