Class: Force::SignedRequest

Inherits:

Object

• Object
• Force::SignedRequest

Defined in:

lib/force/signed_request.rb

Class Method Summary

• .decode(signed_request, client_secret) ⇒ Object

  Public: Initializes and decodes the signed request.

Instance Method Summary

• #decode ⇒ Object

  Public: Decode the signed request.

• #initialize(signed_request, client_secret) ⇒ SignedRequest constructor

  A new instance of SignedRequest.

Constructor Details

#initialize(signed_request, client_secret) ⇒ SignedRequest

Returns a new instance of SignedRequest.

# File 'lib/force/signed_request.rb', line 17

def initialize(signed_request, client_secret)
  @client_secret = client_secret
  split_components(signed_request)
end

Class Method Details

.decode(signed_request, client_secret) ⇒ Object

Public: Initializes and decodes the signed request

signed_request - The POST message containing the signed request from Salesforce. client_secret - The oauth client secret used to encrypt the signed request.

Returns the parsed JSON context.

# File 'lib/force/signed_request.rb', line 13

def self.decode(signed_request, client_secret)
  new(signed_request, client_secret).decode
end

Instance Method Details

#decode ⇒ Object

Public: Decode the signed request.

Returns the parsed JSON context. Returns nil if the signed request is invalid.

# File 'lib/force/signed_request.rb', line 26

def decode
  return nil if signature != hmac
  JSON.parse(Base64.decode64(payload))
end