search_flip 4.0.0.beta14 → 4.0.0.beta15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a711d443c26f483da4898b2b7e69d1ca7c2dfd1280cd4d0a7d8ae6affbcdbc0d
-  data.tar.gz: a5721bc56cc311ce664f49d89229b79fdfe525357c33b6ff9b46e5c7bc6e634f
+  metadata.gz: cbf6d1f0c653af6bc398768eff11d7715c1cea101a06f4eefb1c6078ad33abc1
+  data.tar.gz: c2568175d32374201ea212abfdebd709d8933c92c19cc646225b7bd90244498c
 SHA512:
-  metadata.gz: 43c8b33aaa23e84e65b93a624806664c7f7ea779e582ba010b21319ea8b597c4b53633edf9f6746762b2dce844a0ad0764fc1c2209fdee2ab19aea60a7dbbad4
-  data.tar.gz: 22c06e14023d4bd43475f3573b1e387bb855e43fdb0babc9b366e0f7388ecde08eaee53598d0dda148ecf1f62afb5ed0b328f91742471e7bd8f3e5c7349df146
+  metadata.gz: 3f28cc23ad081e6345764799b2f70b957c9be97fab7781f22fbee580ed2c28b8da0bb0b3a9c4ef5d4ec200c94a6799a5c082489d9a62b2e24f94c49e29bcd4d1
+  data.tar.gz: 1f773fcf838215595db93760a66359acf77a19f63758447a9f30498be90dcce079a2ba21e2ce3350f2b6295e3906b3bb3ea3b5472f0804965b6003e61d94460d

data/.github/workflows/test.yml

@@ -39,6 +39,10 @@ jobs:
           env:
             discovery.type: single-node
             plugins.security.disabled: true
+        - image: opensearchproject/opensearch:2.13.0
+          env:
+            discovery.type: single-node
+            DISABLE_SECURITY_PLUGIN: true
         ruby:
         - 2.7
         - 3.0

data/CHANGELOG.md

@@ -11,7 +11,20 @@
 * Added `SearchFlip::Connection#get_cluster_settings` and
   `#update_cluster_settings`
 
-## v3.8.0.
+## v3.9.0
+
+* Allow to configure the elasticsearch version no matter which elasticsearch
+  version is actually in use. The version information is needed to support
+  version dependent features. Please note that manually configuring the version
+  is usually not need as the version by default is determined by sending one
+  request to elasticsearch.
+
+```ruby
+SearchFlip::Config[:version] = { number: "8.1.1" }
+SearchFlip::Config[:version] = { number: "2.13", distribution: "opensearch" }
+```
+
+## v3.8.0
 
 * Support Opensearch 1.x and 2.x
 

data/Gemfile

@@ -14,6 +14,6 @@ gem "factory_bot"
 gem "rake"
 gem "rspec"
 gem "rubocop"
-gem "sqlite3"
+gem "sqlite3", "~> 1.4"
 gem "timecop"
 gem "webmock"

data/README.md

@@ -98,6 +98,16 @@ Available config options are:
 * `auto_refresh` tells SearchFlip to automatically refresh an index after
   import, index, delete, etc operations. This is e.g. useful for testing, etc.
   Defaults to false.
+* `version` allows to configure the elasticsearch version no matter which
+  elasticsearch version is actually in use. The version information is needed to
+  support version dependent features. Please note that manually configuring the
+  version is usually not need as the version by default is determined by sending
+  one request to elasticsearch.
+
+```ruby
+SearchFlip::Config[:version] = { number: "8.1.1" }
+SearchFlip::Config[:version] = { number: "2.13", distribution: "opensearch" }
+```
 
 ## Usage
 

data/lib/search_flip/connection.rb

@@ -26,7 +26,7 @@ module SearchFlip
     # @return [String] The Elasticsearch distribution
 
     def distribution
-      @distribution ||= SearchFlip::JSON.parse(version_response.to_s)["version"]["distribution"]
+      @distribution ||= SearchFlip::Config.dig(:version, :distribution) || SearchFlip::JSON.parse(version_response.to_s)["version"]["distribution"]
     end
 
     # Queries the cluster settings from Elasticsearch
@@ -66,7 +66,7 @@ module SearchFlip
     # @return [String] The Elasticsearch version
 
     def version
-      @version ||= SearchFlip::JSON.parse(version_response.to_s)["version"]["number"]
+      @version ||= SearchFlip::Config.dig(:version, :number) || SearchFlip::JSON.parse(version_response.to_s)["version"]["number"]
     end
 
     # Queries and returns the Elasticsearch cluster health.

data/lib/search_flip/json.rb

@@ -5,7 +5,7 @@ module SearchFlip
     end
 
     def self.parse(json)
-      ::JSON.parse(json)
+      ::JSON.parse(json, object_class: SearchFlip::Result)
     end
   end
 end

data/lib/search_flip/response.rb

@@ -305,11 +305,11 @@ module SearchFlip
         if response["aggregations"].nil? || response["aggregations"][key].nil?
           SearchFlip::Result.new
         elsif response["aggregations"][key]["buckets"].is_a?(Array)
-          response["aggregations"][key]["buckets"].each_with_object({}) { |bucket, hash| hash[bucket["key"]] = SearchFlip::Result.convert(bucket) }
+          response["aggregations"][key]["buckets"].each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket }
         elsif response["aggregations"][key]["buckets"].is_a?(Hash)
-          SearchFlip::Result.convert(response["aggregations"][key]["buckets"])
+          response["aggregations"][key]["buckets"]
         else
-          SearchFlip::Result.convert(response["aggregations"][key])
+          response["aggregations"][key]
         end
     end
   end

data/lib/search_flip/result.rb

@@ -8,32 +8,6 @@ module SearchFlip
   #   result.some_key # => "value"
 
   class Result < Hash
-    def self.convert(hash)
-      res = self[hash]
-
-      res.each do |key, value|
-        if value.is_a?(Hash)
-          res[key] = convert(value)
-        elsif value.is_a?(Array)
-          res[key] = convert_array(value)
-        end
-      end
-
-      res
-    end
-
-    def self.convert_array(arr)
-      arr.map do |obj|
-        if obj.is_a?(Hash)
-          convert(obj)
-        elsif obj.is_a?(Array)
-          convert_array(obj)
-        else
-          obj
-        end
-      end
-    end
-
     def method_missing(name, *args, &block)
       self[name.to_s]
     end
@@ -43,8 +17,8 @@ module SearchFlip
     end
 
     def self.from_hit(hit)
-      res = convert(hit["_source"] || {})
-      res["_hit"] = convert(self[hit].tap { |hash| hash.delete("_source") })
+      res = self[hit["_source"] || {}]
+      res["_hit"] = self[hit].tap { |hash| hash.delete("_source") }
       res
     end
   end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "4.0.0.beta14"
+  VERSION = "4.0.0.beta15"
 end

data/spec/search_flip/connection_spec.rb

@@ -5,12 +5,28 @@ RSpec.describe SearchFlip::Connection do
     it "reutrns the distribution" do
       expect([nil, "opensearch"]).to include(SearchFlip::Connection.new.distribution)
     end
+
+    it "returns the distribution from the config when given" do
+      SearchFlip::Config[:version] = { distribution: "distribution" }
+
+      expect(SearchFlip::Connection.new.distribution).to eq("distribution")
+    ensure
+      SearchFlip::Config.delete(:version)
+    end
   end
 
   describe "#version" do
     it "returns the version" do
       expect(SearchFlip::Connection.new.version).to match(/\A[0-9.]+\z/)
     end
+
+    it "returns the version from the config when given" do
+      SearchFlip::Config[:version] = { number: "1.2.3" }
+
+      expect(SearchFlip::Connection.new.version).to eq("1.2.3")
+    ensure
+      SearchFlip::Config.delete(:version)
+    end
   end
 
   describe "#cluster_health" do

data/spec/search_flip/json_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe SearchFlip::JSON do
 
       described_class.parse(payload)
 
-      expect(JSON).to have_received(:parse).with(payload)
+      expect(JSON).to have_received(:parse).with(payload, object_class: SearchFlip::Result)
     end
   end
 end

data/spec/search_flip/result_spec.rb

@@ -1,26 +1,17 @@
 require File.expand_path("../spec_helper", __dir__)
 
 RSpec.describe SearchFlip::Result do
-  describe ".convert" do
-    it "deeply converts hashes and arrays" do
-      result = described_class.convert("parent" => { "child" => [{ "key1" => "value" }, { "key2" => 3 }] })
-
-      expect(result.parent.child[0].key1).to eq("value")
-      expect(result.parent.child[1].key2).to eq(3)
-    end
-  end
-
   describe "#method_missing" do
     it "returns the value of the key equal to the message name" do
-      expect(described_class.convert("some_key" => "value").some_key).to eq("value")
+      expect(described_class["some_key" => "value"].some_key).to eq("value")
       expect(described_class.new.some_key).to be_nil
     end
   end
 
   describe "#responds_to_missing?" do
     it "returns true/false if the key equal to the message name is present or not" do
-      expect(described_class.convert("some_key" => nil).respond_to?(:some_key)).to eq(true)
-      expect(described_class.convert("some_key" => nil).respond_to?(:other_key)).to eq(false)
+      expect(described_class["some_key" => nil].respond_to?(:some_key)).to eq(true)
+      expect(described_class["some_key" => nil].respond_to?(:other_key)).to eq(false)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta14
+  version: 4.0.0.beta15
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http