oauth_simple 0.1.0.pre

data/README.rdoc

@@ -0,0 +1,93 @@
+= oauth_simple [RubyGem]
+
+== Example
+
+Following example shows you how to obtain a request token from Twitter server:
+
+  require "oauth_simple"
+  
+  req_uri_str  = 'https://api.twitter.com/oauth/request_token'
+  req_method   = 'POST'
+  consumer_sec = 'your_consumer_secret'
+  
+  req_helper = OAuthSimple::RequestHelper.new(
+    URI.parse( uri_str ),
+    req_method,
+    "#{OAuthSimple::HelperFunctions.enc_perenc(consumer_sec)}&",
+    OAuthSimple::RequestParamList.new( [
+      [ 'oauth_consumer_key',     'your_consumer_key'                                 ],
+      [ 'oauth_signature_method', 'HMAC-SHA1'                                         ],
+      [ 'oauth_timestamp',        OAuthSimple::HelperFunctions.create_timestamp_str() ],
+      [ 'oauth_nonce',            OAuthSimple::HelperFunctions.create_nonce_str()     ],
+      [ 'oauth_version',          '1.0'                                               ],
+    ] ),
+  )
+  
+  require 'net/https'
+  http = Net::HTTP.new( req_helper.host, req_helper.port )
+  http.use_ssl = true                          # SSLを有効に
+  http.verify_mode = OpenSSL::SSL::VERIFY_PEER # 認証モードをセット
+  http.start do |http|
+    http.request_post( req_helper.qpath, req_helper.req_body,
+                { 'Authorization' => req_helper.oauth_header_str } ) do |res|
+      if res.code == '200'
+        res.read_body do |str|
+          puts 'str: ', str
+        end
+      end
+    end
+  end
+
+Alternatively, you can use OAuthSimple::HTTP, which is a subclass of Net::HTTP.
+Following example shows you how to obtain a temporaty credentials (request token)
+from Twitter server,
+how to obtain a token credentials (access token), and how to issue a authenticated request:
+
+  require 'net/https' # if you use ssl
+  require 'oauth_simple'
+  #
+  # OAuthSimple::HTTP is a subclass of Net::HTTP
+  http = OAuthSimple::HTTP.new( 'api.twitter.com', 443 )
+  #
+  # SSL setting
+  http.use_ssl     = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_PEER # 認証モードをセット
+  #
+  # OAuth setting (this feature is provided by OAuthSimple::HTTP)
+  http.use_oauth = true
+  http.set_oauth_client_credentials( 'YOUR_CLIENT_CREDENTIALS', 'YOUR_CLIENT_SECRET' )
+  http.set_oauth_signature_method( 'HMAC-SHA1' ) # at this time, only 'HMAC-SHA1' is supported
+  #
+  # connection start
+  http.start() do |http|
+    # == Obtaining Temporary Credentials ==
+    token, secret = http.request_oauth_temp_credentials( '/oauth/request_token', 'oob' ) do |res_failed|
+      # when response code is not '200', this block is called
+      raise res_failed.body
+    end
+    # token and secret are set to OAuthSimple::HTTP object automatically in the request_oauth_temp_credentials method,
+    # so you need not set them explicitly as follows
+    #   http.set_oauth_user_credentials( token, secret )
+    #
+    # == Resource Owner Authorization ==
+    puts "access to https://api.twitter.com/oauth/authorize?oauth_token=#{OAuthSimple::HelperFunctions.enc_perenc(token)} " + 
+         'and input verifier'
+    $stdout << 'verifier : '
+    verifier = $stdin.gets.chomp
+    #
+    # == Obtaining Token Credentials ==
+    token, secret = http.request_oauth_token_credentials( '/oauth/access_token', verifier ) do |res_failed|
+      # when response code is not '200', this block is called
+      raise res_failed.body
+    end
+    # token and secret are set to OAuthSimple::HTTP object automatically in the request_oauth_token_credentials method,
+    # you need not set them explicitly as follows
+    #   http.set_oauth_user_credentials( token, secret )
+    #
+    # == Authenticated Requests ==
+    http.set_oauth_user_credentials( token, secret )
+    http.request_get( '/1/statuses/home_timeline.json?include_entities=true' ) do |res|
+      p res.code
+      p res.body
+    end
+  end

data/lib/oauth_simple.rb

@@ -0,0 +1,9 @@
+# coding : utf-8
+
+require 'oauth_simple/request_helper'
+require 'oauth_simple/request_helper_factory'
+require 'oauth_simple/request_param_list'
+require 'oauth_simple/http'
+
+module OAuthSimple
+end

data/lib/oauth_simple/helper_functions.rb

@@ -0,0 +1,83 @@
+# coding : utf-8
+
+require 'openssl'
+
+module OAuthSimple
+module HelperFunctions
+  
+  # ====================
+  #   MODULE FUNCTIONS
+  # ====================
+  module_function
+  
+  # nonce 用にランダムに文字列生成するメソッド
+  NONCE_STRING_SOURCE = ('a'..'z').to_a() + ('A'..'Z').to_a() + ('0'..'9').to_a()
+  def create_nonce_str( length = 16 )
+    Array.new( length ).map{ NONCE_STRING_SOURCE[rand(NONCE_STRING_SOURCE.size)] }.join('')
+  end
+  
+  def create_timestamp_str( time = Time.now )
+    ( time - Time.utc( 1970, 1, 1 ) ).to_i().to_s()
+  end
+  
+  # HMAC-SHA1
+  # RSA-SHA1
+  def calc_signature( method, uri_str, param_list, secret_str )
+    params_str = param_list.get_normalized_params_str()
+    #sb_str = String.new()
+    #list.each do |item|
+    #  if ( sb_str != "" ) then
+    #    sb_str << "&"
+    #  end
+    #  sb_str << encode( item[0] ) << "=" << encode( item[1] )
+    #end
+    base_str = [ method, uri_str, params_str ].map{ |e| enc_perenc(e) }.join('&')
+    digest = OpenSSL::HMAC::digest( OpenSSL::Digest::SHA1.new(), secret_str, base_str )
+    return [digest].pack('m').gsub!( /\n/u, '' )
+  end
+  
+  # param  : String
+  # return : [ [ String, String or nil ], ... ]
+  def decode_from_percent_encoded_str( str )
+    str.split( '&', -1 ).map! do |s|
+      if s.empty?
+        [ '', nil ]
+      else
+        pair = s.split( '=', -1 ).map!{ |s| dec_perenc( s ) }
+        # TODO: pair の要素数は 1 以上 2 以下 ('=' がない場合など, 1 個だけの場合もある)
+        [ pair[0], pair[1] ]
+      end
+    end
+  end
+  
+  # param  : [ [ String, String or nil ], ... ]
+  # return : String
+  def encode_to_percent_encoded_str_pairs( str_pairs )
+    str_pairs.map do |pair|
+      pair[1].nil? ? enc_perenc( pair[0] ) 
+                   : enc_perenc( pair[0] ) + '=' + enc_perenc( pair[1] )
+    end.join( '&' )
+  end
+
+  # TODO これで良いか?
+  # UTF-8 エンコードされたものをパーセントエンコードしているとみなしてデコードする
+  # パーセントエンコードする際には文字列を UTF-8 エンコードするのは OAuth 1.0 の仕様
+  # だが, デコード時はこれでよいか?
+  def dec_perenc( str )
+    str.gsub( /%[a-fA-F\d]{2}/u ){ |s| [s[1,2]].pack('H*') }.force_encoding( Encoding::UTF_8 )
+  end
+
+  def enc_perenc( str )
+    str.gsub( /[^a-zA-Z\d\-\._\~]/u ) do |s|
+      d_str = s.unpack("H*")[0].upcase()
+      e_str = String.new()
+      while ( d_str[0,2] != "" ) do
+        e_str << "%" << d_str[0,2]
+        d_str[0,2] = ""
+      end
+      e_str
+    end
+  end
+  
+end
+end

data/lib/oauth_simple/http.rb

