faraday_middleware-aws-sigv4 0.3.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dbe0c6ca7fd755540b7c4c0a282c33101c49697f856336e02d9218c5b885047
-  data.tar.gz: 9f0846fb0a682f9675de3c9bcf3354fc2f9e870f0e06562a2e87591e16bbe3a7
+  metadata.gz: 6c529e426730ad685dc287898b42b6b27345d63e4faba1e016ad2c7126c29612
+  data.tar.gz: 812fb0fdbb3f7158f4811c03e08f5004eeeda9f127ee7e1627403f6ebe3ec96f
 SHA512:
-  metadata.gz: 56d40a5c79b056f329db7c5a59f382378e8b09994a4b1a9031ce7d6fe72f308088d776dc410685c925a528ed3f03ac9dca5fa5ca1adeb52f1eefc39128479a75
-  data.tar.gz: 587bafa4f2cb5412d00ddaf606f23ea52b916fa0de7e0d75d930ef4e93b82c10765ab5245e6135c04e44618ece1f78953da2923523da4803a6c029a71a014e30
+  metadata.gz: e43f5ab344a052c4e37f22bdda9127091367bd927d2a5f7b16b2832ab4ae3684a2daa34c111372dfeb2cc28de77d04cecbe13557e56de166ac277e560f5e481f
+  data.tar.gz: 68cfd56f08e416e3d020a916a10a81ff8e1d813fbbc694ec17484150516dc5cd2fa3d3d09bab4022f018c36478e2109d0a0e307414fe226b7cb6ff74f7737ef3

data/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+        gemfile:
+          - gemfiles/faraday_1.8.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: gemfiles/vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles('faraday_middleware-aws-sigv4.gemspec', '**/Gemfile', '${{ matrix.gemfile }}') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.gemfile }}-
+      - name: Setup dependencies
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+      - name: Run tests
+        run: bundle exec rake
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.ruby }}-${{ matrix.gemfile }}
+          parallel: true
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*'
+  TargetRubyVersion: 2.4
+  NewCops: enable
+Bundler/OrderedGems:
+  Include:
+    - 'Appraisals'
+Metrics/BlockLength:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/.simplecov

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
   # exclude directories and files
-  add_filter "/spec/"
+  add_filter '/spec/'
 end

data/Appraisals

@@ -1,7 +1,5 @@
-appraise 'faraday-0.15' do
-  gem 'faraday', '~> 0.15.0'
-end
+# frozen_string_literal: true
 
-appraise 'faraday-0.16' do
-  gem 'faraday', '~> 0.16.0'
+appraise 'faraday-1.8' do
+  gem 'faraday', '~> 1.8.0'
 end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in faraday_middleware-aws-sigv4.gemspec

data/README.md

