oauth 0.5.0 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b45dc41aae4a7483d4dc3f37231ed79084a7c8e
-  data.tar.gz: c82a432eb7f1a7ab2cb704eedd1ae9da15daed2c
+SHA256:
+  metadata.gz: 56561f5f687d933f2683b93c5d7a426c3202da9b6659cc69d8ef43c36766bb9b
+  data.tar.gz: 71d7d2890d9b2261b85752ba2844eb96d7538a5121b9b72bcef3d00347e91bcf
 SHA512:
-  metadata.gz: 6b3a8ebb69c99d98762a66ddaec9074ee6161824405f04dab2d057e8059fa6cb298985c951479980c41800508a11edbc439a38602e39384add3c2a9424be8975
-  data.tar.gz: 65f7255a19a1def380575faa1a97d95ec78821fcf687ff8f914a10d367dcc6e05d1681e4a7b9106973e5a50618457e35d8c1b07adbf21919e668345ca18143ab
+  metadata.gz: 4bbb7ec6242a2fdeadcae61c5279d42e00d9b29318511b80ea5a0215b8cdfba15c10be2ef0abb74bb21038acff22e27ef59125a8148ab28817f79d89b792707d
+  data.tar.gz: 3ad73ee2f52bf3507b274e923fe2352f7e5cda860e8765a9b062f33abfbc61909e5ff15ced0ce7d5aa66489f002f056f2fbb720f70b179c6eb729c52b7ce76e1

data/README.rdoc

@@ -1,5 +1,11 @@
 = Ruby OAuth
 
