search_flip 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa160794662cedbe89066113cb845c84daaee29451ba8c8ba4f9183689b42582
-  data.tar.gz: b55133b0f4f90f61db0b76042c1223a17035f277ba221a00c0f665512e1cb170
+  metadata.gz: f4e3ca349bd68555b2826d84c17b192335752947babe02ee51c5501cb04f79ca
+  data.tar.gz: e95021068918513669da2730d613157ad7151995c4a25f532f4274c3a848710f
 SHA512:
-  metadata.gz: eb2e1e1fd39d64639b9a1f542997e6a00c6238226144fbd32f45f0023f93aa827a1c54597fb71f993090c9d78bcb8b92bbac3a5185d584f26cbeb2e1c4b1a641
-  data.tar.gz: caea53f0332131113662b24818268bfd5e3cf537ad04b07b853aba600fc4edd417d1783fd3a1d37fd6d848a75df21ec2e3d39c45a8dafab5fdc515d6f8ca43a9
+  metadata.gz: dcb46f99778d2243e6fb4187f85eb9a1db9aedc25a5f2b8287c3cdb8dcd259253bc3430e1e36521ea5794a2a9188f91473ae8d8572edc8c775ac0d234ac2e284
+  data.tar.gz: 1dbb3ba32c9c2a16f1c2b30aba7257dffc39b708f3e68ec8552c6d6d8ac6a751027a2899a3865051f7d1fdd7a6acd7a1f456eba552c7b50f4c2956292f41d413

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

data/README.md

@@ -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

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

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0"
+  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"

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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 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
@@ -212,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
@@ -238,6 +253,7 @@ 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
@@ -278,6 +294,7 @@ 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