allinpay_cnp 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeeda5ea5ef28fb25989946746361e94d696c5c550175502a5b21758a04892dc
-  data.tar.gz: 034452c2f863fcc6d66ceb4d925d386a1644e1a93a3c5c61fcaeda02170f90fb
+  metadata.gz: ac650967bd79647830a80efd1d725613148afcc828675284ad3ed8142be5df3a
+  data.tar.gz: 218cb69cf48768732567cf4bf49f0e5dd6ac9f4424e06ab93a2e83e180016431
 SHA512:
-  metadata.gz: c07e269b643265cee50a9db7a446ea6ae44d85ec1e5bcad13ab647e7ac523f4a9cc3c38f2975ac64fccb9e51af61ef573988085864be7737fa31ae52c471d600
-  data.tar.gz: 01e7e53b849f4ee10f39618372228e9f52d961739f9dbdfce34dcdf82f9f554794cfbaf97a1d24d6e8e5856ba0df28aa8e3c77e5cdff44e4629ecbf310dc5504
+  metadata.gz: fe077759b23abafaf7c567a2f2cf45a0c6f14fe2ec8162196604a5b441f037b09c422bec6ead4f67d0c5d922fb07c921ef3ba7227f7cca9c57e09eaca0f58c68
+  data.tar.gz: adfb37bdd7f78350c362484ab1b1a062aade3e6aa29342f8484d17039e1f98be67c3f1aabb31a0bd73db65c2fa6628af361393c82cc61a2a2e1ce56c918617d6

data/README.md

@@ -7,7 +7,7 @@
 ### Gemfile
 
 ```ruby
-gem 'allinpay_cnp', git: 'https://github.com/your-org/allinpay_cnp'
+gem 'allinpay_cnp', '~> 0.1.7'
 ```
 
 ### 本地安装
@@ -15,7 +15,7 @@ gem 'allinpay_cnp', git: 'https://github.com/your-org/allinpay_cnp'
 ```bash
 cd allinpay_cnp
 gem build allinpay_cnp.gemspec
-gem install allinpay_cnp-0.1.0.gem
+gem install allinpay_cnp-0.1.7.gem
 ```
 
 ## 配置
@@ -29,6 +29,7 @@ AllinpayCnp.configure do |config|
   config.merchant_id = Rails.application.credentials.dig(:allinpay, :merchant_id)
   config.private_key = Rails.application.credentials.dig(:allinpay, :private_key)
   config.public_key  = Rails.application.credentials.dig(:allinpay, :public_key)
+  config.inst_no     = Rails.application.credentials.dig(:allinpay, :inst_no)
   config.environment = Rails.env.production? ? :production : :test
   config.timeout     = 30
   config.logger      = Rails.logger
@@ -44,7 +45,8 @@ AllinpayCnp.configure do |config|
   config.merchant_id = '086310030670001'
   config.private_key = File.read('private_key.pem')
   config.public_key  = File.read('public_key.pem')
-  config.environment = :test  # :test 或 :production
+  config.inst_no     = '00000001'  # 机构模式下必填，直连商户模式不填
+  config.environment = :test       # :test 或 :production
   config.timeout     = 30
   config.logger      = Logger.new($stdout)
 end
@@ -54,13 +56,24 @@ end
 
 | 配置项 | 类型 | 必填 | 说明 |
 |--------|------|------|------|
-| `merchant_id` | String | 是 | 商户号 |
-| `private_key` | String | 是 | 商户私钥 (PEM 格式) |
-| `public_key` | String | 否 | CNP 公钥，用于验证回调签名 |
+| `merchant_id` | String | 条件必填 | 商户号。若每次调用时都传入 `merchant_no`，可不在全局配置 |
+| `private_key` | String | 条件必填 | 商户私钥 (PEM 格式)，用于请求签名。若每次调用时都传入 `private_key`，可不在全局配置 |
+| `public_key` | String | 否 | 系统公钥 (PEM 格式)，用于验证回调/应答签名。亦可在调用时通过 `public_key` / `verify_callback(public_key:)` 传入 |
+| `inst_no` | String | 否 | 机构号，机构模式下必填，直连商户模式留空 |
 | `environment` | Symbol | 否 | `:test` (默认) 或 `:production` |
 | `timeout` | Integer | 否 | 请求超时时间，默认 30 秒 |
 | `logger` | Logger | 否 | 日志对象 |
 
