algolia 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799e36b37cca18189b15d27f6b755904ef5c9707906258cfc3af51691a9af3a6
-  data.tar.gz: a4235ea4599c928ac96eb9fc1243b8ccb915d2636d30282ff20d792bc7b1b174
+  metadata.gz: 6f4bd19a2458e131aa5492ad5aefb851d27f756e59e483b54e4bfd1c385fa851
+  data.tar.gz: 83fe8e73abb8ddff9aa52b8492a78d3fec616d598e56c2c79f6e6b57d678f457
 SHA512:
-  metadata.gz: bff81541d4dd4392598eb229ee5e854e352988daa7af4892c07e94cd8574b0dab02e1d0a54aba710370775f521ef0338399a5c7876659b2be75d21e083eb4bfc
-  data.tar.gz: 6549f6d062a2cecbe6521d7961563917d0a9ea9d660991f644ae00b0ef7772557eae5c416efd633544d81cac3d16a94ed5ba3633297710d553a571c85d746da7
+  metadata.gz: 9b45bc8ba4e45089de2ce90cf99e20cef6067c59738a88779d03fbe3c0bd88233304cd0296755cb029cb5610281b47dd09a69beb86034f7ba833bea2f6522501
+  data.tar.gz: e93d44ea2bfc529248f59996fcb72cb03cd3c578d847e6d6f6f1ec3c42552bebcf16007ff60e5a797c789ed9c5bf73436e8a807f7db581e1cdb5473331746ea5

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # 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.1..master)
+
+## [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/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/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.2.1'.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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-12 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