Class: OauthUtil
- Inherits:
-
Object
- Object
- OauthUtil
- Defined in:
- lib/oauth_util.rb
Instance Attribute Summary collapse
-
#base_str ⇒ Object
Returns the value of attribute base_str.
-
#callback_url ⇒ Object
Returns the value of attribute callback_url.
-
#consumer_key ⇒ Object
Returns the value of attribute consumer_key.
-
#consumer_secret ⇒ Object
Returns the value of attribute consumer_secret.
-
#oauth_version ⇒ Object
Returns the value of attribute oauth_version.
-
#params ⇒ Object
Returns the value of attribute params.
-
#req_method ⇒ Object
Returns the value of attribute req_method.
-
#req_url ⇒ Object
Returns the value of attribute req_url.
-
#sig_method ⇒ Object
Returns the value of attribute sig_method.
-
#token ⇒ Object
Returns the value of attribute token.
-
#token_secret ⇒ Object
Returns the value of attribute token_secret.
Instance Method Summary collapse
-
#initialize ⇒ OauthUtil
constructor
A new instance of OauthUtil.
-
#nonce ⇒ Object
openssl::random_bytes returns non-word chars, which need to be removed.
- #percent_encode(string) ⇒ Object
-
#query_string ⇒ Object
sort (very important as it affects the signature), concat, and percent encode.
-
#sign(parsed_url) ⇒ Object
organize params & create signature.
- #signature ⇒ Object
Constructor Details
#initialize ⇒ OauthUtil
Returns a new instance of OauthUtil.
17 18 19 20 21 22 23 24 25 26 |
# File 'lib/oauth_util.rb', line 17 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.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def base_str @base_str end |
#callback_url ⇒ Object
Returns the value of attribute callback_url.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def callback_url @callback_url end |
#consumer_key ⇒ Object
Returns the value of attribute consumer_key.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def consumer_key @consumer_key end |
#consumer_secret ⇒ Object
Returns the value of attribute consumer_secret.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def consumer_secret @consumer_secret end |
#oauth_version ⇒ Object
Returns the value of attribute oauth_version.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def oauth_version @oauth_version end |
#params ⇒ Object
Returns the value of attribute params.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def params @params end |
#req_method ⇒ Object
Returns the value of attribute req_method.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def req_method @req_method end |
#req_url ⇒ Object
Returns the value of attribute req_url.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def req_url @req_url end |
#sig_method ⇒ Object
Returns the value of attribute sig_method.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def sig_method @sig_method end |
#token ⇒ Object
Returns the value of attribute token.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 def token @token end |
#token_secret ⇒ Object
Returns the value of attribute token_secret.
14 15 16 |
# File 'lib/oauth_util.rb', line 14 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
30 31 32 |
# File 'lib/oauth_util.rb', line 30 def nonce Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first end |
#percent_encode(string) ⇒ Object
34 35 36 37 38 |
# File 'lib/oauth_util.rb', line 34 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
56 57 58 59 60 61 62 |
# File 'lib/oauth_util.rb', line 56 def query_string pairs = [] @params.sort.each { | key, val | pairs.push( "#{ percent_encode( key ) }=#{ percent_encode( val.to_s ) }" ) } pairs.join '&' end |
#sign(parsed_url) ⇒ Object
organize params & create signature
65 66 67 68 69 70 71 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 |
# File 'lib/oauth_util.rb', line 65 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 #@params.merge! CGI.parse( 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
41 42 43 44 45 46 47 48 49 50 |
# File 'lib/oauth_util.rb', line 41 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 |