Add analytics rules resource.

Author: kishorenc

examples/analytics_operations.py

@@ -0,0 +1,58 @@
+import typesense
+
+client = typesense.Client({
+  'api_key': 'abcd',
+  'nodes': [{
+    'host': 'localhost',
+    'port': '8108',
+    'protocol': 'http'
+  }],
+  'connection_timeout_seconds': 2
+})
+
+# Drop pre-existing rule if any
+try:
+    client.analytics_rules['top_queries'].delete()
+except Exception as e:
+    pass
+
+# Create a new rule
+create_response = client.analytics_rules.create({
+    "name": "top_queries",
+    "type": "popular_queries",
+    "params": {
+        "source": {
+            "collections": ["products"]
+        },
+        "destination": {
+            "collection": "top_queries"
+        },
+        "limit": 1000
+    }
+})
+print(create_response)
+
+# Try to fetch it back
+print(client.analytics_rules['top_queries'].retrieve())
+
+# Update the rule
+update_response = client.analytics_rules.upsert('top_queries', {
+    "name": "top_queries",
+    "type": "popular_queries",
+    "params": {
+        "source": {
+            "collections": ["products"]
+        },
+        "destination": {
+            "collection": "top_queries"
+        },
+        "limit": 100
+    }
+})
+print(update_response)
+
+# List all rules
+print(client.analytics_rules.retrieve())
+
+# Delete the rule
+print(client.analytics_rules['top_queries'].delete())

typesense/analytics_rule.py

@@ -0,0 +1,14 @@
+class AnalyticsRule(object):
+    def __init__(self, api_call, rule_id):
+        self.api_call = api_call
+        self.rule_id = rule_id
+
+    def _endpoint_path(self):
+        from .analytics_rules import AnalyticsRules
+        return u"{0}/{1}".format(AnalyticsRules.RESOURCE_PATH, self.rule_id)
+
+    def retrieve(self):
+        return self.api_call.get(self._endpoint_path())
+
+    def delete(self):
+        return self.api_call.delete(self._endpoint_path())

typesense/analytics_rules.py

@@ -0,0 +1,26 @@
+from .analytics_rule import AnalyticsRule
+
+
+class AnalyticsRules(object):
+    RESOURCE_PATH = '/analytics/rules'
+
+    def __init__(self, api_call):
+        self.api_call = api_call
+        self.rules = {}
+
+    def __getitem__(self, rule_id):
+        if rule_id not in self.rules:
+            self.rules[rule_id] = AnalyticsRule(self.api_call, rule_id)
+
+        return self.rules[rule_id]
+
+    def create(self, rule, params=None):
+        params = params or {}
+        return self.api_call.post(AnalyticsRules.RESOURCE_PATH, rule, params)
+
+    def upsert(self, id, rule):
+        return self.api_call.put(u"{0}/{1}".format(AnalyticsRules.RESOURCE_PATH, id), rule)
+
+    def retrieve(self):
+        return self.api_call.get(AnalyticsRules.RESOURCE_PATH)
+

typesense/client.py

@@ -6,7 +6,7 @@
 from .operations import Operations
 from .configuration import Configuration
 from .api_call import ApiCall
-
+from .analytics_rules import AnalyticsRules
 
 class Client(object):
     def __init__(self, config_dict):
@@ -16,5 +16,6 @@ def __init__(self, config_dict):
         self.multi_search = MultiSearch(self.api_call)
         self.keys = Keys(self.api_call)
         self.aliases = Aliases(self.api_call)
+        self.analytics_rules = AnalyticsRules(self.api_call)
         self.operations = Operations(self.api_call)
         self.debug = Debug(self.api_call)