+> 多商户模式下可以不在全局配置 `merchant_id` / `private_key`，而是在每次调用时按商户传入。详见 [多商户模式](#多商户模式-per-call-credentials)。
+
+### 密钥说明
+
+| 密钥 | 用途 | 对应配置 |
+|------|------|----------|
+| 商户私钥 | 请求时计算签名 | `config.private_key` |
+| 系统公钥 | 接收应答/异步通知时验签 | `config.public_key` |
+| 商户公钥 | 上传至通联后台，通联用来验证你的请求签名 | 不需要配置到代码中 |
+
 ## 使用方法
 
 ### 获取客户端
@@ -83,7 +96,10 @@ response = client.unified_pay(
     return_url: 'https://your-domain.com/payments/complete'
   },
   email: 'customer@example.com',
-  language: 'zh-hant',  # 可选: zh-hant, zh-hans, en
+  language: 'zh-CN',    # 可选，收银台语言，见下方「收银台语言」；无法识别时回退 en
+  product_info: [       # 商品信息，可选，会以 JSON 字符串形式发送
+    { sku: 'SKU001', productName: 'Test Product', price: '100.00', quantity: '1' }
+  ],
   shipping: {
     first_name: 'Peter',
     last_name: 'Zhang',
@@ -111,10 +127,34 @@ else
 end
 ```
 
+#### 收银台语言 (language)
+
+通联只接受下面 8 个语言码。`language` 会先经过 `AllinpayCnp::Language.resolve`
+归一化，所以可以直接传常见的 locale 写法（大小写、`_`/`-` 分隔都行），
+识别不出来的（俄语、泰语、德语……）以及不传时，统一回退英文。
+
+| 传入 locale | 发送的 language | 语言 |
+| --- | --- | --- |
+| `zh` / `zh-CN` / `zh-Hans` | `zh` | 简体中文 |
+| `zh-TW` / `zh-HK` / `zh-MO` / `zh-hant` | `zh-hant` | 繁体中文 |
+| `en` | `en` | 英语 |
+| `ja` / `jp` | `ja` | 日语 |
+| `ko` / `kr` | `kr` | 韩语（注意通联写作 `kr`） |
+| `fr` | `fr` | 法语 |
+| `es` | `es` | 西班牙语 |
+| `ar` | `ar` | 阿拉伯语 |
+| 其他 / 不传 | `en` | 英语（默认） |
+
+```ruby
+AllinpayCnp::Language.resolve('zh-CN') # => "zh"
+AllinpayCnp::Language.resolve('ko')    # => "kr"
+AllinpayCnp::Language.resolve('ru')    # => "en"
+```
+
 ### 查询订单 (Query)
 
 ```ruby
-response = client.query('ORIGINAL_ORDER_123')
+response = client.query(ori_access_order_id: 'ORIGINAL_ORDER_123')
 
 if response.success?
   puts "状态: #{response.status}"          # SUCCESS, FAIL, PROCESSING
@@ -168,6 +208,33 @@ class WebhooksController < ApplicationController
 end
 ```
 
+## 多商户模式 (Per-call credentials)
+
+如果你的应用需要为多个商户代发请求 (商户模式 / 非机构模式)，每个商户拥有独立的密钥对。可在调用时传入 `private_key` / `public_key` / `merchant_no`，会覆盖全局配置：
+
+```ruby
+response = client.unified_pay(
+  access_order_id: "ORDER_#{Time.now.to_i}",
+  amount: '100.00',
+  currency: 'HKD',
+  urls: { notify_url: '...', return_url: '...' },
+  merchant_no: merchant.allinpay_id,
+  private_key: merchant.allinpay_private_key,
+  public_key:  merchant.allinpay_public_key
+)
+
+# query / refund 同样支持
+client.query(ori_access_order_id: 'ORDER_123',
+             merchant_no: merchant.allinpay_id,
+             private_key: merchant.allinpay_private_key,
+             public_key:  merchant.allinpay_public_key)
+
+# 回调验签时使用对应商户的 public_key
+client.verify_callback(params, public_key: merchant.allinpay_public_key)
+```
+
+未传入时会回退到 `AllinpayCnp.configure` 中的全局配置，因此单商户用法完全向后兼容。
+
 ## Response 对象
 
 所有 API 方法都返回 `Response` 对象：
@@ -211,9 +278,9 @@ lib/
 └── allinpay_cnp/
     ├── version.rb            # 版本号
     ├── config.rb             # 配置类
+    ├── language.rb           # 收银台语言归一化
     ├── signature.rb          # RSA2 签名
     ├── request.rb            # HTTP 请求
     ├── response.rb           # 响应封装
     └── client.rb             # API 客户端
 ```
-

data/lib/allinpay_cnp/client.rb

@@ -11,7 +11,9 @@ module AllinpayCnp
       amount          = opts.fetch(:amount)
       currency        = opts.fetch(:currency)
       urls            = opts.fetch(:urls)
-      options         = opts.except(:access_order_id, :amount, :currency, :urls)
+      private_key     = opts[:private_key]
+      public_key      = opts[:public_key]
+      options         = opts.except(:access_order_id, :amount, :currency, :urls, :private_key, :public_key)
 
       params = build_unified_pay_params(
         access_order_id: access_order_id,
@@ -21,7 +23,7 @@ module AllinpayCnp
         **options
       )
 
-      request.post(:unified_pay, params)
+      request.post(:unified_pay, params, private_key: private_key, public_key: public_key)
     end
 
     def query(hash_or_opts = nil, **kwargs)
@@ -29,6 +31,8 @@ module AllinpayCnp
 
       merchant_no = opts.fetch(:merchant_no, config.merchant_id)
       ori_access_order_id = opts.fetch(:ori_access_order_id)
+      private_key = opts[:private_key]
+      public_key  = opts[:public_key]
 
       params = {
         version: VERSION,
@@ -38,16 +42,18 @@ module AllinpayCnp
         accessOrderId: generate_order_id,
         oriAccessOrderId: ori_access_order_id
       }.compact
-      request.post(:quickpay, params)
+      request.post(:quickpay, params, private_key: private_key, public_key: public_key)
     end
 
     def refund(hash_or_opts = nil, **kwargs)
       opts = (hash_or_opts || {}).merge(kwargs).transform_keys(&:to_sym)
 
-      merchant_no = opts.fetch(:merchant_no)
+      merchant_no = opts.fetch(:merchant_no, config.merchant_id)
       ori_access_order_id = opts.fetch(:ori_access_order_id)
       refund_amount = opts.fetch(:refund_amount)
       access_order_id = opts.fetch(:access_order_id, generate_order_id)
+      private_key = opts[:private_key]
+      public_key  = opts[:public_key]
 
       params = {
         version: VERSION,
@@ -59,19 +65,20 @@ module AllinpayCnp
         refundAmount: refund_amount.to_s,
         notifyUrl: opts.fetch(:notify_url, nil)
       }.reject { |_, v| v.nil? }
-      request.post(:quickpay, params)
+      request.post(:quickpay, params, private_key: private_key, public_key: public_key)
     end
 
-    def verify_callback(params)
-      return false unless config.public_key
+    def verify_callback(params, public_key: nil)
+      key = public_key || config.public_key
+      return false unless key
 
-      Signature.verify(params, config.public_key)
+      Signature.verify(params, key)
     end
 
     private
 
     def generate_order_id
-      Time.now.to_i.to_s
+      (Time.now.to_f * 1000).to_i.to_s
     end
 
     def inst_no_param
@@ -117,7 +124,7 @@ module AllinpayCnp
 
     def build_base_option_params(options)
       {
-        language: options[:language] || 'zh-hant',
+        language: Language.resolve(options[:language]),
         email: options[:email],
         productInfo: options[:product_info]&.to_json
       }

data/lib/allinpay_cnp/language.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AllinpayCnp
+  # 收银台网站语言 (`language`)。
+  #
+  # 通联只接受下面 8 个语言码，传别的会被拒绝；本模块把常见的 locale 写法
+  # (`zh-CN`、`zh_TW`、`ko` ...) 归一化过去，认不出来的一律回退英文。
+  #
+  #   AllinpayCnp::Language.resolve('zh-CN') # => "zh"
+  #   AllinpayCnp::Language.resolve('ko')    # => "kr"
+  #   AllinpayCnp::Language.resolve('ru')    # => "en"
+  module Language
+    DEFAULT = 'en'
+
+    # 通联语言码 => 归一到该语言码的 locale。注意韩语在通联是 `kr`，不是 `ko`。
+    LOCALES_BY_LANGUAGE = {
+      'zh' => %w[zh zh-cn zh-hans],
+      'zh-hant' => %w[zh-tw zh-hant zh-hk zh-mo],
+      'en' => %w[en],
+      'ja' => %w[ja jp],
+      'kr' => %w[ko kr],
+      'fr' => %w[fr],
+      'es' => %w[es],
+      'ar' => %w[ar]
+    }.freeze
+
+    SUPPORTED = LOCALES_BY_LANGUAGE.each_with_object({}) do |(language, locales), map|
+      locales.each { |locale| map[locale] = language }
+    end.freeze
+
+    def self.resolve(locale)
+      SUPPORTED.fetch(normalize(locale), DEFAULT)
+    end
+
+    def self.normalize(locale)
+      locale.to_s.strip.tr('_', '-').downcase
+    end
+    private_class_method :normalize
+  end
+end

data/lib/allinpay_cnp/request.rb

@@ -16,13 +16,13 @@ module AllinpayCnp
       }
     }.freeze
 
