Merge pull request #3 from afoucret/update-package-name

Update package name

Author: afoucret

README.md

@@ -22,7 +22,7 @@
 To install the client, use pip:
 
 ```python
-python -m pip install swiftype_app_search
+python -m pip install elastic-app-search
 ```
 
 You can also download the project source and run::
@@ -42,7 +42,7 @@ python setup.py install
 ### Instantiating a client
 
 ```python
->>> from swiftype_app_search import Client
+>>> from elastic_app_search import Client
 >>> host_identifier = 'host-c5s2mj'
 >>> api_key = 'private-mu75psc5egt9ppzuycnc2mc3'
 >>> client = Client(host_identifier, api_key)
@@ -53,7 +53,7 @@ python setup.py install
 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.
 
 ```python
->>> from swiftype_app_search import Client
+>>> from elastic_app_search import Client
 >>> client = Client(
     api_key='private-mu75psc5egt9ppzuycnc2mc3',
     base_endpoint='localhost:3002/api/as/v1',

swiftype_app_search/__init__.py renamed to elastic_app_search/__init__.py

@@ -0,0 +1,6 @@
+__title__ = 'elastic-app-search'
+__description__ = 'An API client for Elastic App Search'
+__url__ = 'https://github.com/elastic/app-search-python'
+__version__ = '0.6.0'
+__author__ = 'Elastic'
+__author_email__ = 'support@elastic.co'

elastic_app_search/__version__.py

@@ -1,16 +1,16 @@
 import json
 import jwt
-from .swiftype_request_session import SwiftypeRequestSession
+from .request_session import RequestSession
 from .exceptions import InvalidDocument
 
 
 class Client:
 
-    SWIFTYPE_APP_SEARCH_BASE_ENDPOINT = 'api.swiftype.com/api/as/v1'
+    ELASTIC_APP_SEARCH_BASE_ENDPOINT = 'api.swiftype.com/api/as/v1'
     SIGNED_SEARCH_TOKEN_JWT_ALGORITHM = 'HS256'
 
     def __init__(self, host_identifier='', api_key='',
-                 base_endpoint=SWIFTYPE_APP_SEARCH_BASE_ENDPOINT,
+                 base_endpoint=ELASTIC_APP_SEARCH_BASE_ENDPOINT,
                  use_https=True,
                  account_host_key='' # Deprecated - use host_identifier instead
                  ):
@@ -21,7 +21,7 @@ def __init__(self, host_identifier='', api_key='',
         uri_scheme = 'https' if use_https else 'http'
         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)
+        self.session = RequestSession(self.api_key, base_url)
 
     def get_documents(self, engine_name, document_ids):
         """
@@ -33,7 +33,7 @@ def get_documents(self, engine_name, document_ids):
         """
         endpoint = "engines/{}/documents".format(engine_name)
         data = json.dumps(document_ids)
-        return self.swiftype_session.request('get', endpoint, data=data)
+        return self.session.request('get', endpoint, data=data)
 
     def list_documents(self, engine_name, current=1, size=20):
         """
@@ -44,12 +44,12 @@ def list_documents(self, engine_name, current=1, size=20):
         :return: List of documemts.
         """
         data = { 'page': { 'current': current, 'size': size } }
-        return self.swiftype_session.request('get', "engines/{}/documents/list".format(engine_name), json=data)
+        return self.session.request('get', "engines/{}/documents/list".format(engine_name), json=data)
 
     def index_document(self, engine_name, document):
         """
         Create or update a document for an engine. Raises
-        :class:`~swiftype_app_search.exceptions.InvalidDocument` when the document
+        :class:`~elastic_app_search.exceptions.InvalidDocument` when the document
         has processing errors
 
         :param engine_name: Name of engine to index documents into.
@@ -79,7 +79,7 @@ def index_documents(self, engine_name, documents):
         endpoint = "engines/{}/documents".format(engine_name)
         data = json.dumps(documents)
 
-        return self.swiftype_session.request('post', endpoint, data=data)
+        return self.session.request('post', endpoint, data=data)
 
     def update_documents(self, engine_name, documents):
         """
@@ -93,7 +93,7 @@ def update_documents(self, engine_name, documents):
         endpoint = "engines/{}/documents".format(engine_name)
         data = json.dumps(documents)
 
-        return self.swiftype_session.request('patch', endpoint, data=data)
+        return self.session.request('patch', endpoint, data=data)
 
     def destroy_documents(self, engine_name, document_ids):
         """
@@ -105,7 +105,7 @@ def destroy_documents(self, engine_name, document_ids):
         """
         endpoint = "engines/{}/documents".format(engine_name)
         data = json.dumps(document_ids)
-        return self.swiftype_session.request('delete', endpoint, data=data)
+        return self.session.request('delete', endpoint, data=data)
 
     def get_schema(self, engine_name):
         """
@@ -115,7 +115,7 @@ def get_schema(self, engine_name):
         :return: Schema.
         """
         endpoint = "engines/{}/schema".format(engine_name)
-        return self.swiftype_session.request('get', endpoint)
+        return self.session.request('get', endpoint)
 
     def update_schema(self, engine_name, schema):
         """
@@ -127,7 +127,7 @@ def update_schema(self, engine_name, schema):
         """
         endpoint = "engines/{}/schema".format(engine_name)
         data = json.dumps(schema)
-        return self.swiftype_session.request('post', endpoint, data=data)
+        return self.session.request('post', endpoint, data=data)
 
     def list_engines(self, current=1, size=20):
         """
@@ -139,15 +139,15 @@ def list_engines(self, current=1, size=20):
         name of the engine.
         """
         data = { 'page': { 'current': current, 'size': size } }
-        return self.swiftype_session.request('get', 'engines', json=data)
+        return self.session.request('get', 'engines', json=data)
 
     def get_engine(self, engine_name):
         """
         Retrieves an engine by name.
         :param engine_name: Name of an existing engine.
         :return: A dictionary corresponding to the name of the engine.
         """
-        return self.swiftype_session.request('get', "engines/{}".format(engine_name))
+        return self.session.request('get', "engines/{}".format(engine_name))
 
     def create_engine(self, engine_name, language=None):
         """
@@ -159,7 +159,7 @@ def create_engine(self, engine_name, language=None):
         data = { 'name': engine_name }
         if language is not None:
             data['language'] = language
-        return self.swiftype_session.request('post', 'engines', json=data)
+        return self.session.request('post', 'engines', json=data)
 
     def destroy_engine(self, engine_name):
         """
@@ -168,7 +168,7 @@ def destroy_engine(self, engine_name):
         :return: A dictionary with a single key of `deleted` and a value of
         True or False.
         """
-        return self.swiftype_session.request('delete', "engines/{}".format(engine_name))
+        return self.session.request('delete', "engines/{}".format(engine_name))
 
     def search(self, engine_name, query, options=None):
         """
@@ -182,7 +182,7 @@ def search(self, engine_name, query, options=None):
         endpoint = "engines/{}/search".format(engine_name)
         options = options or {}
         options['query'] = query
-        return self.swiftype_session.request('get', endpoint, json=options)
+        return self.session.request('get', endpoint, json=options)
 
     def multi_search(self, engine_name, searches=None):
         """
@@ -206,7 +206,7 @@ def build_options_from_search(search):
         options = {
             'queries': list(map(build_options_from_search, searches))
         }
-        return self.swiftype_session.request('get', endpoint, json=options)
+        return self.session.request('get', endpoint, json=options)
 
     def query_suggestion(self, engine_name, query, options=None):
         """
@@ -220,19 +220,19 @@ def query_suggestion(self, engine_name, query, options=None):
         endpoint = "engines/{}/query_suggestion".format(engine_name)
         options = options or {}
         options['query'] = query
-        return self.swiftype_session.request('get', endpoint, json=options)
+        return self.session.request('get', endpoint, json=options)
 
     def click(self, engine_name, options):
         """
-        Sends a click event to the Swiftype App Search Api, to track a click-through event.
+        Sends a click event to the Elastic App Search Api, to track a click-through event.
         See https://swiftype.com/documentation/app-search/ for more details
         on options and return values.
 
         :param engine_name: Name of engine to search over.
         :param options: Dict of search options.
         """
         endpoint = "engines/{}/click".format(engine_name)
-        return self.swiftype_session.request_ignore_response('post', endpoint, json=options)
+        return self.session.request_ignore_response('post', endpoint, json=options)
 
 
     @staticmethod

swiftype_app_search/client.py renamed to elastic_app_search/client.py

@@ -0,0 +1,29 @@
+"""Exceptions raised by Elastic App Search Client."""
+
+class ElasticAppSearchError(Exception):
+    """Base class for all Elastic App Search errors."""
+
+class InvalidCredentials(ElasticAppSearchError):
+    """Raised when request cannot authenticate"""
+
+class NonExistentRecord(ElasticAppSearchError):
+    """Raised when record does not exist"""
+
+class RecordAlreadyExists(ElasticAppSearchError):
+    """Raised when record already exists"""
+
+class BadRequest(ElasticAppSearchError):
+    """Raised when bad request"""
+
+class Forbidden(ElasticAppSearchError):
+    """Raised when http forbidden"""
+
+class SynchronousDocumentIndexingFailed(ElasticAppSearchError):
+    """Raised when synchronous indexing of documents takes too long"""
+
+class InvalidDocument(ElasticAppSearchError):
+    """When a document has a non-accepted field or is missing a required field"""
+
+    def __init__(self, message, document):
+        super(ElasticAppSearchError, self).__init__(message)
+        self.document = document

elastic_app_search/exceptions.py

@@ -1,9 +1,9 @@
 import requests
-import swiftype_app_search
+import elastic_app_search
 from .exceptions import InvalidCredentials, NonExistentRecord, RecordAlreadyExists, BadRequest, Forbidden
 
 
-class SwiftypeRequestSession:
+class RequestSession:
 
     def __init__(self, api_key, base_url):
         self.api_key = api_key
@@ -12,8 +12,8 @@ def __init__(self, api_key, base_url):
 
         headers = {
             'Authorization': "Bearer {}".format(api_key),
-            'X-Swiftype-Client': 'swiftype-app-search-python',
-            'X-Swiftype-Client-Version': swiftype_app_search.__version__,
+            'X-Swiftype-Client': 'elastic-app-search-python',
+            'X-Swiftype-Client-Version': elastic_app_search.__version__,
             'content-type': 'application/json; charset=utf8'
         }
         self.session.headers.update(headers)

swiftype_app_search/swiftype_request_session.py renamed to elastic_app_search/request_session.py

@@ -10,7 +10,7 @@
 
 here = path.abspath(path.dirname(__file__))
 about = {}
-with open(path.join(here, 'swiftype_app_search', '__version__.py'), 'r', 'utf-8') as f:
+with open(path.join(here, 'elastic_app_search', '__version__.py'), 'r', 'utf-8') as f:
     exec(f.read(), about)
 
 setup(
@@ -35,7 +35,7 @@
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
     ],
-    keywords='swiftype elastic app search api',
+    keywords='elastic app search api',
     packages=find_packages(exclude=['contrib', 'docs', 'tests']),
     install_requires=[
         'requests',