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.



8
9
10
11
12
 
# File 'lib/api_auth/headers.rb', line 8

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



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

def authorization_header
  @request.authorization_header
end

#calculate_md5 ⇒ Object 



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

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

#canonical_string ⇒ Object

Returns the canonical string computed from the request’s headers



55
56
57
58
59
60
61
 
# File 'lib/api_auth/headers.rb', line 55

def canonical_string
  [ @request.content_type,
    @request.content_md5,
    parse_uri(@request.request_uri), 
    @request.timestamp
  ].join(",")
end

#md5_mismatch? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#set_date ⇒ Object 



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

def set_date
  @request.set_date if @request.timestamp.empty?
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.



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

def sign_header(header)
  @request.set_auth_header header
end

#timestamp ⇒ Object

Returns the request timestamp



50
51
52
 
# File 'lib/api_auth/headers.rb', line 50

def timestamp
   @request.timestamp
end