algolia 2.0.0.pre.alpha.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a37aa5b34c5719c6f15dae985448b1d4469c7617e5da569bb298531b459dcdc4
-  data.tar.gz: d7c2a37e288cff749973b78dd9edc20f4611efe94bb36ede952450925b579976
+  metadata.gz: 555e432d41a84d3031f58dc7c74acf5297df48fe693fadf977c6b15547a82d6b
+  data.tar.gz: a3fbbc9ba6552b0b432a20e34cd5cf7a311f339c2df7f7a3c549ced84f409ba0
 SHA512:
-  metadata.gz: 1b8fa3c17a15bb2249e21fa51376e41ff5f7f9de222c05d70b1e2bf289326e31f51c1c7c2b35abe7eefbcdf59f787c3c5822b84dcd11699d0931f5271d95f00d
-  data.tar.gz: 523de843a4bb08fc9809768c29a4a1ec4393f6b7739c61e5739b429811ef79082a9b89718a7350e4fbfa6c666eab9249c9a96931a92b68dd9626de453b1015d7
+  metadata.gz: 757d57c2723f3f036bfb7faa38615fd751311e99b0a3f5e1b3c13087c53a9010af88c99a5412e31bb3e6d3cdb9201478d7100c71080b3fe948004170a870f875
+  data.tar.gz: ede51228b6bc2498b65434102f8b25b17d7db74ae74cd2b50a1ec7184f42692e4b24d94de8c621ec91a8192c924e71ac1067bfdde038a03936407f12147b6175

data/.gitignore

@@ -35,4 +35,5 @@ pkg
 Gemfile.lock
 spec/integration_spec_conf.rb
 data.sqlite3
+
 debug.log

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# ChangeLog
+
+## Unreleased
+
+## [2.0.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.0) (2020-10-27)
+
+* Initial release of v2

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/README.md

@@ -6,9 +6,9 @@
   <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>
+    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby"><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/algolia"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
   </p>
 </p>
 
@@ -18,39 +18,47 @@
   <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/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</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`.
+- Supports Ruby `^2.2`.
 
 ## 💡 Getting Started
 
 First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
 ```bash
-gem install algoliasearch
+gem install algolia
 ```
 
 Then, create objects on your index:
 
 
 ```ruby
-Algolia.init(application_id: 'YourApplicationID',
-             api_key:        'YourAPIKey')
-index = Algolia::Index.new('your_index_name')
+client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
+index = client.init_index('your_index_name')
 
-index.save_objects([objectID:  1, name: 'Foo'])
+index.save_objects([objectID: 1, name: 'Foo'])
 ```
 
 Finally, you may begin searching a object using the `search` method:
 ```ruby
-objects = index.search('Fo')
+objects = index.search('Foo')
 ```
 
 For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
 
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+
+## Upgrade from V1 to V2
+
+If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
+
 ## 📄 License
 
 Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

data/SECURITY.md

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

data/algolia.gemspec

@@ -12,9 +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 (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.summary     = 'A simple Ruby client for the algolia.com REST API'
+  spec.description = 'A simple Ruby client for the algolia.com REST API'
+  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby'
+
+  spec.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'
+  }
 
   # 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,43 @@
+require 'faraday'
+
+module Algolia
+  class BaseConfig
+    attr_accessor :app_id, :api_key, :headers, :batch_size, :read_timeout, :write_timeout, :connect_timeout, :compression_type,
+                  :symbolize_keys, :use_latest_settings
+
+    #
+    # @option options [String] :application_id
+    # @option options [String] :api_key
+    # @option options [Integer] :batch_size
+    # @option options [Integer] :read_timeout
+    # @option options [Integer] :write_timeout
+    # @option options [Integer] :connect_timeout
+    # @option options [Boolean] :symbolize_keys
+    #
+    def initialize(opts = {})
+      raise AlgoliaError, 'No Application ID provided, please set :application_id' unless opts.has_key?(:application_id)
+      raise AlgoliaError, 'No API key provided, please set :api_key' unless opts.has_key?(:api_key)
+
+      @app_id  = opts[:application_id]
+      @api_key = opts[:api_key]
+
+      @headers = {
+        Defaults::HEADER_API_KEY => @api_key,
+        Defaults::HEADER_APP_ID => @app_id,
+        'Content-Type' => 'application/json; charset=utf-8',
+        'User-Agent' => UserAgent.value
+      }
+
+      @batch_size          = opts[:batch_size] || Defaults::BATCH_SIZE
+      @read_timeout        = opts[:read_timeout] || Defaults::READ_TIMEOUT
+      @write_timeout       = opts[:write_timeout] || Defaults::WRITE_TIMEOUT
+      @connect_timeout     = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
+      @compression_type    = opts[:compression_type] || Defaults::NONE_ENCODING
+      @symbolize_keys      = opts.has_key?(:symbolize_keys) ? opts[:symbolize_keys] : true
+    end
+
+    def set_extra_header(key, value)
+      @headers[key] = value
+    end
+  end
+end

data/lib/algolia/config/insights_config.rb

@@ -1,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,7 @@ module Helpers
 
   # Support to convert old settings to their new names
   #
-  def deserialize_settings(data)
+  def deserialize_settings(data, symbolize_keys)
     settings = symbolize_hash(data)
     keys     = {
       attributesToIndex: 'searchableAttributes',
@@ -62,7 +62,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.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