module OAuth::Signature

Constants

AVAILABLE_METHODS

Public Class Methods

available_methods() click to toggle source

Returns a list of available signature methods

   # File lib/oauth/signature.rb
 9 def available_methods
10   AVAILABLE_METHODS
11 end
body_hash(request, options = {}, &block) click to toggle source

Create the body hash for a request

   # File lib/oauth/signature.rb
45 def body_hash(request, options = {}, &block)
46   build(request, options, &block).body_hash
47 end
build(request, options = {}, &block) click to toggle source

Build a signature from a request.

Raises UnknownSignatureMethod exception if the signature method is unknown.

   # File lib/oauth/signature.rb
16 def build(request, options = {}, &block)
17   request = OAuth::RequestProxy.proxy(request, options)
18   klass = available_methods[
19     (request.signature_method ||
20     ((c = request.options[:consumer]) && c.options[:signature_method]) ||
21     "").downcase]
22   raise UnknownSignatureMethod, request.signature_method unless klass
23 
24   klass.new(request, options, &block)
25 end
sign(request, options = {}, &block) click to toggle source

Sign a request

   # File lib/oauth/signature.rb
28 def sign(request, options = {}, &block)
29   build(request, options, &block).signature
30 end
signature_base_string(request, options = {}, &block) click to toggle source

Create the signature base string for request. This string is the normalized parameter information.

See Also: OAuth core spec version 1.0, section 9.1.1

   # File lib/oauth/signature.rb
40 def signature_base_string(request, options = {}, &block)
41   build(request, options, &block).signature_base_string
42 end
verify(request, options = {}, &block) click to toggle source

Verify the signature of request

   # File lib/oauth/signature.rb
33 def verify(request, options = {}, &block)
34   build(request, options, &block).verify
35 end