feat(request_options): add test

Author: LeoErcolanelli

algoliasearch/client.py

@@ -45,6 +45,22 @@
 MAX_API_KEY_LENGTH = 500
 
 
+class RequestOptions:
+    HEADERS = {
+        'forwardedFor': 'X-Forwarded-For'
+    }
+
+    def __init__(self, options):
+        self.headers = {}
+        self.parameters = {}
+
+        for k, v in options.items():
+            if k in self.HEADERS:
+                self.headers[self.HEADERS[k]] = v
+            else:
+                self.parameters[k] = v
+
+
 class Client(object):
     """
     Entry point in the Python Client API.

algoliasearch/index.py

@@ -35,25 +35,17 @@
 from .helpers import safe
 
 
-class RequestOptions:
-    def __init__(self, options):
-        self.headers = {}
-        self.parameters = {}
-
-        if 'forwaredFor' in options:
-            self.headers['X-Forwarded-For'] = options['forwaredFor']
-
-
 class IndexIterator:
     """Iterator on index."""
 
-    def __init__(self, index, params=None, cursor=None):
+    def __init__(self, index, params=None, cursor=None, request_options=None):
         if params is None:
             params = {}
 
         self.index = index
         self.params = params
         self.cursor = cursor
+        self.request_options = request_options
 
     def __iter__(self):
         self._load_next_page()
@@ -74,7 +66,7 @@ def next(self):
                 raise StopIteration
 
     def _load_next_page(self):
-        self.answer = self.index.browse_from(self.params, self.cursor)
+        self.answer = self.index.browse_from(self.params, self.cursor, self.request_options)
         self.pos = 0
         self.cursor = self.answer.get('cursor', None)
 
@@ -271,7 +263,7 @@ def partial_update_objects(self, objects, no_create=False, request_options=None)
                 'objectID': obj['objectID'],
                 'body': obj
             })
-        return self.batch(requests, request_options, no_create=no_create)
+        return self.batch(requests, no_create=no_create, request_options=request_options)
 
     @deprecated
     def saveObject(self, obj):
@@ -591,7 +583,7 @@ def browse(self, page=0, hits_per_page=1000):
             of hits per page. Defaults to 1000.
         """
         params = {'page': page, 'hitsPerPage': hits_per_page}
-        return self._req(True, '/browse', 'GET', params)
+        return self._req(True, '/browse', 'GET', None, params)
 
     def browse_from(self, params=None, cursor=None, request_options=None):
         """
@@ -683,7 +675,7 @@ def delete_synonym(self, object_id, forward_to_slaves=False,
 
         path = '/synonyms/%s' % safe(object_id)
         params = {'forwardToReplicas': forward_to_replicas}
-        return self._req(False, path, 'DELETE', params)
+        return self._req(False, path, 'DELETE', request_options, params)
 
     def clear_synonyms(self, forward_to_slaves=False,
                        forward_to_replicas=False, request_options=None):
@@ -1141,4 +1133,4 @@ def search_rules(self, query=None, anchoring=None, context=None, page=None, hits
     def _req(self, is_search, path, meth, request_options, params=None, data=None):
         """Perform an HTTPS request with retry logic."""
         path = '%s%s' % (self._request_path, path)
-        return self.client._req(is_search, path, meth, params, data, request_options)
+        return self.client._req(is_search, path, meth, request_options, params, data)

algoliasearch/transport.py

@@ -144,23 +144,17 @@ def req(self, is_search, path, meth, params, data, request_options):
         """Perform an HTTPS request with retry logic."""
 
         # Merge params and request_options params.
-        if params is None:
-            params = request_options.parameters
-        elif request_options.parameters is not None:
-            old_params = params
-            params = params.copy()
-            params.update(old_params)
+        params = {} if params is None else params.copy()
+        if request_options is not None and request_options.parameters is not None:
+            params.update(request_options.parameters)
+
+        params = urlify(params)
 
         # Merge headers and request_options headers.
-        if self.headers is None:
-            headers = request_options.headers
-        elif request_options.headers is not None:
-            headers = self.headers.copy()
+        headers = {} if self.headers is None else self.headers.copy()
+        if request_options is not None and request_options.headers is not None:
             headers.update(request_options.headers)
 
-        if params is not None:
-            params = urlify(params)
-
         if data is not None:
             data = json.dumps(data, cls=CustomJSONEncoder)
 

tests/helpers.py

@@ -9,6 +9,8 @@
 from faker import Factory
 from algoliasearch.client import Client
 
+from collections import namedtuple
+
 
 class FakeData(object):
     def __init__(self):
@@ -87,3 +89,17 @@ def wait_missing_key(index, key):
         except:
             # Not found.
             return
+
+FakeResp = namedtuple('FakeResp', ['status_code', 'json'])
+
+class FakeSession(object):
+    def __init__(self, test_class, exp_headers, exp_params):
+        self.test_class = test_class
+        self.headers = exp_headers
+        self.params = exp_params
+
+    def request(self, path, meth, timeout, params, data, headers):
+        self.test_class.assertDictEqual(headers, self.headers)
+        self.test_class.assertDictEqual(params, self.params)
+
+        return FakeResp(status_code=200, json=lambda: '{}')

tests/test_client.py

@@ -11,12 +11,12 @@
 except ImportError:
     import unittest
 
-from algoliasearch.client import Client, MAX_API_KEY_LENGTH
+from algoliasearch.client import Client, MAX_API_KEY_LENGTH, RequestOptions
 from algoliasearch.helpers import AlgoliaException
 
 from .helpers import safe_index_name
 from .helpers import get_api_client
-from .helpers import FakeData
+from .helpers import FakeData, FakeSession
 
 
 class ClientTest(unittest.TestCase):
@@ -44,6 +44,19 @@ def tearDownClass(cls):
 class ClientNoDataOperationsTest(ClientTest):
     """Tests that use two index and don't make any data operations."""
 
+    def test_request_options(self):
+        options = {'forwardedFor': 'blabla', 'hitsPerPage': 40}
+
+        expected_headers = self.client._transport.headers.copy()
+        expected_headers.update({'X-Forwarded-For': 'blabla'})
+
+        fake_session = FakeSession(self, expected_headers , {'hitsPerPage': 40})
+
+        old_session = self.client._transport.session
+        self.client._transport.session = fake_session
+        self.client.is_alive(RequestOptions(options))
+        self.client._transport.session = old_session
+
     def test_rate_limit_forward(self):
         hearders_rate_limit = {
             'X-Forwarded-For': '127.0.0.1',