Class: ApiAuth::Headers

Inherits:
Object
  • Object
show all
Includes:
RequestDrivers
Defined in:
lib/api_auth/headers.rb

Overview

Builds the canonical string given a request object.

Instance Method Summary collapse

Constructor Details

#initialize(request) ⇒ Headers

Returns a new instance of Headers.



6
7
8
9
10
 
# File 'lib/api_auth/headers.rb', line 6

def initialize(request)
  @original_request = request
  @request = initialize_request_driver(request)
  true
end

Instance Method Details

#authorization_header ⇒ Object

Returns the authorization header from the request’s headers



65
66
67
 
# File 'lib/api_auth/headers.rb', line 65

def authorization_header
  @request.authorization_header
end

#calculate_md5 ⇒ Object 



73
74
75
 
# File 'lib/api_auth/headers.rb', line 73

def calculate_md5
  @request.populate_content_md5 if @request.content_md5.nil?
end

#canonical_string(override_method = nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/api_auth/headers.rb', line 50

def canonical_string(override_method = nil)
  request_method = override_method || @request.http_method

  if request_method.nil?
    raise ArgumentError, 'unable to determine the http method from the request, please supply an override'
  end

  [request_method.upcase,
   @request.content_type,
   @request.content_md5,
   parse_uri(@request.original_uri || @request.request_uri),
   @request.timestamp].join(',')
end

#md5_mismatch? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
 
# File 'lib/api_auth/headers.rb', line 77

def md5_mismatch?
  if @request.content_md5.nil?
    false
  else
    @request.md5_mismatch?
  end
end

#set_date ⇒ Object 



69
70
71
 
# File 'lib/api_auth/headers.rb', line 69

def set_date
  @request.set_date if @request.timestamp.nil?
end

#sign_header(header) ⇒ Object

Sets the request’s authorization header with the passed in value. The header should be the ApiAuth HMAC signature.

This will return the original request object with the signed Authorization header already in place.



90
91
92
 
# File 'lib/api_auth/headers.rb', line 90

def sign_header(header)
  @request.set_auth_header header
end

#timestamp ⇒ Object

Returns the request timestamp



46
47
48
 
# File 'lib/api_auth/headers.rb', line 46

def timestamp
  @request.timestamp
end