@@ -0,0 +1,267 @@
+# coding : utf-8
+
+require 'net/http'
+require 'oauth_simple/helper_functions'
+require 'oauth_simple/request_param_list'
+
+module OAuthSimple
+
+###
+# Subclass of Net::HTTP, which has feature of OAuth authentication
+class HTTP < Net::HTTP
+
+  include HelperFunctions
+
+  module DefaultOAuthParamSettable
+    def set_default_oauth_client_credentials( key, secret )
+      @client_credentials = [ key, secret ]
+    end
+
+    def set_default_oauth_user_credentials( key, secret )
+      @user_credentials = [ key, secret ]
+    end
+
+    def set_default_oauth_signature_method( sig_met )
+      @signature_method = sig_met
+    end
+
+    def get_default_params
+      params = {}
+      params[:oauth_client_credentials] = @client_credentials if @client_credentials
+      params[:oauth_user_credentials  ] = @user_credentials   if @user_credentials
+      params[:signature_method        ] = @signature_method   if @signature_method
+      return params
+    end
+  end
+
+  # :stopdoc:
+  # 空のハッシュを表す定数
+  EMPTY_HASH = {}.freeze
+  # :startdoc:
+
+  def initialize( *args )
+    super
+    self.set_oauth_params_location( LOC_AUTHORIZATION_HEADER )
+  end
+
+  def self.create_subclass_with_default_oauth_params( oauth_params = EMPTY_HASH )
+    klass = Class.new( self ) do
+      def initialize( *args )
+        super
+        default_params = self.class.get_default_params
+        self.use_oauth = true
+        if default_params.has_key? :oauth_client_credentials
+          self.set_oauth_client_credentials( *default_params[:oauth_client_credentials] )
+        end
+        if default_params.has_key? :oauth_user_credentials
+          self.set_oauth_user_credentials( *default_params[:oauth_user_credentials] )
+        end
+        if default_params.has_key? :signature_method
+          # at this time, only 'HMAC-SHA1' is supported
+          self.set_oauth_signature_method( default_params[:signature_method] )
+        end
+      end
+    end
+    klass.extend DefaultOAuthParamSettable
+    # TODO oauth_params で渡されたパラメータをここでセット
+    #
+    return klass
+  end
+
+  # @consumer_key
+  # @token
+  # @signature_method
+  # (timestamp, nonce, version)
+  #    -> signature
+  # 
+  # @consumer_secret
+  # @token_secret
+
+  ###
+  # Override: Net::HTTP#transport_request
+  def transport_request( req )
+    if use_oauth?
+      req_method = req.method.upcase
+      uri_str_scheme = use_ssl? ? 'https' : 'http'
+      uri_str_host   = addr_port.downcase # デフォルトでない場合ポート番号含む
+      # TODO: path 中の '#' はどのように扱われるべき?
+      qpath, uri_str_fragment = req.path.split( '#', 2 )
+      uri_str_path, query_str = qpath.split( '?', 2 )
+      # OAuth Header (基本的には自分で用意)
+      #req.get_fields( 'Authorization' )
+      # ...
+      # body  parameters (必要な場合だけ)
+      #  Protocol parameters can be transmitted in the HTTP request entity-
+      #  body, but only if the following REQUIRED conditions are met:
+      #   o  The entity-body is single-part.
+      #   o  The entity-body follows the encoding requirements of the
+      #      "application/x-www-form-urlencoded" content-type as defined by
+      #      [W3C.REC-html40-19980424].
+      #   o  The HTTP request entity-header includes the "Content-Type" header
+      #      field set to "application/x-www-form-urlencoded".
+      body_str = nil
+      if req.request_body_permitted?
+        content_type = req.content_type || 'application/x-www-form-urlencoded'
+        if content_type == 'application/x-www-form-urlencoded'
+          body_str = req.body
+        end
+      end
+
+      secret_str = [ @oauth_consumer_secret, @oauth_token_secret ].
+                   map {|e| e.nil? ? '' : enc_perenc( e ) }.
+                   join( '&' )
+
+      # for debug
+      #puts "request method - #{req_method    }"
+      #puts "http or https  - #{uri_str_scheme}"
+      #puts "host[:port]    - #{uri_str_host  }"
+      #puts "path           - #{uri_str_path  }"
+      #puts "query str      - #{query_str.nil? ? '<nil>' : query_str}"
+      #puts "body str       - #{body_str.nil?  ? '<nil>' : body_str }"
+
+      p_params = RequestParamList.new()
+      {
+        'oauth_consumer_key'     => @oauth_consumer_key,
+        'oauth_token'            => @oauth_token,
+        'oauth_signature_method' => @oauth_signature_method,
+      }.each_pair{|k,v| p_params.add( k, v ) if v }
+      p_params.add( 'oauth_timestamp'       , create_timestamp_str() )
+      p_params.add( 'oauth_nonce'           , create_nonce_str()     )
+      p_params.add( 'oauth_version'         , '1.0'                  )
+      if req.respond_to? :oauth_params
+        req.oauth_params.each_pair do |key,value|
+          p_params.add( key, value )
+        end
+      end
+
+      param_list = RequestParamList.new()
+      param_list.concat p_params
+      param_list.concat RequestParamList.from_percent_encoded_str query_str if query_str
+      param_list.concat RequestParamList.from_percent_encoded_str body_str  if body_str
+
+      # signature の計算
+      uri_str = "#{uri_str_scheme}://#{uri_str_host}#{uri_str_path}"
+      signature = calc_signature( req_method, uri_str, param_list, secret_str )
+
+      case @oauth_params_loc
+      when LOC_AUTHORIZATION_HEADER
+        # Authorization Header
+        p_params.add( 'oauth_signature', signature )
+        req.add_field( 'Authorization', 'OAuth ' + p_params.to_header_string() )
+      when LOC_REQBODY_OR_REQQUERY
+        # req body or req query
+        raise 'not implemented yet'
+      when LOC_REQQUERY
+        # req query
+        raise 'not implemented yet'
+      else
+        # error
+        raise 'invalid location'
+      end
+    end
+    return super # 引数, block をそのまま継承先へ渡す
+  end
+
+  def use_oauth=( val )
+    @use_oauth = val
+  end
+
+  def use_oauth?
+    @use_oauth
+  end
+
+  def set_oauth_client_credentials( key, secret )
+    @oauth_consumer_key    = key
+    @oauth_consumer_secret = secret
+  end
+
+  def set_oauth_user_credentials( token, secret )
+    @oauth_token        = token
+    @oauth_token_secret = secret
+  end
+
+  def set_oauth_signature_method( sigmet )
+    if sigmet != 'HMAC-SHA1'
+      raise %q{at this time, only 'HMAC-SHA1' is supported}
+    end
+    @oauth_signature_method = sigmet
+  end
+
+  LOC_AUTHORIZATION_HEADER = :auth_header
+  LOC_REQBODY_OR_REQQUERY = :reqbody_or_reqquery
+  LOC_REQQUERY = :reqquery
+  def set_oauth_params_location( location )
+    @oauth_params_loc = location
+  end
+
+  # TODO: POST メソッド以外も使えるように
+  def request_oauth_temp_credentials( path, oauth_callback_uri, &block )
+    req = Post.new( path )
+    req.set_oauth_param( 'oauth_callback', oauth_callback_uri )
+    token  = nil
+    secret = nil
+    request( req ) do |res|
+      if res.code == '200'
+         params = RequestParamList.from_percent_encoded_str res.body
+         token  = params.get_values( 'oauth_token' )[0]
+         secret = params.get_values( 'oauth_token_secret' )[0]
+      else
+        if block
+          block.call res
+        else
+          raise 'error' # TODO
+        end
+      end
+    end
+
+    # Set credentials automatically
+    set_oauth_user_credentials( token, secret )
+    return token, secret
+  end
+
+  # TODO: POST メソッド以外も使えるように
+  def request_oauth_token_credentials( path, oauth_verifier, &block )
+    req = Post.new( path )
+    req.set_oauth_param( 'oauth_verifier', oauth_verifier )
+    token  = nil
+    secret = nil
+    request( req ) do |res|
+      if res.code == '200'
+         params = RequestParamList.from_percent_encoded_str res.body
+         token  = params.get_values( 'oauth_token' )[0]
+         secret = params.get_values( 'oauth_token_secret' )[0]
+      else
+        if block
+          block.call res
+        else
+          raise 'error'
+        end
+      end
+    end
+    set_oauth_user_credentials( token, secret )
+    return token, secret
+  end
+
+  module OAuthParamsHandler
+    def set_oauth_param( name, value )
+      # TODO: name must start with 'oauth_'
+      @oauth_params ||= {}
+      @oauth_params[ name ] = value
+    end
+    def get_oauth_param( name )
+      ( @oauth_params || {} )[ name ]
+    end
+    def oauth_params
+      @oauth_params || {}
+    end
+  end
+
+  class Get < Net::HTTP::Get
+    include OAuthParamsHandler
+  end
+  class Post < Net::HTTP::Post
+    include OAuthParamsHandler
+  end
+
+end
+end

