laserlemon/simple_oauth

View on GitHub
lib/simple_oauth/header.rb

Summary

Maintainability
A
2 hrs
Test Coverage
require "openssl"
require "uri"
require "base64"
require "cgi"

module SimpleOAuth
  # Generates OAuth header for HTTP request
  class Header
    ATTRIBUTE_KEYS = %i[callback consumer_key nonce signature_method timestamp token verifier version].freeze unless defined? ::SimpleOAuth::Header::ATTRIBUTE_KEYS

    IGNORED_KEYS = %i[consumer_secret token_secret signature].freeze unless defined? ::SimpleOAuth::Header::IGNORED_KEYS

    attr_reader :method, :params, :options

    class << self
      def default_options
        {
          nonce: OpenSSL::Random.random_bytes(16).unpack1("H*"),
          signature_method: "HMAC-SHA1",
          timestamp: Time.now.to_i.to_s,
          version: "1.0"
        }
      end

      def parse(header)
        header.to_s.sub(/^OAuth\s/, "").split(/,\s*/).inject({}) do |attributes, pair|
          match = pair.match(/^(\w+)="([^"]*)"$/)
          attributes.merge(match[1].sub(/^oauth_/, "").to_sym => unescape(match[2]))
        end
      end

      def escape(value)
        uri_parser.escape(value.to_s, /[^a-z0-9\-._~]/i)
      end
      alias_method :encode, :escape

      def unescape(value)
        uri_parser.unescape(value.to_s)
      end
      alias_method :decode, :unescape

      private

      def uri_parser
        @uri_parser ||= URI.const_defined?(:Parser) ? URI::DEFAULT_PARSER : URI
      end
    end

    def initialize(method, url, params, oauth = {})
      @method = method.to_s.upcase
      @uri = URI.parse(url.to_s)
      @uri.scheme = @uri.scheme.downcase
      @uri.normalize!
      @uri.fragment = nil
      @params = params
      @options = oauth.is_a?(Hash) ? self.class.default_options.merge(oauth) : self.class.parse(oauth)
    end

    def url
      uri = @uri.dup
      uri.query = nil
      uri.to_s
    end

    def to_s
      "OAuth #{normalized_attributes}"
    end

    def valid?(secrets = {})
      original_options = options.dup
      options.merge!(secrets)
      valid = options[:signature] == signature
      options.replace(original_options)
      valid
    end

    def signed_attributes
      attributes.merge(oauth_signature: signature)
    end

    private

    def normalized_attributes
      signed_attributes.sort_by { |k, _| k.to_s }.collect { |k, v| %(#{k}="#{self.class.escape(v)}") }.join(", ")
    end

    def attributes
      matching_keys, extra_keys = options.keys.partition { |key| ATTRIBUTE_KEYS.include?(key) }
      extra_keys -= IGNORED_KEYS
      raise "SimpleOAuth: Found extra option keys not matching ATTRIBUTE_KEYS:\n  [#{extra_keys.collect(&:inspect).join(", ")}]" unless options[:ignore_extra_keys] || extra_keys.empty?

      options.select { |key, _| matching_keys.include?(key) }.transform_keys { |key| :"oauth_#{key}" }
    end

    def signature
      send("#{options[:signature_method].downcase.tr("-", "_")}_signature")
    end

    def hmac_sha1_signature
      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new("SHA1"), secret, signature_base)).chomp.delete("\n")
    end

    def secret
      options.values_at(:consumer_secret, :token_secret).collect { |v| self.class.escape(v) }.join("&")
    end
    alias_method :plaintext_signature, :secret

    def signature_base
      [method, url, normalized_params].collect { |v| self.class.escape(v) }.join("&")
    end

    def normalized_params
      signature_params.collect { |p| p.collect { |v| self.class.escape(v) } }.sort.collect { |p| p.join("=") }.join("&")
    end

    def signature_params
      attributes.to_a + params.to_a + url_params
    end

    def url_params
      CGI.parse(@uri.query || "").inject([]) { |p, (k, vs)| p + vs.sort.collect { |v| [k, v] } }
    end

    def rsa_sha1_signature
      Base64.encode64(private_key.sign(OpenSSL::Digest.new("SHA1"), signature_base)).chomp.delete("\n")
    end

    def private_key
      OpenSSL::PKey::RSA.new(options[:consumer_secret])
    end
  end
end