wechat-pay 1.0.4 → 1.1.0

data/lib/wechat-pay/ecommerce/bill.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module WechatPay
+  # 账单相关
   module Ecommerce
     class<<self
       TRADEBILL_FIELDS = [:bill_date].freeze # :nodoc:

data/lib/wechat-pay/ecommerce/combine_order.rb

@@ -1,183 +1,43 @@
 # frozen_string_literal: true
 
 module WechatPay
+  # 合并订单相关
   module Ecommerce
-    ##
-    # :singleton-method: invoke_combine_transactions_in_native
-    #
-    # native合单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_5.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::Ecommerce.invoke_combine_transactions_in_native(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_h5
-    #
-    # h5合单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_2.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::Ecommerce.invoke_combine_transactions_in_h5(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_app
-    #
-    # app合单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_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::Ecommerce.invoke_combine_transactions_in_app(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_app
-    #
-    # js合单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_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::Ecommerce.invoke_combine_transactions_in_js(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_combine_transactions_in_miniprogram
-    #
-    # 小程序合单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_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::Ecommerce.invoke_combine_transactions_in_miniprogram(params)
-    # ```
-    {
-      js: 'jsapi',
-      app: 'app',
-      h5: 'h5',
-      native: 'native',
-      miniprogram: 'jsapi'
-    }.each do |key, value|
+    # @private
+    # @!macro [attach] define_transaction_method
+    #   $1合单
+    #
+    #   Document: $3
+    #
+    #   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::Ecommerce.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 combine_payer_info sub_orders notify_url].freeze)
       define_singleton_method("invoke_combine_transactions_in_#{key}") do |params|
@@ -185,6 +45,12 @@ module WechatPay
       end
     end
 
+    define_combine_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_3.shtml')
+    define_combine_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_2.shtml')
+    define_combine_transaction_method('native', 'native', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_5.shtml')
+    define_combine_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_1.shtml')
+    define_combine_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_4.shtml')
+
     QUERY_COMBINE_ORDER_FIELDS = %i[combine_out_trade_no].freeze # :nodoc:
     #
     # 合单查询

data/lib/wechat-pay/ecommerce/order.rb

@@ -1,112 +1,35 @@
 # frozen_string_literal: true
 
 module WechatPay
+  # 订单相关
   module Ecommerce
-    ##
-    # :singleton-method: invoke_transactions_in_js
-    # js下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_2.shtml
-    #
-    # Example:
-    #
-    # ```
-    # params = {
-    #   description: 'pay',
-    #   out_trade_no: 'Order Number',
-    #   payer: {
-    #     sp_openid: 'wechat open id'
-    #   },
-    #   amount: {
-    #     total: 10
-    #   },
-    #   sub_mchid: 'Your sub mchid',
-    #   notify_url: 'the url'
-    # }
-    #
-    # WechatPay::Ecommerce.invoke_transactions_in_js(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_app
-    #
-    # App下单
-    #
-    # https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_1.shtml
-    #
-    # Example:
-    #
-    # ```
-    # params = {
-    #   description: 'pay',
-    #   out_trade_no: 'Order Number',
-    #   payer: {
-    #     sp_openid: 'wechat open id'
-    #   },
-    #   amount: {
-    #     total: 10
-    #   },
-    #   sub_mchid: 'Your sub mchid',
-    #   notify_url: 'the url'
-    # }
-    #
-    # WechatPay::Ecommerce.invoke_transactions_in_app(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_h5
-    #
-    # h5下单
-    #
-    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_4.shtml
-    #
-    # Example:
-    #
-    # ``` ruby
-    # params = {
-    #   description: 'pay',
-    #   out_trade_no: 'Order Number',
-    #   amount: {
-    #     total: 10
-    #   },
-    #   sub_mchid: 'Your sub mchid',
-    #   notify_url: 'the url'
-    # }
-    #
-    # WechatPay::Ecommerce.invoke_transactions_in_h5(params)
-    # ```
-
-    ##
-    # :singleton-method: invoke_transactions_in_miniprogram
-    #
-    # 小程序下单
-    #
-    # Document:
-    #
-    # Example:
-    #
-    # ```
-    # params = {
-    #   description: 'pay',
-    #   out_trade_no: 'Order Number',
-    #   payer: {
-    #     sp_openid: 'wechat open id'
-    #   },
-    #   amount: {
-    #     total: 10
-    #   },
-    #   sub_mchid: 'Your sub mchid',
-    #   notify_url: 'the url'
-    # }
-    #
-    # WechatPay::Ecommerce.invoke_transactions_in_miniprogram(params)
-    # ```
-    {
-      js: 'jsapi',
-      app: 'app',
-      h5: 'h5',
-      miniprogram: 'jsapi'
-    }.each do |key, value|
+    # @private
+    # @!macro [attach] define_transaction_method
+    #   $1下单
+    #
+    #   Document: $3
+    #
+    #   Example:
+    #
+    #   ```
+    #   params = {
+    #     description: 'pay',
+    #     out_trade_no: 'Order Number',
+    #     payer: {
+    #       sp_openid: 'wechat open id'
+    #     },
+    #     amount: {
+    #       total: 10
+    #     },
+    #     sub_mchid: 'Your sub mchid',
+    #     notify_url: 'the url'
+    #   }
+    #
+    #   WechatPay::Ecommerce.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[sub_mchid description out_trade_no notify_url amount].freeze)
       define_singleton_method("invoke_transactions_in_#{key}") do |params|
@@ -114,6 +37,12 @@ module WechatPay
       end
     end
 
+    define_transaction_method('native', 'native', 'document missing')
+    define_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_2.shtml')
+    define_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_1.shtml')
+    define_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_4.shtml')
+    define_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_3.shtml')
+
     QUERY_ORDER_FIELDS = %i[sub_mchid out_trade_no transaction_id].freeze # :nodoc:
     #
     # 订单查询

data/lib/wechat-pay/ecommerce/profitsharing.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module WechatPay
+  # 分账相关
   module Ecommerce
     class << self
       REQUEST_PROFITSHARING_FIELDS = %i[out_trade_no transaction_id sub_mchid out_order_no receivers finish].freeze # :nodoc:

data/lib/wechat-pay/ecommerce/refund.rb

@@ -1,136 +1,135 @@
 # frozen_string_literal: true
 
 module WechatPay
+  # 退款相关
   module Ecommerce
-    class << self
-      INVOKE_REFUND_FIELDS = %i[sub_mchid out_trade_no total refund out_refund_no].freeze # :nodoc:
-      #
-      # 退款申请
-      #
-      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_1.shtml
-      #
-      # Example:
-      #
-      # ``` ruby
-      # WechatPay::Ecommerce.invoke_refund(sub_mchid: '1600000', transaction_id: '4323400972202104305131070170', total: 1, refund: 1, description: '退款', out_refund_no: 'R10000') # by transaction_id
-      # WechatPay::Ecommerce.invoke_refund(sub_mchid: '1608977559', total: 1, refund: 1, description: '退款', out_trade_no: 'N202104302474', out_refund_no: 'R10000') # by out_trade_no
-      # ```
-      def invoke_refund(params)
-        url = '/v3/ecommerce/refunds/apply'
-        method = 'POST'
-        amount = {
-          refund: params.delete(:refund),
-          total: params.delete(:total),
-          currency: 'CNY'
-        }
+    INVOKE_REFUND_FIELDS = %i[sub_mchid out_trade_no total refund out_refund_no].freeze # :nodoc:
+    #
+    # 退款申请
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_1.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.invoke_refund(sub_mchid: '1600000', transaction_id: '4323400972202104305131070170', total: 1, refund: 1, description: '退款', out_refund_no: 'R10000') # by transaction_id
+    # WechatPay::Ecommerce.invoke_refund(sub_mchid: '1608977559', total: 1, refund: 1, description: '退款', out_trade_no: 'N202104302474', out_refund_no: 'R10000') # by out_trade_no
+    # ```
+    def self.invoke_refund(params)
+      url = '/v3/ecommerce/refunds/apply'
+      method = 'POST'
+      amount = {
+        refund: params.delete(:refund),
+        total: params.delete(:total),
+        currency: 'CNY'
+      }
 
-        params = params.merge({
-                                amount: amount,
-                                sp_appid: WechatPay.app_id
-                              })
+      params = params.merge({
+                              amount: amount,
+                              sp_appid: WechatPay.app_id
+                            })
 
-        make_request(
-          path: url,
-          method: method,
-          for_sign: params.to_json,
-          payload: params.to_json
-        )
-      end
+      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_partner/apis/chapter7_6_2.shtml
-      #
-      # Example:
-      #
-      # ``` ruby
-      # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', out_refund_no: 'N202104302474') # 注意这里的out_refund_no用的是商户订单号，微信文档有误
-      # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', refund_id: '420000103020210508005624628') # 注意这里的refund_id用的是微信交易单号transaction_id，微信文档有误
-      # ```
-      #
-      def query_refund(params)
-        if params[:refund_id]
-          params.delete(:out_refund_no)
-          refund_id = params.delete(:refund_id)
-          path = "/v3/pay/partner/transactions/id/#{refund_id}"
-        else
-          params.delete(:refund_id)
-          out_refund_no = params.delete(:out_refund_no)
-          path = "/v3/pay/partner/transactions/out-trade-no/#{out_refund_no}"
-        end
+    QUERY_REFUND_FIELDS = %i[sub_mchid refund_id out_refund_no].freeze # :nodoc:
+    #
+    # 退款查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_2.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', out_refund_no: 'N202104302474') # 注意这里的out_refund_no用的是商户订单号，微信文档有误
+    # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', refund_id: '420000103020210508005624628') # 注意这里的refund_id用的是微信交易单号transaction_id，微信文档有误
+    # ```
+    #
+    def self.query_refund(params)
+      if params[:refund_id]
+        params.delete(:out_refund_no)
+        refund_id = params.delete(:refund_id)
+        path = "/v3/pay/partner/transactions/id/#{refund_id}"
+      else
+        params.delete(:refund_id)
+        out_refund_no = params.delete(:out_refund_no)
+        path = "/v3/pay/partner/transactions/out-trade-no/#{out_refund_no}"
+      end
 
-        params = params.merge({
-                                sp_mchid: WechatPay.mch_id
-                              })
+      params = params.merge({
+                              sp_mchid: WechatPay.mch_id
+                            })
 
-        method = 'GET'
-        query = build_query(params)
-        url = "#{path}?#{query}"
+      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
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
 
-      RETURN_ADVANCE_REFUND_FIELDS = %i[refund_id sub_mchid].freeze # :nodoc:
-      #
-      # 垫付退款回补
-      #
-      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_4.shtml
-      #
-      # Example:
-      #
-      # ``` ruby
-      # WechatPay::Ecommerce.return_advance_refund(refund_id: '50300908092021043008398036516', sub_mchid: '160000')
-      # ```
-      #
-      def return_advance_refund(params)
-        refund_id = params.delete(:refund_id)
-        url = "/v3/ecommerce/refunds/#{refund_id}/return-advance"
-        method = 'POST'
+    RETURN_ADVANCE_REFUND_FIELDS = %i[refund_id sub_mchid].freeze # :nodoc:
+    #
+    # 垫付退款回补
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_4.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.return_advance_refund(refund_id: '50300908092021043008398036516', sub_mchid: '160000')
+    # ```
+    #
+    def self.return_advance_refund(params)
+      refund_id = params.delete(:refund_id)
+      url = "/v3/ecommerce/refunds/#{refund_id}/return-advance"
+      method = 'POST'
 
-        make_request(
-          path: url,
-          method: method,
-          for_sign: params.to_json,
-          payload: params.to_json
-        )
-      end
+      make_request(
+        path: url,
+        method: method,
+        for_sign: params.to_json,
+        payload: params.to_json
+      )
+    end
 
-      QUERY_RETURN_ADVANCE_REFUND_FIELDS = %i[sub_mchid refund_id].freeze # :nodoc:
-      #
-      # 退款查询
-      #
-      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_2.shtml
-      #
-      # Example:
-      #
-      # ``` ruby
-      # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', out_refund_no: 'N202104302474') # 注意这里的out_refund_no用的是商户订单号，微信文档有误
-      # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', refund_id: '420000103020210508005624628') # 注意这里的refund_id用的是微信交易单号transaction_id，微信文档有误
-      # ```
-      #
-      def query_return_advance_refund(params)
-        refund_id = params.delete(:refund_id)
-        path = "/v3/ecommerce/refunds/#{refund_id}/return-advance"
-        method = 'GET'
-        query = build_query(params)
-        url = "#{path}?#{query}"
+    QUERY_RETURN_ADVANCE_REFUND_FIELDS = %i[sub_mchid refund_id].freeze # :nodoc:
+    #
+    # 退款查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_6_2.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', out_refund_no: 'N202104302474') # 注意这里的out_refund_no用的是商户订单号，微信文档有误
+    # WechatPay::Ecommerce.query_refund(sub_mchid: '16000000', refund_id: '420000103020210508005624628') # 注意这里的refund_id用的是微信交易单号transaction_id，微信文档有误
+    # ```
+    #
+    def self.query_return_advance_refund(params)
+      refund_id = params.delete(:refund_id)
+      path = "/v3/ecommerce/refunds/#{refund_id}/return-advance"
+      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
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
     end
   end
 end