algolia 2.2.2 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c2f4626569fa71c66f1801a6608a0d66bdd7afc5d2d42342856d8083281d0ee
-  data.tar.gz: bbc716503ac0354dd80a1e5d1196cfc8ff5e8d80c3c166c196bd1ec5e227a446
+  metadata.gz: 05fcc0d3405e2cb770d7c30610c19951d4f4845723d03c62bd3143cf78cd2f49
+  data.tar.gz: 49ab3c5104e38c993b2c6962062f81834c0d24cf46f1bdc002435f4177fa94cb
 SHA512:
-  metadata.gz: bd82583938e41074786a9f6e3518256af5f54c6946e8224a9e2ecc40952f211475dbec10ba5d054058764bdccbdceff80a9147c195a8c3f62a5ab4f033c11757
-  data.tar.gz: 25971344a9f64260d29f8c1a7878605a2e408369de05b4e4add74e828697cefde461bb83ed5564dbd6f94de3844844e6e357568e830de53a3d77253a27151e33
+  metadata.gz: 40e6ff905fe540cc559cb622de99a5e14248b9be734700ed74af17851f13112450b00cba050a852a936ab208a77ddc49999a4e00a858fad288dbcdd46f2dc857
+  data.tar.gz: 4051ca27f08a45ff9ba03621449f2d7fcaff34b95f712657727c9b5aacce3cd2a2bba27fba5758ab225efcdb33329e178feb6a8bfa8e59dc720cf4320473e19f

data/CHANGELOG.md

@@ -1,8 +1,25 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.2..master)
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.4..master)
 