-    def post(endpoint_type, params)
-      sign_params(params)
+    def post(endpoint_type, params, private_key: nil, public_key: nil)
+      sign_params(params, private_key)
       url = build_url(endpoint_type)
       log_request(url, params)
       response = send_post(url, params)
       log_response(response)
-      Response.new(response, public_key: config.public_key)
+      Response.new(response, public_key: public_key || config.public_key)
     rescue Faraday::Error => e
       log_error(e.message)
       Response.new(nil, error: e)
@@ -34,9 +34,9 @@ module AllinpayCnp
       AllinpayCnp.config
     end
 
-    def sign_params(params)
+    def sign_params(params, private_key = nil)
       params[:signType] = 'RSA2'
-      params[:sign] = Signature.sign(params, config.private_key)
+      params[:sign] = Signature.sign(params, private_key || config.private_key)
     end
 
     def build_url(endpoint_type)

data/lib/allinpay_cnp/signature.rb

@@ -18,7 +18,7 @@ module AllinpayCnp
 
         sign_string = build_sign_string(params)
         rsa_verify(sign_string, signature, public_key)
-      rescue StandardError
+      rescue OpenSSL::PKey::PKeyError, OpenSSL::OpenSSLError
         false
       end
 
@@ -49,7 +49,7 @@ module AllinpayCnp
       end
 
       def load_private_key(key_content)
-        if key_content.include?('-----BEGIN')
+        if key_content.include?('-----BEGIN PRIVATE KEY') || key_content.include?('-----BEGIN RSA PRIVATE KEY')
           OpenSSL::PKey::RSA.new(key_content)
         else
           pem = "-----BEGIN PRIVATE KEY-----\n#{key_content}\n-----END PRIVATE KEY-----"
@@ -58,7 +58,7 @@ module AllinpayCnp
       end
 
       def load_public_key(key_content)
-        if key_content.include?('-----BEGIN')
+        if key_content.include?('-----BEGIN PUBLIC KEY')
           OpenSSL::PKey::RSA.new(key_content)
         else
           pem = "-----BEGIN PUBLIC KEY-----\n#{key_content}\n-----END PUBLIC KEY-----"

data/lib/allinpay_cnp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AllinpayCnp
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/lib/allinpay_cnp.rb

@@ -2,6 +2,7 @@
 
 require_relative 'allinpay_cnp/version'
 require_relative 'allinpay_cnp/config'
+require_relative 'allinpay_cnp/language'
 require_relative 'allinpay_cnp/signature'
 require_relative 'allinpay_cnp/response'
 require_relative 'allinpay_cnp/request'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: allinpay_cnp
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - DrinE
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -41,16 +40,15 @@ files:
 - lib/allinpay_cnp.rb
 - lib/allinpay_cnp/client.rb
 - lib/allinpay_cnp/config.rb
