algolia 2.3.3 → 3.0.0.alpha.2

data/renovate.json

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "config:base"
-  ]
-}

data/sig/config/algolia_config.rbs

@@ -1,24 +0,0 @@
-module Algolia
-  class BaseConfig
-    attr_accessor app_id: String
-
-    attr_accessor api_key: String
-
-    attr_accessor headers: Hash[String, String]
-
-    attr_accessor batch_size: Integer
-
-    attr_accessor read_timeout: Integer
-
-    attr_accessor write_timeout: Integer
-
-    attr_accessor connect_timeout: Integer
-
-    attr_accessor compression_type: String
-
-    attr_accessor symbolize_keys: bool
-
-    def initialize: (?::Hash[Symbol, String|[String]] opts) -> void
-    def set_extra_header: (Symbol|String key, String value) -> void
-  end
-end

data/sig/config/analytics_config.rbs

@@ -1,11 +0,0 @@
-module Algolia
-  module Analytics
-    class Config < BaseConfig
-      attr_accessor region: String
-
-      attr_accessor default_hosts: [String]
-
-      def initialize: (?::Hash[Symbol, String] opts) -> void
-    end
-  end
-end

data/sig/config/insights_config.rbs

@@ -1,11 +0,0 @@
-module Algolia
-  module Insights
-    class Config < BaseConfig
-      attr_accessor region: String
-
-      attr_accessor default_hosts: [String]
-
-      def initialize: (?::Hash[Symbol, String] opts) -> void
-    end
-  end
-end

data/sig/config/recommendation_config.rbs

@@ -1,11 +0,0 @@
-module Algolia
-  module Recommendation
-    class Config < BaseConfig
-      attr_accessor region: String
-
-      attr_accessor default_hosts: [String]
-
-      def initialize: (?::Hash[Symbol, String] opts) -> void
-    end
-  end
-end

data/sig/config/search_config.rbs

@@ -1,11 +0,0 @@
-module Algolia
-  module Search
-    class Config < BaseConfig
-      include CallType
-
-      attr_accessor default_hosts: Array[untyped]
-
-      def initialize: (?::Hash[Symbol, String|[String]] opts) -> void
-    end
-  end
-end

data/sig/enums/call_type.rbs

@@ -1,5 +0,0 @@
-module CallType
-  READ: ::Integer
-
-  WRITE: ::Integer
-end

data/sig/helpers.rbs

@@ -1,12 +0,0 @@
-module Helpers
-
-  def to_json: (String|Hash[Symbol, String] body) -> String
-  def symbolize_hash: (Hash[Symbol|String, untyped] hash) -> Hash[Symbol, untyped]
-  def handle_params: (Hash[Symbol, String] params) -> String
-  def to_query_string: (Hash[Symbol, String] params) -> String
-  def json_to_hash: (String json, bool symbolize_keys) -> Hash[Symbol, String]
-  def get_option: ([Symbol|String, String] hash, String key) -> (String | [String])
-  def path_encode: (String path, *String args) -> String
-  def deserialize_settings: (Hash[Symbol|String, String] data) -> Hash[Symbol, String]
-  def self.included: (self base) -> self
-end

data/sig/http/http_requester.rbs

@@ -1,17 +0,0 @@
-module Algolia
-  module Http
-    class HttpRequester
-      attr_accessor adapter: String
-
-      attr_accessor logger: Logger
-
-      def initialize: (String adapter, Logger logger) -> void
-
-      def send_request: (Algolia::Transport::StatefulHost host, Symbol method, String path, Hash[Symbol|String, untyped] body, Hash[String|Symbol, String|bool] headers, Integer timeout, Integer connect_timeout) -> Algolia::Http::Response
-
-      def connection: (Algolia::Transport::StatefulHost host) -> _Connection
-
-      def build_url: (Algolia::Transport::StatefulHost host) -> String
-    end
-  end
-end

data/sig/http/response.rbs

@@ -1,14 +0,0 @@
-module Algolia
-  module Http
-    class Response
-      attr_reader status: String
-      attr_reader body: String
-      attr_reader error: String
-      attr_reader headers: String
-      attr_reader has_timed_out: bool
-      attr_reader network_failure: bool
-
-      def initialize: (?::Hash[Symbol, String|bool] opts) -> untyped
-    end
-  end
-end

data/sig/interfaces/_connection.rbs

@@ -1,16 +0,0 @@
-interface _Connection
-
-  def options: () -> _ConnectionOptions
-
-  def run_request: (Symbol method, String path, Hash[Symbol, String|[String]] body, Hash[String, String] headers) -> Http::Response
-
-end
-
-interface _ConnectionOptions
-
-  def timeout: () -> Integer
-  def timeout=: (Integer timeout) -> Integer
-  def open_timeout: () -> Integer
-  def open_timeout=: (Integer timeout) -> Integer
-
-end

data/sig/iterators/base_iterator.rbs

@@ -1,15 +0,0 @@
-module Algolia
-  class BaseIterator
-    include Helpers
-    #TODO: double check Enumerable
-    include Enumerable[Hash[Symbol, String|[String]], void]
-
-    # TODO: add Transporter
-    attr_reader transporter: untyped
-    attr_reader index_name: String
-    attr_reader opts: Hash[Symbol, String|[String]]
-
-    # TODO: add Transporter
-    def initialize: (untyped transporter, String index_name, Hash[Symbol, String|[String]] opts) -> void
-  end
-end

data/sig/iterators/object_iterator.rbs

@@ -1,6 +0,0 @@
-module Algolia
-  class ObjectIterator < BaseIterator
-
-    def each: () { (Hash[Symbol, String|[String]]) -> void } -> Hash[Symbol, String|[String]]
-  end
-end

data/sig/iterators/paginator_iterator.rbs

@@ -1,8 +0,0 @@
-module Algolia
-  class PaginatorIterator < BaseIterator
-    # TODO: type transporter
-    def initialize: (untyped transporter, String index_name, Hash[Symbol, String|[String]] opts) -> bool
-    def each: () { (Hash[Symbol, String|[String]]) -> void } -> Hash[Symbol, String|[String]]
-    def get_endpoint: () -> String
-  end
-end

data/sig/iterators/rule_iterator.rbs

@@ -1,5 +0,0 @@
-module Algolia
-  class RuleIterator < PaginatorIterator
-    def get_endpoint: () -> String
-  end
-end

data/sig/iterators/synonym_iterator.rbs

@@ -1,5 +0,0 @@
-module Algolia
-  class SynonymIterator < PaginatorIterator
-    def get_endpoint: () -> String
-  end
-end

data/sig/transport/request_options.rbs

@@ -1,33 +0,0 @@
-module Algolia
-  module Transport
-    class RequestOptions
-      attr_accessor headers: Hash[Symbol|String, String]
-
-      attr_accessor params: Hash[Symbol|String, untyped]
-
-      attr_accessor data: Hash[Symbol|String, untyped]
-
-      attr_accessor timeout: Integer
-
-      attr_accessor connect_timeout: Integer
-
-      attr_accessor compression_type: String
-
-      def initialize: (Algolia::Search::Config config) -> void
-
-      def create: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_headers: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_params: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_timeout: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_connect_timeout: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_compression_type: (?::Hash[Symbol|String, untyped] opts) -> void
-
-      def add_data_body: (?::Hash[Symbol|String, untyped] opts) -> void
-    end
-  end
-end

data/sig/transport/stateful_host.rbs

@@ -1,21 +0,0 @@
-module Algolia
-  module Transport
-    class StatefulHost
-      include CallType
-
-      attr_reader url: untyped
-
-      attr_reader protocol: untyped
-
-      attr_reader accept: untyped
-
-      attr_accessor last_use: untyped
-
-      attr_accessor retry_count: untyped
-
-      attr_accessor up: untyped
-
-      def initialize: (String url, ?::Hash[Symbol|String, untyped] opts) -> void
-    end
-  end
-end

data/test/algolia/integration/account_client_test.rb

@@ -1,47 +0,0 @@
-require_relative 'base_test'
-
-class AccountClientTest < BaseTest
-  describe 'Account client' do
-    def test_account_client
-      index1 = @@search_client.init_index(get_test_index_name('copy_index'))
-      index2 = @@search_client.init_index(get_test_index_name('copy_index2'))
-
-      exception = assert_raises Algolia::AlgoliaError do
-        Algolia::Account::Client.copy_index(index1, index2)
-      end
-
-      assert_equal 'The indices are on the same application. Use Algolia::Search::Client.copy_index instead.', exception.message
-
-      search_client2 = Algolia::Search::Client.create(APPLICATION_ID_2, ADMIN_KEY_2)
-      index2         = search_client2.init_index(get_test_index_name('copy_index2'))
-      index1.save_object!({ objectID: 'one', title: 'Test title' })
-      index1.save_rule!({
-        objectID: 'one',
-        condition: { anchoring: 'is', pattern: 'pattern' },
-        consequence: {
-          params: {
-            query: {
-              edits: [
-                { type: 'remove', delete: 'pattern' }
-              ]
-            }
-          }
-        }
-      })
-      index1.save_synonym!({ objectID: 'one', type: 'synonym', synonyms: %w(one two) })
-      index1.set_settings!({ searchableAttributes: ['title'] })
-
-      Algolia::Account::Client.copy_index!(index1, index2)
-      assert_equal 'one', index2.get_object('one')[:objectID]
-      assert_equal 'one', index2.get_synonym('one')[:objectID]
-      assert_equal 'one', index2.get_rule('one')[:objectID]
-      assert index2.get_settings[:searchableAttributes]
-
-      exception = assert_raises Algolia::AlgoliaError do
-        Algolia::Account::Client.copy_index(index1, index2)
-      end
-
-      assert_equal 'Destination index already exists. Please delete it before copying index across applications.', exception.message
-    end
-  end
-end

