search_flip 3.0.0 → 4.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa160794662cedbe89066113cb845c84daaee29451ba8c8ba4f9183689b42582
-  data.tar.gz: b55133b0f4f90f61db0b76042c1223a17035f277ba221a00c0f665512e1cb170
+  metadata.gz: 3e231e9ac3434626705696aea544b0ab30a134de6c6773129e779e6ae7adfab4
+  data.tar.gz: 7fe5852eda4d9d73a1a6bfe14e1c6d807bffa08c47c15c137d624dd4050bbcd5
 SHA512:
-  metadata.gz: eb2e1e1fd39d64639b9a1f542997e6a00c6238226144fbd32f45f0023f93aa827a1c54597fb71f993090c9d78bcb8b92bbac3a5185d584f26cbeb2e1c4b1a641
-  data.tar.gz: caea53f0332131113662b24818268bfd5e3cf537ad04b07b853aba600fc4edd417d1783fd3a1d37fd6d848a75df21ec2e3d39c45a8dafab5fdc515d6f8ca43a9
+  metadata.gz: ec79c30df34f4cfdb9f8afcd25f4d982d1b03461a00af7a9055f4c48d0b5ffc346cccaed178a6e9137d6cd681f538beaf129d449070b44806966c27ea585d112
+  data.tar.gz: 23c9ea04e2d39447a0aaae56f215e3d6cce59c0c67187ba7a9ca18e509e1cbf22dd8dbd52007f4131880a1f97f9fea23e29892f491d5351f39f7b62019afe921

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+on: push
+name: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        elasticsearch:
+        - plainpicture/elasticsearch:2.4.1_delete-by-query
+        - elasticsearch:5.4
+        - docker.elastic.co/elasticsearch/elasticsearch:6.7.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.9.0
+        ruby:
+        - 2.5
+        - 2.6
+        - 2.7
+    services:
+      elasticsearch:
+        image: ${{ matrix.elasticsearch }}
+        env:
+          discovery.type: single-node
+        ports:
+          - 9200:9200
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle
+    - run: sleep 10
+    - run: bundle exec rspec
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,5 +1,15 @@
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.4
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: false
 
 Style/HashTransformValues:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 
 # CHANGELOG
 
+## v4.0.0
+
+* [BREAKING] For performance reasons, `SearchFlip::Result` now no longer
+  inherits `Hashie::Mash`
+  * It no longer supports symbol based access like `result[:id]`
+  * It no longer supports question mark methods like `result.title?`
+  * It no longer supports method based assignment like `result.some_key = "value"`
+
+## v3.1.2
+
+* Fix ignored false value for source when merging criterias
+
+## v3.1.1
+
+* Make `SearchFlip::Result.from_hit` work with the `_source` being disabled
+
+## v3.1.0
+
+* Added plugin support in `SearchFlip::HTTPClient`
+* Added `SearchFlip::AwsSigv4Plugin` to be able to use AWS Elasticsearch with
+  signed requests
+
 ## v3.0.0
 
 * Added `Criteria#to_query`, which returns a raw query including all queries

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 (http-rb and oj only).
 
 ## Reference Docs
 
@@ -475,8 +474,8 @@ end
 ```
 
 Generally, aggregation results returned by Elasticsearch are returned as a
-`SearchFlip::Result`, which basically is `Hashie::Mash`such that you can access
-them via:
+`SearchFlip::Result`, which basically is a Hash with method-like access, such
+that you can access them via:
 
 ```ruby
 query.aggregations(:username)["mrkamel"].revenue.value