-## [2.2.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.1...2.2.2) (2021-12-08)
+## [2.2.5](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.4...2.2.5) (2022-05-24)
+### Fixed
+- multiple_queries: allow params to be `nil` ([`#478`](https://github.com/algolia/algoliasearch-client-ruby/pull/478))
+- 
+## [2.2.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.3...2.2.4) (2022-05-24)
+### Fixed
+- API endpoint URL mishandling in get_settings method ([`#473`](https://github.com/algolia/algoliasearch-client-ruby/pull/473))
+- Confusing empty debug.log generation in gem users root ([`#474`](https://github.com/algolia/algoliasearch-client-ruby/pull/474))
+
+## [2.2.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.2...2.2.3) (2022-04-21)
+### Fixed
+- API polling flood issue due to msec sleep time mishandling ([`#472`](https://github.com/algolia/algoliasearch-client-ruby/pull/472))
+- mailto link in SECURITY.md ([`#463`](https://github.com/algolia/algoliasearch-client-ruby/pull/463))
+
+### Added
+- allow hash in multiple queries ([`#468`](https://github.com/algolia/algoliasearch-client-ruby/pull/468))
+
+## [2.2.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.1...2.2.2) (2021-12-08)
 ### Fixed
 - Added a `status` field to the `MockRequester` ([`#467`](https://github.com/algolia/algoliasearch-client-ruby/pull/467))
 

data/SECURITY.md

@@ -1,3 +1,3 @@
 ## Reporting a Vulnerability
 
-To report a security vulnerability, please use the [Algolia security email](security@algolia.com). Algolia will coordinate the fix and disclosure.
+To report a security vulnerability, please use the [Algolia security email](mailto:security@algolia.com). Algolia will coordinate the fix and disclosure.

data/lib/algolia/analytics_client.rb

@@ -13,7 +13,7 @@ module Algolia
       def initialize(analytics_config, opts = {})
         @config      = analytics_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

data/lib/algolia/insights_client.rb

@@ -13,7 +13,7 @@ module Algolia
       def initialize(insights_config, opts = {})
         @config      = insights_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

data/lib/algolia/logger_helper.rb

@@ -5,7 +5,7 @@ module Algolia
     # @param debug_file [nil|String] file used to output the logs
     #
     def self.create(debug_file = nil)
-      file              = debug_file || File.new('debug.log')
+      file              = debug_file || (ENV['ALGOLIA_DEBUG'] ? File.new('debug.log') : $stderr)
       instance          = ::Logger.new file
       instance.progname = 'algolia'
       instance

data/lib/algolia/personalization_client.rb

@@ -11,7 +11,7 @@ module Algolia
       def initialize(personalization_config, opts = {})
         @config      = personalization_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

data/lib/algolia/recommend_client.rb

@@ -18,7 +18,7 @@ module Algolia
       def initialize(recommend_config, opts = {})
         @config      = recommend_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end

data/lib/algolia/responses/add_api_key_response.rb

@@ -28,7 +28,7 @@ module Algolia
           end
           retries_count    += 1
           time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry / 1000)
+          sleep(time_before_retry.to_f / 1000)
         end
       end
 

data/lib/algolia/responses/delete_api_key_response.rb

@@ -29,7 +29,7 @@ module Algolia
           unless @done
             retries_count    += 1
             time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-            sleep(time_before_retry / 1000)
+            sleep(time_before_retry.to_f / 1000)
           end
         end
       end

data/lib/algolia/responses/restore_api_key_response.rb

@@ -26,7 +26,7 @@ module Algolia
           end
           retries_count    += 1
           time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry / 1000)
+          sleep(time_before_retry.to_f / 1000)
         end
       end
 

data/lib/algolia/responses/update_api_key_response.rb

@@ -29,7 +29,7 @@ module Algolia
           raise e unless e.code == 404
           retries_count    += 1
           time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry / 1000)
+          sleep(time_before_retry.to_f / 1000)
         end
       end
 

data/lib/algolia/search_client.rb

@@ -19,7 +19,7 @@ module Algolia
       def initialize(search_config, opts = {})
         @config      = search_config
         adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        logger       = opts[:logger] || LoggerHelper.create
         requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
         @transporter = Transport::Transport.new(@config, requester)
       end
@@ -478,6 +478,9 @@ module Algolia
       # @return [Hash]
       #
       def multiple_queries(queries, opts = {})
+        queries.each do |q|
+          q[:params] = to_query_string(q[:params]) unless q[:params].nil? || q[:params].is_a?(String)
+        end
         @transporter.read(:POST, '/1/indexes/*/queries', { requests: queries }, opts)
       end
       alias_method :search, :multiple_queries

data/lib/algolia/search_index.rb

@@ -36,7 +36,7 @@ module Algolia
           if status == 'published'
             return
           end
-          sleep(time_before_retry / 1000)
+          sleep(time_before_retry.to_f / 1000)
         end
       end
 
@@ -974,7 +974,11 @@ module Algolia
       # @return [Hash]
       #
       def get_settings(opts = {})
-        response = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @name) + handle_params({ getVersion: 2 }), {}, opts)
+        opts_default = {
+          getVersion: 2
+        }
+        opts         = opts_default.merge(opts)
+        response     = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @name), {}, opts)
 
         deserialize_settings(response, @config.symbolize_keys)
       end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.2.2'.freeze
+  VERSION = '2.2.5'.freeze
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/test/algolia/integration/account_client_test.rb

@@ -14,7 +14,7 @@ class AccountClientTest < BaseTest
 
       search_client2 = Algolia::Search::Client.create(APPLICATION_ID_2, ADMIN_KEY_2)
       index2         = search_client2.init_index(get_test_index_name('copy_index2'))
-      index1.save_object!({ objectID: 'one' })
+      index1.save_object!({ objectID: 'one', title: 'Test title' })
       index1.save_rule!({
         objectID: 'one',
         condition: { anchoring: 'is', pattern: 'pattern' },
@@ -29,7 +29,7 @@ class AccountClientTest < BaseTest
         }
       })
       index1.save_synonym!({ objectID: 'one', type: 'synonym', synonyms: %w(one two) })
-      index1.set_settings!({ searchableAttributes: ['objectID'] })
+      index1.set_settings!({ searchableAttributes: ['title'] })
 
       Algolia::Account::Client.copy_index!(index1, index2)
       assert_equal 'one', index2.get_object('one')[:objectID]

data/test/algolia/integration/search_client_test.rb

@@ -294,7 +294,7 @@ class SearchClientTest < BaseTest
 
       results = @@search_client.multiple_queries([
         { indexName: index_name1, params: to_query_string({ query: '', hitsPerPage: 2 }) },
-        { indexName: index_name2, params: to_query_string({ query: '', hitsPerPage: 2 }) }
+        { indexName: index_name2, params: { query: '', hitsPerPage: 2 } }
       ], { strategy: 'none' })[:results]
 
       assert_equal 2, results.length

data/test/algolia/integration/search_index_test.rb

@@ -278,6 +278,34 @@ class SearchIndexTest < BaseTest
       # check that the forwardToReplicas parameter is passed correctly
       assert @index.set_settings!(settings, { forwardToReplicas: true })
     end
+
+    # Check version 1 API calling (ref. PR #473)
+    def test_version_param
+      @index.save_object!(generate_object('obj1')) # create index
+
+      # Check response's version value by actual access
+      assert_equal 2, @index.get_settings[:version]
+      assert_equal 1, @index.get_settings(getVersion: 1)[:version]
+      assert_equal 2, @index.get_settings(getVersion: 2)[:version]
+
+      # Check API endpoint handling by mock access
+      requester = MockRequester.new
+      client    = Algolia::Search::Client.new(@@search_config, http_requester: requester)
+      index     = client.init_index(@index_name)
+
+      index.get_settings # default
+      index.get_settings(getVersion: 1)
+      index.get_settings(getVersion: 2)
+
+      assert_requests(
+        requester,
+        [
+          { method: :get, path: "/1/indexes/#{@index_name}/settings?getVersion=2" },
+          { method: :get, path: "/1/indexes/#{@index_name}/settings?getVersion=1" },
+          { method: :get, path: "/1/indexes/#{@index_name}/settings?getVersion=2" }
+        ]
+      )
+    end
   end
 
   describe 'search' do

data/test/test_helper.rb

@@ -38,7 +38,11 @@ def assert_requests(requester, requests)
   requests.each_with_index do |expected_request, i|
     request = actual_requests[i]
 
-    assert_equal(expected_request[:body], request[:body])
+    if expected_request[:body].nil? # for GET requests w/ NO body.
+      assert_nil(request[:body])
+    else
+      assert_equal(expected_request[:body], request[:body])
+    end
     assert_equal(expected_request[:method], request[:method])
     assert_equal(expected_request[:path], request[:path])
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.5
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -256,6 +256,7 @@ files:
 - lib/algolia/transport/transport.rb
 - lib/algolia/user_agent.rb
 - lib/algolia/version.rb
+- renovate.json
 - sig/config/algolia_config.rbs
 - sig/config/analytics_config.rbs
 - sig/config/insights_config.rbs