wechat-pay 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f70f650e820e974fc587e7913dbd17290c515f77ce5666e6267fcd5a8dadce7
-  data.tar.gz: 77b844c39432a5141b3ed9a837e03e3d07657b9668b9001828d479072dc20d79
+  metadata.gz: eb2eeb9cdeaa2ba383bb18c50fa4b3f9962fef6433b45792a48e5eb0bbf72339
+  data.tar.gz: 72ac02d6d3e687fb4ec457ca3ef49e0e1a433a75bfe53955936b2a0308df7098
 SHA512:
-  metadata.gz: 0ce9abbf28b2bc2e49a2c45ca0b6ce732dd4707e241fd065e7d8408e4ce09c9f23b97d73fa9b48dda9efd49ca6055e42130df7f7e30f0f0fbd875932dd530cc1
-  data.tar.gz: 8f590370a5cb1b0aacaeb874edad07325c72cc6391f4247efbb20bbccb731f7d9dc44a7815de3a6c9e8c19ca1c03683390b96fb4a6913f3d732ae3e3d2bdef29
+  metadata.gz: 35bfafd7b998abc6b03354acc1cee71facbfa5be198be03b4c0e9f4acfa6d1c1a93f779bb0bc8b37a234c967a5c47f43f7bb14f38a9386e0f834b4f88a533a9d
+  data.tar.gz: f3f912b410f6b391449157a65bd9cbf35ada56daf553cf2ad177c58b4ae96ee215496aaf1085fcec75742df8d8c60ba87d6ecd3c855e6f383e813ca3dd8149b2

data/.github/workflows/{test.yml → code_quality.yml}

@@ -29,5 +29,7 @@ jobs:
       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/.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/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Next Release
+
+## 1.0.7 (05/16/2021)
+
+* Change `WechatPay::Ecommerce.get_certificates` to `WechatPay::Ecommerce.certificates`
+* Refactor code and document.

data/Gemfile

@@ -13,4 +13,3 @@ gemspec
 # your gem to rubygems.org.
 
 # To use debugger
-gem 'rubocop', require: false

data/README.md

@@ -62,7 +62,7 @@ def download_certificate
   download_path = 'Your Download Path'
   raise '必须提供证书下载路径' if download_path.blank?
 
-  response = WechatPay::Ecommerce.get_certificates
+  response = WechatPay::Ecommerce.certificates
 
   raise '证书下载失败' unless response.code == 200
 

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
 
-  task :default => :spec
+  task default: :spec
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 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:
     #
     # 直连订单查询