algoliasearch 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47343e37f75fab97f3f03b5077d1422376a0995f
-  data.tar.gz: d0c473b3587f99c0b64410fea213dd73f4e83ae9
+  metadata.gz: 95b3d20c46dcec3d87a58b59208d8b956f69612f
+  data.tar.gz: 8fb785f3f57a5295e30906f2edd265c8d1d126fc
 SHA512:
-  metadata.gz: 2c853a919b2dc0a269b28890fa431576dd55424776c77a784dab5bf4e0c536456f9ad1fb67e3a0378ba6f45c3c832f5b018e104866ec5ee731010550c5ffc347
-  data.tar.gz: 5e12669bdc370347f622652079fe882ed836ae6726fe123cc8d2ddfc8b80c6a1a395525dc5ae96fc33a55f4896fc37f0e0f746d1b550773979c5480cf44c4d28
+  metadata.gz: 2095a59b89eb093a49c33b7b2c3ed6e4e37c5b12f0dc1b29a7df95bdccfb6864502129e518c1761dc5ee6356303502272ca93988997b396479effb07926af946
+  data.tar.gz: c55055efdec8a1cca1c16f9211aa119f81434a589ed1482862b591104787b6a42e66c698f51389fbf628bf513602b48a80fdcebf9ec3a5bbd2fdfb7fa99b49d8

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2016-11-25 1.12.1
+      * Rename `search_facet` to `search_for_facet_values`
+
 2016-10-31 1.12.0
       * Add `search_facet`
 

data/README.md

@@ -314,11 +314,11 @@ The server response will look like:
 
     Hits are made of the JSON objects that you stored in the index; therefore, they are mostly schema-less. However, Algolia does enrich them with a few additional fields:
 
