allinpay_cnp 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761b711ff19735de05c502045113231b46fcfeb9d19846250332b7f0ac5796b8
-  data.tar.gz: 2989b6abb28969795fb0bac8ba1f5d70a5dca67e9763df79dc70dc9353e02932
+  metadata.gz: fafe64e400a551831d156112734279e2fb85e79be6501313be8207a1cfec73f7
+  data.tar.gz: 2622d961e762fab513b071796956dc60475e43271541f862c08f3a11b813b725
 SHA512:
-  metadata.gz: 3ab98fa0152a023bc8f81154d8cc5d3318f2068f0581d34b0fbde9a87ed83b92d1409818e5ea7284d8352df49dfe2089983d4db0fcc2b32e6f37a64ab7007e73
-  data.tar.gz: fcd529d01f205b5e2801e61ae68bfb1ba16645513cdb54c81e3dee009468d5a0d7ec0ae5fe64a4f6ccd63e8776bd522ccab767fd83e902afddc851a08c493012
+  metadata.gz: eb660034680377320d589e3608ff84df6f2225276ae57bf7711648600b3df5d6d61973c539a925cb7b05aa986a161e293c62481bffd3471d04f7ddc7a1dd385b
+  data.tar.gz: 5da018a9be520a162b9dbcfa76807ca15fe2b63baa607aff17d0b17a3ac65d50cc8f914296a59fb52a031e7cf884446f67e77c0734ccf3db95b572dda0380ab8

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.6'
 ```
 
 ### 本地安装
@@ -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.6.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` |
+| 商户公钥 | 上传至通联后台，通联用来验证你的请求签名 | 不需要配置到代码中 |
+
 ## 使用方法
 
 ### 获取客户端
@@ -84,6 +97,9 @@ response = client.unified_pay(
   },
   email: 'customer@example.com',
   language: 'zh-hant',  # 可选: zh-hant, zh-hans, en
+  product_info: [       # 商品信息，可选，会以 JSON 字符串形式发送
+    { sku: 'SKU001', productName: 'Test Product', price: '100.00', quantity: '1' }
+  ],
   shipping: {
     first_name: 'Peter',
     last_name: 'Zhang',
@@ -114,7 +130,7 @@ end
 ### 查询订单 (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 +184,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` 对象：
@@ -216,4 +259,3 @@ lib/
     ├── 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,26 +31,33 @@ 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,
+        instNo: inst_no_param,
         mchtId: merchant_no,
         transType: 'Query',
+        accessOrderId: generate_order_id,
         oriAccessOrderId: ori_access_order_id
-      }
-      request.post(:quickpay, params)
+      }.compact
+      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,
+        instNo: inst_no_param,
         mchtId: merchant_no,
         transType: 'Refund',
         accessOrderId: access_order_id,
@@ -56,19 +65,25 @@ 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
+      val = config.inst_no
+      (val.nil? || val.to_s.strip.empty?) ? nil : val.to_s.strip
     end
 
     def config
@@ -80,7 +95,7 @@ module AllinpayCnp
     end
 
     def build_unified_pay_params(access_order_id:, amount:, currency:, urls:, merchant_no: nil, **options)
-      build_base_params(access_order_id, amount, currency, urls, options)
+      build_base_params(access_order_id, amount, currency, urls, options, merchant_no)
         .merge(build_shipping_params(options))
         .merge(build_billing_params(options))
         .compact
@@ -95,11 +110,12 @@ module AllinpayCnp
     def build_order_core_params(access_order_id, amount, currency, merchant_no = nil)
       {
         version: VERSION,
+        instNo: inst_no_param,
         mchtId: merchant_no || config.merchant_id,
         accessOrderId: access_order_id,
         amount: amount.to_s,
         currency: currency
-      }
+      }.compact
     end
 
     def notify_return_urls(urls)

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/response.rb

@@ -16,7 +16,7 @@ module AllinpayCnp
     def http_success?
       return false if @error
 
-      @http_response&.success?
+      @http_response&.success? == true
     end
 
     def success?

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,16 +49,16 @@ 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-----'
+          pem = "-----BEGIN PRIVATE KEY-----\n#{key_content}\n-----END PRIVATE KEY-----"
           OpenSSL::PKey::RSA.new(pem)
         end
       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.4'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allinpay_cnp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - DrinE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday