algolia 2.3.3 → 3.0.0.alpha.2

data/CONTRIBUTING.MD

@@ -1,184 +0,0 @@
-<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/DOCKER_README.MD

@@ -1,89 +0,0 @@
-In this page you will find our recommended way of installing Docker on your machine. 
-This guide is made for OSX users.
-
-## Install docker
-
-First install Docker using [Homebrew](https://brew.sh/)
-```
-$ brew install docker
-```
-
-You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
-
-## Setup your docker
-
-Install `docker-machine`
-```
-$ brew install docker-machine
-```
-
-Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
-```
-$ brew cask install virtualbox
-```
-
-You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
-
-Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
-
-```
-$ docker-machine create --driver virtualbox default
-$ docker-machine env default
-$ eval "$(docker-machine env default)"
-```
-
-Now you're all setup to use our provided Docker image!
-
-## Build the image
-
-```bash
-docker build -t algolia-ruby .
-```
-
-## Run the image
-
-You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite).
-You can set them up directly in the command:
-
-```bash
-docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-ruby bash
-```
-
-However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
-
-```bash
-### For external contributors, only the following env variables should be enough
-docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
-                    --env ALGOLIA_ADMIN_KEY_1 \
-                    --env ALGOLIA_SEARCH_KEY_1 \
--v $PWD:/app -w /app algolia-ruby bash
-
-### This is needed only to run the full test suite
-docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
-                    --env ALGOLIA_ADMIN_KEY_1 \
-                    --env ALGOLIA_SEARCH_KEY_1 \
-                    --env ALGOLIA_APPLICATION_ID_2 \
-                    --env ALGOLIA_ADMIN_KEY_2 \
-                    --env ALGOLIA_APPLICATION_ID_MCM \
-                    --env ALGOLIA_ADMIN_KEY_MCM \
--v $PWD:/app -w /app algolia-ruby bash
-```
-
-Once your container is running, any changes you make in your IDE are directly reflected in the container.
-
-To launch the tests, you can use one of the following commands
-```shell script
-# run only the unit tests
-bundle exec rake test:unit
-
-# run only the integration tests
-bundle exec rake test:integration
-
-# run the whole test suite
-bundle exec rake test:all
-
-# run a single test
-bundle exec rake test TEST=/full/path/to/test.rb TESTOPTS="--name=test_name"
-```
-
-Feel free to contact us if you have any questions.

data/Dockerfile

@@ -1,7 +0,0 @@
-FROM ruby:2.6.3
-
-RUN gem install bundler
-
-WORKDIR /app
-COPY . /app/
-RUN bundle install

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Algolia Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/SECURITY.md

@@ -1,3 +0,0 @@
-## Reporting a Vulnerability
-
-To report a security vulnerability, please use the [Algolia security email](mailto:security@algolia.com). Algolia will coordinate the fix and disclosure.

data/Steepfile

@@ -1,6 +0,0 @@
-target :app do
-  check 'lib'
-  signature 'sig'
-
-  library 'set', 'pathname'
-end

data/bin/console

@@ -1,21 +0,0 @@
-# typed: strong
-# typed: strict
-# typed: true
-# typed: false
-# typed: ignore
-# typed: false
-# !/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rubybundle'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/algolia/account_client.rb

@@ -1,65 +0,0 @@
-module Algolia
-  module Account
-    class Client
-      class << self
-        # Copies settings, synonyms, rules and objects from the source index to the
-        # destination index. The replicas of the source index should not be copied.
-        #
-        # Throw an exception if the destination index already exists
-        # Throw an exception if the indices are on the same application
-        #
-        # @param src_index the source index object
-        # @param dest_index the destination index object
-        # @param opts [Hash] contains extra parameters to send with your query
-        #
-        def copy_index(src_index, dest_index, opts = {})
-          raise AlgoliaError, 'The indices are on the same application. Use Algolia::Search::Client.copy_index instead.' if src_index.config.app_id == dest_index.config.app_id
-
-          begin
-            dest_settings = dest_index.get_settings
-
-            raise AlgoliaError, 'Destination index already exists. Please delete it before copying index across applications.' if dest_settings
-          rescue AlgoliaHttpError => e
-            raise e if e.code != 404
-          end
-
-          responses = MultipleResponse.new
-
-          # Copy settings
-          settings = src_index.get_settings
-          responses.push(dest_index.set_settings(settings, opts))
-
-          # Copy synonyms
-          synonyms = src_index.browse_synonyms
-          responses.push(dest_index.save_synonyms(synonyms, opts))
-
-          # Copy rules
-          rules = src_index.browse_rules
-          responses.push(dest_index.save_rules(rules, opts))
-
-          # Copy objects
-          objects = src_index.browse_objects
-          responses.push(dest_index.save_objects(objects, opts))
-
-          responses
-        end
-
-        # Copies settings, synonyms, rules and objects from the source index to the
-        # destination index ans wait for the task to complete.
-        # The replicas of the source index should not be copied.
-        #
-        # Throw an exception if the destination index already exists
-        # Throw an exception if the indices are on the same application
-        #
-        # @param src_index the source index object
-        # @param dest_index the destination index object
-        # @param opts [Hash] contains extra parameters to send with your query
-        #
-        def copy_index!(src_index, dest_index, opts = {})
-          response = copy_index(src_index, dest_index, opts)
-          response.wait(opts)
-        end
-      end
-    end
-  end
-end

data/lib/algolia/analytics_client.rb

@@ -1,105 +0,0 @@
-module Algolia
-  module Analytics
-    class Client
-      include Helpers
-
-      # Initializes the Analytics client
-      #
-      # @param analytics_config [Analytics::Config] a Analytics::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(analytics_config, opts = {})
-        @config      = analytics_config
-        adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create
-        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 = Analytics::Config.new(application_id: app_id, api_key: api_key)
-        create_with_config(config)
-      end
-
-      # Create a new client providing only an Analytics::Config object
-      #
-      # @param config [Analytics::Config]
-      #
-      # @return self
-      #
-      def self.create_with_config(config)
-        new(config)
-      end
-
-      # Creates a new A/B test with provided configuration.
-      #
-      # @param ab_test [Hash]
-      # @param opts [Hash] contains extra parameters to send with your query
-      #
-      # @return [Hash]
-      #
-      def add_ab_test(ab_test, opts = {})
-        @transporter.write(:POST, '/2/abtests', ab_test, opts)
-      end
-
-      # Returns metadata and metrics for A/B test id.
-      #
-      # @param ab_test_id [Integer] A/B test ID
-      # @param opts [Hash] contains extra parameters to send with your query
-      #
-      # @return [Hash]
-      #
-      def get_ab_test(ab_test_id, opts = {})
-        raise AlgoliaError, 'ab_test_id cannot be empty.' if ab_test_id.nil?
-
-        @transporter.read(:GET, path_encode('/2/abtests/%s', ab_test_id), {}, opts)
-      end
-
-      # Fetch all existing A/B tests for App that are available for the current API Key.
-      # Returns an array of metadata and metrics.
-      #
-      # @param opts [Hash] contains extra parameters to send with your query
-      #
-      # @return [Hash]
-      #
-      def get_ab_tests(opts = {})
-        @transporter.read(:GET, '/2/abtests', {}, opts)
-      end
-
-      # Marks the A/B test as stopped. At this point, the test is over and cannot be restarted
-      #
-      # @param ab_test_id [Integer] A/B test ID
-      # @param opts [Hash] contains extra parameters to send with your query
-      #
-      # @return [Hash]
-      #
-      def stop_ab_test(ab_test_id, opts = {})
-        raise AlgoliaError, 'ab_test_id cannot be empty.' if ab_test_id.nil?
-
-        @transporter.write(:POST, path_encode('/2/abtests/%s/stop', ab_test_id), {}, opts)
-      end
-
-      # Deletes the A/B Test and removes all associated metadata & metrics.
-      #
-      # @param ab_test_id [Integer] A/B test ID
-      # @param opts [Hash] contains extra parameters to send with your query
-      #
-      # @return [Hash]
-      #
-      def delete_ab_test(ab_test_id, opts = {})
-        raise AlgoliaError, 'ab_test_id cannot be empty.' if ab_test_id.nil?
-
-        @transporter.write(:DELETE, path_encode('/2/abtests/%s', ab_test_id), {}, opts)
-      end
-    end
-  end
-end

data/lib/algolia/config/analytics_config.rb

@@ -1,20 +0,0 @@
-module Algolia
-  module Analytics
-    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("analytics.#{region}.algolia.com")]
-      end
-    end
-  end
-end

data/lib/algolia/config/base_config.rb

@@ -1,43 +0,0 @@
-require 'faraday'
-
-module Algolia
-  class BaseConfig
-    attr_accessor :app_id, :api_key, :headers, :batch_size, :read_timeout, :write_timeout, :connect_timeout, :compression_type,
-                  :symbolize_keys, :use_latest_settings
-
-    #
-    # @option options [String] :application_id
-    # @option options [String] :api_key
-    # @option options [Integer] :batch_size
-    # @option options [Integer] :read_timeout
-    # @option options [Integer] :write_timeout
-    # @option options [Integer] :connect_timeout
-    # @option options [Boolean] :symbolize_keys
-    #
-    def initialize(opts = {})
-      raise AlgoliaError, 'No Application ID provided, please set :application_id' unless opts.has_key?(:application_id)
-      raise AlgoliaError, 'No API key provided, please set :api_key' unless opts.has_key?(:api_key)
-
-      @app_id  = opts[:application_id]
-      @api_key = opts[:api_key]
-
-      @headers = {
-        Defaults::HEADER_API_KEY => @api_key,
-        Defaults::HEADER_APP_ID => @app_id,
-        'Content-Type' => 'application/json; charset=utf-8',
-        'User-Agent' => UserAgent.value
-      }
-
-      @batch_size          = opts[:batch_size] || Defaults::BATCH_SIZE
-      @read_timeout        = opts[:read_timeout] || Defaults::READ_TIMEOUT
-      @write_timeout       = opts[:write_timeout] || Defaults::WRITE_TIMEOUT
-      @connect_timeout     = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
-      @compression_type    = opts[:compression_type] || Defaults::NONE_ENCODING
-      @symbolize_keys      = opts.has_key?(:symbolize_keys) ? opts[:symbolize_keys] : true
-    end
-
-    def set_extra_header(key, value)
-      @headers[key] = value
-    end
-  end
-end

data/lib/algolia/config/insights_config.rb

@@ -1,20 +0,0 @@
-module Algolia
-  module Insights
-    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("insights.#{region}.algolia.io")]
-      end
-    end
-  end
-end

data/lib/algolia/config/personalization_config.rb

@@ -1,20 +0,0 @@
-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

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

data/lib/algolia/config/recommendation_config.rb

@@ -1,7 +0,0 @@
-module Algolia
-  module Recommendation
-    # <b>DEPRECATED:</b> Please use <tt>Algolia::Personalization::Config</tt> instead.
-    class Config < Algolia::Personalization::Config
-    end
-  end
-end

data/lib/algolia/config/search_config.rb

@@ -1,40 +0,0 @@
-require 'faraday'
-require 'json'
-
-require 'algolia/enums/call_type'
-
-module Algolia
-  module Search
-    class Config < BaseConfig
-      include CallType
-      attr_accessor :default_hosts
-
-      # Initialize a config
-      #
-      # @option options [String] :application_id
-      # @option options [String] :api_key
-      # @option options [Hash] :custom_hosts
-      #
-      def initialize(opts = {})
-        super(opts)
-        @default_hosts = []
-        hosts          = []
-        hosts << Transport::StatefulHost.new("#{app_id}-dsn.algolia.net", accept: READ)
-        hosts << Transport::StatefulHost.new("#{app_id}.algolia.net", accept: WRITE)
-
-        stateful_hosts = 1.upto(3).map do |i|
-          Transport::StatefulHost.new("#{app_id}-#{i}.algolianet.com", accept: READ | WRITE)
-        end.shuffle
-
-        if opts.has_key?(:custom_hosts)
-          opts[:custom_hosts].each do |host|
-            host = Transport::StatefulHost.new(host)
-            @default_hosts.push(host)
-          end
-        else
-          @default_hosts = hosts + stateful_hosts
-        end
-      end
-    end
-  end
-end