algoliasearch 1.2.10 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5a732fe0627231c87d9015404183714d411ca8
-  data.tar.gz: 3c90c3e9c12cafa3cb37d254acf723c3a210f48b
+  metadata.gz: 128d59909c267e976baa312097edd9519eb92a6f
+  data.tar.gz: e770982f18181545c66310809c06998401f61ac7
 SHA512:
-  metadata.gz: c3a164a8ca1699b0f34801431985fd475a1440ca04de278cf81fe7640b5bebd44a5ee86b92a0e60a967f0e777f51e06afac3a689381581a9aa71d0cd5f101f50
-  data.tar.gz: e51c1cd7aef502ee8ea4d6eecff24e22be7ef957590d008df148225590857eb797ec27de59b8c4741798adcd0fe90897c5535c0c870836ad0e705616f64195c7
+  metadata.gz: df02e9a483a05a462ee68994d8dfb90021540e85da394805906481126730c3b402b3fb409c4dbcf973b05def05ed8c363208d5838a2cc3ae8535982903f31528
+  data.tar.gz: 76d1f9897e16c3c919e8db4cf508eaff64f92b04bba77f87cd974d7d544c7aff6eef2c3d8b3acfdd6e5a4fe287466ab6d840368b00b363ec8bed6e2e169dc1fb

data/README.md

@@ -256,13 +256,14 @@ You can use the following optional arguments:
   * **prefixLast**: only the last word is interpreted as a prefix (default behavior),
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
  * **removeWordsIfNoResult**: This option to select a strategy to avoid having an empty result page. There is three different option:
-  * **LastWords**: when a query does not return any result, the final word will be removed until there is results,
-  * **FirstWords**: when a query does not return any result, the first word will be removed until there is results,
+  * **LastWords**: when a query does not return any result, the last word will be added as optional (the process is repeated with n-1 word, n-2 word, ... until there is results),
+  * **FirstWords**: when a query does not return any result, the first word will be added as optional (the process is repeated with second word, third word, ... until there is results),
   * **None**: No specific processing is done when a query does not return any result (default behavior).
  * **typoTolerance**: if set to false, disable the typo-tolerance. Defaults to true.
- * **minWordSizefor1Typo**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 3.
- * **minWordSizefor2Typos**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 7.
+ * **minWordSizefor1Typo**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 4.
+ * **minWordSizefor2Typos**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 8.
  * **allowTyposOnNumericTokens**: if set to false, disable typo-tolerance on numeric tokens (numbers). Default to true.
+ * **ignorePlural**: If set to true, plural won't be considered as a typo (for example car/cars will be considered as equals). Default to false.
  * **restrictSearchableAttributes** List of attributes you want to use for textual search (must be a subset of the `attributesToIndex` index setting). Attributes are separated with a comma (for example `"name,address"`), you can also use a JSON string array encoding (for example encodeURIComponent("[\"name\",\"address\"]")). By default, all attributes specified in `attributesToIndex` settings are used to search.
  * **advancedSyntax**: Enable the advanced query syntax. Defaults to 0 (false).
     * **Phrase query**: a phrase query defines a particular sequence of terms. A phrase query is build by Algolia's query parser for words surrounded by `"`. For example, `"search engine"` will retrieve records having `search` next to `engine` only. Typo-tolerance is _disabled_ on phrase queries.
@@ -455,6 +456,8 @@ For example `"customRanking" => ["desc(population)", "asc(name)"]`
   * **prefixLast**: only the last word is interpreted as a prefix (default behavior),
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
  * **slaves**: The list of indices on which you want to replicate all write operations. In order to get response times in milliseconds, we pre-compute part of the ranking during indexing. If you want to use different ranking configurations depending of the use-case, you need to create one index per ranking configuration. This option enables you to perform write operations only on this index, and to automatically update slave indices with the same operations.
+ * **unretrievableAttributes**: The list of attributes that cannot be retrieved at query time. This feature allow to have an attribute that is used for indexing and/or ranking but cannot be retrieved. Default to null.
+ * **allowCompressionOfIntegerArray**: Allows compression of big integer arrays. We recommended to store the list of user ID or rights as an integer array and enable this setting. When enabled the integer array are reordered to reach a better compression ratio. Default to false.
 
 #### Query expansion
  * **synonyms**: (array of array of words considered as equals). For example, you may want to retrieve your **black ipad** record when your users are searching for **dark ipad**, even if the **dark** word is not part of the record: so you need to configure **black** as a synonym of **dark**. For example `"synomyms": [ [ "black", "dark" ], [ "small", "little", "mini" ], ... ]`.
@@ -470,8 +473,8 @@ For example `"customRanking" => ["desc(population)", "asc(name)"]`
   For example `"altCorrections": [ { "word" : "foot", "correction": "feet", "nbTypos": 1}, { "word": "feet", "correction": "foot", "nbTypos": 1}].`
 
 #### Default query parameters (can be overwrite by query)
- * **minWordSizefor1Typo**: (integer) the minimum number of characters to accept one typo (default = 3).
- * **minWordSizefor2Typos**: (integer) the minimum number of characters to accept two typos (default = 7).
+ * **minWordSizefor1Typo**: (integer) the minimum number of characters to accept one typo (default = 4).
+ * **minWordSizefor2Typos**: (integer) the minimum number of characters to accept two typos (default = 8).
  * **hitsPerPage**: (integer) the number of hits per page (default = 10).
  * **attributesToRetrieve**: (array of strings) default list of attributes to retrieve in objects. If set to null, all attributes are retrieved.
  * **attributesToHighlight**: (array of strings) default list of attributes to highlight. If set to null, all indexed attributes are highlighted.
