clickclient 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-12-15
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,57 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL, 
+or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+      with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+      the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.txt

@@ -0,0 +1,34 @@
+= CLICK Client -- CLICK Securities Web Service Client Library for Ruby.
+
+CLICK Client is a CLICK Securities Web Service Client for Ruby. 
+CLICK Client はクリック証券Webサービスにアクセスするためのクライアントライブラリです。
+以下の機能を提供します。
+
+* 外為証拠金取引(FX)取引
+
+
+== Dounload
+
+CLICK Clientの最新バージョンは以下のサイトからダウンロードできます。
+
+* http://rubyforge.org/projects/clickclient
+
+
+== Installation
+
+rubygemを使ってインストール可能です。なお、依存もジュールとして「httpclient」も必要となります。
+以下のコマンドを実行してインストールしてください。
+  
+  % [sudo] gem install httpclient --source http://dev.ctor.org/download/
+  % [sudo] gem install clickclient
+
+
+== License
+
+Ruby ライセンスに準拠
+
+
+== Disclaimer
+* 本ライブラリの利用は自己責任でお願いします。
+* ライブラリの不備・不具合等によるあらゆる損害について、作成者は責任を負いません。
+

data/example/example_use_localserver.rb

@@ -0,0 +1,202 @@
+require File.dirname(__FILE__) + '/../lib/clickclient'
+
+require 'kconv'
+
+#== 利用サンプル
+#ローカルサーバーに接続し、結果を表示します。
+c = ClickClient::Client.new
+
+# ローカルサーバーへの接続設定
+c.host_name = "http://localhost:8000"
+c.fx_path = "/webservice/ws-redirect"
+c.fx_session( "012345678", "sdfsdf" ) { | fx_session | 
+  
+  # 通貨ペア一覧取得
+  # 引数で取得する通貨ペアコードを配列で指定
+  # 指定しない場合すべての通貨ペアの情報を取得。
+  puts "\n--- list_currency_pairs"
+  list = fx_session.list_currency_pairs [GMO::FX::USDJPY, GMO::FX::EURJPY]
+  list.each{ |currency_pair_code, value|  puts value }
+  
+  # レート一覧取得 
+  puts "\n--- list_rates"
+  list = fx_session.list_rates
+  list.each{ |currency_pair_code, value|  puts value }
+  
+  # 成り行き注文
+  puts "\n--- order - buy"
+  puts fx_session.order( GMO::FX::USDJPY, GMO::FX::BUY, 2  )
+  puts "\n--- order - sell"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 1, {
+    :slippage=>99,
+    :slippage_base_rate=>list[GMO::FX::USDJPY].bid_rate
+  })
+  puts result
+  
+  # 成り行き決済注文
+  puts "\n--- settle"
+  puts fx_session.settle( result.order_no, 1 )
+  puts fx_session.settle( result.order_no, 2, {
+    :slippage=>99,
+    :slippage_base_rate=>list[GMO::FX::USDJPY].bid_rate
+  })
+  
+  # 通常注文
+  puts "\n--- order - basic sell"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 1, {
+    :rate=>145.19,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 5, 0 )
+  })
+  puts result
+
+  # 注文変更
+  puts "\n--- edit_order"
+  fx_session.edit_order( result.order_no, {
+    :rate=>145.19,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_TODAY
+  })
+  
+  # 注文取消し
+  puts "\n--- cancel_order"
+  fx_session.cancel_order( result.order_no )
+  
+  # 通常決済注文
+  puts "\n--- settle - basic"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 2, {
+    :rate=>145.19,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_TODAY
+  })
+  puts fx_session.settle( result.order_no, 2, {
+    :rate=>146.20,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 5, 0 )
+  })
+  
+  # OCO注文
+  puts "\n--- order - oco"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 1, {
+    :rate=>145.19,
+    :stop_order_rate=>144.19,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 5, 0 )
+  })
+  puts result
+  
+  # OCO注文変更
+  puts "\n--- edit - oco"
+  fx_session.edit_order( result.limit_order_no, {
+    :stop_order_no=>result.stop_order_no,
+    :rate=>145.29,
+    :stop_order_rate=>144.29,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 6, 0 )
+  }) 
+  
+  # OCO決済注文
+  puts "\n--- settle - oco"
+  puts fx_session.settle( result.limit_order_no, 2, {
+    :rate=>146.20,
+    :stop_order_rate=>144.19,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 5, 0 )
+  })    
+  
+  # IFD取引
+  puts "\n--- order - ifd"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 1, {
+    :rate=>145.19,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 5, 0 ),
+    :settle=>{
+      :unit=>1,
+      :sell_or_buy=>GMO::FX::BUY,
+      :rate=>145.91,
+      :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+      :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+      :expiration_date=>DateTime.new( 2007, 11, 5, 0 ),
+    }
+  })
+  puts result   
+  
+  # IFD注文変更
+  puts "\n--- edit - ifd"
+  fx_session.edit_order( result.order_no, {
+    :rate=>145.29,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_TODAY,
+    :settle=>{
+      :order_no=>result.settlement_order_no,
+      :rate=>145.91,
+      :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+      :expiration_date=>DateTime.new( 2007, 11, 6, 0 ),
+    }
+  })   
+  
+  # IFD-OCO取引
+  puts "\n--- order - ifd-oco"
+  result = fx_session.order( GMO::FX::USDJPY, GMO::FX::SELL, 1, {
+    :rate=>145.19,
+    :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_TODAY,
+    :settle=>{
+      :unit=>1,
+      :sell_or_buy=>GMO::FX::BUY,
+      :rate=>145.91,
+      :stop_order_rate=>144.15,
+      :execution_expression=>GMO::FX::EXECUTION_EXPRESSION_LIMIT_ORDER,
+      :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+      :expiration_date=>DateTime.new( 2007, 11, 5, 0 ),
+    }
+  })
+  puts result  
+  
+  # IFD-OCO注文変更
+  puts "\n--- edit - ifd-oco"
+  fx_session.edit_order( result.order_no, {
+    :rate=>145.29,
+    :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+    :expiration_date=>DateTime.new( 2007, 11, 6, 0 ),
+    :settle=>{
+      :order_no=>result.kessaiSashineChumonBango,
+      :stop_order_no=>result.kessaiGyakusashiChumonBango,
+      :rate=>145.21,
+      :stop_order_rate=>144.15,
+      :expiration_type=>GMO::FX::EXPIRATION_TYPE_SPECIFIED,
+      :expiration_date=>DateTime.new( 2007, 11, 6, 0 ),
+    }
+  })     
+  
+  # 注文一覧取得
+  # 引数で、注文状態コード(必須)、通貨ペアコード、注文日期間開始日、注文日期間終了日を指定可能。
+  puts "\n--- list_orders"
+  list = fx_session.list_orders GMO::FX::ORDER_CONDITION_ALL, GMO::FX::EURJPY, Date.new( 2007, 10, 1 ), Date.new( 2007, 11, 1 )
+  list.each{ |item|  puts item }  
+  
+  # 建玉一覧取得
+  # 引数で、通貨ペアコードを指定可能。(省略可)
+  puts "\n--- list_open_interests"
+  list = fx_session.list_open_interests( GMO::FX::EURJPY )
+  list.each{ |item|  puts item }
+  
+  # 約定一覧取得
+  # 引数で、取得期間(開始日,終了日)(必須)、通貨ペアコード、取引タイプ(新規Or決済)を指定可能。
+  puts "\n--- list_execution_results"
+  list = fx_session.list_execution_results( Date.new( 2007, 10, 1 ), Date.new( 2007, 11, 1 ) )
+  list.each{ |item|  puts item }   
+  list = fx_session.list_execution_results( Date.new( 2007, 10, 1 ), Date.new( 2007, 11, 1 ), GMO::FX::TRADE_TYPE_NEW, GMO::FX::EURJPY )
+  list.each{ |item|  puts item }
+  
+  # 余力情報の取得
+  puts "\n--- get_margin"
+  puts fx_session.get_margin
+  
+  # お知らせ一覧取得
+  puts "\n--- list_messages"
+  list = fx_session.list_messages
+  list.each{ |item|  puts item.to_s.tosjis }  
+}

