af-oauth 0.3.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. data/History.txt +83 -0
  2. data/License.txt +20 -0
  3. data/Manifest.txt +84 -0
  4. data/README.rdoc +71 -0
  5. data/Rakefile +36 -0
  6. data/TODO +31 -0
  7. data/bin/oauth +5 -0
  8. data/examples/yql.rb +44 -0
  9. data/lib/oauth.rb +4 -0
  10. data/lib/oauth/cli.rb +300 -0
  11. data/lib/oauth/client.rb +4 -0
  12. data/lib/oauth/client/action_controller_request.rb +54 -0
  13. data/lib/oauth/client/helper.rb +81 -0
  14. data/lib/oauth/client/net_http.rb +94 -0
  15. data/lib/oauth/consumer.rb +297 -0
  16. data/lib/oauth/errors.rb +3 -0
  17. data/lib/oauth/errors/error.rb +4 -0
  18. data/lib/oauth/errors/problem.rb +14 -0
  19. data/lib/oauth/errors/unauthorized.rb +12 -0
  20. data/lib/oauth/helper.rb +77 -0
  21. data/lib/oauth/oauth.rb +7 -0
  22. data/lib/oauth/oauth_test_helper.rb +25 -0
  23. data/lib/oauth/request_proxy.rb +24 -0
  24. data/lib/oauth/request_proxy/action_controller_request.rb +63 -0
  25. data/lib/oauth/request_proxy/base.rb +159 -0
  26. data/lib/oauth/request_proxy/jabber_request.rb +41 -0
  27. data/lib/oauth/request_proxy/mock_request.rb +44 -0
  28. data/lib/oauth/request_proxy/net_http.rb +65 -0
  29. data/lib/oauth/request_proxy/rack_request.rb +40 -0
  30. data/lib/oauth/server.rb +66 -0
  31. data/lib/oauth/signature.rb +37 -0
  32. data/lib/oauth/signature/base.rb +99 -0
  33. data/lib/oauth/signature/hmac/base.rb +12 -0
  34. data/lib/oauth/signature/hmac/md5.rb +9 -0
  35. data/lib/oauth/signature/hmac/rmd160.rb +9 -0
  36. data/lib/oauth/signature/hmac/sha1.rb +9 -0
  37. data/lib/oauth/signature/hmac/sha2.rb +9 -0
  38. data/lib/oauth/signature/md5.rb +13 -0
  39. data/lib/oauth/signature/plaintext.rb +23 -0
  40. data/lib/oauth/signature/rsa/sha1.rb +45 -0
  41. data/lib/oauth/signature/sha1.rb +13 -0
  42. data/lib/oauth/token.rb +7 -0
  43. data/lib/oauth/tokens/access_token.rb +68 -0
  44. data/lib/oauth/tokens/consumer_token.rb +32 -0
  45. data/lib/oauth/tokens/request_token.rb +28 -0
  46. data/lib/oauth/tokens/server_token.rb +9 -0
  47. data/lib/oauth/tokens/token.rb +17 -0
  48. data/lib/oauth/version.rb +3 -0
  49. data/oauth.gemspec +49 -0
  50. data/script/destroy +14 -0
  51. data/script/generate +14 -0
  52. data/script/txt2html +74 -0
  53. data/setup.rb +1585 -0
  54. data/tasks/deployment.rake +34 -0
  55. data/tasks/environment.rake +7 -0
  56. data/tasks/website.rake +17 -0
  57. data/test/cases/oauth_case.rb +19 -0
  58. data/test/cases/spec/1_0-final/test_construct_request_url.rb +62 -0
  59. data/test/cases/spec/1_0-final/test_normalize_request_parameters.rb +88 -0
  60. data/test/cases/spec/1_0-final/test_parameter_encodings.rb +86 -0
  61. data/test/cases/spec/1_0-final/test_signature_base_strings.rb +77 -0
  62. data/test/keys/rsa.cert +11 -0
  63. data/test/keys/rsa.pem +16 -0
  64. data/test/test_access_token.rb +28 -0
  65. data/test/test_action_controller_request_proxy.rb +127 -0
  66. data/test/test_consumer.rb +327 -0
  67. data/test/test_helper.rb +10 -0
  68. data/test/test_hmac_sha1.rb +21 -0
  69. data/test/test_net_http_client.rb +187 -0
  70. data/test/test_net_http_request_proxy.rb +73 -0
  71. data/test/test_oauth_helper.rb +50 -0
  72. data/test/test_rack_request_proxy.rb +40 -0
  73. data/test/test_request_token.rb +53 -0
  74. data/test/test_rsa_sha1.rb +59 -0
  75. data/test/test_server.rb +40 -0
  76. data/test/test_signature.rb +19 -0
  77. data/test/test_signature_base.rb +32 -0
  78. data/test/test_signature_plain_text.rb +31 -0
  79. data/test/test_token.rb +14 -0
  80. data/website/index.html +87 -0
  81. data/website/index.txt +73 -0
  82. data/website/javascripts/rounded_corners_lite.inc.js +285 -0
  83. data/website/stylesheets/screen.css +138 -0
  84. data/website/template.rhtml +48 -0
  85. metadata +241 -0
