algolia 2.0.0.pre.beta.1 → 2.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ae2ec824eed001a361d702826ad88956c6b580793bc8bb3aceda020ea8e8ea
-  data.tar.gz: bbed7b37901bf59cbc1cbf172a4ec9fa06df026988187cd1ea78fd6a3cf9dae4
+  metadata.gz: 4645e42bf97d367a91ac73d59c440bc8f07d34c969df2d16ca3d6fac652f14f9
+  data.tar.gz: 2188142202397e4e56dbe7b77d635b439794ebf6401472e83907ab078e593a45
 SHA512:
-  metadata.gz: 253ebb7ccb0745b17f72526df5656ba58eb800c3ce973eaffe52e6f098758def22d425c77fe6b07f882733551d3d01f081ff80b4be6b900f7ccfcac3a2926edf
-  data.tar.gz: a5e231f9bd48361cfe12fa5b74234ad899b6ac1dbd2b46dc0b4f69a76532bebb7cc1e0f7eb9abf7930693422a124c7eb5e5f18b5798beb3eb9edd6463779d3b7
+  metadata.gz: edb4691eaa9e505a1e014e58232edffb0c6fdb62686f52b90c597b037392e81c1af98c7e339f017ad5b1ecab916d07336cf31c734832838d7648fcab82e2fe82
+  data.tar.gz: c9d8da55b0599118d3153ca84e1bf34f909cf128c101b5480ffff64213253e45685daef451ee48e15410737319efd6dea5f75768b3e2c0af0947160b1304473e

data/lib/algolia/config/base_config.rb

@@ -33,7 +33,7 @@ module Algolia
       @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
+      @symbolize_keys   = opts.has_key?(:symbolize_keys) ? opts[:symbolize_keys] : true
     end
 
     def set_extra_header(key, value)

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/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/search_index.rb

@@ -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)

data/lib/algolia/version.rb

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

data/test/algolia/unit/algolia_config_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 class AlgoliaConfigTest
   describe 'set an extra header' do
     def before_all
-      @config = Algolia::AlgoliaConfig.new(app_id: 'app_id', api_key: 'api_key')
+      @config = Algolia::BaseConfig.new(application_id: 'app_id', api_key: 'api_key')
     end
 
     def test_set_extra_header

data/upgrade_guide.md

@@ -43,6 +43,12 @@ 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:
@@ -66,13 +72,13 @@ index.search('query', opts)
 ### `Client`
 
 #### `set_extra_header`
-The `set_extra_header` method has been moved from the Client to the `Algolia::AlgoliaConfig` class. You have to define your extra headers on Client instantiation.
+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::AlgoliaConfig` 
+# `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')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta.1
+  version: 2.0.0.pre.beta.2
 platform: ruby
 authors:
 - Algolia