opensearch-aws-sigv4 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c18c127380978f8f6c155763004c09c2f47f8fe510060f78f5e2dd22dfda7d9
-  data.tar.gz: 1bf9b1df47af0b02f6e95950aab3bd51aa107e0d1b70dad9b210c894bcc5074f
+  metadata.gz: 3653f0078c0217fcf752f3a3dbd8f5fb69d528f1792c8f15bab2d227729befc4
+  data.tar.gz: 41e8d376d24bb217f766970265a50c4502d8b7ca6995099619bb5c9051a8e6c4
 SHA512:
-  metadata.gz: 6425d6f4b4925292cca4d1ab444643b40399ce6728b865715537df1c061c776bcb759b9fbd1f5d891a72e78ebf457ec601f4d3e0bb106e151d274a9aadb0e81c
-  data.tar.gz: 0376e3c9a1b67e4885335ecd1a751cd2db67725242f5a09f84cfa905dcbed18b2cbe64043e8ffcbb1b638bc5b71917982be13da6186c6f04cbb9f10f73c18d1f
+  metadata.gz: 65bd6720403fb13d258a21c0e21c28312d57b04346435388f23ddf976e1aedf190abbb7c469b4cacc0c418b0bd29bb7ee700eae59fb58cac388be5e8067eed72
+  data.tar.gz: ae9eb85688027bb1b9de52fc62f5c8a3829d99e8414c397b80486e94f225f3393a47ea7cad47bf2b448247d136c9da0b777408fd6ec927b626dd534794862e37

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-O0H�56�X����=�q�.��Ёl,���1���?F�j����VU؟V���86z��,�v�`U�<>pk�<�R�,�9}�A��
-��!6���S��k��.�"y|C�,�XL���
+�h�jnT߇~ø1o>#���X��.��Q��^����=B/��_o>�2�f���Ɓ�����4���w��VJ�������B�v�]P׸I��C��2�h�t�O��}x3?Z�j���Ȓ��<s��&	�x��<X����|0W�D%�n�v�N��@+.���v�̟�M3��q��E�4g��D��[��l����\Q�Y�q��V��}]L�ݡu�po?�G͕b*u��r�
+	�5�,}��M�Y��n�-�����\K��

data/README.md

@@ -1,102 +1,19 @@
-# OpenSearch Aws Sigv4 Client
+[<img src="OpenSearch.svg" width="400">](https://opensearch.org)
 
-The `opensearch-aws-sigv4` library provides an AWS Sigv4 client for [OpenSearch](http://opensearch.com).
+# OpenSearch AWS Sigv4 Client
 
-## Compatibility
-
-The OpenSearch Aws Sigv4 Client is compatible with Ruby 2.5 and higher.
-
-The client's API is compatible with OpenSearch's API versions from 1.0.0 till current.
-
-See [COMPATIBILITY](../COMPATIBILITY.md) for more details.
-
-## Installation
-
-Install the package from [Rubygems](https://rubygems.org):
-
-    gem install opensearch-aws-sigv4
-
-To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
-
-    gem 'opensearch-aws-sigv4', git: 'git://github.com/opensearch-project/opensearch-ruby.git'
-
-or install it from a source code checkout:
-
-    git clone https://github.com/opensearch-project/opensearch-ruby
-    cd opensearch-ruby/opensearch-aws-sigv4
-    bundle install
-    rake install
-
-## Usage
-
-This library is an AWS Sigv4 wrapper for 
-[`opensearch-ruby`](https://github.com/opensearch-project/opensearch-ruby/tree/main/opensearch-ruby),
-which is a Ruby client for OpenSearch. The `OpenSearch::Aws::Sigv4Client` is, therefore, has all features of `OpenSearch::Client`.
-And since `opensearch-ruby` is a dependency of `opensearch-aws-sigv4`, you only need to install `opensearch-aws-sigv4`.
+The `opensearch-aws-sigv4` library provides an AWS Sigv4 client for connecting to [Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/index.html).
 
-### Amazon Managed OpenSearch
-Via the Sigv4 Client, you can interact with an Amazon Managed OpenSearch cluster just like would with a self-managed cluster:
+This library is an AWS Sigv4 wrapper for [`opensearch-ruby`](https://github.com/opensearch-project/opensearch-ruby/tree/main), which is a Ruby client for OpenSearch. The `OpenSearch::Aws::Sigv4Client`, therefore, has all features of `OpenSearch::Client`.
 
-```ruby
-require 'opensearch-aws-sigv4'
-require 'aws-sigv4'
-
-signer = Aws::Sigv4::Signer.new(service: 'es',
-                                region: 'us-west-2',
-                                access_key_id: 'key_id',
-                                secret_access_key: 'secret')
-
-client = OpenSearch::Aws::Sigv4Client.new(
-  { host: 'https://your.amz-managed-opensearch.domain',
-    log: true }, 
-  signer)
-
-client.cluster.health
-
-client.transport.reload_connections!
-
-client.search q: 'test'
-```
-
-Please refer to [opensearch-ruby](https://github.com/opensearch-project/opensearch-ruby/blob/main/opensearch-ruby/README.md) documentation for further details.
-
-### Amazon OpenSearch Serverless
-You can also use this client to connect to Amazon OpenSearch Serverless (AOSS). Remember to change the service for the signer to `aoss`:
-
-```ruby
-require 'opensearch-aws-sigv4'
-require 'aws-sigv4'
-
-signer = Aws::Sigv4::Signer.new(service: 'aoss',
-                                region: 'us-west-2',
-                                access_key_id: 'key_id',
-                                secret_access_key: 'secret')
-
-client = OpenSearch::Aws::Sigv4Client.new(
-  { host: 'https://your.amz-opensearch-serverless.endpoint',
-    log: true },
-  signer)
-
-index = 'prime'
-client.indices.create(index: index)
-client.index(index: index, id: '1', body: { name: 'Amazon Echo', 
-                                            msrp: '5999', 
-                                            year: 2011 })
-client.search(body: { query: { match: { name: 'Echo' } } })
-client.delete(index: index, id: '1')
-client.indices.delete(index: index)
-
-# Most administrative commands like the ones below will result in a 404 error for AOSS
-client.cluster.stats
-client.cat.health
-```
+## Compatibility
 
-*NOTES:* AOSS does NOT support all API endpoints provided by a standard OpenSearch cluster. Refer to [AOSS Developer's Guide](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-genref.html) for more detail.
+The `opensearch-aws-sigv4` library is compatible with all versions of `opensearch-ruby`.
 
-## Development
+## User Guide
 
-You can run `rake -T` to check the test tasks. Use `COVERAGE=true` before running a test task to check the coverage with Simplecov.
+See [USER_GUIDE](USER_GUIDE.md).
 
 ## License
 
-This software is licensed under the [Apache 2 license](./LICENSE).
+This software is licensed under the [Apache 2 license](LICENSE).

data/USER_GUIDE.md

@@ -0,0 +1,96 @@
+- [User Guide](#user-guide)
+  - [Setup](#setup)
+  - [Usage](#usage)
+    - [Amazon OpenSearch Service](#amazon-opensearch-service)
+    - [Enable Sigv4 Debug Logging](#enable-sigv4-debug-logging)
+# User Guide
+## Setup
+
+To add the gem to your project, install it using [RubyGems](https://rubygems.org/):
+
+```
+gem install opensearch-aws-sigv4
+```
+
+or add it to your Gemfile:
+```
+gem opensearch-aws-sigv4
+```
+and run:
+```
+bundle install
+```
+
+## Usage
+
+This library is an AWS Sigv4 wrapper for [`opensearch-ruby`](https://github.com/opensearch-project/opensearch-ruby/tree/main), which is a Ruby client for OpenSearch. The `OpenSearch::Aws::Sigv4Client`, therefore, has all features of `OpenSearch::Client`.
+
+### Amazon OpenSearch Service
+To sign requests for the Amazon OpenSearch Service:
+
+```ruby
+require 'opensearch-aws-sigv4'
+require 'aws-sigv4'
+
+signer = Aws::Sigv4::Signer.new(service: 'es', # signing service name, use "aoss" for OpenSearch Serverless
+                                region: 'us-west-2', # signing service region
+                                access_key_id: 'key_id',
+                                secret_access_key: 'secret')
+
+client = OpenSearch::Aws::Sigv4Client.new({
+    host: 'https://your.amz-managed-opensearch.domain', # serverless endpoint for OpenSearch Serverless
+    log: true
+}, signer)
+
+# create an index and document
+index = 'prime'
+client.indices.create(index: index)
+client.index(index: index, id: '1', body: { name: 'Amazon Echo', 
+                                            msrp: '5999', 
+                                            year: 2011 })
+
+# search for the document
+client.search(body: { query: { match: { name: 'Echo' } } })
+
+# delete the document
+client.delete(index: index, id: '1')
+
+# delete the index
+client.indices.delete(index: index)
+```
+
+### Enable Sigv4 Debug Logging
+If you run into credentials errors, usually from expired session, set the `sigv4_debug` option to `true` when creating the client to print out the Sigv4 Signing Debug information.
+
+```ruby
+client = OpenSearch::Aws::Sigv4Client.new({
+    host: 'https://your.amz-managed-opensearch.domain',
+}, signer, sigv4_debug: true)
+
+client.info
+```
+
+```shell
+(2023-04-25 11:02:59 -0600)  Sigv4 - STRING TO SIGN: 
+AWS4-HMAC-SHA256
+20230425T170259Z
+20230425/us-east-1/aoss/aws4_request
+0e20bdc5eda484f2b0e65f8a33514c48471500da91b1f0c8bb6b86770b5dc6c4
+
+(2023-04-25 11:02:59 -0600)  Sigv4 - CANONICAL REQUEST:
+GET
+/
+
+host:your.amz-managed-opensearch.domain
+x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+x-amz-date:20230425T170259Z
+
+host;x-amz-content-sha256;x-amz-date
+e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+
+(2023-04-25 11:02:59 -0600)  Sigv4 - SIGNATURE HEADERS:
+{"host"=>"your.amz-managed-opensearch.domain", 
+"x-amz-date"=>"20230425T170259Z", 
+"x-amz-content-sha256"=>"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", 
+"authorization"=>"AWS4-HMAC-SHA256 Credential=ABCDEFGH/20230425/us-east-1/aoss/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=858f171c834231ae3c885c670217f94c68f010e85c50b0ad095444966fb5df0c"}
+```

data/bin/opensearch_sigv4_console

@@ -1,43 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.expand_path('../../opensearch-aws-sigv4/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../opensearch-ruby/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../opensearch-transport/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../opensearch-dsl/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../opensearch-api/lib', __dir__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'opensearch-aws-sigv4'
-
-gems_not_loaded = ['opensearch-dsl'].reject do |gem|
-  begin
-    (require gem) || true
-  rescue LoadError
-    false
-  end
-end
-
-unless gems_not_loaded.empty?
-  warn "The following gems were not loaded: [#{gems_not_loaded.join(', ')}]. Please install and require them explicitly."
-end
-
-include OpenSearch
-include OpenSearch::DSL if defined?(OpenSearch::DSL)
+require 'aws-sigv4'
 
 begin
   require 'pry'
+  Pry.start
 rescue LoadError
-end
-
-begin
   require 'irb'
-rescue LoadError
-end
-
-if defined?(Pry)
-  Pry.config.prompt_name = 'opensearch_sigv4'
-  Pry.start
-elsif defined?(IRB)
   IRB.start
-else
-  abort 'LoadError: opensearch_sigv4_console requires Pry or IRB'
 end

data/lib/opensearch-aws-sigv4/version.rb

@@ -7,10 +7,12 @@
 # Modifications Copyright OpenSearch Contributors. See
 # GitHub history for details.
 
+# frozen_string_literal: true
+
 module OpenSearch
   module Aws
     module Sigv4
-      VERSION = '1.1.0'.freeze
+      VERSION = '1.2.1'
     end
   end
 end

data/lib/opensearch-aws-sigv4.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/FileName
 # SPDX-License-Identifier: Apache-2.0
 #
 # The OpenSearch Contributors require contributions made to
@@ -7,6 +8,8 @@
 # Modifications Copyright OpenSearch Contributors. See
 # GitHub history for details.
 
+# frozen_string_literal: true
+
 require 'opensearch-ruby'
 require 'aws-sigv4/signer'
 require 'faraday'
@@ -39,12 +42,16 @@ module OpenSearch
       # @param [Hash] transport_args arguments for OpenSearch::Transport::Client.
       # @param [&block] block code block to be passed to OpenSearch::Transport::Client.
       # @param [Aws::Sigv4::Signer] sigv4_signer an instance of AWS Sigv4 Signer.
-      def initialize(transport_args = {}, sigv4_signer, &block)
+      # @param [Hash] options
+      # @option options [Boolean] :sigv4_debug whether to log debug info for Sigv4 Signing
+      def initialize(transport_args, sigv4_signer, options: {}, &block)
         unless sigv4_signer.is_a?(::Aws::Sigv4::Signer)
           raise ArgumentError, "Please pass a Aws::Sigv4::Signer. A #{sigv4_signer.class} was given."
         end
 
         @sigv4_signer = sigv4_signer
+        @sigv4_debug = options[:sigv4_debug]
+        @logger = nil
         super(transport_args, &block)
       end
 
@@ -55,9 +62,12 @@ module OpenSearch
           http_method: method,
           url: signature_url(path, params),
           headers: headers,
-          body: signature_body)
+          body: signature_body
+        )
         headers = (headers || {}).merge(signature.headers)
-        super(method, path, params, body, headers)
+
+        log_signature_info(signature)
+        super(method, path, params, signature_body, headers)
       end
 
       private
@@ -68,10 +78,35 @@ module OpenSearch
 
       def signature_url(path, params)
         host = @transport.transport.hosts.dig(0, :host)
-        path = '/' + path unless path.start_with?('/')
-        query_string = params.empty? ? '' : "#{Faraday::Utils::ParamsHash[params].to_query}"
+        path = "/#{path}" unless path.start_with?('/')
+        query_string = params.empty? ? '' : Faraday::Utils::ParamsHash[params].to_query.to_s
         URI::HTTP.build(host: host, path: path, query: query_string)
       end
+
+      # @param [Aws::Sigv4::Signature] signature
+      def log_signature_info(signature)
+        return unless @sigv4_debug
+
+        log('string to sign', signature.string_to_sign)
+        log('canonical request', signature.canonical_request)
+        log('signature headers', signature.headers)
+      end
+
+      def log(title, message)
+        logger.debug("#{title.upcase}:\n\e[36m#{message}\e[0m")
+      end
+
+      def logger
+        return @logger if @logger
+
+        require 'logger'
+        @logger = Logger.new(
+          $stdout,
+          progname: 'Sigv4',
+          formatter: proc { |_severity, datetime, progname, msg| "\e[34m(#{datetime})  #{progname} - #{msg}\e[0m\n\n" }
+        )
+      end
     end
   end
 end
+# rubocop:enable Naming/FileName

data/{.gitignore → lib/opensearch_aws_sigv4.rb}

@@ -7,22 +7,6 @@
 # Modifications Copyright OpenSearch Contributors. See
 # GitHub history for details.
 
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.ruby-version
-.idea/
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+# frozen_string_literal: true
+
+require 'opensearch-aws-sigv4'

data/opensearch-aws-sigv4.gemspec

@@ -7,58 +7,48 @@
 # Modifications Copyright OpenSearch Contributors. See
 # GitHub history for details.
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'opensearch-aws-sigv4/version'
+# frozen_string_literal: true
 
-signing_key_path = File.expand_path("../gem-private_key.pem")
+require_relative 'lib/opensearch-aws-sigv4/version'
 
 Gem::Specification.new do |s|
   s.name          = 'opensearch-aws-sigv4'
   s.version       = OpenSearch::Aws::Sigv4::VERSION
-  s.authors       = ['Theo Truong', 'Robin Roestenburg']
-  s.email         = ['theo.nam.truong@gmail.com', 'robin.roestenburg@4me.com']
-  s.summary       = 'Ruby AWS Sigv4 Client for OpenSearch'
-  s.homepage      = 'https://opensearch.org/docs/latest'
+  s.homepage      = 'https://github.com/opensearch-project/opensearch-ruby-aws-sigv4'
   s.license       = 'Apache-2.0'
+  s.authors       = ['OpenSearch Contributors']
+  s.email         = 'opensearch@amazon.com'
+  s.summary       = 'Ruby AWS Sigv4 Client for OpenSearch'
+  s.description   = <<~DESC
+    A wrapper for opensearch-ruby gem that provides AWS Sigv4 signing.
+    It behaves like OpenSearch::Client, but signs every request with AWS Sigv4
+    using the credentials provided during the client's initialization.
+  DESC
   s.metadata = {
-    'homepage_uri' => 'https://opensearch.org/docs/latest/',
-    'source_code_uri' => 'https://github.com/opensearch-project/opensearch-ruby/tree/main',
-    'bug_tracker_uri' => 'https://github.com/opensearch-project/opensearch-ruby/issues'
+    'homepage_uri'          => 'https://github.com/opensearch-project/opensearch-ruby-aws-sigv4',
+    'documentation_uri'     => 'https://rubydoc.info/gems/opensearch-aws-sigv4/OpenSearch/Aws/Sigv4Client',
+    'source_code_uri'       => 'https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/tree/main',
+    'bug_tracker_uri'       => 'https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/issues',
+    'changelog_uri'         => 'https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/blob/main/CHANGELOG.md'
   }
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.executables   << 'opensearch_sigv4_console'
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-
-  if $PROGRAM_NAME.end_with?("gem") && ARGV == ["build", __FILE__] && File.exist?(signing_key_path)
-    s.signing_key = signing_key_path
-    s.cert_chain  = ['../certs/opensearch-rubygems.pem']
-  end
 
+  s.files         = Dir['lib/**/*', '*.gemspec']
+  s.test_files    = Dir['spec/unit/**/*']
   s.require_paths = ['lib']
-  s.bindir = 'bin'
+  s.bindir        = 'bin'
+  s.executables   = 'opensearch_sigv4_console'
 
-  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
-  s.rdoc_options      = [ '--charset=UTF-8' ]
+  s.extra_rdoc_files  = %w[README.md USER_GUIDE.md LICENSE]
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.required_ruby_version = '>= 2.5'
-
-  s.add_dependency 'aws-sigv4',  '~> 1'
-  s.add_dependency 'opensearch-ruby', '>= 1.0.1'
+  signing_key = File.expand_path('gem-private_key.pem')
+  if $PROGRAM_NAME.end_with?('gem') && ARGV.first == 'build' && File.exist?(signing_key)
+    s.signing_key = signing_key
+    s.cert_chain  = ['.github/opensearch-rubygems.pem']
+  end
 
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13'
-  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'timecop'
+  s.required_ruby_version = '>= 2.4'
 
-  s.description = <<-DESC.gsub(/^    /, '')
-    Ruby AWS Sigv4 Client for OpenSearch
-  DESC
+  s.add_dependency 'aws-sigv4', '>= 1'
+  s.add_dependency 'opensearch-ruby', '>= 1.0.1'
 end

data/spec/unit/{sigv4_client_spec.rb → open_search/aws/sigv4_client_spec.rb}

@@ -7,7 +7,9 @@
 # Modifications Copyright OpenSearch Contributors. See
 # GitHub history for details.
 
-require_relative '../spec_helper'
+# frozen_string_literal: true
+
+require_relative '../../../spec_helper'
 require 'aws-sigv4'
 require 'timecop'
 
@@ -16,7 +18,8 @@ describe OpenSearch::Aws::Sigv4Client do
     described_class.new(
       { host: 'http://localhost:9200',
         transport_options: { ssl: { verify: false } } },
-      signer)
+      signer
+    )
   end
 
   let(:signer) do
@@ -37,7 +40,7 @@ describe OpenSearch::Aws::Sigv4Client do
 
     context 'when a Sigv4 Signer is provided' do
       it 'does NOT raise any error' do
-        expect { client }.to_not raise_error
+        expect { client }.not_to raise_error
       end
     end
   end
@@ -45,25 +48,25 @@ describe OpenSearch::Aws::Sigv4Client do
   describe '#perform_request' do
     let(:response) { { body: 'Response Body' } }
     let(:transport_double) do
-      _double = instance_double('OpenSearch::Transport::Client', perform_request: response)
-      _double.stub_chain(:transport, :hosts, :dig).and_return('localhost')
-      _double
+      double = instance_double(OpenSearch::Transport::Client, perform_request: response)
+      allow(double).to receive_message_chain(:transport, :hosts, :dig).and_return('localhost')
+      double
     end
     let(:signed_headers) do
       { 'authorization' => 'AWS4-HMAC-SHA256 Credential=key_id/20220101/us-west-2/es/aws4_request, '\
-                            'SignedHeaders=host;x-amz-content-sha256;x-amz-date, ' \
-                            'Signature=9c4c690110483308f62a91c2ca873857750bca2607ba1aabdae0d2303950310a',
+                           'SignedHeaders=host;x-amz-content-sha256;x-amz-date, ' \
+                           'Signature=9c4c690110483308f62a91c2ca873857750bca2607ba1aabdae0d2303950310a',
         'host' => 'localhost',
         'x-amz-content-sha256' => 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
         'x-amz-date' => '20220101T000000Z' }
     end
 
-    before(:each) do
+    before do
       Timecop.freeze(Time.utc(2022))
       client.transport = transport_double
     end
 
-    after(:each) { Timecop.return }
+    after { Timecop.return }
 
     it 'signs the request before passing it to @transport' do
       output = client.perform_request('GET', '/', {}, '', {})
@@ -72,8 +75,27 @@ describe OpenSearch::Aws::Sigv4Client do
     end
 
     it 'skips the opensearch verification' do
-      expect(client).to_not receive(:open_search_validation_request)
+      allow(client).to receive(:open_search_validation_request)
       client.perform_request('GET', '/_stats', {}, '', {})
+      expect(client).not_to have_received(:open_search_validation_request)
+    end
+
+    it 'passes the same body to sign_request and super' do
+      body = {
+        char_filter: {
+          test: {
+            type: 'mapping',
+            mappings: ["’ => '"]
+          }
+        }
+      }
+      signature_body = body.to_json
+
+      allow(signer).to receive(:sign_request).with(a_hash_including(body: signature_body)).and_call_original
+
+      client.perform_request('GET', '/', {}, body, {})
+
+      expect(transport_double).to have_received(:perform_request).with('GET', '/', {}, signature_body, kind_of(Hash))
     end
   end
 end

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-aws-sigv4
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
-- Theo Truong
-- Robin Roestenburg
+- OpenSearch Contributors
 autorequire: 
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRMwEQYDVQQDDApvcGVu
+  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBCMRMwEQYDVQQDDApvcGVu
   c2VhcmNoMRYwFAYKCZImiZPyLGQBGRYGYW1hem9uMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMB4XDTIyMDgxNzE3NTIzNFoXDTIzMDgxNzE3NTIzNFowQjETMBEGA1UEAwwK
+  Y29tMB4XDTIzMDgyNDIwNDIwNFoXDTI0MDgyMzIwNDIwNFowQjETMBEGA1UEAwwK
   b3BlbnNlYXJjaDEWMBQGCgmSJomT8ixkARkWBmFtYXpvbjETMBEGCgmSJomT8ixk
   ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM1z3/jcitjV
   umXwRFn+JSBBd36qZB54Dtucf6+E2fmNPzBRhgYN5XJy/+clQJ9NIJV7C8H52P3V
@@ -24,27 +23,27 @@ cert_chain:
   zfR37/NQFkECAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
   BBYEFJJ2myhLXK742btavNbG0IWrMNBIMCAGA1UdEQQZMBeBFW9wZW5zZWFyY2hA
   YW1hem9uLmNvbTAgBgNVHRIEGTAXgRVvcGVuc2VhcmNoQGFtYXpvbi5jb20wDQYJ
-  KoZIhvcNAQEFBQADggEBAH5pWLYwKWFh1OjdCReGz/VEAiF4jXXputoN5Z8ga+1Z
-  lg8/diJf0PlP2B46PdmxH/TVc/o+qglNO2cHVEp8xZfEd83dfioOBeK90URQUpC5
-  UZmO0LZusg46SQKwKa2ukpIy2fNi3PeHRiV+W2Zv69GoWppyLun+fMez7wVoah2r
-  r5ROUYuAvFUvga1Vm+49pKiPM5n+MAYP5t/vWhgymY3SYQ1TfewkvKAFiFXikOR+
-  r+j7FLyKuk5DzIxiCp8QN5dU71BbGUmsHf/C5UV76WLPOFX/szeaHhPwpjR3sK7r
-  5zLgCV1KP7cgDdCYMlmZGeSViU8NV+Yy8/ghrzGpqVw=
+  KoZIhvcNAQELBQADggEBABAQpnELuY5AgdNUIlIVRVATO6iZOXTbt3a9oVbQdLPe
+  BfMObZyJydg0+leyR3oFyN9ZIFiEFwpd0biFf39DuC0M6Oge0Rv4oO9GRI3yyv77
+  9m59he+5DI3hbqtGje108oqRe61NZMlKcy/DCBVkzzZFsJ17GC09tY/gwhmNRtLV
+  3vYIEY6vmn57wrGn1NUzWdG+x/XVjYPw5Kwo+/rCxxZqpVTklMqVWV43N/lFrUOe
+  1DlemA1SsUBIoF7CwtVd/RTG/K1iT6nBD08fdKxodMhI5ujkP3N7gkxzRf6aKN4z
+  glnDJYZjluKBUsKTOLdPW1CZpb0AHLpNqDf8SVHsPFk=
   -----END CERTIFICATE-----
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
@@ -61,179 +60,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: byebug
-  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: pry
-  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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: require-prof
-  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: rspec
-  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: ruby-prof
-  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: simplecov
-  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: yard
-  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: timecop
-  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'
-description: 'Ruby AWS Sigv4 Client for OpenSearch
-
-  '
-email:
-- theo.nam.truong@gmail.com
-- robin.roestenburg@4me.com
+description: |
+  A wrapper for opensearch-ruby gem that provides AWS Sigv4 signing.
+  It behaves like OpenSearch::Client, but signs every request with AWS Sigv4
+  using the credentials provided during the client's initialization.
+email: opensearch@amazon.com
 executables:
 - opensearch_sigv4_console
 extensions: []
 extra_rdoc_files:
 - README.md
+- USER_GUIDE.md
 - LICENSE
 files:
-- ".gitignore"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
+- USER_GUIDE.md
 - bin/opensearch_sigv4_console
 - lib/opensearch-aws-sigv4.rb
 - lib/opensearch-aws-sigv4/version.rb
+- lib/opensearch_aws_sigv4.rb
 - opensearch-aws-sigv4.gemspec
-- spec/integration/sigv4_client_integration_spec.rb
-- spec/spec_helper.rb
-- spec/unit/sigv4_client_spec.rb
-homepage: https://opensearch.org/docs/latest
+- spec/unit/open_search/aws/sigv4_client_spec.rb
+homepage: https://github.com/opensearch-project/opensearch-ruby-aws-sigv4
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://opensearch.org/docs/latest/
-  source_code_uri: https://github.com/opensearch-project/opensearch-ruby/tree/main
-  bug_tracker_uri: https://github.com/opensearch-project/opensearch-ruby/issues
+  homepage_uri: https://github.com/opensearch-project/opensearch-ruby-aws-sigv4
+  documentation_uri: https://rubydoc.info/gems/opensearch-aws-sigv4/OpenSearch/Aws/Sigv4Client
+  source_code_uri: https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/tree/main
+  bug_tracker_uri: https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/issues
+  changelog_uri: https://github.com/opensearch-project/opensearch-ruby-aws-sigv4/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -243,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -255,6 +112,4 @@ signing_key:
 specification_version: 4
 summary: Ruby AWS Sigv4 Client for OpenSearch
 test_files:
-- spec/integration/sigv4_client_integration_spec.rb
-- spec/spec_helper.rb
-- spec/unit/sigv4_client_spec.rb
+- spec/unit/open_search/aws/sigv4_client_spec.rb

data/CHANGELOG.md

@@ -1,18 +0,0 @@
-# CHANGELOG
-Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-
-## [Unreleased]
-### Added
-- Added support for Amazon OpenSearch Serverless ([#131](https://github.com/opensearch-project/opensearch-ruby/issues/131))
-
-### Changed
-### Deprecated
-### Removed
-### Fixed
-- Sign validation requests when using AWS Sigv4 ([#134](https://github.com/opensearch-project/opensearch-ruby/pull/134))
-
-### Security
-
-## 1.0.0
-### Added
-- Added `OpenSearch::AWS::Sigv4Client` ([#110](https://github.com/opensearch-project/opensearch-ruby/pull/110))

data/Gemfile

@@ -1,25 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in opensearch-aws-sigv4.gemspec
-gemspec
-
-if File.exist? File.expand_path("../../opensearch-api/opensearch-api.gemspec", __FILE__)
-  gem 'opensearch-api', :path => File.expand_path("../../opensearch-api", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../opensearch-transport/opensearch-transport.gemspec", __FILE__)
-  gem 'opensearch-transport', :path => File.expand_path("../../opensearch-transport", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../opensearch-ruby/opensearch-ruby.gemspec", __FILE__)
-  gem 'opensearch-ruby', :path => File.expand_path("../../opensearch-ruby", __FILE__), :require => false
-end

data/Rakefile

@@ -1,41 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-
-require 'bundler/gem_tasks'
-
-task(:default) { system 'rake --tasks' }
-
-desc 'Run unit tests'
-task test: 'test:spec'
-
-# ----- Test tasks ------------------------------------------------------------
-require 'rspec/core/rake_task'
-
-namespace :test do
-  RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = 'spec/integration/**{,/*/**}/*_spec.rb'
-  end
-
-  RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = 'spec/unit/**{,/*/**}/*_spec.rb'
-  end
-
-  desc 'Run unit and integration tests'
-  task :all do
-    Rake::Task['test:unit'].invoke
-    Rake::Task['test:integration'].invoke
-  end
-end
-
-# ----- Documentation tasks ---------------------------------------------------
-
-require 'yard'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.options = %w| --embed-mixins --markup=markdown |
-end

data/spec/integration/sigv4_client_integration_spec.rb

@@ -1,42 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-
-require_relative '../spec_helper'
-require 'logger'
-require 'aws-sigv4'
-
-describe OpenSearch::Aws::Sigv4Client do
-  let(:client) do
-    signer = Aws::Sigv4::Signer.new(service: 'es',
-                                    region: 'us-west-2',
-                                    access_key_id: 'key_id',
-                                    secret_access_key: 'secret')
-
-    OpenSearch::Aws::Sigv4Client.new({ host: OPENSEARCH_URL, logger: Logger.new($stdout) }, signer)
-  end
-
-  it 'performs API actions without throwing any errors' do
-    expect do
-      # Index a document
-      client.index(index: 'test-index', id: '1', body: { title: 'Test' })
-
-      # Refresh the index
-      client.indices.refresh(index: 'test-index')
-
-      # Search
-      response = client.search(index: 'test-index', body: { query: { match: { title: 'test' } } })
-
-      expect(response['hits']['total']['value']).to eq 1
-      expect(response['hits']['hits'][0]['_source']['title']).to eq 'Test'
-
-      # Delete the index
-      client.indices.delete(index: 'test-index')
-    end.not_to raise_error
-  end
-end

data/spec/spec_helper.rb

@@ -1,18 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-
-require 'opensearch-aws-sigv4'
-require 'rspec'
-
-OPENSEARCH_URL = ENV['TEST_OPENSEARCH_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless OPENSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
-RSpec.configure do |config|
-  config.formatter = :documentation
-end