algolia 2.0.0.pre.alpha.3 → 2.0.0

data/lib/algolia/transport/transport.rb

@@ -132,10 +132,10 @@ module Algolia
       # @return [Hash] merged headers
       #
       def generate_headers(request_options = {})
-        headers                                                     = {}
-        extra_headers                                               = request_options.headers || {}
-        @config.default_headers.each { |key, val| headers[key.to_s] = val }
-        extra_headers.each { |key, val| headers[key.to_s]           = val }
+        headers                                             = {}
+        extra_headers                                       = request_options.headers || {}
+        @config.headers.each { |key, val| headers[key.to_s] = val }
+        extra_headers.each { |key, val| headers[key.to_s]   = val }
         if request_options.compression_type == Defaults::GZIP_ENCODING
           headers['Accept-Encoding']  = Defaults::GZIP_ENCODING
         end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.0.0-alpha.3'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/sig/config/algolia_config.rbs

@@ -1,11 +1,10 @@
 module Algolia
-  # Class AlgoliaConfig
-  class AlgoliaConfig
+  class BaseConfig
     attr_accessor app_id: String
 
     attr_accessor api_key: String
 
-    attr_accessor default_headers: Hash[String, String]
+    attr_accessor headers: Hash[String, String]
 
     attr_accessor batch_size: Integer
 
@@ -20,5 +19,6 @@ module Algolia
     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,6 +1,6 @@
 module Algolia
   module Analytics
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor region: String
 
       attr_accessor default_hosts: [String]

data/sig/config/insights_config.rbs

@@ -1,6 +1,6 @@
 module Algolia
   module Insights
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor region: String
 
       attr_accessor default_hosts: [String]

data/sig/config/recommendation_config.rbs

@@ -1,6 +1,6 @@
 module Algolia
   module Recommendation
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor region: String
 
       attr_accessor default_hosts: [String]

data/sig/config/search_config.rbs

@@ -1,6 +1,6 @@
 module Algolia
   module Search
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       include CallType
 
       attr_accessor default_hosts: Array[untyped]

data/test/algolia/integration/analytics_client_test.rb

@@ -11,14 +11,14 @@ class AnalyticsClientTest < BaseTest
       index1.save_object!({ objectID: 'one' })
       index2.save_object!({ objectID: 'one' })
 
-      ab_test_name = index1.index_name
+      ab_test_name = index1.name
       tomorrow     = Time.now + 24*60*60
 
       ab_test = {
         name: ab_test_name,
         variants: [
-          { index: index1.index_name, trafficPercentage: 60, description: 'a description' },
-          { index: index2.index_name, trafficPercentage: 40 }
+          { index: index1.name, trafficPercentage: 60, description: 'a description' },
+          { index: index2.name, trafficPercentage: 40 }
         ],
         endAt: tomorrow.strftime('%Y-%m-%dT%H:%M:%SZ')
       }
@@ -74,14 +74,14 @@ class AnalyticsClientTest < BaseTest
 
       index.save_object!({ objectID: 'one' })
 
-      ab_test_name = index.index_name
+      ab_test_name = index.name
       tomorrow     = Time.now + 24*60*60
 
       ab_test = {
         name: ab_test_name,
         variants: [
-          { index: index.index_name, trafficPercentage: 90 },
-          { index: index.index_name, trafficPercentage: 10, customSearchParameters: { ignorePlurals: true } }
+          { index: index.name, trafficPercentage: 90 },
+          { index: index.name, trafficPercentage: 10, customSearchParameters: { ignorePlurals: true } }
         ],
         endAt: tomorrow.strftime('%Y-%m-%dT%H:%M:%SZ')
       }

data/test/algolia/integration/insights_client_test.rb

@@ -17,7 +17,7 @@ class InsightsClientTest < BaseTest
       client.send_event({
         eventType: 'click',
         eventName: 'foo',
-        index: index.index_name,
+        index: index.name,
         userToken: 'bar',
         objectIDs: %w(one two),
         timestamp: (today - 2).strftime('%Q').to_i
@@ -27,14 +27,14 @@ class InsightsClientTest < BaseTest
         {
           eventType: 'click',
           eventName: 'foo',
-          index: index.index_name,
+          index: index.name,
           userToken: 'bar',
           objectIDs: %w(one two),
           timestamp: (today - 2).strftime('%Q').to_i
         }, {
           eventType: 'click',
           eventName: 'foo',
-          index: index.index_name,
+          index: index.name,
           userToken: 'bar',
           objectIDs: %w(one two),
           timestamp: (today - 2).strftime('%Q').to_i
@@ -42,37 +42,37 @@ class InsightsClientTest < BaseTest
       ])
 
       user_client = client.user('bar')
-      response    = user_client.clicked_object_ids('foo', index.index_name, %w(one two))
+      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.index_name, %w(one two), [1, 2], query_id)
+      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.index_name, %w(filter:foo filter:bar))
+      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.index_name, %w(one two))
+      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.index_name, %w(one two), query_id)
+      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.index_name, %w(filter:foo filter:bar))
+      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.index_name, %w(one two))
+      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.index_name, %w(filter:foo filter:bar))
+      response = user_client.viewed_filters('foo', index.name, %w(filter:foo filter:bar))
       assert_equal 200, response[:status]
       assert_equal 'OK', response[:message]
     end

data/test/algolia/integration/search_client_test.rb

@@ -80,10 +80,10 @@ class SearchClientTest < BaseTest
       copy_rules_index     = @@search_client.init_index(get_test_index_name('copy_index_rules'))
       copy_synonyms_index  = @@search_client.init_index(get_test_index_name('copy_index_synonyms'))
       copy_full_copy_index = @@search_client.init_index(get_test_index_name('copy_index_full_copy'))
-      @@search_client.copy_settings!(@index_name, copy_settings_index.index_name)
-      @@search_client.copy_rules!(@index_name, copy_rules_index.index_name)
-      @@search_client.copy_synonyms!(@index_name, copy_synonyms_index.index_name)
-      @@search_client.copy_index!(@index_name, copy_full_copy_index.index_name)
+      @@search_client.copy_settings!(@index_name, copy_settings_index.name)
+      @@search_client.copy_rules!(@index_name, copy_rules_index.name)
+      @@search_client.copy_synonyms!(@index_name, copy_synonyms_index.name)
+      @@search_client.copy_index!(@index_name, copy_full_copy_index.name)
 
       assert_equal @index.get_settings, copy_settings_index.get_settings
       assert_equal @index.get_rule(rule[:objectID]), copy_rules_index.get_rule(rule[:objectID])
@@ -93,7 +93,7 @@ class SearchClientTest < BaseTest
       assert_equal @index.get_synonym(synonym[:objectID]), copy_full_copy_index.get_synonym(synonym[:objectID])
 
       moved_index = @@search_client.init_index(get_test_index_name('move_index'))
-      @@search_client.move_index!(@index_name, moved_index.index_name)
+      @@search_client.move_index!(@index_name, moved_index.name)
 
       moved_index.get_synonym('google_placeholder')
       moved_index.get_rule('company_auto_faceting')
@@ -233,7 +233,16 @@ class SearchClientTest < BaseTest
 
       assert_equal 'Key does not exist', exception.message
 
-      @@search_client.restore_api_key!(@api_key[:value])
+      loop do
+        begin
+          @@search_client.restore_api_key!(@api_key[:value])
+          break
+        rescue Algolia::AlgoliaHttpError => e
+          if e.code != 404
+            raise StandardError
+          end
+        end
+      end
 
       restored_key = @@search_client.get_api_key(@api_key[:value])
 
@@ -261,8 +270,8 @@ class SearchClientTest < BaseTest
     end
 
     def test_multiple_operations
