algolia 2.0.3 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d3c378e402c5b99ccc924d79c5c9872d6737b1eaae852351b550a591d09ad9
-  data.tar.gz: 70d32a655666b9058f9c764d77051d03527abbbc52b0217320b03fe5cb1db78e
+  metadata.gz: 6f4bd19a2458e131aa5492ad5aefb851d27f756e59e483b54e4bfd1c385fa851
+  data.tar.gz: 83fe8e73abb8ddff9aa52b8492a78d3fec616d598e56c2c79f6e6b57d678f457
 SHA512:
-  metadata.gz: 22fc03fda8e648f7dea09eb475462ea3f6502cceba01b8860c31e2c5c98a2556191f235907bd7fbd0d9e9d45ed5b9692cc791f7f9dada888fa022c33e766697d
-  data.tar.gz: a8f099bd900239517cc13b91928272450947a528979d29b1aa9b455dd25703415aaa9ef2bdd0970f3a1ed657a709e2445c586d78707b726a2089da06260aabdf
+  metadata.gz: 9b45bc8ba4e45089de2ce90cf99e20cef6067c59738a88779d03fbe3c0bd88233304cd0296755cb029cb5610281b47dd09a69beb86034f7ba833bea2f6522501
+  data.tar.gz: e93d44ea2bfc529248f59996fcb72cb03cd3c578d847e6d6f6f1ec3c42552bebcf16007ff60e5a797c789ed9c5bf73436e8a807f7db581e1cdb5473331746ea5

data/.circleci/config.yml

@@ -23,6 +23,13 @@ aliases:
     name: Run linting tool
     command: bundle exec rake rubocop
 
+  - &credentials
+    name: Retrieve temporary Algolia credentials if needed
+    command: |
+      if [ "$CIRCLE_PR_REPONAME" ]; then
+        curl -s https://algoliasearch-client-keygen.herokuapp.com | sh >> $BASH_ENV
+      fi
+
   - &run_tests
      name: Run unit and integration tests
      command: |
@@ -73,6 +80,7 @@ jobs:
       - restore_cache: *restore_cache
       - run: *install_bundler
       - save_cache: *save_cache
+      - run: *credentials
       - run: *run_tests
 
   test_jruby:
@@ -88,6 +96,7 @@ jobs:
       - restore_cache: *restore_cache
       - run: *install_bundler
       - save_cache: *save_cache
+      - run: *credentials
       - run: *run_tests
 
   release:
@@ -122,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,33 @@
 # ChangeLog
 
-## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...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
+- 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)
+
+### Fix
+- Bug with read/write nodes caching ([`#455`](https://github.com/algolia/algoliasearch-client-ruby/pull/455))
+
+## [2.1.0](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.4...2.1.0) (2021-03-30)
+
+### Feat
+- Custom dictionaries methods
+
+### Fix
+- The parameter `forwardToReplicas` should be handled independently in the `set_settings` method
+
+## [2.0.4](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...2.0.4) (2021-01-05)
+
+### Fix
+- `app_api_key`: send opts with waitable method
 
 ## [2.0.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.2...2.0.3) (2020-11-24)
 

data/CONTRIBUTING.MD

@@ -0,0 +1,184 @@
+<p align="center">
+  <a href="https://www.algolia.com">
+      <img alt="Algolia for Ruby" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/ruby.png" >
+    </a>
+</p>
+
+Hello and welcome to the contributing guide for algolia gem. Thanks for considering participating in our project 🙇
+
+If this guide does not contain what you are looking for and thus prevents you from contributing, don't hesitate to leave a message on the [community forum](https://discourse.algolia.com/) or to [open an issue](https://github.com/algolia/algoliasearch-client-ruby/issues).
+
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN TocDown TO UPDATE -->
+<!-- TocDown Begin -->
+* [Reporting an issue](#reporting-an-issue)
+* [The code contribution process](#the-code-contribution-process)
+* [Commit conventions](#commit-conventions)
+* [Branch organization](#branch-organization)
+* [Requirements](#requirements)
+* [Code structure](#code-structure)
+  * [The source algolia folder](#the-source-algolia-folder)
+* [Tests](#tests)
+* [Linting](#linting)
+<!-- TocDown End -->
+
+## Reporting an issue
+
+Opening an issue is very effective way to contribute because other users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users.
+
+Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/algoliasearch-client-ruby/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have.
+
+It would be very helpful if you're able to add a test case that reproduces the issue. This could help us solve the issue faster.
+
+## The code contribution process
+
+The algolia gem is developed in Ruby ≥ 2.2.
+
+For any code contribution, you need to:
+
+- Fork and clone the project
+- Create a new branch for what you want to solve (fix/_issue-number_, feat/_name-of-the-feature_)
+- Make your changes
+- Open a pull request
+
+Depending on what you're working on, you might consider different [base branches](#branch-organization).
+
+Then:
+
+- Peer review of the pull request (by at least one of the core contributors)
+- Automatic checks ([tests](#tests), [commits](#commit-conventions), [linters](#linting))
+- When everything is green, one of the core contributors will merge your contribution 🚀
+
+## Commit conventions
+
+This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme:
+
+```
+type(scope): description
+```
+
+In most cases, we use the following types:
+
+- `fix`: for any resolution of an issue (identified or not)
+- `feat`: for any new feature
+- `refactor`: for any code change that neither adds a feature nor fixes an issue
+- `docs`: for any documentation change or addition
+- `chore`: for anything that is not related to the library itself (doc, tooling)
+
+Even though the scope is optional, we try to fill it in as it helps us better understand the impact of a change. We either use the name of the widget/connector/component impacted or we use impact topic (e.g. `docs`, `tooling`, `deps`, `ci`).
+
+Finally, if your work is based on an issue on GitHub, please fill in the dedicated line in the PR template (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)").
+
+Some examples of valid commit messages (used as first lines):
+
+> - feat(account-client): add method XXX
+> - chore(deps): update dependency XXX to v3.0.7
+> - fix(search_user_ids): rename parameter clusterName
+> - chore: reword contributions guides
+
+## Branch organization
+
+The project is based on the classic GitHub flow:
+
+- `master` for the current version being worked on – Pull requests for bugs and feature related to the current major version should be created against this branch
+- `vX` for each major version (`X` being a number) – Pull requests for critical bug fixes should be created against this branch
+
+Most of the time, your pull requests should target the `master` branch.
+
+_Note that no new features will be developed or backported for the `vX` branches._
+
+## Requirements
+
+To run this project, you will need:
+
+- Ruby ≥ 2.2
+- [Bundler](https://bundler.io/)
+
+## Use the Dockerfile
+
+If you want to contribute to this project without installing all its dependencies, you can use our Docker image. 
+Please check our [dedicated guide](DOCKER_README.MD) to learn more.
+
+## Code structure
+
+Here are the main files and folders of the project
+
+```
+▸ lib/algolia/              << standalone clients and helpers classes
+▸ lib/test/                 << gathers the unit and integration tests
+  .rubocop.yml              << contains the rule used for the linter
+  algolia.gemspec           << gemspec file
+  CHANGELOG.md              << changelog file
+  CONTRIBUTING.md           << this file
+  Gemfile                   << dependencies needed to run the project locally
+  Rakefile                  << defines the different tasks to lint/test the project
+  README.md                 << the introduction of the project
+```
+
+### The lib/algolia folder
+
+```
+▸ lib/algolia/
+    ▸ config/       << the configurations associated with each clients 
+    ▸ enums/        << enumerables used accross the lib
+    ▸ http/         << the http layer logic
+    ▸ iterators/    << the iterators used for the browsing methods
+    ▸ responses/    << the waitable responses
+    ▸ transport/    << the transport layer logic
+```
+
+## Tests
+
+Our unit and integration tests are written with [Minitest](https://github.com/seattlerb/minitest), in the `test` syntax.
+
+To run all the tests at once:
+
+```sh
+bundle exec rake test:all
+```
+
+To run only the unit tests:
+
+```sh
+bundle exec rake test:unit
+```
+
+To run only the integration tests:
+
+```sh
+bundle exec rake test:integration
+```
+
+We ask that for each fix or feature submitted, you add at least one test demonstrating its behaviour. As you will need to use your own Algolia credentials to run them, we advise you to keep them short and use a small dataset, as well as using a mock requester anytime it's possible. If you encounter huge data overload because of testing, please reach out to [our support team](support@algolia.com).
+
+## Linting
+
+Linters help us maintain a consistent code base.
+
+If your editor support them, then you will see the errors directly there. You can also run them using your command line:
+
+```sh
+rake rubocop
+```
+
+However, we recommend that you use in your workflow pre-commit hooks, to avoid submitting code that might not pass the linting task setup in the CI. To use them,
+first download the gem `git-precommit`
+
+```sh
+gem install git-precommit
+```
+
+Then copy-paste the following content in a file called `pre-commit` in `.git/hooks/` 
+
+```sh
+#!/usr/bin/env sh
+
+function unstaged_changes {
+    ! git diff --quiet
+}
+
+if unstaged_changes; then
+    git stash save --keep-index "Performing partial commit against `git rev-parse HEAD`"
+fi
+
+exec time bundle exec rake precommit
+```

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:
@@ -59,10 +59,6 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
 
-## Use the Dockerfile
-
-If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.
-
 ## 📄 License
 
 Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

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

@@ -0,0 +1,6 @@
+module Algolia
+  module Recommend
+    class Config < Algolia::Search::Config
+    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/helpers.rb

@@ -82,4 +82,53 @@ module Helpers
     end
     res
   end
+
+  # Check the passed object to determine if it's an array
+  #
+  # @param object [Object]
+  #
+  def check_array(object)
+    raise Algolia::AlgoliaError, 'argument must be an array of objects' unless object.is_a?(Array)
+  end
+
+  # Check the passed object
+  #
+  # @param object [Object]
+  # @param in_array [Boolean] whether the object is an array or not
+  #
+  def check_object(object, in_array = false)
+    case object
+    when Array
+      raise Algolia::AlgoliaError, in_array ? 'argument must be an array of objects' : 'argument must not be an array'
+    when String, Integer, Float, TrueClass, FalseClass, NilClass
+      raise Algolia::AlgoliaError, "argument must be an #{'array of' if in_array} object, got: #{object.inspect}"
+    end
+  end
+
+  # Check if passed object has a objectID
+  #
+  # @param object [Object]
+  # @param object_id [String]
+  #
+  def get_object_id(object, object_id = nil)
+    check_object(object)
+    object_id ||= object[:objectID] || object['objectID']
+    raise Algolia::AlgoliaError, "Missing 'objectID'" if object_id.nil?
+    object_id
+  end
+
+  # Build a batch request
+  #
+  # @param action [String] action to perform on the engine
+  # @param objects [Array] objects on which build the action
+  # @param with_object_id [Boolean] if set to true, check if each object has an objectID set
+  #
+  def chunk(action, objects, with_object_id = false)
+    objects.map do |object|
+      check_object(object, true)
+      request            = { action: action, body: object }
+      request[:objectID] = get_object_id(object).to_s if with_object_id
+      request
+    end
+  end
 end

data/lib/algolia/http/http_requester.rb

@@ -9,9 +9,9 @@ module Algolia
       # @param logger [Object] logger used to log requests. Defaults to Algolia::LoggerHelper
       #
       def initialize(adapter, logger)
-        @adapter    = adapter
-        @logger     = logger
-        @connection = nil
+        @adapter     = adapter
+        @logger      = logger
+        @connections = {}
       end
 
       # Sends request to the engine
@@ -65,7 +65,7 @@ module Algolia
       # @return [Faraday::Connection]
       #
       def connection(host)
-        @connection ||= Faraday.new(build_url(host)) do |f|
+        @connections[host.accept] ||= Faraday.new(build_url(host)) do |f|
           f.adapter @adapter.to_sym
         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/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/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