oauth 0.5.6 → 0.6.2

data/lib/oauth/cli.rb

@@ -1,11 +1,13 @@
-require 'optparse'
-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'
+# frozen_string_literal: true
+
+require "optparse"
+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
@@ -14,12 +16,12 @@ module OAuth
     end
 
     ALIASES = {
-      'h' => 'help',
-      'v' => 'version',
-      'q' => 'query',
-      'a' => 'authorize',
-      's' => 'sign',
-    }
+      "h" => "help",
+      "v" => "version",
+      "q" => "query",
+      "a" => "authorize",
+      "s" => "sign"
+    }.freeze
 
     def initialize(stdout, stdin, stderr, command, arguments)
       klass = get_command_class(parse_command(command))
@@ -39,17 +41,17 @@ module OAuth
 
     def parse_command(command)
       case command = command.to_s.downcase
-      when '--version', '-v'
-        'version'
-      when '--help', '-h', nil, ''
-        'help'
+      when "--version", "-v"
+        "version"
+      when "--help", "-h", nil, ""
+        "help"
       when *ALIASES.keys
         ALIASES[command]
       when *ALIASES.values
         command
       else
         OAuth::CLI.puts_red "Command '#{command}' not found"
-        'help'
+        "help"
       end
     end
   end

data/lib/oauth/client/action_controller_request.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 if defined? ActionDispatch
-  require 'oauth/request_proxy/rack_request'
-  require 'oauth/request_proxy/action_dispatch_request'
-  require 'action_dispatch/testing/test_process'
+  require "oauth/request_proxy/rack_request"
+  require "oauth/request_proxy/action_dispatch_request"
+  require "action_dispatch/testing/test_process"
 else
-  require 'oauth/request_proxy/action_controller_request'
-  require 'action_controller/test_process'
+  require "oauth/request_proxy/action_controller_request"
+  require "action_controller/test_process"
 end
 
 module ActionController
   class Base
     if defined? ActionDispatch
-      def process_with_new_base_test(request, response=nil)
+      def process_with_new_base_test(request, response = nil)
         request.apply_oauth! if request.respond_to?(:apply_oauth!)
         super(request, response)
       end
     else
-      def process_with_oauth(request, response=nil)
+      def process_with_oauth(request, response = nil)
         request.apply_oauth! if request.respond_to?(:apply_oauth!)
         process_without_oauth(request, response)
       end
@@ -24,8 +26,8 @@ module ActionController
   end
 
   class TestRequest
-    def self.use_oauth=(bool)
-      @use_oauth = bool
+    class << self
+      attr_writer :use_oauth
     end
 
     def self.use_oauth?
@@ -33,33 +35,33 @@ module ActionController
     end
 
     def configure_oauth(consumer = nil, token = nil, options = {})
-      @oauth_options = { :consumer  => consumer,
-                         :token     => token,
-                         :scheme    => 'header',
-                         :signature_method => nil,
-                         :nonce     => nil,
-                         :timestamp => nil }.merge(options)
+      @oauth_options = { consumer: consumer,
+                         token: token,
+                         scheme: "header",
+                         signature_method: nil,
+                         nonce: nil,
+                         timestamp: nil }.merge(options)
     end
 
     def apply_oauth!
       return unless ActionController::TestRequest.use_oauth? && @oauth_options
 
-      @oauth_helper = OAuth::Client::Helper.new(self, @oauth_options.merge(:request_uri => (respond_to?(:fullpath) ? fullpath : request_uri)))
+      @oauth_helper = OAuth::Client::Helper.new(self,
+                                                @oauth_options.merge(request_uri: (respond_to?(:fullpath) ? fullpath : request_uri)))
       @oauth_helper.amend_user_agent_header(env)
 
-      self.send("set_oauth_#{@oauth_options[:scheme]}")
+      send("set_oauth_#{@oauth_options[:scheme]}")
     end
 
     def set_oauth_header