data/test/algolia/integration/analytics_client_test.rb

@@ -1,117 +0,0 @@
-require_relative 'base_test'
-require 'date'
-
-class AnalyticsClientTest < BaseTest
-  describe 'Analytics client' do
-    def test_ab_testing
-      index1 = @@search_client.init_index(get_test_index_name('ab_testing'))
-      index2 = @@search_client.init_index(get_test_index_name('ab_testing_dev'))
-      client = Algolia::Analytics::Client.create(APPLICATION_ID_1, ADMIN_KEY_1)
-
-      index1.save_object!({ objectID: 'one' })
-      index2.save_object!({ objectID: 'one' })
-
-      ab_test_name = index1.name
-      tomorrow     = Time.now + 24*60*60
-
-      ab_test = {
-        name: ab_test_name,
-        variants: [
-          { index: index1.name, trafficPercentage: 60, description: 'a description' },
-          { index: index2.name, trafficPercentage: 40 }
-        ],
-        endAt: tomorrow.strftime('%Y-%m-%dT%H:%M:%SZ')
-      }
-
-      response   = retry_test do
-        client.add_ab_test(ab_test)
-      end
-      ab_test_id = response[:abTestID]
-
-      index1.wait_task(response[:taskID])
-      result = client.get_ab_test(ab_test_id)
-
-      assert_equal ab_test[:name], result[:name]
-      assert_equal ab_test[:variants][0][:index], result[:variants][0][:index]
-      assert_equal ab_test[:variants][0][:trafficPercentage], result[:variants][0][:trafficPercentage]
-      assert_equal ab_test[:variants][0][:description], result[:variants][0][:description]
-      assert_equal ab_test[:endAt], result[:endAt]
-      refute_equal 'stopped', result[:status]
-
-      ab_tests = client.get_ab_tests
-      found    = false
-      ab_tests[:abtests].each do |iterated_ab_test|
-        if iterated_ab_test[:name] == ab_test_name
-          assert_equal ab_test[:name], iterated_ab_test[:name]
-          assert_equal ab_test[:variants][0][:index], iterated_ab_test[:variants][0][:index]
-          assert_equal ab_test[:variants][0][:trafficPercentage], iterated_ab_test[:variants][0][:trafficPercentage]
-          assert_equal ab_test[:variants][0][:description], iterated_ab_test[:variants][0][:description]
-          assert_equal ab_test[:endAt], iterated_ab_test[:endAt]
-          refute_equal 'stopped', iterated_ab_test[:status]
-          found = true
-        end
-      end
-
-      assert found
-
-      response = client.stop_ab_test(ab_test_id)
-      index1.wait_task(response[:taskID])
-      result   = client.get_ab_test(ab_test_id)
-      assert_equal 'stopped', result[:status]
-
-      response = client.delete_ab_test(ab_test_id)
-      index1.wait_task(response[:taskID])
-
-      exception = assert_raises Algolia::AlgoliaHttpError do
-        client.get_ab_test(ab_test_id)
-      end
-
-      assert_equal 404, exception.code
-      assert_equal 'ABTestID not found', exception.message
-    end
-
-    def test_aa_testing
-      index  = @@search_client.init_index(get_test_index_name('aa_testing'))
-      client = Algolia::Analytics::Client.create(APPLICATION_ID_1, ADMIN_KEY_1)
-
-      index.save_object!({ objectID: 'one' })
-
-      ab_test_name = index.name
-      tomorrow     = Time.now + 24*60*60
-
-      ab_test = {
-        name: ab_test_name,
-        variants: [
-          { index: index.name, trafficPercentage: 90 },
-          { index: index.name, trafficPercentage: 10, customSearchParameters: { ignorePlurals: true } }
-        ],
-        endAt: tomorrow.strftime('%Y-%m-%dT%H:%M:%SZ')
-      }
-
-      response   = retry_test do
-        client.add_ab_test(ab_test)
-      end
-      ab_test_id = response[:abTestID]
-
-      index.wait_task(response[:taskID])
-      result = client.get_ab_test(ab_test_id)
-
-      assert_equal ab_test[:name], result[:name]
-      assert_equal ab_test[:variants][0][:index], result[:variants][0][:index]
-      assert_equal ab_test[:variants][0][:trafficPercentage], result[:variants][0][:trafficPercentage]
-      assert_equal ab_test[:variants][1][:customSearchParameters], result[:variants][1][:customSearchParameters]
-      assert_equal ab_test[:endAt], result[:endAt]
-      refute_equal 'stopped', result[:status]
-
-      response = client.delete_ab_test(ab_test_id)
-      index.wait_task(response[:taskID])
-
-      exception = assert_raises Algolia::AlgoliaHttpError do
-        client.get_ab_test(ab_test_id)
-      end
-
-      assert_equal 404, exception.code
-      assert_equal 'ABTestID not found', exception.message
-    end
-  end
-end

