search_flip 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa450fa83c07d1ed7e266ef436c26075a0bd6d8b5fd2904ed98d6b4b3921c6ab
-  data.tar.gz: b7c06e750f4b73d3ad1c8626485526b9389d95591f6c56b954f5f1f6610dec2d
+  metadata.gz: 021f5dd6d172381d777444631e96f2ebff0759b002f38b9ca555f844184d5dd9
+  data.tar.gz: ded7bbcab491ca187a68214377aa1f6ab2e3774739224744181aca16cf81e504
 SHA512:
-  metadata.gz: cd8bbc2c91f7b35f5b3d54d225082b7d2c4a0b932b1323c4de836adfa8d3118e89bc70ac6f41b27c6dec3fdf200eafec10a7b7c145f3a73ccbc2a2f7c6eb8581
-  data.tar.gz: 8c6a974604a63b210d6dd8e585549116266db09321745511ffe78cece7fe84284dd1e035c01be685522f3fd118ac21daa714b2fdcb91f00c08d23dbf93adc692
+  metadata.gz: adc9acf973b399aa0595bdc42705516f9a13cb4cfbd18b5ee5db613d8c91261c3bba80834848b8079c4569431dfcbcff0368787b5edeb42f517e864721a54bef
+  data.tar.gz: 0b8769e3c59d1953036b2fc1618cfbd15db7bc4d19beef0a71e24aeb82830b499eff820e061b397ee20c15d4942941df69cc4dff2b20e4b35119193e78af74b7

data/.github/workflows/test.yml

@@ -28,6 +28,7 @@ jobs:
     - uses: actions/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+    - run: gem install bundler
     - run: bundle
     - run: sleep 10
     - run: bundle exec rspec

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
 
 Layout/EmptyLineBetweenDefs:
   EmptyLineBetweenClassDefs: false

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # CHANGELOG
 
+## v3.3.0
+
+* Update httprb
+* Changed oj default options
+* Allow to set oj json options
+
 ## v3.2.1
 
 * Fix `refresh` having a empty body breaking in elasticsearch 7.11

data/README.md

@@ -3,7 +3,7 @@
 
 **Full-Featured Elasticsearch Ruby Client with a Chainable DSL**
 
-[![Build Status](https://secure.travis-ci.org/mrkamel/search_flip.svg?branch=master)](http://travis-ci.org/mrkamel/search_flip)
+[![Build](https://github.com/mrkamel/search_flip/workflows/test/badge.svg)](https://github.com/mrkamel/search_flip/actions?query=workflow%3Atest+branch%3Amaster)
 [![Gem Version](https://badge.fury.io/rb/search_flip.svg)](http://badge.fury.io/rb/search_flip)
 
 Using SearchFlip it is dead-simple to create index classes that correspond to
@@ -51,8 +51,7 @@ CommentIndex.search("hello world").where(available: true).sort(id: "desc").aggre
 
 ```
 
-Finally, SearchFlip comes with a minimal set of dependencies (http-rb, hashie
-and oj only).
+Finally, SearchFlip comes with a minimal set of dependencies.
 
 ## Reference Docs
 
@@ -883,52 +882,46 @@ Thus, if your ORM supports `.find_each`, `#id` and `#where` you are already
 good to go. Otherwise, simply add your custom implementation of those methods
 that work with whatever ORM you use.
 
-## Date and Timestamps in JSON
+## JSON
 
-Elasticsearch requires dates and timestamps to have one of the formats listed
-here: [https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time).
-
-However, `JSON.generate` in ruby by default outputs something like:
+SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
+JSON. More concretely, SearchFlip is using:
 
 ```ruby
-JSON.generate(time: Time.now.utc)
-# => "{\"time\":\"2018-02-22 18:19:33 UTC\"}"
+Oj.dump({ key: "value" }, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
 ```
 
-This format is not compatible with Elasticsearch by default. If you're on
-Rails, ActiveSupport adds its own `#to_json` methods to `Time`, `Date`, etc.
-However, ActiveSupport checks whether they are used in combination with
-`JSON.generate` or not and adapt:
+The `use_to_json` option is used for maximum compatibility, most importantly
+when using rails `ActiveSupport::TimeWithZone` timestamps, which `oj` can not
+serialize natively. However, `use_to_json` adds performance overhead. You can
+change the json options via:
 
 ```ruby
-Time.now.utc.to_json
-=> "\"2018-02-22T18:18:22.088Z\""
-
-JSON.generate(time: Time.now.utc)
-=> "{\"time\":\"2018-02-22 18:18:59 UTC\"}"
+SearchFlip::Config[:json_options] = {
+  mode: :custom,
+  use_to_json: false,
+  time_format: :xmlschema,
+  bigdecimal_as_decimal: false
+}
 ```
 
-SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
-JSON. More concretely, SearchFlip is using:
+However, you then have to convert timestamps manually for indexation via e.g.:
 
 ```ruby
-Oj.dump({ key: "value" }, mode: :custom, use_to_json: true)
-```
+class MyIndex
+  # ...
 
-This mitigates the issues if you're on Rails:
+  def self.serialize(model)
+    {
+      # ...
 
-```ruby
-Oj.dump(Time.now, mode: :custom, use_to_json: true)
-# => "\"2018-02-22T18:21:21.064Z\""
+      created_at: model.created_at.to_time
+    }
+  end
+end
 ```
 
-However, if you're not on Rails, you need to add `#to_json` methods to `Time`,
-`Date` and `DateTime` to get proper serialization. You can either add them on
-your own, via other libraries or by simply using:
-
-```ruby
-require "search_flip/to_json"
-```
+Please check out the oj docs for more details.
 
 ## Feature Support
 

data/lib/search_flip.rb

@@ -3,6 +3,7 @@ require "forwardable"
 require "http"
 require "hashie"
 require "thread"
+require "json"
 require "oj"
 require "set"
 

data/lib/search_flip/bulk.rb

@@ -143,7 +143,7 @@ module SearchFlip
 
       return if options[:raise] == false
 
-      parsed_response = response.parse
+      parsed_response = SearchFlip::JSON.parse(response.to_s)
 
       return unless parsed_response["errors"]
 

data/lib/search_flip/config.rb

@@ -5,6 +5,12 @@ module SearchFlip
     bulk_limit: 1_000,
     bulk_max_mb: 100,
     auto_refresh: false,
-    instrumenter: NullInstrumenter.new
+    instrumenter: NullInstrumenter.new,
+    json_options: {
+      mode: :custom,
+      use_to_json: true,
+      time_format: :xmlschema,
+      bigdecimal_as_decimal: false
+    }
   }
 end

data/lib/search_flip/connection.rb

@@ -28,7 +28,11 @@ module SearchFlip
 
     def version
       @version_mutex.synchronize do
-        @version ||= http_client.headers(accept: "application/json").get("#{base_url}/").parse["version"]["number"]
+        @version ||= begin
+          response = http_client.headers(accept: "application/json").get("#{base_url}/")
+
+          SearchFlip::JSON.parse(response.to_s)["version"]["number"]
+        end
       end
     end
 
@@ -40,7 +44,9 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def cluster_health
-      http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health").parse
+      response = http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health")
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Uses the Elasticsearch Multi Search API to execute multiple search requests
@@ -71,7 +77,7 @@ module SearchFlip
           .headers(accept: "application/json", content_type: "application/x-ndjson")
           .post("#{base_url}/_msearch", body: payload)
 
-      raw_response.parse["responses"].map.with_index do |response, index|
+      SearchFlip::JSON.parse(raw_response.to_s)["responses"].map.with_index do |response, index|
         SearchFlip::Response.new(criterias[index], response)
       end
     end
@@ -90,10 +96,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def update_aliases(payload)
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .post("#{base_url}/_aliases", body: SearchFlip::JSON.generate(payload))
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Sends an analyze request to Elasticsearch. Raises
@@ -105,10 +112,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def analyze(request, params = {})
-      http_client
+      response = http_client
         .headers(accept: "application/json")
         .post("#{base_url}/_analyze", json: request, params: params)
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Fetches information about the specified index aliases. Raises
@@ -124,10 +132,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def get_aliases(index_name: "*", alias_name: "*")
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Returns whether or not the associated Elasticsearch alias already
@@ -159,10 +168,11 @@ module SearchFlip
     # @return [Array] The raw response
 
     def get_indices(name = "*", params: {})
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .get("#{base_url}/_cat/indices/#{name}", params: params)
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     alias_method :cat_indices, :get_indices
@@ -259,10 +269,11 @@ module SearchFlip
     # @return [Hash] The index settings
 
     def get_index_settings(index_name)
-      http_client
+      response = http_client
         .headers(accept: "application/json")
         .get("#{index_url(index_name)}/_settings")
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Sends a refresh request to Elasticsearch. Raises
@@ -310,7 +321,9 @@ module SearchFlip
       url = type_name ? type_url(index_name, type_name) : index_url(index_name)
       params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}
 
-      http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params).parse
+      response = http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params)
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Deletes the specified index from Elasticsearch. Raises

data/lib/search_flip/criteria.rb

@@ -608,7 +608,7 @@ module SearchFlip
           http_request.post("#{target.type_url}/_search", params: request_params, json: request)
         end
 
-      SearchFlip::Response.new(self, http_response.parse)
+      SearchFlip::Response.new(self, SearchFlip::JSON.parse(http_response.to_s))
     rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
       raise e unless failsafe_value
 

data/lib/search_flip/index.rb

@@ -455,7 +455,9 @@ module SearchFlip
       # @return [Hash] The specified document
 
       def get(id, params = {})
-        connection.http_client.headers(accept: "application/json").get("#{type_url}/#{id}", params: params).parse
+        response = connection.http_client.headers(accept: "application/json").get("#{type_url}/#{id}", params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Retrieves the documents specified by ids from elasticsearch.
@@ -471,7 +473,9 @@ module SearchFlip
       # @return [Hash] The raw response
 
       def mget(request, params = {})
-        connection.http_client.headers(accept: "application/json").post("#{type_url}/_mget", json: request, params: params).parse
+        response = connection.http_client.headers(accept: "application/json").post("#{type_url}/_mget", json: request, params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Sends an analyze request to Elasticsearch. Raises
@@ -483,7 +487,9 @@ module SearchFlip
       # @return [Hash] The raw response
 
       def analyze(request, params = {})
-        connection.http_client.headers(accept: "application/json").post("#{index_url}/_analyze", json: request, params: params).parse
+        response = connection.http_client.headers(accept: "application/json").post("#{index_url}/_analyze", json: request, params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Sends a index refresh request to Elasticsearch. Raises

data/lib/search_flip/json.rb

@@ -1,16 +1,11 @@
 module SearchFlip
   class JSON
-    @default_options = {
-      mode: :custom,
-      use_to_json: true
-    }
-
-    def self.default_options
-      @default_options
+    def self.generate(obj)
+      Oj.dump(obj, SearchFlip::Config[:json_options])
     end
 
-    def self.generate(obj)
-      Oj.dump(obj, default_options)
+    def self.parse(json)
+      ::JSON.parse(json)
     end
   end
 end

data/lib/search_flip/to_json.rb

@@ -1,29 +1 @@
-require "time"
-require "date"
-require "json"
-
-class Time
-  def to_json(*args)
-    iso8601(6).to_json
-  end
-end
-
-class Date
-  def to_json(*args)
-    iso8601.to_json
-  end
-end
-
-class DateTime
-  def to_json(*args)
-    iso8601(6).to_json
-  end
-end
-
-if defined?(ActiveSupport)
-  class ActiveSupport::TimeWithZone
-    def to_json(*args)
-      iso8601(6).to_json
-    end
-  end
-end
+warn "[DEPRECATION] Using search_flip/to_json is not neccessary anymore"

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.2.1"
+  VERSION = "3.3.0"
 end

data/search_flip.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "hashie"
   spec.add_dependency "http"
+  spec.add_dependency "json"
   spec.add_dependency "oj"
   spec.add_dependency "ruby2_keywords"
 end

data/spec/search_flip/json_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::JSON do
+  describe ".generate" do
+    it "encodes timestamps correctly" do
+      Timecop.freeze "2020-06-01 12:00:00 UTC" do
+        expect(described_class.generate(timestamp: Time.now.utc)).to eq('{"timestamp":"2020-06-01T12:00:00.000Z"}')
+      end
+    end
+
+    it "encodes bigdecimals as string" do
+      expect(described_class.generate(value: BigDecimal(1))).to eq('{"value":"1.0"}')
+    end
+
+    it "delegates to Oj" do
+      allow(Oj).to receive(:dump)
+
+      payload = { key: "value" }
+
+      described_class.generate(payload)
+
+      expect(Oj).to have_received(:dump).with(payload, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+    end
+
+    it "generates json" do
+      expect(described_class.generate(key: "value")).to eq('{"key":"value"}')
+    end
+  end
+
+  describe ".parse" do
+    it "returns the parsed json payload" do
+      expect(described_class.parse('{"key":"value"}')).to eq("key" => "value")
+    end
+
+    it "delegates to JSON" do
+      allow(JSON).to receive(:parse)
+
+      payload = '{"key":"value"}'
+
+      described_class.parse(payload)
+
+      expect(JSON).to have_received(:parse).with(payload)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -259,11 +273,11 @@ files:
 - spec/search_flip/criteria_spec.rb
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
+- spec/search_flip/json_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
-- spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mrkamel/search_flip
 licenses:
@@ -300,9 +314,9 @@ test_files:
 - spec/search_flip/criteria_spec.rb
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
+- spec/search_flip/json_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
-- spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb

data/spec/search_flip/to_json_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path("../spec_helper", __dir__)
-require "search_flip/to_json"
-
-RSpec.describe "to_json" do
-  it "uses the correct format for Time" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.now.utc.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-
-  it "uses the correct format for Date" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Date.today.to_json).to eq("\"2018-01-01\"")
-    end
-  end
-
-  it "uses the correct format for DateTime" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.now.utc.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-
-  it "uses the correct format for TimeWithZone" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.find_zone("UTC").now.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-end