alipay 0.15.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b46f90c6340aeb58cf9de3a967423f390fa0444a63635f0548bace4019a61f
-  data.tar.gz: b011da754fa7343f08785829906b33014807794184b130a0d413dfee3048e679
+  metadata.gz: 7ee68ff17cbe892261f66b282dbd49e81f88efa779db4f6916b69b41cf84053f
+  data.tar.gz: 13fded2aeab1797089926ee3f323ee895695f1e8437688bd7bc09861bd204af9
 SHA512:
-  metadata.gz: '033712118c048e90a8e45189d4483fcef0c549c68c21182c2c09b3b72cefe9c32ee75b1645b39dc8f54346315a47fd8f17013f02e897f4399f1be6ccf1727f68'
-  data.tar.gz: ed308742f277d296686254a6801269db4c33ea32fcc2f64b7df6bc778913332050426970638f5797639db9f45c8773d1c7476dcae0ab51fe20bf2e296e42537a
+  metadata.gz: ecf437110ed593f50fa3e6a387c8bcf99e5919151104c0c14e1f7480b145539c0191de9bf4b6a3302ef9c06a95ad59af3b779703e28cc3e07aa88383eb9c1e66
+  data.tar.gz: 669046641accc68da181058bc608b0b3490f72bc0f33b54b4171601221cf2704513143db7a85055d1cdf7936d6010bb74de22025133251ea3afee58846244104

data/.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build_and_push:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+        bundler-cache: true
+    - run: bundle exec rake
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"

data/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['3.0', '3.1', '3.2']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master
 
+Newer release changelog, see https://github.com/chloerei/alipay/releases
+
+## v0.16.0 (2020-05-15)
+
+- Support certificate signature, thanks @moohao #92
+
 ## v0.15.2 (2019-08-02)
 
 - page_execute_form invalid-signature charset, thanks @lingceng #90

data/README.md

@@ -12,7 +12,7 @@ To install using [Bundler](http://bundler.io/). Add this line to your
 application's Gemfile:
 
 ```ruby
-gem 'alipay', '~> 0.15.1'
+gem 'alipay'
 ```
 
 Then run:
@@ -22,7 +22,7 @@ $ bundle
 
 Or you can manually install using [RubyGems](http://rubygems.org/):
 ```bash
-$ gem install alipay -v 0.15.1
+$ gem install alipay
 ```
 
 ## Getting Started

data/doc/legacy_api.md

@@ -11,7 +11,7 @@ Alipay official document: https://b.alipay.com/order/techService.htm .
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'alipay', '~> 0.14.0'
+gem 'alipay'
 ```
 
 And then execute:
@@ -539,6 +539,202 @@ notify_params = params.except(*request.path_parameters.keys)
 Alipay::Notify.verify?(notify_params, options = {})
 ```
 
+### QR Code 生成二维码
+
+#### Name
+
+```ruby
+alipay.commerce.qrcode.create
+```
+
+#### Definition
+
+```ruby
+Alipay::Service.create_merchant_qr_code({PARAMS}, {OPTIONS})
+```
+
+#### Example
+
+```ruby
+create_qr_code_params = {
+  biz_type: "OVERSEASHOPQRCODE",
+  biz_data: {
+    address: "No.278, Road YinCheng, Shanghai, China",
+    country_code: "CN",
+    currency: "USD",
+    secondary_merchant_id: "xxx001",
+    secondary_merchant_industry: "7011",
+    secondary_merchant_name: "xxx Store",
+    store_id: "0001",
+    store_name: "Apple store",
+    trans_currency: "USD"
+  }
+}
+
+Alipay::Service.create_merchant_qr_code(create_qr_code_params)
+# => 'https://mapi.alipay.com/gateway.do?service=alipay.commerce.qrcode.create...'
+```
+
+#### ARGUMENTS
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| notify_url | optional | Alipay asyn notify url. |
+| biz_type | required | Business type that is defined by Alipay, this case is “OVERSEASHOPQRCODE” |
+| biz_data | required | Business data. Format：JSON |
+
+#### BIZ_DATA ARGUMENTS (required)
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| secondary_merchant_industry | required | Business category code of the secondary merchant. |
+| secondary_merchant_id | required | The unique ID assigned by the partner to identify a secondary merchant. |
+| secondary_merchant_name | required | Registration legal name of the secondary merchant, shown in the Alipay Wallet and the reconciliation file to identify a secondary merchant. |
+| store_id | required | The unique ID that is assigned by the partner to identify a store of a merchant. |
+| store_name | required | The name of the store. |
+| trans_currency | required | The pricing currency |
+| currency | required | The currency to settle with the merchant. The default value is CNY. If the pricing currency is not CNY, then the settlement currency must be either CNY or the pricing currency. |
+| country_code | required | The country code that consists of two letters (alpha-2 code) |
+| address | required | The address of the store where the code is created. |
+
+This is not a complete list of arguments, please read official document: https://global.alipay.com/docs/ac/global/qrcode_create#biz_data
+
+### QR Code 修改二维码
+
+#### Name
+
+```ruby
+alipay.commerce.qrcode.modify
+```
+
+#### Definition
+
+```ruby
+Alipay::Service.update_merchant_qr_code({PARAMS}, {OPTIONS})
+```
+
+#### Example
+
+```ruby
+update_qr_code_params = {
+  biz_type: "OVERSEASHOPQRCODE",
+  qrcode: "https://qr.alipay.com/baxxxxx",
+  biz_data: {
+    address: "No.278, Road YinCheng, Shanghai, China",
+    country_code: "CN",
+    currency: "USD",
+    secondary_merchant_id: "xxx001",
+    secondary_merchant_industry: "7011",
+    secondary_merchant_name: "xxx Store",
+    store_id: "0001",
+    store_name: "Apple store",
+    trans_currency: "USD"
+  }
+}
+
+Alipay::Service.update_merchant_qr_code(update_qr_code_params)
+# => 'https://mapi.alipay.com/gateway.do?service=alipay.commerce.qrcode.modify...'
+```
+
+#### ARGUMENTS
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| notify_url | optional | Alipay asyn notify url. |
+| biz_type | required | Business type that is defined by Alipay, this case is “OVERSEASHOPQRCODE” |
+| biz_data | required | Business data. Format：JSON |
+| qrcode | required | The returned QR code value after the code is generated successfully. |
+
+#### BIZ_DATA ARGUMENTS (required)
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| secondary_merchant_industry | required | Business category code of the secondary merchant. |
+| secondary_merchant_id | required | The unique ID assigned by the partner to identify a secondary merchant. |
+| secondary_merchant_name | required | Registration legal name of the secondary merchant, shown in the Alipay Wallet and the reconciliation file to identify a secondary merchant. |
+| store_id | required | The unique ID that is assigned by the partner to identify a store of a merchant. |
+| store_name | required | The name of the store. |
+| trans_currency | required | The pricing currency |
+| currency | required | The currency to settle with the merchant. The default value is CNY. If the pricing currency is not CNY, then the settlement currency must be either CNY or the pricing currency. |
+| country_code | required | The country code that consists of two letters (alpha-2 code) |
+| address | required | The address of the store where the code is created. |
+
+This is not a complete list of arguments, please read official document: https://global.alipay.com/docs/ac/global/qrcode_modify#Qb0Hc
+
+### 境外线下交易查询接口
+
+#### Name
+
+```ruby
+alipay.acquire.overseas.query
+```
+
+#### Definition
+
+```ruby
+Alipay::Service.acquirer_overseas_query({PARAMS}, {OPTIONS})
+```
+
+#### Example
+
+```ruby
+acquirer_overseas_query_params = {
+  partner_trans_id: "2010121000000002"
+}
+
+Alipay::Service.acquirer_overseas_query(acquirer_overseas_query_params)
+# => 'https://mapi.alipay.com/gateway.do?service=alipay.acquire.overseas.query...'
+```
+
+#### ARGUMENTS
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| partner_trans_id | required | The original partner transaction ID given in the payment request |
+| alipay_trans_id | optional | The transaction ID assigned by Alipay for the partner's payment request, which follows a mapping relation with the partner field plus the partner_trans_id field. When both of the fields are specified, alipay_trans_id will be verified first. |
+
+Document: https://global.alipay.com/docs/ac/global/overseas_query
+
+### 境外线下单笔退款接口
+
+#### Name
+
+```ruby
+alipay.acquire.overseas.spot.refund
+```
+
+#### Definition
+
+```ruby
+Alipay::Service.acquirer_overseas_spot_refund_url({PARAMS}, {OPTIONS})
+```
+
+#### Example
+
+```ruby
+acquirer_overseas_spot_refund_params = {
+  partner_trans_id: "2010121000000002",
+  partner_refund_id: "301012133000002",
+  currency: "USD",
+  refund_amount: "0.01"
+}
+
+Alipay::Service.acquirer_overseas_spot_refund_url(acquirer_overseas_spot_refund_params)
+# => 'https://mapi.alipay.com/gateway.do?service=alipay.acquire.overseas.spot.refund...'
+```
+
+#### ARGUMENTS
+
+| Key | Requirement | Description |
+| --- | ----------- | ----------- |
+| partner_trans_id | required | The original partner transaction ID given in the payment request |
+| partner_refund_id | required | The refund order ID in the partner system. The value of partner_refund_id cannot be the same as that of partner_trans_id. The partner_refund_id field plus the partner field identifies a refund transaction. |
+| currency | required | The currency of the refund amount. |
+| refund_amount | required | Refund amount, which must be less than or equal to the original transaction amount or the left transaction amount if ever refunded. |
+| is_sync | optional | Indicates that the refund request is processed synchronously or asynchronously with a value of Y or N. The default value is N, which means an asynchronous notification from Alipay is returned to the merchant if the merchant has set the value of the notify_url field when sending the refund request. If the value is set as Y, it means only a synchronous response is returned to the merchant. |
+
+This is not a complete list of arguments, please read official document: https://global.alipay.com/docs/ac/global/spot_refund#92fa0c95
+
 ## Mobile::Service
 
 ### 移动支付接口

data/doc/rsa_key_cn.md

@@ -6,6 +6,7 @@
 * [生成应用密钥](#生成应用密钥)
 * [验证参数](#验证参数)
 * [补充格式到支付宝公钥](#补充格式到支付宝公钥)
+* [使用证书签名方式](#使用证书签名方式)
 
 ### 生成应用密钥
 #### 在 Ruby 下生成 RSA2 密钥
@@ -62,3 +63,43 @@ pub_key.scan(/.{64}|.+$/).join("\n").insert(0, "-----BEGIN PUBLIC KEY-----\n").i
 # => "-----BEGIN PUBLIC KEY-----\nMIIBI...\n-----END PUBLIC KEY-----\n"
 ```
 
+# 使用证书签名方式
+
+## 应用证书配置
+按照官方文档进行新建应用配置证书签名 https://docs.open.alipay.com/291/twngcd/
+
+配置完成后，可以得到 `xxx.com_私钥.txt  alipayCertPublicKey_RSA2.crt  appCertPublicKey_2019082600000001.crt  alipayRootCert.crt` 四个文件。
+
+### 应用私钥补充格式
+```ruby
+app_private_key = File.read('xxx.com_私钥.txt')
+app_private_key = app_private_key.scan(/.{64}|.+$/).join("\n").insert(0, "-----BEGIN RSA PRIVATE KEY-----\n").insert(-1, "\n-----END RSA PRIVATE KEY-----\n")
+```
+### 处理应用阿里云公钥
+```ruby
+alipay_public_key = File.read('alipayCertPublicKey_RSA2.crt')
+alipay_public_key = OpenSSL::X509::Certificate.new(alipay_public_key).public_key.to_s
+```
+### 得到应用公钥证书sn
+```ruby
+app_cert = File.read('appCertPublicKey_2019082600000001.crt')
+app_cert_sn = Alipay::Utils.get_cert_sn(app_cert)
+# => "28d1147972121b91734da59aa10f3c16"
+```
+### 得到支付宝根证书sn
+```ruby
+alipay_root_cert = File.read('alipayRootCert.crt')
+alipay_root_cert_sn = Alipay::Utils.get_root_cert_sn(alipay_root_cert)
+# => "28d1147972121b91734da59aa10f3c16_28d1147972121b91734da59aa10f3c16"
+```
+### 使用
+```ruby
+@alipay_client = Alipay::Client.new(
+  url: API_URL,
+  app_id: APP_ID,
+  app_private_key: app_private_key,
+  alipay_public_key: alipay_public_key,
+  app_cert_sn: app_cert_sn,
+  alipay_root_cert_sn: alipay_root_cert_sn
+)
+```

data/lib/alipay/client.rb

@@ -37,6 +37,8 @@ module Alipay
       @format = options['format'] || 'json'
       @charset = options['charset'] || 'UTF-8'
       @sign_type = options['sign_type'] || 'RSA2'
+      @app_cert_sn = options['app_cert_sn']
+      @alipay_root_cert_sn = options['alipay_root_cert_sn']
     end
 
     # Generate a query string that use for APP SDK excute.
@@ -183,6 +185,12 @@ module Alipay
         'version' => '1.0',
         'timestamp' => Time.now.localtime('+08:00').strftime("%Y-%m-%d %H:%M:%S")
       }.merge(::Alipay::Utils.stringify_keys(params))
+      if !@app_cert_sn.nil? && !@alipay_root_cert_sn.nil?
+        params = params.merge({
+          'app_cert_sn' => @app_cert_sn,
+          'alipay_root_cert_sn' => @alipay_root_cert_sn
+        })
+      end
       params['sign'] = sign(params)
       params
     end

data/lib/alipay/service.rb

@@ -209,6 +209,92 @@ module Alipay
       request_uri(params, options).to_s
     end
 
+    CREATE_MERCHANT_QR_CODE_REQUIRED_PARAMS = %w( biz_type biz_data )
+    CREATE_MERCHANT_QR_CODE_REQUIRED_BIZ_DATA_PARAMS = %w( secondary_merchant_industry secondary_merchant_id secondary_merchant_name trans_currency currency )
+    def self.create_merchant_qr_code(params, options = {})
+      params = Utils.stringify_keys(params)
+      check_required_params(params, CREATE_MERCHANT_QR_CODE_REQUIRED_PARAMS)
+      biz_data = nil
+
+      if params['biz_data']
+        params['biz_data'] = Utils.stringify_keys(params['biz_data'])
+        check_required_params(params['biz_data'], CREATE_MERCHANT_QR_CODE_REQUIRED_BIZ_DATA_PARAMS)
+
+        data = params.delete('biz_data')
+        biz_data = data.map do |key, value|
+          "\"#{key}\": \"#{value}\""
+        end.join(',')
+      end
+
+      biz_data = "{#{biz_data}}"
+
+      params = {
+        'service'        => 'alipay.commerce.qrcode.create',
+        '_input_charset' => 'utf-8',
+        'partner'        => options[:pid] || Alipay.pid,
+        'timestamp'      => Time.now.utc.strftime('%Y-%m-%d %H:%M:%S').to_s,
+        'biz_data'       => biz_data
+      }.merge(params)
+
+      request_uri(params, options).to_s
+    end
+
+    UPDATE_MERCHANT_QR_CODE_REQUIRED_PARAMS = %w( biz_type biz_data qr_code )
+    def self.update_merchant_qr_code(params, options = {})
+      params = Utils.stringify_keys(params)
+      check_required_params(params, UPDATE_MERCHANT_QR_CODE_REQUIRED_PARAMS)
+      biz_data = nil
+
+      if params['biz_data']
+        params['biz_data'] = Utils.stringify_keys(params['biz_data'])
+
+        data = params.delete('biz_data')
+        biz_data = data.map do |key, value|
+          "\"#{key}\": \"#{value}\""
+        end.join(',')
+      end
+
+      biz_data = "{#{biz_data}}"
+
+      params = {
+        'service'        => 'alipay.commerce.qrcode.modify',
+        '_input_charset' => 'utf-8',
+        'partner'        => options[:pid] || Alipay.pid,
+        'timestamp'      => Time.now.utc.strftime('%Y-%m-%d %H:%M:%S').to_s,
+        'biz_data'       => biz_data
+      }.merge(params)
+
+      request_uri(params, options).to_s
+    end
+
+    ACQUIRER_OVERSEAS_QUERY_REQUIRED_PARAMS = %w(partner_trans_id)
+    def self.acquirer_overseas_query(params, options = {})
+      params = Utils.stringify_keys(params)
+      check_required_params(params, ACQUIRER_OVERSEAS_QUERY_REQUIRED_PARAMS)
+
+      params = {
+        'service'        => 'alipay.acquire.overseas.query',
+        '_input_charset' => 'utf-8',
+        'partner'        => options[:pid] || Alipay.pid,
+      }.merge(params)
+
+      request_uri(params, options).to_s
+    end
+
+    ACQUIRER_OVERSEAS_SPOT_REFUND_REQUIRED_PARAMS = %w( partner_trans_id partner_refund_id refund_amount currency )
+    def self.acquirer_overseas_spot_refund_url(params, options= {})
+      params = Utils.stringify_keys(params)
+      check_required_params(params, ACQUIRER_OVERSEAS_SPOT_REFUND_REQUIRED_PARAMS)
+
+      params = {
+        'service'        => 'alipay.acquire.overseas.spot.refund',
+        '_input_charset' => 'utf-8',
+        'partner'        => options[:pid] || Alipay.pid,
+      }.merge(params)
+
+      request_uri(params, options).to_s
+    end
+
     def self.request_uri(params, options = {})
       uri = URI(GATEWAY_URL)
       uri.query = URI.encode_www_form(sign_params(params, options))

data/lib/alipay/utils.rb

@@ -15,5 +15,36 @@ module Alipay
       batch_no = t.strftime('%Y%m%d%H%M%S') + t.nsec.to_s
       batch_no.ljust(24, rand(10).to_s)
     end
+
+    # get app_cert_sn
+    def self.get_cert_sn(str, match_algo = false)
+      return nil if str.nil?
+      certificate = OpenSSL::X509::Certificate.new(str)
+      if match_algo
+        begin
+          return unless certificate.public_key.is_a?(OpenSSL::PKey::RSA)
+        rescue => exception
+          return
+        end
+      end
+      issuer_arr = OpenSSL::X509::Name.new(certificate.issuer).to_a
+      issuer = issuer_arr.reverse.map { |item| item[0..1].join('=') }.join(',')
+      serial = OpenSSL::BN.new(certificate.serial).to_s
+      OpenSSL::Digest::MD5.hexdigest(issuer + serial)
+    end
+
+    # get alipay_root_cert_sn
+    def self.get_root_cert_sn(str)
+      return nil if str.nil?
+      arr = str.scan(/-----BEGIN CERTIFICATE-----[\s\S]*?-----END CERTIFICATE-----/)
+      arr_sn = []
+      arr.each do |item|
+        sn = get_cert_sn(item, true)
+        unless sn.nil?
+          arr_sn.push(sn)
+        end
+      end
+      arr_sn.join('_')
+    end
   end
 end

data/lib/alipay/version.rb

@@ -1,3 +1,3 @@
 module Alipay
-  VERSION = "0.15.2"
+  VERSION = "0.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alipay
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Rei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: An unofficial simple alipay gem