Merge pull request #15 from swiftype/configurable-client

Release 0.4.0 - Updated Python client for Managed deploys

Author: JasonStoltz

README.rst

@@ -43,9 +43,21 @@ Instantiating a client
 
     >>> from swiftype_app_search import Client
     >>> host_identifier = 'host-c5s2mj'
-    >>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
+    >>> api_key = 'private-mu75psc5egt9ppzuycnc2mc3'
     >>> client = Client(host_identifier, api_key)
 
+Using with App Search Managed Deploys
+-------------------------------------
+
+The client can be configured to use a managed deploy by adjusting the
+`base_endpoint` and `use_https` parameters. Since managed deploys do not
+rely on a `host_identifier`, it can be omitted.
+
+.. code-block:: python
+
+    >>> from swiftype_app_search import Client
+    >>> client = Client(api_key='private-mu75psc5egt9ppzuycnc2mc3', base_endpoint='localhost:3002/api/as/v1', use_https=False)
+
 Index document
 --------------
 
@@ -160,7 +172,7 @@ Creating a search key that will only search over the body field.
 
 .. code-block:: python
 
-    >>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
+    >>> api_key = 'private-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(host_identifier, signed_search_key)

swiftype_app_search/__version__.py

@@ -1,6 +1,6 @@
 __title__ = 'swiftype_app_search'
 __description__ = 'An API client for Swiftype App Search'
 __url__ = 'https://github.com/swiftype/swiftype-app-search-python'
-__version__ = '0.3.0'
+__version__ = '0.4.0'
 __author__ = 'Swiftype'
 __author_email__ = 'eng@swiftype.com'

swiftype_app_search/client.py

@@ -19,7 +19,8 @@ def __init__(self, host_identifier='', api_key='',
         self.api_key = api_key
 
         uri_scheme = 'https' if use_https else 'http'
-        base_url = "{}://{}.{}".format(uri_scheme, host_identifier, base_endpoint)
+        host_prefix = host_identifier + '.' if host_identifier else ''
+        base_url = "{}://{}{}".format(uri_scheme, host_prefix, base_endpoint)
         self.swiftype_session = SwiftypeRequestSession(self.api_key, base_url)
 
     def get_documents(self, engine_name, document_ids):

tests/test_client.py

@@ -27,6 +27,15 @@ 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_host_identifier_is_optional(self):
+        client = Client('', 'api_key', 'localhost:3002/api/as/v1', False)
+        query = 'query'
+
+        with requests_mock.Mocker() as m:
+            url = "http://localhost:3002/api/as/v1/engines/some-engine-name/search"
+            m.register_uri('GET', url, json={}, status_code=200)
+            client.search(self.engine_name, query, {})
+
     def test_index_document_processing_error(self):
         invalid_document = {'id': 'something', 'bad': {'no': 'nested'}}
         error = 'some processing error'