-      env['Authorization'] = @oauth_helper.header
+      env["Authorization"] = @oauth_helper.header
     end
 
     def set_oauth_parameters
       @query_parameters = @oauth_helper.parameters_with_oauth
-      @query_parameters.merge!(:oauth_signature => @oauth_helper.signature)
+      @query_parameters.merge!(oauth_signature: @oauth_helper.signature)
     end
 
-    def set_oauth_query_string
-    end
+    def set_oauth_query_string; end
   end
 end

data/lib/oauth/client/em_http.rb

@@ -1,119 +1,121 @@
-require 'em-http'
-require 'oauth/helper'
-require 'oauth/request_proxy/em_http_request'
+# frozen_string_literal: true
+
+require "em-http"
+require "oauth/helper"
+require "oauth/request_proxy/em_http_request"
 
 # Extensions for em-http so that we can use consumer.sign! with an EventMachine::HttpClient
 # instance. This is purely syntactic sugar.
-class EventMachine::HttpClient
-
-  attr_reader :oauth_helper
+module EventMachine
+  class HttpClient
+    attr_reader :oauth_helper
 
-  # Add the OAuth information to an HTTP request. Depending on the <tt>options[:scheme]</tt> setting
-  # this may add a header, additional query string parameters, or additional POST body parameters.
-  # The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
-  # header.
-  #
-  # * http - Configured Net::HTTP instance, ignored in this scenario except for getting host.
-  # * consumer - OAuth::Consumer instance
-  # * token - OAuth::Token instance
-  # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
-  #   +signature_method+, +nonce+, +timestamp+)
-  #
-  # This method also modifies the <tt>User-Agent</tt> header to add the OAuth gem version.
-  #
-  # See Also: {OAuth core spec version 1.0, section 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1]
-  def oauth!(http, consumer = nil, token = nil, options = {})
-    options = { :request_uri      => normalized_oauth_uri(http),
-                :consumer         => consumer,
-                :token            => token,
-                :scheme           => 'header',
-                :signature_method => nil,
-                :nonce            => nil,
-                :timestamp        => nil }.merge(options)
+    # Add the OAuth information to an HTTP request. Depending on the <tt>options[:scheme]</tt> setting
+    # this may add a header, additional query string parameters, or additional POST body parameters.
+    # The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
+    # header.
+    #
+    # * http - Configured Net::HTTP instance, ignored in this scenario except for getting host.
+    # * consumer - OAuth::Consumer instance
+    # * token - OAuth::Token instance
+    # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
+    #   +signature_method+, +nonce+, +timestamp+)
+    #
+    # This method also modifies the <tt>User-Agent</tt> header to add the OAuth gem version.
+    #
+    # See Also: {OAuth core spec version 1.0, section 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1]
+    def oauth!(http, consumer = nil, token = nil, options = {})
+      options = { request_uri: normalized_oauth_uri(http),
+                  consumer: consumer,
+                  token: token,
+                  scheme: "header",
+                  signature_method: nil,
+                  nonce: nil,
+                  timestamp: nil }.merge(options)
 
-    @oauth_helper = OAuth::Client::Helper.new(self, options)
-    self.__send__(:"set_oauth_#{options[:scheme]}")
-  end
+      @oauth_helper = OAuth::Client::Helper.new(self, options)
+      __send__(:"set_oauth_#{options[:scheme]}")
+    end
 
