gmo 0.0.1

data/lib/gmo/shop_and_site_api.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+module GMO
+  module Payment
+
+    module ShopAndSiteAPIMethods
+      def initialize(options = {})
+        @shop_id     = options[:shop_id]
+        @shop_pass   = options[:shop_pass]
+        @site_id     = options[:site_id]
+        @site_pass   = options[:site_pass]
+        @development = options[:development] || true
+        unless @site_id && @site_pass && @shop_id && @shop_pass
+          raise ArgumentError, "Initialize must receive a hash with :site_id, :site_pass, :shop_id and either :shop_pass! (received #{options.inspect})"
+        end
+      end
+      attr_reader :shop_id, :shop_pass, :site_id, :site_pass, :development
+
+      # 2.17.2.1.決済後カード登録
+      # 指定されたオーダーID の取引に使用したカードを登録します。
+      ### @return ###
+      # CardSeq
+      # CardNo
+      # Forward
+      def trade_card(options = {})
+        name = "TradedCard.idPass"
+        args = {
+          "OrderID"     => options[:order_id],
+          "MemberID"    => options[:member_id],
+          "SeqMode"     => options[:seq_mode] || "0",
+          "DefaultFlag" => options[:default_flag] || "0",
+          "HolderName"  => options[:holder_name]
+        }
+        args.delete("HolderName") if options[:holder_name].nil?
+        post_request name, args
+      end
+
+      private
+
+        def api_call(name, args = {}, verb = "post", options = {})
+          args.merge!({
+            "ShopID"   => @shop_id,
+            "ShopPass" => @shop_pass,
+            "SiteID"   => @site_id,
+            "SitePass" => @site_pass
+          })
+          response = api(name, args, verb, options) do |response|
+            if response.is_a?(Hash) && !response["ErrInfo"].nil?
+              raise APIError.new(response)
+            end
+          end
+          response
+        end
+
+    end
+  end
+end

data/lib/gmo/shop_api.rb

@@ -0,0 +1,218 @@
+# coding: utf-8
+
+# A client for the GMO Payment API.
+#
+# example
+# gmo = GMO::Payment::ShopAPI.new({
+#   shop_id:     "foo",
+#   shop_pass:   "bar",
+#   development:  true
+# })
+# result = gmo.post_request("EntryTran.idPass", options)
+module GMO
+  module Payment
+
+    module ShopAPIMethods
+
+      def initialize(options = {})
+        @shop_id     = options[:shop_id]
+        @shop_pass   = options[:shop_pass]
+        @development = options[:development] || true
+        unless @shop_id && @shop_pass
+          raise ArgumentError, "Initialize must receive a hash with :shop_id and either :shop_pass! (received #{options.inspect})"
+        end
+      end
+      attr_reader :shop_id, :shop_pass, :development
+
+      ## 2.1.2.1.取引登録
+      # これ以降の決済取引で必要となる取引 ID と取引パスワードの発行を行い、取引を開始します。
+      # ItemCode
+      # Tax
+      # TdFlag
+      # TdTenantName
+      ### @return ###
+      # AccessID
+      # AccessPass
+      # ErrCode
+      # ErrInfo
+      ### example ###
+      # gmo.entry_tran({
+      #   order_id: 100,
+      #   job_cd: "AUTH",
+      #   amount: 100
+      # })
+      # {"AccessID"=>"a41d83f1f4c908baeda04e6dc03e300c", "AccessPass"=>"d72eca02e28c88f98b9341a33ba46d5d"}
+      def entry_tran(options = {})
+        name = "EntryTran.idPass"
+        args = {
+          "OrderID"  => options[:order_id],
+          "JobCd"    => options[:job_cd],
+          "Amount"   => options[:amount]
+        }
+        post_request name, args
+      end
+
+      ## 2.2.2.2.決済実行
+      # 指定されたサイトに会員を登録します。
+      # return
+      # ACS
+      # OrderID
+      # Forward
+      # Method
+      # PayTimes
+      # Approve
+      # TranID
+      # TranDate
+      # CheckString
+      # ClientField1
+      # ClientField2
+      # ClientField3
+      ### @return ###
+      # ACS
+      # OrderID
+      # Forward
+      # Method
+      # PayTimes
+      # Approve
+      # TranID
+      # CheckString
+      # ClientField1
+      # ClientField2
+      # ClientField3
+      ### example ###
+      # gmo.exec_tran({
+      #   order_id:      100,
+      #   access_id:    "a41d83f1f4c908baeda04e6dc03e300c",
+      #   access_pass:  "d72eca02e28c88f98b9341a33ba46d5d",
+      #   method:        1,
+      #   pay_times:     1,
+      #   card_no:       "4111111111111111",
+      #   expire:        "1405", #format YYMM
+      #   client_field1: "client_field1"
+      # })
+      # {"ACS"=>"0", "OrderID"=>"100", "Forward"=>"2a99662", "Method"=>"1", "PayTimes"=>"", "Approve"=>"6294780", "TranID"=>"1302160543111111111111192829", "TranDate"=>"20130216054346", "CheckString"=>"3e455a2168fefc90dbb7db7ef7b0fe82", "ClientField1"=>"client_field1", "ClientField2"=>"", "ClientField3"=>""}
+      def exec_tran(options = {})
+        name = "ExecTran.idPass"
+        if options[:client_field1] || options[:client_field2] || options[:client_field3]
+          client_field_flg = "1"
+        else
+          client_field_flg = "0"
+        end
+        args = {
+          "AccessID"        => options[:access_id],
+          "AccessPass"      => options[:access_pass],
+          "OrderID"         => options[:order_id],
+          "Method"          => options[:method],
+          "PayTimes"        => options[:pay_times],
+          "CardNo"          => options[:card_no],
+          "Expire"          => options[:expire],
+          "HttpAccept"      => options[:http_accept],
+          "HttpUserAgent"   => options[:http_ua],
+          "DeviceCategory"  => "0",
+          "ClientField1"    => options[:client_field1],
+          "ClientField2"    => options[:client_field2],
+          "ClientField3"    => options[:client_field3],
+          "ClientFieldFlag" => client_field_flg
+        }
+        post_request name, args
+      end
+
+      ## 2.14.2.1.決済変更
+      # 仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。
+      # /payment/AlterTran.idPass
+      # ShopID
+      # ShopPass
+      # AccessID 取引ID
+      # AccessPass 取引パスワード
+      # JobCd 処理区分 "SALES"
+      # Amount 利用金額
+      ### @return ###
+      # AccessID
+      # AccessPass
+      # Forward
+      # Approve
+      # TranID
+      # TranDate
+      ### example ###
+      # gmo.alter_tran({
+      #   access_id:    "a41d83f1f4c908baeda04e6dc03e300c",
+      #   access_pass:  "d72eca02e28c88f98b9341a33ba46d5d",
+      #   job_cd: "SALES",
+      #   amount: 100
+      # })
+      # {"AccessID"=>"381d84ae4e6fc37597482573a9569f10", "AccessPass"=>"cc0093ca8758c6616fa0ab9bf6a43e8d", "Forward"=>"2a99662", "Approve"=>"6284199", "TranID"=>"1302140555111111111111193536", "TranDate"=>"20130215110651"}
+      def alter_tran(options = {})
+        name = "AlterTran.idPass"
+        args = {
+          "AccessID"   => options[:access_id],
+          "AccessPass" => options[:access_pass],
+          "JobCd"      => options[:job_cd] || "SALES",
+          "Amount"     => options[:amount]
+        }
+        post_request name, args
+      end
+
+      ## 2.15.2.1.金額変更
+      # 決済が完了した取引に対して金額の変更を行います。
+      ### @return ###
+      # AccessID
+      # AccessPass
+      # Forward
+      # Approve
+      # TranID
+      # TranDate
+      ### example ###
+      # gmo.change_tran({
+      #   access_id:    "a41d83f1f4c908baeda04e6dc03e300c",
+      #   access_pass:  "d72eca02e28c88f98b9341a33ba46d5d",
+      #   JobCd: 100,
+      #   Amount: 100
+      # })
+      def change_tran(options = {})
+        name = "ChangeTran.idPass"
+        args = {
+          "AccessID"   => options[:access_id],
+          "AccessPass" => options[:access_pass],
+          "JobCd"      => options[:job_cd],
+          "Amount"     => options[:amount]
+        }
+        post_request name, args
+      end
+
+      ## 2.16.2.1.取引状態参照
+      # 指定したオーダーID の取引情報を取得します。
+      def search_trade(options = {})
+        name = "SearchTrade.idPass"
+        args = {
+          "OrderID" => options[:order_id]
+        }
+        post_request name, args
+      end
+
+      # 13.1.2.1.取引状態参照
+      # 指定したオーダーIDの取引情報を取得します。
+      def search_trade_multi(options = {})
+        name = "SearchTradeMulti.idPass"
+        args = {
+          "OrderID" => options[:order_id],
+          "PayType" => options[:pay_type]
+        }
+        post_request name, args
+      end
+
+      private
+
+        def api_call(name, args = {}, verb = "post", options = {})
+          args.merge!({ "ShopID" => @shop_id, "ShopPass" => @shop_pass })
+          response = api(name, args, verb, options) do |response|
+            if response.is_a?(Hash) && !response["ErrInfo"].nil?
+              raise APIError.new(response)
+            end
+          end
+          response
+        end
+
+    end
+
+  end
+end

data/lib/gmo/site_api.rb