@@ -0,0 +1,83 @@
1
+ == 0.3.4 2009-05-06
2
+
3
+ * OAuth::Client::Helper uses OAuth::VERSION (chadisfaction)
4
+ * Fix OAuth::RequestProxy::ActionControllerRequest's handling of params
5
+ (Tristan Groléat)
6
+
7
+ == 0.3.3 2009-05-04
8
+
9
+ * Corrected OAuth XMPP namespace (Seth)
10
+ * Improved error handling for invalid Authorization headers (Matt Sanford)
11
+ * Fixed signatures for non-ASCII under $KCODE other than 'u' (Matt Sanford)
12
+ * Fixed edge cases in ActionControllerRequestProxy where params were being
13
+ incorrectly signed (Marcos Wright Kuhns)
14
+ * Support for arguments in OAuth::Consumer#get_access_token (Matt Sanford)
15
+ * Add gem version to user-agent header (Matt Sanford)
16
+ * Handle input from aggressive form encoding libraries (Matt Wood)
17
+
18
+ == 0.3.2 2009-03-23
19
+
20
+ * 2xx statuses should be treated as success (Anders Conbere)
21
+ * Support applications using the MethodOverride Rack middleware (László Bácsi)
22
+ * `authorize` command for `oauth` CLI (Seth)
23
+ * Initial support for Problem Reporting extension (Seth)
24
+ * Verify SSL certificates if CA certificates are available (Seth)
25
+ * Fixed ActionController parameter escaping behavior (Thiago Arrais, László
26
+ Bácsi, Brett Gibson, et al)
27
+ * Fixed signature calculation when both options and a block were provided to
28
+ OAuth::Signature::Base#initialize (Seth)
29
+ * Added help to the 'oauth' CLI (Seth)
30
+ * Fixed a problem when attempting to normalize MockRequest URIs (Seth)
31
+
32
+ == 0.3.1 2009-1-26
33
+
34
+ * Fixed a problem with relative and absolute token request paths. (Michael
35
+ Wood)
36
+
37
+ == 0.3.0 2009-1-25
38
+
39
+ * Support ActionController::Request from Edge Rails (László Bácsi)
40
+ * Correctly handle multi-valued parameters (Seth)
41
+ * Added #normalized_parameters to OAuth::RequestProxy::Base (Pelle)
42
+ * OAuth::Signature.sign and friends now yield the RequestProxy instead of the
43
+ token when the passed block's arity is 1. (Seth)
44
+ * Token requests are made to the configured URL rather than generating a
45
+ potentially incorrect one. (Kellan Elliott-McCrea)
46
+ * Command-line app for generating signatures. (Seth)
47
+ * Improved test-cases and compatibility for encoding issues. (Pelle)
48
+
49
+ == 0.2.7 2008-9-10 The lets fix the last release release
50
+
51
+ * Fixed plain text signatures (Andrew Arrow)
52
+ * Fixed RSA requests using OAuthTokens. (Philip Lipu Tsai)
53
+
54
+ == 0.2.6 2008-9-9 The lets RSA release
55
+
56
+ * Improved support for Ruby 1.8.7 (Bill Kocik)
57
+ * Fixed RSA verification to support RSA providers
58
+ now using Ruby and RSA
59
+ * Improved RSA testing
60
+ * Omit token when signing with RSA
61
+ * Added support for 'private_key_file' option for RSA signatures (Chris Mear)
62
+ * Fixed several edge cases where params were being incorrectly signed (Scott
63
+ Hill)
64
+ * Fixed RSA signing (choonkeat)
65
+
66
+ == 0.2.2 2008-2-22 Lets actually support SSL release
67
+
68
+ * Use HTTPS when required.
69
+
70
+ == 0.2 2008-1-19 All together now release
71
+
72
+ This is a big release, where we have merged the efforts of various parties into one common library. This means there are definitely some API changes you should be aware of. They should be minimal but please have a look at the unit tests.
73
+
74
+ == 0.1.2 2007-12-1
75
+
76
+ * Fixed checks for missing OAuth params to improve performance
77
+ * Includes Pat's fix for getting the realm out.
78
+
79
+ == 0.1.1 2007-11-26
80
+
81
+ * First release as a GEM
82
+ * Moved all non-Rails functionality from the Rails plugin:
83
+ http://code.google.com/p/oauth-plugin/
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2007 Blaine Cook, Larry Halff, Pelle Braendgaard
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,84 @@
1
+ History.txt
2
+ License.txt
3
+ Manifest.txt
4
+ README.rdoc
5
+ Rakefile
6
+ TODO
7
+ bin/oauth
8
+ examples/yql.rb
9
+ lib/oauth.rb
10
+ lib/oauth/oauth.rb
11
+ lib/oauth/cli.rb
12
+ lib/oauth/client.rb
13
+ lib/oauth/client/action_controller_request.rb
14
+ lib/oauth/client/helper.rb
15
+ lib/oauth/client/net_http.rb
16
+ lib/oauth/consumer.rb
17
+ lib/oauth/errors.rb
18
+ lib/oauth/errors/error.rb
19
+ lib/oauth/errors/problem.rb
20
+ lib/oauth/errors/unauthorized.rb
21
+ lib/oauth/helper.rb
22
+ lib/oauth/oauth_test_helper.rb
23
+ lib/oauth/request_proxy.rb
24
+ lib/oauth/request_proxy/action_controller_request.rb
25
+ lib/oauth/request_proxy/base.rb
26
+ lib/oauth/request_proxy/jabber_request.rb
27
+ lib/oauth/request_proxy/mock_request.rb
28
+ lib/oauth/request_proxy/net_http.rb
29
+ lib/oauth/request_proxy/rack_request.rb
30
+ lib/oauth/server.rb
31
+ lib/oauth/signature.rb
32
+ lib/oauth/signature/base.rb
33
+ lib/oauth/signature/hmac/base.rb
34
+ lib/oauth/signature/hmac/md5.rb
35
+ lib/oauth/signature/hmac/rmd160.rb
36
+ lib/oauth/signature/hmac/sha1.rb
37
+ lib/oauth/signature/hmac/sha2.rb
38
+ lib/oauth/signature/md5.rb
39
+ lib/oauth/signature/plaintext.rb
40
+ lib/oauth/signature/rsa/sha1.rb
41
+ lib/oauth/signature/sha1.rb
42
+ lib/oauth/token.rb
43
+ lib/oauth/tokens/access_token.rb
44
+ lib/oauth/tokens/consumer_token.rb
45
+ lib/oauth/tokens/request_token.rb
46
+ lib/oauth/tokens/server_token.rb
47
+ lib/oauth/tokens/token.rb
48
+ lib/oauth/version.rb
49
+ oauth.gemspec
50
+ script/destroy
51
+ script/generate
52
+ script/txt2html
53
+ setup.rb
54
+ tasks/deployment.rake
55
+ tasks/environment.rake
56
+ tasks/website.rake
57
+ test/cases/oauth_case.rb
58
+ test/cases/spec/1_0-final/test_construct_request_url.rb
59
+ test/cases/spec/1_0-final/test_normalize_request_parameters.rb
60
+ test/cases/spec/1_0-final/test_parameter_encodings.rb
61
+ test/cases/spec/1_0-final/test_signature_base_strings.rb
62
+ test/keys/rsa.cert
63
+ test/keys/rsa.pem
64
+ test/test_access_token.rb
65
+ test/test_action_controller_request_proxy.rb
66
+ test/test_consumer.rb
67
+ test/test_helper.rb
68
+ test/test_hmac_sha1.rb
69
+ test/test_net_http_client.rb
70
+ test/test_net_http_request_proxy.rb
71
+ test/test_oauth_helper.rb
72
+ test/test_rack_request_proxy.rb
73
+ test/test_request_token.rb
74
+ test/test_rsa_sha1.rb
75
+ test/test_server.rb
76
+ test/test_signature.rb
77
+ test/test_signature_base.rb
78
+ test/test_signature_plain_text.rb
79
+ test/test_token.rb
80
+ website/index.html
81
+ website/index.txt
82
+ website/javascripts/rounded_corners_lite.inc.js
83
+ website/stylesheets/screen.css
84
+ website/template.rhtml
@@ -0,0 +1,71 @@
1
+ = Ruby OAuth GEM
2
+
3
+ == What
4
+
5
+ This is a RubyGem for implementing both OAuth clients and servers in Ruby applications.
6
+
7
+ See the OAuth specs http://oauth.net/core/1.0/
8
+
9
+ == Installing
10
+
11
+ sudo gem install oauth
12
+
13
+ You can also install it from the oauth rubyforge project http://rubyforge.org/projects/oauth/.
14
+
15
+ The source code is now hosted on the OAuth GitHub Project http://github.com/mojodna/oauth
16
+
17
+ == The basics
18
+
19
+ This is a ruby library which is intended to be used in creating Ruby Consumer and Service Provider applications. It is NOT a Rails plugin, but could easily be used for the foundation for such a Rails plugin.
20
+
21
+ As a matter of fact it has been pulled out from an OAuth Rails Plugin http://code.google.com/p/oauth-plugin/ which now requires this GEM.
22
+
23
+ == Demonstration of usage
24
+
25
+ Create a new consumer instance by passing it a configuration hash:
26
+
27
+ @consumer = OAuth::Consumer.new("key","secret", :site => "https://agree2")
28
+
29
+ Start the process by requesting a token
30
+
31
+ @request_token = @consumer.get_request_token
32
+ session[:request_token] = @request_token
33
+ redirect_to @request_token.authorize_url
34
+
35
+ When user returns create an access_token
36
+
37
+ @access_token = @request_token.get_access_token
38
+ @photos = @access_token.get('/photos.xml')
39
+
40
+ For more detailed instructions I have written this OAuth Client Tutorial http://stakeventures.com/articles/2008/02/23/developing-oauth-clients-in-ruby and "How to turn your rails site into an OAuth Provider ":http://stakeventures.com/articles/2007/11/26/how-to-turn-your-rails-site-into-an-oauth-provider .
41
+
42
+ Finally be sure to check out the OAuth RDoc Manual http://oauth.rubyforge.org/rdoc/ .
43
+
44
+ == Documentation Wiki
45
+
46
+ There is some documentation on the Google Code project for the "OAuth Rails Plugin":http://code.google.com/p/oauth-plugin/ :
47
+
48
+ * RequestToken http://code.google.com/p/oauth-plugin/wiki/RequestToken
49
+ * AccessToken http://code.google.com/p/oauth-plugin/wiki/AccessToken
50
+
51
+ == Forum
52
+
53
+ http://groups.google.com/group/oauth-ruby
54
+
55
+
56
+ == How to submit patches
57
+
58
+ Read the "8 steps for fixing other people's code" http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
59
+
60
+ The source code is now hosted on the OAuth GitHub Project http://github.com/mojodna/oauth
61
+
62
+ To submit a patch, please fork the oauth project and create a patch with tests. Once you're happy with it send a pull request and post a message to the google group.
63
+
64
+ == License
65
+
66
+ This code is free to use under the terms of the MIT license.
67
+
68
+ == Contact
69
+
70
+ Comments are welcome. Send an email to "Pelle Braendgaard" pelleb@gmail.com email via the OAuth Ruby mailing list http://groups.google.com/group/oauth-ruby
71
+
@@ -0,0 +1,36 @@
1
+ %w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
2
+ $LOAD_PATH << File.dirname(__FILE__) + '/lib'
3
+ require 'oauth'
4
+ require 'oauth/version'
5
+
6
+ # Generate all the Rake tasks
7
+ # Run 'rake -T' to see list of generated tasks (from gem root directory)
8
+ $hoe = Hoe.new('oauth', OAuth::VERSION) do |p|
9
+ p.author = ['Pelle Braendgaard','Blaine Cook','Larry Halff','Jesse Clark','Jon Crosby', 'Seth Fitzsimmons']
10
+ p.email = "oauth-ruby@googlegroups.com"
11
+ p.description = "OAuth Core Ruby implementation"
12
+ p.summary = p.description
13
+ p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
14
+ p.rubyforge_name = p.name # TODO this is default value
15
+ p.url = "http://oauth.rubyforge.org"
16
+
17
+ p.extra_deps = [
18
+ ['ruby-hmac','>= 0.3.1']
19
+ ]
20
+ p.extra_dev_deps = [
21
+ ['newgem', ">= #{::Newgem::VERSION}"],
22
+ ['actionpack'],
23
+ ['rack']
24
+ ]
25
+
26
+ p.clean_globs |= %w[**/.DS_Store tmp *.log **/.*.sw? *.gem .config **/.DS_Store]
27
+ path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
28
+ p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
29
+ p.rsync_args = '-av --delete --ignore-errors'
30
+ end
31
+
32
+ require 'newgem/tasks' # load /tasks/*.rake
33
+ Dir['tasks/**/*.rake'].each { |t| load t }
34
+
35
+ # TODO - want other tests/tasks run by default? Add them to the list
36
+ # task :default => [:spec, :features]
data/TODO ADDED
@@ -0,0 +1,31 @@
1
+ Common use-cases should be streamlined:
2
+
3
+ * I have a URL that I want to sign (given consumer key/secret, optional
4
+ token/secret, optional nonce/timestamp).
5
+ * I have a URL that I want to sign AND I want to see what the components
6
+ (e.g. signature base string, etc.) are while it's being signed (i.e. verbose
7
+ signing).
8
+ * I have a URL that I want to sign and I only want the signature.
9
+ * I have a URL that I want to sign and I want something suitable to put in
10
+ {the header, the querystring, XMPP}.
11
+ * I want to make a query to an OAuth-enabled web service (with sensible
12
+ errors, if available).
13
+ * I want to host an OAuth-enabled web service.
14
+ * I want to test my OAuth-enabled web service (i.e. test helpers)
15
+
16
+ Example applications for:
17
+ * Ning
18
+ * Fire Eagle
19
+ * Google (blogger, contacts)
20
+ * Twitter
21
+ * YOS / YQL
22
+ * Netflix
23
+
24
+ In addition to providing best practices of use, these can also be part of
25
+ the pre-release checks to make sure that there have been no regressions.
26
+
27
+ Random TODOs:
28
+ * finish CLI
29
+ * sensible Exception hierarchy
30
+ * Tokens as Modules
31
+ * don't tie to Net::HTTP
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby -w -rubygems
2
+
3
+ require "oauth/cli"
4
+
5
+ OAuth::CLI.execute(STDOUT, STDIN, STDERR, ARGV)
@@ -0,0 +1,44 @@
1
+ #!/usr/bin/env ruby -rubygems
2
+
3
+ # Sample queries:
4
+ # ./yql.rb --consumer-key <key> --consumer-secret <secret> "show tables"
5
+ # ./yql.rb --consumer-key <key> --consumer-secret <secret> "select * from flickr.photos.search where text='Cat' limit 10"
6
+
7
+ require 'oauth'
8
+ require 'optparse'
9
+ require 'json'
10
+ require 'pp'
11
+
12
+ options = {}
13
+
14
+ option_parser = OptionParser.new do |opts|
15
+ opts.banner = "Usage: #{$0} [options] <query>"
16
+
17
+ opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
18
+ options[:consumer_key] = v
19
+ end
20
+
21
+ opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
22
+ options[:consumer_secret] = v
23
+ end
24
+ end
25
+
26
+ option_parser.parse!
27
+ query = ARGV.pop
28
+ query = STDIN.read if query == "-"
29
+
30
+ if options[:consumer_key].nil? || options[:consumer_secret].nil? || query.nil?
31
+ puts option_parser.help
32
+ exit 1
33
+ end
34
+
35
+ consumer = OAuth::Consumer.new \
36
+ options[:consumer_key],
37
+ options[:consumer_secret],
38
+ :site => "http://query.yahooapis.com"
39
+
40
+ access_token = OAuth::AccessToken.new(consumer)
41
+
42
+ response = access_token.request(:get, url = "/v1/yql?q=#{OAuth::Helper.escape(query)}&format=json")
43
+ rsp = JSON.parse(response.body)
44
+ pp rsp
@@ -0,0 +1,4 @@
1
+ require 'oauth/oauth'
2
+ require 'oauth/client/helper'
3
+ require 'oauth/signature/hmac/sha1'
4
+ require 'oauth/request_proxy/mock_request'
@@ -0,0 +1,300 @@
1
+ require 'optparse'
2
+ require 'oauth'
3
+
4
+ module OAuth
5
+ class CLI
6
+ SUPPORTED_COMMANDS = {
7
+ "authorize" => "Obtain an access token and secret for a user",
8
+ "debug" => "Verbosely generate an OAuth signature",
9
+ "sign" => "Generate an OAuth signature"
10
+ }
11
+
12
+ attr_reader :command
13
+ attr_reader :options
14
+ attr_reader :stdout, :stdin
15
+
16
+ def self.execute(stdout, stdin, stderr, arguments = [])
17
+ self.new.execute(stdout, stdin, stderr, arguments)
18
+ end
19
+
20
+ def initialize
21
+ @options = {}
22
+
23
+ # don't dump a backtrace on a ^C
24
+ trap(:INT) {
25
+ exit
26
+ }
27
+ end
28
+
29
+ def execute(stdout, stdin, stderr, arguments = [])
30
+ @stdout = stdout
31
+ @stdin = stdin
32
+ @stderr = stderr
33
+ extract_command_and_parse_options(arguments)
34
+
35
+ if sufficient_options? && valid_command?
36
+ if command == "debug"
37
+ @command = "sign"
38
+ @options[:verbose] = true
39
+ end
40
+
41
+ case command
42
+ # TODO move command logic elsewhere
43
+ when "authorize"
44
+ # Y! token authority requires realm=yahoo.com when headers are in use
45
+ # TODO remove :scheme when that's been fixed
46
+ # TODO determine endpoints w/ X-RDS-Simple
47
+ consumer = OAuth::Consumer.new \
48
+ options[:oauth_consumer_key],
49
+ options[:oauth_consumer_secret],
50
+ :access_token_url => options[:access_token_url],
51
+ :authorize_url => options[:authorize_url],
52
+ :request_token_url => options[:request_token_url],
53
+ :scheme => :query_string
54
+
55
+ # get a request token
56
+ request_token = consumer.get_request_token
57
+
58
+ stdout.puts "Please visit this url to authorize:"
59
+ stdout.puts request_token.authorize_url
60
+
61
+ stdout.puts "Press return to continue..."
62
+ stdin.gets
63
+
64
+ begin
65
+ # get an access token
66
+ access_token = request_token.get_access_token
67
+
68
+ stdout.puts "Response:"
69
+ access_token.params.each do |k,v|
70
+ stdout.puts " #{k}: #{v}"
71
+ end
72
+ rescue OAuth::Unauthorized => e
73
+ stderr.puts "A problem occurred while attempting to obtain an access token:"
74
+ stderr.puts e
75
+ end
76
+ when "sign"
77
+ parameters = prepare_parameters
78
+
79
+ request = OAuth::RequestProxy.proxy \
80
+ "method" => options[:method],
81
+ "uri" => options[:uri],
82
+ "parameters" => parameters
83
+
84
+ if verbose?
85
+ stdout.puts "OAuth parameters:"
86
+ request.oauth_parameters.each do |k,v|
87
+ stdout.puts " " + [k, v] * ": "
88
+ end
89
+ stdout.puts
90
+
91
+ if request.non_oauth_parameters.any?
92
+ stdout.puts "Parameters:"
93
+ request.non_oauth_parameters.each do |k,v|
94
+ stdout.puts " " + [k, v] * ": "
95
+ end
96
+ stdout.puts
97
+ end
98
+ end
99
+
100
+ request.sign! \
101
+ :consumer_secret => options[:oauth_consumer_secret],
102
+ :token_secret => options[:oauth_token_secret]
103
+
104
+ if verbose?
105
+ stdout.puts "Method: #{request.method}"
106
+ stdout.puts "URI: #{request.uri}"
107
+ stdout.puts "Normalized params: #{request.normalized_parameters}" unless options[:xmpp]
108
+ stdout.puts "Signature base string: #{request.signature_base_string}"
109
+
110
+ if options[:xmpp]
111
+ stdout.puts
112
+ stdout.puts "XMPP Stanza:"
113
+ stdout.puts <<-EOS
114
+ <oauth xmlns='urn:xmpp:oauth:0'>
115
+ <oauth_consumer_key>#{request.oauth_consumer_key}</oauth_consumer_key>
116
+ <oauth_token>#{request.oauth_token}</oauth_token>
117
+ <oauth_signature_method>#{request.oauth_signature_method}</oauth_signature_method>
118
+ <oauth_signature>#{request.oauth_signature}</oauth_signature>
119
+ <oauth_timestamp>#{request.oauth_timestamp}</oauth_timestamp>
120
+ <oauth_nonce>#{request.oauth_nonce}</oauth_nonce>
121
+ <oauth_version>#{request.oauth_version}</oauth_version>
122
+ </oauth>
123
+ EOS
124
+ stdout.puts
125
+ stdout.puts "Note: You may want to use bare JIDs in your URI."
126
+ stdout.puts
127
+ else
128
+ stdout.puts "OAuth Request URI: #{request.signed_uri}"
129
+ stdout.puts "Request URI: #{request.signed_uri(false)}"
130
+ stdout.puts "Authorization header: #{request.oauth_header(:realm => options[:realm])}"
131
+ end
132
+ stdout.puts "Signature: #{request.oauth_signature}"
133
+ stdout.puts "Escaped signature: #{OAuth::Helper.escape(request.oauth_signature)}"
134
+ else
135
+ stdout.puts request.oauth_signature
136
+ end
137
+ end
138
+ else
139
+ usage
140
+ end
141
+ end
142
+
143
+ protected
144
+
145
+ def extract_command_and_parse_options(arguments)
146
+ @command = arguments[-1]
147
+ parse_options(arguments[0..-1])
148
+ end
149
+
150
+ def option_parser
151
+ option_parser = OptionParser.new do |opts|
152
+ opts.banner = "Usage: #{$0} [options] <command>"
153
+
154
+ # defaults
155
+ options[:oauth_nonce] = OAuth::Helper.generate_key
156
+ options[:oauth_signature_method] = "HMAC-SHA1"
157
+ options[:oauth_timestamp] = OAuth::Helper.generate_timestamp
158
+ options[:oauth_version] = "1.0"
159
+ options[:params] = []
160
+
161
+ ## Common Options
162
+
163
+ opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
164
+ options[:oauth_consumer_key] = v
165
+ end
166
+
167
+ opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
168
+ options[:oauth_consumer_secret] = v
169
+ end
170
+
171
+ ## Options for signing
172
+
173
+ opts.on("--method METHOD", "Specifies the method (e.g. GET) to use when signing.") do |v|
174
+ options[:method] = v
175
+ end
176
+
177
+ opts.on("--nonce NONCE", "Specifies the none to use.") do |v|
178
+ options[:oauth_nonce] = v
179
+ end
180
+
181
+ opts.on("--parameters PARAMS", "Specifies the parameters to use when signing.") do |v|
182
+ options[:params] << v
183
+ end
184
+
185
+ opts.on("--signature-method METHOD", "Specifies the signature method to use; defaults to HMAC-SHA1.") do |v|
186
+ options[:oauth_signature_method] = v
187
+ end
188
+
189
+ opts.on("--secret SECRET", "Specifies the token secret to use.") do |v|
190
+ options[:oauth_token_secret] = v
191
+ end
192
+
193
+ opts.on("--timestamp TIMESTAMP", "Specifies the timestamp to use.") do |v|
194
+ options[:oauth_timestamp] = v
195
+ end
196
+
197
+ opts.on("--token TOKEN", "Specifies the token to use.") do |v|
198
+ options[:oauth_token] = v
199
+ end
200
+
201
+ opts.on("--realm REALM", "Specifies the realm to use.") do |v|
202
+ options[:realm] = v
203
+ end
204
+
205
+ opts.on("--uri URI", "Specifies the URI to use when signing.") do |v|
206
+ options[:uri] = v
207
+ end
208
+
209
+ opts.on("--version VERSION", "Specifies the OAuth version to use.") do |v|
210
+ options[:oauth_version] = v
211
+ end
212
+
213
+ opts.on("--no-version", "Omit oauth_version.") do
214
+ options[:oauth_version] = nil
215
+ end
216
+
217
+ opts.on("--xmpp", "Generate XMPP stanzas.") do
218
+ options[:xmpp] = true
219
+ options[:method] ||= "iq"
220
+ end
221
+
222
+ opts.on("-v", "--verbose", "Be verbose.") do
223
+ options[:verbose] = true
224
+ end
225
+
226
+ ## Options for authorization
227
+
228
+ opts.on("--access-token-url URL", "Specifies the access token URL.") do |v|
229
+ options[:access_token_url] = v
230
+ end
231
+
232
+ opts.on("--authorize-url URL", "Specifies the authorization URL.") do |v|
233
+ options[:authorize_url] = v
234
+ end
235
+
236
+ opts.on("--request-token-url URL", "Specifies the request token URL.") do |v|
237
+ options[:request_token_url] = v
238
+ end
239
+ end
240
+ end
241
+
242
+ def parse_options(arguments)
243
+ option_parser.parse!(arguments)
244
+ end
245
+
246
+ def prepare_parameters
247
+ escaped_pairs = options[:params].collect do |pair|
248
+ if pair =~ /:/
249
+ Hash[*pair.split(":", 2)].collect do |k,v|
250
+ [CGI.escape(k.strip), CGI.escape(v.strip)] * "="
251
+ end
252
+ else
253
+ pair
254
+ end
255
+ end
256
+
257
+ querystring = escaped_pairs * "&"
258
+ cli_params = CGI.parse(querystring)
259
+
260
+ {
261
+ "oauth_consumer_key" => options[:oauth_consumer_key],
262
+ "oauth_nonce" => options[:oauth_nonce],
263
+ "oauth_timestamp" => options[:oauth_timestamp],
264
+ "oauth_token" => options[:oauth_token],
265
+ "oauth_signature_method" => options[:oauth_signature_method],
266
+ "oauth_version" => options[:oauth_version]
267
+ }.reject { |k,v| v.nil? || v == "" }.merge(cli_params)
268
+ end
269
+
270
+ def sufficient_options?
271
+ case command
272
+ # TODO move command logic elsewhere
273
+ when "authorize"
274
+ options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
275
+ options[:access_token_url] && options[:authorize_url] &&
276
+ options[:request_token_url]
277
+ else
278
+ options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
279
+ options[:method] && options[:uri]
280
+ end
281
+ end
282
+
283
+ def usage
284
+ stdout.puts option_parser.help
285
+ stdout.puts
286
+ stdout.puts "Available commands:"
287
+ SUPPORTED_COMMANDS.each do |command, desc|
288
+ puts " #{command.ljust(15)}#{desc}"
289
+ end
290
+ end
291
+
292
+ def valid_command?
293
+ SUPPORTED_COMMANDS.keys.include?(command)
294
+ end
295
+
296
+ def verbose?
297
+ options[:verbose]
298
+ end
299
+ end
300
+ end