-    - `_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [`attributesToHighlight`](#attributestohighlight) is non-empty.*
+    - `_highlightResult` (object, optional): Highlighted attributes. *Note: Only returned when [attributesToHighlight](#attributestohighlight) is non-empty.*
 
         - `${attribute_name}` (object): Highlighting for one attribute.
 
-            - `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag).
+            - `value` (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via [highlightPreTag](#highlightpretag) and [highlightPostTag](#highlightposttag).
 
             - `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
 
@@ -326,15 +326,15 @@ The server response will look like:
 
             - `fullyHighlighted` (boolean): Whether the entire attribute value is highlighted.
 
-    - `_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [`attributesToSnippet`](#attributestosnippet) is non-empty.*
+    - `_snippetResult` (object, optional): Snippeted attributes. *Note: Only returned when [attributesToSnippet](#attributestosnippet) is non-empty.*
 
         - `${attribute_name}` (object): Snippeting for the corresponding attribute.
 
-            - `value` (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via [`highlightPreTag`](#highlightpretag) and [`highlightPostTag`](#highlightposttag). The text used to indicate ellipsis is specified via [`snippetEllipsisText`](#snippetellipsistext).
+            - `value` (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via [highlightPreTag](#highlightpretag) and [highlightPostTag](#highlightposttag). The text used to indicate ellipsis is specified via [snippetEllipsisText](#snippetellipsistext).
 
             - `matchLevel` (string, enum) = {`none` | `partial` | `full`}: Indicates how well the attribute matched the search query.
 
-    - `_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [`getRankingInfo`](#getrankinginfo) is `true`.*
+    - `_rankingInfo` (object, optional): Ranking information. *Note: Only returned when [getRankingInfo](#getrankinginfo) is `true`.*
 
         - `nbTypos` (integer): Number of typos encountered when matching the record. Corresponds to the `typos` ranking criterion in the ranking formula.
 
@@ -354,31 +354,33 @@ The server response will look like:
 
         - `filters` (integer): *This field is reserved for advanced usage.* It will be zero in most cases.
 
-    - `_distinctSeqID` (integer): *Note: Only returned when [`distinct`](#distinct) is non-zero.* When two consecutive results have the same value for the attribute used for "distinct", this field is used to distinguish between them.
+    - `_distinctSeqID` (integer): *Note: Only returned when [distinct](#distinct) is non-zero.* When two consecutive results have the same value for the attribute used for "distinct", this field is used to distinguish between them.
 
 - `nbHits` (integer): Number of hits that the search query matched.
 
-- `page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
+- `page` (integer): Index of the current page (zero-based). See the [page](#page) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
 
-- `hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
+- `hitsPerPage` (integer): Maximum number of hits returned per page. See the [hitsPerPage](#hitsperpage) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
 
 - `nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`. *Note: Not returned if you use `offset`/`length` for pagination.*
 
 - `processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
 
-- `query` (string): An echo of the query text. See the [`query`](#query) search parameter.
+- `query` (string): An echo of the query text. See the [query](#query) search parameter.
 
-- `queryAfterRemoval` (string, optional): *Note: Only returned when [`removeWordsIfNoResults`](#removewordsifnoresults) is set to `lastWords` or `firstWords`.* A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. The removed parts are surrounded by `<em>` tags.
+- `queryAfterRemoval` (string, optional): *Note: Only returned when [removeWordsIfNoResults](#removewordsifnoresults) is set to `lastWords` or `firstWords`.* A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. The removed parts are surrounded by `<em>` tags.
 
 - `params` (string, URL-encoded): An echo of all search parameters.
 
 - `message` (string, optional): Used to return warnings about the query.
 
-- `aroundLatLng` (string, optional): *Note: Only returned when [`aroundLatLngViaIP`](#aroundlatlngviaip) is set.* The computed geo location. **Warning: for legacy reasons, this parameter is a string and not an object.** Format: `${lat},${lng}`, where the latitude and longitude are expressed as decimal floating point numbers.
+
+- `aroundLatLng` (string, optional): *Note: Only returned when [aroundLatLngViaIP](#aroundlatlngviaip) is set.* The computed geo location. **Warning: for legacy reasons, this parameter is a string and not an object.** Format: `${lat},${lng}`, where the latitude and longitude are expressed as decimal floating point numbers.
+
 
 - `automaticRadius` (integer, optional): *Note: Only returned for geo queries without an explicitly specified radius (see `aroundRadius`).* The automatically computed radius. **Warning: for legacy reasons, this parameter is a string and not an integer.**
 
-When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additional fields are returned:
+When [getRankingInfo](#getrankinginfo) is set to `true`, the following additional fields are returned:
 
 - `serverUsed` (string): Actual host name of the server that processed the request. (Our DNS supports automatic failover and load balancing, so this may differ from the host name used in the request.)
 
@@ -390,7 +392,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
 
 ... and ranking information is also added to each of the hits (see above).
 
-When [`facets`](#facets) is non-empty, the following additional fields are returned:
+When [facets](#facets) is non-empty, the following additional fields are returned:
 
 - `facets` (object): Maps each facet name to the corresponding facet counts:
 
@@ -410,12 +412,10 @@ When [`facets`](#facets) is non-empty, the following additional fields are retur
 
         - `sum` (integer | float): The sum of all values in the result set.
 
-- `exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [`distinct`](#distinct), the facet counts cannot be exhaustive.*
-
+- `exhaustiveFacetsCount` (boolean): Whether the counts are exhaustive (`true`) or approximate (`false`). *Note: When using [distinct](#distinct), the facet counts cannot be exhaustive.*
 
 ### Search Parameters
 
-<!--PARAMETERS_LINK-->
 Here is the list of parameters you can use with the search method (`search` [scope](#scope)):
 Parameters that can also be used in a setSettings also have the `indexing` [scope](#scope)
 
@@ -492,8 +492,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 - [synonyms](#synonyms) `search`
 - [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `search`, `settings`
 - [minProximity](#minproximity) `search`, `settings`
-
-<!--/PARAMETERS_LINK-->
+- [responseFields](#responsefields) `search`, `settings`
 
 ### Multiple queries - `multiple_queries`
 
@@ -612,7 +611,7 @@ res = index.save_objects([{"firstname" => "Jimmie",
                            "objectID" => "myID2"}])
 ```
 
-To update a single object, you can use the `[Update object](#update-object---save_object) method:
+To update a single object, you can use the `save_object` method:
 
 ```ruby
 index.save_object({"firstname" => "Jimmie", 
@@ -775,8 +774,6 @@ index.set_settings({"customRanking" => ["desc(followers)"]}, {"forwardToReplicas
 
 ### Index settings parameters
 
-<!--PARAMETERS_LINK-->
-
 Here is the list of parameters you can use with the set settings method (`settings` [scope](#scope)).
 
 
@@ -842,9 +839,6 @@ Parameters that can be overridden at search time also have the `search` [scope](
 - [altCorrections](#altcorrections) `settings`
 - [placeholders](#placeholders) `settings`
 
-<!--/PARAMETERS_LINK-->
-
-
 ## Parameters
 
 ### Overview
@@ -952,6 +946,7 @@ They are three scopes:
 - [placeholders](#placeholders) `settings`
 - [altCorrections](#altcorrections) `settings`
 - [minProximity](#minproximity) `search`, `settings`
+- [responseFields](#responsefields) `search`, `settings`
 
 ### Search
 
@@ -1930,6 +1925,25 @@ Considering the query *“javascript framework”*, if you set `minProximity=2`,
 
 **Note:** the maximum `minProximity` that can be set is 7. Any higher value will disable the `proximity` criterion from the ranking formula.
 
+#### responseFields
+
+- scope: `search`, `settings`
+- type: `array of strings`
+- default: `*`
+
+
+Choose which fields the response will contain. Applies to search and browse queries.
+
+By default, all fields are returned. If this parameter is specified, only the fields explicitly listed will be returned, unless `*` is used, in which case all fields are returned. Specifying an empty list or unknown field names is an error.
+
+This parameter is mainly intended to limit the response size. For example, for complex queries, echoing of request parameters in the response's `params` field can be undesirable.
+
+Some fields cannot be filtered out:
+
+- warning `message`
+- `cursor` in browse queries
+- fields triggered explicitly via [getRankingInfo](#getrankinginfo)
+
 
 ## Manage Indices
 
@@ -2067,7 +2081,7 @@ We have several methods to manage them:
 When you need to restrict the scope of the *Search Key*, we recommend to use *Secured API Key*.
 You can generate a *Secured API Key* from the *Search Only API Key* or any search *User API Key*
 
-There is a few things to know about about *Secured API Keys*
+There is a few things to know about *Secured API Keys*
 - They always need to be generated **on your backend** using one of our API Client 
 - You can generate them on the fly (without any call to the API)
 - They will not appear on the dashboard as they are generated without any call to the API
@@ -2749,3 +2763,4 @@ end
 ```
 
 
+

data/lib/algolia/index.rb

@@ -563,7 +563,7 @@ module Algolia
       res
     end
 
-    # Search in facets
+    # Search for facet values
     #
     # @param facet Name of the facet to search. It must have been declared in the
     #       index's`attributesForFaceting` setting with the `searchable()` modifier.
@@ -571,12 +571,15 @@ module Algolia
     # @param query An optional query to take extra search parameters into account.
     #       These parameters apply to index objects like in a regular search query.
     #       Only facet values contained in the matched objects will be returned.
-    def search_facet(facet, text, query = {})
+    def search_for_facet_values(facet, text, query = {})
       params = query.clone
       params['facetQuery'] = text
       client.post(Protocol.search_facet_uri(name, facet), params.to_json)
     end
 
+    # deprecated
+    alias_method :search_facet, :search_for_facet_values
+
     # Perform a search with disjunctive facets generating as many queries as number of disjunctive facets
     #
     # @param query the query

data/lib/algolia/protocol.rb

@@ -84,7 +84,7 @@ module Algolia
     end
 
     def Protocol.search_facet_uri(index, facet)
-      "#{index_uri(index)}/facets/#{facet}/query"
+      "#{index_uri(index)}/facets/#{CGI.escape(facet)}/query"
     end
 
     def Protocol.partial_object_uri(index, object_id, create_if_not_exits = true)

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.12.0"
+  VERSION = "1.12.1"
 end

data/spec/client_spec.rb

@@ -841,7 +841,7 @@ describe 'Client' do
       :facetFilters => ['kind:animal'],
       :numericFilters => ['born >= 1955']
     }
-    answer = index.search_facet 'series', 'Peanutz', query
+    answer = index.search_for_facet_values 'series', 'Peanutz', query
     expect(answer['facetHits'].size).to eq(1)
     expect(answer['facetHits'].first['value']).to eq('Peanuts')
     expect(answer['facetHits'].first['count']).to eq(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient