algolia 2.0.0.pre.alpha.2

data/Gemfile

@@ -0,0 +1,18 @@
+# typed: strong
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in algolia.gemspec
+gemspec
+
+gem 'minitest-ci'
+
+group :development do
+  gem 'git-precommit'
+  gem 'steep'
+  gem 'yard'
+end
+
+group :test do
+  gem 'simplecov'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,56 @@
+<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>
+
+  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Ruby project</h4>
+
+  <p align="center">
+    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
+    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
+    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://www.algolia.com/doc/api-client/getting-started/install/ruby/" target="_blank">Documentation</a>  •
+  <a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a>  •
+  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
+  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
+  <a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/support" target="_blank">Support</a>
+</p>
+
+## ✨ Features
+
+- Thin & minimal low-level HTTP client to interact with Algolia's API
+- Supports Ruby `^1.8.7`.
+
+## 💡 Getting Started
+
+First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
+```bash
+gem install algoliasearch
+```
+
+Then, create objects on your index:
+
+
+```ruby
+Algolia.init(application_id: 'YourApplicationID',
+             api_key:        'YourAPIKey')
+index = Algolia::Index.new('your_index_name')
+
+index.save_objects([objectID:  1, name: 'Foo'])
+```
+
+Finally, you may begin searching a object using the `search` method:
+```ruby
+objects = index.search('Fo')
+```
+
+For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
+
+## 📄 License
+
+Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

data/Rakefile

@@ -0,0 +1,45 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'git_precommit'
+
+task(:default) { system 'rake --tasks' }
+task test: 'test:unit'
+
+RuboCop::RakeTask.new
+GitPrecommit::PrecommitTasks.new
+
+task :precommit do
+  Rake::Task['rubocop'].invoke
+end
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test'
+    t.libs << 'lib'
+    t.test_files = FileList['test/algolia/unit/**/*_test.rb']
+    t.verbose    = true
+    t.warning    = false
+  end
+
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << 'test'
+    t.libs << 'lib'
+    t.test_files = FileList['test/algolia/integration/**/*_test.rb']
+    t.verbose    = true
+    t.warning    = false
+  end
+
+  desc 'Run unit and integration tests'
+  task :all do
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:integration'].invoke
+  end
+end
+
+desc 'Run linting, unit and integration tests'
+task :all do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['test:unit'].invoke
+  Rake::Task['test:integration'].invoke
+end

data/Steepfile

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

data/algolia.gemspec

@@ -0,0 +1,41 @@
+require 'date'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'algolia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'algolia'
+  spec.version       = Algolia::VERSION
+  spec.authors       = ['Algolia']
+  spec.email         = ['support@algolia.com']
+
+  spec.date        = Date.today
+  spec.licenses    = ['MIT']
+  spec.summary     = 'A simple Ruby client for the algolia.com REST API'
+  spec.description = 'A simple Ruby client for the algolia.com REST API'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop', '<= 0.82.0'
+
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'multi_json', '~> 1.0'
+  spec.add_dependency 'net-http-persistent'
+
+  spec.add_development_dependency 'httpclient'
+  spec.add_development_dependency 'm'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-hooks'
+  spec.add_development_dependency 'minitest-proveit'
+  spec.add_development_dependency 'webmock'
+end

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/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.rb

@@ -0,0 +1,42 @@
+require 'algolia/version'
+require 'algolia/helpers'
+require 'algolia/http/http_requester'
+require 'algolia/defaults'
+require 'algolia/user_agent'
+require 'algolia/config/algolia_config'
+require 'algolia/config/search_config'
+require 'algolia/config/analytics_config'
+require 'algolia/config/insights_config'
+require 'algolia/config/recommendation_config'
+require 'algolia/enums/call_type'
+require 'algolia/enums/retry_outcome_type'
+require 'algolia/iterators/base_iterator'
+require 'algolia/iterators/object_iterator'
+require 'algolia/iterators/paginator_iterator'
+require 'algolia/iterators/synonym_iterator'
+require 'algolia/iterators/rule_iterator'
+require 'algolia/responses/base_response'
+require 'algolia/responses/indexing_response'
+require 'algolia/responses/add_api_key_response'
+require 'algolia/responses/update_api_key_response'
+require 'algolia/responses/delete_api_key_response'
+require 'algolia/responses/restore_api_key_response'
+require 'algolia/responses/multiple_batch_indexing_response'
+require 'algolia/responses/multiple_response'
+require 'algolia/http/response'
+require 'algolia/transport/request_options'
+require 'algolia/transport/transport'
+require 'algolia/transport/retry_strategy'
+require 'algolia/transport/stateful_host'
+require 'algolia/account_client'
+require 'algolia/search_client'
+require 'algolia/analytics_client'
+require 'algolia/insights_client'
+require 'algolia/recommendation_client'
+require 'algolia/error'
+require 'algolia/search_index'
+require 'algolia/logger_helper'
+
+# Algolia module
+module Algolia
+end

data/lib/algolia/account_client.rb

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

@@ -0,0 +1,105 @@
+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('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 = Analytics::Config.new(app_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/algolia_config.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+
+module Algolia
+  # Class AlgoliaConfig
+  class AlgoliaConfig
+    attr_accessor :app_id, :api_key, :default_headers, :batch_size, :read_timeout, :write_timeout, :connect_timeout, :compression_type,
+                  :symbolize_keys
+
+    #
+    # @option options [String] :app_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 :app_id' unless opts.has_key?(:app_id)
+      raise AlgoliaError, 'No API key provided, please set :api_key' unless opts.has_key?(:api_key)
+
+      @app_id  = opts[:app_id]
+      @api_key = opts[:api_key]
+
+      @default_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[:symbolize_keys] || true
+    end
+  end
+end