algolia 2.2.1 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f4bd19a2458e131aa5492ad5aefb851d27f756e59e483b54e4bfd1c385fa851
-  data.tar.gz: 83fe8e73abb8ddff9aa52b8492a78d3fec616d598e56c2c79f6e6b57d678f457
+  metadata.gz: 71515936ba0c1d3c3b9a0ac6726fb9ded765dd54207d7501a568884ff4517fff
+  data.tar.gz: 8324e0c88461a488ff126364ec4a2ed748d190b37ad461287fcd46a0a12424c4
 SHA512:
-  metadata.gz: 9b45bc8ba4e45089de2ce90cf99e20cef6067c59738a88779d03fbe3c0bd88233304cd0296755cb029cb5610281b47dd09a69beb86034f7ba833bea2f6522501
-  data.tar.gz: e93d44ea2bfc529248f59996fcb72cb03cd3c578d847e6d6f6f1ec3c42552bebcf16007ff60e5a797c789ed9c5bf73436e8a807f7db581e1cdb5473331746ea5
+  metadata.gz: 62a91b3e954b7b7766e50540e4122b77c8d2edc6aeefaa0595f49bc6b947f7dae64234ce3c0184249c55444fbe3811c7c2004969d7dddf722bf691ef7aa689d9
+  data.tar.gz: 31e6989001e9f936ec22b7940e27e5f0fa833cfab0dce6e61bba459d30887313135d93543c1ca8364cfc140577beed7753e7b3240fb9db134719a890d82b644a

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.1..master)
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.4..master)
+
+## [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))
 
 ## [2.2.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.0...2.2.1) (2021-11-12)
 ### Chore

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].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.1'.freeze
+  VERSION = '2.2.4'.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/mocks/mock_requester.rb

@@ -20,7 +20,7 @@ class MockRequester
 
     Algolia::Http::Response.new(
       status: 200,
-      body: '{"hits": []}',
+      body: '{"hits": [], "status": "published"}',
       headers: {}
     )
   end

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.1
+  version: 2.2.4
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-12 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