data/lib/oauth_simple/request_helper.rb

@@ -0,0 +1,98 @@
+# coding : utf-8
+
+require 'oauth_simple/helper_functions'
+
+module OAuthSimple
+class RequestHelper
+  
+  include HelperFunctions
+  
+  ###
+  # req_uri    : URI or String object
+  # req_method : String
+  def initialize( req_uri, req_method, oauth_secret, protocol_params, query_params = nil, body_params = nil )
+    # URI
+    @req_uri    = req_uri # 後ろの処理で query は nil になる
+    # String or Symbol?
+    @req_method = req_method
+    # String or Symbol?
+    @sig_method = nil
+    # String
+    @secret_str = oauth_secret
+    # RequestParamList 
+    @p_params = protocol_params
+    # RequestParamList or nil
+    q_params_list = []
+    if @req_uri.query
+      q_params_list << RequestParamList.from_percent_encoded_str( @req_uri.query )
+      @req_uri.query = nil
+    end
+    if query_params
+      q_params_list << query_params
+    end
+    @q_params = q_params_list.empty? ? nil : q_params_list.inject{|a,b| a.concat b}
+    # RequestParamList or nil
+    @b_params = body_params
+    
+    params = RequestParamList.new()
+    params.concat @p_params
+    params.concat @q_params if @q_params
+    params.concat @b_params if @b_params
+    
+    # URI の処理
+    #   The scheme, authority, and path of the request resource URI [RFC3986]
+    #   are included by constructing an "http" or "https" URI representing
+    #   the request resource (without the query or fragment) as follows:
+    # 1.  The scheme and host MUST be in lowercase.
+    uri_str = ''
+    # scheme
+    uri_str << @req_uri.scheme.downcase
+    uri_str << '://'
+    uri_str << @req_uri.host.downcase
+    # 3.  The port MUST be included if it is not the default port for the
+    #   scheme, and MUST be excluded if it is the default.  Specifically,
+    #   the port MUST be excluded when making an HTTP request [RFC2616]
+    #   to port 80 or when making an HTTPS request [RFC2818] to port 443.
+    #   All other non-default port numbers MUST be included.
+    if @req_uri.port != @req_uri.default_port
+      uri_str << ":#{@req_uri.port}"
+    end
+    uri_str << @req_uri.path
+    
+    @p_params.add( 'oauth_signature', calc_signature( req_method, uri_str, params, @secret_str ) )
+  end
+  
+  def host
+    @req_uri.host
+  end
+  
+  def port
+    @req_uri.port
+  end
+  
+  def request_method
+    @req_method
+  end
+  
+  ###
+  # path + '?' + query
+  def qpath
+    @req_uri.path
+  end
+  
+  def qpath_with_oauth_params
+    
+  end
+  
+  def req_body
+  end
+  
+  def req_body_with_oauth_params
+  end
+  
+  def oauth_header_str( realm_str = nil )
+    'OAuth ' + @p_params.to_header_string()
+  end
+  
+end
+end

