Merge pull request typesense#4 from typesense/alias-curation-apis

Alias curation apis

Author: kishorenc

examples/alias_operations.py

@@ -0,0 +1,78 @@
+import typesense
+
+# Aliasing is a Typesense Premium feature (see: https://typesense.org/premium)
+
+client = typesense.Client({
+  'master_node': {
+    'host': 'localhost',
+    'port': '8108',
+    'protocol': 'http',
+    'api_key': 'abcd'
+  },
+  'read_replica_nodes': [{
+    'host': 'localhost',
+    'port': '9108',
+    'protocol': 'http',
+    'api_key': 'abcd'
+  }],
+  'timeout_seconds': 2
+})
+
+# Create a collection
+
+create_response = client.collections.create({
+  "name": "books_january",
+  "fields": [
+    {"name": "title", "type": "string" },
+    {"name": "authors", "type": "string[]" },
+    {"name": "authors_facet", "type": "string[]", "facet": True },
+    {"name": "publication_year", "type": "int32" },
+    {"name": "publication_year_facet", "type": "string", "facet": True },
+    {"name": "ratings_count", "type": "int32" },
+    {"name": "average_rating", "type": "float" },
+    {"name": "image_url", "type": "string" }
+  ],
+  "default_sorting_field": "ratings_count"
+})
+
+print(create_response)
+
+# Create or update an existing alias
+
+create_alias_response = client.aliases.upsert('books', {
+    "collection_name": "books_january"
+})
+
+print(create_alias_response)
+
+# Add a book using the alias name `books`
+
+hunger_games_book = {
+  'id': '1', 'original_publication_year': 2008, 'authors': ['Suzanne Collins'], 'average_rating': 4.34,
+  'publication_year': 2008, 'publication_year_facet': '2008', 'authors_facet': ['Suzanne Collins'],
+  'title': 'The Hunger Games',
+  'image_url': 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
+  'ratings_count': 4780653
+}
+
+client.collections['books'].documents.create(hunger_games_book)
+
+# Search using the alias
+
+print(client.collections['books'].documents.search({
+    'q': 'hunger',
+    'query_by': 'title',
+    'sort_by': 'ratings_count:desc'
+}))
+
+# List all aliases
+
+print(client.aliases.retrieve())
+
+# Retrieve the configuration of a specific alias
+
+print(client.aliases['books'].retrieve())
+
+# Delete an alias
+
+print(client.aliases['books'].delete())

examples/curation_operations.py

@@ -0,0 +1,84 @@
+import typesense
+
+# Curation is a Typesense Premium feature (see: https://typesense.org/premium)
+
+client = typesense.Client({
+  'master_node': {
+    'host': 'localhost',
+    'port': '8108',
+    'protocol': 'http',
+    'api_key': 'abcd'
+  },
+  'read_replica_nodes': [{
+    'host': 'localhost',
+    'port': '9108',
+    'protocol': 'http',
+    'api_key': 'abcd'
+  }],
+  'timeout_seconds': 2
+})
+
+# Create a collection
+
+create_response = client.collections.create({
+  "name": "books",
+  "fields": [
+    {"name": "title", "type": "string" },
+    {"name": "authors", "type": "string[]" },
+    {"name": "authors_facet", "type": "string[]", "facet": True },
+    {"name": "publication_year", "type": "int32" },
+    {"name": "publication_year_facet", "type": "string", "facet": True },
+    {"name": "ratings_count", "type": "int32" },
+    {"name": "average_rating", "type": "float" },
+    {"name": "image_url", "type": "string" }
+  ],
+  "default_sorting_field": "ratings_count"
+})
+
+print(create_response)
+
+# Create or update an override
+
+create_override_response = client.collections["books"].overrides.upsert('hermione-exact', {
+  "rule": {
+    "query": "hermione",
+    "match": "exact"
+  },
+  "includes": [
+    {"id": "1", "position": 1},
+  ]
+})
+
+print(create_override_response)
+
+# List all overrides
+
+print(client.collections["books"].overrides.retrieve())
+
+# Retrieve the configuration of a specific override
+
+print(client.collections["books"].overrides["hermione-exact"].retrieve())
+
+# Add a book
+
+hunger_games_book = {
+  'id': '1', 'original_publication_year': 2008, 'authors': ['JK Rowling'], 'average_rating': 4.34,
+  'publication_year': 2008, 'publication_year_facet': '2008', 'authors_facet': ['JK Rowling'],
+  'title': 'Harry Potter and the Goblet of Fire',
+  'image_url': 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
+  'ratings_count': 4780653
+}
+
+client.collections['books'].documents.create(hunger_games_book)
+
+# Search for a book
+
+print(client.collections['books'].documents.search({
+    'q': 'hermione',
+    'query_by': 'title',
+    'sort_by': 'ratings_count:desc'
+}))
+
+# Delete an override
+
+print(client.collections['books'].overrides["hermione-exact"].delete())

requirements.txt

