hncb_e_atm 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTg2MGJiY2YyNzQ0MjVhMmRiMjAyOTk2OWVmZTI2YmE4MTI5NGUyNw==
+  data.tar.gz: !binary |-
+    MGNhMGJjN2IyNmU4YjkzNDk5MzliZjA4ODVlNzljOWUwOTgxYWRiZg==
+SHA512:
+  metadata.gz: !binary |-
+    MzU4Yzk0MTAzNDU4NDU2ZmFmMWY3ZGRkY2M1Y2E5YjYzYWU0MGE3ZWM4NTQw
+    MWZmOGQzYjI0MTA1ZDE1ZGI1OGEyZjJhMzU5ZGI4MWVhMjcxZTNjYzE1MjU3
+    YTU5YWZiOTY4YjNkZjZkZjJkNmI1MjQ2MjcxZDM1NDUzYzU4NTM=
+  data.tar.gz: !binary |-
+    MzFiOTU2ZGViNmZiOWRhMTc5MDkzYjA1OTQ2ZWFmNGM5YWQzMWY4N2VkNzhi
+    YWU4ZjY5NTFlMmM2OWM0YTE4ZGJlZWU4MWJmZmYwMTI0OTRlZmYwOWNlYWIy
+    NmMyOWY3ODBkZTY4Mzk1ZGM0MzRiYjZlNzY5NmQzZWI0NjJiM2Q=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swo
+*.swp
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@hncb_e_atm --create

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hncb_e_atm.gemspec
+gemspec
+
+gem 'actionpack'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hao Liu
+
+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,91 @@
+# HncbEAtm
+
+A simple Hncb Eatm ruby gem, without unnecessary magic or wraper, it's directly facing how Hncb Eatm api works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hncb_e_atm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hncb_e_atm
+
+And then execute:
+
+    $ rails g hncb_e_atm:install
+
+## Usage
+
+### Generate payment url
+you have two selections
+
+1. generator url directly
+```ruby
+      options = {
+        StoreID: "008757080070001ABCD1310",
+        StoreAcnt: "100200000025",
+        StoreTxDate: "2005-11-10",
+        OrderNumber: "00001",
+        Amount: "10",
+        StoreName: "博客來網絡書店",
+        StoreURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_01.jsp",
+        SuccessURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_03OK.jsp",
+        FailURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_03NOK.jsp"
+      }
+        HncbEAtm::Service.create_trade(@options)
+       # => "https://www.smartatm.com.tw/eatm/servlet/TrxDispatcher?trx=com.eatm.wibc.trx.web.EAtmWShopping&state=prompt&val=...&mac=..."
+```
+You can redirect user to this payment url, and user will see a payment page for his/her order. NOTICE: use HTTP POST method
+
+2. generate a form
+```ruby
+      options = {
+        StoreID: "008757080070001ABCD1310",
+        StoreAcnt: "100200000025",
+        StoreTxDate: "2005-11-10",
+        OrderNumber: "00001",
+        Amount: "10",
+        StoreName: "博客來網絡書店",
+        StoreURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_01.jsp",
+        SuccessURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_03OK.jsp",
+        FailURL: "http://10.8.61.71:8080/mctmk/eatm/Shopping_03NOK.jsp"
+      }
+        HncbEAtm::Service.create_trade(@options)
+        hncb_e_atm_form_for(@options) do
+        "<input>Other</input>" #option
+        end
+       # => "<form action=..."
+```
+
+###callback
+in the callback controller
+```ruby
+HncbEAtm::Notify.parse params
+# => {
+        'StoreID' => "...",
+        'StoreAcnt' => "...",
+        'StoreTxDate' => "...",
+        'OrderNumber' => "...",
+        'Amount' => "...",
+        'StoreName' => "...",
+        'StoreURL' => "...",
+        'SuccessURL' => "...",
+        'FailURL' => "..."
+      }
+ #     or  => nil
+```
+###
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--color"
+end

data/hncb_e_atm.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hncb_e_atm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hncb_e_atm"
+  spec.version       = HncbEAtm::VERSION
+  spec.authors       = ["Hao Liu"]
+  spec.email         = ["leomayleomay@gmail.com"]
+  spec.description   = %q{eATM interface for 華南銀行(HNCB)}
+  spec.summary       = %q{eATM interface for 華南銀行(HNCB)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "debugger"
+end

data/lib/generators/hncb_e_atm/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module HncbEAtm
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "HncbEAtm installation generator"
+    def install
+      template "config.yml", "config/hncb_e_atm.yml"
+      puts "HncbEAtm is installed."
+    end
+  end
+end

data/lib/generators/hncb_e_atm/templates/config.yml

@@ -0,0 +1,20 @@
+test:
+  store_id: "008757080070001ABCD1310"
+  store_account: "100200000025"
+  store_name: "博客來網絡書店"
+  store_url: "http://10.8.61.71:8080/mctmk/eatm/Shopping_01.jsp"
+  debug: true
+
+development:
+  store_id: "008757080070001ABCD1310"
+  store_account: "100200000025"
+  store_name: "博客來網絡書店"
+  store_url: "http://10.8.61.71:8080/mctmk/eatm/Shopping_01.jsp"
+  debug: true
+
+production:
+  store_id: ""
+  store_account: ""
+  store_name: ""
+  store_url: ""
+  debug: false

data/lib/hncb_e_atm/form.rb

@@ -0,0 +1,43 @@
+module HncbEAtm
+  class Form
+    REQUIRED_FIELDS = [
+      "store_id",
+      "store_account",
+      "store_transaction_date",
+      "order_number",
+      "amount",
+      "store_name",
+      "store_url",
+      "success_url",
+      "fail_url"
+    ]
+
+    def initialize(params)
+      @params = HncbEAtm::Utils.stringfy_keys(params)
+
+      REQUIRED_FIELDS.each do |field|
+        next if @params.keys.include?(field) &&
+          @params.fetch(field).to_s.length > 0
+
+        raise ArgumentError.new("#{field} is a required field")
+      end
+    end
+
+    def serialize
+      {
+        "StoreID"     => @params["store_id"] || HncbEAtm.store_id,
+        "StoreAcnt"   => @params['store_account'] || HncbEAtm.store_account,
+        "StoreTxDate" => @params['store_transaction_date'],
+        "OrderNumber" => @params['order_number'],
+        "Amount"      => @params['amount'],
+        "StoreName"   => @params['store_name'] || HncbEAtm.store_name,
+        "StoreURL"    => @params['store_url'] || HncbEAtm.store_url,
+        "SuccessURL"  => @params['success_url'],
+        "FailURL"     => @params['fail_url']
+      }.inject([]) do |fields, (key, value)|
+        fields << "#{key.to_s}=#{value.to_s}"
+        fields
+      end.join("&")
+    end
+  end
+end

data/lib/hncb_e_atm/railtie.rb

@@ -0,0 +1,18 @@
+module HncbEAtm
+  class Railtie < Rails::Railtie
+    initializer "hncb_e_atm.setup" do
+      ActionView::Base.send :include, HncbEAtm::ViewHelpers
+
+      config_file = Rails.root.join("config/hncb_e_atm.yml")
+      if config_file.file?
+        config = YAML.load_file(config_file)[Rails.env].freeze
+
+        HncbEAtm.store_id      = config["store_id"]
+        HncbEAtm.store_account = config["store_account"]
+        HncbEAtm.store_name    = config["store_name"]
+        HncbEAtm.store_url     = config["store_url"]
+        HncbEAtm.debug         = config["debug"]
+      end
+    end
+  end
+end

data/lib/hncb_e_atm/utils.rb

@@ -0,0 +1,10 @@
+module HncbEAtm
+  module Utils
+    def self.stringfy_keys(hash)
+      hash.inject({}) do |result, (key, value)|
+        result[key.to_s] = value
+        result
+      end
+    end
+  end
+end

data/lib/hncb_e_atm/version.rb

@@ -0,0 +1,3 @@
+module HncbEAtm
+  VERSION = "0.0.2"
+end

data/lib/hncb_e_atm/view_helpers.rb

@@ -0,0 +1,31 @@
+require 'action_view'
+require 'base64'
+
+module HncbEAtm
+  module ViewHelpers
+    include ::ActionView::Helpers
+    include ::ActionView::Context
+
+    def hncb_e_atm_form_for(params, &block)
+      query_string = HncbEAtm::Form.new(params).serialize
+      val = Base64.encode64(query_string)
+      mac = Digest::SHA1.hexdigest(query_string).upcase
+
+      html_form = []
+
+      html_form << "<form action='"+HncbEAtm.endpoint+"' method='post'>"
+      html_form << "<input type='hidden' name='trx' value='com.eatm.wibc.trx.web.EAtmWShopping'>"
+      html_form << "<input type='hidden' name='state' value='prompt'>"
+      html_form << "<input type='hidden' name='val' value='#{val}'>"
+      html_form << "<input type='hidden' name='mac' value='#{mac}'>"
+      html_form << capture(&block) if block_given?
+      html_form << "</form>"
+
+      html_form = html_form.join("\n")
+
+      concat(html_form.respond_to?(:html_safe) ? html_form.html_safe : html_form)
+
+      nil
+    end
+  end
+end

data/lib/hncb_e_atm.rb

@@ -0,0 +1,37 @@
+require "hncb_e_atm/version"
+require "hncb_e_atm/utils"
+require "hncb_e_atm/view_helpers"
+require "hncb_e_atm/form"
+
+if defined?(Rails)
+  require 'hncb_e_atm/railtie'
+  require 'generators/hncb_e_atm/install_generator'
+end
+
+module HncbEAtm
+  GATEWAY_ENDPOINT = "https://www.smartatm.com.tw/eatm/servlet/TrxDispatcher"
+  SANDBOX_ENDPOINT = "https://210.65.217.216/eatm/servlet/TrxDispatcher"
+
+  class << self
+    attr_accessor :endpoint
+    attr_accessor :store_id
+    attr_accessor :store_account
+    attr_accessor :store_name
+    attr_accessor :store_url
+    attr_accessor :debug
+
+    def debug=(d)
+      @@debug = d
+
+      if @@debug
+        @@endpoint = SANDBOX_ENDPOINT
+      else
+        @@endpoint = GATEWAY_ENDPOINT
+      end
+    end
+
+    def endpoint
+      @@endpoint ||= SANDBOX_ENDPOINT
+    end
+  end
+end

data/spec/lib/hncb_e_atm/form_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../../../lib/hncb_e_atm/form', File.dirname(__FILE__))
+
+describe HncbEAtm::Form do
+  before do
+    @params = {
+      :store_id => "1",
+      :store_account => "2",
+      :store_transaction_date => Date.today,
+      :order_number => "3",
+      :amount => 12.44,
+      :store_name => "xinqianbi",
+      :store_url => "http://sandbox.xinqianbi.com",
+      :success_url => "http://sandbox.xinqianbi.com/transactions/succeed",
+      :fail_url => "http://sandbox.xinqianbi.com/transactions/fail"
+    }
+  end
+
+  HncbEAtm::Form::REQUIRED_FIELDS.each do |field|
+    it "should validate the presence of #{field}" do
+      @params.delete(field.to_sym)
+
+      lambda do
+        HncbEAtm::Form.new(@params)
+      end.should raise_error(ArgumentError, "#{field} is a required field")
+    end
+  end
+
+  describe "#serialize" do
+    it "should serialize the fields for the form" do
+      form = HncbEAtm::Form.new(@params)
+
+      form.serialize.should == "StoreID=1&StoreAcnt=2&StoreTxDate=#{Date.today.strftime("%Y-%m-%d")}&\
+OrderNumber=3&Amount=12.44&StoreName=xinqianbi&\
+StoreURL=http://sandbox.xinqianbi.com&\
+SuccessURL=http://sandbox.xinqianbi.com/transactions/succeed&\
+FailURL=http://sandbox.xinqianbi.com/transactions/fail"
+    end
+  end
+end

data/spec/lib/hncb_e_atm/view_helpers_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require File.expand_path('../../../lib/hncb_e_atm', File.dirname(__FILE__))
+require File.expand_path('../../../lib/hncb_e_atm/view_helpers', File.dirname(__FILE__))
+
+describe HncbEAtm::ViewHelpers do
+  include HncbEAtm::ViewHelpers
+
+  before do
+    self.output_buffer = ""
+  end
+
+  describe "#hncb_e_atm_form_for" do
+    let (:params) {
+      {
+        :store_id => "008757080070001ABCD1310",
+        :store_account => "100200000025",
+        :store_transaction_date => "2005-11-10",
+        :order_number => "00001",
+        :amount => "10",
+        :store_name => "博客來網絡書店",
+        :store_url => "http://10.8.61.71:8080/mctmk/eatm/Shopping_01.jsp",
+        :success_url => "http://10.8.61.71:8080/mctmk/eatm/Shopping_03OK.jsp",
+        :fail_url => "http://10.8.61.71:8080/mctmk/eatm/Shopping_03NOK.jsp"
+      }
+    }
+
+    before do
+      HncbEAtm.debug = true
+    end
+
+    it "should generate a HTML form for the given parameters" do
+      expected_output = <<-FORM
+<form action='https://210.65.217.216/eatm/servlet/TrxDispatcher' method='post'>
+<input type='hidden' name='trx' value='com.eatm.wibc.trx.web.EAtmWShopping'>
+<input type='hidden' name='state' value='prompt'>
+<input type='hidden' name='val' value='U3RvcmVJRD0wMDg3NTcwODAwNzAwMDFBQkNEMTMxMCZTdG9yZUFjbnQ9MTAw\nMjAwMDAwMDI1JlN0b3JlVHhEYXRlPTIwMDUtMTEtMTAmT3JkZXJOdW1iZXI9\nMDAwMDEmQW1vdW50PTEwJlN0b3JlTmFtZT3ljZrlrqLkvobntrLntaHmm7jl\nupcmU3RvcmVVUkw9aHR0cDovLzEwLjguNjEuNzE6ODA4MC9tY3Rtay9lYXRt\nL1Nob3BwaW5nXzAxLmpzcCZTdWNjZXNzVVJMPWh0dHA6Ly8xMC44LjYxLjcx\nOjgwODAvbWN0bWsvZWF0bS9TaG9wcGluZ18wM09LLmpzcCZGYWlsVVJMPWh0\ndHA6Ly8xMC44LjYxLjcxOjgwODAvbWN0bWsvZWF0bS9TaG9wcGluZ18wM05P\nSy5qc3A=\n'>
+<input type='hidden' name='mac' value='8E446B831D90EF4DC429DAA5FD82979580B53DAD'>
+&lt;%= submit_tag &#x27;Pay Now!&#x27; %&gt;
+</form>
+      FORM
+
+      hncb_e_atm_form_for(params) do
+        "<%= submit_tag 'Pay Now!' %>"
+      end
+
+
+      self.output_buffer.should == expected_output.strip
+    end
+  end
+end

data/spec/lib/hncb_e_atm_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../../lib/hncb_e_atm", File.dirname(__FILE__))
+
+describe HncbEAtm do
+  describe "#debug=" do
+    it "should set the API endpoint to SANDBOX_ENDPOINT if it's debug mode" do
+      HncbEAtm.endpoint = HncbEAtm::GATEWAY_ENDPOINT
+
+      HncbEAtm.debug = true
+
+      HncbEAtm.endpoint.should == HncbEAtm::SANDBOX_ENDPOINT
+    end
+
+    it "should set the API endpoint to GATEWAY_ENDPOINT if it's not debug mode" do
+      HncbEAtm.endpoint = HncbEAtm::SANDBOX_ENDPOINT
+
+      HncbEAtm.debug = false
+
+      HncbEAtm.endpoint.should == HncbEAtm::GATEWAY_ENDPOINT
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: hncb_e_atm
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Hao Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: eATM interface for 華南銀行(HNCB)
+email:
+- leomayleomay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hncb_e_atm.gemspec
+- lib/generators/hncb_e_atm/install_generator.rb
+- lib/generators/hncb_e_atm/templates/config.yml
+- lib/hncb_e_atm.rb
+- lib/hncb_e_atm/form.rb
+- lib/hncb_e_atm/railtie.rb
+- lib/hncb_e_atm/utils.rb
+- lib/hncb_e_atm/version.rb
+- lib/hncb_e_atm/view_helpers.rb
+- spec/lib/hncb_e_atm/form_spec.rb
+- spec/lib/hncb_e_atm/view_helpers_spec.rb
+- spec/lib/hncb_e_atm_spec.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.1.3
+signing_key: 
+specification_version: 4
+summary: eATM interface for 華南銀行(HNCB)
+test_files:
+- spec/lib/hncb_e_atm/form_spec.rb
+- spec/lib/hncb_e_atm/view_helpers_spec.rb
+- spec/lib/hncb_e_atm_spec.rb