data/lib/oauth_simple/request_helper_factory.rb

@@ -0,0 +1,72 @@
+# coding : utf-8
+
+require 'oauth_simple/helper_functions'
+
+module OAuthSimple
+class RequestHelperFactory
+  
+  include HelperFunctions
+  
+  ###
+  #     consumer_secret
+  #     token_secret
+  #     consumer_key
+  #     token
+  #       clients MAY omit the parameter.
+  #     signature_method
+  #     timestamp
+  #       MAY be omitted when using the "PLAINTEXT" signature method.
+  #     nonce
+  #       MAY be omitted when using the "PLAINTEXT" signature method.
+  #     version
+  #       OPTIONAL.  If present, MUST be set to "1.0". 
+  # :consumer_key, :consumer_secret, :token, :token_secret, :signature_method
+  # :use_default_timestamp, :use_default_nonce, :use_default_version
+  def initialize( args )
+    args = {
+      :use_default_timestamp => true,
+      :use_default_nonce     => true,
+      :use_default_version   => true,
+    }.merge args
+    # String object or nil
+    @consumer_key          = args.delete( :consumer_key          )
+    @consumer_secret       = args.delete( :consumer_secret       )
+    @token                 = args.delete( :token                 )
+    @token_secret          = args.delete( :token_secret          )
+    @signature_method      = args.delete( :signature_method      )
+    # boolean
+    @use_default_timestamp = args.delete( :use_default_timestamp )
+    @use_default_nonce     = args.delete( :use_default_nonce     )
+    @use_default_version   = args.delete( :use_default_version   )
+    # TODO: args に key が残っている場合, 警告を表示
+  end
+  
+  ###
+  # create RequestHelper object
+  def create( req_uri, req_method, option_params )
+    # secret_str 生成
+    cons_sec = option_params[:consumer_secret] || @consumer_secret
+    tokn_sec = option_params[:token_secret   ] || @token_secret
+    secret_str = "#{cons_sec}&#{tokn_sec}"
+    
+    # protocol params
+    p_params = RequestParamList.new()
+    p_params.add( 'oauth_consumer_key'    , @consumer_key          ) if @consumer_key
+    p_params.add( 'oauth_token'           , @token                 ) if @token
+    p_params.add( 'oauth_signature_method', @signature_method      ) if @signature_method
+    p_params.add( 'oauth_timestamp'       , create_timestamp_str() ) if @use_default_timestamp
+    p_params.add( 'oauth_nonce'           , create_nonce_str()     ) if @use_default_nonce
+    p_params.add( 'oauth_version'         , '1.0'                  ) if @use_default_version
+    p_params2 = option_params.delete( :protocol_params )
+    p_params.concat p_params2 if p_params2
+    
+    # query_params and body_params
+    q_params = option_params.delete( :query_params )
+    b_params = option_params.delete( :body_params  )
+    
+    # RequestHelper object 生成
+    RequestHelper.new( req_uri, req_method, secret_str, p_params, q_params, b_params )
+  end
+  
+end
+end

data/lib/oauth_simple/request_param_list.rb