-  # Create a string suitable for signing for an HTTP request. This process involves parameter
-  # normalization as specified in the OAuth specification. The exact normalization also depends
-  # on the <tt>options[:scheme]</tt> being used so this must match what will be used for the request
-  # itself. The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
-  # header.
-  #
-  # * http - Configured Net::HTTP instance
-  # * consumer - OAuth::Consumer instance
-  # * token - OAuth::Token instance
-  # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
-  #   +signature_method+, +nonce+, +timestamp+)
-  #
-  # See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]
-  def signature_base_string(http, consumer = nil, token = nil, options = {})
-    options = { :request_uri      => normalized_oauth_uri(http),
-                :consumer         => consumer,
-                :token            => token,
-                :scheme           => 'header',
-                :signature_method => nil,
-                :nonce            => nil,
-                :timestamp        => nil }.merge(options)
+    # Create a string suitable for signing for an HTTP request. This process involves parameter
+    # normalization as specified in the OAuth specification. The exact normalization also depends
+    # on the <tt>options[:scheme]</tt> being used so this must match what will be used for the request
+    # itself. The default scheme is +header+, in which the OAuth parameters as put into the +Authorization+
+    # header.
+    #
+    # * http - Configured Net::HTTP instance
+    # * consumer - OAuth::Consumer instance
+    # * token - OAuth::Token instance
+    # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
+    #   +signature_method+, +nonce+, +timestamp+)
+    #
+    # See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]
+    def signature_base_string(http, consumer = nil, token = nil, options = {})
+      options = { request_uri: normalized_oauth_uri(http),
+                  consumer: consumer,
+                  token: token,
+                  scheme: "header",
+                  signature_method: nil,
+                  nonce: nil,
+                  timestamp: nil }.merge(options)
 
-    OAuth::Client::Helper.new(self, options).signature_base_string
-  end
+      OAuth::Client::Helper.new(self, options).signature_base_string
+    end
 
-  # This code was lifted from the em-http-request because it was removed from
-  # the gem June 19, 2010
-  # see: http://github.com/igrigorik/em-http-request/commit/d536fc17d56dbe55c487eab01e2ff9382a62598b
-  def normalize_uri
-    @normalized_uri ||= begin
-      uri = @uri.dup
-      encoded_query = encode_query(@uri, @options[:query])
-      path, query = encoded_query.split("?", 2)
-      uri.query = query unless encoded_query.empty?
-      uri.path  = path
-      uri
+    # This code was lifted from the em-http-request because it was removed from
+    # the gem June 19, 2010
+    # see: http://github.com/igrigorik/em-http-request/commit/d536fc17d56dbe55c487eab01e2ff9382a62598b
+    def normalize_uri
+      @normalized_uri ||= begin
+        uri = @conn.dup
+        encoded_query = encode_query(@conn, @req[:query])
+        path, query = encoded_query.split("?", 2)
+        uri.query = query unless encoded_query.empty?
+        uri.path  = path
+        uri
+      end
     end
-  end
 
-  protected
+    protected
 
-  def combine_query(path, query, uri_query)
-    combined_query = if query.kind_of?(Hash)
-      query.map { |k, v| encode_param(k, v) }.join('&')
-    else
-      query.to_s
-    end
-    if !uri_query.to_s.empty?
-      combined_query = [combined_query, uri_query].reject {|part| part.empty?}.join("&")
+    def combine_query(path, query, uri_query)
+      combined_query = if query.is_a?(Hash)
+                         query.map { |k, v| encode_param(k, v) }.join("&")
+                       else
+                         query.to_s
+                       end
+      unless uri_query.to_s.empty?
+        combined_query = [combined_query, uri_query].reject(&:empty?).join("&")
+      end
+      combined_query.to_s.empty? ? path : "#{path}?#{combined_query}"
     end
-    combined_query.to_s.empty? ? path : "#{path}?#{combined_query}"
-  end
 
-  # Since we expect to get the host etc details from the http instance (...),
-  # we create a fake url here. Surely this is a horrible, horrible idea?
-  def normalized_oauth_uri(http)
-    uri = URI.parse(normalize_uri.path)
-    uri.host = http.address
-    uri.port = http.port
+    # Since we expect to get the host etc details from the http instance (...),
+    # we create a fake url here. Surely this is a horrible, horrible idea?
+    def normalized_oauth_uri(http)
+      uri = URI.parse(normalize_uri.path)
+      uri.host = http.address
+      uri.port = http.port
 
-    if http.respond_to?(:use_ssl?) && http.use_ssl?
-      uri.scheme = "https"
-    else
-      uri.scheme = "http"
+      uri.scheme = if http.respond_to?(:use_ssl?) && http.use_ssl?
+                     "https"
+                   else
+                     "http"
+                   end
+      uri.to_s
     end
-    uri.to_s
-  end
 
-  def set_oauth_header
-    headers = (self.options[:head] ||= {})
-    headers['Authorization'] = @oauth_helper.header
-  end
+    def set_oauth_header
+      req[:head] ||= {}
+      req[:head].merge!("Authorization" => @oauth_helper.header)
+    end
 
-  def set_oauth_body
-    raise NotImplementedError, 'please use the set_oauth_header method instead'
-  end
+    def set_oauth_body
+      raise NotImplementedError, "please use the set_oauth_header method instead"
+    end
 
-  def set_oauth_query_string
-    raise NotImplementedError, 'please use the set_oauth_header method instead'
+    def set_oauth_query_string
+      raise NotImplementedError, "please use the set_oauth_header method instead"
+    end
   end
-
 end

data/lib/oauth/client/helper.rb

@@ -1,101 +1,102 @@
-require 'oauth/client'
-require 'oauth/consumer'
-require 'oauth/helper'
-require 'oauth/token'
-require 'oauth/signature/hmac/sha1'
-
-module OAuth::Client
-  class Helper
-    include OAuth::Helper
-
-    def initialize(request, options = {})
-      @request = request
-      @options = options
-      @options[:signature_method] ||= 'HMAC-SHA1'
-    end
+# frozen_string_literal: true
+
+require "oauth/client"
+require "oauth/consumer"
+require "oauth/helper"
+require "oauth/token"
+require "oauth/signature/hmac/sha1"
+
+module OAuth
+  module Client
+    class Helper
+      include OAuth::Helper
+
+      def initialize(request, options = {})
+        @request = request
+        @options = options
+        @options[:signature_method] ||= "HMAC-SHA1"
+      end
 
-    def options
-      @options
-    end
+      attr_reader :options
 
-    def nonce
-      options[:nonce] ||= generate_key
-    end
+      def nonce
+        options[:nonce] ||= generate_key
+      end
 
-    def timestamp
-      options[:timestamp] ||= generate_timestamp
-    end
+      def timestamp
+        options[:timestamp] ||= generate_timestamp
+      end
 
-    def oauth_parameters
-      out = {
-        'oauth_body_hash'        => options[:body_hash],
-        'oauth_callback'         => options[:oauth_callback],
-        'oauth_consumer_key'     => options[:consumer].key,
-        'oauth_token'            => options[:token] ? options[:token].token : '',
-        'oauth_signature_method' => options[:signature_method],
-        'oauth_timestamp'        => timestamp,
-        'oauth_nonce'            => nonce,
-        'oauth_verifier'         => options[:oauth_verifier],
-        'oauth_version'          => (options[:oauth_version] || '1.0'),
-        'oauth_session_handle'   => options[:oauth_session_handle]
-      }
-      allowed_empty_params = options[:allow_empty_params]
-      if allowed_empty_params != true && !allowed_empty_params.kind_of?(Array)
-        allowed_empty_params = allowed_empty_params == false ? [] : [allowed_empty_params]
+      def oauth_parameters
+        out = {
+          "oauth_body_hash" => options[:body_hash],
+          "oauth_callback" => options[:oauth_callback],
+          "oauth_consumer_key" => options[:consumer].key,
+          "oauth_token" => options[:token] ? options[:token].token : "",
+          "oauth_signature_method" => options[:signature_method],
+          "oauth_timestamp" => timestamp,
+          "oauth_nonce" => nonce,
+          "oauth_verifier" => options[:oauth_verifier],
+          "oauth_version" => (options[:oauth_version] || "1.0"),
+          "oauth_session_handle" => options[:oauth_session_handle]
+        }
+        allowed_empty_params = options[:allow_empty_params]
+        if allowed_empty_params != true && !allowed_empty_params.is_a?(Array)
+          allowed_empty_params = allowed_empty_params == false ? [] : [allowed_empty_params]
+        end
+        out.select! { |k, v| v.to_s != "" || allowed_empty_params == true || allowed_empty_params.include?(k) }
+        out
       end
