algolia 2.0.0.pre.alpha.2 → 2.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60205951ef158935268ca5acdea467072a3e06355b1937a81ae78724da0e909
-  data.tar.gz: eba4990f0591fb94fbcbc4d7e834f9fdb8ff0092d05a05e658b5a89272999bd5
+  metadata.gz: 47d18253040f91e77f82a815e90b4064c88aac2ddbacbe4c26b1dea81304d847
+  data.tar.gz: 530b601d76e6de0b4f252dc13bcce01f7446428f839cd22fb4b286a1b5a17f73
 SHA512:
-  metadata.gz: e458b5c6be67e8c73338995485cfb01783e83d0e22be7bdce4fa0b23f7bedada8f9630ce274569a30ce7e792ad35324f22d8dbd2761e1ed5f08a6bbcd69984fb
-  data.tar.gz: 68b2b9af700d930b34ccab5340515935ee56b81eb1bec1703ae9cf4db6f7cb065322dc88705ebc8025e3579a065f6cbbed8b288347d2e15d7e68df4e54b378de
+  metadata.gz: 04c63a1fb49fcd66817e0b43f66c16b3cbe8bd044ca513409047f8709ab8cc757deb30cedaeafcddf831f98179efa9c21fdcbf4bb09a1641b9b5b7aa96d6fc8c
+  data.tar.gz: e552093cc4ab5827c8ab87e448856bfdbd68f113b8e321e928e66ceb03f8ecf96531aad902d256a6372336c9efeedd166e85165d63a0c83f0795de942a0b4eb7

data/.rubocop.yml

@@ -184,3 +184,6 @@ Style/HashTransformValues:
 
 Style/HashEachMethods:
   Enabled: true
+
+Style/RedundantBegin:
+  Enabled: false

data/Gemfile

@@ -9,7 +9,7 @@ gem 'minitest-ci'
 
 group :development do
   gem 'git-precommit'
-  gem 'steep'
+  gem 'steep' if RUBY_VERSION >= '2.5'
   gem 'yard'
 end
 

data/algolia.gemspec

@@ -12,8 +12,15 @@ Gem::Specification.new do |spec|
 
   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'
+  spec.summary     = 'A simple Ruby client for the algolia.com REST API (alpha release)'
+  spec.description = 'This is the alpha version of the upcoming v2 release of Algolia Client. Please keep on using the algoliasearch gem in the meantime.'
+  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/issues',
+    'documentation_uri' => 'http://www.rubydoc.info/gems/algolia',
+    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem

data/lib/algolia.rb

@@ -3,7 +3,7 @@ require 'algolia/helpers'
 require 'algolia/http/http_requester'
 require 'algolia/defaults'
 require 'algolia/user_agent'
-require 'algolia/config/algolia_config'
+require 'algolia/config/base_config'
 require 'algolia/config/search_config'
 require 'algolia/config/analytics_config'
 require 'algolia/config/insights_config'

data/lib/algolia/analytics_client.rb

@@ -26,7 +26,7 @@ module Algolia
       # @return self
       #
       def self.create(app_id, api_key)
-        config = Analytics::Config.new(app_id: app_id, api_key: api_key)
+        config = Analytics::Config.new(application_id: app_id, api_key: api_key)
         create_with_config(config)
       end
 

data/lib/algolia/config/analytics_config.rb

@@ -1,11 +1,11 @@
 module Algolia
   module Analytics
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor :region, :default_hosts
 
       # Initialize a config
       #
-      # @option options [String] :app_id
+      # @option options [String] :application_id
       # @option options [String] :api_key
       # @option options [String] :region
       #

data/lib/algolia/config/base_config.rb

@@ -0,0 +1,45 @@
+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
+      # used to avoid BC break on Rails integration, should not be documented
+      @use_latest_settings = opts.has_key?(:use_latest_settings) ? opts[:use_latest_settings] : true
+    end
+
+    def set_extra_header(key, value)
+      @headers[key] = value
+    end
+  end
+end

data/lib/algolia/config/insights_config.rb

@@ -1,11 +1,11 @@
 module Algolia
   module Insights
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor :region, :default_hosts
 
       # Initialize a config
       #
-      # @option options [String] :app_id
+      # @option options [String] :application_id
       # @option options [String] :api_key
       # @option options [String] :region
       #

data/lib/algolia/config/recommendation_config.rb

@@ -1,11 +1,11 @@
 module Algolia
   module Recommendation
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       attr_accessor :region, :default_hosts
 
       # Initialize a config
       #
-      # @option options [String] :app_id
+      # @option options [String] :application_id
       # @option options [String] :api_key
       # @option options [String] :region
       #

data/lib/algolia/config/search_config.rb

@@ -5,13 +5,13 @@ require 'algolia/enums/call_type'
 
 module Algolia
   module Search
-    class Config < AlgoliaConfig
+    class Config < BaseConfig
       include CallType
       attr_accessor :default_hosts
 
       # Initialize a config
       #
-      # @option options [String] :app_id
+      # @option options [String] :application_id
       # @option options [String] :api_key
       # @option options [Hash] :custom_hosts
       #

data/lib/algolia/defaults.rb

@@ -24,8 +24,8 @@ module Defaults
 
   BATCH_SIZE      = 1000
   CONNECT_TIMEOUT = 2
-  READ_TIMEOUT    = 30
-  WRITE_TIMEOUT   = 5
+  READ_TIMEOUT    = 5
+  WRITE_TIMEOUT   = 30
   USER_AGENT      = "Algolia for Ruby (#{Algolia::VERSION}), Ruby (#{RUBY_VERSION})"
 
   WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY = 100

data/lib/algolia/error.rb

@@ -17,8 +17,7 @@ module Algolia
   # which is also included in the response attribute.
   #
   class AlgoliaHttpError < AlgoliaError
-    attr_accessor :code
-    attr_accessor :message
+    attr_accessor :code, :message
 
     def initialize(code, message)
       self.code    = code

data/lib/algolia/helpers.rb

@@ -52,7 +52,9 @@ module Helpers
 
   # Support to convert old settings to their new names
   #
-  def deserialize_settings(data)
+  def deserialize_settings(data, use_latest_settings, symbolize_keys)
+    return data unless use_latest_settings
+
     settings = symbolize_hash(data)
     keys     = {
       attributesToIndex: 'searchableAttributes',
@@ -62,7 +64,8 @@ module Helpers
 
     keys.each do |deprecated_key, current_key|
       if settings.has_key?(deprecated_key)
-        settings[current_key.to_sym] = settings.delete(deprecated_key)
+        key           = symbolize_keys ? current_key.to_sym : current_key.to_s
+        settings[key] = settings.delete(deprecated_key)
       end
     end
 

data/lib/algolia/insights_client.rb

@@ -26,7 +26,7 @@ module Algolia
       # @return self
       #
       def self.create(app_id, api_key)
-        config = Insights::Config.new(app_id: app_id, api_key: api_key)
+        config = Insights::Config.new(application_id: app_id, api_key: api_key)
         create_with_config(config)
       end
 

data/lib/algolia/iterators/object_iterator.rb

@@ -7,16 +7,17 @@ module Algolia
         data = {}
 
         if @response
-          if @response[:hits].length
-            @response[:hits].each do |hit|
+          parsed_response = symbolize_hash(@response)
+          if parsed_response[:hits].length
+            parsed_response[:hits].each do |hit|
               yield hit
             end
 
-            if @response[:cursor].nil?
+            if parsed_response[:cursor].nil?
               @response = nil
               raise StopIteration
             else
-              data[:cursor] = @response[:cursor]
+              data[:cursor] = parsed_response[:cursor]
             end
           end
         end

data/lib/algolia/iterators/paginator_iterator.rb

@@ -16,13 +16,15 @@ module Algolia
     def each
       loop do
         if @response
-          if @response[:hits].length
-            @response[:hits].each do |hit|
+          parsed_response = symbolize_hash(@response)
+          parsed_data     = symbolize_hash(@data)
+          if parsed_response[:hits].length
+            parsed_response[:hits].each do |hit|
               hit.delete(:_highlightResult)
               yield hit
             end
 
-            if @response[:nbHits] < @data[:hitsPerPage]
+            if parsed_response[:nbHits] < parsed_data[:hitsPerPage]
               @response = nil
               @data     = {
                 hitsPerPage: 1000,

data/lib/algolia/recommendation_client.rb

@@ -24,7 +24,7 @@ module Algolia
       # @return self
       #
       def self.create(app_id, api_key)
-        config = Recommendation::Config.new(app_id: app_id, api_key: api_key)
+        config = Recommendation::Config.new(application_id: app_id, api_key: api_key)
         create_with_config(config)
       end
 

data/lib/algolia/search_client.rb

@@ -32,7 +32,7 @@ module Algolia
       # @return self
       #
       def self.create(app_id, api_key)
-        config = Search::Config.new(app_id: app_id, api_key: api_key)
+        config = Search::Config.new(application_id: app_id, api_key: api_key)
         create_with_config(config)
       end
 

data/lib/algolia/search_index.rb

@@ -5,16 +5,16 @@ module Algolia
       include CallType
       include Helpers
 
-      attr_reader :index_name, :transporter, :config
+      attr_reader :name, :transporter, :config
 
       # Initialize an index
       #
-      # @param index_name [String] name of the index
+      # @param name [String] name of the index
       # @param transporter [Object] transport object used for the connection
       # @param config [Config] a Config object which contains your APP_ID and API_KEY
       #
-      def initialize(index_name, transporter, config)
-        @index_name  = index_name
+      def initialize(name, transporter, config)
+        @name        = name
         @transporter = transporter
         @config      = config
       end
@@ -47,7 +47,7 @@ module Algolia
       # @param opts [Hash] contains extra parameters to send with your query
       #
       def get_task_status(task_id, opts = {})
-        res    = @transporter.read(:GET, path_encode('/1/indexes/%s/task/%s', @index_name, task_id), {}, opts)
+        res    = @transporter.read(:GET, path_encode('/1/indexes/%s/task/%s', @name, task_id), {}, opts)
         get_option(res, 'status')
       end
 
@@ -56,7 +56,7 @@ module Algolia
       # @param opts [Hash] contains extra parameters to send with your query
       #
       def clear_objects(opts = {})
-        response = @transporter.write(:POST, path_encode('/1/indexes/%s/clear', @index_name), {}, opts)
+        response = @transporter.write(:POST, path_encode('/1/indexes/%s/clear', @name), {}, opts)
 
         IndexingResponse.new(self, response)
       end
@@ -75,7 +75,7 @@ module Algolia
       # @param opts [Hash] contains extra parameters to send with your query
       #
       def delete(opts = {})
-        response = @transporter.write(:DELETE, path_encode('/1/indexes/%s', @index_name), opts)
+        response = @transporter.write(:DELETE, path_encode('/1/indexes/%s', @name), opts)
 
         IndexingResponse.new(self, response)
       end
@@ -115,7 +115,7 @@ module Algolia
         has_next_page = true
         while has_next_page
           request_options[:page] = page
-          res                    = search(query, request_options)
+          res                    = symbolize_hash(search(query, request_options))
 
           res[:hits].each_with_index do |hit, i|
             if callback.call(hit)
@@ -154,7 +154,7 @@ module Algolia
       # @return [IndexingResponse]
       #
       def copy_to(name, opts = {})
-        response = @transporter.write(:POST, path_encode('/1/indexes/%s/operation', @index_name), { operation: 'copy', destination: name }, opts)
+        response = @transporter.write(:POST, path_encode('/1/indexes/%s/operation', @name), { operation: 'copy', destination: name }, opts)
 
         IndexingResponse.new(self, response)
       end
@@ -167,7 +167,7 @@ module Algolia
       # @return [IndexingResponse]
       #
       def move_to(name, opts = {})
-        response = @transporter.write(:POST, path_encode('/1/indexes/%s/operation', @index_name), { operation: 'move', destination: name }, opts)
+        response = @transporter.write(:POST, path_encode('/1/indexes/%s/operation', @name), { operation: 'move', destination: name }, opts)
 
         IndexingResponse.new(self, response)
       end
@@ -184,7 +184,7 @@ module Algolia
       # @return [Hash]
       #
       def get_object(object_id, opts = {})
-        @transporter.read(:GET, path_encode('/1/indexes/%s/%s', @index_name, object_id), {}, opts)
+        @transporter.read(:GET, path_encode('/1/indexes/%s/%s', @name, object_id), {}, opts)
       end
 
       # Retrieve one or more objects in a single API call
@@ -201,7 +201,7 @@ module Algolia
 
         requests = []
         object_ids.each do |object_id|
-          request = { indexName: @index_name, objectID: object_id.to_s }
+          request = { indexName: @name, objectID: object_id.to_s }
 
           if attributes_to_retrieve
             request[:attributesToRetrieve] = attributes_to_retrieve
@@ -381,7 +381,7 @@ module Algolia
       # @return [IndexingResponse]
       #
       def delete_by(filters, opts = {})
-        response = @transporter.write(:POST, path_encode('/1/indexes/%s/deleteByQuery', @index_name), filters, opts)
+        response = @transporter.write(:POST, path_encode('/1/indexes/%s/deleteByQuery', @name), filters, opts)
 
         IndexingResponse.new(self, response)
       end
@@ -436,7 +436,7 @@ module Algolia
       # @return [Hash]
       #
       def get_rule(object_id, opts = {})
-        @transporter.read(:GET, path_encode('/1/indexes/%s/rules/%s', @index_name, object_id), {}, opts)
+        @transporter.read(:GET, path_encode('/1/indexes/%s/rules/%s', @name, object_id), {}, opts)
       end
 
       # Create or update a rule
@@ -500,7 +500,7 @@ module Algolia
           get_object_id(rule)
         end
 
-        response = @transporter.write(:POST, path_encode('/1/indexes/%s/rules/batch', @index_name) + handle_params({ forwardToReplicas: forward_to_replicas, clearExistingRules: clear_existing_rules }), rules, request_options)
+        response = @transporter.write(:POST, path_encode('/1/indexes/%s/rules/batch', @name) + handle_params({ forwardToReplicas: forward_to_replicas, clearExistingRules: clear_existing_rules }), rules, request_options)
 
         IndexingResponse.new(self, response)
       end
@@ -532,7 +532,7 @@ module Algolia
           request_options.delete(:forwardToReplicas)
         end
 
-        response = @transporter.write(:POST, path_encode('1/indexes/%s/rules/clear', @index_name) + handle_params({ forwardToReplicas: forward_to_replicas }), '', request_options)
+        response = @transporter.write(:POST, path_encode('1/indexes/%s/rules/clear', @name) + handle_params({ forwardToReplicas: forward_to_replicas }), '', request_options)
 
         IndexingResponse.new(self, response)
       end
@@ -566,7 +566,7 @@ module Algolia
 
         response = @transporter.write(
           :DELETE,
-          path_encode('1/indexes/%s/rules/%s', @index_name, object_id) + handle_params({ forwardToReplicas: forward_to_replicas }),
+          path_encode('1/indexes/%s/rules/%s', @name, object_id) + handle_params({ forwardToReplicas: forward_to_replicas }),
           '',
           request_options
         )
@@ -598,7 +598,7 @@ module Algolia
       # @return [Hash]
       #
       def get_synonym(object_id, opts = {})
-        @transporter.read(:GET, path_encode('/1/indexes/%s/synonyms/%s', @index_name, object_id), {}, opts)
+        @transporter.read(:GET, path_encode('/1/indexes/%s/synonyms/%s', @name, object_id), {}, opts)
       end
 
       # Create a new synonym object or update the existing synonym object with the given object ID
@@ -666,7 +666,7 @@ module Algolia
         end
         response = @transporter.write(
           :POST,
-          path_encode('/1/indexes/%s/synonyms/batch', @index_name) + handle_params({ forwardToReplicas: forward_to_replicas, replaceExistingSynonyms: replace_existing_synonyms }),
+          path_encode('/1/indexes/%s/synonyms/batch', @name) + handle_params({ forwardToReplicas: forward_to_replicas, replaceExistingSynonyms: replace_existing_synonyms }),
           synonyms,
           request_options
         )
@@ -703,7 +703,7 @@ module Algolia
         end
         response = @transporter.write(
           :POST,
-          path_encode('1/indexes/%s/synonyms/clear', @index_name) + handle_params({ forwardToReplicas: forward_to_replicas }),
+          path_encode('1/indexes/%s/synonyms/clear', @name) + handle_params({ forwardToReplicas: forward_to_replicas }),
           '',
           request_options
         )
@@ -738,7 +738,7 @@ module Algolia
         end
         response = @transporter.write(
           :DELETE,
-          path_encode('1/indexes/%s/synonyms/%s', @index_name, object_id) + handle_params({ forwardToReplicas: forward_to_replicas }),
+          path_encode('1/indexes/%s/synonyms/%s', @name, object_id) + handle_params({ forwardToReplicas: forward_to_replicas }),
           '',
           request_options
         )
@@ -769,9 +769,9 @@ module Algolia
       #
       def browse_objects(opts = {}, &block)
         if block_given?
-          ObjectIterator.new(@transporter, @index_name, opts).each(&block)
+          ObjectIterator.new(@transporter, @name, opts).each(&block)
         else
-          ObjectIterator.new(@transporter, @index_name, opts)
+          ObjectIterator.new(@transporter, @name, opts)
         end
       end
 
@@ -783,9 +783,9 @@ module Algolia
       #
       def browse_rules(opts = {}, &block)
         if block_given?
-          RuleIterator.new(@transporter, @index_name, opts).each(&block)
+          RuleIterator.new(@transporter, @name, opts).each(&block)
         else
-          RuleIterator.new(@transporter, @index_name, opts)
+          RuleIterator.new(@transporter, @name, opts)
         end
       end
 
@@ -797,9 +797,9 @@ module Algolia
       #
       def browse_synonyms(opts = {}, &block)
         if block_given?
-          SynonymIterator.new(@transporter, @index_name, opts).each(&block)
+          SynonymIterator.new(@transporter, @name, opts).each(&block)
         else
-          SynonymIterator.new(@transporter, @index_name, opts)
+          SynonymIterator.new(@transporter, @name, opts)
         end
       end
 
@@ -822,7 +822,7 @@ module Algolia
           request_options.delete(:safe)
         end
 
-        tmp_index_name   = @index_name + '_tmp_' + rand(10000000).to_s
+        tmp_index_name   = @name + '_tmp_' + rand(10000000).to_s
         copy_to_response = copy_to(tmp_index_name, request_options.merge({ scope: %w(settings synonyms rules) }))
 
         if safe
@@ -839,7 +839,7 @@ module Algolia
           save_objects_response.wait
         end
 
-        move_to_response = tmp_index.move_to(@index_name)
+        move_to_response = tmp_index.move_to(@name)
         if safe
           move_to_response.wait
         end
@@ -924,7 +924,7 @@ module Algolia
       # @return [Hash]
       #
       def search(query, opts = {})
-        @transporter.read(:POST, path_encode('/1/indexes/%s/query', @index_name), { 'query': query.to_s }, opts)
+        @transporter.read(:POST, path_encode('/1/indexes/%s/query', @name), { 'query': query.to_s }, opts)
       end
 
       # Search for values of a given facet, optionally restricting the returned values to those contained
@@ -937,7 +937,7 @@ module Algolia
       # @return [Hash]
       #
       def search_for_facet_values(facet_name, facet_query, opts = {})
-        @transporter.read(:POST, path_encode('/1/indexes/%s/facets/%s/query', @index_name, facet_name),
+        @transporter.read(:POST, path_encode('/1/indexes/%s/facets/%s/query', @name, facet_name),
                           { 'facetQuery': facet_query }, opts)
       end
 
@@ -949,7 +949,7 @@ module Algolia
       # @return [Hash]
       #
       def search_synonyms(query, opts = {})
-        @transporter.read(:POST, path_encode('/1/indexes/%s/synonyms/search', @index_name), { query: query.to_s }, opts)
+        @transporter.read(:POST, path_encode('/1/indexes/%s/synonyms/search', @name), { query: query.to_s }, opts)
       end
 
       # Search or browse all rules, optionally filtering them by type
@@ -960,7 +960,7 @@ module Algolia
       # @return [Hash]
       #
       def search_rules(query, opts = {})
-        @transporter.read(:POST, path_encode('/1/indexes/%s/rules/search', @index_name), { query: query.to_s }, opts)
+        @transporter.read(:POST, path_encode('/1/indexes/%s/rules/search', @name), { query: query.to_s }, opts)
       end
 
       # # # # # # # # # # # # # # # # # # # # #
@@ -974,9 +974,9 @@ module Algolia
       # @return [Hash]
       #
       def get_settings(opts = {})
-        response = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @index_name) + handle_params({ getVersion: 2 }), {}, opts)
+        response = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @name) + handle_params({ getVersion: 2 }), {}, opts)
 
