Class: Faraday::ApiAuth::Middleware

Inherits:
Middleware
  • Object
show all
Defined in:
lib/faraday/api_auth/middleware.rb

Overview

Request middleware for Faraday. It takes the same arguments as ApiAuth.sign!.

You will usually need to include it after the other middlewares since ApiAuth needs to hash the final request.

Usage:

require 'faraday/api_auth'

conn = Faraday.new do |f|
  f.request :api_auth, access_id, secret_key
  # Alternatively:
  # f.use Faraday::ApiAuth::Middleware, access_id, secret_key
end

Instance Method Summary collapse

Constructor Details

#initialize(app, access_id, secret_key, options = {}) ⇒ Middleware

Returns a new instance of Middleware.



23
24
25
26
27
28
 
# File 'lib/faraday/api_auth/middleware.rb', line 23

def initialize(app, access_id, secret_key, options = {})
  super(app)
  @access_id = access_id
  @secret_key = secret_key
  @options = options
end

Instance Method Details

#on_request(env) ⇒ Object 



30
31
32
 
# File 'lib/faraday/api_auth/middleware.rb', line 30

def on_request(env)
  ::ApiAuth.sign!(env, @access_id, @secret_key, @options)
end