@@ -769,6 +768,41 @@ http_client = http_client.headers(key: "value")
 SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 ```
 
+## AWS Elasticsearch / Signed Requests
+
+To use SearchFlip with AWS Elasticsearch and signed requests, you have to add
+`aws-sdk-core` to your Gemfile and tell SearchFlip to use the
+`SearchFlip::AwsSigv4Plugin`:
+
+```ruby
+require "search_flip/aws_sigv4_plugin"
+
+MyConnection = SearchFlip::Connection.new(
+  base_url: "https://your-elasticsearch-cluster.es.amazonaws.com",
+  http_client: SearchFlip::HTTPClient.new(
+    plugins: [
+      SearchFlip::AwsSigv4Plugin.new(
+        region: "...",
+        access_key_id: "...",
+        secret_access_key: "..."
+      )
+    ]
+  )
+)
+```
+
+Again, in your index you need to specify this connection:
+
+```ruby
+class MyIndex
+  include SearchFlip::Index
+
+  def self.connection
+    MyConnection
+  end
+end
+```
+
 ## Routing and other index-time options
 
 Override `index_options` in case you want to use routing or pass other
@@ -914,6 +948,10 @@ It uses `after_commit` (if applicable, `after_save`, `after_destroy` and
 `after_touch` otherwise) hooks to synchronously update the index when your
 model changes.
 
+## Semantic Versioning
+
+SearchFlip is using Semantic Versioning: [SemVer](http://semver.org/)
+
 ## Links
 
 * Elasticsearch: [https://www.elastic.co/](https://www.elastic.co/)
@@ -945,5 +983,4 @@ $ rspec
 
 That's it.
 
-
 [Bulk API]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

data/UPDATING.md

@@ -1,6 +1,46 @@
 
 # Updating from previous SearchFlip versions
 
+## Update 3.x to 4.x
+
+**[BREAKING]** For performance reasons, `SearchFlip::Result` no longer
+inherits `Hashie::Mash`
+
+* It no longer supports symbol based access like `result[:id]`
+
+2.x:
+
+```ruby
+CommentIndex.match_all.results.first[:id]
+CommentIndex.aggregate(:tags).aggregations(:tags).values.first[:doc_count]
+```
+
+3.x
+
+```ruby
+CommentIndex.match_all.results.first["id"] # or .id
+CommentIndex.aggregate(:tags).aggregations(:tags).values.first["doc_count"] # or .doc_count
+```
+
+* It no longer supports question mark methods like `result.title?`
+
+2.x:
+
+```ruby
+CommentIndex.match_all.results.first.is_published?
+```
+
+3.x
+
+```ruby
+CommentIndex.match_all.results.first.is_published == true
+```
+
+* It no longer supports method based assignment like `result.some_key = "value"`.
+
+However, this should not have any practical implications, as changing the
+results is not considered to be a common use case.
+
 ## Update 2.x to 3.x
 
 * **[BREAKING]**  No longer pass multiple arguments to `#must`, `#must_not`,

data/lib/search_flip.rb

@@ -1,7 +1,6 @@
 require "ruby2_keywords"
 require "forwardable"
 require "http"
-require "hashie"
 require "thread"
 require "oj"
 require "set"
@@ -39,6 +38,8 @@ module SearchFlip
     attr_reader :code, :body
 
     def initialize(code:, body:)
+      super
+
       @code = code
       @body = body
     end

data/lib/search_flip/aggregation.rb

@@ -40,7 +40,7 @@ module SearchFlip
         else
           filters = (filter_values || []) + (must_not_values || []).map { |must_not_value| { not: must_not_value } }
           queries = must_values ? { must: must_values } : {}
-          filters_and_queries = filters + (queries.size > 0 ? [bool: queries] : [])
+          filters_and_queries = filters + (queries.size > 0 ? [{ bool: queries }] : [])
 
           res[:filter] = filters_and_queries.size > 1 ? { and: filters_and_queries } : filters_and_queries.first
         end
@@ -101,7 +101,7 @@ module SearchFlip
     end
 
     def respond_to_missing?(name, *args)
-      target.respond_to?(name, *args)
+      target.respond_to?(name, *args) || super
     end
 
     def method_missing(name, *args, &block)

data/lib/search_flip/aws_sigv4_plugin.rb

@@ -0,0 +1,47 @@
+require "aws-sdk-core"
+require "uri"
+
+module SearchFlip
+  # The SearchFlip::AwsSigV4Plugin is a plugin for the SearchFlip::HTTPClient
+  # to be used with AWS Elasticsearch to sign requests, i.e. add signed
+  # headers, before sending the request to Elasticsearch.
+  #
+  # @example
+  #   MyConnection = SearchFlip::Connection.new(
+  #     base_url: "https://your-elasticsearch-cluster.es.amazonaws.com",
+  #     http_client: SearchFlip::HTTPClient.new(
+  #       plugins: [
+  #         SearchFlip::AwsSigv4Plugin.new(
+  #           region: "...",
+  #           access_key_id: "...",
+  #           secret_access_key: "..."
+  #         )
+  #       ]
+  #     )
+  #   )
+
+  class AwsSigv4Plugin
+    attr_accessor :signer
+
+    def initialize(options = {})
+      self.signer = Aws::Sigv4::Signer.new({ service: "es" }.merge(options))
+    end
+
+    def call(request, method, uri, options = {})
+      full_uri = URI.parse(uri)
+      full_uri.query = URI.encode_www_form(options[:params]) if options[:params]
+
+      signature_request = {
+        http_method: method.to_s.upcase,
+        url: full_uri.to_s
+      }
+
+      signature_request[:body] = options[:body] if options.key?(:body)
+      signature_request[:body] = options[:json].respond_to?(:to_str) ? options[:json] : JSON.generate(options[:json]) if options[:json]
+
+      signature = signer.sign_request(signature_request)
+
+      request.headers(signature.headers)
+    end
+  end
+end

data/lib/search_flip/connection.rb

@@ -71,7 +71,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

data/lib/search_flip/criteria.rb

@@ -44,35 +44,25 @@ module SearchFlip
       other = other.criteria
 
       fresh.tap do |criteria|
-        criteria.profile_value = other.profile_value unless other.profile_value.nil?
-        criteria.failsafe_value = other.failsafe_value unless other.failsafe_value.nil?
-        criteria.terminate_after_value = other.terminate_after_value unless other.terminate_after_value.nil?
-        criteria.timeout_value = other.timeout_value unless other.timeout_value.nil?
-        criteria.offset_value = other.offset_value if other.offset_value
-        criteria.limit_value = other.limit_value if other.limit_value
-        criteria.scroll_args = other.scroll_args if other.scroll_args
-        criteria.source_value = other.source_value if other.source_value
-        criteria.preference_value = other.preference_value if other.preference_value
-        criteria.search_type_value = other.search_type_value if other.search_type_value
-        criteria.routing_value = other.routing_value if other.routing_value
-        criteria.track_total_hits_value = other.track_total_hits_value unless other.track_total_hits_value.nil?
-        criteria.explain_value = other.explain_value unless other.explain_value.nil?
-
-        criteria.sort_values = (criteria.sort_values || []) + other.sort_values if other.sort_values
-        criteria.includes_values = (criteria.includes_values || []) + other.includes_values if other.includes_values
-        criteria.preload_values = (criteria.preload_values || []) + other.preload_values if other.preload_values
-        criteria.eager_load_values = (criteria.eager_load_values || []) + other.eager_load_values if other.eager_load_values
-        criteria.must_values = (criteria.must_values || []) + other.must_values if other.must_values
-        criteria.must_not_values = (criteria.must_not_values || []) + other.must_not_values if other.must_not_values
-        criteria.filter_values = (criteria.filter_values || []) + other.filter_values if other.filter_values
-        criteria.post_must_values = (criteria.post_must_values || []) + other.post_must_values if other.post_must_values
-        criteria.post_must_not_values = (criteria.post_must_not_values || []) + other.post_must_not_values if other.post_must_not_values
-        criteria.post_filter_values = (criteria.post_filter_values || []) + other.post_filter_values if other.post_filter_values
-
-        criteria.highlight_values = (criteria.highlight_values || {}).merge(other.highlight_values) if other.highlight_values
-        criteria.suggest_values = (criteria.suggest_values || {}).merge(other.suggest_values) if other.suggest_values
-        criteria.custom_value = (criteria.custom_value || {}).merge(other.custom_value) if other.custom_value
-        criteria.aggregation_values = (criteria.aggregation_values || {}).merge(other.aggregation_values) if other.aggregation_values
+        [
+          :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value,
+          :limit_value, :scroll_args, :source_value, :preference_value, :search_type_value,
+          :routing_value, :track_total_hits_value, :explain_value
+        ].each do |name|
+          criteria.send(:"#{name}=", other.send(name)) unless other.send(name).nil?
+        end
+
+        [
+          :sort_values, :includes_values, :preload_values, :eager_load_values, :must_values,
+          :must_not_values, :filter_values, :post_must_values, :post_must_not_values,
+          :post_filter_values
+        ].each do |name|
+          criteria.send(:"#{name}=", (criteria.send(name) || []) + other.send(name)) if other.send(name)
+        end
+
+        [:highlight_values, :suggest_values, :custom_value, :aggregation_values].each do |name|
+          criteria.send(:"#{name}=", (criteria.send(name) || {}).merge(other.send(name))) if other.send(name)
+        end
       end
     end
 
@@ -576,7 +566,7 @@ module SearchFlip
     end
 
     def respond_to_missing?(name, *args)
-      target.respond_to?(name, *args)
+      target.respond_to?(name, *args) || super
     end
 
     def method_missing(name, *args, &block)
@@ -618,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/highlightable.rb

@@ -34,9 +34,10 @@ module SearchFlip
         criteria.highlight_values = (criteria.highlight_values || {}).merge(options)
 
         hash =
-          if fields.is_a?(Hash)
+          case fields
+          when Hash
             fields
-          elsif fields.is_a?(Array)
+          when Array
             fields.each_with_object({}) { |field, h| h[field] = {} }
           else
             { fields => {} }

data/lib/search_flip/http_client.rb

@@ -1,15 +1,14 @@
 module SearchFlip
-  # @api private
-  #
   # The SearchFlip::HTTPClient class wraps the http gem, is for internal use
   # and responsible for the http request/response handling, ie communicating
   # with Elasticsearch.
 
   class HTTPClient
-    attr_accessor :request
+    attr_accessor :request, :plugins
 
-    def initialize
+    def initialize(plugins: [])
       self.request = HTTP
+      self.plugins = plugins
     end
 
     class << self
@@ -30,17 +29,16 @@ module SearchFlip
     end
 
     [:get, :post, :put, :delete, :head].each do |method|
-      define_method(method) do |*args|
-        execute(method, *args)
+      define_method(method) do |uri, options = {}|
+        execute(method, uri, options)
       end
-
-      ruby2_keywords method
     end
 
     private
 
-    ruby2_keywords def execute(method, *args)
-      response = request.send(method, *args)
+    def execute(method, uri, options = {})
+      final_request = plugins.inject(self) { |res, cur| cur.call(res, method, uri, options) }
+      response = final_request.request.send(method, uri, options)
 
       raise SearchFlip::ResponseError.new(code: response.code, body: response.body.to_s) unless response.status.success?
 

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

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, mode: :custom, use_to_json: true)
     end
 
-    def self.generate(obj)
-      Oj.dump(obj, default_options)
+    def self.parse(str)
+      Oj.load(str, mode: :compat)
     end
   end
 end

data/lib/search_flip/response.rb

@@ -156,8 +156,7 @@ module SearchFlip
     end
 
     # Returns the results, ie hits, wrapped in a SearchFlip::Result object