data/lib/clickclient/common.rb

@@ -0,0 +1,208 @@
+begin
+  require 'rubygems'
+rescue LoadError
+end
+require 'httpclient'
+require 'rexml/document'
+require 'date'
+
+#
+#=== クリック証券アクセスクライアント
+#
+#*Version*::   0.0.1 
+#*License*::   Ruby ライセンスに準拠
+#
+#クリック証券Webサービスを利用するためのクライアントライブラリです。以下の機能を提供します。
+#- 外為証拠金取引(FX)取引
+#
+#====依存モジュール
+#「{httpclient}[http://dev.ctor.org/http-access2]」を利用しています。以下のコマンドを実行してインストールしてください。
+#
+# gem install httpclient --source http://dev.ctor.org/download/
+#
+#====基本的な使い方
+#
+# require 'clickclient'
+# 
+# c = ClickClient::Client.new 
+# # c = ClickClient::Client.new https://<プロキシホスト>:<プロキシポート> # プロキシを利用する場合
+# c.fx_session( "<ユーザー名>", "<パスワード>" ) { | fx_session |
+#   # 通貨ペア一覧取得
+#   list = fx_session.list_currency_pairs
+#   puts list
+# } 
+#なお、ご利用にあたっては「{クリック証券Ｗｅｂサービス利用規約}[https://sec.gmo.jp/corp/guide/regulations/pdf/reg_webservice.pdf]
+#」(PDF)に同意して頂く必要があります。
+#
+#====免責
+#- 本ライブラリの利用は自己責任でお願いします。
+#- ライブラリの不備・不具合等によるあらゆる損害について、作成者は責任を負いません。
+#
+module ClickClient
+  
+  # クライアント
+  class Client
+
+    # ホスト名
+    DEFAULT_HOST_NAME = "https://sec-sso.gmo.jp"
+
+    #
+    #===コンストラクタ
+    #
+    #*proxy*:: プロキシホストを利用する場合、そのホスト名とパスを指定します。
+    # 例) https://proxyhost.com:80
+    #
+    def initialize( proxy=nil  )
+      @client = HTTPClient.new( proxy, "ClickClientLib")
+      @client.set_cookie_store("cookie.dat")
+      @host_name = DEFAULT_HOST_NAME
+    end
+    
+    #ホスト名
+    attr :host_name, true
+    
+  private
+    # ログインしてブロックを実行する。ブロックの実行後ログアウトする。
+    def session( uri, userid, password, &block )
+
+      # sequence 1
+      result = @client.post(uri, "u=" << userid )
+      seq2_uri = result.header["Location"].to_s
+      raise "fail session-1.responce=" << result.content  if seq2_uri == nil  || seq2_uri.length <= 0
+
+      # sequence 2
+      result = @client.get( seq2_uri )
+      doc = REXML::Document.new(result.content)
+      unless ( doc.text( "./loginResponse/responseStatus" ) =~ /OK/  )
+        raise "fail session-2." << doc.text( "./loginResponse/message" )
+      end
+
+      # sequence 3
+      base_uri = File.dirname( seq2_uri  )
+      result = @client.post(  base_uri  +  "/ws-login", "j_username=#{userid}&j_password=#{password}" )
+      seq4_uri = result.header["Location"]
+      if ( seq4_uri == nil  || seq4_uri.length <= 0 )
+        doc = REXML::Document.new(result.content)
+        raise "fail session-3." << doc.text( "./loginResponse/message" )
+      end
+
+      # sequence 4
+      # responseStatusがOKになるまでリダイレクトが続く。
+      while ( true )
+        result = @client.get( seq4_uri )
+        doc = REXML::Document.new(result.content)
+        if ( doc.text( "./loginResponse/responseStatus" ) =~ /OK/  )
+          break
+        else
+          seq4_uri = result.header["Location"]
+          raise "fail session-4.responce=" << result.content  if seq4_uri == nil  || seq4_uri.length <= 0
+        end
+      end
+
+      begin
+        block.call( @client, base_uri )
+      ensure
+        # logout
+        result = @client.post(  base_uri  +  "/ws-logout" )
+        doc = REXML::Document.new(result.content)
+        unless ( doc.text( "./logoutResponse/responseStatus" ) =~ /OK/  )
+          raise "fail session-5." << doc.text( "./logoutResponse/message" )
+        end
+      end
+
+    end
+  end
+
+private
+
+  #
+  #=== 結果オブジェクトの抽象基底クラス。
+  #
+  class Base #:nodoc:
+    def initialize( item )
+      # 属性と子要素の値を、オブジェクトの属性として格納する。
+      item.attributes.each { |name, value|
+        set_attribute(name.to_s ,value)
+      }
+      item.elements.each { |elm|
+        if ( elm.name != "responseStatus" && elm.name != "message" )
+          set_attribute(elm.name.to_s, elm.text)
+        end
+      }
+    end
+    def to_s
+      str = ""
+      instance_variables.each { |name|
+        str += name + "=" + instance_variable_get(name).to_s + ", "
+      }
+      return str.chop.chop
+    end
+    def method_missing( name, *args )
+      if name.to_s =~ /(.*?)=/
+        name = $1
+        setter = true
+      end
+      
+      # 同名の属性があればそれのReaderと見なし、属性値を返す。
+      value = instance_variable_get("@" << name.to_s)
+      unless ( value == nil )
+        if setter
+          instance_variable_set( "@" << name, args[0] )
+        else
+          return value
+        end
+      else
+        super(name)
+      end
+    end
+    def hash 
+      hash = 0
+      values.each {|v|
+        hash = v.hash + 31 * hash
+      }
+      return hash
+    end
+    def eql?(other)
+      return false if other == nil 
+      return false unless other.is_a?( Base )
+      a = values
+      b = other.values
+      return false if a.length != b.length
+      a.length.times{|i|
+        return false unless a[i].eql? b[i]
+      }
+      return true
+    end
+  protected
+    def values
+      values = []
+      instance_variables.each { |name|
+        values << instance_variable_get(name)
+      }
+      return values
+    end
+  private
+    def set_attribute(name ,value)
+      if ( value =~  /^\d+$/)
+        value = value.to_i
+      elsif ( value =~  /^[\d\.]+$/)
+        value = value.to_f
+      elsif ( value =~ /^\d{4}-\d{2}-\d{2}\s+\d{2}:\d{2}:\d{2}$/)
+        value = DateTime.strptime( value, "%Y-%m-%d %H:%M:%S")
+      elsif ( value =~ /^\d{4}-\d{2}-\d{2}$/)
+        value = DateTime.strptime( value, "%Y-%m-%d")
+      end
+      instance_variable_set( "@" << name, value )
+    end
+  end
+
+  # 結果を解析し、エラーであれば例外をスローする。
+  def self.parse( content )
+    doc = REXML::Document.new( content )
+    unless ( doc.text( "./*/responseStatus" ) =~ /OK/  )
+      raise "fail." << doc.text( "./*/message" )
+    end
+    return doc
+  end
+
+end