+== Status
+
+{<img src="https://travis-ci.org/oauth-xx/oauth-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/oauth-xx/oauth-ruby]
+
+
+
 == What
 
 This is a RubyGem for implementing both OAuth clients and servers in Ruby applications.
@@ -16,31 +22,38 @@ The source code is now hosted on the OAuth GitHub Project http://github.com/oaut
 
 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.
 
-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.
+As a matter of fact it has been pulled out from an OAuth Rails GEM (https://rubygems.org/gems/oauth-plugin https://github.com/pelle/oauth-plugin) which now uses this gem as a dependency.
 
 == Demonstration of usage
 
 We need to specify the oauth_callback url explicitly, otherwise it defaults to "oob" (Out of Band)
 
-  @callback_url = "http://127.0.0.1:3000/oauth/callback"
+  callback_url = "http://127.0.0.1:3000/oauth/callback"
 
-Create a new consumer instance by passing it a configuration hash:
+Create a new `OAuth::Consumer` instance by passing it a configuration hash:
 
-  @consumer = OAuth::Consumer.new("key","secret", :site => "https://agree2")
+  oauth_consumer = OAuth::Consumer.new("key", "secret", :site => "https://agree2")
 
 Start the process by requesting a token
 
-  @request_token = @consumer.get_request_token(:oauth_callback => @callback_url)
-  session[:request_token] = @request_token
-  redirect_to @request_token.authorize_url(:oauth_callback => @callback_url)
+  request_token = oauth_consumer.get_request_token(:oauth_callback => callback_url)
+
+  session[:token] = request_token.token
+  session[:token_secret] = request_token.secret
+  redirect_to request_token.authorize_url(:oauth_callback => callback_url)
 
 When user returns create an access_token
 
-  @access_token = @request_token.get_access_token
-  @photos = @access_token.get('/photos.xml')
+  hash = { oauth_token: session[:token], oauth_token_secret: session[:token_secret]}
+  request_token  = OAuth::RequestToken.from_hash(oauth_consumer, hash)
+  access_token = request_token.get_access_token
+  # For 3-legged authorization, flow oauth_verifier is passed as param in callback
+  # access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier]) 
+  @photos = access_token.get('/photos.xml')
 
 Now that you have an access token, you can use Typhoeus to interact with the OAuth provider if you choose.
 
+  require 'typhoeus'
   require 'oauth/request_proxy/typhoeus_request'
   oauth_params = {:consumer => oauth_consumer, :token => access_token}
   hydra = Typhoeus::Hydra.new

data/bin/oauth

@@ -1,5 +1,11 @@
 #!/usr/bin/env ruby
 
-require "oauth/cli"
+require_relative "../lib/oauth"
+require 'oauth/cli'
 
-OAuth::CLI.execute(STDOUT, STDIN, STDERR, ARGV)
+Signal.trap("INT") { puts; exit(1) } # don't dump a backtrace on a ^C
+
+ARGV << 'help' if ARGV.empty?
+command = ARGV.shift
+
+OAuth::CLI.new(STDOUT, STDIN, STDERR, command, ARGV).run

data/lib/oauth.rb

@@ -1,9 +1,9 @@
-$LOAD_PATH << File.dirname(__FILE__) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+root = File.dirname(__FILE__)
+$LOAD_PATH << root unless $LOAD_PATH.include?(root)
 
 require 'oauth/version'
 
 require 'oauth/oauth'
-require 'oauth/core_ext'
 
 require 'oauth/client/helper'
 require 'oauth/signature/hmac/sha1'

data/lib/oauth/cli.rb

@@ -1,378 +1,56 @@
 require 'optparse'
-require 'oauth'
+require 'oauth/cli/base_command'
+require 'oauth/cli/help_command'
+require 'oauth/cli/query_command'
+require 'oauth/cli/authorize_command'
+require 'oauth/cli/sign_command'
+require 'oauth/cli/version_command'
+require 'active_support/core_ext/string/inflections'
 
 module OAuth
   class CLI
-    SUPPORTED_COMMANDS = {
-      "authorize" => "Obtain an access token and secret for a user",
-      "debug"     => "Verbosely generate an OAuth signature",
-      "query"     => "Query a protected resource",
-      "sign"      => "Generate an OAuth signature",
-      "version"   => "Display the current version of the library"
-    }
-
-    attr_reader :command
-    attr_reader :options
-    attr_reader :stdout, :stdin
-
-    def self.execute(stdout, stdin, stderr, arguments = [])
-      self.new.execute(stdout, stdin, stderr, arguments)
-    end
-
-    def initialize
-      @options = {}
-
-      # don't dump a backtrace on a ^C
-      trap(:INT) {
-        exit
-      }
-    end
-
-    def execute(stdout, stdin, stderr, arguments = [])
-      @stdout = stdout
-      @stdin  = stdin
-      @stderr = stderr
-      extract_command_and_parse_options(arguments)
-
-      if sufficient_options? && valid_command?
-        if command == "debug"
-          @command = "sign"
-          @options[:verbose] = true
-        end
-
-        case command
-        # TODO move command logic elsewhere
-        when "authorize"
-          begin
-            consumer = OAuth::Consumer.new \
-              options[:oauth_consumer_key],
-              options[:oauth_consumer_secret],
-              :access_token_url  => options[:access_token_url],
-              :authorize_url     => options[:authorize_url],
-              :request_token_url => options[:request_token_url],
-              :scheme            => options[:scheme],
-              :http_method       => options[:method].to_s.downcase.to_sym
-
-            # parameters for OAuth 1.0a
-            oauth_verifier = nil
-
-            # get a request token
-            request_token = consumer.get_request_token({ :oauth_callback => options[:oauth_callback] }, options[:scope] ? { "scope" => options[:scope] } : {})
-
-            if request_token.callback_confirmed?
-              stdout.puts "Server appears to support OAuth 1.0a; enabling support."
-              options[:version] = "1.0a"
-            end
-
-            stdout.puts "Please visit this url to authorize:"
-            stdout.puts request_token.authorize_url
-
-            if options[:version] == "1.0a"
-              stdout.puts "Please enter the verification code provided by the SP (oauth_verifier):"
-              oauth_verifier = stdin.gets.chomp
-            else
-              stdout.puts "Press return to continue..."
-              stdin.gets
-            end
-
-            begin
-              # get an access token
-              access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
-
-              stdout.puts "Response:"
-              access_token.params.each do |k,v|
-                stdout.puts "  #{k}: #{v}" unless k.is_a?(Symbol)
-              end
-            rescue OAuth::Unauthorized => e
-              stderr.puts "A problem occurred while attempting to obtain an access token:"
-              stderr.puts e
-              stderr.puts e.request.body
-            end
-          rescue OAuth::Unauthorized => e
-            stderr.puts "A problem occurred while attempting to authorize:"
-            stderr.puts e
-            stderr.puts e.request.body
-          end
-        when "query"
-          consumer = OAuth::Consumer.new \
-            options[:oauth_consumer_key],
-            options[:oauth_consumer_secret],
-            :scheme => options[:scheme]
-
-          access_token = OAuth::AccessToken.new(consumer, options[:oauth_token], options[:oauth_token_secret])
-
-          # append params to the URL
-          uri = URI.parse(options[:uri])
-          params = prepare_parameters.map { |k,v| v.map { |v2| "#{URI.encode(k)}=#{URI.encode(v2)}" } * "&" }
-          uri.query = [uri.query, *params].reject { |x| x.nil? } * "&"
-          p uri.to_s
-
-          response = access_token.request(options[:method].to_s.downcase.to_sym, uri.to_s)
-          puts "#{response.code} #{response.message}"
-          puts response.body
-        when "sign"
-          parameters = prepare_parameters
-
-          request = OAuth::RequestProxy.proxy \
-             "method"     => options[:method],
-             "uri"        => options[:uri],
-             "parameters" => parameters
-
-          if verbose?
-            stdout.puts "OAuth parameters:"
-            request.oauth_parameters.each do |k,v|
-              stdout.puts "  " + [k, v] * ": "
-            end
-            stdout.puts
-
-            if request.non_oauth_parameters.any?
-              stdout.puts "Parameters:"
-              request.non_oauth_parameters.each do |k,v|
-                stdout.puts "  " + [k, v] * ": "
-              end
-              stdout.puts
-            end
-          end
-
-          request.sign! \
-            :consumer_secret => options[:oauth_consumer_secret],
-            :token_secret    => options[:oauth_token_secret]
-
-          if verbose?
-            stdout.puts "Method: #{request.method}"
-            stdout.puts "URI: #{request.uri}"
-            stdout.puts "Normalized params: #{request.normalized_parameters}" unless options[:xmpp]
-            stdout.puts "Signature base string: #{request.signature_base_string}"
-
-            if options[:xmpp]
-              stdout.puts
-              stdout.puts "XMPP Stanza:"
-              stdout.puts <<-EOS
-  <oauth xmlns='urn:xmpp:oauth:0'>
-    <oauth_consumer_key>#{request.oauth_consumer_key}</oauth_consumer_key>
-    <oauth_token>#{request.oauth_token}</oauth_token>
-    <oauth_signature_method>#{request.oauth_signature_method}</oauth_signature_method>
-    <oauth_signature>#{request.oauth_signature}</oauth_signature>
-    <oauth_timestamp>#{request.oauth_timestamp}</oauth_timestamp>
-    <oauth_nonce>#{request.oauth_nonce}</oauth_nonce>
-    <oauth_version>#{request.oauth_version}</oauth_version>
-  </oauth>
-              EOS
-              stdout.puts
-              stdout.puts "Note: You may want to use bare JIDs in your URI."
-              stdout.puts
-            else
-              stdout.puts "OAuth Request URI: #{request.signed_uri}"
-              stdout.puts "Request URI: #{request.signed_uri(false)}"
-              stdout.puts "Authorization header: #{request.oauth_header(:realm => options[:realm])}"
-            end
-            stdout.puts "Signature:         #{request.oauth_signature}"
-            stdout.puts "Escaped signature: #{OAuth::Helper.escape(request.oauth_signature)}"
-          else
-            stdout.puts request.oauth_signature
-          end
-        when "version"
-          puts "OAuth for Ruby #{OAuth::VERSION}"
-        end
-      else
-        usage
-      end
+    def self.puts_red(string)
+      puts "\033[0;91m#{string}\033[0m"
     end
 
-  protected
-
-    def extract_command_and_parse_options(arguments)
-      @command = arguments[-1]
-      parse_options(arguments[0..-1])
-    end
-
-    def option_parser(arguments = "")
-      # TODO add realm parameter
-      # TODO add user-agent parameter
-      option_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: #{$0} [options] <command>"
-
-        # defaults
-        options[:oauth_nonce] = OAuth::Helper.generate_key
-        options[:oauth_signature_method] = "HMAC-SHA1"
-        options[:oauth_timestamp] = OAuth::Helper.generate_timestamp
-        options[:oauth_version] = "1.0"
-        options[:method] = :post
-        options[:params] = []
-        options[:scheme] = :header
-        options[:version] = "1.0"
-
-        ## Common Options
-
-        opts.on("-B", "--body", "Use the request body for OAuth parameters.") do
-          options[:scheme] = :body
-        end
-
-        opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
-          options[:oauth_consumer_key] = v
-        end
-
-        opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
-          options[:oauth_consumer_secret] = v
-        end
-
-        opts.on("-H", "--header", "Use the 'Authorization' header for OAuth parameters (default).") do
-          options[:scheme] = :header
-        end
-
-        opts.on("-Q", "--query-string", "Use the query string for OAuth parameters.") do
-          options[:scheme] = :query_string
-        end
-
-        opts.on("-O", "--options FILE", "Read options from a file") do |v|
-          arguments.unshift(*open(v).readlines.map { |l| l.chomp.split(" ") }.flatten)
-        end
-
-        ## Options for signing and making requests
-
-        opts.separator("\n  options for signing and querying")
-
-        opts.on("--method METHOD", "Specifies the method (e.g. GET) to use when signing.") do |v|
-          options[:method] = v
-        end
-
-        opts.on("--nonce NONCE", "Specifies the none to use.") do |v|
-          options[:oauth_nonce] = v
-        end
-
-        opts.on("--parameters PARAMS", "Specifies the parameters to use when signing.") do |v|
-          options[:params] << v
-        end
-
-        opts.on("--signature-method METHOD", "Specifies the signature method to use; defaults to HMAC-SHA1.") do |v|
-          options[:oauth_signature_method] = v
-        end
-
-        opts.on("--secret SECRET", "Specifies the token secret to use.") do |v|
-          options[:oauth_token_secret] = v
-        end
-
-        opts.on("--timestamp TIMESTAMP", "Specifies the timestamp to use.") do |v|
-          options[:oauth_timestamp] = v
-        end
-
-        opts.on("--token TOKEN", "Specifies the token to use.") do |v|
-          options[:oauth_token] = v
-        end
-
-        opts.on("--realm REALM", "Specifies the realm to use.") do |v|
-          options[:realm] = v
-        end
-
-        opts.on("--uri URI", "Specifies the URI to use when signing.") do |v|
-          options[:uri] = v
-        end
-
-        opts.on("--version [VERSION]", "Specifies the OAuth version to use.") do |v|
-          if v
-            options[:oauth_version] = v
-          else
-            @command = "version"
-          end
-        end
-
-        opts.on("--no-version", "Omit oauth_version.") do
-          options[:oauth_version] = nil
-        end
-
-        opts.on("--xmpp", "Generate XMPP stanzas.") do
-          options[:xmpp] = true
-          options[:method] ||= "iq"
-        end
-
-        opts.on("-v", "--verbose", "Be verbose.") do
-          options[:verbose] = true
-        end
-
-        ## Options for authorization
-
-        opts.separator("\n  options for authorization")
-
-        opts.on("--access-token-url URL", "Specifies the access token URL.") do |v|
-          options[:access_token_url] = v
-        end
-
-        opts.on("--authorize-url URL", "Specifies the authorization URL.") do |v|
-          options[:authorize_url] = v
-        end
-
-        opts.on("--callback-url URL", "Specifies a callback URL.") do |v|
-          options[:oauth_callback] = v
-        end
-
-        opts.on("--request-token-url URL", "Specifies the request token URL.") do |v|
-          options[:request_token_url] = v
-        end
+    ALIASES = {
+      'h' => 'help',
+      'v' => 'version',
+      'q' => 'query',
+      'a' => 'authorize',
+      's' => 'sign',
+    }
 
-        opts.on("--scope SCOPE", "Specifies the scope (Google-specific).") do |v|
-          options[:scope] = v
-        end
-      end
+    def initialize(stdout, stdin, stderr, command, arguments)
+      klass = get_command_class(parse_command(command))
+      @command = klass.new(stdout, stdin, stderr, arguments)
+      @help_command = HelpCommand.new(stdout, stdin, stderr, [])
     end
 
-    def parse_options(arguments)
-      option_parser(arguments).parse!(arguments)
+    def run
+      @command.run
     end
 
-    def prepare_parameters
-      escaped_pairs = options[:params].collect do |pair|
-        if pair =~ /:/
-          Hash[*pair.split(":", 2)].collect do |k,v|
-            [CGI.escape(k.strip), CGI.escape(v.strip)] * "="
-          end
-        else
-          pair
-        end
-      end
+    private
 
-      querystring = escaped_pairs * "&"
-      cli_params = CGI.parse(querystring)
-
-      {
-        "oauth_consumer_key"     => options[:oauth_consumer_key],
-        "oauth_nonce"            => options[:oauth_nonce],
-        "oauth_timestamp"        => options[:oauth_timestamp],
-        "oauth_token"            => options[:oauth_token],
-        "oauth_signature_method" => options[:oauth_signature_method],
-        "oauth_version"          => options[:oauth_version]
-      }.reject { |k,v| v.nil? || v == "" }.merge(cli_params)
+    def get_command_class(command)
+      Object.const_get("OAuth::CLI::#{command.camelize}Command")
     end
 
-    def sufficient_options?
-      case command
-      # TODO move command logic elsewhere
-      when "authorize"
-        options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
-          options[:access_token_url] && options[:authorize_url] &&
-          options[:request_token_url]
-      when "version"
-        true
+    def parse_command(command)
+      case command = command.to_s.downcase
+      when '--version', '-v'
+        'version'
+      when '--help', '-h', nil, ''
+        'help'
+      when *ALIASES.keys
+        ALIASES[command]
+      when *ALIASES.values
+        command
       else
-        options[:oauth_consumer_key] && options[:oauth_consumer_secret] &&
-          options[:method] && options[:uri]
-      end
-    end
-
-    def usage
-      stdout.puts option_parser.help
-      stdout.puts
-      stdout.puts "Available commands:"
-      SUPPORTED_COMMANDS.each do |command, desc|
-        puts "   #{command.ljust(15)}#{desc}"
+        OAuth::CLI.puts_red "Command '#{command}' not found"
+        'help'
       end
     end
-
-    def valid_command?
-      SUPPORTED_COMMANDS.keys.include?(command)
-    end
-
-    def verbose?
-      options[:verbose]
-    end
   end
 end