Module: Lti2Commons::Signer

Defined in:
lib/lti2_commons/lib/lti2_commons/signer.rb

Instance Method Summary collapse

Instance Method Details

#create_signed_request(launch_url, http_method, consumer_key, consumer_secret, params = {}, body = nil, content_type = nil, accept = nil) ⇒ Request

Creates an OAuth signed request using the OAuth Gem - github.com/oauth/oauth-ruby

Parameters:

  • launch_url (String) —

    Endpoint of service to be launched

  • http_method (String) —

    Http method (‘get’, ‘post’, ‘put’, ‘delete’)

  • consumer_key (String) —

    OAuth consumer key

  • consumer_secret (String) —

    OAuth consumer secret

  • params (Hash) (defaults to: {}) —

    Non-auth parameters or oauth parameter default values oauth_timestamp => defaults to current time oauth_nonce => defaults to random number oauth_signature_method => defaults to HMAC-SHA1 (also RSA-SHA1 supported)

  • body (String) (defaults to: nil) —

    Body content. Usually would include this for body-signing of non form-encoded data.

  • content_type (String) (defaults to: nil) —

    HTTP CONTENT-TYPE header; defaults: ‘application/x-www-form-urlencoded’

Returns:

  • (Request) —

    Signed request



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/lti2_commons/lib/lti2_commons/signer.rb', line 20

def create_signed_request(launch_url, http_method, consumer_key, consumer_secret, params = {},
    body = nil, content_type = nil, accept = nil)
  params['oauth_consumer_key'] = consumer_key
  params['oauth_nonce'] = (rand * 10E12).to_i.to_s unless params.key? 'oauth_nonce'
  params['oauth_signature_method'] = 'HMAC-SHA1' unless params.key? 'oauth_signature_method'
  params['oauth_timestamp'] = Time.now.to_i.to_s unless params.key? 'oauth_timestamp'
  params['oauth_version'] = '1.0' unless params.key? 'oauth_version'
  params['oauth_callback'] = 'about:blank'

  content_type = 'application/x-www-form-urlencoded' unless content_type

  launch_url = URI.unescape(launch_url)
  uri = URI.parse(launch_url)

  # flatten in query string arrays
  if uri.query && uri.query != ''
    CGI.parse(uri.query).each do |query_key, query_values|
      params[query_key] = query_values.first unless params[query_key]
    end
  end

  final_uri = uri
  uri = URI.parse(launch_url.split('?').first)

  unless content_type == 'application/x-www-form-urlencoded'
    params['oauth_body_hash'] = compute_oauth_body_hash body if body
  end

  request = OAuth::OAuthProxy::OAuthRequest.new(
    'method' => http_method.to_s.upcase,
    'uri' => uri,
    'parameters' => params,
    'final_uri' => final_uri
  )

  request.body = body
  request.content_type = content_type
  request.accept = accept

  request.sign!(consumer_secret: consumer_secret)

  # puts "Sender secret: #{consumer_secret}"
  request
end