search_flip 3.0.0.beta3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 417bf711946ace4812485ea2efdfefdeb36414e7e8e8d8ed24b10b4807050be9
-  data.tar.gz: c8a9f7392d77f15c4714c40756c032a2bb3bc12c363a9e956a6b9e184c8e4c17
+  metadata.gz: f4e3ca349bd68555b2826d84c17b192335752947babe02ee51c5501cb04f79ca
+  data.tar.gz: e95021068918513669da2730d613157ad7151995c4a25f532f4274c3a848710f
 SHA512:
-  metadata.gz: c62c6d3bc17ec18da5b304dfbddbafc29e35013bcc6b0b906858380b01a263b2e534986cd41f9e90d13de99820f9cbf11a173802910737bf33d8ae5653230af1
-  data.tar.gz: 3b6ee6d16086e451f6f6e6d7c718d6a30c30115d91c6ba9e69113faa19b9abc35d04c8c179dc9ca5ac49418877c0c5828435d71c1dab7b71d4afe2e31da88762
+  metadata.gz: dcb46f99778d2243e6fb4187f85eb9a1db9aedc25a5f2b8287c3cdb8dcd259253bc3430e1e36521ea5794a2a9188f91473ae8d8572edc8c775ac0d234ac2e284
+  data.tar.gz: 1dbb3ba32c9c2a16f1c2b30aba7257dffc39b708f3e68ec8552c6d6d8ac6a751027a2899a3865051f7d1fdd7a6acd7a1f456eba552c7b50f4c2956292f41d413

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  NewCops: enable
+
 Style/HashTransformValues:
   Enabled: false
 

data/.travis.yml

@@ -5,9 +5,11 @@ env:
   - 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.4.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

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # CHANGELOG
 
+## 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
@@ -23,6 +29,11 @@
 * Added `SearchFlip::Result.from_hit`
 * Added support for `source`, `sort`, `page`, `per`, `paginate`, `explain`, and
   `highlight` to aggregations
+* Added support for instrumentation
+
+## v2.3.2
+
+* Remove ruby 2.7 warnings
 
 ## v2.3.1
 

data/README.md

@@ -274,7 +274,7 @@ CommentIndex.create(Comment.first, { bulk_max_mb: 100 }, routing: "routing_key")
 CommentIndex.update(Comment.first, ...)
 ```
 
-Checkout the elasticsearch [Bulk API] docs for more info as well as
+Checkout the Elasticsearch [Bulk API] docs for more info as well as
 [SearchFlip::Bulk](http://www.rubydoc.info/github/mrkamel/search_flip/SearchFlip/Bulk)
 for a complete list of available options to control the bulk indexing of
 SearchFlip.
@@ -475,8 +475,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 `Hashie::Mash`, such that you can
+access them via:
 
 ```ruby
 query.aggregations(:username)["mrkamel"].revenue.value
@@ -769,6 +769,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
@@ -790,6 +825,30 @@ end
 
 These options will be passed whenever records get indexed, deleted, etc.
 
+## Instrumentation
+
+SearchFlip supports instrumentation for request execution via
+`ActiveSupport::Notifications` compatible instrumenters to e.g. allow global
+performance tracing, etc.
+
+To use instrumentation, configure the instrumenter:
+
+```ruby
+SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications.notifier
+```
+
+Subsequently, you can subscribe to notifcations for `request.search_flip`:
+
+```ruby
+ActiveSupport::Notifications.subscribe("request.search_flip") do |name, start, finish, id, payload|
+  payload[:index] # the index class
+  payload[:request] # the request hash sent to Elasticsearch
+  payload[:response] # the SearchFlip::Response object or nil in case of errors
+end
+```
+
+A notification will be send for every request that is sent to Elasticsearch.
+
 ## Non-ActiveRecord models
 
 SearchFlip ships with built-in support for ActiveRecord models, but using

data/lib/search_flip.rb

@@ -1,3 +1,4 @@
+require "ruby2_keywords"
 require "forwardable"
 require "http"
 require "hashie"
@@ -6,6 +7,7 @@ require "oj"
 require "set"
 
 require "search_flip/version"
+require "search_flip/null_instrumenter"
 require "search_flip/helper"
 require "search_flip/exceptions"
 require "search_flip/json"

data/lib/search_flip/aggregatable.rb

@@ -58,10 +58,11 @@ module SearchFlip
           aggregation = yield(SearchFlip::Aggregation.new(target: target))
 
           if field_or_hash.is_a?(Hash)