data/test/algolia/integration/base_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-require 'minitest/hell'
-
-class BaseTest < Minitest::Test
-  parallelize_me!
-  def setup
-    check_environment_variables
-  end
-end

data/test/algolia/integration/insights_client_test.rb

@@ -1,80 +0,0 @@
-require_relative 'base_test'
-require 'date'
-
-class InsightsClientTest < BaseTest
-  describe 'Insights client' do
-    def test_insights_client
-      index  = @@search_client.init_index(get_test_index_name('sending_events'))
-      client = Algolia::Insights::Client.create(APPLICATION_ID_1, ADMIN_KEY_1)
-
-      index.save_objects!([
-        { objectID: 'one' },
-        { objectID: 'two' }
-      ])
-
-      today = Date.today
-
-      client.send_event({
-        eventType: 'click',
-        eventName: 'foo',
-        index: index.name,
-        userToken: 'bar',
-        objectIDs: %w(one two),
-        timestamp: (today - 2).strftime('%Q').to_i
-      })
-
-      client.send_events([
-        {
-          eventType: 'click',
-          eventName: 'foo',
-          index: index.name,
-          userToken: 'bar',
-          objectIDs: %w(one two),
-          timestamp: (today - 2).strftime('%Q').to_i
-        }, {
-          eventType: 'click',
-          eventName: 'foo',
-          index: index.name,
-          userToken: 'bar',
-          objectIDs: %w(one two),
-          timestamp: (today - 2).strftime('%Q').to_i
-        }
-      ])
-
-      user_client = client.user('bar')
-      response    = user_client.clicked_object_ids('foo', index.name, %w(one two))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      query_id = index.search('', { clickAnalytics: true })[:queryID]
-
-      response = user_client.clicked_object_ids_after_search('foo', index.name, %w(one two), [1, 2], query_id)
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.clicked_filters('foo', index.name, %w(filter:foo filter:bar))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.converted_object_ids('foo', index.name, %w(one two))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.converted_object_ids_after_search('foo', index.name, %w(one two), query_id)
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.converted_filters('foo', index.name, %w(filter:foo filter:bar))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.viewed_object_ids('foo', index.name, %w(one two))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-
-      response = user_client.viewed_filters('foo', index.name, %w(filter:foo filter:bar))
-      assert_equal 200, response[:status]
-      assert_equal 'OK', response[:message]
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-class MockRequester
-  attr_accessor :requests
-  def initialize
-    @connection = nil
-    @requests   = []
-  end
-
-  def send_request(host, method, path, body, headers, timeout, connect_timeout)
-    request = {
-      host: host,
-      method: method,
-      path: path,
-      body: body,
-      headers: headers,
-      timeout: timeout,
-      connect_timeout: connect_timeout
-    }
-
-    @requests.push(request)
-
-    Algolia::Http::Response.new(
-      status: 200,
-      body: '{"hits": [], "status": "published"}',
-      headers: {}
-    )
-  end
-
-  # Retrieve the connection from the @connections
-  #
-  # @param host [StatefulHost]
-  #
-  # @return [Faraday::Connection]
-  #
-  def get_connection(host)
-    @connection = host
-  end
-
-  # Build url from host, path and parameters
-  #
-  # @param host [StatefulHost]
-  #
-  # @return [String]
-  #
-  def build_url(host)
-    host.protocol + host.url
-  end
-end

data/test/algolia/integration/personalization_client_test.rb

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

data/test/algolia/integration/recommend_client_test.rb

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