wechat-pay-next 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b608cb6babc9646f8af22de6992a171f98e9e35702712b2b98b56eb0502d34b
+  data.tar.gz: 010ff2401e5dcf60824d10da640ac4f2621100c3cb4936a32c325f21a3cbe595
+SHA512:
+  metadata.gz: c7f42f5df83e02f1035ea4235f6c20a0f98b27e4c48b1507762897d4e7c5020c2c1eb906c5774b8f10850840589a9f490afaa1c3b86ff74d655f02766dfebc82
+  data.tar.gz: fae96a73bc93f0382d078533e970ca88e6f1643e40988ad6ec392869816bbd01dad5f6937453f7bb1b3c18ae19b4e1e3703c773c155943ac173664850a8d087d

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

@@ -0,0 +1,371 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'wechat-pay/helper'
+
+module WechatPay
+  # # 直连商户相关接口封装（常用的已有，待完善）
+  # 文档: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_1_1.shtml
+  module Direct
+    include WechatPayHelper
+
+    # @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
+
+    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|
+        WechatPay::Ecommerce.send("invoke_combine_transactions_in_#{key}", params)
+      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:
+    #
+    # 合单查询
+    #
+    # TODO: 与电商平台相同，稍后重构
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_11.shtml
+    #
+    # ``` ruby
+    # WechatPay::Direct.query_order(combine_out_trade_no: 'C202104302474')
+    # ```
+    #
+    def self.query_combine_order(params)
+      combine_out_trade_no = params.delete(:combine_out_trade_no)
+
+      url = "/v3/combine-transactions/out-trade-no/#{combine_out_trade_no}"
+
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    CLOSE_COMBINE_ORDER_FIELDS = %i[combine_out_trade_no sub_orders].freeze # :nodoc:
+    #
+    # 关闭合单
+    #
+    # TODO: 与电商平台相同，稍后重构
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_11.shtml
+    #
+    # ``` ruby
+    # WechatPay::Direct.close_combine_order(combine_out_trade_no: 'C202104302474')
+    # ```
+    def self.close_combine_order(params)
+      combine_out_trade_no = params.delete(:combine_out_trade_no)
+
+      url = "/v3/combine-transactions/out-trade-no/#{combine_out_trade_no}/close"
+
+      payload = {
+        combine_appid: WechatPay.app_id
+      }.merge(params)
+
+      payload_json = payload.to_json
+
+      method = 'POST'
+
+      make_request(
+        method: method,
+        for_sign: payload_json,
+        payload: payload_json,
+        path: url
+      )
+    end
+
+    QUERY_ORDER_FIELDS = %i[out_trade_no transaction_id].freeze # :nodoc:
+    #
+    # 直连订单查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_2.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Direct.query_order(transaction_id: '4323400972202104305133344444') # by transaction_id
+    # WechatPay::Direct.query_order(out_trade_no: 'N202104302474') # by out_trade_no
+    # ```
+    #
+    def self.query_order(params)
+      if params[:transaction_id]
+        params.delete(:out_trade_no)
+        transaction_id = params.delete(:transaction_id)
+        path = "/v3/pay/transactions/id/#{transaction_id}"
+      else
+        params.delete(:transaction_id)
+        out_trade_no = params.delete(:out_trade_no)
+        path = "/v3/pay/transactions/out-trade-no/#{out_trade_no}"
+      end
+
+      params = params.merge({
+                              mchid: WechatPay.mch_id
+                            })
+
+      method = 'GET'
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    CLOSE_ORDER_FIELDS = %i[out_trade_no].freeze # :nodoc:
+    #
+    # 关闭订单
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_3.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Direct.close_order(out_trade_no: 'N3344445')
+    # ```
+    #
+    def self.close_order(params)
+      out_trade_no = params.delete(:out_trade_no)
+      url = "/v3/pay/transactions/out-trade-no/#{out_trade_no}/close"
+      params = params.merge({
+                              mchid: WechatPay.mch_id
+                            })
+
+      method = 'POST'
+
+      make_request(
+        method: method,
+        path: url,
+        for_sign: params.to_json,
+        payload: params.to_json
+      )
+    end
+
+    INVOKE_REFUND_FIELDS = %i[transaction_id out_trade_no out_refund_no amount].freeze # :nodoc:
+    #
+    # 退款申请
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_9.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Direct.invoke_refund(transaction_id: '4323400972202104305131070170', total: 1, refund: 1, out_refund_no: 'R10000')
+    # WechatPay::Direct.invoke_refund(out_trade_no: 'N2021', total: 1, refund: 1, out_refund_no: 'R10000').body
+    # ```
+    def self.invoke_refund(params)
+      url = '/v3/refund/domestic/refunds'
+      method = 'POST'
+      amount = {
+        refund: params.delete(:refund),
+        total: params.delete(:total),
+        currency: 'CNY'
+      }
+
+      params = params.merge({
+                              amount: amount
+                            })
+
+      make_request(
+        path: url,
+        method: method,
+        for_sign: params.to_json,
+        payload: params.to_json
+      )
+    end
+
+    QUERY_REFUND_FIELDS = %i[sub_mchid refund_id out_refund_no].freeze # :nodoc:
+    #
+    # 直连退款查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_10.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Direct.query_refund(out_refund_no: 'R10000')
+    # ```
+    #
+    def self.query_refund(params)
+      out_refund_no = params.delete(:out_refund_no)
+      url = "/v3/refund/domestic/refunds/#{out_refund_no}"
+
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    TRADEBILL_FIELDS = [:bill_date].freeze # :nodoc:
+    #
+    # 直连申请交易账单
+    #
+    # Todo: 跟商户平台接口相同
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_6.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::direct.tradebill(bill_date: '2021-04-30')
+    # ```
+    def self.tradebill(params)
+      path = '/v3/bill/tradebill'
+      method = 'GET'
+
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    FUNDFLOWBILL_FIELDS = [:bill_date].freeze # :nodoc:
+    #
+    # 申请资金账单
+    #
+    # Todo: 跟商户平台接口相同
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter3_5_7.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Direct.fundflowbill(bill_date: '2021-04-30')
+    # ```
+    #
+    def self.fundflowbill(params)
+      path = '/v3/bill/fundflowbill'
+      method = 'GET'
+
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    class << self
+      private
+
+      def direct_transactions_method_by_suffix(suffix, params)
+        url = "/v3/pay/transactions/#{suffix}"
+        method = 'POST'
+
+        params = {
+          mchid: WechatPay.mch_id,
+          appid: WechatPay.app_id
+        }.merge(params)
+
+        payload_json = params.to_json
+
+        make_request(
+          method: method,
+          path: url,
+          for_sign: payload_json,
+          payload: payload_json
+        )
+      end
+    end
+  end
+end