+- lib/allinpay_cnp/language.rb
 - lib/allinpay_cnp/request.rb
 - lib/allinpay_cnp/response.rb
 - lib/allinpay_cnp/signature.rb
 - lib/allinpay_cnp/version.rb
-- lib/debug.rb
 homepage: https://github.com/CoolDrinELiu/allinpay
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby SDK for Allinpay CNP cross-border payment gateway
 test_files: []

data/lib/debug.rb

@@ -1,86 +0,0 @@
-require './allinpay_cnp'
-
-AllinpayCnp.configure do |config|
-  config.merchant_id = '086310058120045'
-  config.private_key = <<~XXX
------BEGIN PRIVATE KEY-----
-MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDFt99S9adbC84l
-LExEF4vjFHiurFNRmBVEMmVVeJQfzQbQ/6fY0s+2Vx0lHVcD5ZVdDRwbTl2LG+8S
-lWH6aXmvOk5j5DI9wGJEwPo2L8GH9RHbHMQu0jr9+UO97kBCjKNZKmWkbNsPrfUb
-HxWuKKFILaZcv4LYNsjBNvVkvRU674lJVQ+TZ8ZsPLvc5+I3anJGLbu5Bt1igqbn
-vpMV1seYsUnNbuDBSoYHl09CPvGRc5krmRyouwwLlXiwcJDNDudl5Uohwj2LCuiC
-TWfkd/Me1ty1YrAZR9a/zh+vM7dLc9aCBnic2/7JYBtPwcKKC0Zix9ODbNehLahE
-Nqvxm9KtAgMBAAECggEAE3lb1rj5Zd9Qy5qEXISRM6mVhWbVwgift5rbHkMFG+i+
-ziEQMCv7Z3NHHJu6MVkQkBy1cv8R+ZyjvInYH6j54kd05yPXyvtC8pCrVGD5x+Fc
-g99ed1ofk1pU0MVBsQxXHnYtkrdiEDZLGQPDx+aalBhi9Wmrgo5K0bUPEIALMkWv
-RIBTkRbA/SB4WatB7zmKJxkqA+YIRzAmLDgUE1qjyhE/1VG/d/aetkwGkMo+HSDU
-x87ERKSbgLCri80UQ9RnMtV/wp9nh0VD3b6+MVFKacfKLHBrAwT3E/8Lv4S0I/Sr
-I94IoxOP4gCxytps+BslNuSCd3mMp8OuxCkqg2PBhQKBgQDmC+SpWH4WU/1XO/w9
-C0HnV7b0mpLt4+BqN/1eHdKK29L4R0iOqRjnO9bCkWGnV8nGU0kzNk9jueK2QBdR
-eOnmwqFCvEaIksyG/sUcHkzCxgtUvHxhy3e9IvjKv/5y47P9w/YgIZn62X+tWsnv
-EzPKPfw2+ALxllkVWZsBqB3hrwKBgQDcBkoL1JRWlrPaaSzcUbyJKUQWwIm9trHj
-XAYzwwsNjhGuV/aefVI7priLOxWR9Djq5IuOabNQ290ve6Bu2BBrEtbIsL/0UXwq
-HAmWXuCFc9/MfocQ+TiE0BuUDKgsYqQU2DE+JLaxvaUv1DNw2bUgm9z3zQyJJed4
-ZAHrYqo0YwKBgE9GGe4hiJG5L7w395wxnOxT1cBE5A0GUfdIhA9Cx6MCTZkxN1ex
-/drxS/iQkM5R+j5VxQvY01LSY8XaIC77M99Jgri0mLnHnKOId/RQnLMh/BWfPl2U
-+BY9Tu7Paqe8v/Ha7Z309lLzUIQ0nRG91EMFSTzICnumC9zHnBreDC4RAoGBAMWl
-JKjh6eqqb594MSMsjVcM6awigtkXn05kYPHoeCpR/5IEVHZkjxUkm8v+ZE76+pIO
-gUqJqtms11ELFb/ceUsl3ijjlVssQ4Q0MWyRh9B5mYVB96SIq3uq0cs5X2yXo1tS
-JVH0euTJPfTsAtWRy4IiYOl8mZEtqnNcKtk+hTSPAoGAKSF7NCZU0hQwu/rf8v7v
-go/qdS/oYDUohs5HVLG074Eerb1Q4w/xUfSz8zIJvTg04PLWwiBO3P5hCoXUXEaR
-V3Dl1g4i/pGrurOQQHhH9gdPINGBb7okthIwl02QT1UxX3Ibq1OjuH27qoCRQtWJ
-7oJx+aHeFOuOHjULBy+6/CU=
------END PRIVATE KEY-----
-XXX
-  config.public_key = <<~PEM
------BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsNGWmxYl6uYA/X3k1OOY
-nMlLvmgJpYMvahxDLUc9CEXbaqMoMMuLbsvfR6Zf3JIeYCjjfgNVDJTsJY/HWWbp
-HEd4GvQAgv6wywsQ8AJqIHe3fM3B8iwS3XIxZM9fs92lU+mHuVHQdMvciQyaB3iw
-3IvBBzCEgyqSFcGBrlQOGf1x7fZZKY9RH3EDxqzE+Zrs27BjE8T3sNvUCKcfWGhQ
-GKX80jcqLEnFBl9CIlgL4TRSksQ1U4GhOY0/4Db6UsmbTAQeG2plWgbJ0l0khJ2O
-DYqTtDujl4zN3tGXQ2gwCErxqBbukIFMkT+jS1lxrBeGGrvuOXTz408tDbAsJnbU
-YwIDAQAB
------END PUBLIC KEY-----
-PEM
-  config.environment = :test
-  config.logger = Logger.new($stdout)
-end
-
-client = AllinpayCnp.client
-
-# 测试创建订单
-response = client.unified_pay(
-  access_order_id: "TEST_#{Time.now.to_i}",
-  amount: '1.00',
-  currency: 'HKD',
-  urls: {
-    notify_url: 'https://example.com/callback',
-    return_url: 'https://example.com/return'
-  },
-  email: 'test@example.com',
-  product_info: [
-    {
-      # sku: '123456789',
-      productName: 'MacBook Pro'
-      # price: '1.00',
-      # quantity: '1'
-    }
-  ],
-  shipping: {
-    first_name: 'Peter',
-    last_name: 'Zhang',
-    address1: '123 Test Street',
-    city: 'Hong Kong',
-    state: 'Hong Kong',
-    country: 'HK',
-    zip_code: '000000',
-    phone: '12345678'
-  }
-)
-
-q = client.query('TEST_1771053407')
-puts "Success: #{response.success?}"
-puts "Result Code: #{response.result_code}"
-puts "Result Desc: #{response.result_desc}"
-puts "Payment URL: #{response.payment_url}" if response.success?