-      index_name1 = @index1.index_name
-      index_name2 = @index2.index_name
+      index_name1 = @index1.name
+      index_name2 = @index2.name
 
       response = @@search_client.multiple_batch!([
         { indexName: index_name1, action: 'addObject', body: { firstname: 'Jimmie' } },
@@ -317,12 +326,12 @@ class SearchClientTest < BaseTest
         now             = Time.now.to_i
         secured_api_key = Algolia::Search::Client.generate_secured_api_key(SEARCH_KEY_1, {
           validUntil: now + (10 * 60),
-          restrictIndices: @index1.index_name
+          restrictIndices: @index1.name
         })
 
         secured_client = Algolia::Search::Client.create(APPLICATION_ID_1, secured_api_key)
-        secured_index1 = secured_client.init_index(@index1.index_name)
-        secured_index2 = secured_client.init_index(@index2.index_name)
+        secured_index1 = secured_client.init_index(@index1.name)
+        secured_index2 = secured_client.init_index(@index2.name)
 
         secured_index1.search('')
         exception = assert_raises Algolia::AlgoliaHttpError do

data/test/algolia/unit/algolia_config_test.rb

@@ -0,0 +1,16 @@
+require 'algolia'
+require 'test_helper'
+
+class AlgoliaConfigTest
+  describe 'set an extra header' do
+    def before_all
+      @config = Algolia::BaseConfig.new(application_id: 'app_id', api_key: 'api_key')
+    end
+
+    def test_set_extra_header
+      @config.set_extra_header('foo', 'bar')
+      assert @config.headers['foo']
+      assert_equal @config.headers['foo'], 'bar'
+    end
+  end
+end

data/test/algolia/unit/helpers_test.rb

@@ -18,7 +18,24 @@ class HelpersTest
         replicas: %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings)
+      deserialized_settings = deserialize_settings(old_settings, true)
+      assert_equal new_settings, deserialized_settings
+    end
+
+    def test_deserialize_settings_with_string
+      old_settings = {
+        'attributesToIndex' => %w(attr1 attr2),
+        'numericAttributesToIndex' => %w(attr1 attr2),
+        'slaves' => %w(index1 index2)
+      }
+
+      new_settings = {
+        'searchableAttributes' => %w(attr1 attr2),
+        'numericAttributesForFiltering' => %w(attr1 attr2),
+        'replicas' => %w(index1 index2)
+      }
+
+      deserialized_settings = deserialize_settings(old_settings, false)
       assert_equal new_settings, deserialized_settings
     end
   end

data/test/algolia/unit/retry_strategy_test.rb

@@ -13,7 +13,7 @@ class RetryStrategyTest
       stateful_hosts << "#{@app_id}-4.algolianet.com"
       stateful_hosts << "#{@app_id}-5.algolianet.com"
       stateful_hosts << "#{@app_id}-6.algolianet.com"
-      @config        = Algolia::Search::Config.new(app_id: @app_id, api_key: @api_key, custom_hosts: stateful_hosts)
+      @config        = Algolia::Search::Config.new(application_id: @app_id, api_key: @api_key, custom_hosts: stateful_hosts)
     end
 
     def test_resets_expired_hosts_according_to_read_type
@@ -74,7 +74,7 @@ class RetryStrategyTest
   describe 'All hosts are unreachable' do
     def test_failure_when_all_hosts_are_down
       stateful_hosts = ['0.0.0.0']
-      @config        = Algolia::Search::Config.new(app_id: 'foo', api_key: 'bar', custom_hosts: stateful_hosts)
+      @config        = Algolia::Search::Config.new(application_id: 'foo', api_key: 'bar', custom_hosts: stateful_hosts)
       client         = Algolia::Search::Client.create_with_config(@config)
       index          = client.init_index(get_test_index_name('failure'))
 
@@ -91,7 +91,7 @@ class RetryStrategyTest
       super
       @app_id         = 'app_id'
       @api_key        = 'api_key'
-      @config         = Algolia::Search::Config.new(app_id: @app_id, api_key: @api_key)
+      @config         = Algolia::Search::Config.new(application_id: @app_id, api_key: @api_key)
       @retry_strategy = Algolia::Transport::RetryStrategy.new(@config)
       @hosts          = @retry_strategy.get_tryable_hosts(READ|WRITE)
     end

data/test/test_helper.rb

@@ -24,7 +24,7 @@ class Minitest::Test
 
   include Minitest::Hooks
   include Helpers
-  @@search_config = Algolia::Search::Config.new(app_id: APPLICATION_ID_1, api_key: ADMIN_KEY_1, user_agent: USER_AGENT)
+  @@search_config = Algolia::Search::Config.new(application_id: APPLICATION_ID_1, api_key: ADMIN_KEY_1, user_agent: USER_AGENT)
   @@search_client = Algolia::Search::Client.new(@@search_config)
 end
 

data/upgrade_guide.md

@@ -5,7 +5,7 @@ First, you'll have to include the new version in your Gemfile. To do so, change
 
 ```diff
 - gem 'algoliasearch'
-+ gem 'algolia', git: 'https://github.com/algolia/algoliasearch-client-ruby.git', tag: 'v2.0.0-alpha.1'
++ gem 'algolia', git: 'https://github.com/algolia/algoliasearch-client-ruby.git', tag: 'v2.0.0-beta.1'
 ```
 
 Then, you'll need to change your current `require` statements:
@@ -38,11 +38,17 @@ index = client.init_index('index_name')
 client = Algolia::Search::Client.create('APP_ID', 'API_KEY')
 index = client.init_index('index_name')
 # or
-search_config = Algolia::Search::Config.new(app_id: app_id, api_key: api_key)
+search_config = Algolia::Search::Config.new(application_id: app_id, api_key: api_key)
 client = Algolia::Search::Client.create_with_config(search_config)
 index = client.init_index('index_name')
 ```
 
+By default the keys of the response hashes are symbols. If you wish to change that for strings, use the following configuration
+```ruby
+search_config = Algolia::Search::Config.new(application_id: app_id, api_key: api_key, symbolize_keys: false)
+client = Algolia::Search::Client.create_with_config(search_config)
+```
+
 ## Search parameters and request options
 The search parameters and request options are still optional, but they are combined into a single hash instead of two. 
 For example:
@@ -55,12 +61,8 @@ index.search('query', search_params, request_opts)
 
 # After
 opts = {
-  :headers => {
-    'X-Algolia-UserToken': 'user123'
-  },
-  :params => {
-    hitsPerPage: 50
-  }
+  headers: { 'X-Algolia-UserToken': 'user123' },
+  hitsPerPage: 50
 }
 index.search('query', opts)
 ```
@@ -69,6 +71,20 @@ index.search('query', opts)
 
 ### `Client`
 
+#### `set_extra_header`
+The `set_extra_header` method has been moved from the Client to the `Algolia::BaseConfig` class. You have to define your extra headers on Client instantiation.
+```ruby
+# Before
+client.set_extra_header('admin', 'admin-key')
+
+# After
+# `Algolia::Search::Config` inherits from `Algolia::BaseConfig` 
+config = Algolia::Search::Config.new(app_id: 'APP_ID', api_key: 'API_KEY')
+config.set_extra_header('admin', 'admin-key')
+
+client = Algolia::Search::Client.create_with_config(config)
+```
+
 #### `multiple_queries`
 The `strategy` parameter is no longer a string, but a key in the `requestOptions`.
 ```ruby
@@ -213,7 +229,7 @@ client.search_user_ids('query', {clusterName: 'my-cluster', hitPerPage: 12, page
 #### `pending_mappings`
 New method to check the status of your clusters' migration or user creation.
 ```ruby
-client.pending_mapping?({ retrieveMappings: true })
+client.pending_mappings?({ retrieveMappings: true })
 ``` 
 
 #### `get_logs`
@@ -244,12 +260,8 @@ index.search('query', search_params, request_opts)
 
 # After
 opts = {
-  :headers => {
-    'X-Algolia-UserToken': 'user123'
-  },
-  :params => {
-    hitsPerPage: 50
-  }
+  headers: { 'X-Algolia-UserToken': 'user123' },
+  hitsPerPage: 50
 }
 index.search('query', opts)
 ```
@@ -265,12 +277,8 @@ index.search_for_facet_values('category', 'phone', search_params, request_opts)
 
 # After
 opts = {
-  :headers => {
-    'X-Algolia-UserToken': 'user123'
-  },
-  :params => {
-    hitsPerPage: 50
-  }
+  headers: { 'X-Algolia-UserToken': 'user123' },
+  hitsPerPage: 50
 }
 index.search_for_facet_values('category', 'phone', opts)
 ```
@@ -590,6 +598,6 @@ client = Algolia::Client.new({
 })
 
 # After
-search_config = Algolia::Search::Config.new(app_id: 'app_id', api_key: 'api_key', read_timeout: 10, connect_timeout: 2)
+search_config = Algolia::Search::Config.new(application_id: 'app_id', api_key: 'api_key', read_timeout: 10, connect_timeout: 2)
 client = Algolia::Search::Client.create_with_config(search_config)
 ```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Algolia
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,8 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This is the alpha version of the upcoming v2 release of Algolia Client.
-  Please keep on using the algoliasearch gem in the meantime.
+description: A simple Ruby client for the algolia.com REST API
 email:
 - support@algolia.com
 executables: []
@@ -192,11 +191,13 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
 - algolia.gemspec
 - bin/console
@@ -204,8 +205,8 @@ files:
 - lib/algolia.rb
 - lib/algolia/account_client.rb
 - lib/algolia/analytics_client.rb
-- lib/algolia/config/algolia_config.rb
 - lib/algolia/config/analytics_config.rb
+- lib/algolia/config/base_config.rb
 - lib/algolia/config/insights_config.rb
 - lib/algolia/config/recommendation_config.rb
 - lib/algolia/config/search_config.rb
@@ -265,16 +266,20 @@ files:
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb
 - test/algolia/integration/search_index_test.rb
+- test/algolia/unit/algolia_config_test.rb
 - test/algolia/unit/helpers_test.rb
 - test/algolia/unit/retry_strategy_test.rb
 - test/algolia/unit/user_agent_test.rb
 - test/test_helper.rb
 - upgrade_guide.md
-homepage: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+homepage: https://github.com/algolia/algoliasearch-client-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/algolia/algoliasearch-client-ruby/issues
+  documentation_uri: https://www.algolia.com/doc/api-client/getting-started/install/ruby
+  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -285,14 +290,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: A simple Ruby client for the algolia.com REST API (alpha release)
+summary: A simple Ruby client for the algolia.com REST API
 test_files:
 - test/algolia/integration/account_client_test.rb
 - test/algolia/integration/analytics_client_test.rb
@@ -302,6 +307,7 @@ test_files:
 - test/algolia/integration/recommendation_client_test.rb
 - test/algolia/integration/search_client_test.rb
 - test/algolia/integration/search_index_test.rb
+- test/algolia/unit/algolia_config_test.rb
 - test/algolia/unit/helpers_test.rb
 - test/algolia/unit/retry_strategy_test.rb
 - test/algolia/unit/user_agent_test.rb