@@ -631,6 +634,19 @@ res = index.add_user_key(["search"], 300, 100, 20, ['my_index1', 'my_index2'])
 puts res['key']
 ```
 
+Update the rights of an existing key:
+```ruby
+# Update an existing global API key that is valid for 300 seconds
+res = Algolia.update_user_key("myAPIKey", ["search"], 300)
+puts res['key']
+# Update an existing index specific API key:
+#  - valid for 300 seconds
+#  - rate limit of 100 calls per hour per IP
+#  - maximum of 20 hits
+#  - valid on 'my_index1' and 'my_index2'
+res = index.update_user_key("myAPIKey", ["search"], 300, 100, 20, ['my_index1', 'my_index2'])
+puts res['key']
+```
 Get the rights of a given key:
 ```ruby
 # Gets the rights of a global key

data/algoliasearch.gemspec

@@ -6,7 +6,7 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.10"
+  s.version = "1.2.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/lib/algolia/client.rb

@@ -311,6 +311,35 @@ module Algolia
     Algolia.client.post(Protocol.keys_uri, params.to_json)
   end
 
+  #
+  #  Update a user key
+  #
+  #  @param acls the list of ACL for this key. Defined by an array of strings that 
+  #         can contains the following values:
+  #           - search: allow to search (https and http)
+  #           - addObject: allows to add a new object in the index (https only)
+  #           - updateObject : allows to change content of an existing object (https only)
+  #           - deleteObject : allows to delete an existing object (https only)
+  #           - deleteIndex : allows to delete index content (https only)
+  #           - settings : allows to get index settings (https only)
+  #           - editSettings : allows to change index settings (https only)
+  #  @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
+  #  @param maxQueriesPerIPPerHour the maximum number of API calls allowed from an IP address per hour (0 means unlimited)
+  #  @param maxHitsPerQuery  the maximum number of hits this API key can retrieve in one call (0 means unlimited)
+  #  @param indexes the optional list of targeted indexes
+  #
+  def Algolia.update_user_key(key, acls, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0, indexes = nil)
+    params = {
+      :acl => acls,
+      :validity => validity.to_i,
+      :maxQueriesPerIPPerHour => maxQueriesPerIPPerHour.to_i,
+      :maxHitsPerQuery => maxHitsPerQuery.to_i
+    }
+    params[:indexes] = indexes if indexes
+    Algolia.client.put(Protocol.key_uri(key), params.to_json)
+  end
+
+
   # Delete an existing user key
   def Algolia.delete_user_key(key)
       Algolia.client.delete(Protocol.key_uri(key))

data/lib/algolia/index.rb

@@ -438,6 +438,25 @@ module Algolia
     def add_user_key(acls, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0)
       Algolia.client.post(Protocol.index_keys_uri(name), {:acl => acls, :validity => validity, :maxQueriesPerIPPerHour => maxQueriesPerIPPerHour.to_i, :maxHitsPerQuery => maxHitsPerQuery.to_i}.to_json)
     end
+
+    #
+    #  Update a user key
+    #
+    #  @param acls the list of ACL for this key. Defined by an array of strings that 
+    #         can contains the following values:
+    #           - search: allow to search (https and http)
+    #           - addObject: allows to add a new object in the index (https only)
+    #           - updateObject : allows to change content of an existing object (https only)
+    #           - deleteObject : allows to delete an existing object (https only)
+    #           - deleteIndex : allows to delete index content (https only)
+    #           - settings : allows to get index settings (https only)
+    #           - editSettings : allows to change index settings (https only)
+    #  @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
+    #
+    def update_user_key(key, acls, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0)
+      Algolia.client.put(Protocol.index_key_uri(name, key), {:acl => acls, :validity => validity, :maxQueriesPerIPPerHour => maxQueriesPerIPPerHour.to_i, :maxHitsPerQuery => maxHitsPerQuery.to_i}.to_json)
+    end
+
  
     # Delete an existing user key
     def delete_user_key(key)

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.2.10"
+  VERSION = "1.2.11"
 end

data/spec/client_spec.rb

@@ -333,6 +333,10 @@ describe 'Client' do
     is_include(resIndexAfter['keys'], 'value', newIndexKey['key']).should eq(true)
     indexKey = @index.get_user_key(newIndexKey['key'])
     indexKey['acl'][0].should eq('search')
+    @index.update_user_key(newIndexKey['key'], ['addObject'])
+    sleep 2 # no task ID here
+    indexKey = @index.get_user_key(newIndexKey['key'])
+    indexKey['acl'][0].should eq('addObject')
     @index.delete_user_key(newIndexKey['key'])
     sleep 2 # no task ID here
     resIndexEnd = @index.list_user_keys
@@ -348,6 +352,10 @@ describe 'Client' do
     is_include(resAfter['keys'], 'value', newKey['key']).should eq(true)
     key = Algolia.get_user_key(newKey['key'])
     key['acl'][0].should eq('search')
+    Algolia.update_user_key(newKey['key'], ['addObject'])
+    sleep 2 # no task ID here
+    key = Algolia.get_user_key(newKey['key'])
+    key['acl'][0].should eq('addObject')
     Algolia.delete_user_key(newKey['key'])
     sleep 2 # no task ID here
     resEnd = Algolia.list_user_keys

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.11
 platform: ruby
 authors:
 - Algolia
@@ -14,70 +14,70 @@ dependencies:
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby client for the algolia.com REST API
@@ -89,8 +89,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".rspec"
-- ".travis.yml"
+- .rspec
+- .travis.yml
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -121,17 +121,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API