Added clickthrough tracking

Author: JasonStoltz

README.md

@@ -213,19 +213,10 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 {'results': {'documents': [{'suggestion': 'cat'}]}, 'meta': {'request_id': '390be384ad5888353e1b32adcfaaf1c9'}}
 ```
 
-```ruby
-engine_name = 'favorite-videos'
-
-options = {
-  :size => 3,
-  :types => {
-    :documents => {
-      :fields => ['title']
-    }
-  }
-}
+### Clickthrough Tracking
 
-client.query_suggestion(engine_name, 'cat', options)
+```python
+>>> client.click(engine_name, {'query': 'cat', 'document_id': 'INscMGmhmX4'})
 ```
 
 

swiftype_app_search/client.py

@@ -200,6 +200,18 @@ def query_suggestion(self, engine_name, query, options=None):
         options['query'] = query
         return self.swiftype_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.
+        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)
+
 
     @staticmethod
     def create_signed_search_key(api_key, api_key_name, options):

swiftype_app_search/swiftype_request_session.py

@@ -33,8 +33,11 @@ def raise_if_error(self, response):
         response.raise_for_status()
 
     def request(self, http_method, endpoint, base_url=None, **kwargs):
+        return self.request_ignore_response(http_method, endpoint, base_url, **kwargs).json()
+
+    def request_ignore_response(self, http_method, endpoint, base_url=None, **kwargs):
         base_url = base_url or self.base_url
         url = "{}/{}".format(base_url, endpoint)
         response = self.session.request(http_method, url, **kwargs)
         self.raise_if_error(response)
-        return response.json()
+        return response

tests/test_client.py

@@ -242,3 +242,12 @@ def test_query_suggestion(self):
             m.register_uri('GET', url, json=expected_return, status_code=200)
             response = self.client.query_suggestion(self.engine_name, query, {})
             self.assertEqual(response, expected_return)
+
+    def test_click(self):
+        with requests_mock.Mocker() as m:
+            url = "{}/{}".format(
+                self.client.swiftype_session.base_url,
+                "engines/{}/click".format(self.engine_name)
+            )
+            m.register_uri('POST', url, json={}, status_code=200)
+            self.client.click(self.engine_name, {'query': 'cat', 'document_id': 'INscMGmhmX4'})