sporkd-oauth 0.3.6

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 +93 -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 +366 -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 +83 -0
  14. data/lib/oauth/client/net_http.rb +106 -0
  15. data/lib/oauth/consumer.rb +347 -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 +78 -0
  21. data/lib/oauth/oauth.rb +11 -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 +62 -0
  25. data/lib/oauth/request_proxy/base.rb +165 -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 +91 -0
  33. data/lib/oauth/signature/hmac/base.rb +16 -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 +33 -0
  45. data/lib/oauth/tokens/request_token.rb +32 -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 +46 -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 +375 -0
  67. data/test/test_helper.rb +19 -0
  68. data/test/test_hmac_sha1.rb +21 -0
  69. data/test/test_net_http_client.rb +191 -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 +206 -0
data/History.txt ADDED
@@ -0,0 +1,93 @@
1
+ == 0.3.5 2009-06-03
2
+
3
+ * `query` CLI command to access protected resources (Seth)
4
+ * Added -H, -Q CLI options for specifying the authorization scheme (Seth)
5
+ * Added -O CLI option for specifying a file containing options (Seth)
6
+ * Support streamable body contents for large request bodies (Seth Cousins)
7
+ * Support for OAuth 1.0a (Seth)
8
+ * Added proxy support to OAuth::Consumer (Marshall Huss)
9
+ * Added --scope CLI option for Google's 'scope' parameter (Seth)
10
+
11
+ == 0.3.4 2009-05-06
12
+
13
+ * OAuth::Client::Helper uses OAuth::VERSION (chadisfaction)
14
+ * Fix OAuth::RequestProxy::ActionControllerRequest's handling of params
15
+ (Tristan Groléat)
16
+
17
+ == 0.3.3 2009-05-04
18
+
19
+ * Corrected OAuth XMPP namespace (Seth)
20
+ * Improved error handling for invalid Authorization headers (Matt Sanford)
21
+ * Fixed signatures for non-ASCII under $KCODE other than 'u' (Matt Sanford)
22
+ * Fixed edge cases in ActionControllerRequestProxy where params were being
23
+ incorrectly signed (Marcos Wright Kuhns)
24
+ * Support for arguments in OAuth::Consumer#get_access_token (Matt Sanford)
25
+ * Add gem version to user-agent header (Matt Sanford)
26
+ * Handle input from aggressive form encoding libraries (Matt Wood)
27
+
28
+ == 0.3.2 2009-03-23
29
+
30
+ * 2xx statuses should be treated as success (Anders Conbere)
31
+ * Support applications using the MethodOverride Rack middleware (László Bácsi)
32
+ * `authorize` command for `oauth` CLI (Seth)
33
+ * Initial support for Problem Reporting extension (Seth)
34
+ * Verify SSL certificates if CA certificates are available (Seth)
35
+ * Fixed ActionController parameter escaping behavior (Thiago Arrais, László
36
+ Bácsi, Brett Gibson, et al)
37
+ * Fixed signature calculation when both options and a block were provided to
38
+ OAuth::Signature::Base#initialize (Seth)
39
+ * Added help to the 'oauth' CLI (Seth)
40
+ * Fixed a problem when attempting to normalize MockRequest URIs (Seth)
41
+
42
+ == 0.3.1 2009-1-26
43
+
44
+ * Fixed a problem with relative and absolute token request paths. (Michael
45
+ Wood)
46
+
47
+ == 0.3.0 2009-1-25
48
+
49
+ * Support ActionController::Request from Edge Rails (László Bácsi)
50
+ * Correctly handle multi-valued parameters (Seth)
51
+ * Added #normalized_parameters to OAuth::RequestProxy::Base (Pelle)
52
+ * OAuth::Signature.sign and friends now yield the RequestProxy instead of the
53
+ token when the passed block's arity is 1. (Seth)
54
+ * Token requests are made to the configured URL rather than generating a
55
+ potentially incorrect one. (Kellan Elliott-McCrea)
56
+ * Command-line app for generating signatures. (Seth)
57
+ * Improved test-cases and compatibility for encoding issues. (Pelle)
58
+
59
+ == 0.2.7 2008-9-10 The lets fix the last release release
60
+
61
+ * Fixed plain text signatures (Andrew Arrow)
62
+ * Fixed RSA requests using OAuthTokens. (Philip Lipu Tsai)
63
+
64
+ == 0.2.6 2008-9-9 The lets RSA release
65
+
66
+ * Improved support for Ruby 1.8.7 (Bill Kocik)
67
+ * Fixed RSA verification to support RSA providers
68
+ now using Ruby and RSA
69
+ * Improved RSA testing
70
+ * Omit token when signing with RSA
71
+ * Added support for 'private_key_file' option for RSA signatures (Chris Mear)
72
+ * Fixed several edge cases where params were being incorrectly signed (Scott
73
+ Hill)
74
+ * Fixed RSA signing (choonkeat)
75
+
76
+ == 0.2.2 2008-2-22 Lets actually support SSL release
77
+
78
+ * Use HTTPS when required.
79
+
80
+ == 0.2 2008-1-19 All together now release
81
+
82
+ 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.
83
+
84
+ == 0.1.2 2007-12-1
85
+
86
+ * Fixed checks for missing OAuth params to improve performance
87
+ * Includes Pat's fix for getting the realm out.
88
+
89
+ == 0.1.1 2007-11-26
90
+
91
+ * First release as a GEM
92
+ * Moved all non-Rails functionality from the Rails plugin:
93
+ http://code.google.com/p/oauth-plugin/
data/License.txt ADDED
@@ -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.
data/Manifest.txt ADDED
@@ -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
data/README.rdoc ADDED
@@ -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
+
data/Rakefile ADDED
@@ -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
data/bin/oauth ADDED
@@ -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)
data/examples/yql.rb ADDED
@@ -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, "/v1/yql?q=#{OAuth::Helper.escape(query)}&format=json")
43
+ rsp = JSON.parse(response.body)
44
+ pp rsp
data/lib/oauth.rb ADDED
@@ -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'
data/lib/oauth/cli.rb ADDED
@@ -0,0 +1,366 @@
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
+ "query" => "Query a protected resource",
10
+ "sign" => "Generate an OAuth signature",
11
+ "version" => "Display the current version of the library"
12
+ }
13
+
14
+ attr_reader :command
15
+ attr_reader :options
16
+ attr_reader :stdout, :stdin
17
+
18
+ def self.execute(stdout, stdin, stderr, arguments = [])
19
+ self.new.execute(stdout, stdin, stderr, arguments)
20
+ end
21
+
22
+ def initialize
23
+ @options = {}
24
+
25
+ # don't dump a backtrace on a ^C
26
+ trap(:INT) {
27
+ exit
28
+ }
29
+ end
30
+
31
+ def execute(stdout, stdin, stderr, arguments = [])
32
+ @stdout = stdout
33
+ @stdin = stdin
34
+ @stderr = stderr
35
+ extract_command_and_parse_options(arguments)
36
+
37
+ if sufficient_options? && valid_command?
38
+ if command == "debug"
39
+ @command = "sign"
40
+ @options[:verbose] = true
41
+ end
42
+
43
+ case command
44
+ # TODO move command logic elsewhere
45
+ when "authorize"
46
+ begin
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 => options[:scheme]
54
+
55
+ # parameters for OAuth 1.0a
56
+ oauth_verifier = nil
57
+
58
+ # get a request token
59
+ request_token = consumer.get_request_token({ :oauth_callback => options[:oauth_callback] }, { :scope => options[:scope] })
60
+
61
+ if request_token.callback_confirmed?
62
+ stdout.puts "Server appears to support OAuth 1.0a; enabling support."
63
+ options[:version] = "1.0a"
64
+ end
65
+
66
+ stdout.puts "Please visit this url to authorize:"
67
+ stdout.puts request_token.authorize_url
68
+
69
+ if options[:version] == "1.0a"
70
+ stdout.puts "Please enter the verification code provided by the SP (oauth_verifier):"
71
+ oauth_verifier = stdin.gets.chomp
72
+ else
73
+ stdout.puts "Press return to continue..."
74
+ stdin.gets
75
+ end
76
+
77
+ begin
78
+ # get an access token
79
+ access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
80
+
81
+ stdout.puts "Response:"
82
+ access_token.params.each do |k,v|
83
+ stdout.puts " #{k}: #{v}" unless k.is_a?(Symbol)
84
+ end
85
+ rescue OAuth::Unauthorized => e
86
+ stderr.puts "A problem occurred while attempting to obtain an access token:"
87
+ stderr.puts e
88
+ stderr.puts e.request.body
89
+ end
90
+ rescue OAuth::Unauthorized => e
91
+ stderr.puts "A problem occurred while attempting to authorize:"
92
+ stderr.puts e
93
+ stderr.puts e.request.body
94
+ end
95
+ when "query"
96
+ consumer = OAuth::Consumer.new \
97
+ options[:oauth_consumer_key],
98
+ options[:oauth_consumer_secret],
99
+ :scheme => options[:scheme]
100
+
101
+ access_token = OAuth::AccessToken.new(consumer, options[:oauth_token], options[:oauth_token_secret])
102
+
103
+ response = access_token.request(options[:method].downcase.to_sym, options[:uri])
104
+ puts "#{response.code} #{response.message}"
105
+ puts response.body
106
+ when "sign"
107
+ parameters = prepare_parameters
108
+
109
+ request = OAuth::RequestProxy.proxy \
110
+ "method" => options[:method],
111
+ "uri" => options[:uri],
112
+ "parameters" => parameters
113
+
114
+ if verbose?
115
+ stdout.puts "OAuth parameters:"
116
+ request.oauth_parameters.each do |k,v|
117
+ stdout.puts " " + [k, v] * ": "
118
+ end
119
+ stdout.puts
120
+
121
+ if request.non_oauth_parameters.any?
122
+ stdout.puts "Parameters:"
123
+ request.non_oauth_parameters.each do |k,v|
124
+ stdout.puts " " + [k, v] * ": "
125
+ end
126
+ stdout.puts
127
+ end
128
+ end
129
+
130
+ request.sign! \
131
+ :consumer_secret => options[:oauth_consumer_secret],
132
+ :token_secret => options[:oauth_token_secret]
133
+
134
+ if verbose?
135
+ stdout.puts "Method: #{request.method}"
136
+ stdout.puts "URI: #{request.uri}"
137
+ stdout.puts "Normalized params: #{request.normalized_parameters}" unless options[:xmpp]
138
+ stdout.puts "Signature base string: #{request.signature_base_string}"
139
+
140
+ if options[:xmpp]
141
+ stdout.puts
142
+ stdout.puts "XMPP Stanza:"
143
+ stdout.puts <<-EOS
144
+ <oauth xmlns='urn:xmpp:oauth:0'>
145
+ <oauth_consumer_key>#{request.oauth_consumer_key}</oauth_consumer_key>
146
+ <oauth_token>#{request.oauth_token}</oauth_token>
147
+ <oauth_signature_method>#{request.oauth_signature_method}</oauth_signature_method>
148
+ <oauth_signature>#{request.oauth_signature}</oauth_signature>
149
+ <oauth_timestamp>#{request.oauth_timestamp}</oauth_timestamp>
150
+ <oauth_nonce>#{request.oauth_nonce}</oauth_nonce>
151
+ <oauth_version>#{request.oauth_version}</oauth_version>
152
+ </oauth>
153
+ EOS
154
+ stdout.puts
155
+ stdout.puts "Note: You may want to use bare JIDs in your URI."
156
+ stdout.puts
157
+ else
158
+ stdout.puts "OAuth Request URI: #{request.signed_uri}"
159
+ stdout.puts "Request URI: #{request.signed_uri(false)}"
160
+ stdout.puts "Authorization header: #{request.oauth_header(:realm => options[:realm])}"
161
+ end
162
+ stdout.puts "Signature: #{request.oauth_signature}"
163
+ stdout.puts "Escaped signature: #{OAuth::Helper.escape(request.oauth_signature)}"
164
+ else
165
+ stdout.puts request.oauth_signature
166
+ end
167
+ when "version"
168
+ puts "OAuth for Ruby #{OAuth::VERSION}"
169
+ end
170
+ else
171
+ usage
172
+ end
173
+ end
174
+
175
+ protected
176
+
177
+ def extract_command_and_parse_options(arguments)
178
+ @command = arguments[-1]
179
+ parse_options(arguments[0..-1])
180
+ end
181
+
182
+ def option_parser(arguments = "")
183
+ # TODO add realm parameter
184
+ # TODO add user-agent parameter
185
+ option_parser = OptionParser.new do |opts|
186
+ opts.banner = "Usage: #{$0} [options] <command>"
187
+
188
+ # defaults
189
+ options[:oauth_nonce] = OAuth::Helper.generate_key
190
+ options[:oauth_signature_method] = "HMAC-SHA1"
191
+ options[:oauth_timestamp] = OAuth::Helper.generate_timestamp
192
+ options[:oauth_version] = "1.0"
193
+ options[:params] = []
194
+ options[:scheme] = :header
195
+ options[:version] = "1.0"
196
+
197
+ ## Common Options
198
+
199
+ opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
200
+ options[:oauth_consumer_key] = v
201
+ end
202
+
203
+ opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
204
+ options[:oauth_consumer_secret] = v
205
+ end
206
+
207
+ opts.on("-H", "--header", "Use the 'Authorization' header for OAuth parameters (default).") do
208
+ options[:scheme] = :header
209
+ end
210
+
211
+ opts.on("-Q", "--query-string", "Use the query string for OAuth parameters.") do
212
+ options[:scheme] = :query_string
213
+ end
214
+
215
+ opts.on("-O", "--options FILE", "Read options from a file") do |v|
216
+ arguments.unshift(*open(v).readlines.map { |l| l.chomp.split(" ") }.flatten)
217
+ end
218
+
219
+ ## Options for signing and making requests
220
+
221
+ opts.separator("\n options for signing and querying")
222
+
223
+ opts.on("--method METHOD", "Specifies the method (e.g. GET) to use when signing.") do |v|
224
+ options[:method] = v
225
+ end
226
+
227
+ opts.on("--nonce NONCE", "Specifies the none to use.") do |v|
228
+ options[:oauth_nonce] = v
229
+ end
230
+
231
+ opts.on("--parameters PARAMS", "Specifies the parameters to use when signing.") do |v|
232
+ options[:params] << v
233
+ end
234
+
235
+ opts.on("--signature-method METHOD", "Specifies the signature method to use; defaults to HMAC-SHA1.") do |v|
236
+ options[:oauth_signature_method] = v
237
+ end
238
+
239
+ opts.on("--secret SECRET", "Specifies the token secret to use.") do |v|
240
+ options[:oauth_token_secret] = v
241
+ end
242
+
243
+ opts.on("--timestamp TIMESTAMP", "Specifies the timestamp to use.") do |v|
244
+ options[:oauth_timestamp] = v
245
+ end
246
+
247
+ opts.on("--token TOKEN", "Specifies the token to use.") do |v|
248
+ options[:oauth_token] = v
249
+ end
250
+
251
+ opts.on("--realm REALM", "Specifies the realm to use.") do |v|
252
+ options[:realm] = v
253
+ end
254
+
255
+ opts.on("--uri URI", "Specifies the URI to use when signing.") do |v|
256
+ options[:uri] = v
257
+ end
258
+
259
+ opts.on(:OPTIONAL, "--version VERSION", "Specifies the OAuth version to use.") do |v|
260
+ if v
261
+ options[:oauth_version] = v
262
+ else
263
+ @command = "version"
264
+ end
265
+ end
266
+
267
+ opts.on("--no-version", "Omit oauth_version.") do
268
+ options[:oauth_version] = nil
269
+ end
270
+
271
+ opts.on("--xmpp", "Generate XMPP stanzas.") do
272
+ options[:xmpp] = true
273
+ options[:method] ||= "iq"
274
+ end
275
+
276
+ opts.on("-v", "--verbose", "Be verbose.") do
277
+ options[:verbose] = true
278
+ end
279
+
280
+ ## Options for authorization
281
+
282
+ opts.separator("\n options for authorization")
283
+
284
+ opts.on("--access-token-url URL", "Specifies the access token URL.") do |v|
285
+ options[:access_token_url] = v
286
+ end
287
+
288
+ opts.on("--authorize-url URL", "Specifies the authorization URL.") do |v|
289
+ options[:authorize_url] = v
290
+ end
291
+
292
+ opts.on("--callback-url URL", "Specifies a callback URL.") do |v|
293
+ options[:oauth_callback] = v
294
+ end
295
+
296
+ opts.on("--request-token-url URL", "Specifies the request token URL.") do |v|
297
+ options[:request_token_url] = v
298
+ end
299
+
300
+ opts.on("--scope SCOPE", "Specifies the scope (Google-specific).") do |v|
301
+ options[:scope] = v
302
+ end
303
+ end
304
+ end
305
+
306
+ def parse_options(arguments)
307
+ option_parser(arguments).parse!(arguments)
308
+ end
309
+
310
+ def prepare_parameters
311
+ escaped_pairs = options[:params].collect do |pair|
312
+ if pair =~ /:/
313
+ Hash[*pair.split(":", 2)].collect do |k,v|
314
+ [CGI.escape(k.strip), CGI.escape(v.strip)] * "="
315
+ end
316
+ else
317
+ pair
318
+ end
319
+ end
320
+
321
+ querystring = escaped_pairs * "&"
322
+ cli_params = CGI.parse(querystring)
323
+
324
+ {
325
+ "oauth_consumer_key" => options[:oauth_consumer_key],
326
+ "oauth_nonce" => options[:oauth_nonce],
327
+ "oauth_timestamp" => options[:oauth_timestamp],
328
+ "oauth_token" => options[:oauth_token],
329
+ "oauth_signature_method" => options[:oauth_signature_method],
330
+ "oauth_version" => options[:oauth_version]
331
+ }.reject { |k,v| v.nil? || v == "" }.merge(cli_params)
332
+ end
333
+
334
+ def sufficient_options?
335
+ case command
336
+ # TODO move command logic elsewhere
337
+ when "authorize"
338
+ options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
339
+ options[:access_token_url] && options[:authorize_url] &&
340
+ options[:request_token_url]
341
+ when "version"
342
+ true
343
+ else
344
+ options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
345
+ options[:method] && options[:uri]
346
+ end
347
+ end
348
+
349
+ def usage
350
+ stdout.puts option_parser.help
351
+ stdout.puts
352
+ stdout.puts "Available commands:"
353
+ SUPPORTED_COMMANDS.each do |command, desc|
354
+ puts " #{command.ljust(15)}#{desc}"
355
+ end
356
+ end
357
+
358
+ def valid_command?
359
+ SUPPORTED_COMMANDS.keys.include?(command)
360
+ end
361
+
362
+ def verbose?
363
+ options[:verbose]
364
+ end
365
+ end
366
+ end