@@ -0,0 +1,144 @@
+# coding : utf-8
+
+require 'oauth_simple/helper_functions'
+
+module OAuthSimple
+class RequestParamList
+  
+  include HelperFunctions
+
+  # instance variable
+  # @list : [ [ String obj, String obj or nil ], ... ]
+
+  def initialize( arg = Array.new() )
+    if ( arg.is_a? Array ) then
+      arg.each do |item|
+        if not item.is_a?( Array ) or item.length != 2 or not item[0].is_a?( String ) or not ( item[1].is_a?( String ) or item[1].nil? ) then
+          raise "引数として与えられた Array が正しい形式ではありません. " +
+                '引数として与えられた Array オブジェクトの各要素は, String オブジェクト ' +
+                '2 つ (または 2 つめは nil) からなる Array オブジェクトである必要があります'
+        end
+      end
+      @list = arg
+    elsif ( arg.is_a? Hash ) then
+      @list = Array.new()
+      arg.each do |key,val|
+        @list.push( [key, val] )
+      end
+    elsif ( arg.is_a? String ) then
+      @list = Array.new()
+      if ( /%(?![a-fA-F\d]{2})/u =~ arg ) then
+        # OAuth の仕様どおりではないが, URL エンコードの形式ならば受け付ける
+        raise "引数として与えられた String オブジェクトが正しく encode されたものではありません"
+      end
+      param_list = arg.split( /&/u )
+      param_list.each do |item|
+        if ( item.nil? || item == "" ) then
+          next
+        end
+        pair = item.split( /=/u )
+        @list.push( [decode( pair[0] ), decode( pair[1].to_s() )] )
+      end
+    else
+      raise "型エラー : ParameterList の初期化時に与えることができる引数の型は Array と String のみです"
+    end
+  end
+  
+  def self.from_percent_encoded_str( str )
+    # HelperFunctions モジュールで定義されている... 関数呼び出しにはできない?
+    new HelperFunctions.decode_from_percent_encoded_str( str )
+  end
+  
+  public
+  def +( other )
+    return ParameterList.new( self.get_list() + other.get_list() )
+  end
+  
+  def concat( other )
+    @list.concat( other.get_list() )
+    return self
+  end
+  
+  def add( name, value )
+    @list.push( [name, value] )
+    return nil
+  end
+  
+  def get_values( name )
+    res_list = Array.new()
+    @list.each do |item|
+      if ( item[0] == name ) then
+        res_list.push( item[1] )
+      end
+    end
+    return res_list
+  end
+  
+  alias :[] :get_values
+  
+  def each()
+    @list.each do |item|
+      yield( item[0], item[1] )
+    end
+  end
+  
+  def to_header_string()
+    #list = get_sorted_list()
+    sb_str = String.new()
+    @list.each do |item|
+      if ( sb_str != "" ) then
+        sb_str << ", "
+      end
+      sb_str << enc_perenc( item[0] ) << '="' << enc_perenc( item[1] ) << '"'
+    end
+    return sb_str
+  end
+
+  def to_query_string()
+    #list = get_sorted_list()
+    sb_str = String.new()
+    @list.map{ |e| enc_perenc( e[0] ) + ( e[1] ? "=#{enc_perenc( e[1] )}" : '' ) }.join( '&' )
+  end
+
+=begin
+  def to_signature_string( method, url, key )
+    list = get_sorted_list()
+    sb_str = String.new()
+    list.each do |item|
+      if ( sb_str != "" ) then
+        sb_str << "&"
+      end
+      sb_str << encode( item[0] ) << "=" << encode( item[1] )
+    end
+    base_string = encode( method ) + "&" + encode( url ) + "&" + encode( sb_str )
+    digest = OpenSSL::HMAC::digest( OpenSSL::Digest::SHA1.new(), key, base_string )
+    sig = [digest].pack("m").gsub!( /\n/u, "" )
+    return sig
+  end
+=end
+  
+  protected
+  def get_list()
+    return @list
+  end
+  
+  public
+  # http://tools.ietf.org/html/rfc5849#section-3.4.1.3.2
+  def get_normalized_params_str()
+    @list.
+      map do |e| # [ key, val ]
+        [ enc_perenc( e[0] ), e[1] ? enc_perenc( e[1] ) : '' ]
+      end.
+      sort do |a,b|
+        case a[0] <=> b[0]
+          when  1 then rel =  1
+          when -1 then rel = -1
+          when  0 then rel = a[1] <=> b[1]
+        end
+      end.
+      map{ |e| "#{e[0]}=#{e[1]}" }.
+      join( '&' )
+  end
+  
+end
+end

data/rakefile.rb

@@ -0,0 +1,13 @@
+# coding: UTF-8
+
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  # $LOAD_PATH に追加するパス (デフォルトで 'lib' は入っている)
+  test.libs << 'test'
+  # テスト対象ファイルの指定
+  test.test_files = Dir[ 'test/**/test_*.rb' ]
+  test.verbose = true
+end

data/test/helper_path_setting.rb

@@ -0,0 +1,4 @@
+# coding: UTF-8
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), '..', 'lib' )

data/test/test_http.rb

