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



62
63
64
 
# File 'lib/api_auth/headers.rb', line 62

def authorization_header
  @request.authorization_header
end

#calculate_md5 ⇒ Object 



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

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



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

def canonical_string
  [ @request.content_type,
    @request.content_md5,
    @request.request_uri.gsub(/https?:\/\/[^(,|\?|\/)]*/,''), # remove host
    @request.timestamp
  ].join(",")
end

#md5_mismatch? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#set_date ⇒ Object 



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

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.



87
88
89
 
# File 'lib/api_auth/headers.rb', line 87

def sign_header(header)
  @request.set_auth_header header
end

#timestamp ⇒ Object

Returns the request timestamp



48
49
50
 
# File 'lib/api_auth/headers.rb', line 48

def timestamp
   @request.timestamp
end