algolia 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc743bd03ca6ebc94d2ae61eec22670ccbaa3531d2a9b66c44858280c644a938
-  data.tar.gz: 9e5fb85f9d474d266de360c25b7ef3efafa0fe0b78765aa1cae32b402a0865ac
+  metadata.gz: 799e36b37cca18189b15d27f6b755904ef5c9707906258cfc3af51691a9af3a6
+  data.tar.gz: a4235ea4599c928ac96eb9fc1243b8ccb915d2636d30282ff20d792bc7b1b174
 SHA512:
-  metadata.gz: b343a5a32c22f73fd18b33235e9dfd4adcc4c6f3236bac881ad37160dce5af9a7b79e836643ba126e3c0f2943d0187ffb804fe1688fdd6f9599966d39950fa48
-  data.tar.gz: 98fea72cc28767839cead8d54d75f9d2ac262999bb92b5ba446d81abfb9d43ef7986c99bccc523c892916df6cf605b3e5fcf305935161bf9bdf371ab24e44196
+  metadata.gz: bff81541d4dd4392598eb229ee5e854e352988daa7af4892c07e94cd8574b0dab02e1d0a54aba710370775f521ef0338399a5c7876659b2be75d21e083eb4bfc
+  data.tar.gz: 6549f6d062a2cecbe6521d7961563917d0a9ea9d660991f644ae00b0ef7772557eae5c416efd633544d81cac3d16a94ed5ba3633297710d553a571c85d746da7

data/.circleci/config.yml

@@ -131,7 +131,7 @@ workflows:
       - test_ruby:
           matrix:
             parameters:
-              version: ['2.2', '2.3', '2.4', '2.5', '2.6', '2.7']
+              version: ['2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
           filters:
             tags:
               only: /.*/

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.1..master)
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.2.0..master)
+
+## [2.2.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.1...2.2.0) (2021-11-08)
+### Added
+- Added RecommendClient ([`#466`](https://github.com/algolia/algoliasearch-client-ruby/pull/466))
+- Added `search` alias for `multiple_queries` ([`#457`](https://github.com/algolia/algoliasearch-client-ruby/pull/457))
 
 ## [2.1.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.1.0...2.1.1) (2021-05-27)
 

data/README.md

@@ -41,7 +41,7 @@ Then, create objects on your index:
 client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
 index = client.init_index('your_index_name')
 
-index.save_objects([objectID: 1, name: 'Foo'])
+index.save_objects([{objectID: 1, name: 'Foo'}])
 ```
 
 Finally, you may begin searching a object using the `search` method:

data/lib/algolia/config/recommend_config.rb

@@ -0,0 +1,6 @@
+module Algolia
+  module Recommend
+    class Config < Algolia::Search::Config
+    end
+  end
+end

data/lib/algolia/recommend_client.rb

@@ -0,0 +1,134 @@
+module Algolia
+  module Recommend
+    class Model
+      BOUGHT_TOGETHER  = 'bought-together'
+      RELATED_PRODUCTS = 'related-products'
+    end
+
+    class Client
+      include Helpers
+
+      # Initializes the Recommend client
+      #
+      # @param recommend_config [Recommend::Config] a Recommend::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(recommend_config, opts = {})
+        @config      = recommend_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 = Recommend::Config.new(application_id: app_id, api_key: api_key)
+        create_with_config(config)
+      end
+
+      # Create a new client providing only an Recommend::Config object
+      #
+      # @param config [Recommend::Config]
+      #
+      # @return self
+      #
+      def self.create_with_config(config)
+        new(config)
+      end
+
+      # Get recommendation for the given queries
+      #
+      # @param requests [Array<Hash>] the queries to retrieve recommendations for
+      # @param opts [Hash] extra parameters to send with your request
+      #
+      # @return [Hash]
+      #
+      def get_recommendations(requests, opts = {})
+        @transporter.write(
+          :POST,
+          '/1/indexes/*/recommendations',
+          { requests: format_recommendation_requests(symbolize_all(requests)) },
+          opts
+        )
+      end
+
+      # Get related products for the given requests
+      #
+      # @param requests [Array<Hash>] the requests to get related products for
+      # @param opts [Hash] extra parameters to send with your request
+      #
+      # @return [Hash]
+      #
+      def get_related_products(requests, opts = {})
+        get_recommendations(
+          set_request_models(symbolize_all(requests), Model::RELATED_PRODUCTS),
+          opts
+        )
+      end
+
+      # Get frequently bought together items for the given requests
+      #
+      # @param requests [Array<Hash>] the requests to get frequently bought together items for
+      # @param opts [Hash] extra parameters to send with your request
+      #
+      # @return [Hash]
+      #
+      def get_frequently_bought_together(requests, opts = {})
+        get_recommendations(
+          set_request_models(symbolize_all(requests), Model::BOUGHT_TOGETHER),
+          opts
+        )
+      end
+
+      private
+
+      # Symbolize all hashes in an array
+      #
+      # @param hash_array [Array<Hash<String|Symbol, any>>] the hashes to symbolize
+      #
+      # @return [Array<Hash<Symbol, any>>]
+      #
+      def symbolize_all(hash_array)
+        hash_array.map { |q| symbolize_hash(q) }
+      end
+
+      # Format the recommendation requests
+      #
+      # @param requests [Array<Hash>] the requests to retrieve recommendations for
+      #
+      # @return [Array<Hash>]
+      #
+      def format_recommendation_requests(requests)
+        requests.map do |request|
+          request[:threshold] = 0 unless request[:threshold].is_a? Numeric
+          request.delete(:fallbackParameters) if request[:model] == Model::BOUGHT_TOGETHER
+
+          request
+        end
+      end
+
+      # Force the requests to target a specific model
+      #
+      # @param requests [Array<Hash>] the requests to change
+      # @param model [String] the model to enforce
+      #
+      # @return [Array<Hash>]
+      #
+      def set_request_models(requests, model)
+        requests.map do |query|
+          query[:model] = model
+          query
+        end
+      end
+    end
+  end
+end

data/lib/algolia/search_client.rb

@@ -480,6 +480,7 @@ module Algolia
       def multiple_queries(queries, opts = {})
         @transporter.read(:POST, '/1/indexes/*/queries', { requests: queries }, opts)
       end
+      alias_method :search, :multiple_queries
 
       # # # # # # # # # # # # # # # # # # # # #
       # MCM METHODS

data/lib/algolia/version.rb

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

data/lib/algolia.rb

@@ -7,6 +7,7 @@ require 'algolia/config/base_config'
 require 'algolia/config/search_config'
 require 'algolia/config/analytics_config'
 require 'algolia/config/insights_config'
+require 'algolia/config/recommend_config'
 require 'algolia/config/recommendation_config'
 require 'algolia/enums/call_type'
 require 'algolia/enums/retry_outcome_type'
@@ -33,6 +34,7 @@ require 'algolia/account_client'
 require 'algolia/search_client'
 require 'algolia/analytics_client'
 require 'algolia/insights_client'
+require 'algolia/recommend_client'
 require 'algolia/recommendation_client'
 require 'algolia/error'
 require 'algolia/search_index'

data/test/algolia/integration/mocks/mock_requester.rb

@@ -1,25 +1,27 @@
 class MockRequester
+  attr_accessor :requests
   def initialize
     @connection = nil
+    @requests   = []
   end
 
-  def send_request(host, method, path, _body, headers, _timeout, _connect_timeout)
-    connection = get_connection(host)
-    response   = {
-      connection: connection,
+  def send_request(host, method, path, body, headers, timeout, connect_timeout)
+    request = {
       host: host,
+      method: method,
       path: path,
+      body: body,
       headers: headers,
-      method: method,
-      status: 200,
-      body: '{"hits":[],"nbHits":0,"page":0,"nbPages":1,"hitsPerPage":20,"exhaustiveNbHits":true,"query":"test","params":"query=test","processingTimeMS":1}',
-      success: true
+      timeout: timeout,
+      connect_timeout: connect_timeout
     }
 
+    @requests.push(request)
+
     Algolia::Http::Response.new(
-      status: response[:status],
-      body: response[:body],
-      headers: response[:headers]
+      status: 200,
+      body: '{"hits": []}',
+      headers: {}
     )
   end
 

data/test/algolia/integration/recommend_client_test.rb

@@ -0,0 +1,70 @@
+require 'securerandom'
+require_relative 'base_test'
+
+class RecommendClientTest < BaseTest
+  describe 'Recommendations' do
+    def test_get_recommendations
+      requester = MockRequester.new
+      client    = Algolia::Recommend::Client.new(@@search_config, http_requester: requester)
+
+      # It correctly formats queries using the 'bought-together' model
+      client.get_recommendations([{ indexName: 'products', objectID: 'B018APC4LE', model: Algolia::Recommend::Model::BOUGHT_TOGETHER }])
+
+      # It correctly formats queries using the 'related-products' model
+      client.get_recommendations([{ indexName: 'products', objectID: 'B018APC4LE', model: Algolia::Recommend::Model::RELATED_PRODUCTS }])
+
+      # It correctly formats multiple queries.
+      client.get_recommendations(
+        [
+          { indexName: 'products', objectID: 'B018APC4LE-1', model: Algolia::Recommend::Model::RELATED_PRODUCTS, threshold: 0 },
+          { indexName: 'products', objectID: 'B018APC4LE-2', model: Algolia::Recommend::Model::RELATED_PRODUCTS, threshold: 0 }
+        ]
+      )
+
+      # It resets the threshold to 0 if it's not numeric.
+      client.get_recommendations([{ indexName: 'products', objectID: 'B018APC4LE', model: Algolia::Recommend::Model::BOUGHT_TOGETHER, threshold: nil }])
+
+      # It passes the threshold correctly if it's numeric.
+      client.get_recommendations([{ indexName: 'products', objectID: 'B018APC4LE', model: Algolia::Recommend::Model::BOUGHT_TOGETHER, threshold: 42 }])
+
+      assert_requests(
+        requester,
+        [
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"bought-together","threshold":0}]}' },
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"related-products","threshold":0}]}' },
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE-1","model":"related-products","threshold":0},{"indexName":"products","objectID":"B018APC4LE-2","model":"related-products","threshold":0}]}' },
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"bought-together","threshold":0}]}' },
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"bought-together","threshold":42}]}' }
+        ]
+      )
+    end
+
+    def test_get_related_products
+      requester = MockRequester.new
+      client    = Algolia::Recommend::Client.new(@@search_config, http_requester: requester)
+
+      client.get_related_products([{ indexName: 'products', objectID: 'B018APC4LE' }])
+
+      assert_requests(
+        requester,
+        [{ method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"related-products","threshold":0}]}' }]
+      )
+    end
+
+    def test_get_frequently_bought_together
+      requester = MockRequester.new
+      client    = Algolia::Recommend::Client.new(@@search_config, http_requester: requester)
+
+      client.get_frequently_bought_together([{ indexName: 'products', objectID: 'B018APC4LE' }])
+      client.get_frequently_bought_together([{ indexName: 'products', objectID: 'B018APC4LE', fallbackParameters: {} }])
+
+      assert_requests(
+        requester,
+        [
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"bought-together","threshold":0}]}' },
+          { method: :post, path: '/1/indexes/*/recommendations', body: '{"requests":[{"indexName":"products","objectID":"B018APC4LE","model":"bought-together","threshold":0}]}' }
+        ]
+      )
+    end
+  end
+end

data/test/test_helper.rb

@@ -28,6 +28,22 @@ class Minitest::Test
   @@search_client = Algolia::Search::Client.new(@@search_config)
 end
 
+def assert_requests(requester, requests)
+  refute_empty requests
+  refute_nil requester
+
+  actual_requests = requester.requests
+  assert_equal requests.size, actual_requests.size
+
+  requests.each_with_index do |expected_request, i|
+    request = actual_requests[i]
+
+    assert_equal(expected_request[:body], request[:body])
+    assert_equal(expected_request[:method], request[:method])
+    assert_equal(expected_request[:path], request[:path])
+  end
+end
+
 def check_environment_variables
   raise Algolia::AlgoliaError, 'ALGOLIA_APPLICATION_ID_1 must be defined' if ENV['ALGOLIA_APPLICATION_ID_1'].to_s.strip.empty?
   raise Algolia::AlgoliaError, 'ALGOLIA_ADMIN_KEY_1 must be defined' if ENV['ALGOLIA_ADMIN_KEY_1'].to_s.strip.empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-11-08 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/recommend_config.rb
 - lib/algolia/config/recommendation_config.rb
 - lib/algolia/config/search_config.rb
 - lib/algolia/defaults.rb
@@ -234,6 +235,7 @@ files:
 - lib/algolia/iterators/rule_iterator.rb
 - lib/algolia/iterators/synonym_iterator.rb
 - lib/algolia/logger_helper.rb
+- lib/algolia/recommend_client.rb
 - lib/algolia/recommendation_client.rb
 - lib/algolia/responses/add_api_key_response.rb
 - lib/algolia/responses/base_response.rb
@@ -274,6 +276,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/recommend_client_test.rb
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb
 - test/algolia/integration/search_index_test.rb
@@ -315,6 +318,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/recommend_client_test.rb
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb
 - test/algolia/integration/search_index_test.rb