@@ -0,0 +1,43 @@
+# coding: UTF-8
+
+require File.expand_path File.join( File.dirname(__FILE__), 'helper_path_setting' )
+
+require 'uri'
+require 'minitest/unit'
+require 'minitest/autorun'
+
+require 'oauth_simple'
+require 'oauth_simple/http'
+
+class TestHttp < MiniTest::Unit::TestCase
+
+  # OAuthSimple::HTTP is a subclass of Net::HTTP
+  MyHTTP = OAuthSimple::HTTP.create_subclass_with_default_oauth_params()
+  MyHTTP.set_default_oauth_client_credentials( 'key', 'secret' )
+  #MyHTTP.set_default_oauth_user_credentials( key, secret )
+  MyHTTP.set_default_oauth_signature_method( 'HMAC-SHA1' )
+
+  ###
+  # test by using OAuth Test Server : http://term.ie/oauth/example/
+  def test_getting_request_token
+
+    http = MyHTTP.new( 'term.ie' )
+    # connection start
+    http.start() do |http|
+      assert_equal( http.class, MyHTTP )
+      http.request_post( '/oauth/example/request_token.php', nil ) do |res|
+        assert_equal( '200', res.code )
+        assert_equal( 'oauth_token=requestkey&oauth_token_secret=requestsecret', res.body )
+      end
+
+      token, secret = http.request_oauth_temp_credentials( '/oauth/example/request_token.php', 'oob' )
+      assert_equal( 'requestkey'   , token  )
+      assert_equal( 'requestsecret', secret )
+    end
+  end
+
+end
+
+__END__
+
+assert( .... )

data/test/test_main.rb