-            value = field_or_hash.values.first
-            value = value.values.first if value.is_a?(Hash) && !value.empty?
+            aggregation_hash = field_or_hash.values.first
+            aggregation_hash = aggregation_hash[:top_hits] if aggregation_hash.is_a?(Hash) && aggregation_hash.key?(:top_hits)
+            aggregation_hash = aggregation_hash["top_hits"] if aggregation_hash.is_a?(Hash) && aggregation_hash.key?("top_hits")
 
-            value.merge!(aggregation.to_hash)
+            aggregation_hash.merge!(aggregation.to_hash)
           else
             hash[field_or_hash].merge!(aggregation.to_hash)
           end

data/lib/search_flip/aggregation.rb

@@ -73,7 +73,8 @@ module SearchFlip
         unsupported_methods = [
           :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :scroll_args,
           :suggest_values, :includes_values, :preload_values, :eager_load_values, :post_must_values,
-          :post_must_not_values, :post_filter_values, :preference_value, :search_type_value, :routing_value
+          :post_must_not_values, :post_filter_values, :preference_value, :search_type_value,
+          :routing_value
         ]
 
         unsupported_methods.each do |unsupported_method|
@@ -111,6 +112,8 @@ module SearchFlip
       end
     end
 
+    ruby2_keywords :method_missing
+
     # @api private
     #
     # Simply dups the object for api compatability.

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

@@ -77,7 +77,7 @@ module SearchFlip
     #   and versioning
 
     def index(id, object, options = {})
-      perform :index, id, SearchFlip::JSON.generate(object), options
+      perform(:index, id, SearchFlip::JSON.generate(object), options)
     end
 
     # @api private
@@ -86,7 +86,7 @@ module SearchFlip
     #
     # @see #index
 
-    def import(*args)
+    ruby2_keywords def import(*args)
       index(*args)
     end
 
@@ -100,7 +100,7 @@ module SearchFlip
     #   and versioning
 
     def create(id, object, options = {})
-      perform :create, id, SearchFlip::JSON.generate(object), options
+      perform(:create, id, SearchFlip::JSON.generate(object), options)
     end
 
     # @api private
@@ -113,7 +113,7 @@ module SearchFlip
     #   and versioning
 
     def update(id, object, options = {})
-      perform :update, id, SearchFlip::JSON.generate(object), options
+      perform(:update, id, SearchFlip::JSON.generate(object), options)
     end
 
     # @api private
@@ -125,7 +125,7 @@ module SearchFlip
     #   and versioning
 
     def delete(id, options = {})
-      perform :delete, id, nil, options
+      perform(:delete, id, nil, options)
     end
 
     private

data/lib/search_flip/config.rb

@@ -4,6 +4,7 @@ module SearchFlip
     base_url: "http://127.0.0.1:9200",
     bulk_limit: 1_000,
     bulk_max_mb: 100,
-    auto_refresh: false
+    auto_refresh: false,
+    instrumenter: NullInstrumenter.new
   }
 end

data/lib/search_flip/criteria.rb

@@ -206,7 +206,7 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] Simply returns self
 
-    def with_settings(*args)
+    ruby2_keywords def with_settings(*args)
       fresh.tap do |criteria|
         criteria.target = target.with_settings(*args)
       end
@@ -219,45 +219,47 @@ module SearchFlip
     # @return [Hash] The generated request object
 
     def request
-      res = {}
-
-      if must_values || must_not_values || filter_values
-        res[:query] = {
-          bool: {
-            must: must_values.to_a,
-            must_not: must_not_values.to_a,
-            filter: filter_values.to_a
-          }.reject { |_, value| value.empty? }
-        }
-      end
+      @request ||= begin
+        res = {}
+
+        if must_values || must_not_values || filter_values
+          res[:query] = {
+            bool: {
+              must: must_values.to_a,
+              must_not: must_not_values.to_a,
+              filter: filter_values.to_a
+            }.reject { |_, value| value.empty? }
+          }
+        end
 
