algoliasearch 1.19.2 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7415df1901dcf0b5385fb28c1e442dcf0d4dbdbff4daa47ce1373103304a2382
-  data.tar.gz: ff76387ec82d308e1cd6388ab4f8c33969c086f4a504dc2e122e9fc20004b353
+  metadata.gz: 042aa8d5e6c4fd28ca302c2f6599c5ef5ec347a809ad567dde393b6633cba2c3
+  data.tar.gz: e99b0315c64bcf650d4496e2ae8a9bd7f0f12f0cb42b31e5209d6359dbe019eb
 SHA512:
-  metadata.gz: 7e76676e94d0386306ad19675804020bee0146c1f2dcb2581bb0f7f5a851b25218febed68151da64b2dbf15550fb3f2feae3328a2b206d534f4fe6b566892955
-  data.tar.gz: 5bedebce436947e4651daaff28cbba69dfc32302f2b515870663fea93fb05e85757ad0f836c20b2e19c31f9891582976fc4a56906ca91f23e98c377fcfb7c34d
+  metadata.gz: f184dce817dbe9309f2d97d131ef4738d0aa72e6e8bafb907cb2b182d96f8de367982c34eebffdbbe8ece916a7685fb1b524c01468fc0583f6a09be22a5111f1
+  data.tar.gz: d02d20d28c815d707fae14725ae5c0c1add7e056c0f2086ea18ba50d5d8f20e9cac8b06a5b35439d0ae2c13abe392e7e255c1636e9866f8cf14cdb255b5d1335

data/.travis.yml

@@ -14,11 +14,11 @@ rvm:
 - 2.4.1
 - 2.5.0
 - jruby
-- rbx-2
+- rbx-3
 
 matrix:
   allow_failures:
-    - rvm: rbx-2
+    - rvm: rbx-3
     - rvm: jruby
 
 cache: bundler

data/ChangeLog

@@ -1,4 +1,12 @@
-CHANGELOG
+2018-05-07 1.20.0
+			* Feat: deprecate api keys methods on index in favor of client ones (#286)
+			* Chore(gemfile): remove useless dependencies (#280)
+			* Fix(env): adding default env var (#279)
+			* Chore(travis): test against rubinius 3 (#281)
+			* Fix: prevent saving a rule with an empty objectid (#283)
+
+2018-04-03 1.19.2
+      * Fix Algolia.delete_index wrong number of arguments (#277)
 
 2017-12-18 1.19.1
       * Fix hard dependency on `hashdiff` (#262)

data/Gemfile

@@ -6,25 +6,24 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 # See https://github.com/algolia/algoliasearch-client-ruby/pull/257/files/36bcd0b1c4d05776dcbdb362c15a609c81f41cde
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
+if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new('1.9.3')
   gem 'hashdiff', '< 0.3.6' # Hashdiff 0.3.6 no longer supports Ruby 1.8
+  gem 'highline', '< 1.7.0'
+  gem 'mime-types', '< 2.0'
+  gem 'rubysl', '~> 2.0', :platform => :rbx
+else
+  gem 'rubysl', '~> 2.2', :platform => :rbx
 end
 
-gem 'rubysl', '~> 2.0', :platform => :rbx
-
 group :development do
-  gem 'highline', '< 1.7.0'
   gem 'coveralls'
-  gem 'safe_yaml'
-  gem 'travis'
   gem 'rake'
   gem 'rdoc'
+  gem 'travis'
 end
 
 group :test do
   gem 'rspec', '>= 2.5.0'
-  gem 'redgreen'
   gem 'webmock'
   gem 'simplecov'
-  gem 'mime-types'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.19.1)
+    algoliasearch (1.20.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 
@@ -9,7 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
-    backports (3.11.1)
+    backports (3.11.2)
     coveralls (0.7.2)
       multi_json (~> 1.3)
       rest-client (= 1.6.7)
@@ -19,7 +19,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.0)
     ethon (0.11.0)
       ffi (>= 1.3.0)
     faraday (0.14.0)
@@ -41,9 +41,7 @@ GEM
     json (2.1.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mime-types (1.25.1)
     multi_json (1.13.1)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
@@ -51,9 +49,8 @@ GEM
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rake (12.3.0)
-    rdoc (6.0.1)
-    redgreen (1.2.2)
+    rake (12.3.1)
+    rdoc (6.0.3)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (3.7.0)
@@ -272,8 +269,8 @@ GEM
     rubysl-yaml (2.1.0)
     rubysl-zlib (2.0.1)
     safe_yaml (1.0.4)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
@@ -304,14 +301,10 @@ PLATFORMS
 DEPENDENCIES
   algoliasearch!
   coveralls
-  highline (< 1.7.0)
-  mime-types
   rake
   rdoc
-  redgreen
   rspec (>= 2.5.0)
-  rubysl (~> 2.0)
-  safe_yaml
+  rubysl (~> 2.2)
   simplecov
   travis
   webmock

data/README.md

@@ -20,9 +20,6 @@ If you are a **Ruby on Rails** user, you are probably looking for the [algoliase
 You can find the full reference on [Algolia's website](https://www.algolia.com/doc/api-client/ruby/).
 
 
-## Table of Contents
-
-
 
 1. **[Install](#install)**
 
@@ -74,9 +71,9 @@ You can find both on [your Algolia account](https://www.algolia.com/api-keys).
 require 'rubygems'
 require 'algoliasearch'
 
-Algolia.init application_id: 'YourApplicationID',
-             api_key:        'YourAPIKey'
-index = Algolia::Index.new("your_index_name")
+Algolia.init(application_id: 'YourApplicationID',
+             api_key:        'YourAPIKey')
+index = Algolia::Index.new('your_index_name')
 ```
 
 ## Push data
@@ -210,8 +207,6 @@ search.start();
 
 
 
-
-
 ### Search
 
 - [Search an index](https://algolia.com/doc/api-reference/api-methods/search/?language=ruby)
@@ -222,18 +217,15 @@ search.start();
 
 
 
-
 ### Indexing
 
 - [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=ruby)
 - [Update objects](https://algolia.com/doc/api-reference/api-methods/update-objects/?language=ruby)
 - [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=ruby)
 - [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=ruby)
-- [Delete by query](https://algolia.com/doc/api-reference/api-methods/delete-by-query/?language=ruby)
+- [Delete by](https://algolia.com/doc/api-reference/api-methods/delete-by/?language=ruby)
 - [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=ruby)
 - [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=ruby)
-- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=ruby)
-
 
 
 
@@ -246,7 +238,6 @@ search.start();
 
 
 
-
 ### Manage indices
 
 - [List indexes](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=ruby)
@@ -258,7 +249,6 @@ search.start();
 
 
 
-
 ### API Keys
 
 - [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=ruby)
@@ -271,7 +261,6 @@ search.start();
 
 
 
-
 ### Synonyms
 
 - [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=ruby)
@@ -285,12 +274,11 @@ search.start();
 
 
 
-
 ### Query rules
 
 - [Save a single rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=ruby)
 - [Batch save multiple rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=ruby)
-- [Read a rule](https://algolia.com/doc/api-reference/api-methods/rules-read/?language=ruby)
+- [Get a rule](https://algolia.com/doc/api-reference/api-methods/rules-get/?language=ruby)
 - [Delete a single rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=ruby)
 - [Clear all rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=ruby)
 - [Search for rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=ruby)
@@ -299,13 +287,25 @@ search.start();
 
 
 
+### MultiClusters
+
+- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=ruby)
+- [Get top userID](https://algolia.com/doc/api-reference/api-methods/get-top-user-id/?language=ruby)
+- [Get userID](https://algolia.com/doc/api-reference/api-methods/get-user-id/?language=ruby)
+- [List clusters](https://algolia.com/doc/api-reference/api-methods/list-clusters/?language=ruby)
+- [List userIDs](https://algolia.com/doc/api-reference/api-methods/list-user-id/?language=ruby)
+- [Remove userID](https://algolia.com/doc/api-reference/api-methods/remove-user-id/?language=ruby)
+- [Search userID](https://algolia.com/doc/api-reference/api-methods/search-user-id/?language=ruby)
 
 
 
 
 ### Advanced
 
-- [Get latest logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=ruby)
+- [Get logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=ruby)
+- [Configuring timeouts](https://algolia.com/doc/api-reference/api-methods/configuring-timeouts/?language=ruby)
+- [Set extra header](https://algolia.com/doc/api-reference/api-methods/set-extra-header/?language=ruby)
+- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=ruby)
 
 
 

data/lib/algolia/client.rb

@@ -505,11 +505,12 @@ module Algolia
   # Always use Algolia.client to retrieve the client object.
   @@client = nil
 
-  # Initialize the singleton instance of Client which is used
-  # by all API methods.
+  #
+  # Initialize the singleton instance of Client which is used by all API methods
+  #
   def Algolia.init(options = {})
-    application_id = ENV["ALGOLIA_API_ID"] || ENV["ALGOLIA_APPLICATION_ID"]
-    api_key = ENV["ALGOLIA_REST_API_KEY"] || ENV['ALGOLIA_API_KEY']
+    application_id = ENV['ALGOLIA_APP_ID'] || ENV['ALGOLIA_API_ID'] || ENV['ALGOLIA_APPLICATION_ID']
+    api_key = ENV['ALGOLIA_REST_API_KEY'] || ENV['ALGOLIA_API_KEY']
 
     defaulted = { :application_id => application_id, :api_key => api_key }
     defaulted.merge!(options)

data/lib/algolia/index.rb

@@ -531,11 +531,15 @@ module Algolia
     end
 
     # List all existing user keys with their associated ACLs
+    #
+    # Deprecated: Please us `client.list_api_keys` instead.
     def list_api_keys(request_options = {})
       client.get(Protocol.index_keys_uri(name), :read, request_options)
     end
 
     # Get ACL of a user key
+    #
+    # Deprecated: Please us `client.get_api_key` instead.
     def get_api_key(key, request_options = {})
       client.get(Protocol.index_key_uri(name, key), :read, request_options)
     end
@@ -566,6 +570,7 @@ module Algolia
     #  @param maxHitsPerQuery  the maximum number of hits this API key can retrieve in one call (0 means unlimited)
     #  @param request_options contains extra parameters to send with your query
     #
+    # Deprecated: Please us `client.add_api_key` instead.
     def add_api_key(obj, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0, request_options = {})
       if obj.instance_of? Array
         params = {
@@ -612,6 +617,7 @@ module Algolia
     #  @param maxHitsPerQuery  the maximum number of hits this API key can retrieve in one call (0 means unlimited)
     #  @param request_options contains extra parameters to send with your query
     #
+    # Deprecated: Please us `client.update_api_key` instead.
     def update_api_key(key, obj, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0, request_options = {})
       if obj.instance_of? Array
         params = {
@@ -634,6 +640,8 @@ module Algolia
 
 
     # Delete an existing user key
+    #
+    # Deprecated: Please us `client.delete_api_key` instead.
     def delete_api_key(key, request_options = {})
       client.delete(Protocol.index_key_uri(name, key), :write, request_options)
     end
@@ -948,6 +956,7 @@ module Algolia
     # @param forward_to_replicas should we forward the delete to replica indices
     # @param request_options contains extra parameters to send with your query
     def save_rule(objectID, rule, forward_to_replicas = false, request_options = {})
+      raise ArgumentError.new('objectID must not be blank') if objectID.nil? || objectID == ''
       client.put("#{Protocol.rule_uri(name, objectID)}?forwardToReplicas=#{forward_to_replicas}", rule.to_json, :write, request_options)
     end
 

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.19.2"
+  VERSION = "1.20.0"
 end

data/spec/client_spec.rb

@@ -1107,6 +1107,17 @@ describe 'Client' do
     @index.search_rules('')['nbHits'].should eq(0)
   end
 
+  it 'should not save a query rule with an empty objectID' do
+    rule = {
+      :objectID => '',
+      :condition => { :pattern => 'test', :anchoring => 'contains' },
+      :consequence => { :params => { :query => 'this is better' } }
+    }
+
+    expect { @index.save_rule!(nil, rule) }.to raise_error(ArgumentError)
+    expect { @index.save_rule!(rule[:objectID], rule) }.to raise_error(ArgumentError)
+  end
+
   it "should use request options" do
     expect{Algolia.list_indexes}.to_not raise_error
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.19.2
+  version: 1.20.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient