active_merchant_pay2go 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f55bb8d2006a427c075c364acf2a9b200060bcf9
-  data.tar.gz: 25986d4763d59489305a4a5707849ea3dd806c47
+  metadata.gz: d23e9bc1ca09cac881fece50e4e64bfdedc87cc2
+  data.tar.gz: 5ff36d0f6871ee64f0ebc9d7e5f980019e91231b
 SHA512:
-  metadata.gz: ebff76ca4790061955fcea86f620fc35c33848c21f730bbb9f6efa22f3dbda0e56e6fffe9e111e0c26a57ad0927b3352681c0dc2d1c4887396918ada2886937e
-  data.tar.gz: ff07d32b3ba5d5bf39f46a2aea661fffcad24d381ff23a2a3badeea421803ddac84c06c7f427196971064b49aa1562178c6923b1c854f6241c01d23e025d9b0c
+  metadata.gz: 0c973f9d2cbc1dfcf245b24162fb4e04d0d4ca26240b8bf59222c8b5b3b5921e6118dfc030c77a581302c8c5c76ac4f657c5a32e7943cf45cb37fef2355298f8
+  data.tar.gz: b851ecbc935c2ae482168ce92ed47b22b9c9cadad7d16ffa172972552c04d74f07f87b37480c553e508608ddd4e263ba6b42c96a24e8aa59f3171774bab2b5dc

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 test/tmp/*
 *.gem
+coverage

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.4
+  - 2.3.0
 before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_merchant_pay2go.gemspec
 gemspec
+
+group 'test' do
+  gem 'simplecov', require: false
+  gem 'minitest-reporters', require: false
+end

data/README.md

@@ -1,11 +1,12 @@
+[![Build Status](https://travis-ci.org/imgarylai/active_merchant_pay2go.svg?branch=master)](https://travis-ci.org/imgarylai/active_merchant_pay2go)
+[![Code Climate](https://codeclimate.com/github/imgarylai/active_merchant_pay2go/badges/gpa.svg)](https://codeclimate.com/github/imgarylai/active_merchant_pay2go)
+
 # ActiveMerchantPay2go
 
 This gem integrate Rails with [pay2go(智付寶)](https://www.pay2go.com/).
 
 It was inspired by [active_merchant_allpay](https://github.com/xwaynec/active_merchant_allpay).
 
-*WARNING:* This gem is not fully tested.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,23 +23,30 @@ $ bundle
 
 ## Setup
 
-1. I would suggest reading the [official API](https://www.pay2go.com/dw_files/info_api/pay2go_gateway_MPGapi_V1_1_4.pdf) first.
-
-2. Create file `config/initializers/pay2go.rb`
+- I would suggest reading the [official API](https://www.pay2go.com/dw_files/info_api/pay2go_gateway_MPGapi_V1_1_4.pdf) first.
 
+- Create file `config/initializers/pay2go.rb`
 ``` sh
 rails g pay2go:install
 ```
 
-3. Environment configuration:
+- Go to Pay2go and get your credential information. Then fill in `config/initializers/pay2go.rb`
+```rb
+OffsitePayments::Integrations::Pay2go.setup do |pay2go|
+  # You have to apply credential below by yourself.
+  pay2go.merchant_id = '123456'
+  pay2go.hash_key    = 'xxx'
+  pay2go.hash_iv     = 'yyy'
+end
+```
 
+- Environment configuration:
 ```rb
 # config/environments/development.rb
 config.after_initialize do
   ActiveMerchant::Billing::Base.mode = :development
 end
 ```
-
 ```rb
 # config/environments/production.rb
 config.after_initialize do
@@ -48,30 +56,32 @@ end
 
 ## Example
 
-```rb
+```
 <% payment_service_for  @order,
                         @order.user.email,
                         service: :pay2go,
                         html: { :id => 'pay2go-form', :method => :post } do |service| %>
-  <% service.encrypted_data %>
   <% service.time_stamp @order.created_at %>
   <% service.merchant_order_no @order.id %>
   <% service.amt @order.total_amount.to_i %>
   <% service.item_desc @order.description %>
   <% service.email @order.user.email %>
   <% service.login_type 0 %>
+  <% service.encrypted_data %>
   <%= submit_tag '付款' %>
 <% end %>
 ```
+This example code only fulfill the min requirements.
+
+To customize settings, you should read the documents.
+I put some comments in the [code](https://github.com/imgarylai/active_merchant_pay2go/blob/master/lib/offsite_payments/integrations/pay2go.rb) as well!
 
-To customize settings, you can read the documents.
-Or you can read [code](https://github.com/imgarylai/active_merchant_pay2go/blob/master/lib/offsite_payments/integrations/pay2go.rb#L47-L99) here!
+Here is an [example app](https://github.com/imgarylai/rails_active_merchant_pay2go) though it is really rough.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/imgarylai/active_merchant_pay2go. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/active_merchant_pay2go.gemspec

@@ -19,12 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activemerchant'
-  spec.add_dependency 'offsite_payments'
+  spec.add_dependency 'activemerchant', '~> 1.50'
+  spec.add_dependency 'offsite_payments', '~> 2'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'test-unit', '~> 3.0'
   spec.add_development_dependency 'rails', '>= 3.2.6', '< 5'
 
 end

data/lib/active_merchant_pay2go.rb

@@ -2,10 +2,13 @@ require 'action_view'
 require 'active_merchant_pay2go/version'
 require 'active_merchant'
 require 'offsite_payments'
+require 'active_support/core_ext/string'
+require 'uri'
 
 module OffsitePayments
   module Integrations
     autoload :Pay2go, 'offsite_payments/integrations/pay2go'
+    autoload :Pay2goPeriod, 'offsite_payments/integrations/pay2go_period'
   end
 end
 

data/lib/active_merchant_pay2go/version.rb

@@ -1,3 +1,3 @@
 module ActiveMerchantPay2go
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/generators/pay2go/install_generator.rb

@@ -10,6 +10,10 @@ module Pay2go
         template "pay2go.rb", "config/initializers/pay2go.rb"
       end
 
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
     end
   end
 end

data/lib/generators/pay2go/templates/README

@@ -0,0 +1,11 @@
+===============================================================================
+
+Please check and setup your  `config/initializers/pay2go.rb`
+
+    OffsitePayments::Integrations::Pay2go.setup do |pay2go|
+      pay2go.merchant_id =
+      pay2go.hash_key    =
+      pay2go.hash_iv     = 
+    end
+
+===============================================================================

data/lib/offsite_payments/integrations/pay2go.rb

@@ -7,20 +7,8 @@ module OffsitePayments #:nodoc:
 
       VERSION = '1.2'
       RESPOND_TYPE = 'String'
-      CHECK_VALUE_FIELDS = [
-        'Amt',
-        'MerchantID',
-        'MerchantOrderNo',
-        'TimeStamp',
-        'Version'
-      ]
-
-      CHECK_CODE_FIELDS = [
-        'Amt',
-        'MerchantID',
-        'MerchantOrderNo',
-        'TradeNo'
-      ]
+      CHECK_VALUE_FIELDS = %w(Amt MerchantID MerchantOrderNo TimeStamp Version)
+      CHECK_CODE_FIELDS = %w(Amt MerchantID MerchantOrderNo TradeNo)
 
       mattr_accessor :service_url
       mattr_accessor :merchant_id
@@ -51,58 +39,17 @@ module OffsitePayments #:nodoc:
       end
 
       class Helper < OffsitePayments::Helper
-        # 商店代號 *
-        mapping :merchant_id, 'MerchantID'
+        FIELDS = %w(
+          MerchantID LangType MerchantOrderNo Amt ItemDesc TradeLimit ExpireDate ReturnURL NotifyURL CustomerURL
+          ClientBackURL Email EmailModify LoginType OrderComment CREDIT CreditRed InstFlag UNIONPAY WEBATM VACC
+          CVS BARCODE CUSTOM TokenTerm
+        )
+
+        FIELDS.each do |field|
+          mapping field.underscore.to_sym, field
+        end
         mapping :account, 'MerchantID' # AM common
-        # 語系
-        mapping :lang_type, 'LangType'
-        # 廠商交易編號 *
-        mapping :merchant_order_no, 'MerchantOrderNo'
-        # 交易金額
-        mapping :amt, 'Amt'
         mapping :amount, 'Amt' # AM common
-        # 商品資訊 *
-        mapping :item_desc, 'ItemDesc'
-        # 交易限制秒數
-        mapping :trade_limit, 'TradeLimit'
-        # 繳費有效期限(適用於非即時交易))
-        mapping :expire_date, 'ExpireDate'
-        # 支付完成返回商店網址
-        mapping :return_url, 'ReturnURL'
-        # 支付通知網址
-        mapping :notify_url, 'NotifyURL'
-        # CustomerURL
-        mapping :customer_url, 'CustomerURL'
-        # Client 端返回廠商網址
-        mapping :client_back_url, 'ClientBackURL'
-        # 付款人電子信箱 *
-        mapping :email, 'Email'
-        # 付款人電子信箱是否開放修改
-        mapping :email_modify, 'EmailModify'
-        # 智付寶會員 *
-        mapping :login_type, 'LoginType'
-        # 商店備註
-        mapping :order_comment, 'OrderComment'
-        # 信用卡一次付清啟用
-        mapping :credit ,'CREDIT'
-        # 信用卡紅利啟用
-        mapping :credit_red, 'CreditRed'
-        # 信用卡分期付款啟用
-        mapping :inst_flag ,'InstFlag'
-        # 信用卡銀聯卡啟用
-        mapping :unionpay ,'UNIONPAY'
-        # WEBATM 啟用
-        mapping :webatm, 'WEBATM'
-        # ATM 轉帳啟用
-        mapping :vacc, 'VACC'
-        # 超商代碼繳費啟用
-        mapping :cvs, 'CVS'
-        # 條碼繳費啟用
-        mapping :barcode, 'BARCODE'
-        # 自訂支付啟用
-        mapping :custom, 'CUSTOM'
-        # 快速結帳 *
-        mapping :token_term, 'TokenTerm'
 
         def initialize(order, account, options = {})
           super
@@ -116,23 +63,30 @@ module OffsitePayments #:nodoc:
         end
 
         def encrypted_data
-          raw_data = OffsitePayments::Integrations::Pay2go::CHECK_VALUE_FIELDS.sort.map { |field|
-            "#{field}=#{@fields[field]}"
-          }.join('&')
+          raw_data = URI.encode_www_form OffsitePayments::Integrations::Pay2go::CHECK_VALUE_FIELDS.sort.map { |field|
+            [field, @fields[field]]
+          }
 
           hash_raw_data = "HashKey=#{OffsitePayments::Integrations::Pay2go.hash_key}&#{raw_data}&HashIV=#{OffsitePayments::Integrations::Pay2go.hash_iv}"
-
-          binding.pry if OffsitePayments::Integrations::Pay2go.debug
-
           add_field 'CheckValue', Digest::SHA256.hexdigest(hash_raw_data).upcase
         end
-
       end
 
       class Notification < OffsitePayments::Notification
+        PARAMS_FIELDS = %w(
+          Status Message MerchantID Amt TradeNo MerchantOrderNo PaymentType RespondType CheckCode PayTime IP
+          EscrowBank TokenUseStatus RespondCode Auth Card6No Card4No Inst InstFirst InstEach ECI PayBankCode
+          PayerAccount5Code CodeNo BankCode Barcode_1 Barcode_2 Barcode_3 ExpireDate CheckCode
+        )
+
+        PARAMS_FIELDS.each do |field|
+          define_method field.underscore do
+            @params[field]
+          end
+        end
 
         def success?
-          @params['Status'] == 'SUCCESS' ? true : false
+          status == 'SUCCESS'
         end
 
         # TODO 使用查詢功能實作 acknowledge
@@ -143,160 +97,17 @@ module OffsitePayments #:nodoc:
         end
 
         def complete?
-          case @params['Status']
-          when 'SUCCESS'
-            true
-          when 'CUSTOM'
-            true
-          else
-            false
-          end
+          %w(SUCCESS CUSTOM).include? status
         end
 
         def checksum_ok?
-          params_copy = @params.clone
-
-          checksum = params_copy['CheckCode']
-
-          raw_data = OffsitePayments::Integrations::Pay2go::CHECK_CODE_FIELDS.sort.map { |field|
-            "#{field}=#{params_copy[field]}"
-          }.join('&')
+          raw_data = URI.encode_www_form OffsitePayments::Integrations::Pay2go::CHECK_CODE_FIELDS.sort.map { |field|
+            [field, @params[field]]
+          }
 
           hash_raw_data = "HashIV=#{OffsitePayments::Integrations::Pay2go.hash_iv}&#{raw_data}&HashKey=#{OffsitePayments::Integrations::Pay2go.hash_key}"
-
-          Digest::SHA256.hexdigest(hash_raw_data).upcase == checksum
-        end
-
-        def status
-          @params['Status']
-        end
-
-        def message
-          @params['Message']
-        end
-
-        def merchant_id
-          @params['MerchantID']
-        end
-
-        def amt
-          @params['Amt']
-        end
-
-        def trade_no
-          @params['TradeNo']
-        end
-
-        def merchant_order_no
-          @params['MerchantOrderNo']
-        end
-
-        def payment_type
-          @params['PaymentType']
-        end
-
-        def respond_type
-          @params['RespondType']
-        end
-
-        def check_code
-          @params['CheckCode']
-        end
-
-        # 所有支付方式共同回傳參數
-
-        def pay_time
-          @params['PayTime']
-        end
-
-        def ip
-          @params['IP']
-        end
-
-        def escrow_bank
-          @params['EscrowBank']
-        end
-
-        def token_use_status
-          @params['TokenUseStatus']
+          Digest::SHA256.hexdigest(hash_raw_data).upcase == check_code
         end
-
-        # 信用卡支付回傳參數
-
-        def respond_code
-          @params['RespondCode']
-        end
-
-        def auth
-          @params['Auth']
-        end
-
-        def card_6_no
-          @params['Card6No']
-        end
-
-        def card_4_no
-          @params['Card4No']
-        end
-
-        def inst
-          @params['Inst']
-        end
-
-        def inst_first
-          @params['InstFirst']
-        end
-
-        def inst_each
-          @params['InstEach']
-        end
-
-        def eci
-          @params['ECI']
-        end
-
-        # WEBATM、ATM 繳費回傳參數
-
-        def pay_bank_code
-          @params['PayBankCode']
-        end
-
-        def payer_account_5_code
-          @params['PayerAccount5Code']
-        end
-
-        # 超商代碼繳費回傳參數
-
-        def code_no
-          @params['CodeNo']
-        end
-
-        # ATM 轉帳回傳參數
-        def bank_code
-          @params['BankCode']
-        end
-
-
-        # 條碼繳費回傳參數
-
-        def barcode_1
-          @params['Barcode_1']
-        end
-
-        def barcode_2
-          @params['Barcode_2']
-        end
-
-        def barcode_3
-          @params['Barcode_3']
-        end
-
-        # 取號完成系統回傳參數
-
-        def expire_date
-          @params['ExpireDate']
-        end
-
       end
     end
   end

data/lib/offsite_payments/integrations/pay2go_period.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require 'digest'
+
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Pay2goPeriod
+
+      VERSION = '1.0'
+      RESPOND_TYPE = 'String'
+      CHECK_VALUE_FIELDS = %w(PeriodAmt MerchantID MerchantOrderNo TimeStamp PeriodType)
+      CHECK_CODE_FIELDS = %w(PeriodType MerchantID MerchantOrderNo)
+
+      mattr_accessor :service_url
+      mattr_accessor :merchant_id
+      mattr_accessor :hash_key
+      mattr_accessor :hash_iv
+      mattr_accessor :debug
+
+      def self.service_url
+        mode = ActiveMerchant::Billing::Base.mode
+        case mode
+          when :production
+            'https://api.pay2go.com/API/PeriodAPI'
+          when :development
+            'https://capi.pay2go.com/API/PeriodAPI'
+          when :test
+            'https://capi.pay2go.com/API/PeriodAPI'
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+        end
+      end
+
+      def self.notification(post)
+        Notification.new(post)
+      end
+
+      def self.setup
+        yield(self)
+      end
+
+      class Helper < OffsitePayments::Helper
+        FIELDS = %w(
+          MerchantID MerchantOrderNo PeriodAmt ProdDesc PeriodAmtMode PeriodType PeriodPoint PeriodStartType
+          PeriodTimes ReturnURL ProDetail PeriodMemo PaymentInfo OrderInfo InvoiceInfo NotifyURL
+        )
+
+        FIELDS.each do |field|
+          mapping field.underscore.to_sym, field
+        end
+        mapping :account, 'MerchantID' # AM common
+
+        def initialize(order, account, options = {})
+          super
+          add_field 'MerchantID', OffsitePayments::Integrations::Pay2go.merchant_id
+          add_field 'Version', OffsitePayments::Integrations::Pay2goPeriod::VERSION
+          add_field 'RespondType', OffsitePayments::Integrations::Pay2goPeriod::RESPOND_TYPE
+        end
+
+        def time_stamp(date)
+          add_field 'TimeStamp', date.to_time.to_i
+        end
+
+        def encrypted_data
+          raw_data = URI.encode_www_form OffsitePayments::Integrations::Pay2goPeriod::CHECK_VALUE_FIELDS.sort.map { |field|
+            [field, @fields[field]]
+          }
+
+          hash_raw_data = "HashKey=#{OffsitePayments::Integrations::Pay2go.hash_key}&#{raw_data}&HashIV=#{OffsitePayments::Integrations::Pay2go.hash_iv}"
+          add_field 'CheckValue', Digest::SHA256.hexdigest(hash_raw_data).upcase
+        end
+
+      end
+
+      class Notification < OffsitePayments::Notification
+        PARAMS_FIELDS = %w(
+          Status Message MerchantID MerchantOrderNo PeriodType authDate authTime dateArray PeriodTotalAmt
+          PeriodFirstAmt PeriodAmt CheckCode
+        )
+
+        PARAMS_FIELDS.each do |field|
+          define_method field.underscore do
+            @params[field]
+          end
+        end
+
+        def success?
+          status == 'SUCCESS'
+        end
+
+        # TODO 使用查詢功能實作 acknowledge
+        # Pay2go 沒有遠端驗證功能，
+        # 而以 checksum_ok? 代替
+        def acknowledge
+          checksum_ok?
+        end
+
+        def complete?
+          %w(SUCCESS CUSTOM).include? status
+        end
+
+        def checksum_ok?
+          raw_data = URI.encode_www_form OffsitePayments::Integrations::Pay2goPeriod::CHECK_CODE_FIELDS.sort.map { |field|
+            [field, @params[field]]
+          }
+
+          hash_raw_data = "HashIV=#{OffsitePayments::Integrations::Pay2go.hash_iv}&#{raw_data}&HashKey=#{OffsitePayments::Integrations::Pay2go.hash_key}"
+          Digest::SHA256.hexdigest(hash_raw_data).upcase == check_code
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: active_merchant_pay2go
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gary
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemerchant
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: offsite_payments
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +106,10 @@ files:
 - lib/active_merchant_pay2go.rb
 - lib/active_merchant_pay2go/version.rb
 - lib/generators/pay2go/install_generator.rb
+- lib/generators/pay2go/templates/README
 - lib/generators/pay2go/templates/pay2go.rb
 - lib/offsite_payments/integrations/pay2go.rb
+- lib/offsite_payments/integrations/pay2go_period.rb
 homepage: https://github.com/imgarylai/active_merchant_pay2go
 licenses:
 - MIT
@@ -142,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: pay2go(智付寶) gem