-      res.update(from: offset_value_with_default, size: limit_value_with_default)
-
-      res[:track_total_hits] = track_total_hits_value unless track_total_hits_value.nil?
-      res[:explain] = explain_value unless explain_value.nil?
-      res[:timeout] = timeout_value if timeout_value
-      res[:terminate_after] = terminate_after_value if terminate_after_value
-      res[:highlight] = highlight_values if highlight_values
-      res[:suggest] = suggest_values if suggest_values
-      res[:sort] = sort_values if sort_values
-      res[:aggregations] = aggregation_values if aggregation_values
-
-      if post_must_values || post_must_not_values || post_filter_values
-        res[:post_filter] = {
-          bool: {
-            must: post_must_values.to_a,
-            must_not: post_must_not_values.to_a,
-            filter: post_filter_values.to_a
-          }.reject { |_, value| value.empty? }
-        }
-      end
+        res.update(from: offset_value_with_default, size: limit_value_with_default)
+
+        res[:track_total_hits] = track_total_hits_value unless track_total_hits_value.nil?
+        res[:explain] = explain_value unless explain_value.nil?
+        res[:timeout] = timeout_value if timeout_value
+        res[:terminate_after] = terminate_after_value if terminate_after_value
+        res[:highlight] = highlight_values if highlight_values
+        res[:suggest] = suggest_values if suggest_values
+        res[:sort] = sort_values if sort_values
+        res[:aggregations] = aggregation_values if aggregation_values
+
+        if post_must_values || post_must_not_values || post_filter_values
+          res[:post_filter] = {
+            bool: {
+              must: post_must_values.to_a,
+              must_not: post_must_not_values.to_a,
+              filter: post_filter_values.to_a
+            }.reject { |_, value| value.empty? }
+          }
+        end
 
-      res[:_source] = source_value unless source_value.nil?
-      res[:profile] = true if profile_value
+        res[:_source] = source_value unless source_value.nil?
+        res[:profile] = true if profile_value
 
-      res.update(custom_value) if custom_value
+        res.update(custom_value) if custom_value
 
-      res
+        res
+      end
     end
 
     # Adds a suggestion section with the given name to the request.
@@ -520,30 +522,13 @@ module SearchFlip
 
     def execute
       @response ||= begin
-        http_request = connection.http_client.headers(accept: "application/json")
-
-        http_response =
-          if scroll_args && scroll_args[:id]
-            http_request.post(
-              "#{connection.base_url}/_search/scroll",
-              params: request_params,
-              json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
-            )
-          elsif scroll_args
-            http_request.post(
-              "#{target.type_url}/_search",
-              params: request_params.merge(scroll: scroll_args[:timeout]),
-              json: request
-            )
-          else
-            http_request.post("#{target.type_url}/_search", params: request_params, json: request)
-          end
-
-        SearchFlip::Response.new(self, http_response.parse)
-      rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
-        raise e unless failsafe_value
-
-        SearchFlip::Response.new(self, "took" => 0, "hits" => { "total" => 0, "hits" => [] })
+        Config[:instrumenter].instrument("request.search_flip", index: target, request: request) do |payload|
+          response = execute!
+
+          payload[:response] = response
+
+          response
+        end
       end
     end
 
@@ -585,6 +570,7 @@ module SearchFlip
 
     def fresh
       dup.tap do |criteria|
+        criteria.instance_variable_set(:@request, nil)
         criteria.instance_variable_set(:@response, nil)
       end
     end
@@ -601,6 +587,8 @@ module SearchFlip
       end
     end
 
+    ruby2_keywords :method_missing
+
     def_delegators :response, :total_entries, :total_count, :current_page, :previous_page,
       :prev_page, :next_page, :first_page?, :last_page?, :out_of_range?, :total_pages,
       :hits, :ids, :count, :size, :length, :took, :aggregations, :suggestions,
@@ -610,6 +598,33 @@ module SearchFlip
 
     private
 
+    def execute!
+      http_request = connection.http_client.headers(accept: "application/json")
+
+      http_response =
+        if scroll_args && scroll_args[:id]
+          http_request.post(
+            "#{connection.base_url}/_search/scroll",
+            params: request_params,
+            json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
+          )
+        elsif scroll_args
+          http_request.post(
+            "#{target.type_url}/_search",
+            params: request_params.merge(scroll: scroll_args[:timeout]),
+            json: request
+          )
+        else
+          http_request.post("#{target.type_url}/_search", params: request_params, json: request)
+        end
+
+      SearchFlip::Response.new(self, http_response.parse)
+    rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
+      raise e unless failsafe_value
+
+      SearchFlip::Response.new(self, "took" => 0, "hits" => { "total" => 0, "hits" => [] })
+    end
+
     def yield_in_batches(options = {})
       return enum_for(:yield_in_batches, options) unless block_given?
 

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
@@ -25,18 +24,21 @@ module SearchFlip
           client.request = request.send(method, *args)
         end
       end
+
+      ruby2_keywords method
     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
     end
 
     private
 
-    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

@@ -498,7 +498,7 @@ module SearchFlip
       #
       # @see #index See #index for more details
 
-      def import(*args)
+      ruby2_keywords def import(*args)
         index(*args)
       end
 

data/lib/search_flip/null_instrumenter.rb

@@ -0,0 +1,21 @@
+module SearchFlip
+  class NullInstrumenter
+    def instrument(name, payload = {})
+      start(name, payload)
+
+      begin
+        yield(payload) if block_given?
+      ensure
+        finish(name, payload)
+      end
+    end
+
+    def start(_name, _payload)
+      true
+    end
+
+    def finish(_name, _payload)
+      true
+    end
+  end
+end

data/lib/search_flip/response.rb

@@ -222,7 +222,7 @@ module SearchFlip
     #
     # @return [Array] An array of database records
 
-    def records(options = {})
+    def records
       @records ||= begin
         sort_map = ids.each_with_index.each_with_object({}) { |(id, index), hash| hash[id.to_s] = index }
 

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0.beta3"
+  VERSION = "3.1.0"
 end

data/search_flip.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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"
@@ -37,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hashie"
   spec.add_dependency "http"
   spec.add_dependency "oj"
+  spec.add_dependency "ruby2_keywords"
 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/criteria_spec.rb

@@ -1198,9 +1198,12 @@ RSpec.describe SearchFlip::Criteria do
 
       query = ProductIndex.criteria.tap(&:records)
 
+      expect(query.instance_variable_get(:@request)).not_to be_nil
       expect(query.instance_variable_get(:@response)).not_to be_nil
 
       expect(query.object_id).not_to eq(query.fresh.object_id)
+
+      expect(query.fresh.instance_variable_get(:@request)).to be_nil
       expect(query.fresh.instance_variable_get(:@response)).to be_nil
     end
   end
@@ -1234,10 +1237,49 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#execute" do
+    around do |example|
+      default_instrumenter = SearchFlip::Config[:instrumenter]
+
+      SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications.instrumenter
+
+      begin
+        example.run
+      ensure
+        SearchFlip::Config[:instrumenter] = default_instrumenter
+      end
+    end
+
+    let(:notifications) { [] }
+
+    let!(:subscriber) do
+      ActiveSupport::Notifications.subscribe("request.search_flip") do |*args|
+        notifications << args
+      end
+    end
+
+    after { ActiveSupport::Notifications.unsubscribe(subscriber) }
+
+    it "instruments the request" do
+      ProductIndex.match_all.execute
+
+      expect(notifications).to be_present
+    end
+
+    it "passes the index, request and response" do
+      ProductIndex.match_all.execute
+
+      expect(notifications.first[4][:index]).to eq(ProductIndex)
+      expect(notifications.first[4][:request]).to be_present
+      expect(notifications.first[4][:response]).to be_present
+    end
+  end
+
   describe "#track_total_hits" do
     it "is added to the request" do
       if ProductIndex.connection.version.to_i >= 7
         query = ProductIndex.track_total_hits(false)
+
         expect(query.request[:track_total_hits]).to eq(false)
         expect { query.execute }.not_to raise_error
       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/null_instrumenter_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::NullInstrumenter do
+  subject { described_class.new }
+
+  describe "#instrument" do
+    it "calls start" do
+      allow(subject).to receive(:start)
+
+      subject.instrument("name", { key: "value" }) {}
+
+      expect(subject).to have_received(:start)
+    end
+
+    it "calls finish" do
+      allow(subject).to receive(:finish)
+
+      subject.instrument("name", { key: "value" }) {}
+
+      expect(subject).to have_received(:finish)
+    end
+
+    it "yields and passes the payload" do
+      yielded_payload = nil
+
+      subject.instrument("name", { key: "value" }) { |payload| yielded_payload = payload }
+
+      expect(yielded_payload).to eq(key: "value")
+    end
+  end
+
+  describe "#start" do
+    it "returns true" do
+      expect(subject.start("name", { key: "value" })).to eq(true)
+    end
+  end
+
+  describe "#finish" do
+    it "returns true" do
+      expect(subject.finish("name", { key: "value" })).to eq(true)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta3
+  version: 3.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  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'
 description: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
 email:
 - vetter@flakks.com
@@ -198,6 +226,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
@@ -212,6 +241,7 @@ files:
 - lib/search_flip/index.rb
 - lib/search_flip/json.rb
 - lib/search_flip/model.rb
+- lib/search_flip/null_instrumenter.rb
 - lib/search_flip/paginatable.rb
 - lib/search_flip/post_filterable.rb
 - lib/search_flip/response.rb
@@ -223,12 +253,14 @@ 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/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
@@ -251,9 +283,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -262,12 +294,14 @@ 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/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