Replace user ID usage with account ID

Author: oschwald

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+2.8.0
++++++++++++++++++
+
+* Renamed user ID to account ID in the code and added support for the new
+  ``ACCOUNT_ID_REQUIRED`` AND ``ACCOUNT_ID_UNKNOWN`` error codes.
+
 2.7.0 (2018-01-18)
 ++++++++++++++++++
 

README.rst

@@ -46,7 +46,7 @@ Usage
 -----
 
 To use this API, you first create either a web service object with your
-MaxMind ``user_id`` and ``license_key`` or a database reader object with the
+MaxMind ``account_id`` and ``license_key`` or a database reader object with the
 path to your database file. After doing this, you may call the method
 corresponding to request type (e.g., ``city`` or ``country``), passing it the
 IP address you want to look up.
@@ -65,7 +65,7 @@ Web Service Example
     >>> import geoip2.webservice
     >>>
     >>> # This creates a Client object that can be reused across requests.
-    >>> # Replace "42" with your user ID and "license_key" with your license
+    >>> # Replace "42" with your account ID and "license_key" with your license
     >>> # key.
     >>> client = geoip2.webservice.Client(42, 'license_key')
     >>>

geoip2/webservice.py

@@ -44,7 +44,7 @@ class Client(object):
 
     It accepts the following required arguments:
 
-    :param user_id: Your MaxMind User ID.
+    :param account_id: Your MaxMind account ID.
     :param license_key: Your MaxMind license key.
 
     Go to https://www.maxmind.com/en/my_license_key to see your MaxMind
@@ -83,7 +83,7 @@ class Client(object):
     """
 
     def __init__(self,
-                 user_id,
+                 account_id,
                  license_key,
                  host='geoip.maxmind.com',
                  locales=None,
@@ -95,7 +95,8 @@ def __init__(self,
         self._locales = locales
         # requests 2.12.2 requires that the username passed to auth be bytes
         # or a string, with the former being preferred.
-        self._user_id = user_id if isinstance(user_id, bytes) else str(user_id)
+        self._account_id = account_id if isinstance(account_id,
+                                                    bytes) else str(account_id)
         self._license_key = license_key
         self._base_uri = 'https://%s/geoip/v2.1' % host
         self._timeout = timeout
@@ -143,7 +144,7 @@ def _response_for(self, path, model_class, ip_address):
         uri = '/'.join([self._base_uri, path, ip_address])
         response = requests.get(
             uri,
-            auth=(self._user_id, self._license_key),
+            auth=(self._account_id, self._license_key),
             headers={
                 'Accept': 'application/json',
                 'User-Agent': self._user_agent()
@@ -201,7 +202,8 @@ def _exception_for_4xx_status(self, response, status, uri):
     def _exception_for_web_service_error(self, message, code, status, uri):
         if code in ('IP_ADDRESS_NOT_FOUND', 'IP_ADDRESS_RESERVED'):
             return AddressNotFoundError(message)
-        elif code in ('AUTHORIZATION_INVALID', 'LICENSE_KEY_REQUIRED',
+        elif code in ('ACCOUNT_ID_REQUIRED', 'ACCOUNT_ID_UNKNOWN',
+                      'AUTHORIZATION_INVALID', 'LICENSE_KEY_REQUIRED',
                       'USER_ID_REQUIRED', 'USER_ID_UNKNOWN'):
             return AuthenticationError(message)
         elif code in ('INSUFFICIENT_FUNDS', 'OUT_OF_QUERIES'):

tests/webservice_test.py

@@ -221,10 +221,18 @@ def test_license_key_required(self, mock):
         self._test_error(mock, 401, 'LICENSE_KEY_REQUIRED',
                          AuthenticationError)
 
+    @requests_mock.mock()
+    def test_account_id_required(self, mock):
+        self._test_error(mock, 401, 'ACCOUNT_ID_REQUIRED', AuthenticationError)
+
     @requests_mock.mock()
     def test_user_id_required(self, mock):
         self._test_error(mock, 401, 'USER_ID_REQUIRED', AuthenticationError)
 
+    @requests_mock.mock()
+    def test_account_id_unkown(self, mock):
+        self._test_error(mock, 401, 'ACCOUNT_ID_UNKNOWN', AuthenticationError)
+
     @requests_mock.mock()
     def test_user_id_unkown(self, mock):
         self._test_error(mock, 401, 'USER_ID_UNKNOWN', AuthenticationError)