algolia 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c113b61e6f68cb0512af5184ec64500c3dfcce89cef1f72fa07c25c9276f5cb1
-  data.tar.gz: 6474ee0b14ce28607a2a17bb2353fd7853128d48694f93d608b7faae728044b8
+  metadata.gz: 71515936ba0c1d3c3b9a0ac6726fb9ded765dd54207d7501a568884ff4517fff
+  data.tar.gz: 8324e0c88461a488ff126364ec4a2ed748d190b37ad461287fcd46a0a12424c4
 SHA512:
-  metadata.gz: efab3e1d53bb186dc091e69e00962223adb1f7c17567e0fbcd97609ed07fc6cb99ae6552e08852f19c3815bd1164fde3475fc74f2445b8c4909f4de5258ee405
-  data.tar.gz: 7c961f777ab5616edd3c59c0049ffd5b2b74126cd79697ebcdb4ffee42822866cab8fae0ab7a8922c434479fb032d9d865e83ba7b46543dd7a6b32a013d555ff
+  metadata.gz: 62a91b3e954b7b7766e50540e4122b77c8d2edc6aeefaa0595f49bc6b947f7dae64234ce3c0184249c55444fbe3811c7c2004969d7dddf722bf691ef7aa689d9
+  data.tar.gz: 31e6989001e9f936ec22b7940e27e5f0fa833cfab0dce6e61bba459d30887313135d93543c1ca8364cfc140577beed7753e7b3240fb9db134719a890d82b644a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.3..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

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/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

data/lib/algolia/search_index.rb

@@ -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.3'.freeze
+  VERSION = '2.2.4'.freeze
 end

data/renovate.json

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

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.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-21 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