Merge pull request #122 from algolia/search-facet-new-name

rename search_facet in a backward-compatible way

Author: LeoErcolanelli

ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2016-11-29 1.10.1
+    * Add `search_for_facet_value` to supplant `search_facet`
+
 2016-10-19 1.10.0
     * Add `attribute_to_retrieve` to `get_objects`
     * Add `no_create` with `partial_update_object`

algoliasearch/index.py

@@ -904,7 +904,7 @@ def batch(self, requests, no_create=False):
 
         return self._req(False, '/batch', 'POST', data=requests)
 
-    def search_facet(self, facet_name, facet_query, query=None):
+    def search_for_facet_values(self, facet_name, facet_query, query=None):
         """
         Perform a search within a given facet's values
         @param facet_name name of the facet to search. It must have been
@@ -922,6 +922,11 @@ def search_facet(self, facet_name, facet_query, query=None):
         path = '/facets/%s/query' % safe(facet_name)
         return self._req(True, path, 'POST', data={'params' : urlencode(urlify(query))})
 
+
+    def search_facet(self, facet_name, facet_query, query=None):
+        return self.search_for_facet_values(facet_name, facet_query, query)
+
+
     def _req(self, is_search, path, meth, params=None, data=None):
         """Perform an HTTPS request with retry logic."""
         path = '%s%s' % (self._request_path, path)

algoliasearch/version.py

@@ -1 +1 @@
-VERSION = "1.10.0"
+VERSION = "1.10.1"