@@ -0,0 +1,151 @@
+# coding: UTF-8
+
+require File.expand_path File.join( File.dirname(__FILE__), 'helper_path_setting' )
+
+require 'uri'
+require 'minitest/unit'
+require 'minitest/autorun'
+
+require 'oauth_simple'
+require 'oauth_simple/http'
+
+class TestMain < MiniTest::Unit::TestCase
+  
+  def test_proxy
+    http = OAuthSimple::HTTP.Proxy( '96.32.133.3', '8085' ).new( 'api.twitter.com' )
+    assert( http.is_a? OAuthSimple::HTTP )
+  end
+  
+  def test_sign_simple
+    base_str   = 'GET&http%3A%2F%2Fphotos.example.net%2Fphotos&file%3Dvacation.jpg%26oauth_consumer_key%3Ddpf43f3p2l4k3l03%26oauth_nonce%3Dkllo9940pd9333jh%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D1191242096%26oauth_token%3Dnnch734d00sl2jdk%26oauth_version%3D1.0%26size%3Doriginal'
+    secret_str = 'kd94hf93k423kf44&pfkkdhi9sl3r4s00'
+    signature  = 'tR3+Ty81lMeYAr/Fid0kMTYa/WM='
+    digest = OpenSSL::HMAC::digest( OpenSSL::Digest::SHA1.new(), secret_str, base_str )
+    assert_equal( signature, [digest].pack('m').gsub!( /\n/u, '' ) )
+    base_str   = 'POST&http%3A%2F%2Fexample.com%2Frequest&a2%3Dr%2520b%26a3%3D2%2520q%26a3%3Da%26b5%3D%253D%25253D%26c%2540%3D%26c2%3D%26oauth_consumer_key%3D9djdj82h48djs9d2%26oauth_nonce%3D7d8f3e4a%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D137131201%26oauth_token%3Dkkk9d7dh3k39sjv7'
+    secret_str = 'j49sk3j29djd&dh893hdasih9'
+    signature  = 'r6%2FTJjbCOr97%2F%2BUU0NsvSne7s5g%3D'
+    digest = OpenSSL::HMAC::digest( OpenSSL::Digest::SHA1.new(), secret_str, base_str )
+    assert_equal( signature, OAuthSimple::HelperFunctions.enc_perenc( [digest].pack('m').gsub!( /\n/u, '' ) ) )
+  end
+  
+  def test_nonce_string_creation
+    # 引数を与えなければ, 16 文字の文字列
+    nonce_str = OAuthSimple::HelperFunctions.create_nonce_str()
+    assert_equal( nonce_str.class, String )
+    assert_equal( nonce_str.length, 16 )
+    # 0 以上の整数を引数として与えると, その長さの文字列
+    [ 20, 0, 300, 432, 125432 ].each do |len|
+      nonce_str = OAuthSimple::HelperFunctions.create_nonce_str( len )
+      assert_equal( nonce_str.class,  String )
+      assert_equal( nonce_str.length, len )
+    end
+  end
+  
+  def test_helper
+    req_helper = OAuthSimple::RequestHelper.new(
+      URI.parse( 'https://api.twitter.com/oauth/request_token' ),
+      'POST',
+      'CONS_SECRET_XXXX&',
+      OAuthSimple::RequestParamList.new( [
+        # TwitVC
+        [ 'oauth_consumer_key',     'CONS_KEY_XXXX'         ],
+        [ 'oauth_signature_method', 'HMAC-SHA1'             ],
+        [ 'oauth_timestamp',        ( Time.now() - Time.utc( 1970, 1, 1 ) ).to_i().to_s() ],
+        [ 'oauth_nonce',            'dfaeaveafefea'         ],
+        [ 'oauth_version',          '1.0'                   ],
+      ] ),
+    )
+    assert_equal( req_helper.host, 'api.twitter.com' )
+    assert_equal( req_helper.port, 443               )
+  end
+  
+  # RFC5849 Sec. 3.1 の試験
+  # http://tools.ietf.org/html/rfc5849
+  # 
+  #   POST /request?b5=%3D%253D&a3=a&c%40=&a2=r%20b HTTP/1.1
+  #   Host: example.com
+  #   Content-Type: application/x-www-form-urlencoded
+  #   
+  #   c2&a3=2+q
+  # 
+  # The client assigns values to the following protocol parameters using
+  # its client credentials, token credentials, the current timestamp, a
+  # uniquely generated nonce, and indicates that it will use the
+  # "HMAC-SHA1" signature method:
+  #  oauth_consumer_key:     9djdj82h48djs9d2
+  #  oauth_token:            kkk9d7dh3k39sjv7
+  #  oauth_signature_method: HMAC-SHA1
+  #  oauth_timestamp:        137131201
+  #  oauth_nonce:            7d8f3e4a
+  def test_sign
+    client_secret = 'j49sk3j29djd'
+    token_secret  = 'dh893hdasih9'
+    req_helper = OAuthSimple::RequestHelper.new(
+      URI.parse( 'http://example.com/request?b5=%3D%253D&a3=a&c%40=&a2=r%20b' ),
+      'POST',
+      "#{client_secret}&#{token_secret}",
+      OAuthSimple::RequestParamList.new( [
+        [ 'oauth_consumer_key',     '9djdj82h48djs9d2' ],
+        [ 'oauth_token',            'kkk9d7dh3k39sjv7' ],
+        [ 'oauth_signature_method', 'HMAC-SHA1'        ],
+        [ 'oauth_timestamp',        '137131201'        ],
+        [ 'oauth_nonce',            '7d8f3e4a'         ],
+      ] ),
+      nil,
+      OAuthSimple::RequestParamList.new( [
+        [ 'c2', nil   ],
+        [ 'a3', '2 q' ],
+      ] ),
+    )
+    #p req_helper.oauth_header_str
+  end
+  
+  def test_factory
+    rhf = OAuthSimple::RequestHelperFactory.new(
+      :consumer_key     => '9djdj82h48djs9d2',
+      :consumer_secret  => 'j49sk3j29djd'    ,
+      :token            => 'kkk9d7dh3k39sjv7',
+      :token_secret     => 'dh893hdasih9'    ,
+      :signature_method => 'HMAC-SHA1'       ,
+    )
+    req_helper = rhf.create(
+      URI.parse( 'http://example.com/request?b5=%3D%253D&a3=a&c%40=&a2=r%20b' ),
+      'POST',
+      :body_params => OAuthSimple::RequestParamList.new( [
+        [ 'c2', nil   ],
+        [ 'a3', '2 q' ],
+      ] )
+    )
+    assert_equal( req_helper.class, OAuthSimple::RequestHelper )
+    #p req_helper.oauth_header_str
+  end
+  
+  ###
+  # test by using OAuth Test Server : http://term.ie/oauth/example/
+  def test_getting_request_token
+    # OAuthSimple::HTTP is a subclass of Net::HTTP
+    http = OAuthSimple::HTTP.new( 'term.ie' )
+    
+    # OAuth setting (this feature provided by OAuthSimple::HTTP)
+    http.use_oauth = true
+    http.set_oauth_client_credentials( 'key', 'secret' )
+    http.set_oauth_signature_method( 'HMAC-SHA1' ) # at this time, only 'HMAC-SHA1' is supported
+    
+    # connection start
+    http.start() do |http|
+      assert_equal( http.class, OAuthSimple::HTTP )
+      http.request_post( '/oauth/example/request_token.php', nil ) do |res|
+        assert_equal( '200', res.code )
+        assert_equal( 'oauth_token=requestkey&oauth_token_secret=requestsecret', res.body )
+      end
+      
+      token, secret = http.request_oauth_temp_credentials( '/oauth/example/request_token.php', 'oob' )
+    end
+  end
+  
+end
+
+__END__
+
+assert( .... )

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: oauth_simple
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- NOBUOKA Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: nobuoka@vividcode.info
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- rakefile.rb
+- .gemtest
+- lib/oauth_simple/request_param_list.rb
+- lib/oauth_simple/helper_functions.rb
+- lib/oauth_simple/request_helper_factory.rb
+- lib/oauth_simple/request_helper.rb
+- lib/oauth_simple/http.rb
+- lib/oauth_simple.rb
+- test/helper_path_setting.rb
+- test/test_http.rb
+- test/test_main.rb
+homepage: https://github.com/nobuoka/ruby-OAuthSimple
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Helper for OAuth 1.0
+test_files:
+- test/test_main.rb