oauth 0.5.14 → 0.6.2

data/lib/oauth/client/helper.rb

@@ -1,98 +1,102 @@
+# frozen_string_literal: true
+
 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
+module OAuth
+  module Client
+    class Helper
+      include OAuth::Helper
 
-    def initialize(request, options = {})
-      @request = request
-      @options = options
-      @options[:signature_method] ||= "HMAC-SHA1"
-    end
+      def initialize(request, options = {})
+        @request = request
+        @options = options
+        @options[:signature_method] ||= "HMAC-SHA1"
+      end
 
-    attr_reader :options
+      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.is_a?(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["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

data/lib/oauth/client/net_http.rb

@@ -1,121 +1,128 @@
+# frozen_string_literal: true
+
 require "oauth/helper"
 require "oauth/request_proxy/net_http"
 
-class Net::HTTPGenericRequest
-  include OAuth::Helper
-
-  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
-  # * 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],
-  #           {OAuth Request Body Hash 1.0 Draft 4}[http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/drafts/4/spec.html,
-  #                                                 http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html#when_to_include]
-  def oauth!(http, consumer = nil, token = nil, options = {})
-    helper_options = oauth_helper_options(http, consumer, token, options)
-    @oauth_helper = OAuth::Client::Helper.new(self, helper_options)
-    @oauth_helper.amend_user_agent_header(self)
-    @oauth_helper.hash_body if oauth_body_hash_required?
-    send("set_oauth_#{helper_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 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1],
-  #           {OAuth Request Body Hash 1.0 Draft 4}[http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/drafts/4/spec.html,
-  #                                                 http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html#when_to_include]
-  def signature_base_string(http, consumer = nil, token = nil, options = {})
-    helper_options = oauth_helper_options(http, consumer, token, options)
-    @oauth_helper = OAuth::Client::Helper.new(self, helper_options)
-    @oauth_helper.hash_body if oauth_body_hash_required?
-    @oauth_helper.signature_base_string
-  end
+module Net
+  class HTTPGenericRequest
+    include OAuth::Helper
+
+    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
+    # * consumer - OAuth::Consumer instance
+    # * token - OAuth::Token instance
+    # * options - Request-specific options (e.g. +request_uri+, +consumer+, +token+, +scheme+,
+    #   +signature_method+, +nonce+, +timestamp+, +body_hash+)
+    #
+    # 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],
+    #           {OAuth Request Body Hash 1.0 Draft 4}[http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/drafts/4/spec.html,
+    #                                                 http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html#when_to_include]
+    def oauth!(http, consumer = nil, token = nil, options = {})
+      helper_options = oauth_helper_options(http, consumer, token, options)
+      @oauth_helper = OAuth::Client::Helper.new(self, helper_options)
+      @oauth_helper.amend_user_agent_header(self)
+      @oauth_helper.hash_body if oauth_body_hash_required?(helper_options)
+      send("set_oauth_#{helper_options[:scheme]}")
+    end
 
-  private
+    # 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 5.4.1}[http://oauth.net/core/1.0#rfc.section.5.4.1],
+    #           {OAuth Request Body Hash 1.0 Draft 4}[http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/drafts/4/spec.html,
+    #                                                 http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html#when_to_include]
+    def signature_base_string(http, consumer = nil, token = nil, options = {})
+      helper_options = oauth_helper_options(http, consumer, token, options)
+      @oauth_helper = OAuth::Client::Helper.new(self, helper_options)
+      @oauth_helper.hash_body if oauth_body_hash_required?(helper_options)
+      @oauth_helper.signature_base_string
+    end
 
-  def oauth_helper_options(http, consumer, token, options)
-    { request_uri: oauth_full_request_uri(http, options),
-      consumer: consumer,
-      token: token,
-      scheme: "header",
-      signature_method: nil,
-      nonce: nil,
-      timestamp: nil }.merge(options)
-  end
+    private
+
+    def oauth_helper_options(http, consumer, token, options)
+      { request_uri: oauth_full_request_uri(http, options),
+        consumer: consumer,
+        token: token,
+        scheme: "header",
+        signature_method: nil,
+        nonce: nil,
+        timestamp: nil,
+        body_hash_enabled: true }.merge(options)
+    end
 
-  def oauth_full_request_uri(http, options)
-    uri = URI.parse(path)
-    uri.host = http.address
-    uri.port = http.port
+    def oauth_full_request_uri(http, options)
+      uri = URI.parse(path)
+      uri.host = http.address
+      uri.port = http.port
 
-    if options[:request_endpoint] && options[:site]
-      is_https = options[:site].match(%r{^https://})
-      uri.host = options[:site].gsub(%r{^https?://}, "")
-      uri.port ||= is_https ? 443 : 80
-    end
+      if options[:request_endpoint] && options[:site]
+        is_https = options[:site].match(%r{^https://})
+        uri.host = options[:site].gsub(%r{^https?://}, "")
+        uri.port ||= is_https ? 443 : 80
+      end
 
-    uri.scheme = if http.respond_to?(:use_ssl?) && http.use_ssl?
-                   "https"
-                 else
-                   "http"
-                 end
+      uri.scheme = if http.respond_to?(:use_ssl?) && http.use_ssl?
+                     "https"
+                   else
+                     "http"
+                   end
 
-    uri.to_s
-  end
+      uri.to_s
+    end
 
-  def oauth_body_hash_required?
-    !@oauth_helper.token_request? && request_body_permitted? && !content_type.to_s.downcase.start_with?("application/x-www-form-urlencoded")
-  end
+    def oauth_body_hash_required?(options)
+      !@oauth_helper.token_request? && request_body_permitted? && !content_type.to_s.downcase.start_with?("application/x-www-form-urlencoded") && options[:body_hash_enabled]
+    end
 
-  def set_oauth_header
-    self["Authorization"] = @oauth_helper.header
-  end
+    def set_oauth_header
+      self["Authorization"] = @oauth_helper.header
+    end
 
-  # FIXME: if you're using a POST body and query string parameters, this method
-  # will move query string parameters into the body unexpectedly. This may
-  # cause problems with non-x-www-form-urlencoded bodies submitted to URLs
-  # containing query string params. If duplicate parameters are present in both
-  # places, all instances should be included when calculating the signature
-  # base string.
-
-  def set_oauth_body
-    set_form_data(@oauth_helper.stringify_keys(@oauth_helper.parameters_with_oauth))
-    params_with_sig = @oauth_helper.parameters.merge(oauth_signature: @oauth_helper.signature)
-    set_form_data(@oauth_helper.stringify_keys(params_with_sig))
-  end
+    # FIXME: if you're using a POST body and query string parameters, this method
+    # will move query string parameters into the body unexpectedly. This may
+    # cause problems with non-x-www-form-urlencoded bodies submitted to URLs
+    # containing query string params. If duplicate parameters are present in both
+    # places, all instances should be included when calculating the signature
+    # base string.
+
+    def set_oauth_body
+      # NOTE: OAuth::Helper and @oauth_helper are not the same, despite sharing all methods defined in OAuth::Helper
+      #       see: https://stackoverflow.com/a/53447775/213191
+      set_form_data(OAuth::Helper.stringify_keys(@oauth_helper.parameters_with_oauth))
+      params_with_sig = @oauth_helper.parameters.merge(oauth_signature: @oauth_helper.signature)
+      set_form_data(OAuth::Helper.stringify_keys(params_with_sig))
+    end
 
-  def set_oauth_query_string
-    oauth_params_str = @oauth_helper.oauth_parameters.map { |k, v| [escape(k), escape(v)].join("=") }.join("&")
-    uri = URI.parse(path)
-    uri.query = if uri.query.to_s == ""
-                  oauth_params_str
-                else
-                  uri.query + "&" + oauth_params_str
-                end
+    def set_oauth_query_string
+      oauth_params_str = @oauth_helper.oauth_parameters.map { |k, v| [escape(k), escape(v)].join("=") }.join("&")
+      uri = URI.parse(path)
+      uri.query = if uri.query.to_s == ""
+                    oauth_params_str
+                  else
+                    "#{uri.query}&#{oauth_params_str}"
+                  end
 
-    @path = uri.to_s
+      @path = uri.to_s
 
-    @path << "&oauth_signature=#{escape(oauth_helper.signature)}"
+      @path << "&oauth_signature=#{escape(oauth_helper.signature)}"
+    end
   end
 end

data/lib/oauth/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OAuth
   module Client
   end