module SimpleApiAuth
Constants
- MAJOR
- MINOR
- PATCH
- VERSION
Public Class Methods
compute_signature(request, secret_key, options = {})
click to toggle source
# File lib/simple-api-auth.rb, line 33 def self.compute_signature(request, secret_key, options = {}) request = SimpleApiAuth::Request.create(request) signer = SimpleApiAuth.config.signer.new(options) signer.sign(request, secret_key) end
config()
click to toggle source
# File lib/simple-api-auth.rb, line 11 def self.config @config ||= Config.new end
configure() { |config| ... }
click to toggle source
# File lib/simple-api-auth.rb, line 15 def self.configure yield config end
extract_key(request)
click to toggle source
# File lib/simple-api-auth.rb, line 23 def self.extract_key(request) request = SimpleApiAuth::Request.create(request) request.headers[SimpleApiAuth.config.header_keys[:saa_key]] end
log(severity, message = nil, progname = nil, &block)
click to toggle source
# File lib/simple-api-auth.rb, line 19 def self.log(severity, message = nil, progname = nil, &block) config.logger.log(severity, message, progname, &block) unless config.logger.nil? end
sign!(request, secret_key, options = {})
click to toggle source
# File lib/simple-api-auth.rb, line 39 def self.sign!(request, secret_key, options = {}) request = SimpleApiAuth::Request.create(request) request.add_header(SimpleApiAuth.config.header_keys[:saa_auth_time], Time.now.utc.iso8601) signature = compute_signature(request, secret_key, options) request.add_header(SimpleApiAuth.config.header_keys[:authorization], "Signature: #{signature}") request.original end
valid_signature?(request, secret_key, options = {})
click to toggle source
# File lib/simple-api-auth.rb, line 28 def self.valid_signature?(request, secret_key, options = {}) authenticator = Authenticator.new(request, secret_key, options) authenticator.valid_signature? end