Merge pull request #8 from swiftype/updates-naming

Updates naming

Author: goodroot

README.rst

@@ -39,9 +39,9 @@ Instantiating a client
 .. code-block:: python
 
     >>> from swiftype_app_search import Client
-    >>> account_host_key = 'host-c5s2mj'
+    >>> host_identifier = 'host-c5s2mj'
     >>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
-    >>> client = Client(account_host_key, api_key)
+    >>> client = Client(host_identifier, api_key)
 
 Index document
 --------------
@@ -160,4 +160,4 @@ Creating a search key that will only search over the body field.
     >>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
     >>> api_key_name = 'my-api-token'
     >>> signed_search_key = Client.create_signed_search_key(api_key, api_key_name, {'search_fields': { 'body': {}}})
-    >>> client = Client(account_host_key, signed_search_key)
+    >>> client = Client(host_identifier, signed_search_key)

swiftype_app_search/client.py

@@ -9,14 +9,17 @@ class Client:
     SWIFTYPE_APP_SEARCH_BASE_ENDPOINT = 'api.swiftype.com/api/as/v1'
     SIGNED_SEARCH_TOKEN_JWT_ALGORITHM = 'HS256'
 
-    def __init__(self, account_host_key, api_key,
+    def __init__(self, host_identifier='', api_key='',
                  base_endpoint=SWIFTYPE_APP_SEARCH_BASE_ENDPOINT,
-                 use_https=True):
-        self.account_host_key = account_host_key
+                 use_https=True,
+                 account_host_key='' # Deprecated - use host_identifier instead
+                 ):
+        self.host_identifier = host_identifier or account_host_key
+        self.account_host_key = self.host_identifier # Deprecated
         self.api_key = api_key
 
         uri_scheme = 'https' if use_https else 'http'
-        base_url = "{}://{}.{}".format(uri_scheme, account_host_key, base_endpoint)
+        base_url = "{}://{}.{}".format(uri_scheme, host_identifier, base_endpoint)
         self.swiftype_session = SwiftypeRequestSession(self.api_key, base_url)
 
     def get_documents(self, engine_name, document_ids):

tests/test_client.py

@@ -8,13 +8,25 @@ class TestClient(TestCase):
 
     def setUp(self):
         self.engine_name = 'some-engine-name'
-        self.client = Client('account_host_key', 'api_key')
+        self.client = Client('host_identifier', 'api_key')
 
         self.document_index_url = "{}/{}".format(
             self.client.swiftype_session.base_url,
             "engines/{}/documents".format(self.engine_name)
         )
 
+    def test_deprecated_init_support_with_old_names(self):
+        self.client = Client(account_host_key='host_identifier', api_key='api_key')
+        self.assertEqual(self.client.account_host_key, 'host_identifier')
+
+    def test_deprecated_init_support_with_new_names(self):
+        self.client = Client(host_identifier='host_identifier', api_key='api_key')
+        self.assertEqual(self.client.account_host_key, 'host_identifier')
+
+    def test_deprecated_init_support_with_positional(self):
+        self.client = Client('host_identifier', 'api_key', 'example.com', False)
+        self.assertEqual(self.client.account_host_key, 'host_identifier')
+
     def test_index_document_processing_error(self):
         invalid_document = {'id': 'something', 'bad': {'no': 'nested'}}
         error = 'some processing error'