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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4645e42bf97d367a91ac73d59c440bc8f07d34c969df2d16ca3d6fac652f14f9
-  data.tar.gz: 2188142202397e4e56dbe7b77d635b439794ebf6401472e83907ab078e593a45
+  metadata.gz: 47d18253040f91e77f82a815e90b4064c88aac2ddbacbe4c26b1dea81304d847
+  data.tar.gz: 530b601d76e6de0b4f252dc13bcce01f7446428f839cd22fb4b286a1b5a17f73
 SHA512:
-  metadata.gz: edb4691eaa9e505a1e014e58232edffb0c6fdb62686f52b90c597b037392e81c1af98c7e339f017ad5b1ecab916d07336cf31c734832838d7648fcab82e2fe82
-  data.tar.gz: c9d8da55b0599118d3153ca84e1bf34f909cf128c101b5480ffff64213253e45685daef451ee48e15410737319efd6dea5f75768b3e2c0af0947160b1304473e
+  metadata.gz: 04c63a1fb49fcd66817e0b43f66c16b3cbe8bd044ca513409047f8709ab8cc757deb30cedaeafcddf831f98179efa9c21fdcbf4bb09a1641b9b5b7aa96d6fc8c
+  data.tar.gz: e552093cc4ab5827c8ab87e448856bfdbd68f113b8e321e928e66ceb03f8ecf96531aad902d256a6372336c9efeedd166e85165d63a0c83f0795de942a0b4eb7

data/lib/algolia/config/base_config.rb

@@ -3,7 +3,7 @@ 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
+                  :symbolize_keys, :use_latest_settings
 
     #
     # @option options [String] :application_id
@@ -28,12 +28,14 @@ module Algolia
         '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
+      @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)

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

@@ -976,7 +976,7 @@ module Algolia
       def get_settings(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

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.0.0-beta.2'.freeze
+  VERSION = '2.0.0-beta.3'.freeze
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta.2
+  version: 2.0.0.pre.beta.3
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler