rootlyhq / faraday_middleware-aws-sigv4

Faraday middleware for AWS Signature Version 4 using aws-sigv4.

FaradayMiddleware::AwsSigV4

Faraday middleware for AWS Signature Version 4 using aws-sigv4.

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

Add this line to your application's Gemfile:

gem 'faraday_middleware-aws-sigv4'

And then execute:

$ bundle

Or install it yourself as:

$ gem install faraday_middleware-aws-sigv4

Usage

# `gem install faraday_middleware` is required for this example.
# However, FaradayMiddleware::AwsSigV4 works without faraday_middleware.
require 'faraday_middleware/aws_sigv4'
require 'pp'

conn = Faraday.new(url: 'https://apigateway.us-east-1.amazonaws.com') do |faraday|
  faraday.request :aws_sigv4,
    service: 'apigateway',
    region: 'us-east-1',
    access_key_id: ENV['AWS_ACCESS_KEY_ID'],
    secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
  # see http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html

  faraday.response :json, content_type: /\bjson\b/

  # 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

res = conn.get '/account'

pp res.body
#=> {"_links"=>
#     {"curies"=>
#       {"href"=>
#         "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html",
#        "name"=>"account",
#        "templated"=>true},
#      "self"=>{"href"=>"/account"},
#      "account:update"=>{"href"=>"/account"}},
#    "throttleSettings"=>{"rateLimit"=>10000.0, "burstLimit"=>5000}}

Upgrading from faraday_middleware-aws-signers-v4

If you previously provided the service_name option, you need to rename it service

Test

bundle install
bundle exec appraisal install
bundle exec appraisal faraday-1.8 rake

Related Links

• http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html