ezpay-invoice 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec555b48c041b0df2d4a9907a5e6e737773963ac930c167200b25f76840e9539
+  data.tar.gz: 95972e938fd6ad07a0e1ea1c4f7b1dd3672e251f958650abdd6392e27689a49e
+SHA512:
+  metadata.gz: 6b48f13eb270a8591e0b784b0991559625407f187fabeadc56bbce816f7b8a097ec458f2a28486f9dd125a0d45c2bb1f23e5bb6ad7bc02d1938e01ccaff238e3
+  data.tar.gz: c6a27d77b81fc795e7f7b8074fbf7ee20e18fb39d32969efb2ec3cd331eb52fe02a38011edfee3de263c538f5f06833076b504f845f2c28fde0e4a56577b86db

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ezpay-invoice-sdk.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "byebug", "~> 11.1", :groups => [:development, :test]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Whyayen
+
+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,381 @@
+# Ezpay Invoice SDK (Unofficial)
+Ruby SDK for Ezpay Invoice.
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuration](#configuration)
+    - [Global](#global)
+    - [Individual](#individual)
+  - [Must Know](#must-know)
+  - [Invoice Issue](#invoice-issue)
+  - [Invoice Touch Issue](#invoice-touch-issue)
+  - [Invoice Invalid](#invoice-invalid)
+  - [Allowance Issue](#allowance-issue)
+  - [Allowance Touch Issue](#allowance-touch-issue)
+  - [Allowance Invalid](#allowance-invalid)
+  - [Invoice Search](#invoice-search)
+  - [Ezpay Error](#ezpay-error)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ezpay-invoice-sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ezpay-invoice-sdk
+
+Access the library in Ruby:
+```ruby
+require 'ezpay-invoice-sdk'
+```
+
+## Usage
+
+### Configuration
+使用前需先設定商店相關資料
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| merchant_id | String | 商店代號 | nil | ✔️ |
+| hash_key | String | API串接金鑰 Hash Key | nil | ✔️ |
+| hash_iv | String | API串接金鑰 Hash IV | nil | ✔️ |
+| mode | String | 測試環境或正式環境 | dev |  |
+
+請注意：預設的環境為 **測試環境**，**如果要使用正式環境開立發票**，請將 `mode` 設定為 `prod`。
+
+Ezpay 後台
+- [測試環境](https://cinv.ezpay.com.tw/)
+- [正式環境](https://inv.ezpay.com.tw/)
+
+此 SDK 目前僅實作電子發票開立、作廢、折讓、作廢折讓、查詢發票，並無字軌相關功能。
+
+詳細操作請參考 Ezpay 電子發票技術串接手冊
+https://inv.ezpay.com.tw/dw_files/info_api/EZP_INVI_1_2_1.pdf
+
+#### Global
+可以直接透過 `EzpayInvoice.setup` 設定商店資料，後面進行操作時預設會使用 `EzpayInvoice.config` 的設定進行 Ezpay 的操作
+
+```ruby
+EzpayInvoice.setup do |config|
+  config.merchant_id = 'your_merchant_id'
+  config.hash_key = 'your_hash_key'
+  config.hash_iv = 'your_hash_iv'
+  config.mode = 'dev' # or prod, default value is dev
+end
+```
+
+Rails 的使用者可以建立一個 `config/initializers/ezpay_invoice.rb` 檔案，並進行設定:
+```ruby
+EzpayInvoice.setup do |config|
+  config.merchant_id = 'merchant_id_from_yml_or_credential'
+  config.hash_key = 'your_hash_key_from_yml_or_credential'
+  config.hash_iv = 'your_hash_iv_from_yml_or_credential'
+  config.mode = Rails.env == 'production' ? 'prod' : 'dev'
+end
+```
+
+#### Individual
+如果同時有數家商店要各別開立發票的情況，可以通過建立 Client 時才設定商店資料
+
+```ruby
+store1 = EzpayInvoice::Client.new({
+  merchant_id: 'your_merchant_id',
+  hash_key: 'your_hash_key',
+  hash_iv: 'your_hash_iv',
+  mode: 'prod' # default value is dev
+})
+
+store2 = EzpayInvoice::Client.new({
+  merchant_id: 'your_merchant_id2',
+  hash_key: 'your_hash_key2',
+  hash_iv: 'your_hash_iv2',
+  mode: 'prod' # default value is dev
+})
+
+# store1.invoice_issue({...}) 使用 store1 Client 進行開立發票
+# store2.invoice_issue({...}) 使用 store2 Client 進行開立發票
+```
+
+### Must Know
+欄位皆與手冊上相同，差別在於 naming case 統一是 snake case，另外 item 相關欄位（`item_amt`, `item_name`）等會變成 Array 形態，在 SDK invoke API 時會自動轉換為字串並以 `|` 隔開各筆資料。
+
+建議搭配[官方手冊](https://inv.ezpay.com.tw/dw_files/info_api/EZP_INVI_1_2_1.pdf)看，`RespondType`、`Version`、`TimeStamp` 會預設帶入值，其餘欄位皆與手冊相同，SDK 並未自動預設帶入。
+
+非定義的欄位，自行填入會遭到忽略，例如：
+```ruby
+client.issue_invoice({ a: 'x' })
+```
+此時 `a` 欄位並不會被送到 API，因此如果 API 改版，有新增或修改欄位時，就需要更新此 package 所定義的欄位。
+
+另外 `response.result` 會返回 `check_code` 欄位用以驗證 Response 是否為 Ezpay 回傳的資料，SDK 不會幫你做驗證，因為在一些方法缺乏欄位進行驗證，需自行驗證，驗證方式請參考手冊附件二。
+
+### Invoice Issue
+`invoice_issue` 開立電子發票方法
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| trans_num | String | ezPay 平台交易序號 | nil |  |
+| merchant_order_no | String | 自訂編號 | nil | ✔️ |
+| status | String | 開立發票方式 | nil | ✔️ |
+| create_status_time | Date | 預計開立日期 | nil |  |
+| category | String | 發票種類 | nil | ✔️ |
+| buyer_name | String | 買受人名稱 | nil | ✔️ |
+| buyer_ubn | String | 買受人統一編號 | nil |  |
+| buyer_address | String | 買受人地址 | nil |  |
+| buyer_email | String | 買受人電子信箱 | nil |  |
+| carrier_type | String | 載具類別 | nil |  |
+| carrier_num | String | 載具編號 | nil |  |
+| love_code | Integer | 捐贈碼 | nil |  |
+| print_flag | String | 索取紙本發票 | nil | ✔️ |
+| kiosk_print_flag | String | 是否開放至合作超商 Kiosk 列印 | nil |  |
+| tax_type | String | 課稅別 | nil | ✔️ |
+| tax_rate | Float | 稅率 | nil | ✔️ |
+| customs_clearance | String | 報關標記 | nil |  |
+| amt | Integer | 銷售額合計 | nil | ✔️ |
+| amt_sales | Integer | 銷售額 (課稅別應稅) | nil |  |
+| amt_zero | Integer | 銷售額 (課稅別零稅率) | nil |  |
+| amt_free | Integer | 銷售額 (課稅別免稅) | nil |  |
+| tax_amt | Integer | 稅額 | nil | ✔️ |
+| total_amt | Integer | 發票金額 | nil | ✔️ |
+| item_name | String Array | 商品名稱 | nil | ✔️ |
+| item_count | Integer Array | 商品數量  | nil | ✔️ |
+| item_unit | String Array | 商品單位 | nil | ✔️ |
+| item_price | Integer Array | 商品單價 | nil | ✔️ |
+| item_amt | Integer Array | 商品小計 | nil | ✔️ |
+| item_tax_type | Integer Array | 商品課稅別 | nil |  |
+| comment | String | 備註 | nil |  |
+
+使用範例
+```ruby
+client = EzpayInvoice::Client.new
+payload = {
+  merchant_order_no: 'G20220101012',
+  status: '1',
+  category: 'B2B',
+  buyer_name: '好人好事代表公司',
+  buyer_ubn: '11223344',
+  buyer_email: 'your_buyer@email.com',
+  print_flag: 'Y',
+  tax_type: '1',
+  tax_rate: 5,
+  amt: 8000,
+  tax_amt: 400,
+  total_amt: 8400,
+  item_name: ['廣告費', '商務車租賃'],
+  item_count: [1, 2],
+  item_unit: ['筆', '小時'],
+  item_price: [5000, 1500],
+  item_amt: [5000, 3000],
+  item_tax_type: [1, 1]
+}
+response = client.invoice_issue(payload)
+response.status # => "SUCCESS"
+response.message # => "發票開立成功"
+response.result
+# =>  {"check_code"=>"ABCS***********3", "merchant_id"=>"3******2", "merchant_order_no"=>"G20220101013", "invoice_number"=>"ZH10000009", "total_amt"=>8400, "invoice_trans_no"=>"22011614342665747", "random_num"=>"8198", "create_time"=>"2022-01-16 14:34:26", "bar_code"=>"11102ZH100000098198", "q_rcode_l"=>"ZH100000091110116819800001f40000020d01122334461385956p+gqDeGDbLTQM4XuD4sEvQ==:**********:2:2:1:廣告費:1:5000:商務車租賃:2:1500", "q_rcode_r"=>"**"}
+```
+
+如果過程中 Ezpay 有返回錯誤代碼，則會直接 `raise EzpayResponseError`，請參考 [Ezpay Error](#ezpay-error) 進行處理
+
+### Invoice Touch Issue
+`invoice_touch_issue` 立即觸發等待開立、預約自動開立的發票
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| trans_num | String | ezPay 平台交易序號 | nil |  |
+| invoice_trans_no | String | ezPay 電子發票開立序號 | nil | ✔️ |
+| merchant_order_no | String | 自訂編號 | nil | ✔️ |
+| total_amt | Integer | 發票金額 | nil | ✔️ |
+
+使用範例
+```ruby
+payload = {
+  merchant_order_no: 'G20220101012',
+  invoice_trans_no: '22011614342665747',
+  total_amt: 8400
+}
+response = client.invoice_touch_issue(payload)
+response.result
+```
+
+### Invoice Invalid
+`invoice_valid` 作廢發票
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| invoice_number | String | 發票號碼 | nil | ✔️ |
+| invalid_reason | String | 作廢原因 | nil | ✔️ |
+
+
+使用範例
+```ruby
+payload = {
+  invoice_number: 'ZH10000008',
+  invalid_reason: '退貨'
+}
+
+response = client.invoice_invalid(payload)
+response.result
+```
+
+### Allowance Issue
+`allowance_issue` 開立折讓方法
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| invoice_no | String | 發票號碼 | nil | ✔️ |
+| merchant_order_no | String | 自訂編號 | nil | ✔️ |
+| item_name | String Array | 折讓商品名稱 | nil | ✔️ |
+| item_count | Integer Array | 折讓商品數量 | nil | ✔️ |
+| item_unit | String Array | 折讓商品單位 | nil | ✔️ |
+| item_price | Integer Array | 折讓商品單價 | nil | ✔️ |
+| item_amt | Integer Array | 折讓商品小計 | nil | ✔️ |
+| tax_type_for_mixed | Integer | 折讓課稅別 | nil |  |
+| item_tax_amt | Integer Array | 折讓商品稅額 | nil | ✔️ |
+| total_amt | Integer | 折讓總金額 | nil | ✔️ |
+| buyer_email | String | 買受人電子信箱 | nil |  |
+| status | String | 確認折讓方式 | nil | ✔️ |
+
+使用範例
+```ruby
+payload = {
+  invoice_no: 'ZH10000010',
+  merchant_order_no: 'G20220101014',
+  buyer_email: 'junjun.st.tw01@gmail.com',
+  item_name: ['廣告費', '商務車租賃'],
+  item_count: [1, 2],
+  item_unit: ['筆', '小時'],
+  item_price: [3000, 1500],
+  item_amt: [3000, 3000],
+  item_tax_amt: [150, 150],
+  tax_type_for_mixed: 1,
+  total_amt: 6300,
+  status: '1'
+}
+
+response = client.allowance_issue(payload)
+response.result
+```
+
+### Allowance Touch Issue
+`allowance_touch_issue` 觸發確認折讓或取消折讓方法
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| allowance_status | String | 觸發折讓狀態  | nil | ✔️ |
+| allowance_no | String | 折讓號  | nil | ✔️ |
+| merchant_order_no | String | 自訂編號 | nil | ✔️ |
+| total_amt | Integer | 折讓總金額 | nil | ✔️ |
+
+使用範例
+```ruby
+payload = {
+  allowance_no: 'A220116015800106',
+  allowance_status: 'D',
+  merchant_order_no: 'G20220101014',
+  total_amt: 6300,
+}
+
+response = client.allowance_touch_issue(payload)
+response.result
+```
+
+### Allowance Invalid
+`allowance_invalid` 作廢折讓方法
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| allowance_no | String | 折讓號  | nil | ✔️ |
+| invalid_reason | String | 作廢原因  | nil | ✔️ |
+
+使用範例
+```ruby
+payload = {
+  allowance_no: 'A220116015800106',
+  invalid_reason: '作廢折讓'
+}
+
+response = client.allowance_invalid(payload)
+response.result
+```
+
+### Invoice Search
+`invoice_search` 查詢發票方法
+
+| 欄位 | 型別 | 用途 | 預設 | 必填 |
+| :--- | :--- | :--- | :--- | :---: |
+| timestamp | Integer | 時間戳 | Time.now.to_i | |
+| search_type | String | 查詢方式   | nil |  |
+| merchant_order_no | String | 訂單編號  | nil | ✔️ |
+| total_amt | String | 發票金額  | nil | ✔️ |
+| invoice_number | String | 發票號碼   | nil | ✔️ |
+| random_num | String | 發票防偽隨機碼  | nil | ✔️ |
+| display_flag | String | 是否於本平台網頁 顯示發票查詢結果  | nil | |
+
+使用範例
+```ruby
+payload = {
+  search_type: '0',
+  merchant_order_no: 'G20220101014',
+  invoice_number: 'ZH10000008',
+  total_amt: '8400',
+  random_num: '8856'
+}
+
+response = client.invoice_search(payload)
+response.result
+```
+
+### Ezpay Error
+如果使用上述方法時，Ezpay API 端返回文件內所定義的錯誤，如：
+| 錯誤代碼 | 錯誤原因 |
+| :---: | :---: |
+| KEY10002 | 資料解密錯誤 |
+| KEY10004 | 資料不齊全 |
+
+更多錯誤代碼請參考[官方手冊](https://inv.ezpay.com.tw/dw_files/info_api/EZP_INVI_1_2_1.pdf)附件九
+
+如果接收到上述錯誤時，則會 raise 一個 `EzpayResponseError` 並將 `status` 與 `message` 存於 Exception 內，想 catch 特定錯誤進行處理時，可以參考下列 pseudo code：
+
+```ruby
+begin
+  client.inovice_issue(payload)
+rescue EzpayInvoice::EzpayResponseError => e
+  puts e.status
+  puts e.message
+  # 錯誤處理
+end
+```
+
+## 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/whyayen/ezpay-invoice-sdk.
+
+
+## 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 "ezpay-invoice"
+
+# 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/ezpay-invoice.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ezpay-invoice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezpay-invoice"
+  spec.version       = EzpayInvoice::VERSION
+  spec.authors       = ["Whyayen"]
+  spec.email         = ["c75a90@gmail.com"]
+
+  spec.add_dependency 'rest-client', '~> 2.1.0'
+  spec.add_dependency 'hashie', '~> 5.0.0'
+  spec.add_dependency 'addressable', '~> 2.8.0'
+  spec.add_dependency 'activesupport', ['>= 5.0.0', '<= 7.0.1']
+
+  spec.summary       = %q{The unofficial Ezpay invoice ruby SDK.}
+  spec.description   = %q{The package would be able to issue invoice, invalid invoice on Ezpay}
+  spec.homepage      = "https://github.com/whyayen/ezpay-invoice-sdk"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/whyayen/ezpay-invoice-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/whyayen/ezpay-invoice-sdk"
+
+  # 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"]
+end

data/lib/ezpay-invoice/api/endpoints/allowance_invalid.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module AllowanceInvalid
+        def allowance_invalid(payload = {})
+          post(
+            'allowanceInvalid',
+            EzpayInvoice::Api::Payloads::AllowanceInvalid.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/allowance_issue.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module AllowanceIssue
+        def allowance_issue(payload = {})
+          post(
+            'allowance_issue',
+            EzpayInvoice::Api::Payloads::AllowanceIssue.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/allowance_touch_issue.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module AllowanceTouchIssue
+        def allowance_touch_issue(payload = {})
+          post(
+            'allowance_touch_issue',
+            EzpayInvoice::Api::Payloads::AllowanceTouchIssue.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/invoice_invalid.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module InvoiceInvalid
+        def invoice_invalid(payload = {})
+          post(
+            'invoice_invalid',
+            EzpayInvoice::Api::Payloads::InvoiceInvalid.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/invoice_issue.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module InvoiceIssue
+        def invoice_issue(payload = {})
+          post(
+            'invoice_issue',
+            EzpayInvoice::Api::Payloads::InvoiceIssue.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/invoice_search.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module InvoiceSearch
+        def invoice_search(payload = {})
+          post(
+            'invoice_search',
+            EzpayInvoice::Api::Payloads::InvoiceSearch.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/endpoints/invoice_touch_issue.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Endpoints
+      module InvoiceTouchIssue
+        def invoice_touch_issue(payload = {})
+          post(
+            'invoice_touch_issue',
+            EzpayInvoice::Api::Payloads::InvoiceTouchIssue.new(payload)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/allowance_invalid.rb

@@ -0,0 +1,11 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class AllowanceInvalid < Base
+        property(:Version, from: :version, default: '1.0')
+        property(:AllowanceNo, from: :allowance_no, required: true)
+        property(:InvalidReason, from: :invalid_reason, required: true)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/allowance_issue.rb

@@ -0,0 +1,23 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class AllowanceIssue < Base
+        include EzpayInvoice::Api::Properties::Item
+
+        property(:Version, from: :version, default: '1.3')
+        property(:InvoiceNo, from: :invoice_no, required: true)
+        property(:MerchantOrderNo, from: :merchant_order_no, required: true)
+        property(:TaxTypeForMixed, from: :tax_type_for_mixed)
+        property(
+          :ItemTaxAmt,
+          from: :item_tax_amt,
+          with: ->(value) { value.join('|') },
+          required: true
+        )
+        property(:TotalAmt, from: :total_amt, required: true)
+        property(:BuyerEmail, from: :buyer_email)
+        property(:Status, from: :status, required: true)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/allowance_touch_issue.rb

@@ -0,0 +1,13 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class AllowanceTouchIssue < Base
+        property(:Version, from: :version, default: '1.0')
+        property(:AllowanceStatus, from: :allowance_status, required: true)
+        property(:AllowanceNo, from: :allowance_no, required: true)
+        property(:MerchantOrderNo, from: :merchant_order_no, required: true)
+        property(:TotalAmt, from: :total_amt, required: true)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/base.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+
+module EzpayInvoice
+  module Api
+    module Payloads
+      class Base < Hashie::Dash
+        include Hashie::Extensions::IgnoreUndeclared
+        include Hashie::Extensions::Dash::PropertyTranslation
+        include EzpayInvoice::Api::Properties::General
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/invoice_invalid.rb

@@ -0,0 +1,11 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class InvoiceInvalid < Base
+        property(:Version, from: :version, default: '1.0')
+        property(:InvoiceNumber, from: :invoice_number, required: true)
+        property(:InvalidReason, from: :invalid_reason, required: true)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/invoice_issue.rb

@@ -0,0 +1,40 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class InvoiceIssue < Base
+        include EzpayInvoice::Api::Properties::Item
+
+        property(:Version, from: :version, default: '1.4')
+        property(:TransNum, from: :trans_num)
+        property(:MerchantOrderNo, from: :merchant_order_no, required: true)
+        property(:Status, from: :status, required: true)
+        property(:CreateStatusTime, from: :create_status_time)
+        property(:Category, from: :category, required: true)
+        property(:BuyerName, from: :buyer_name, required: true)
+        property(:BuyerUBN, from: :buyer_ubn)
+        property(:BuyerAddress, from: :buyer_address)
+        property(:BuyerEmail, from: :buyer_email)
+        property(:CarrierType, from: :carrier_type)
+        property(:CarrierNum, from: :carrier_num)
+        property(:LoveCode, from: :love_code)
+        property(:PrintFlag, from: :print_flag, required: true)
+        property(:KioskPrintFlag, from: :kiosk_print_flag)
+        property(:TaxType, from: :tax_type, required: true)
+        property(:TaxRate, from: :tax_rate, required: true)
+        property(:CustomsClearance, from: :customs_clearance)
+        property(:Amt, from: :amt, required: true)
+        property(:AmtSales, from: :amt_sales)
+        property(:AmtZero, from: :amt_zero)
+        property(:AmtFree, from: :amt_free)
+        property(:TaxAmt, from: :tax_amt, required: true)
+        property(:TotalAmt, from: :total_amt, required: true)
+        property(
+          :ItemTaxType,
+          from: :item_tax_type,
+          with: ->(value) { value.join('|') },
+        )
+        property(:Comment, from: :comment)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/invoice_search.rb

@@ -0,0 +1,15 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class InvoiceSearch < Base
+        property(:Version, from: :version, default: '1.3')
+        property(:SearchType, from: :search_type)
+        property(:MerchantOrderNo, from: :merchant_order_no, required: true)
+        property(:TotalAmt, from: :total_amt, required: true)
+        property(:InvoiceNumber, from: :invoice_number, required: true)
+        property(:RandomNum, from: :random_num, required: true)
+        property(:DisplayFlag, from: :display_flag)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads/invoice_touch_issue.rb

@@ -0,0 +1,13 @@
+module EzpayInvoice
+  module Api
+    module Payloads
+      class InvoiceTouchIssue < Base
+        property(:Version, from: :version, default: '1.0')
+        property(:TransNum, from: :trans_num)
+        property(:MerchantOrderNo, from: :merchant_order_no, required: true)
+        property(:InvoiceTransNo, from: :invoice_trans_no, required: true)
+        property(:TotalAmt, from: :total_amt, required: true)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/payloads.rb

@@ -0,0 +1,8 @@
+require_relative 'payloads/base'
+require_relative 'payloads/invoice_issue'
+require_relative 'payloads/invoice_touch_issue'
+require_relative 'payloads/invoice_invalid'
+require_relative 'payloads/invoice_search'
+require_relative 'payloads/allowance_issue'
+require_relative 'payloads/allowance_touch_issue'
+require_relative 'payloads/allowance_invalid'

data/lib/ezpay-invoice/api/properties/general.rb

@@ -0,0 +1,14 @@
+module EzpayInvoice
+  module Api
+    module Properties
+      module General
+        def self.included(base)
+          base.class_eval do
+            property :RespondType, from: :respond_type, default: 'JSON'
+            property :TimeStamp, from: :timestamp, default: Time.now.to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/properties/item.rb

@@ -0,0 +1,42 @@
+module EzpayInvoice
+  module Api
+    module Properties
+      module Item
+        def self.included(base)
+          base.class_eval do
+            property(
+              :ItemName,
+              from: :item_name,
+              with: ->(value) { value.join('|') },
+              required: true
+            )
+            property(
+              :ItemCount,
+              from: :item_count,
+              with: ->(value) { value.join('|') },
+              required: true
+            )
+            property(
+              :ItemUnit,
+              from: :item_unit,
+              with: ->(value) { value.join('|') },
+              required: true
+            )
+            property(
+              :ItemPrice,
+              from: :item_price,
+              with: ->(value) { value.join('|') },
+              required: true
+            )
+            property(
+              :ItemAmt,
+              from: :item_amt,
+              with: ->(value) { value.join('|') },
+              required: true
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/api/properties.rb

@@ -0,0 +1,2 @@
+require_relative 'properties/general'
+require_relative 'properties/item'

data/lib/ezpay-invoice/client.rb

@@ -0,0 +1,31 @@
+require_relative 'request'
+require_relative 'api/properties'
+require_relative 'api/payloads'
+require_relative 'api/endpoints/invoice_issue'
+require_relative 'api/endpoints/invoice_touch_issue'
+require_relative 'api/endpoints/invoice_invalid'
+require_relative 'api/endpoints/invoice_search'
+require_relative 'api/endpoints/allowance_issue'
+require_relative 'api/endpoints/allowance_touch_issue'
+require_relative 'api/endpoints/allowance_invalid'
+
+module EzpayInvoice
+  class Client
+    include EzpayInvoice::Configurable
+    include EzpayInvoice::Request
+    include EzpayInvoice::Api::Endpoints::InvoiceIssue
+    include EzpayInvoice::Api::Endpoints::InvoiceTouchIssue
+    include EzpayInvoice::Api::Endpoints::InvoiceInvalid
+    include EzpayInvoice::Api::Endpoints::InvoiceSearch
+    include EzpayInvoice::Api::Endpoints::AllowanceIssue
+    include EzpayInvoice::Api::Endpoints::AllowanceTouchIssue
+    include EzpayInvoice::Api::Endpoints::AllowanceInvalid
+
+    def initialize(options = {})
+      EzpayInvoice::Configurable.attributes.each do |key|
+        value = options.key?(key) ? options[key] : EzpayInvoice.send(key)
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/configurable.rb

@@ -0,0 +1,35 @@
+module EzpayInvoice
+  module Configurable
+    attr_accessor :merchant_id, :hash_key, :hash_iv
+
+    MODES = ['dev', 'prod']
+
+    def mode
+      @mode ||= 'dev'
+    end
+
+    def mode=(_mode)
+      raise ArgumentError, "mode must be one of [#{MODES.join(', ')}]." if !MODES.include?(_mode)
+      @mode = _mode
+    end
+
+    def setup
+      block_given? ? yield(self) : self
+    end
+
+    def config
+      self
+    end
+
+    class << self
+      def attributes
+        @attributes ||= [
+          :merchant_id,
+          :hash_key,
+          :hash_iv,
+          :mode
+        ]
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/exceptions.rb

@@ -0,0 +1,13 @@
+module EzpayInvoice
+  class Error < StandardError; end
+  class CheckCodeInvalid < Error; end
+
+  class EzpayResponseError < StandardError
+    attr_reader :status
+
+    def initialize(message, status)
+      super(message)
+      @status = status
+    end
+  end
+end

data/lib/ezpay-invoice/request.rb

@@ -0,0 +1,43 @@
+require 'rest-client'
+require 'addressable/uri'
+require 'json'
+
+require_relative 'response'
+
+module EzpayInvoice
+  module Request
+    def post(path, data)
+      uri = Addressable::URI.new
+      uri.query_values = data
+      payload = {
+        'MerchantID_' => @merchant_id,
+        'PostData_' => encrypt(uri.query)
+      }
+      request(:post, path, payload)
+    end
+
+    private
+    def api_endpoint
+      subdomain = @mode == 'prod' ? 'inv' : 'cinv'
+      "https://#{subdomain}.ezpay.com.tw/Api/"
+    end
+
+    def request(method, path, payload)
+      response = RestClient::Request.execute(
+        method: method,
+        url: Addressable::URI.parse("#{api_endpoint}#{path}").normalize.to_str,
+        payload: payload
+      )
+
+      Response.new(response)
+    end
+
+    def encrypt(data)
+      aes = OpenSSL::Cipher.new('AES-256-CBC')
+      aes.encrypt
+      aes.key = @hash_key
+      aes.iv = @hash_iv
+      (aes.update(data) + aes.final).unpack("H*").first.upcase
+    end
+  end
+end

data/lib/ezpay-invoice/response.rb

@@ -0,0 +1,37 @@
+require 'digest'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+
+module EzpayInvoice
+  class Response
+    attr_reader :body, :status, :message, :result
+
+    def initialize(rest_response)
+      response_hash = JSON.parse(rest_response.body)
+      raise EzpayResponseError.new(
+        response_hash['Message'],
+        response_hash['Status']
+      ) if response_hash['Status'] != 'SUCCESS'
+
+      @body = response_hash
+      @status = response_hash['Status']
+      @message = response_hash['Message']
+      @result = transform_keys(JSON.parse(response_hash['Result']))
+      parse_item_detail
+    end
+
+    private
+    def parse_item_detail
+      if @result.has_key?('item_detail')
+        item_detail = JSON.parse(@result['item_detail']).map { |item| transform_keys(item) }
+        @result['item_detail'] = item_detail
+      end
+    end
+
+    def transform_keys(hash)
+      hash.deep_transform_keys do |k|
+        k.to_s.underscore
+      end
+    end
+  end
+end

data/lib/ezpay-invoice/version.rb

@@ -0,0 +1,3 @@
+module EzpayInvoice
+  VERSION = '0.0.1'
+end

data/lib/ezpay-invoice.rb

@@ -0,0 +1,10 @@
+require_relative 'ezpay-invoice/version'
+require_relative 'ezpay-invoice/exceptions'
+require_relative 'ezpay-invoice/configurable'
+require_relative 'ezpay-invoice/client'
+
+module EzpayInvoice
+  class << self
+    include EzpayInvoice::Configurable
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ezpay-invoice
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Whyayen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+description: The package would be able to issue invoice, invalid invoice on Ezpay
+email:
+- c75a90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ezpay-invoice.gemspec
+- lib/ezpay-invoice.rb
+- lib/ezpay-invoice/api/endpoints/allowance_invalid.rb
+- lib/ezpay-invoice/api/endpoints/allowance_issue.rb
+- lib/ezpay-invoice/api/endpoints/allowance_touch_issue.rb
+- lib/ezpay-invoice/api/endpoints/invoice_invalid.rb
+- lib/ezpay-invoice/api/endpoints/invoice_issue.rb
+- lib/ezpay-invoice/api/endpoints/invoice_search.rb
+- lib/ezpay-invoice/api/endpoints/invoice_touch_issue.rb
+- lib/ezpay-invoice/api/payloads.rb
+- lib/ezpay-invoice/api/payloads/allowance_invalid.rb
+- lib/ezpay-invoice/api/payloads/allowance_issue.rb
+- lib/ezpay-invoice/api/payloads/allowance_touch_issue.rb
+- lib/ezpay-invoice/api/payloads/base.rb
+- lib/ezpay-invoice/api/payloads/invoice_invalid.rb
+- lib/ezpay-invoice/api/payloads/invoice_issue.rb
+- lib/ezpay-invoice/api/payloads/invoice_search.rb
+- lib/ezpay-invoice/api/payloads/invoice_touch_issue.rb
+- lib/ezpay-invoice/api/properties.rb
+- lib/ezpay-invoice/api/properties/general.rb
+- lib/ezpay-invoice/api/properties/item.rb
+- lib/ezpay-invoice/client.rb
+- lib/ezpay-invoice/configurable.rb
+- lib/ezpay-invoice/exceptions.rb
+- lib/ezpay-invoice/request.rb
+- lib/ezpay-invoice/response.rb
+- lib/ezpay-invoice/version.rb
+homepage: https://github.com/whyayen/ezpay-invoice-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/whyayen/ezpay-invoice-sdk
+  source_code_uri: https://github.com/whyayen/ezpay-invoice-sdk
+  changelog_uri: https://github.com/whyayen/ezpay-invoice-sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The unofficial Ezpay invoice ruby SDK.
+test_files: []