focas-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 437b2a6a29fd61f69fce24a4c4e4f64de74db25597c14167fd3c024390e03718
+  data.tar.gz: 234ee05500b4d9a592abbb09e9ccade6c64acb34dc2484d3c8002a0020e37353
+SHA512:
+  metadata.gz: e080feab65aac91830754c283fdc952a7f2357763de5d39ac604dfcaffcdc7c6593d56c3affe25f0a1999ff38a4075e671577040c18d00016dee3a41d80963d4
+  data.tar.gz: 93f76018b8144b04276f3cfcce33d463a4cd497e844b0eb2128199f66aef20a42319b899f27da5be108933f654f1c09d09091fbd07d69ec9b7792b58d71eea55

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# vim
+*~
+*.swp
+.idea
+
+# 開發用
+rspec.sh
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1 @@
+## 0.1.0 (開發中)

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in focas-client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    focas-client (0.1.0)
+      activesupport (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.17.0)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  focas-client!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Daniel Lin (pct)
+
+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,55 @@
+# Focas::Client (開發中)
+
+`focas-client` 是串接財金資訊 金流 API 的 rails gem。
+
+目前狀態為`開發中`，請優先使用別的 focas 相關 gem 來達到您的需求(好像沒看到別的 gem...)
+
+## NOTICE: 目前僅支援信用卡，不支援銀聯卡
+
+## 測試用信用卡號
+- 請跟財金公司索取
+
+## 安裝
+Gemfile：
+```ruby
+gem 'focas-client'
+```
+
+執行：
+```bash
+$ bundle install
+```
+
+建立 `config/initializers/focas.rb`：
+
+```bash
+$ rails generate focas:install
+```
+
+設定 `config/initializers/focas.rb`：
+
+```yml
+- config.production_mode # 0: 開發環境 / 1: 正式站，預設為 0
+- config.marchant_id # 商店 ID
+- config.hash_key
+- config.hash_iv
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pct/focas-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "focas-client"
+
+# 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(__FILE__)

data/bin/setup

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

data/focas-client.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/focas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "focas-client"
+  spec.version       = Focas::VERSION
+  spec.authors       = ["Daniel Lin (pct)"]
+  spec.email         = ["pct@4point-inc.com"]
+
+  spec.summary       = %q{財金資訊 金流 focas-client (開發中，勿用)}
+  spec.description   = %q{財金資訊 金流 focas-client (開發中，勿用)}
+  spec.homepage      = "https://github.com/pct/focas-client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pct/focas-client"
+  spec.metadata["changelog_uri"] = "https://github.com/pct/focas-client/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # 相依套件
+  spec.add_runtime_dependency "activesupport", [">= 4.0"]
+end

data/lib/focas/config.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+# for mattr_accessor
+require 'active_support/core_ext/module/attribute_accessors'
+
+# for with_indifferent_access
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Focas
+
+  module Config
+    mattr_accessor :options
+    mattr_accessor :production_mode # 0/1，預設為 0，使用開發環境網址
+    mattr_accessor :api_base_url # 依據 production_mode 設定 api 網址
+
+    OPTIONS = %w[
+      merID
+      MerchantID
+      TerminalID
+      MerchantName
+      customize
+      lidm
+      purchAmt
+      CurrencyNote
+      AutoCap
+      AuthResURL
+      frontFailUrl
+      PayType
+      PeriodNum
+      LocalDate
+      LocalTime
+      reqToken
+      subMerchID
+      enCodeType
+      timeoutDate
+      timeoutTime
+      timeoutSecs
+      Currency
+      lagSelect
+      threeDSAuthInd
+    ].freeze
+
+    # 標 **[必] 為必填，另外 threeDSAuthInd 是 3DS 驗證，需要時就必填 
+    # TradeInfo 參數
+    MAPPING_TABLE = {
+      merID: 'mer_id', # **[必] 網站特店自訂代碼(請注意 merID 與 MerchantID 不同), number <= 10
+      MerchantID: 'merchant_id', # **[必] 收單銀行授權使用的特店代號(由收單銀行編製提供), number 固定 15
+      TerminalID: 'terminal_id', # **[必] 收單銀行授權使用的機台代號(由收單銀行編製提供), number 固定 8
+      MerchantName: 'merchant_name', # 特店名稱，僅供顯示
+      customize: 'customize', # **[必] 客製化付款授權網頁辨識碼(0: 不客製；1-8 有 8 種客製化樣式可選擇)
+      lidm: 'lidm', # * 交易訂單編號，建議訂單編號不可重複編號，且在 16 位以下最佳(如果是銀聯卡，則不能用 -、_ 符號)
+      purchAmt: 'purch_amt', # **[必] 新台幣整數(10 位數內)，如果是金融卡，最大交易為 200 萬
+      CurrencyNote: 'currency_note', # 註記說明，50 字內
+      AutoCap: 'auto_cap', # 是否自動轉入請款檔作業 (0: 預設不轉入 / 1: 自動轉入)
+      AuthResURL: 'auth_res_url', # 授權結果回傳網址，最多 512 位元組
+      frontFailUrl: 'front_fail_url', #  銀聯網路 UPOP 交易失敗，返回商戶跳轉網址
+      PayType: 'pay_type', # 交易類別碼 (0: 預設一般交易 / 1: 分期 / 2: 紅利)
+      PeriodNum: 'period_num', # 分期期數 (1-99)
+      LocalDate: 'local_date', # 購買地交易日期(yyyymmdd)(預設為系統日期)
+      LocalTime: 'local_time', # 購買地交易時間(HHMMSS) (預設為系統時間)
+      reqToken: 'req_token', # 交易驗證碼，最大長度 64 位
+      subMerchID: 'sub_merch_id', # 次特店代號，固定長度 8 位
+      enCodeType: 'encode_type', # *[必] 網頁編碼格式(預設為 BIG5)，所以必傳 "UTF-8"
+      timeoutDate: 'timeout_date', # 設定交易逾時日期(yyyymmdd)，固定長度 8 位
+      timeoutTime: 'timeout_time', # 設定交易逾時起始時間(HHMMSS)，固定長度 6 位
+      timeoutSecs: 'timeout_secs', # 設定交易逾時秒數，固定長度 3 位 (最大值為 600 秒)
+      Currency: 'currency', # 交易幣別，固定長度 3 位 (901)
+      lagSelect: 'lag_select', # 語言選擇，固定長度 1 位 (0: 繁 / 1: 簡 / 2: 英 / 3: 日 )
+      threeDSAuthInd: 'three_ds_auth_ind', # 3D 交易驗證類型，若該特店設定支援 3D 交易，前端未帶此欄位，則預設為 0101 (0101 表示支付類交易驗證(PA)的 Payment transaction。 0204 表示非支付類交易驗證(NPA)的 Add card。0205 表示非支付類交易驗證(NPA)的 Maintain card。 註:綁卡驗證應使用 0204 或 0205)
+    }.freeze
+
+    self.options = {}.with_indifferent_access
+
+    OPTIONS.each do |option|
+      transfer_option = MAPPING_TABLE[:"#{option}"]
+      define_method("#{transfer_option}=") do |value|
+        options[option] = value
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def api_base_url
+      self.production_mode ||= 0
+      self.api_base_url = self.production_mode == 0 ? 
+        'https://www.focas-test.fisc.com.tw' : 
+        'https://www.focas.fisc.com.tw'
+    end
+
+    def get_payment_url
+      "#{self.api_base_url}/FOCAS_WEBPOS/online/"
+    end
+
+    def create_lidm
+      lidm = "#{Time.now.strftime("%Y%m%d%H%M%S")}_#{SecureRandom.hex(2).upcase}"
+    end
+  end
+end

data/lib/focas/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Focas
+  class PaymentArgumentError < StandardError; end
+  class ConfigError < StandardError; end
+end

data/lib/focas/payment.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require_relative 'config'
+require_relative 'errors'
+
+module Focas
+  class Payment
+    attr_accessor :trade_info
+    attr_reader :response
+
+    def initialize(
+      # 必填參數
+      lidm: nil,
+      purch_amt: nil,
+
+      # 參數
+      currency_note: '訂單金額說明',
+
+      # 客製回傳網址(同一個站有不同接收的 route 時使用)
+      auth_res_url: nil
+    )
+      unless lidm && purch_amt
+        raise Focas::PaymentArgumentError,
+          '請確認以下參數皆有填寫:
+          - lidm 訂單編號
+          - purch_amt 金額
+        '
+      end
+
+      @lidm = lidm
+      @purch_amt = purch_amt
+      @currency_note = currency_note
+
+      # 回傳網址
+      @auth_res_url = auth_res_url
+
+      set_trade_info
+    end
+
+    def success?
+      return if @response.nil?
+      @response['Status'] == 'SUCCESS'
+    end
+
+    def gen_payment_params
+      {
+        merID: Config.options[:merID], # merID (統一編號)
+        MerchantID: Config.options[:MerchantID], # 商店 ID
+        TerminalID: Config.options[:TerminalID], # 終端機
+      }
+    end
+
+    private
+
+    def set_trade_info
+      options = Config.options
+      @trade_info = options.transform_keys(&:to_sym)
+
+      individual_trade_info = {
+        lidm: @lidm, # 商店訂單編號，如：用途_日期時間戳記_流水號
+        purchAmt: @purch_amt.to_i, # 訂單金額
+        CurrencyNote: @currency_note, # 商品資訊
+        # 回傳網址
+        AuthResURL: @auth_res_url,
+      }
+
+      @trade_info.merge!(individual_trade_info)
+    end
+  end
+end

data/lib/focas/query_trade_info.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require_relative 'config'
+require_relative 'errors'
+
+module Focas
+  class QueryTradeInfo
+    attr_accessor :trade_info
+    attr_reader :response
+
+    def initialize(
+      lidm: nil,
+      purch_amt: nil,
+      res_url: nil
+    )
+      unless lidm && purch_amt
+        raise Focas::PaymentArgumentError,
+          '請確認以下參數皆有填寫:
+          - lidm
+          - purch_amt
+          '
+      end
+
+      @lidm = lidm
+      @purch_amt = purch_amt
+      @res_url = res_url
+      @xid = xid
+
+      set_trade_info
+      set_check_value
+    end
+
+    def request!
+      uri = URI("#{Config.api_base_url}/FOCAS_WEBPOS/orderInquery/")
+
+      res = Net::HTTP.post_form(uri,
+        merID: Config.options[:merID], 
+        MerchantID: Config.options[:MerchantID],
+        TerminalID: Config.options[:TerminalID],
+        lidm: @lidm,
+        purchAmt: @purch_amt,
+        ResURL: @res_url,
+        xid: @xid
+      )
+
+      @response = JSON.parse(res.body)
+    end
+
+    def success?
+      return if @response.nil?
+
+      @response['Status'] == 'SUCCESS'
+    end
+
+    private
+
+  end
+end

data/lib/focas/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Focas
+  VERSION = '0.1.0'
+end

data/lib/focas-client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'focas/config'
+require 'focas/version'
+require 'focas/payment'
+require 'focas/query_trade_info'
+require 'focas/errors'
+
+module Focas
+  extend Config
+end

data/lib/generators/focas/helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Focas
+  module Generators
+    module Helpers
+      private
+
+      def focas_config_path
+        'config/initializers/focas.rb'
+      end
+    end
+  end
+end

data/lib/generators/focas/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'generators/focas/helpers'
+require 'rails/generators/base'
+
+module Focas
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Focas::Generators::Helpers
+
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer_file
+        template 'initializer.rb', focas_config_path
+      end
+    end
+  end
+end

data/lib/generators/focas/templates/initializer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+focas.configure do |config|
+  # ========
+  # 必要參數
+  # ========
+
+  # (0/1 使用財金資訊 正式站與否，預設為 0 測試站)
+  config.production_mode = 0
+
+  # **[必] 網站特店自訂代碼(請注意 merID 與 MerchantID 不同), number <= 10 (通常是統編)
+  config.mer_id = ''
+
+  # **[必] 收單銀行授權使用的特店代號(由收單銀行編製提供), number 固定 15
+  config.merchant_id = '' 
+
+  # **[必] 收單銀行授權使用的機台代號(由收單銀行編製提供), number 固定 8
+  config.terminal_id = ''
+  
+  # 特店名稱，僅供顯示
+  config.merchant_name = ''
+
+  # **[必] 客製化付款授權網頁辨識碼(0: 預設不客製 / 1-8: 樣式1-8)
+  config.customize = 1
+
+  # ========
+  # 其他參數
+  # ========
+  # 是否自動轉入請款檔作業 (0: 不自動轉入 / 1: 自動轉入)
+  config.auto_cap = 1
+  
+  # 授權結果回傳網址，最多 512 位元組
+  #config.callback_url = ''
+  
+  #  銀聯網路 UPOP 交易失敗，返回商戶跳轉網址
+  #config.front_fail_url = ''
+  
+  # 交易類別碼 (0: 一般交易(預設) / 1: 分期交易 / 2: 紅利交易)
+  #config.pay_type = 0
+  
+  # 分期期數 (1-99)
+  #config.period_num = 1
+  
+  # 次特店代號，固定長度 8 位
+  #config.sub_merch_id = '00000000'
+  
+  # *[必] 網頁編碼格式(預設為 BIG5)，所以必傳 "UTF-8"
+  config.encode_type = 'UTF-8'
+  
+  # 設定交易逾時秒數，固定長度 3 位 (最大值為 600 秒)
+  config.timeout_secs = 600
+  
+  # 交易幣別，固定長度 3 位 (901)
+  config.currency = 901
+  
+  # 語言選擇，固定長度 1 位 (0: 繁 / 1: 簡 / 2: 英 / 3: 日)
+  #config.lag_select = 0
+  
+  # 3D 交易驗證類型，若該特店設定支援 3D 交易，前端未帶此欄位，則預設為 0101 (0101 表示支付類交易驗證(PA)的 Payment transaction。 0204 表示非支付類交易驗證(NPA)的 Add card。0205 表示非支付類交易驗證(NPA)的 Maintain card。 
+  #config.three_ds_auth_ind = '0101'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: focas-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Lin (pct)
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 財金資訊 金流 focas-client (開發中，勿用)
+email:
+- pct@4point-inc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- focas-client.gemspec
+- lib/focas-client.rb
+- lib/focas/config.rb
+- lib/focas/errors.rb
+- lib/focas/payment.rb
+- lib/focas/query_trade_info.rb
+- lib/focas/version.rb
+- lib/generators/focas/helpers.rb
+- lib/generators/focas/install_generator.rb
+- lib/generators/focas/templates/initializer.rb
+homepage: https://github.com/pct/focas-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pct/focas-client
+  source_code_uri: https://github.com/pct/focas-client
+  changelog_uri: https://github.com/pct/focas-client/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: 財金資訊 金流 focas-client (開發中，勿用)
+test_files: []