-        deserialize_settings(response)
+        deserialize_settings(response, @config.use_latest_settings, @config.symbolize_keys)
       end
 
       # Update some index settings. Only specified settings are overridden
@@ -987,7 +987,7 @@ module Algolia
       # @return [IndexingResponse]
       #
       def set_settings(settings, opts = {})
-        response = @transporter.write(:PUT, path_encode('/1/indexes/%s/settings', @index_name), settings, opts)
+        response = @transporter.write(:PUT, path_encode('/1/indexes/%s/settings', @name), settings, opts)
 
         IndexingResponse.new(self, response)
       end
@@ -1087,7 +1087,7 @@ module Algolia
       end
 
       def raw_batch(requests, opts)
-        @transporter.write(:POST, path_encode('/1/indexes/%s/batch', @index_name), { requests: requests }, opts)
+        @transporter.write(:POST, path_encode('/1/indexes/%s/batch', @name), { requests: requests }, opts)
       end
     end
   end

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.2'.freeze
+  VERSION = '2.0.0-beta.3'.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,35 @@ class HelpersTest
         replicas: %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings)
+      deserialized_settings = deserialize_settings(old_settings, true, true)
+      assert_equal new_settings, deserialized_settings
+    end
+
+    def test_deserialize_settings_with_old_settings
+      old_settings = {
+        attributesToIndex: %w(attr1 attr2),
+        numericAttributesToIndex: %w(attr1 attr2),
+        slaves: %w(index1 index2)
+      }
+
+      deserialized_settings = deserialize_settings(old_settings, false, true)
+      assert_equal old_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, true, 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
@@ -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.2
+  version: 2.0.0.pre.beta.3
 platform: ruby
 authors:
 - Algolia
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,7 +178,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple Ruby client for the algolia.com REST API
+description: This is the alpha version of the upcoming v2 release of Algolia Client.
+  Please keep on using the algoliasearch gem in the meantime.
 email:
 - support@algolia.com
 executables: []
@@ -203,8 +204,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
@@ -264,16 +265,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: 
+homepage: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/algolia/algoliasearch-client-ruby/issues
+  documentation_uri: http://www.rubydoc.info/gems/algolia
+  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -288,10 +293,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 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
+summary: A simple Ruby client for the algolia.com REST API (alpha release)
 test_files:
 - test/algolia/integration/account_client_test.rb
 - test/algolia/integration/analytics_client_test.rb
@@ -301,6 +306,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

data/lib/algolia/config/algolia_config.rb

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