Class: OauthUtil

Inherits:
Object
  • Object
show all
Defined in:
lib/oauth_util.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ OauthUtil

Returns a new instance of OauthUtil.



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/oauth_util.rb', line 24

def initialize
  @consumer_key = ''
  @consumer_secret = ''
  @token = ''
  @token_secret = ''
  @req_method = 'GET'
  @sig_method = 'HMAC-SHA1'
  @oauth_version = '1.0'
  @callback_url = ''
end

Instance Attribute Details

#base_str ⇒ Object

Returns the value of attribute base_str.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def base_str
  @base_str
end

#callback_url ⇒ Object

Returns the value of attribute callback_url.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def callback_url
  @callback_url
end

#consumer_key ⇒ Object

Returns the value of attribute consumer_key.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ Object

Returns the value of attribute consumer_secret.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def consumer_secret
  @consumer_secret
end

#oauth_version ⇒ Object

Returns the value of attribute oauth_version.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def oauth_version
  @oauth_version
end

#params ⇒ Object

Returns the value of attribute params.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def params
  @params
end

#req_method ⇒ Object

Returns the value of attribute req_method.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def req_method
  @req_method
end

#req_url ⇒ Object

Returns the value of attribute req_url.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def req_url
  @req_url
end

#sig_method ⇒ Object

Returns the value of attribute sig_method.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def sig_method
  @sig_method
end

#token ⇒ Object

Returns the value of attribute token.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def token
  @token
end

#token_secret ⇒ Object

Returns the value of attribute token_secret.



21
22
23
 
# File 'lib/oauth_util.rb', line 21

def token_secret
  @token_secret
end

Instance Method Details

#nonce ⇒ Object

openssl::random_bytes returns non-word chars, which need to be removed. using alt method to get length ref snippets.dzone.com/posts/show/491



37
38
39
 
# File 'lib/oauth_util.rb', line 37

def nonce
  Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first
end

#percent_encode(string) ⇒ Object 



41
42
43
44
45
 
# File 'lib/oauth_util.rb', line 41

def percent_encode( string )

  # ref http://snippets.dzone.com/posts/show/1260
  return URI.escape( string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") ).gsub('*', '%2A')
end

#query_string ⇒ Object

sort (very important as it affects the signature), concat, and percent encode



63
64
65
66
67
68
69
 
# File 'lib/oauth_util.rb', line 63

def query_string
  pairs = []
  @params.sort.each { | key, val | 
    pairs.push( "#{ CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') } }=#{ CGI.escape(val.to_s) }" )
  }
  pairs.join '&'
end

#sign(parsed_url) ⇒ Object

organize params & create signature



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oauth_util.rb', line 72

def sign( parsed_url )

  @params = {
    'oauth_consumer_key' => @consumer_key,
    'oauth_nonce' => nonce,
    'oauth_signature_method' => @sig_method,
    'oauth_timestamp' => Time.now.to_i.to_s,
    'oauth_version' => @oauth_version
  }

  # if url has query, merge key/values into params obj overwriting defaults
  if parsed_url.query
    CGI.parse( parsed_url.query ).each do |k,v|
      if v.is_a?(Array) && v.count == 1
        @params[k] = v.first
      else
        @params[k] = v
      end
    end
  end

  # @ref http://oauth.net/core/1.0/#rfc.section.9.1.2
  @req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path

  # create base str. make it an object attr for ez debugging
  # ref http://oauth.net/core/1.0/#anchor14
  @base_str = [ 
    @req_method, 
    percent_encode( req_url ), 

    # normalization is just x-www-form-urlencoded
    percent_encode( query_string ) 

  ].join( '&' )

  # add signature
  @params[ 'oauth_signature' ] = signature

  return self
end

#signature ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oauth_util.rb', line 48

def signature
  key = percent_encode( @consumer_secret ) + '&' + percent_encode( @token_secret )

  # ref: http://blog.nathanielbibler.com/post/63031273/openssl-hmac-vs-ruby-hmac-benchmarks
  digest = OpenSSL::Digest::Digest.new( 'sha1' )
  hmac = OpenSSL::HMAC.digest( digest, key, @base_str )

  # ref http://groups.google.com/group/oauth-ruby/browse_thread/thread/9110ed8c8f3cae81
  Base64.encode64( hmac ).chomp.gsub( /\n/, '' )
end