-      out.select! { |k,v| v.to_s != '' || allowed_empty_params == true || allowed_empty_params.include?(k) }
-      out
-    end
 
-    def signature(extra_options = {})
-      OAuth::Signature.sign(@request, { :uri      => options[:request_uri],
-                                        :consumer => options[:consumer],
-                                        :token    => options[:token],
-                                        :unsigned_parameters => options[:unsigned_parameters]
-      }.merge(extra_options) )
-    end
+      def signature(extra_options = {})
+        OAuth::Signature.sign(@request, { uri: options[:request_uri],
+                                          consumer: options[:consumer],
+                                          token: options[:token],
+                                          unsigned_parameters: options[:unsigned_parameters] }.merge(extra_options))
+      end
 
-    def signature_base_string(extra_options = {})
-      OAuth::Signature.signature_base_string(@request, { :uri        => options[:request_uri],
-                                                         :consumer   => options[:consumer],
-                                                         :token      => options[:token],
-                                                         :parameters => oauth_parameters}.merge(extra_options) )
-    end
+      def signature_base_string(extra_options = {})
+        OAuth::Signature.signature_base_string(@request, { uri: options[:request_uri],
+                                                           consumer: options[:consumer],
+                                                           token: options[:token],
+                                                           parameters: oauth_parameters }.merge(extra_options))
+      end
 
-    def token_request?
-      @options[:token_request].eql?(true)
-    end
+      def token_request?
+        @options[:token_request].eql?(true)
+      end
 
-    def hash_body
-      @options[:body_hash] = OAuth::Signature.body_hash(@request, :parameters => oauth_parameters)
-    end
+      def hash_body
+        @options[:body_hash] = OAuth::Signature.body_hash(@request, parameters: oauth_parameters)
+      end
 
-    def amend_user_agent_header(headers)
-      @oauth_ua_string ||= "OAuth gem v#{OAuth::VERSION}"
-      # Net::HTTP in 1.9 appends Ruby
-      if headers['User-Agent'] && headers['User-Agent'] != 'Ruby'
-        headers['User-Agent'] += " (#{@oauth_ua_string})"
-      else
-        headers['User-Agent'] = @oauth_ua_string
+      def amend_user_agent_header(headers)
+        @oauth_ua_string ||= "OAuth gem v#{OAuth::Version::VERSION}"
+        # Net::HTTP in 1.9 appends Ruby
+        if headers["User-Agent"] && headers["User-Agent"] != "Ruby"
+          headers["User-Agent"] += " (#{@oauth_ua_string})"
+        else
+          headers["User-Agent"] = @oauth_ua_string
+        end
       end
-    end
 
-    def header
-      parameters = oauth_parameters
-      parameters.merge!('oauth_signature' => signature(options.merge(:parameters => parameters)))
+      def header
+        parameters = oauth_parameters
+        parameters["oauth_signature"] = signature(options.merge(parameters: parameters))
 
-      header_params_str = parameters.sort.map { |k,v| "#{k}=\"#{escape(v)}\"" }.join(', ')
+        header_params_str = parameters.sort.map { |k, v| "#{k}=\"#{escape(v)}\"" }.join(", ")
 
-      realm = "realm=\"#{options[:realm]}\", " if options[:realm]
-      "OAuth #{realm}#{header_params_str}"
-    end
+        realm = "realm=\"#{options[:realm]}\", " if options[:realm]
+        "OAuth #{realm}#{header_params_str}"
+      end
 
-    def parameters
-      OAuth::RequestProxy.proxy(@request).parameters
-    end
+      def parameters
+        OAuth::RequestProxy.proxy(@request).parameters
+      end
 
-    def parameters_with_oauth
-      oauth_parameters.merge(parameters)
+      def parameters_with_oauth
+        oauth_parameters.merge(parameters)
+      end
     end
   end
 end