active_merchant_spgateway 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa4fa4a378b04baaa61715b3c66067ac0569250
+  data.tar.gz: a538e54742a87b6f4b90488912ebb5879c996440
+SHA512:
+  metadata.gz: e906aac724c8dafa9ebc3203a219e7d0c52750ec8d38123f0ee2f11aa25f61a83d66065104731e0c60fc8a491ece0c95fc417cea848fc453537e5bf7d9f0da77
+  data.tar.gz: c2a7f3d6eeae50f74d07ae418f3eeb821283b57f20c4817a008251821883c4db55b1d3804f118ce7688286ea3d9971d081225356b4716cc466b9bf0862c6e92c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/tmp/*
+*.gem
+coverage

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_merchant_spgateway.gemspec
+gemspec
+
+group 'test' do
+  gem 'simplecov', require: false
+  gem 'minitest-reporters', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gary
+
+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,70 @@
+# ActiveMerchantSpgateway
+
+This gem integrate Rails with [spgateway(智付通)](https://www.spgateway.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_merchant_spgateway', github: 'afunction/active_merchant_spgateway'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Setup
+
+- Create file `config/initializers/spgateway.rb`
+``` sh
+rails g spgateway:install
+```
+
+- Go to spgateway and get your credential information. Then fill in `config/initializers/spgateway.rb`
+```rb
+OffsitePayments::Integrations::Spgateway.setup do |spgateway|
+  # You have to apply credential below by yourself.
+  spgateway.merchant_id = '123456'
+  spgateway.hash_key    = 'xxx'
+  spgateway.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
+  ActiveMerchant::Billing::Base.mode = :production
+end
+```
+
+## Example
+
+```
+<% payment_service_for  @order,
+                        @order.user.email,
+                        service: :spgateway,
+                        html: { :id => 'spgateway-form', :method => :post } do |service| %>
+  <% 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 %>
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+desc "Run the unit test suite"
+task :default => 'test:units'
+
+task :test => 'test:units'
+
+namespace :test do
+
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+end

data/active_merchant_spgateway.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_merchant_spgateway/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_merchant_spgateway"
+  spec.version       = ActiveMerchantSpgateway::VERSION
+  spec.authors       = ["Gary"]
+  spec.email         = ["me@adz.cool"]
+
+  spec.summary       = %q{spgateway (智付通) gem}
+  spec.description   = %q{This gem integrate Rails with spgateway (智付通).}
+  spec.homepage      = "https://github.com/imgarylai/active_merchant_spgateway"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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 'rails', '>= 3.2.6', '< 5'
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_merchant_spgateway"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_merchant_spgateway.rb

@@ -0,0 +1,14 @@
+require 'action_view'
+require 'active_merchant_spgateway/version'
+require 'active_merchant'
+require 'offsite_payments'
+require 'active_support/core_ext/string'
+require 'uri'
+
+module OffsitePayments
+  module Integrations
+    autoload :Spgateway, 'offsite_payments/integrations/spgateway'
+  end
+end
+
+ActionView::Base.send(:include, OffsitePayments::ActionViewHelper)

data/lib/active_merchant_spgateway/version.rb

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

data/lib/generators/spgateway/install_generator.rb

@@ -0,0 +1,19 @@
+module Spgateway
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates a spgateway initialize"
+      class_option :orm
+
+      def copy_initializer
+        template "spgateway.rb", "config/initializers/spgateway.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+    end
+  end
+end

data/lib/generators/spgateway/templates/README

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

data/lib/generators/spgateway/templates/spgateway.rb

@@ -0,0 +1,6 @@
+OffsitePayments::Integrations::Spgateway.setup do |spgateway|
+  # You have to apply credential below by yourself.
+  spgateway.merchant_id = ''
+  spgateway.hash_key    = ''
+  spgateway.hash_iv     = ''
+end

data/lib/offsite_payments/integrations/spgateway.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'digest'
+require File.dirname(__FILE__) + '/spgateway/helper.rb'
+require File.dirname(__FILE__) + '/spgateway/notification.rb'
+
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Spgateway
+
+      VERSION = '1.2'
+      RESPOND_TYPE = 'String'
+      CHECK_VALUE_FIELDS = %w(Amt MerchantID MerchantOrderNo TimeStamp Version)
+      CHECK_CODE_FIELDS = %w(Amt MerchantID MerchantOrderNo TradeNo)
+
+      CONFIG = %w(
+        MerchantID LangType TradeLimit ExpireDate NotifyURL EmailModify LoginType
+      )
+
+      mattr_accessor :service_url
+      mattr_accessor :hash_key
+      mattr_accessor :hash_iv
+      mattr_accessor :debug
+
+      CONFIG.each do |field|
+        mattr_accessor field.underscore.to_sym
+      end
+
+      def self.service_url
+        mode = ActiveMerchant::Billing::Base.mode
+        case mode
+          when :production
+            'https://core.spgateway.com/MPG/mpg_gateway'
+          when :development
+            'https://ccore.spgateway.com/MPG/mpg_gateway'
+          when :test
+            'https://ccore.spgateway.com/MPG/mpg_gateway'
+          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
+
+    end
+  end
+end

data/lib/offsite_payments/integrations/spgateway/helper.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'digest'
+
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Spgateway
+      class Helper < OffsitePayments::Helper
+        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 :amount, 'Amt' # AM common
+
+        # 廠商編號(由 allpay 提供)
+        # type: Varchar(10)
+        # presense: true
+        # example: 2000132
+        # description:
+        # mapping :merchant_id, 'MerchantID'
+        # mapping :account, 'MerchantID' # AM common
+
+        def initialize(order, account, options = {})
+          super
+          add_field 'Version', OffsitePayments::Integrations::Spgateway::VERSION
+          add_field 'RespondType', OffsitePayments::Integrations::Spgateway::RESPOND_TYPE
+          OffsitePayments::Integrations::Spgateway::CONFIG.each do |field|
+            add_field field, OffsitePayments::Integrations::Spgateway.send(field.underscore.to_sym)
+          end
+        end
+
+        def hash_key(key)
+          @key = key
+        end
+
+        def hash_iv(iv)
+          @iv = iv
+        end
+
+        def merchant_hash_key
+          @key || OffsitePayments::Integrations::Spgateway.hash_key
+        end
+
+        def merchant_hash_iv
+          @iv || OffsitePayments::Integrations::Spgateway.hash_iv
+        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::Spgateway::CHECK_VALUE_FIELDS.sort.map { |field|
+            [field, @fields[field]]
+          }
+
+          hash_raw_data = "HashKey=#{merchant_hash_key}&#{raw_data}&HashIV=#{merchant_hash_iv}"
+          add_field 'CheckValue', Digest::SHA256.hexdigest(hash_raw_data).upcase
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/spgateway/notification.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require 'digest'
+
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Spgateway
+      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 hash_key=(key)
+          @hash_key = key
+        end
+
+        def hash_iv=(iv)
+          @hash_iv = iv
+        end
+
+        def hash_key
+          @hash_key || OffsitePayments::Integrations::Spgateway.hash_key
+        end
+
+        def hash_iv
+          @hash_iv || OffsitePayments::Integrations::Spgateway.hash_iv
+        end
+
+        def success?
+          status == 'SUCCESS'
+        end
+
+        # TODO 使用查詢功能實作 acknowledge
+        # Spgateway 沒有遠端驗證功能，
+        # 而以 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::Spgateway::CHECK_CODE_FIELDS.sort.map { |field|
+            [field, @params[field]]
+          }
+
+          hash_raw_data = "HashIV=#{hash_iv}&#{raw_data}&HashKey=#{hash_key}"
+          Digest::SHA256.hexdigest(hash_raw_data).upcase == check_code
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: active_merchant_spgateway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: offsite_payments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This gem integrate Rails with spgateway (智付通).
+email:
+- me@adz.cool
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_merchant_spgateway.gemspec
+- bin/console
+- bin/setup
+- lib/active_merchant_spgateway.rb
+- lib/active_merchant_spgateway/version.rb
+- lib/generators/spgateway/install_generator.rb
+- lib/generators/spgateway/templates/README
+- lib/generators/spgateway/templates/spgateway.rb
+- lib/offsite_payments/integrations/spgateway.rb
+- lib/offsite_payments/integrations/spgateway/helper.rb
+- lib/offsite_payments/integrations/spgateway/notification.rb
+homepage: https://github.com/imgarylai/active_merchant_spgateway
+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.8
+signing_key: 
+specification_version: 4
+summary: spgateway (智付通) gem
+test_files: []