-    # which basically is a Hashie::Mash. Check out the Hashie docs for further
-    # details.
+    # which basically is a Hash with method-like access.
     #
     # @example
     #   CommentIndex.search("hello world").results
@@ -166,7 +165,7 @@ module SearchFlip
     # @return [Array] An array of results
 
     def results
-      @results ||= hits["hits"].map { |hit| Result.from_hit(hit) }
+      @results ||= hits["hits"].map { |hit| SearchFlip::Result.from_hit(hit) }
     end
 
     # Returns the named sugggetion, if a name is specified or alle suggestions.
@@ -304,13 +303,13 @@ module SearchFlip
 
       @aggregations[key] =
         if response["aggregations"].nil? || response["aggregations"][key].nil?
-          Result.new
+          SearchFlip::Result.new
         elsif response["aggregations"][key]["buckets"].is_a?(Array)
-          response["aggregations"][key]["buckets"].each_with_object({}) { |bucket, hash| hash[bucket["key"]] = Result.new(bucket) }
+          response["aggregations"][key]["buckets"].each_with_object({}) { |bucket, hash| hash[bucket["key"]] = SearchFlip::Result.convert(bucket) }
         elsif response["aggregations"][key]["buckets"].is_a?(Hash)
-          Result.new response["aggregations"][key]["buckets"]
+          SearchFlip::Result.convert(response["aggregations"][key]["buckets"])
         else
-          Result.new response["aggregations"][key]
+          SearchFlip::Result.convert(response["aggregations"][key])
         end
     end
   end

data/lib/search_flip/result.rb

@@ -1,29 +1,55 @@
 module SearchFlip
-  # The SearchFlip::Result class basically is a hash wrapper that uses
-  # Hashie::Mash to provide convenient method access to the hash attributes.
+  # The SearchFlip::Result class is a simple Hash, but extended with
+  # method-like access. Keys assigned via methods are stored as strings.
+  #
+  # @example method access
+  #   result = SearchFlip::Result.new
+  #   result["some_key"] = "value"
+  #   result.some_key # => "value"
 
-  class Result < Hashie::Mash
-    def self.disable_warnings?(*args)
-      true
-    end
+  class Result < Hash
+    def self.convert(hash)
+      res = self[hash]
 
-    # Creates a SearchFlip::Result object from a raw hit. Useful for e.g.
-    # top hits aggregations.
-    #
-    # @example
-    #   query = ProductIndex.aggregate(top_sales: { top_hits: "..." })
-    #   top_sales_hits = query.aggregations(:top_sales).top_hits.hits.hits
-    #
-    #   SearchFlip::Result.from_hit(top_sales_hits.first)
+      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
 
-    def self.from_hit(hit)
-      raw_result = hit["_source"].dup
+      res
+    end
 
-      raw_result["_hit"] = hit.each_with_object({}) do |(key, value), hash|
-        hash[key] = value if key != "_source"
+    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
+
+    # rubocop:disable Lint/MissingSuper
 
-      new(raw_result)
+    def method_missing(name, *args, &block)
+      self[name.to_s]
+    end
+
+    # rubocop:enable Lint/MissingSuper
+
+    def respond_to_missing?(name, include_private = false)
+      key?(name.to_s) || super
+    end
+
+    def self.from_hit(hit)
+      res = convert(hit["_source"] || {})
+      res["_hit"] = convert(self[hit].tap { |hash| hash.delete("_source") })
+      res
     end
   end
 end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0"
+  VERSION = "4.0.0.beta1"
 end

data/search_flip.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = <<~MESSAGE
     Thanks for using search_flip!
-    When upgrading to 3.x, please check out
+    When upgrading major versions, please check out
     https://github.com/mrkamel/search_flip/blob/master/UPDATING.md
   MESSAGE
 
   spec.add_development_dependency "activerecord", ">= 3.0"
+  spec.add_development_dependency "aws-sdk-core"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "rake"
@@ -34,7 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "hashie"
   spec.add_dependency "http"
   spec.add_dependency "oj"
   spec.add_dependency "ruby2_keywords"

data/spec/search_flip/aggregation_spec.rb

@@ -15,7 +15,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.where(title: "title").where(description: "description").aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -36,7 +36,7 @@ RSpec.describe SearchFlip::Aggregation do
           .aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -54,7 +54,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.where(title: "title1".."title3").where(price: 100..200).aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -74,7 +74,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.where_not(title: "title4").where_not(title: "title5").aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -94,7 +94,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.where_not(title: ["title1", "title2"]).where_not(title: ["title6", "title7"]).aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -114,7 +114,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.where_not(price: 100..150).where_not(title: "title6".."title7").aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -134,7 +134,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.filter(range: { price: { gte: 100, lte: 200 } }).filter(term: { title: "title" }).aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -156,7 +156,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.range(:price, gte: 100, lte: 200).range(:title, gte: "title1", lte: "title3").aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -174,7 +174,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.match_all.aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -194,7 +194,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.exists(:title).exists(:price).aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -214,7 +214,7 @@ RSpec.describe SearchFlip::Aggregation do
         aggregation.exists_not(:title).exists_not(:price).aggregate(:category)
       end
 
-      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket[:key]] = bucket.doc_count }
+      aggregations = query.aggregations(:category).category.buckets.each_with_object({}) { |bucket, hash| hash[bucket["key"]] = bucket.doc_count }
 
       expect(aggregations).to eq("category1" => 2, "category2" => 1)
     end
@@ -244,21 +244,21 @@ RSpec.describe SearchFlip::Aggregation do
       expect(aggregations).to eq("category1" => 3, "category2" => 3)
 
       aggregations = query.aggregations(:category)["category1"].title.buckets.each_with_object({}) do |bucket, hash|
-        hash[bucket[:key]] = bucket.doc_count
+        hash[bucket["key"]] = bucket.doc_count
       end
 
       expect(aggregations).to eq("title1" => 2, "title2" => 1)
 
       aggregations = query.aggregations(:category)["category2"].title.buckets.each_with_object({}) do |bucket, hash|
-        hash[bucket[:key]] = bucket.doc_count
+        hash[bucket["key"]] = bucket.doc_count
       end
 
       expect(aggregations).to eq("title1" => 1, "title2" => 2)
 
-      expect(query.aggregations(:category)["category1"].title.buckets.detect { |bucket| bucket[:key] == "title1" }.price.value).to eq(30)
-      expect(query.aggregations(:category)["category1"].title.buckets.detect { |bucket| bucket[:key] == "title2" }.price.value).to eq(15)
-      expect(query.aggregations(:category)["category2"].title.buckets.detect { |bucket| bucket[:key] == "title1" }.price.value).to eq(30)
-      expect(query.aggregations(:category)["category2"].title.buckets.detect { |bucket| bucket[:key] == "title2" }.price.value).to eq(60)
+      expect(query.aggregations(:category)["category1"].title.buckets.detect { |bucket| bucket["key"] == "title1" }.price.value).to eq(30)
+      expect(query.aggregations(:category)["category1"].title.buckets.detect { |bucket| bucket["key"] == "title2" }.price.value).to eq(15)
+      expect(query.aggregations(:category)["category2"].title.buckets.detect { |bucket| bucket["key"] == "title1" }.price.value).to eq(30)
+      expect(query.aggregations(:category)["category2"].title.buckets.detect { |bucket| bucket["key"] == "title2" }.price.value).to eq(60)
     end
   end
 

data/spec/search_flip/aws_sigv4_plugin_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path("../spec_helper", __dir__)
+require "search_flip/aws_sigv4_plugin"
+
+RSpec.describe SearchFlip::AwsSigv4Plugin do
+  describe "#call" do
+    subject(:plugin) do
+      SearchFlip::AwsSigv4Plugin.new(
+        region: "us-east-1",
+        access_key_id: "access key",
+        secret_access_key: "secret access key"
+      )
+    end
+
+    let(:client) { SearchFlip::HTTPClient.new }
+
+    it "adds the signed headers to the request" do
+      Timecop.freeze Time.parse("2020-01-01 12:00:00 UTC") do
+        expect(client).to receive(:headers).with(
+          "host" => "localhost",
+          "authorization" => /.*/,
+          "x-amz-content-sha256" => /.*/,
+          "x-amz-date" => /20200101T120000Z/
+        )
+
+        plugin.call(client, :get, "http://localhost/index")
+      end
+    end
+
+    it "feeds the http method, full url and body to the signer" do
+      signing_request = {
+        http_method: "GET",
+        url: "http://localhost/index?param=value",
+        body: JSON.generate(key: "value")
+      }
+
+      expect(plugin.signer).to receive(:sign_request).with(signing_request).and_call_original
+
+      plugin.call(client, :get, "http://localhost/index", params: { param: "value" }, json: { key: "value" })
+    end
+  end
+end

data/spec/search_flip/connection_spec.rb

@@ -36,10 +36,10 @@ RSpec.describe SearchFlip::Connection do
     it "changes the aliases" do
       connection = SearchFlip::Connection.new
 
-      connection.update_aliases(actions: [add: { index: "products", alias: "alias1" }])
+      connection.update_aliases(actions: [{ add: { index: "products", alias: "alias1" } }])
       expect(connection.get_aliases(alias_name: "alias1").keys).to eq(["products"])
 
-      connection.update_aliases(actions: [remove: { index: "products", alias: "alias1" }])
+      connection.update_aliases(actions: [{ remove: { index: "products", alias: "alias1" } }])
       expect(connection.alias_exists?("alias1")).to eq(false)
     end
   end
@@ -79,11 +79,11 @@ RSpec.describe SearchFlip::Connection do
 
         expect(connection.alias_exists?(:some_alias)).to eq(false)
 
-        connection.update_aliases(actions: [add: { index: "products", alias: "some_alias" }])
+        connection.update_aliases(actions: [{ add: { index: "products", alias: "some_alias" } }])
 
         expect(connection.alias_exists?(:some_alias)).to eq(true)
       ensure
-        connection.update_aliases(actions: [remove: { index: "products", alias: "some_alias" }])
+        connection.update_aliases(actions: [{ remove: { index: "products", alias: "some_alias" } }])
       end
     end
   end

data/spec/search_flip/criteria_spec.rb

@@ -110,6 +110,16 @@ RSpec.describe SearchFlip::Criteria do
 
           expect(criteria1.merge(criteria2).send(method)).to eq("value2")
         end
+
+        it "handles false values correctly" do
+          criteria1 = SearchFlip::Criteria.new(target: TestIndex)
+          criteria1.send("#{method}=", true)
+
+          criteria2 = SearchFlip::Criteria.new(target: TestIndex)
+          criteria2.send("#{method}=", false)
+
+          expect(criteria1.merge(criteria2).send(method)).to eq(false)
+        end
       end
     end
 
@@ -1291,7 +1301,7 @@ RSpec.describe SearchFlip::Criteria do
       ProductIndex.import create(:product)
 
       query = ProductIndex.match_all.explain(true)
-      expect(query.results.first._hit.key?(:_explanation)).to eq(true)
+      expect(query.results.first._hit.key?("_explanation")).to eq(true)
     end
   end
 

data/spec/search_flip/http_client_spec.rb

@@ -39,6 +39,23 @@ RSpec.describe SearchFlip::HTTPClient do
     end
   end
 
+  describe "plugins" do
+    subject do
+      SearchFlip::HTTPClient.new(
+        plugins: [
+          ->(request, _method, _uri, _options = {}) { request.headers("First-Header" => "Value") },
+          ->(request, _method, _uri, _options = {}) { request.headers("Second-Header" => "Value") }
+        ]
+      )
+    end
+
+    it "injects the plugins and uses their result in the request" do
+      stub_request(:get, "http://localhost/path").with(query: { key: "value" }, headers: { "First-Header" => "Value", "Second-Header" => "Value" }).and_return(body: "success")
+
+      expect(subject.get("http://localhost/path", params: { key: "value" }).body.to_s).to eq("success")
+    end
+  end
+
   [:via, :basic_auth, :auth].each do |method|
     describe "##{method}" do
       it "creates a dupped instance" do

data/spec/search_flip/json_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::JSON do
+  describe ".generate" do
+    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)
+    end
+
+    it "generates json" do
+      expect(described_class.generate(key: "value")).to eq('{"key":"value"}')
+    end
+  end
+
+  describe ".parse" do
+    it "delegates to Oj" do
+      allow(Oj).to receive(:load)
+
+      payload = '{"key":"value"}'
+
+      described_class.parse(payload)
+
+      expect(Oj).to have_received(:load).with(payload, mode: :compat)
+    end
+  end
+end

data/spec/search_flip/result_spec.rb

@@ -1,6 +1,29 @@
 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.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)
+    end
+  end
+
   describe ".from_hit" do
     it "adds a _hit key into _source and merges the hit keys into it" do
       result = SearchFlip::Result.from_hit("_score" => 1.0, "_source" => { "name" => "Some name" })
@@ -8,10 +31,10 @@ RSpec.describe SearchFlip::Result do
       expect(result).to eq("name" => "Some name", "_hit" => { "_score" => 1.0 })
     end
 
-    it "allows deep method access" do
-      result = SearchFlip::Result.from_hit("_source" => { "key1" => [{ "key2" => "value" }] })
+    it "works with the _source being disabled" do
+      result = SearchFlip::Result.from_hit("_id" => 1)
 
-      expect(result.key1[0].key2).to eq("value")
+      expect(result._hit._id).to eq(1)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0.beta1
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,13 +137,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -199,9 +199,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -212,6 +212,7 @@ files:
 - lib/search_flip.rb
 - lib/search_flip/aggregatable.rb
 - lib/search_flip/aggregation.rb
+- lib/search_flip/aws_sigv4_plugin.rb
 - lib/search_flip/bulk.rb
 - lib/search_flip/config.rb
 - lib/search_flip/connection.rb
@@ -238,11 +239,13 @@ files:
 - search_flip.gemspec
 - spec/delegate_matcher.rb
 - spec/search_flip/aggregation_spec.rb
+- spec/search_flip/aws_sigv4_plugin_spec.rb
 - spec/search_flip/bulk_spec.rb
 - spec/search_flip/connection_spec.rb
 - 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
@@ -255,7 +258,7 @@ licenses:
 metadata: {}
 post_install_message: |
   Thanks for using search_flip!
-  When upgrading to 3.x, please check out
+  When upgrading major versions, please check out
   https://github.com/mrkamel/search_flip/blob/master/UPDATING.md
 rdoc_options: []
 require_paths:
@@ -267,9 +270,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -278,11 +281,13 @@ summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
 test_files:
 - spec/delegate_matcher.rb
 - spec/search_flip/aggregation_spec.rb
+- spec/search_flip/aws_sigv4_plugin_spec.rb
 - spec/search_flip/bulk_spec.rb
 - spec/search_flip/connection_spec.rb
 - 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

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-env:
-  - ES_IMAGE=plainpicture/elasticsearch:2.4.1_delete-by-query
-  - ES_IMAGE=elasticsearch:5.4
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.7.0
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.0.0
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.6.0
-rvm:
-  - ruby-2.5.3
-  - ruby-2.6.2
-  - ruby-2.7.1
-before_install:
-  - docker-compose up -d
-  - sleep 10
-install:
-  - travis_retry bundle install
-script:
- - bundle exec rspec
- - bundle exec rubocop