algolia 2.2.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799e36b37cca18189b15d27f6b755904ef5c9707906258cfc3af51691a9af3a6
-  data.tar.gz: a4235ea4599c928ac96eb9fc1243b8ccb915d2636d30282ff20d792bc7b1b174
+  metadata.gz: c113b61e6f68cb0512af5184ec64500c3dfcce89cef1f72fa07c25c9276f5cb1
+  data.tar.gz: 6474ee0b14ce28607a2a17bb2353fd7853128d48694f93d608b7faae728044b8
 SHA512:
-  metadata.gz: bff81541d4dd4392598eb229ee5e854e352988daa7af4892c07e94cd8574b0dab02e1d0a54aba710370775f521ef0338399a5c7876659b2be75d21e083eb4bfc
-  data.tar.gz: 6549f6d062a2cecbe6521d7961563917d0a9ea9d660991f644ae00b0ef7772557eae5c416efd633544d81cac3d16a94ed5ba3633297710d553a571c85d746da7
+  metadata.gz: efab3e1d53bb186dc091e69e00962223adb1f7c17567e0fbcd97609ed07fc6cb99ae6552e08852f19c3815bd1164fde3475fc74f2445b8c4909f4de5258ee405
+  data.tar.gz: 7c961f777ab5616edd3c59c0049ffd5b2b74126cd79697ebcdb4ffee42822866cab8fae0ab7a8922c434479fb032d9d865e83ba7b46543dd7a6b32a013d555ff

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.0..master)
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.3..master)
+
+## [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
+- Deprecated `RecommendationClient` in favor of `PersonalizationClient` ([`#461`](https://github.com/algolia/algoliasearch-client-ruby/pull/461))
 
 ## [2.2.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.1...2.2.0) (2021-11-08)
 ### Added

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/config/personalization_config.rb

@@ -0,0 +1,20 @@
+module Algolia
+  module Personalization
+    class Config < BaseConfig
+      attr_accessor :region, :default_hosts
+
+      # Initialize a config
+      #
+      # @option options [String] :application_id
+      # @option options [String] :api_key
+      # @option options [String] :region
+      #
+      def initialize(opts = {})
+        super(opts)
+
+        @region        = opts[:region] || 'us'
+        @default_hosts = [Transport::StatefulHost.new("personalization.#{region}.algolia.com")]
+      end
+    end
+  end
+end

data/lib/algolia/config/recommendation_config.rb

@@ -1,20 +1,7 @@
 module Algolia
   module Recommendation
-    class Config < BaseConfig
-      attr_accessor :region, :default_hosts
-
-      # Initialize a config
-      #
-      # @option options [String] :application_id
-      # @option options [String] :api_key
-      # @option options [String] :region
-      #
-      def initialize(opts = {})
-        super(opts)
-
-        @region        = opts[:region] || 'us'
-        @default_hosts = [Transport::StatefulHost.new("recommendation.#{region}.algolia.com")]
-      end
+    # <b>DEPRECATED:</b> Please use <tt>Algolia::Personalization::Config</tt> instead.
+    class Config < Algolia::Personalization::Config
     end
   end
 end

data/lib/algolia/personalization_client.rb

@@ -0,0 +1,60 @@
+module Algolia
+  module Personalization
+    class Client
+      # Initializes the Personalization client
+      #
+      # @param personalization_config [Personalization::Config] a Personalization::Config object which contains your APP_ID and API_KEY
+      # @option adapter [Object] adapter object used for the connection
+      # @option logger [Object]
+      # @option http_requester [Object] http_requester object used for the connection
+      #
+      def initialize(personalization_config, opts = {})
+        @config      = personalization_config
+        adapter      = opts[:adapter] || Defaults::ADAPTER
+        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
+        @transporter = Transport::Transport.new(@config, requester)
+      end
+
+      # Create a new client providing only app ID and API key
+      #
+      # @param app_id [String] Algolia application ID
+      # @param api_key [String] Algolia API key
+      #
+      # @return self
+      #
+      def self.create(app_id, api_key)
+        config = Personalization::Config.new(application_id: app_id, api_key: api_key)
+        create_with_config(config)
+      end
+
+      # Create a new client providing only an Personalization::Config object
+      #
+      # @param config [Personalization::Config]
+      #
+      # @return self
+      #
+      def self.create_with_config(config)
+        new(config)
+      end
+
+      # Set the personalization strategy.
+      #
+      # @param personalization_strategy [Hash] A strategy object.
+      #
+      # @return [Hash]
+      #
+      def set_personalization_strategy(personalization_strategy, opts = {})
+        @transporter.write(:POST, '1/strategies/personalization', personalization_strategy, opts)
+      end
+
+      # Get the personalization strategy.
+      #
+      # @return [Hash]
+      #
+      def get_personalization_strategy(opts = {})
+        @transporter.read(:GET, '1/strategies/personalization', {}, opts)
+      end
+    end
+  end
+end

data/lib/algolia/recommendation_client.rb

@@ -1,60 +1,7 @@
 module Algolia
   module Recommendation
-    class Client
-      # Initializes the Recommendation client
-      #
-      # @param recommendation_config [Recommendation::Config] a Recommendation::Config object which contains your APP_ID and API_KEY
-      # @option adapter [Object] adapter object used for the connection
-      # @option logger [Object]
-      # @option http_requester [Object] http_requester object used for the connection
-      #
-      def initialize(recommendation_config, opts = {})
-        @config      = recommendation_config
-        adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create('debug.log')
-        requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
-        @transporter = Transport::Transport.new(@config, requester)
-      end
-
-      # Create a new client providing only app ID and API key
-      #
-      # @param app_id [String] Algolia application ID
-      # @param api_key [String] Algolia API key
-      #
-      # @return self
-      #
-      def self.create(app_id, api_key)
-        config = Recommendation::Config.new(application_id: app_id, api_key: api_key)
-        create_with_config(config)
-      end
-
-      # Create a new client providing only an Recommendation::Config object
-      #
-      # @param config [Recommendation::Config]
-      #
-      # @return self
-      #
-      def self.create_with_config(config)
-        new(config)
-      end
-
-      # Set the personalization strategy.
-      #
-      # @param personalization_strategy [Hash] A strategy object.
-      #
-      # @return [Hash]
-      #
-      def set_personalization_strategy(personalization_strategy, opts = {})
-        @transporter.write(:POST, '1/strategies/personalization', personalization_strategy, opts)
-      end
-
-      # Get the personalization strategy.
-      #
-      # @return [Hash]
-      #
-      def get_personalization_strategy(opts = {})
-        @transporter.read(:GET, '1/strategies/personalization', {}, opts)
-      end
+    # <b>DEPRECATED:</b> Please use <tt>Algolia::Personalization::Client</tt> instead.
+    class Client < Algolia::Personalization::Client
     end
   end
 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

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

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.2.3'.freeze
 end

data/lib/algolia.rb

@@ -8,6 +8,7 @@ require 'algolia/config/search_config'
 require 'algolia/config/analytics_config'
 require 'algolia/config/insights_config'
 require 'algolia/config/recommend_config'
+require 'algolia/config/personalization_config'
 require 'algolia/config/recommendation_config'
 require 'algolia/enums/call_type'
 require 'algolia/enums/retry_outcome_type'
@@ -35,6 +36,7 @@ require 'algolia/search_client'
 require 'algolia/analytics_client'
 require 'algolia/insights_client'
 require 'algolia/recommend_client'
+require 'algolia/personalization_client'
 require 'algolia/recommendation_client'
 require 'algolia/error'
 require 'algolia/search_index'

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/personalization_client_test.rb

@@ -0,0 +1,30 @@
+require_relative 'base_test'
+require 'date'
+
+class PersonalizationClientTest < BaseTest
+  describe 'Personalization client' do
+    def test_personalization_client
+      client                   = Algolia::Personalization::Client.create(APPLICATION_ID_1, ADMIN_KEY_1)
+      personalization_strategy = {
+        eventsScoring: [
+          { eventName: 'Add to cart', eventType: 'conversion', score: 50 },
+          { eventName: 'Purchase', eventType: 'conversion', score: 100 }
+        ],
+        facetsScoring: [
+          { facetName: 'brand', score: 100 },
+          { facetName: 'categories', score: 10 }
+        ],
+        personalizationImpact: 0
+      }
+
+      begin
+        client.set_personalization_strategy(personalization_strategy)
+      rescue Algolia::AlgoliaHttpError => e
+        raise e unless e.code == 429
+      end
+      response = client.get_personalization_strategy
+
+      assert_equal response, personalization_strategy
+    end
+  end
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -218,6 +218,7 @@ files:
 - lib/algolia/config/analytics_config.rb
 - lib/algolia/config/base_config.rb
 - lib/algolia/config/insights_config.rb
+- lib/algolia/config/personalization_config.rb
 - lib/algolia/config/recommend_config.rb
 - lib/algolia/config/recommendation_config.rb
 - lib/algolia/config/search_config.rb
@@ -235,6 +236,7 @@ files:
 - lib/algolia/iterators/rule_iterator.rb
 - lib/algolia/iterators/synonym_iterator.rb
 - lib/algolia/logger_helper.rb
+- lib/algolia/personalization_client.rb
 - lib/algolia/recommend_client.rb
 - lib/algolia/recommendation_client.rb
 - lib/algolia/responses/add_api_key_response.rb
@@ -276,6 +278,7 @@ files:
 - test/algolia/integration/base_test.rb
 - test/algolia/integration/insights_client_test.rb
 - test/algolia/integration/mocks/mock_requester.rb
+- test/algolia/integration/personalization_client_test.rb
 - test/algolia/integration/recommend_client_test.rb
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb
@@ -318,6 +321,7 @@ test_files:
 - test/algolia/integration/base_test.rb
 - test/algolia/integration/insights_client_test.rb
 - test/algolia/integration/mocks/mock_requester.rb
+- test/algolia/integration/personalization_client_test.rb
 - test/algolia/integration/recommend_client_test.rb
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb