wechat-pay 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b07e4346fb61d83569dadb3b0dd467a6b719375fa3b471d6df0ed58a2307b3d2
-  data.tar.gz: f72bff18f57427e1c8946ddf82bcdb9f20c0057f80fb11beb9eb71183a6499c0
+  metadata.gz: 97a1465d8d7d51844df252100062b9a93e3fca7ec95ba71b3c6efde5be055fdd
+  data.tar.gz: 79f475e4b12bd326b67ba5eb20600f2c085fbdfbafcab8dc3c6dfc74e904f948
 SHA512:
-  metadata.gz: 124e7291a418fd0759ca7906973bf2134fa4330d0db0c2b8cb0612964247ee51de5f7ed74203b99492019a544f513a8b2e005f5f1f81a339e4f4bf91890fedc4
-  data.tar.gz: c1b0543c3cffc19563d0f42ed624f43f0a4bfcd5bbf990923457be6c9cfa49dbcb67ad864a444970f4929e81ee4e7fdeb1e5f2727ca24b1f05e2627546f79d78
+  metadata.gz: a4fcb7ab75a019b3de65aae0946bc8db4b3812a651c8ab6652fb2e47bbb31afaf98a10f6d5b6028f81385ac69c319f7f46e872b72b21c1ab0930d8fe36f579b4
+  data.tar.gz: 208c39a3eb250aaa7fc13c49d34bc75d093698641b28cb5b992bf33aa825f8c175b8ca3fc4ab9503a11c86f81e0df7628f60fc5669571dc5cb56fb80d8737299

data/.github/workflows/code_quality.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run rubocop
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+Gemfile.lock
+doc/
+.yardoc/
+rdoc/
+/*.pem

data/.rspec

@@ -0,0 +1,2 @@
+--force-color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 200

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+--protected
+--no-private

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Next Release
+
+## 1.1.0 (07/26/2021)
+
+* Fix `Accept-Encoding` issue in wechat.
+
+
+## 1.0.8 (05/26/2021)
+
+* Add api `invoke_transactions_in_native` to `WechatPay::Ecommerce`
+
+## 1.0.7 (05/16/2021)
+
+* Change `WechatPay::Ecommerce.get_certificates` to `WechatPay::Ecommerce.certificates`
+* Refactor code and document.

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in tenpay.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger

data/README.md

@@ -0,0 +1,92 @@
+# Wechat Pay
+
+A simple Wechat pay ruby gem, without unnecessary magic or wrapper. Just a simple wrapper for api V3. Refer to [wx_pay](https://github.com/jasl/wx_pay)
+
+Please read official document first: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/pages/index.shtml
+
+If you want check the present public api, you can find them in the [Document](https://www.rubydoc.info/github/lanzhiheng/wechat-pay/master/index)。
+
+Summary:
+
+`WechatPay::Direct` will contain the public api for direct connection merchant（直连商户）and `WechatPay::Ecommerce` will contain the public api for ecommerce（服务商，电商平台）。For more detail you can refer to the wechat document.
+
+- 直连商户: https://pay.weixin.qq.com/wiki/doc/apiv3/index.shtml
+- 服务商: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/index.shtml
+- 电商平台（电商收付通）: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/open/pay/chapter3_3_3.shtml
+
+If you find any issue in this repo, don't shy to create issues https://github.com/lanzhiheng/wechat-pay/issues
+
+For more Information，you can check my posts: https://www.lanzhiheng.com/posts/preview/ruby-gem-for-wechat-pay-v3
+
+# Installation
+
+Add this line to your Gemfile:
+
+```
+gem 'wechat-pay'
+```
+
+or development version
+
+```
+gem 'wechat-pay', :github => 'lanzhiheng/wechat-pay'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+# Usage
+
+## Configuration
+
+Create `config/initializer/wechat_pay.rb`and put following configurations into it
+
+``` ruby
+WechatPay.apiclient_key = File.read('apiclient_key.pem')
+WechatPay.platform_cert = File.read('platform_cert.pem') # You should comment this line before downloaded platform_cert.
+WechatPay.apiclient_cert = File.read('apiclient_cert.pem')
+WechatPay.app_id = 'Your App Id'
+WechatPay.mch_id = 'Your Mch Id'
+WechatPay.mch_key = 'Your Mch Key'
+```
+
+## Download
+
+I will provide a simple script for you to download the platform_cert
+
+``` ruby
+def download_certificate
+  download_path = 'Your Download Path'
+  raise '必须提供证书下载路径' if download_path.blank?
+
+  response = WechatPay::Ecommerce.certificates
+
+  raise '证书下载失败' unless response.code == 200
+
+  result = JSON.parse(response.body)
+  # 需要按生效日期进行排序，获取最新的证书
+  array = result['data'].sort_by { |item| -Time.parse(item['effective_time']).to_i }
+  current_data = array.first
+  encrypt_certificate = current_data['encrypt_certificate']
+  associated_data = encrypt_certificate['associated_data']
+  nonce = encrypt_certificate['nonce']
+  ciphertext = encrypt_certificate['ciphertext']
+
+  content = WechatPay::Sign.decrypt_the_encrypt_params(
+    associated_data: associated_data,
+    nonce: nonce,
+    ciphertext: ciphertext
+  )
+
+  File.open(download_path, 'w') do |f|
+    f.write(content)
+  end
+
+  puts '证书下载成功'
+end
+```
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wechat-pay #{WechatPay::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/wechat-pay.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Naming/FileName
+
 # frozen_string_literal: true
 
 require 'restclient'
@@ -8,7 +10,6 @@ require 'wechat-pay/ecommerce' # 电商平台
 # # 微信支付
 #
 # 设置关键信息
-
 module WechatPay
   class<< self
     attr_accessor :app_id, :mch_id, :mch_key
@@ -40,3 +41,4 @@ module WechatPay
     end
   end
 end
+# rubocop:enable Naming/FileName

data/lib/wechat-pay/direct.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'wechat-pay/helper'
 
@@ -7,183 +9,80 @@ module WechatPay
   module Direct
     include WechatPayHelper
 
-    ##
-    # :singleton-method: invoke_combine_transactions_in_app
-    #
-    # 直连合单app下单
-    #
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_1.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   combine_out_trade_no: 'combine_out_trade_no',
-    #   combine_payer_info: {
-    #     openid: 'client open id'
-    #   },
-    #   sub_orders: [
-    #     {
-    #       mchid: 'mchid',
-    #       sub_mchid: 'sub mchid',
-    #       attach: 'attach',
-    #       amount: {
-    #         total_amount: 100,
-    #         currency: 'CNY'
-    #       },
-    #       out_trade_no: 'out_trade_no',
-    #       description: 'description'
-    #     }
-    #   ],
-    #   notify_url: 'the_url'
-    # }
-    #
-    # WechatPay::Direct.invoke_combine_transactions_in_app(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_js
-    #
-    # js合单
-    #
-    # 直连合单js下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_3.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   combine_out_trade_no: 'combine_out_trade_no',
-    #   combine_payer_info: {
-    #     openid: 'client open id'
-    #   },
-    #   sub_orders: [
-    #     {
-    #       mchid: 'mchid',
-    #       sub_mchid: 'sub mchid',
-    #       attach: 'attach',
-    #       amount: {
-    #         total_amount: 100,
-    #         currency: 'CNY'
-    #       },
-    #       out_trade_no: 'out_trade_no',
-    #       description: 'description'
-    #     }
-    #   ],
-    #   notify_url: 'the_url'
-    # }
-    #
-    # WechatPay::Direct.invoke_combine_transactions_in_js(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_h5
-    #
-    # 直连合单h5下单
-    #
-    # TODO: 与电商平台类似，只是参数不同，稍后重构
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_2.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   combine_out_trade_no: 'combine_out_trade_no',
-    #   sub_orders: [
-    #     {
-    #       mchid: 'mchid',
-    #       sub_mchid: 'sub mchid',
-    #       attach: 'attach',
-    #       amount: {
-    #         total_amount: 100,
-    #         currency: 'CNY'
-    #       },
-    #       out_trade_no: 'out_trade_no',
-    #       description: 'description'
-    #     }
-    #   ],
-    #   notify_url: 'the_url'
-    # }
-    #
-    # WechatPay::Direct.invoke_combine_transactions_in_h5(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_miniprogram
-    #
-    # 直连合单小程序下单
-    #
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_4.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   combine_out_trade_no: 'combine_out_trade_no',
-    #   combine_payer_info: {
-    #     openid: 'client open id'
-    #   },
-    #   sub_orders: [
-    #     {
-    #       mchid: 'mchid',
-    #       sub_mchid: 'sub mchid',
-    #       attach: 'attach',
-    #       amount: {
-    #         total_amount: 100,
-    #         currency: 'CNY'
-    #       },
-    #       out_trade_no: 'out_trade_no',
-    #       description: 'description'
-    #     }
-    #   ],
-    #   notify_url: 'the_url'
-    # }
-    #
-    # WechatPay::Direct.invoke_combine_transactions_in_miniprogram(params)
-    # ```
+    # @private
+    # @!macro [attach] define_transaction_method
+    #   直连$1下单
+    #
+    #   Document: $3
+    #
+    #   Example:
+    #
+    #   ``` ruby
+    #   params = {
+    #     appid: 'Your Open id',
+    #     mchid: 'Your Mch id'',
+    #     description: '回流',
+    #     out_trade_no: 'Checking',
+    #     payer: {
+    #       openid: 'oly6s5c'
+    #     },
+    #     amount: {
+    #       total: 1
+    #     },
+    #     notify_url: ENV['NOTIFICATION_URL']
+    #   }
+    #
+    #   WechatPay::Direct.invoke_transactions_in_$1(params)
+    #   ```
+    #   @!method invoke_transactions_in_$1
+    #   @!scope class
+    def self.define_transaction_method(key, value, _document)
+      const_set("INVOKE_TRANSACTIONS_IN_#{key.upcase}_FIELDS",
+                %i[description out_trade out_trade_no payer amount notify_url].freeze)
+      define_singleton_method "invoke_transactions_in_#{key}" do |params|
+        direct_transactions_method_by_suffix(value, params)
+      end
+    end
 
-    ##
-    # :singleton-method: invoke_combine_transactions_in_native
-    #
-    # 直连合单native下单
-    #
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_5.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   combine_out_trade_no: 'combine_out_trade_no',
-    #   sub_orders: [
-    #     {
-    #       mchid: 'mchid',
-    #       sub_mchid: 'sub mchid',
-    #       attach: 'attach',
-    #       amount: {
-    #         total_amount: 100,
-    #         currency: 'CNY'
-    #       },
-    #       out_trade_no: 'out_trade_no',
-    #       description: 'description'
-    #     }
-    #   ],
-    #   notify_url: 'the_url'
-    # }
-    #
-    # WechatPay::Direct.invoke_combine_transactions_in_native(params)
-    # ```
-    {
-      js: 'jsapi',
-      app: 'app',
-      h5: 'h5',
-      native: 'native',
-      miniprogram: 'jsapi'
-    }.each do |key, _value|
+    define_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_1.shtml')
+    define_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_1.shtml')
+    define_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_2_1.shtml')
+    define_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_3_1.shtml')
+    define_transaction_method('native', 'native', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_4_1.shtml')
+
+    # @private
+    # @!macro [attach] define_combine_transaction_method
+    #   直连合单$1下单
+    #
+    #   Document: $3
+    #
+    #   ``` ruby
+    #   params = {
+    #     combine_out_trade_no: 'combine_out_trade_no',
+    #     combine_payer_info: {
+    #       openid: 'client open id'
+    #     },
+    #     sub_orders: [
+    #       {
+    #         mchid: 'mchid',
+    #         sub_mchid: 'sub mchid',
+    #         attach: 'attach',
+    #         amount: {
+    #           total_amount: 100,
+    #           currency: 'CNY'
+    #         },
+    #         out_trade_no: 'out_trade_no',
+    #         description: 'description'
+    #       }
+    #     ],
+    #     notify_url: 'the_url'
+    #   }
+    #
+    #   WechatPay::Direct.invoke_combine_transactions_in_$1(params)
+    #   ```
+    #   @!method invoke_combine_transactions_in_$1
+    #   @!scope class
+    def self.define_combine_transaction_method(key, _value, _document)
       const_set("INVOKE_COMBINE_TRANSACTIONS_IN_#{key.upcase}_FIELDS",
                 %i[combine_out_trade_no scene_info sub_orders notify_url].freeze)
       define_singleton_method("invoke_combine_transactions_in_#{key}") do |params|
@@ -191,6 +90,12 @@ module WechatPay
       end
     end
 
+    define_combine_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_1.shtml')
+    define_combine_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_3.shtml')
+    define_combine_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_2.shtml')
+    define_combine_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_4.shtml')
+    define_combine_transaction_method('native', 'native', 'https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter5_1_5.shtml')
+
     QUERY_COMBINE_ORDER_FIELDS = %i[combine_out_trade_no].freeze # :nodoc:
     #
     # 合单查询
@@ -251,153 +156,6 @@ module WechatPay
       )
     end
 
-    ##
-    # :singleton-method: invoke_transactions_in_js
-    #
-    # 直连js下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   appid: 'Your Open id',
-    #   mchid: 'Your Mch id'',
-    #   description: '回流',
-    #   out_trade_no: 'Checking',
-    #   payer: {
-    #     openid: 'oly6s5c'
-    #   },
-    #   amount: {
-    #     total: 1
-    #   },
-    #   notify_url: ENV['NOTIFICATION_URL']
-    # }
-    #
-    # WechatPay::Direct.invoke_transactions_in_js(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_miniprogram
-    #
-    # 直连小程序下单
-    #
-    # Document:https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_1.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   appid: 'Your Open id',
-    #   mchid: 'Your Mch id'',
-    #   description: '回流',
-    #   out_trade_no: 'Checking',
-    #   payer: {
-    #     openid: 'oly6s5c'
-    #   },
-    #   amount: {
-    #     total: 1
-    #   },
-    #   notify_url: ENV['NOTIFICATION_URL']
-    # }
-    #
-    # WechatPay::Direct.invoke_transactions_in_miniprogram(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_app
-    #
-    # 直连APP下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_2_1.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   appid: 'Your Open id',
-    #   mchid: 'Your Mch id'',
-    #   description: '回流',
-    #   out_trade_no: 'Checking',
-    #   payer: {
-    #     openid: 'oly6s5c'
-    #   },
-    #   amount: {
-    #     total: 1
-    #   },
-    #   notify_url: ENV['NOTIFICATION_URL']
-    # }
-    #
-    # WechatPay::Direct.invoke_transactions_in_app(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_h5
-    #
-    # 直连h5下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_3_1.shtml
-    #
-    # Example:
-    #
-    # ```
-    # params = {
-    #   appid: 'Your Open id',
-    #   mchid: 'Your Mch id'',
-    #   description: '回流',
-    #   out_trade_no: 'Checking',
-    #   payer: {
-    #     openid: 'oly6s5c'
-    #   },
-    #   amount: {
-    #     total: 1
-    #   },
-    #   notify_url: ENV['NOTIFICATION_URL']
-    # }
-    #
-    # WechatPay::Direct.invoke_transactions_in_h5(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_native
-    #
-    # 直连native下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_4_1.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   appid: 'Your Open id',
-    #   mchid: 'Your Mch id'',
-    #   description: '回流',
-    #   out_trade_no: 'Checking',
-    #   payer: {
-    #     openid: 'oly6s5c'
-    #   },
-    #   amount: {
-    #     total: 1
-    #   },
-    #   notify_url: ENV['NOTIFICATION_URL']
-    # }
-    #
-    # WechatPay::Direct.invoke_transactions_in_native(params)
-    # ```
-    {
-      js: 'jsapi',
-      app: 'app',
-      h5: 'h5',
-      miniprogram: 'jsapi',
-      native: 'native'
-    }.each do |key, value|
-      const_set("INVOKE_TRANSACTIONS_IN_#{key.upcase}_FIELDS", %i[description out_trade out_trade_no payer amount notify_url].freeze)
-      define_singleton_method "invoke_transactions_in_#{key}" do |params|
-        direct_transactions_method_by_suffix(value, params)
-      end
-    end
-
     QUERY_ORDER_FIELDS = %i[out_trade_no transaction_id].freeze # :nodoc:
     #
     # 直连订单查询