allpay_client 1.0.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45e8efe0cfd77657844f1579f7ba92f0353163ec
-  data.tar.gz: 9359e09cf6c1a665dc6a1ababe6e749a5ff3726f
+  metadata.gz: 289f14a5eea78b627c25e2ba352b8db3fefc0085
+  data.tar.gz: 33a5f66099a93de19b3a2d0fded4d3642bf195d5
 SHA512:
-  metadata.gz: 7a8b488d46e9c5f8eaa892ebfa177cd8f5be1c35425b91f467dec7c356839ca8baaad0098397bf7c5772f2a2b63cef7fd12c220ed7e810f25afdda3c774afe4c
-  data.tar.gz: 67779336cc5698abd9a47b413bec97f8fd1031219d281b578d694f3a06c4505ff7250d2ac1c54bfeb625875503a1547e0f95a77e6060bf2ca19d926907d81843
+  metadata.gz: 53a307012b9805ee5bd2c2f284d7eeaa6455b71d0b877d5ce00d1dc2bdf8e75910771e3dcc3a7c5d616c5fd3f7acab547d340c5a9061a02296b4f46f449fa952
+  data.tar.gz: c1e186805948c1339029b4bab674f2aa506687d7be994a41d07f69157de9f8c3a880eb71cf878dc05a77db55f14cc88af15c155a0315853e33007f3a4c530613

data/README.md

@@ -4,6 +4,10 @@
 
 這是歐付寶 API 的 Ruby 包裝，更多資訊參考他們的[官方文件](https://www.allpay.com.tw/Content/files/%E5%85%A8%E6%96%B9%E4%BD%8D%E9%87%91%E6%B5%81%E4%BB%8B%E6%8E%A5%E6%8A%80%E8%A1%93%E6%96%87%E4%BB%B6.pdf)。
 
+- 這不是 Rails 插件，只是個 API 包裝。
+- 使用時只需要傳送需要的參數即可，不用產生檢查碼，`allpay_client` 會自己產生。
+- 錯誤代碼太多且會不斷增加，筆者不另行撰寫，官方也建議查網站上的代碼清單。
+
 ## 安裝
 
 ```bash
@@ -13,13 +17,14 @@ gem install allpay_client
 ## 使用
 
 ```ruby
-client = Allpay::Client.new({
-  merchant_id: '2000132',
-  hash_key: '5294y06JbISpM5x9',
-  hash_iv: 'v77hoKGq4kWxNNIS',
-  mode: :test
+test_client = Allpay::Client.new(mode: :test)
+production_client = Allpay::Client.new({
+  merchant_id: 'MERCHANT_ID',
+  hash_key: 'HASH_KEY',
+  hash_iv: 'HASH_IV'
 })
-client.request '/Cashier/QueryTradeInfo',
+
+test_client.request '/Cashier/QueryTradeInfo',
   MerchantTradeNo: '0457ce27',
   TimeStamp: Time.now.to_i
 ```
@@ -32,10 +37,10 @@ client.request '/Cashier/QueryTradeInfo',
 - /CreditDetail/DoAction
 - /Cashier/AioChargeback
 
-每個 API 有哪些參數建議直接參考歐付寶文件，不過要注意幾點：
+每個 API 有哪些參數建議直接參考歐付寶文件，注意幾點：
 
-- 原本 API 都需要 `MerchantID` 與 `CheckMacValue`，不過 `Client#request` 已經都處理好了，使用時可忽略這兩個參數，正如上述範例一樣。
-- `/Cashier/AioCheckOut` 回傳的內容是 HTML，這個請求應該是交給瀏覽器發送的，所以不應該寫出 `client.request '/Cashier/AioCheckOut'`這樣的內容。
+- 使用時不用煩惱 `MerchantID` 與 `CheckMacValue`，正如上述範例一樣。
+- `/Cashier/AioCheckOut` 回傳的內容是 HTML，這個請求應該是交給瀏覽器發送的，所以不應該寫出 `client.request '/Cashier/AioCheckOut'` 這樣的內容。
 
 ## Allpay::Client
 
@@ -43,8 +48,10 @@ client.request '/Cashier/QueryTradeInfo',
 ---                                                          | ---                 | ---
 `request(path, **params)`                                    | `Net::HTTPResponse` | 發送 API 請求
 `make_mac(**params)`                                         | `String`            | 用於產生 `CheckMacValue`，單純做加密，`params` 需要完整包含到 `MerchantID`
+`verify_mac(**params)`                                       | `Boolean`           | 會於檢查收到的參數，其檢查碼是否正確，這用在歐付寶物的 `ReturnURL` 與 `PeriodReturnURL` 參數上。
 `query_trade_info(merchant_trade_number, platform = nil)`    | `Hash`              | `/Cashier/QueryTradeInfo` 的捷徑方法，將 `TimeStamp` 設定為當前時間
 `query_period_credit_card_trade_info(merchant_trade_number)` | `Hash`              | `/Cashier/QueryPeriodCreditCardTradeInfo` 的捷徑方法，將 `TimeStamp` 設定為當前時間
+`generate_checkout_params`                                   | `Hash`              | 用於產生 `/Cashier/AioCheckOut` 表單需要的參數，`MerchantTradeDate`、`MerchantTradeNo`、`PaymentType`，可省略。
 
 ## 使用範例
 

data/examples/server.rb

@@ -4,12 +4,9 @@ require 'sinatra'
 require 'allpay'
 
 get '/' do
-  client = Allpay::Client.new(merchant_id: '2000132', hash_key: '5294y06JbISpM5x9', hash_iv: 'v77hoKGq4kWxNNIS', mode: :test)
-  @params = {
-    MerchantID: client.merchant_id,
+  client = Allpay::Client.new(mode: :test)
+  @params = client.generate_checkout_params({
     MerchantTradeNo: SecureRandom.hex(4),
-    MerchantTradeDate: Time.now.strftime('%Y/%m/%d %H:%M:%S'),
-    PaymentType: 'aio',
     TotalAmount: 1000,
     TradeDesc: '腦袋有動工作室',
     ItemName: '物品一#物品二',
@@ -21,7 +18,6 @@ get '/' do
     Frequency: 1,
     ExecTimes: 12,
     PeriodReturnURL: 'http://requestb.in/158bu8e1'
-  }
-  @mac = client.make_mac(@params)
+  })
   erb :index
 end

data/examples/views/index.erb

@@ -6,23 +6,9 @@
 </head>
 <body>
   <form action="http://payment-stage.allpay.com.tw/Cashier/AioCheckOut" method="post">
-    <input type="text" name="MerchantID" value="<%= @params[:MerchantID] %>">
-    <input type="text" name="MerchantTradeNo" value="<%= @params[:MerchantTradeNo] %>">
-    <input type="text" name="MerchantTradeDate" value="<%= @params[:MerchantTradeDate] %>">
-    <input type="text" name="PaymentType" value="<%= @params[:PaymentType] %>">
-    <input type="text" name="TotalAmount" value="<%= @params[:TotalAmount] %>">
-    <input type="text" name="TradeDesc" value="<%= @params[:TradeDesc] %>">
-    <input type="text" name="ItemName" value="<%= @params[:ItemName] %>">
-    <input type="text" name="ReturnURL" value="<%= @params[:ReturnURL] %>">
-    <input type="text" name="ClientBackURL" value="<%= @params[:ClientBackURL] %>">
-    <input type="text" name="ChoosePayment" value="<%= @params[:ChoosePayment] %>">
-    <input type="text" name="PeriodAmount" value="<%= @params[:PeriodAmount] %>">
-    <input type="text" name="PeriodType" value="<%= @params[:PeriodType] %>">
-    <input type="text" name="Frequency" value="<%= @params[:Frequency] %>">
-    <input type="text" name="ExecTimes" value="<%= @params[:ExecTimes] %>">
-    <input type="text" name="PeriodReturnURL" value="<%= @params[:PeriodReturnURL] %>">
-
-    <input type="text" name="CheckMacValue" value="<%= @mac %>">
+    <% @params.each do |k, v| %>
+      <input type="text" name="<%= k %>" value="<%= v %>">
+    <% end %>
     <input type="submit">
   </form>
 </body>

data/lib/allpay.rb

@@ -1,5 +1,5 @@
-require "allpay/version"
-require "allpay/client"
+require 'allpay/version'
+require 'allpay/client'
 
 module Allpay
 end

data/lib/allpay/client.rb

@@ -1,46 +1,73 @@
 require 'net/http'
 require 'json'
+require 'cgi'
+require 'digest'
+require 'allpay/errors'
+require 'allpay/core_ext/hash'
 
 module Allpay
   class Client
     PRODUCTION_API_HOST = 'https://payment.allpay.com.tw'.freeze
     TEST_API_HOST = 'http://payment-stage.allpay.com.tw'.freeze
+    TEST_OPTIONS = {
+      merchant_id: '2000132',
+      hash_key: '5294y06JbISpM5x9',
+      hash_iv: 'v77hoKGq4kWxNNIS'
+    }.freeze
 
-    attr_accessor :merchant_id, :hash_key, :hash_iv, :mode
+    attr_reader :options
 
-    def initialize params = {}
-      merchant_id = params[:merchant_id]
-      hash_key = params[:hash_key]
-      hash_iv = params[:hash_iv]
-      mode = params[:mode]
-      @merchant_id, @hash_key, @hash_iv, @mode = merchant_id, hash_key, hash_iv, mode
+    def initialize options = {}
+      @options = {mode: :production}.merge!(options)
+      case @options[:mode]
+      when :production
+        option_required! :merchant_id, :hash_key, :hash_iv
+      when :test
+        @options = TEST_OPTIONS.merge(options)
+      else
+        raise InvalidMode, %Q{option :mode is either :test or :production}
+      end
+      @options.freeze
     end
 
     def api_host
-      case mode
+      case @options[:mode]
       when :production then PRODUCTION_API_HOST
       when :test then TEST_API_HOST
-      else raise '`mode` is either :test or :production (default)'
       end
     end
 
     def make_mac params = {}
       raw = params.sort.map!{|k,v| "#{k}=#{v}"}.join('&')
-      padded = "HashKey=#{@hash_key}&#{raw}&HashIV=#{@hash_iv}"
+      padded = "HashKey=#{@options[:hash_key]}&#{raw}&HashIV=#{@options[:hash_iv]}"
       url_encoded = CGI.escape(padded).downcase!
       Digest::MD5.hexdigest(url_encoded).upcase!
     end
 
     def verify_mac params = {}
-      check_mac_value = params[:CheckMacValue] || params['CheckMacValue']
-      make_mac(params.reject{ |k,v| [:CheckMacValue, 'CheckMacValue'].include? k }) == check_mac_value
+      stringified_keys = params.stringify_keys
+      check_mac_value = stringified_keys.delete('CheckMacValue')
+      make_mac(stringified_keys) == check_mac_value
+    end
+
+    def generate_params overwrite_params = {}
+      result = overwrite_params.clone
+      result[:MerchantID] = @options[:merchant_id]
+      result[:CheckMacValue] = make_mac(result)
+      result
+    end
+
+    def generate_checkout_params overwrite_params = {}
+      generate_params({
+        MerchantTradeDate: Time.now.strftime('%Y/%m/%d %H:%M:%S'),
+        MerchantTradeNo: SecureRandom.hex(4),
+        PaymentType: 'aio'
+      }.merge!(overwrite_params))
     end
 
     def request path, params = {}
-      params[:MerchantID] = @merchant_id
-      params[:CheckMacValue] = make_mac(params)
       api_url = URI.join(api_host, path)
-      Net::HTTP.post_form api_url, params
+      Net::HTTP.post_form api_url, generate_params(params)
     end
 
     def query_trade_info merchant_trade_number, platform = nil
@@ -60,5 +87,13 @@ module Allpay
               TimeStamp: Time.now.to_i
       JSON.parse(res.body)
     end
+
+    private
+
+    def option_required! *option_names
+      option_names.each do |option_name|
+        raise MissingOption, %Q{option "#{option_name}" is required.} if @options[:option_name].nil?
+      end
+    end
   end
 end

data/lib/allpay/core_ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def stringify_keys
+    result = self.class.new
+    each_key do |key|
+      result[key.to_s] = self[key]
+    end
+    result
+  end
+end

data/lib/allpay/errors.rb

@@ -0,0 +1,6 @@
+module Allpay
+  # Generic Allpay exception class.
+  class AllpayError < StandardError; end
+  class MissingOption < AllpayError; end
+  class InvalidMode < AllpayError; end
+end

data/lib/allpay/version.rb

@@ -1,3 +1,3 @@
 module Allpay
-  VERSION = "1.0.9"
+  VERSION = "2.0.0"
 end

data/spec/allpay_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 require 'securerandom'
 describe Allpay::Client do
   before :all do
-    @client = Allpay::Client.new(merchant_id: '2000132', hash_key: '5294y06JbISpM5x9', hash_iv: 'v77hoKGq4kWxNNIS', mode: :test)
+    @client = Allpay::Client.new(mode: :test)
   end
 
   it '#api /Cashier/AioCheckOut' do
@@ -41,7 +41,7 @@ describe Allpay::Client do
   end
 
   it '#make_mac' do 
-    client = Allpay::Client.new(merchant_id: '12345678', hash_key: 'xdfaefasdfasdfa32d', hash_iv: 'sdfxfafaeafwexfe')
+    client = Allpay::Client.new(merchant_id: '12345678', hash_key: 'xdfaefasdfasdfa32d', hash_iv: 'sdfxfafaeafwexfe', mode: :test)
     mac = client.make_mac({
       ItemName: 'sdfasdfa',
       MerchantID: '12345678',
@@ -70,20 +70,4 @@ describe Allpay::Client do
       MerchantTradeNo: '355313'
     expect(result).to eq true
   end
-
-  it '#verify_mac with string hash' do
-    result = @client.verify_mac 'RtnCode' => '1',
-      'PaymentType' => 'Credit_CreditCard',
-      'TradeAmt' => '700',
-      'PaymentTypeChargeFee' => '14',
-      'PaymentDate' => '2015/02/07 14:21:00',
-      'SimulatePaid' => '0',
-      'CheckMacValue' => '3AF270CCCFA58CA0349F4FD462E21643',
-      'TradeDate' => '2015/02/07 14:20:47',
-      'MerchantID' => '2000132',
-      'TradeNo' => '1502071420478656',
-      'RtnMsg' => '交易成功',
-      'MerchantTradeNo' => '355313'
-    expect(result).to eq true
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allpay_client
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 2.0.0
 platform: ruby
 authors:
 - Jian Weihang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,8 @@ files:
 - examples/views/index.erb
 - lib/allpay.rb
 - lib/allpay/client.rb
+- lib/allpay/core_ext/hash.rb
+- lib/allpay/errors.rb
 - lib/allpay/version.rb
 - lib/allpay_client.rb
 - spec/allpay_spec.rb