@@ -1 +1 @@
-requests==2.18.4
+requests==2.22.0

typesense/alias.py

@@ -0,0 +1,19 @@
+from .documents import Documents
+from .api_call import ApiCall
+
+
+class Alias(object):
+    def __init__(self, config, name):
+        self.config = config
+        self.name = name
+        self.api_call = ApiCall(config)
+
+    def _endpoint_path(self):
+        from .aliases import Aliases
+        return u"{0}/{1}".format(Aliases.RESOURCE_PATH, self.name)
+
+    def retrieve(self):
+        return self.api_call.get(self._endpoint_path())
+
+    def delete(self):
+        return self.api_call.delete(self._endpoint_path())

typesense/aliases.py

@@ -0,0 +1,26 @@
+from typesense.alias import Alias
+from .api_call import ApiCall
+
+
+class Aliases(object):
+    RESOURCE_PATH = '/aliases'
+
+    def __init__(self, config):
+        self.config = config
+        self.api_call = ApiCall(config)
+        self.aliases = {}
+
+    def __getitem__(self, name):
+        if name not in self.aliases:
+            self.aliases[name] = Alias(self.config, name)
+
+        return self.aliases.get(name)
+
+    def _endpoint_path(self, alias_name):
+        return u"{0}/{1}".format(Aliases.RESOURCE_PATH, alias_name)
+
+    def upsert(self, name, mapping):
+        return self.api_call.put(self._endpoint_path(name), mapping)
+
+    def retrieve(self):
+        return self.api_call.get(Aliases.RESOURCE_PATH)

typesense/api_call.py

@@ -66,7 +66,20 @@ def post(self, endpoint, body):
                           timeout=self.config.timeout_seconds)
         if r.status_code != 201:
             error_message = r.json().get('message', 'API error.')
-            print(url)
+            raise ApiCall.get_exception(r.status_code)(error_message)
+
+        return r.json()
+
+    def put(self, endpoint, body):
+        url = self.config.master_node.url() + endpoint
+        api_key = self.config.master_node.api_key
+
+        r = requests.put(url, json=body,
+                         headers={ApiCall.API_KEY_HEADER_NAME: api_key},
+                         timeout=self.config.timeout_seconds)
+
+        if r.status_code != 200:
+            error_message = r.json().get('message', 'API error.')
             raise ApiCall.get_exception(r.status_code)(error_message)
 
         return r.json()

typesense/client.py

@@ -1,3 +1,4 @@
+from .aliases import Aliases
 from .collections import Collections
 from .configuration import Configuration
 
@@ -6,3 +7,4 @@ class Client(object):
     def __init__(self, config_dict):
         self.config = Configuration(config_dict)
         self.collections = Collections(self.config)
+        self.aliases = Aliases(self.config)

typesense/collection.py

@@ -1,3 +1,4 @@
+from .overrides import Overrides
 from .documents import Documents
 from .api_call import ApiCall
 
@@ -8,6 +9,7 @@ def __init__(self, config, name):
         self.name = name
         self.api_call = ApiCall(config)
         self.documents = Documents(config, name)
+        self.overrides = Overrides(config, name)
 
     def _endpoint_path(self):
         from .collections import Collections

typesense/override.py

@@ -0,0 +1,21 @@
+from .api_call import ApiCall
+
+
+class Override(object):
+    def __init__(self, config, collection_name, override_id):
+        self.config = config
+        self.collection_name = collection_name
+        self.override_id = override_id
+        self.api_call = ApiCall(config)
+
+    def _endpoint_path(self):
+        from .overrides import Overrides
+        from .collections import Collections
+        return u"{0}/{1}/{2}/{3}".format(Collections.RESOURCE_PATH, self.collection_name, Overrides.RESOURCE_PATH,
+                                         self.override_id)
+
+    def retrieve(self):
+        return self.api_call.get(self._endpoint_path())
+
+    def delete(self):
+        return self.api_call.delete(self._endpoint_path())

typesense/overrides.py

@@ -0,0 +1,30 @@
+from .override import Override
+from .api_call import ApiCall
+
+
+class Overrides(object):
+    RESOURCE_PATH = 'overrides'
+
+    def __init__(self, config, collection_name):
+        self.config = config
+        self.api_call = ApiCall(config)
+        self.collection_name = collection_name
+        self.overrides = {}
+
+    def __getitem__(self, override_id):
+        if override_id not in self.overrides:
+            self.overrides[override_id] = Override(self.config, self.collection_name, override_id)
+
+        return self.overrides[override_id]
+
+    def _endpoint_path(self, override_id=None):
+        from .collections import Collections
+        override_id = override_id or ''
+        return u"{0}/{1}/{2}/{3}".format(Collections.RESOURCE_PATH, self.collection_name,
+                                         Overrides.RESOURCE_PATH, override_id)
+
+    def upsert(self, id, config):
+        return self.api_call.put(self._endpoint_path(id), config)
+
+    def retrieve(self):
+        return self.api_call.get(self._endpoint_path())