@@ -0,0 +1,146 @@
+# coding: utf-8
+
+# A client for the GMO Payment API.
+#
+# example
+# gmo = GMO::Payment::SiteAPI.new({
+#   site_id:     "foo",
+#   site_pass:   "bar",
+#   development:  true
+# })
+# result = gmo.post_request("EntryTran.idPass", options)
+module GMO
+  module Payment
+
+    module SiteAPIMethods
+
+      def initialize(options = {})
+        @site_id     = options[:site_id]
+        @site_pass   = options[:site_pass]
+        @development = options[:development] || true
+        unless @site_id && @site_pass
+          raise ArgumentError, "Initialize must receive a hash with :site_id and either :site_pass! (received #{options.inspect})"
+        end
+      end
+      attr_reader :site_id, :site_pass, :development
+
+      ## 2.3.2.1.会員登録
+      # 指定されたサイトに会員を登録します。
+      def save_member(options = {})
+        name = "SaveMember.idPass"
+        args = {
+          "MemberID"   => options[:member_id],
+          "MemberName" => options[:member_name]
+        }
+        post_request name, args
+      end
+
+      ## 2.4.2.1.会員更新
+      # 指定されたサイトに会員情報を更新します。
+      def update_member(options = {})
+        name = "UpdateMember.idPass"
+        args = {
+          "MemberID"   => options[:member_id],
+          "MemberName" => options[:member_name]
+        }
+        post_request name, args
+      end
+
+      ## 2.5.2.1.会員削除
+      # 指定したサイトから会員情報を削除します。
+      def delete_member(options = {})
+        name = "DeleteMember.idPass"
+        args = {
+          "MemberID" => options[:member_id]
+        }
+        post_request name, args
+      end
+
+      ## 2.6.2.1.会員参照
+      # 指定したサイトの会員情報を参照します。
+      def search_member(options = {})
+        name = "SearchMember.idPass"
+        args = {
+          "MemberID" => options[:member_id]
+        }
+        post_request name, args
+      end
+
+      ## 2.7.2.1.カード登録/更新
+      # 指定した会員にカード情報を登録します。尚、サイトに設定されたショップ ID を使用してカード会社と通信を行い有効性の確認を行います。
+      def save_card(options = {})
+        name = "SaveCard.idPass"
+        args = {
+          "MemberID" => options[:member_id],
+          "CardSeq"  => options[:card_seq],
+          "CardNo"   => options[:card_no],
+          "Expire"   => options[:expire]
+        }
+        args.delete("CardSeq") if options[:card_seq].nil?
+        post_request name, args
+      end
+
+      ## 2.8.2.1.カード削除
+      # 指定した会員のカード情報を削除します。
+      def delete_card(options = {})
+        name = "DeleteCard.idPass"
+        args = {
+          "MemberID" => options[:member_id],
+          "CardSeq"  => options[:card_seq]
+        }
+        post_request name, args
+      end
+
+      ## 2.9.2.1.カード参照
+      # お客様が選択したカード登録連番のカード情報を取得します。
+      # カード情報が本人認証サービスに対応していない場合は、カード会社との通信を行い決済を実行します。その際の出力パラメータは「2.10.2.3決済実行」の出力パラメータと同じになります。
+      # /payment/ExecTran.idPass
+      def search_card(options = {})
+        name = "SearchCard.idPass"
+        args = {
+          "MemberID" => options[:member_id],
+          "CardSeq"  => options[:card_seq],
+          "SeqMode"  => options[:seq_mode]
+        }
+        post_request name, args
+      end
+
+      ## 2.11.2.3. 決済実行
+      # お客様が選択したカード登録連番のカード情報を取得します。
+      # カード情報が本人認証サービスに対応していない場合は、カード会社との通信を行い決済を実行します。その際の出力パラメータは「2.10.2.3決済実行」の出力パラメータと同じになります。
+      # /payment/ExecTran.idPass
+      def exec_tran(options = {})
+        name = "ExecTran.idPass"
+        args = {
+          "AccessID"       => options[:access_id],
+          "AccessPass"     => options[:access_pass],
+          "OrderID"        => options[:order_id],
+          "JobCd"          => "SALES",
+          "Method"         => options[:method],
+          "PayTimes"       => options[:pay_times],
+          "MemberID"       => options[:member_id],
+          "CardSeq"        => options[:card_seq],
+          "Amount"         => options[:amount],
+          "HttpAccept"     => options[:http_accept],
+          "HttpUserAgent"  => options[:http_ua],
+          "DeviceCategory" => "0"
+        }
+        post_request name, args
+      end
+
+      private
+
+        def api_call(name, args = {}, verb = "post", options = {})
+          args.merge!({ "SiteID" => @site_id, "SitePass" => @site_pass })
+          response = api(name, args, verb, options) do |response|
+            if response.is_a?(Hash) && !response["ErrInfo"].nil?
+              raise APIError.new(response)
+            end
+          end
+          response
+        end
+
+    end
+
+  end
+end

data/lib/gmo/version.rb

@@ -0,0 +1,3 @@
+module GMO
+  VERSION = "0.0.1"
+end

data/spec/gmo/api_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe "GMO::Payment::API" do
+
+  describe "#get_request" do
+    it "raises" do
+      lambda {
+        service = GMO::Payment::API.new()
+        service.get_request("foo")
+      }.should raise_error(RuntimeError)
+    end
+  end
+
+  describe "#post_request" do
+    it "raises" do
+      lambda {
+        service = GMO::Payment::API.new()
+        service.post_request("foo")
+      }.should raise_error(RuntimeError)
+    end
+  end
+
+  describe "#api_call" do
+    it "raises" do
+      lambda {
+        service = GMO::Payment::API.new()
+        service.api_call
+      }.should raise_error(NoMethodError)
+    end
+  end
+
+end