@@ -3,14 +3,17 @@
 [Faraday](https://github.com/lostisland/faraday) middleware for AWS Signature Version 4 using [aws-sigv4](https://rubygems.org/gems/aws-sigv4).
 
 [![Gem Version](https://badge.fury.io/rb/faraday_middleware-aws-sigv4.svg)](https://badge.fury.io/rb/faraday_middleware-aws-sigv4)
-[![Build Status](https://travis-ci.org/winebarrel/faraday_middleware-aws-sigv4.svg?branch=master)](https://travis-ci.org/winebarrel/faraday_middleware-aws-sigv4)
+[![Build Status](https://github.com/winebarrel/faraday_middleware-aws-sigv4/workflows/test/badge.svg?branch=master)](https://github.com/winebarrel/faraday_middleware-aws-sigv4/actions)
 [![Coverage Status](https://coveralls.io/repos/github/winebarrel/faraday_middleware-aws-sigv4/badge.svg?branch=master)](https://coveralls.io/github/winebarrel/faraday_middleware-aws-sigv4?branch=master)
 
-* `faraday_middleware-aws-sigv4 < 0.3.0`
-  * `faraday < 0.15`
-* `faraday_middleware-aws-sigv4 >= 0.3.0`
-  * `ruby >= 2.3`
-  * `faraday >= 0.15`
+## Required dependency version
+
+| version    | ruby     | faraday   |
+|------------|----------|-----------|
+| `>= 0.6.0` | `>= 2.4` | `>= 1.8`  |
+| `>= 0.5.0` | `>= 2.4` | `>= 0.15` |
+| `>= 0.3.0` | `>= 2.3` | `>= 0.15` |
+| `< 0.3.0`  | -        | `< 0.15`  |
 
 ## Installation
 
@@ -31,7 +34,8 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# `gem install faraday_middleware` is required.
+# `gem install faraday_middleware` is required for this example.
+# However, FaradayMiddleware::AwsSigV4 works without faraday_middleware.
 require 'faraday_middleware'
 require 'faraday_middleware/aws_sigv4'
 require 'pp'
@@ -44,9 +48,15 @@ conn = Faraday.new(url: 'https://apigateway.us-east-1.amazonaws.com') do |farada
     secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
   # see http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html
 
+  # NOTE: The following middleware is from `faraday_middleware`
+  # cf. https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware.rb
+  # **It is not an essential middleware to work.**
   faraday.response :json, content_type: /\bjson\b/
   faraday.response :raise_error
 
+
+  # NOTE: If you need to send case sensitive headers like `x-amz-access-token` in `SP API`.
+  # cf. https://github.com/lostisland/faraday/issues/747#issuecomment-439864181
   faraday.adapter Faraday.default_adapter
 end
 
@@ -73,10 +83,9 @@ If you previously provided the `service_name` option, you need to rename it `ser
 ```sh
 bundle install
 bundle exec appraisal install
-bundle exec appraisal faraday-0.16 rake
+bundle exec appraisal faraday-1.8 rake
 ```
 
 ## Related Links
 
 * http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html
-* https://github.com/winebarrel/faraday_middleware-aws-signers-v4 (aws-sdk-v2 version)

data/Rakefile

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+RuboCop::RakeTask.new do |task|
+  task.options = %w[-c .rubocop.yml]
+end
+
+task default: %i[rubocop spec]

data/faraday_middleware-aws-sigv4.gemspec

@@ -1,15 +1,16 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'faraday_middleware-aws-sigv4'
-  spec.version       = '0.3.0'
+  spec.version       = '0.6.1'
   spec.authors       = ['Genki Sugawara']
   spec.email         = ['sugawara@cookpad.com']
 
-  spec.summary       = %q{Faraday middleware for AWS Signature Version 4 using aws-sigv4.}
-  spec.description   = %q{Faraday middleware for AWS Signature Version 4 using aws-sigv4.}
+  spec.summary       = 'Faraday middleware for AWS Signature Version 4 using aws-sigv4.'
+  spec.description   = 'Faraday middleware for AWS Signature Version 4 using aws-sigv4.'
   spec.homepage      = 'https://github.com/winebarrel/faraday_middleware-aws-sigv4'
   spec.license       = 'MIT'
 
@@ -20,17 +21,24 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency 'faraday', '>= 0.15'
   spec.add_dependency 'aws-sigv4', '~> 1.0'
+  spec.add_dependency 'faraday', '>= 1.8', '< 2'
 
-  spec.add_development_dependency 'faraday_middleware'
+  spec.add_development_dependency 'appraisal', '>= 2.2'
+  spec.add_development_dependency 'aws-sdk-core', '>= 3.124.0'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'faraday_middleware'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '>= 1.8.0'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
   spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'aws-sdk-core', '~> 3.14.0'
-  spec.add_development_dependency 'appraisal', '>= 2.2'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/gemfiles/{faraday_0.15.gemfile → faraday_1.8.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "faraday", "~> 0.15.0"
+gem "faraday", "~> 1.8.0"
 
 gemspec path: "../"

data/lib/faraday_middleware/aws_sigv4.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module FaradayMiddleware
   autoload :AwsSigV4, 'faraday_middleware/request/aws_sigv4'
-  Faraday::Request.register_middleware aws_sigv4: lambda { AwsSigV4 }
+  Faraday::Request.register_middleware aws_sigv4: -> { AwsSigV4 }
 end

data/lib/faraday_middleware/request/aws_sigv4.rb

@@ -1,37 +1,41 @@
+# frozen_string_literal: true
+
 require 'aws-sigv4'
 require 'faraday_middleware/request/aws_sigv4_util'
 
-class FaradayMiddleware::AwsSigV4 < Faraday::Middleware
-  include FaradayMiddleware::AwsSigV4Util
+module FaradayMiddleware
+  class AwsSigV4 < Faraday::Middleware
+    include FaradayMiddleware::AwsSigV4Util
 
-  def initialize(app, options = nil)
-    super(app)
-    @signer = Aws::Sigv4::Signer.new(options)
-    @options = options
-  end
+    def initialize(app, options = nil)
+      super(app)
+      @signer = Aws::Sigv4::Signer.new(options)
+      @options = options
+    end
 
-  def call(env)
-    sign!(env)
-    @app.call(env)
-  end
+    def call(env)
+      sign!(env)
+      @app.call(env)
+    end
 
-  private
+    private
 
-  def sign!(env)
-    request = build_aws_sigv4_request(env)
-    signature = @signer.sign_request(request)
+    def sign!(env)
+      request = build_aws_sigv4_request(env)
+      signature = @signer.sign_request(request)
 
-    signature.headers.each do |name, value|
-      env.request_headers[name] = value
+      signature.headers.each do |name, value|
+        env.request_headers[name] = value
+      end
     end
-  end
 
-  def build_aws_sigv4_request(env)
-    {
-      http_method: env.method.to_s,
-      url: seahorse_encode_query(env.url),
-      headers: env.request_headers,
-      body: env.body,
-    }
+    def build_aws_sigv4_request(env)
+      {
+        http_method: env.method.to_s,
+        url: seahorse_encode_query(env.url),
+        headers: env.request_headers,
+        body: env.body
+      }
+    end
   end
 end

data/lib/faraday_middleware/request/aws_sigv4_util.rb

@@ -1,32 +1,36 @@
-module FaradayMiddleware::AwsSigV4Util
-  def seahorse_encode_query(url)
-    return url unless url.query
+# frozen_string_literal: true
 
-    params = URI.decode_www_form(url.query)
+module FaradayMiddleware
+  module AwsSigV4Util
+    def seahorse_encode_query(url)
+      return url unless url.query
 
-    if params.any? {|_, v| v[?\s] }
-      url = url.dup
-      url.query = seahorse_encode_www_form(params)
-    end
+      params = URI.decode_www_form(url.query)
 
-    url
-  end
+      if params.any? { |_, v| v["\s"] }
+        url = url.dup
+        url.query = seahorse_encode_www_form(params)
+      end
 
-  def seahorse_encode_www_form(params)
-    params.flat_map {|key, value|
-      encoded_key = URI.encode_www_form_component(key)
+      url
+    end
 
-      if value.nil?
-        encoded_key
-      else
-        Array(value).map do |v|
-          if v.nil?
-            # nothing to do
-          else
-            encoded_key + '=' + Aws::Sigv4::Signer.uri_escape(v)
+    def seahorse_encode_www_form(params)
+      params.flat_map do |key, value|
+        encoded_key = URI.encode_www_form_component(key)
+
+        if value.nil?
+          encoded_key
+        else
+          Array(value).map do |v|
+            if v.nil?
+              # nothing to do
+            else
+              "#{encoded_key}=#{Aws::Sigv4::Signer.uri_escape(v)}"
+            end
           end
         end
-      end
-    }.join(?&)
+      end.join('&')
+    end
   end
 end

metadata

@@ -1,45 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-aws-sigv4
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Genki Sugawara
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2021-12-19 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: aws-sigv4
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '2.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.124.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.124.0
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +129,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +157,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,33 +171,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-core
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        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: Faraday middleware for AWS Signature Version 4 using aws-sigv4.
 email:
 - sugawara@cookpad.com
@@ -157,30 +219,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - faraday_middleware-aws-sigv4.gemspec
 - gemfiles/.bundle/config
-- gemfiles/faraday_0.15.gemfile
-- gemfiles/faraday_0.16.gemfile
+- gemfiles/faraday_1.8.gemfile
 - lib/faraday_middleware/aws_sigv4.rb
 - lib/faraday_middleware/request/aws_sigv4.rb
 - lib/faraday_middleware/request/aws_sigv4_util.rb
 homepage: https://github.com/winebarrel/faraday_middleware-aws-sigv4
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,15 +248,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Faraday middleware for AWS Signature Version 4 using aws-sigv4.
 test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-- 2.3.8
-- 2.4.7
-- 2.5.6
-- 2.6.4
-script:
-- bundle exec rake
-gemfile:
-- gemfiles/faraday_0.15.gemfile
-- gemfiles/faraday_0.16.gemfile

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "faraday_middleware/aws/sigv4"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/gemfiles/faraday_0.16.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "faraday", "~> 0.16.0"
-
-gemspec path: "../"