oauth_weshays 0.4.8.pre

data/lib/oauth/client/net_http.rb

@@ -0,0 +1,120 @@
+require 'oauth/helper'
+require 'oauth/client/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]
+  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?
+    self.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 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1],
+  #           {OAuth Request Body Hash 1.0 Draft 4}[http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/drafts/4/spec.html]
+  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
+
+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 }.merge(options)
+  end
+
+  def oauth_full_request_uri(http,options)
+    uri = URI.parse(self.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 http.respond_to?(:use_ssl?) && http.use_ssl?
+      uri.scheme = "https"
+    else
+      uri.scheme = "http"
+    end
+
+    uri.to_s
+  end
+
+  def oauth_body_hash_required?
+    request_body_permitted? && !content_type.to_s.downcase.start_with?("application/x-www-form-urlencoded")
+  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
+    self.set_form_data(@oauth_helper.stringify_keys(@oauth_helper.parameters_with_oauth))
+    params_with_sig = @oauth_helper.parameters.merge(:oauth_signature => @oauth_helper.signature)
+    self.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("&")
+    uri = URI.parse(path)
+    if uri.query.to_s == ""
+      uri.query = oauth_params_str
+    else
+      uri.query = uri.query + "&" + oauth_params_str
+    end
+
+    @path = uri.to_s
+
+    @path << "&oauth_signature=#{escape(oauth_helper.signature)}"
+  end
+end

data/lib/oauth/client.rb

@@ -0,0 +1,4 @@
+module OAuth
+  module Client
+  end
+end

data/lib/oauth/consumer.rb

@@ -0,0 +1,389 @@
+require 'net/http'
+require 'net/https'
+require 'oauth/oauth'
+require 'oauth/client/net_http'
+require 'oauth/errors'
+require 'cgi'
+
+module OAuth
+  class Consumer
+    # determine the certificate authority path to verify SSL certs
+    CA_FILES = %w(/etc/ssl/certs/ca-certificates.crt /usr/share/curl/curl-ca-bundle.crt)
+    CA_FILES.each do |ca_file|
+      if File.exists?(ca_file)
+        CA_FILE = ca_file
+        break
+      end
+    end
+    CA_FILE = nil unless defined?(CA_FILE)
+
+    @@default_options = {
+      # Signature method used by server. Defaults to HMAC-SHA1
+      :signature_method   => 'HMAC-SHA1',
+
+      # default paths on site. These are the same as the defaults set up by the generators
+      :request_token_path => '/oauth/request_token',
+      :authorize_path     => '/oauth/authorize',
+      :access_token_path  => '/oauth/access_token',
+
+      :proxy              => nil,
+      # How do we send the oauth values to the server see
+      # http://oauth.net/core/1.0/#consumer_req_param for more info
+      #
+      # Possible values:
+      #
+      #   :header - via the Authorize header (Default) ( option 1. in spec)
+      #   :body - url form encoded in body of POST request ( option 2. in spec)
+      #   :query_string - via the query part of the url ( option 3. in spec)
+      :scheme        => :header,
+
+      # Default http method used for OAuth Token Requests (defaults to :post)
+      :http_method   => :post,
+
+      # Add a custom ca_file for consumer
+      # :ca_file       => '/etc/certs.pem'
+
+      :oauth_version => "1.0"
+    }
+
+    attr_accessor :options, :key, :secret
+    attr_writer   :site, :http
+
+    # Create a new consumer instance by passing it a configuration hash:
+    #
+    #   @consumer = OAuth::Consumer.new(key, secret, {
+    #     :site               => "http://term.ie",
+    #     :scheme             => :header,
+    #     :http_method        => :post,
+    #     :request_token_path => "/oauth/example/request_token.php",
+    #     :access_token_path  => "/oauth/example/access_token.php",
+    #     :authorize_path     => "/oauth/example/authorize.php"
+    #    })
+    #
+    # Start the process by requesting a token
+    #
+    #   @request_token = @consumer.get_request_token
+    #   session[:request_token] = @request_token
+    #   redirect_to @request_token.authorize_url
+    #
+    # When user returns create an access_token
+    #
+    #   @access_token = @request_token.get_access_token
+    #   @photos=@access_token.get('/photos.xml')
+    #
+    def initialize(consumer_key, consumer_secret, options = {})
+      @key    = consumer_key
+      @secret = consumer_secret
+
+      # ensure that keys are symbols
+      @options = @@default_options.merge(options.inject({}) do |opts, (key, value)|
+        opts[key.to_sym] = value
+        opts
+      end)
+    end
+
+    # The default http method
+    def http_method
+      @http_method ||= @options[:http_method] || :post
+    end
+
+    # The HTTP object for the site. The HTTP Object is what you get when you do Net::HTTP.new
+    def http
+      @http ||= create_http
+    end
+
+    # Contains the root URI for this site
+    def uri(custom_uri = nil)
+      if custom_uri
+        @uri  = custom_uri
+        @http = create_http # yike, oh well. less intrusive this way
+      else  # if no custom passed, we use existing, which, if unset, is set to site uri
+        @uri ||= URI.parse(site)
+      end
+    end
+
+    def get_access_token(request_token, request_options = {}, *arguments, &block)
+      response = token_request(http_method, (access_token_url? ? access_token_url : access_token_path), request_token, request_options, *arguments, &block)
+      OAuth::AccessToken.from_hash(self, response)
+    end
+
+    # Makes a request to the service for a new OAuth::RequestToken
+    #
+    #  @request_token = @consumer.get_request_token
+    #
+    # To include OAuth parameters:
+    #
+    #  @request_token = @consumer.get_request_token \
+    #    :oauth_callback => "http://example.com/cb"
+    #
+    # To include application-specific parameters:
+    #
+    #  @request_token = @consumer.get_request_token({}, :foo => "bar")
+    #
+    # TODO oauth_callback should be a mandatory parameter
+    def get_request_token(request_options = {}, *arguments, &block)
+      # if oauth_callback wasn't provided, it is assumed that oauth_verifiers
+      # will be exchanged out of band
+      request_options[:oauth_callback] ||= OAuth::OUT_OF_BAND unless request_options[:exclude_callback]
+
+      if block_given?
+        response = token_request(http_method,
+        (request_token_url? ? request_token_url : request_token_path),
+        nil,
+        request_options,
+        *arguments, &block)
+      else
+        response = token_request(http_method, (request_token_url? ? request_token_url : request_token_path), nil, request_options, *arguments)
+      end
+      OAuth::RequestToken.from_hash(self, response)
+    end
+
+    # Creates, signs and performs an http request.
+    # It's recommended to use the OAuth::Token classes to set this up correctly.
+    # request_options take precedence over consumer-wide options when signing
+    #   a request.
+    # arguments are POST and PUT bodies (a Hash, string-encoded parameters, or
+    #   absent), followed by additional HTTP headers.
+    #
+    #   @consumer.request(:get,  '/people', @token, { :scheme => :query_string })
+    #   @consumer.request(:post, '/people', @token, {}, @person.to_xml, { 'Content-Type' => 'application/xml' })
+    #
+    def request(http_method, path, token = nil, request_options = {}, *arguments)
+      if path !~ /^\//
+        @http = create_http(path)
+        _uri = URI.parse(path)
+        path = "#{_uri.path}#{_uri.query ? "?#{_uri.query}" : ""}"
+      end
+
+      # override the request with your own, this is useful for file uploads which Net::HTTP does not do
+      req = create_signed_request(http_method, path, token, request_options, *arguments)
+      return nil if block_given? and yield(req) == :done
+      rsp = http.request(req)
+      # check for an error reported by the Problem Reporting extension
+      # (http://wiki.oauth.net/ProblemReporting)
+      # note: a 200 may actually be an error; check for an oauth_problem key to be sure
+      if !(headers = rsp.to_hash["www-authenticate"]).nil? &&
+        (h = headers.select { |hdr| hdr =~ /^OAuth / }).any? &&
+        h.first =~ /oauth_problem/
+
+        # puts "Header: #{h.first}"
+
+        # TODO doesn't handle broken responses from api.login.yahoo.com
+        # remove debug code when done
+        params = OAuth::Helper.parse_header(h.first)
+
+        # puts "Params: #{params.inspect}"
+        # puts "Body: #{rsp.body}"
+
+        raise OAuth::Problem.new(params.delete("oauth_problem"), rsp, params)
+      end
+
+      rsp
+    end
+
+    # Creates and signs an http request.
+    # It's recommended to use the Token classes to set this up correctly
+    def create_signed_request(http_method, path, token = nil, request_options = {}, *arguments)
+      request = create_http_request(http_method, path, *arguments)
+      sign!(request, token, request_options)
+      request
+    end
+
+    # Creates a request and parses the result as url_encoded. This is used internally for the RequestToken and AccessToken requests.
+    def token_request(http_method, path, token = nil, request_options = {}, *arguments)
+      response = request(http_method, path, token, request_options, *arguments)
+      case response.code.to_i
+
+      when (200..299)
+        if block_given?
+          yield response.body
+        else
+          # symbolize keys
+          # TODO this could be considered unexpected behavior; symbols or not?
+          # TODO this also drops subsequent values from multi-valued keys
+          CGI.parse(response.body).inject({}) do |h,(k,v)|
+            h[k.strip.to_sym] = v.first
+            h[k.strip]        = v.first
+            h
+          end
+        end
+      when (300..399)
+        # this is a redirect
+        uri = URI.parse(response.header['location'])
+        response.error! if uri.path == path # careful of those infinite redirects
+        self.token_request(http_method, uri.path, token, request_options, arguments)
+      when (400..499)
+        raise OAuth::Unauthorized, response
+      else
+        response.error!
+      end
+    end
+
+    # Sign the Request object. Use this if you have an externally generated http request object you want to sign.
+    def sign!(request, token = nil, request_options = {})
+      request.oauth!(http, self, token, options.merge(request_options))
+    end
+
+    # Return the signature_base_string
+    def signature_base_string(request, token = nil, request_options = {})
+      request.signature_base_string(http, self, token, options.merge(request_options))
+    end
+
+    def site
+      @options[:site].to_s
+    end
+
+    def request_endpoint
+  return nil if @options[:request_endpoint].nil?
+  @options[:request_endpoint].to_s
+    end
+
+    def scheme
+      @options[:scheme]
+    end
+
+    def request_token_path
+      @options[:request_token_path]
+    end
+
+    def authorize_path
+      @options[:authorize_path]
+    end
+
+    def access_token_path
+      @options[:access_token_path]
+    end
+
+    # TODO this is ugly, rewrite
+    def request_token_url
+      @options[:request_token_url] || site + request_token_path
+    end
+
+    def request_token_url?
+      @options.has_key?(:request_token_url)
+    end
+
+    def authorize_url
+      @options[:authorize_url] || site + authorize_path
+    end
+
+    def authorize_url?
+      @options.has_key?(:authorize_url)
+    end
+
+    def access_token_url
+      @options[:access_token_url] || site + access_token_path
+    end
+
+    def access_token_url?
+      @options.has_key?(:access_token_url)
+    end
+
+    def proxy
+      @options[:proxy]
+    end
+
+    protected
+
+    # Instantiates the http object
+    def create_http(_url = nil)
+
+
+      if !request_endpoint.nil?
+       _url = request_endpoint
+      end
+
+
+      if _url.nil? || _url[0] =~ /^\//
+        our_uri = URI.parse(site)
+      else
+        our_uri = URI.parse(_url)
+      end
+
+
+      if proxy.nil?
+        http_object = Net::HTTP.new(our_uri.host, our_uri.port)
+      else
+        proxy_uri = proxy.is_a?(URI) ? proxy : URI.parse(proxy)
+        http_object = Net::HTTP.new(our_uri.host, our_uri.port, proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+      end
+
+      http_object.use_ssl = (our_uri.scheme == 'https')
+
+      if @options[:ca_file] || CA_FILE
+        http_object.ca_file = @options[:ca_file] || CA_FILE
+        http_object.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http_object.verify_depth = 5
+      else
+        http_object.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http_object.read_timeout = http_object.open_timeout = @options[:timeout] || 30
+      http_object.open_timeout = @options[:open_timeout] if @options[:open_timeout]
+
+      http_object
+    end
+
+    # create the http request object for a given http_method and path
+    def create_http_request(http_method, path, *arguments)
+      http_method = http_method.to_sym
+
+      if [:post, :put].include?(http_method)
+        data = arguments.shift
+      end
+
+      # if the base site contains a path, add it now
+      uri = URI.parse(site)
+      path = uri.path + path if uri.path && uri.path != '/'
+
+      headers = arguments.first.is_a?(Hash) ? arguments.shift : {}
+
+      case http_method
+      when :post
+        request = Net::HTTP::Post.new(path,headers)
+        request["Content-Length"] = '0' # Default to 0
+      when :put
+        request = Net::HTTP::Put.new(path,headers)
+        request["Content-Length"] = '0' # Default to 0
+      when :get
+        request = Net::HTTP::Get.new(path,headers)
+      when :delete
+        request =  Net::HTTP::Delete.new(path,headers)
+      when :head
+        request = Net::HTTP::Head.new(path,headers)
+      else
+        raise ArgumentError, "Don't know how to handle http_method: :#{http_method.to_s}"
+      end
+
+      if data.is_a?(Hash)
+        request.body = OAuth::Helper.normalize(data)
+        request.content_type = 'application/x-www-form-urlencoded'
+      elsif data
+        if data.respond_to?(:read)
+          request.body_stream = data
+          if data.respond_to?(:length)
+            request["Content-Length"] = data.length.to_s
+          elsif data.respond_to?(:stat) && data.stat.respond_to?(:size)
+            request["Content-Length"] = data.stat.size.to_s
+          else
+            raise ArgumentError, "Don't know how to send a body_stream that doesn't respond to .length or .stat.size"
+          end
+        else
+          request.body = data.to_s
+          request["Content-Length"] = request.body.length.to_s
+        end
+      end
+
+      request
+    end
+
+    def marshal_dump(*args)
+      {:key => @key, :secret => @secret, :options => @options}
+    end
+
+    def marshal_load(data)
+      initialize(data[:key], data[:secret], data[:options])
+    end
+
+  end
+end

data/lib/oauth/core_ext.rb

@@ -0,0 +1,31 @@
+# these are to backport methods from 1.8.7/1.9.1 to 1.8.6
+
+class Object
+
+  unless method_defined?(:tap)
+    def tap
+      yield self
+      self
+    end
+  end
+
+end
+
+class String
+
+
+
+  unless method_defined?(:bytesize)
+    def bytesize
+      self.size
+    end
+  end
+
+  unless method_defined?(:bytes)
+    def bytes
+      require 'enumerator'
+      Enumerable::Enumerator.new(self, :each_byte)
+    end
+  end
+
+end

data/lib/oauth/errors/error.rb

@@ -0,0 +1,4 @@
+module OAuth
+  class Error < StandardError
+  end
+end

data/lib/oauth/errors/problem.rb

@@ -0,0 +1,14 @@
+module OAuth
+  class Problem < OAuth::Unauthorized
+    attr_reader :problem, :params
+    def initialize(problem, request = nil, params = {})
+      super(request)
+      @problem = problem
+      @params  = params
+    end
+
+    def to_s
+      problem
+    end
+  end
+end

data/lib/oauth/errors/unauthorized.rb

@@ -0,0 +1,12 @@
+module OAuth
+  class Unauthorized < OAuth::Error
+    attr_reader :request
+    def initialize(request = nil)
+      @request = request
+    end
+
+    def to_s
+      [request.code, request.message] * " "
+    end
+  end
+end

data/lib/oauth/errors.rb

@@ -0,0 +1,3 @@
+require 'oauth/errors/error'
+require 'oauth/errors/unauthorized'
+require 'oauth/errors/problem'

data/lib/oauth/helper.rb

@@ -0,0 +1,109 @@
+require 'openssl'
+require 'base64'
+
+module OAuth
+  module Helper
+    extend self
+
+    # Escape +value+ by URL encoding all non-reserved character.
+    #
+    # See Also: {OAuth core spec version 1.0, section 5.1}[http://oauth.net/core/1.0#rfc.section.5.1]
+    def escape(value)
+      URI::escape(value.to_s, OAuth::RESERVED_CHARACTERS)
+    rescue ArgumentError
+      URI::escape(value.to_s.force_encoding(Encoding::UTF_8), OAuth::RESERVED_CHARACTERS)
+    end
+
+    # Generate a random key of up to +size+ bytes. The value returned is Base64 encoded with non-word
+    # characters removed.
+    def generate_key(size=32)
+      Base64.encode64(OpenSSL::Random.random_bytes(size)).gsub(/\W/, '')
+    end
+
+    alias_method :generate_nonce, :generate_key
+
+    def generate_timestamp #:nodoc:
+      Time.now.to_i.to_s
+    end
+
+    # Normalize a +Hash+ of parameter values. Parameters are sorted by name, using lexicographical
+    # byte value ordering. If two or more parameters share the same name, they are sorted by their value.
+    # Parameters are concatenated in their sorted order into a single string. For each parameter, the name
+    # is separated from the corresponding value by an "=" character, even if the value is empty. Each
+    # name-value pair is separated by an "&" character.
+    #
+    # See Also: {OAuth core spec version 1.0, section 9.1.1}[http://oauth.net/core/1.0#rfc.section.9.1.1]
+    def normalize(params)
+      params.sort.map do |k, values|
+        if values.is_a?(Array)
+          # make sure the array has an element so we don't lose the key
+          values << nil if values.empty?
+          # multiple values were provided for a single key
+          values.sort.collect do |v|
+            [escape(k),escape(v)] * "="
+          end
+        elsif values.is_a?(Hash)
+          normalize_nested_query(values, k)
+        else
+          [escape(k),escape(values)] * "="
+        end
+      end * "&"
+    end
+    
+    #Returns a string representation of the Hash like in URL query string
+    # build_nested_query({:level_1 => {:level_2 => ['value_1','value_2']}}, 'prefix'))
+    #   #=> ["prefix%5Blevel_1%5D%5Blevel_2%5D%5B%5D=value_1", "prefix%5Blevel_1%5D%5Blevel_2%5D%5B%5D=value_2"]
+    def normalize_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map do |v|
+          normalize_nested_query(v, "#{prefix}[]")
+        end.flatten.sort
+      when Hash
+        value.map do |k, v|
+          normalize_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
+        end.flatten.sort
+      else
+        [escape(prefix), escape(value)] * "="
+      end
+    end
+
+    # Parse an Authorization / WWW-Authenticate header into a hash. Takes care of unescaping and
+    # removing surrounding quotes. Raises a OAuth::Problem if the header is not parsable into a
+    # valid hash. Does not validate the keys or values.
+    #
+    #   hash = parse_header(headers['Authorization'] || headers['WWW-Authenticate'])
+    #   hash['oauth_timestamp']
+    #     #=>"1234567890"
+    #
+    def parse_header(header)
+      # decompose
+      params = header[6,header.length].split(/[,=&]/)
+
+      # odd number of arguments - must be a malformed header.
+      raise OAuth::Problem.new("Invalid authorization header") if params.size % 2 != 0
+
+      params.map! do |v|
+        # strip and unescape
+        val = unescape(v.strip)
+        # strip quotes
+        val.sub(/^\"(.*)\"$/, '\1')
+      end
+
+      # convert into a Hash
+      Hash[*params.flatten]
+    end
+
+    def unescape(value)
+      URI.unescape(value.gsub('+', '%2B'))
+    end
+
+    def stringify_keys(hash)
+      new_h = {}
+      hash.each do |k, v|
+        new_h[k.to_s] = v.is_a?(Hash) ? stringify_keys(v) : v
+      end
+      new_h
+    end
+  end
+end