allpay_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e71e6f61f2ea5a62e48c694640f883125966ff1
+  data.tar.gz: 5851603bedddfec6ea4f39643095d046e9b8b9f6
+SHA512:
+  metadata.gz: e67fb023a81e3de2b388236f573635b865fe8c5e9d94fe02449a3d2a2c9b6cf0fb293a02c48aeedc459c38dfcc1d0ab911332da1881be2878ef20673752bcdca
+  data.tar.gz: 6b7476079c50b4154c74a5b89bf317ef78d4d8352a1842b3722beadd3b3be804ad041310353386364a3428b2575354d227674802489eb0f0f6e98183acd1ab65

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.5
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jian Weihang
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Allpay 歐付寶
+
+這是歐付寶 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)。
+
+## 安裝
+
+```bash
+gem install allpay_client
+```
+
+## 使用
+
+```ruby
+client = Allpay::Client.new({
+  merchant_id: '2000132',
+  hash_key: '5294y06JbISpM5x9',
+  hash_iv: 'v77hoKGq4kWxNNIS',
+  mode: :test
+})
+client.request '/Cashier/QueryTradeInfo',
+  MerchantTradeNo: '0457ce27',
+  TimeStamp: Time.now.to_i
+```
+
+歐付寶共有 5 個 API：
+
+- /Cashier/AioCheckOut
+- /Cashier/QueryTradeInfo
+- /Cashier/QueryPeriodCreditCardTradeInfo
+- /CreditDetail/DoAction
+- /Cashier/AioChargeback
+
+每個 API 有哪些參數建議直接參考歐付寶文件，不過要注意幾點：
+
+- 原本 API 都需要 `MerchantID` 與 `CheckMacValue`，不過 `Client#request` 已經都處理好了，使用時可忽略這兩個參數，正如上述範例一樣。
+- `/Cashier/AioCheckOut` 回傳的內容是 HTML，這個請求應該是交給瀏覽器發送的，所以不應該寫出 `client.request '/Cashier/AioCheckOut'`這樣的內容。
+
+## Allpay::Client
+
+實體方法                                                     | 回傳                | 說明
+---                                                          | ---                 | ---
+`request(path, **params)`                                    | `Net::HTTPResponse` | 發送 API 請求
+`make_mac(**params)`                                         | `String`            | 用於產生 `CheckMacValue`，單純做加密，`params` 需要完整包含到 `MerchantID`
+`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` 設定為當前時間

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/allpay.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'allpay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "allpay_client"
+  spec.version       = Allpay::VERSION
+  spec.authors       = ["Jian Weihang"]
+  spec.email         = ["tonytonyjan@gmail.com"]
+  spec.summary       = %q{API client for allpay}
+  spec.description   = %q{API client for allpay}
+  # spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/examples/server.rb

@@ -0,0 +1,21 @@
+$: << File.expand_path('../../lib', __FILE__)
+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,
+    MerchantTradeNo: SecureRandom.hex(4),
+    MerchantTradeDate: Time.now.strftime('%Y/%m/%d %H:%M:%S'),
+    PaymentType: 'aio',
+    TotalAmount: 100,
+    TradeDesc: '腦袋有動工作室',
+    ItemName: '物品一#物品二',
+    ReturnURL: 'http://requestb.in/11zuej31',
+    ClientBackURL: 'http://requestb.in/11zuej31?inspect',
+    ChoosePayment: 'Credit'
+  }
+  @mac = client.make_mac(@params)
+  erb :index
+end

data/examples/views/index.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+</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="CheckMacValue" value="<%= @mac %>">
+    <input type="submit">
+  </form>
+</body>
+</html>

data/lib/allpay/client.rb

@@ -0,0 +1,52 @@
+require 'net/http'
+require 'json'
+
+module Allpay
+  class Client
+    PRODUCTION_API_HOST = 'https://payment.allpay.com.tw'.freeze
+    TEST_API_HOST = 'http://payment-stage.allpay.com.tw'.freeze
+
+    attr_accessor :merchant_id, :hash_key, :hash_iv, :mode
+
+    def initialize(merchant_id:, hash_key:, hash_iv:, mode: :production)
+      @merchant_id, @hash_key, @hash_iv, @mode = merchant_id, hash_key, hash_iv, mode
+    end
+
+    def api_host
+      case 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}"
+      url_encoded = CGI.escape(padded).downcase!
+      Digest::MD5.hexdigest(url_encoded).upcase!
+    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
+    end
+
+    def query_trade_info merchant_trade_number, platform = nil
+      res = request '/Cashier/QueryTradeInfo',
+              MerchantTradeNo: merchant_trade_number,
+              TimeStamp: Time.now.to_i,
+              PlatformID: platform
+      Hash[res.body.split('&').map!{|i| i.split('=')}]
+    end
+
+    def query_period_credit_card_trade_info merchant_trade_number
+      res = request '/Cashier/QueryPeriodCreditCardTradeInfo',
+              MerchantTradeNo: merchant_trade_number,
+              TimeStamp: Time.now.to_i
+      JSON.parse(res.body)
+    end
+  end
+end

data/lib/allpay/version.rb

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

data/lib/allpay.rb

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

data/spec/allpay_spec.rb

@@ -0,0 +1,56 @@
+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)
+  end
+
+  it '#api /Cashier/AioCheckOut' do
+    res = @client.request '/Cashier/AioCheckOut',
+      MerchantTradeNo: SecureRandom.hex(4),
+      MerchantTradeDate: Time.now.strftime('%Y/%m/%d %H:%M:%S'),
+      PaymentType: 'aio',
+      TotalAmount: 100,
+      TradeDesc: '腦袋有動工作室',
+      ItemName: '物品一#物品二',
+      ReturnURL: 'http://requestb.in/11zuej31',
+      ClientBackURL: 'http://requestb.in/11zuej31?inspect',
+      ChoosePayment: 'Credit'
+    expect(res.code).to eq '302'
+  end
+
+  it '#api /Cashier/QueryTradeInfo' do
+    res = @client.request '/Cashier/QueryTradeInfo',
+      MerchantTradeNo: '0457ce27',
+      TimeStamp: Time.now.to_i
+    expect(res.code).to eq '200'
+  end
+
+  it '#query_trade_info' do
+    result_hash = @client.query_trade_info '0457ce27'
+    expect(result_hash.keys).to match_array %w[HandlingCharge ItemName MerchantID MerchantTradeNo
+      PaymentDate PaymentType PaymentTypeChargeFee TradeAmt TradeDate TradeNo TradeStatus CheckMacValue]
+  end
+
+  it '#query_period_credit_card_trade_info' do
+    result_hash = @client.query_period_credit_card_trade_info '0457ce27'
+    expect(result_hash.keys).to match_array %w[MerchantID MerchantTradeNo TradeNo RtnCode PeriodType
+      Frequency ExecTimes PeriodAmount amount gwsr process_date auth_code card4no
+      card6no TotalSuccessTimes TotalSuccessAmount ExecLog]
+  end
+
+  it '#make_mac' do 
+    client = Allpay::Client.new(merchant_id: '12345678', hash_key: 'xdfaefasdfasdfa32d', hash_iv: 'sdfxfafaeafwexfe')
+    mac = client.make_mac({
+      ItemName: 'sdfasdfa',
+      MerchantID: '12345678',
+      MerchantTradeDate: '2013/03/12 15:30:23',
+      MerchantTradeNo: 'allpay_1234',
+      PaymentType: 'allpay',
+      ReturnURL: 'http:sdfasdfa',
+      TotalAmount: '500',
+      TradeDesc: 'dafsdfaff'
+    })
+    expect(mac).to eq '40D9A6C00A4A78A300ED458237071BDA'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'allpay'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: allpay_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jian Weihang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client for allpay
+email:
+- tonytonyjan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- allpay.gemspec
+- examples/server.rb
+- examples/views/index.erb
+- lib/allpay.rb
+- lib/allpay/client.rb
+- lib/allpay/version.rb
+- spec/allpay_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: API client for allpay
+test_files:
+- spec/allpay_spec.rb
+- spec/spec_helper.rb
+has_rdoc: