wechat_payment 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c25024b1f10c62e7ddd1d03489d9d6464f51f1e0540a981574685099ed0c9e
-  data.tar.gz: ba71d84612d41cdde00a24994237b2d9339d47689e61005695bbb0a15c5f4dda
+  metadata.gz: 2a2e445d0e1ce0d2cc83eef761a18bbd90ade6264e2798e2ce0a1bc1756b9139
+  data.tar.gz: bcfbaf1b877b6a7656cb378a894293c593e96862b018c9415eac13ed00063961
 SHA512:
-  metadata.gz: '090abcf0b7ffacad8b5dd22bf5cd0d82938b68a6b4d156ffda335e3672f2c3136e8bf63fa1961d465d74561c951bf86876836154c11ef69d1577e18f46d439f7'
-  data.tar.gz: 5c391978e493f2ca85f61595c758bb209d14f2700205150d5156e65e88b230fadd1ebfd4899f071a53ed415b314cc02d4ec0826a09183c036aac53150acc0aca
+  metadata.gz: e3157ecac086e7f9d491d1359f4ce3de8208068f277a041c9a57d9b20abd6406d1648fce5d11c25f6cbc9d8f6aea64b24e2477383c73a775212b2ac11d42bf2c
+  data.tar.gz: 3e41d27212801e96e9c359cb60a6a51f6c7e63cd4dbcbcd3deaba2c0ee72c13a55423e538422b1ff952602ef05717cb5df3c6d0a75dda131c6f3befff9aa6dcd

data/README.md

@@ -1,28 +1,230 @@
 # WechatPayment
-Short description and motivation.
+微信支付的 engine
 
-## Usage
-How to use my plugin.
 
-## Installation
-Add this line to your application's Gemfile:
+## Convention
+在使用该 Engine 之前，需要先建立`用户模型`，`商品模型`，`用户商品关联模型`，用户表需要有 open_id 字段,
+商品表需要有 price 和 name 字段。假设`商品模型`为`Product`，则用户和商品之间的关联模型为`UserProduct`，
+关联模型属于`user`和`product`。
+
+## Getting Started
+1. 在`Gemfile`中添加
+   ```ruby
+     gem 'wechat_payment'
+   ```
+
+2. 执行 `bundle install`
+
+3. 初始化
+   ```bash
+   # rails g wechat_payment:install [GoodsModel] [UserModel]
+   $ rails g wechat_payment:install Product User
+   $ rails db:migrate
+   ```
+
+## 配置
+打开 `config/initializers/wechat_payment.rb`，將里边的配置改成你自己的小程序配置
+
+## 支付
+用户模型具有`buy`方法，而商品模型有`sell`方法，用户购买商品或商品售出都会产生一张订单，
+调用订单的`pay`方法则会向微信发起下单请求，并将处理后的结果返回，此时返回的是一个`ServiceResult`对象，
+执行该对象的`as_json`方法，得到的就是小程序需要拉起支付的参数
+
+```ruby
+user = User.first
+
+product = Product.first
+
+# 微信要传一个用户调起支付的 ip: spbill_create_ip ，文档上写必传，但是传空、固定ip、不传都不会报错，
+# 但是还是给他加上了，保存到用户模型的 last_spbill_create_ip 属性上，实际使用中可以
+# 在控制器里边通过 request.remote_ip 获取请求的 ip
+# 
+# user.spbill_create_ip = request.remote_ip
+client_ip = "45.12.112.31"  
+user.spbill_create_ip = client_ip
+
+order = user.buy(product)
+
+result = order.pay 
+
+# 返回给前端调起支付的数据
+result.as_json
+```
+
+## 退款
+调用订单的`refund`，参数是退款金额，默认全额退款，执行成功后会创建一张退款订单，此时退款订单状态为 pending，
+并返回退款下单的结果(`SerivceResult`对象)，如果成功，触发用户商品关联模型的`refund_apply_success`，
+失败则触发`refund_apply_failure`
 
 ```ruby
-gem 'wechat_payment'
+payment_order = User.first.payment_orders.last
+result = payment_order.refund
+
+if result.success?
+   # do something on success
+else
+   # do something on failure
+end
 ```
 
-And then execute:
-```bash
-$ bundle
+## 事件
+当支付进行时，会产生一些相应的事件，事件会触发相应的钩子，如果有事先定义的话。钩子方法需定义在用户商品关联(如`UserProduct`)模型中，
+且每个钩子接收一个参数 result ，事件和钩子的对应关系如下：
+
+|        事件       |        钩子       |
+|  :-------------- | :--------------- |
+| 支付下单成功        | payment_apply_success |
+| 支付下单失败        | payment_apply_failure |
+| 支付成功(回调)      | payment_exec_success |
+| 支付失败(回调)      | payment_exec_failure |
+| 申请退款成功        | refund_apply_success |
+| 申请退款失败        | refund_apply_failure |
+| 退款成功(回调)      | refund_exec_success |
+| 退款失败(回调)      | refund_exec_failure |
+
+一个简单的事件处理的例子
+```ruby
+# app/model/user_product.rb
+class UserProduct
+   # result 结构见下文说明
+  def payment_exec_success(result)
+    update(state: :paid)
+  end
+end
 ```
 
-Or install it yourself as:
-```bash
-$ gem install wechat_payment
+每个钩子接收的参数结构可能不一样:
+
+### payment_apply_success:
+```ruby
+{
+   "return_code"=>"SUCCESS",
+   "return_msg"=>"OK",
+   "result_code"=>"SUCCESS",
+   "mch_id"=>"12312412312",
+   "appid"=>"wxc5acd06cc6a7ac12",
+   "sub_mch_id"=>"1526921451",
+   "sub_appid"=>"wxf89f912345823dcd",
+   "nonce_str"=>"ZUN2rEf6ATgYU8Lr",
+   "sign"=>"3A216DB61196CE2313CE21182D53FD1833F",
+   "prepay_id"=>"wx2815535651598812181c452eb3f26b90000",
+   "trade_type"=>"JSAPI"
+}
 ```
 
+###  payment_apply_failure:
+```ruby
+{
+   "return_code"=>"SUCCESS",
+   "return_msg"=>"OK",
+   "result_code"=>"FAIL",
+   "err_code_des"=>"该订单已支付",
+   "err_code"=>"ORDERPAID",
+   "mch_id"=>"12312412312",
+   "appid"=>"wxc5acd06cc6a7ac12",
+   "sub_mch_id"=>"1526921451",
+   "sub_appid"=>"wxf89f912345823dcd",
+   "nonce_str"=>"1jWLkg2YZjwnOozl",
+   "sign"=>"3C210A1C9BD6CFDB7C37CCFCA1AAF9E274"
+} 
+```
+
+### payment_exec_success:
+```ruby
+{
+   "appid" => "wxc5acd06cc6a7ac12",
+   "bank_type" => "CMB_CREDIT",
+   "cash_fee" => "1",
+   "fee_type" => "CNY",
+   "is_subscribe" => "N",
+   "mch_id" => "12312412312",
+   "nonce_str" => "e42ad44489a1f4e6f8a09d1299cfa59f6",
+   "openid" => "oef2nsaOcYcBYrNq1x9eUucKy7NQ",
+   "out_trade_no" => "16267654023120174189",
+   "result_code" => "SUCCESS",
+   "return_code" => "SUCCESS",
+   "sign" => "608972A854024030332360B1E79511B4",
+   "sub_appid" => "wxf89f912345823dcd",
+   "sub_is_subscribe" => "N",
+   "sub_mch_id" => "1526921451",
+   "sub_openid" => "oef2nsaOcYcBYrNq1x9eUucKy7NQ",
+   "time_end" => "20210720151228",
+   "total_fee" => "1",
+   "trade_type" => "JSAPI",
+   "transaction_id" => "4200001153233202137201270712453"
+}
+```
+
+### payment_exec_failure:
+TODO 待补充
+
+### refund_apply_success:
+```ruby
+{
+   "return_code"=>"SUCCESS",
+   "return_msg"=>"OK",
+   "appid"=>"wxc5acd06cc6a7ac12",
+   "mch_id"=>"12312412312",
+   "sub_mch_id"=>"1526921451",
+   "nonce_str"=>"RsXVcs0GMg2p5NRD",
+   "sign"=>"F10AB3929B900DE4E189CA93B12D9D7A",
+   "result_code"=>"SUCCESS",
+   "transaction_id"=>"420000119112202101210049902399",
+   "out_trade_no"=>"1624867410141191608",
+   "out_refund_no"=>"16248674504421685776",
+   "refund_id"=>"50301108952025421210183695009",
+   "refund_channel"=>"",
+   "refund_fee"=>"1",
+   "coupon_refund_fee"=>"0",
+   "total_fee"=>"1",
+   "cash_fee"=>"1",
+   "coupon_refund_count"=>"0",
+   "cash_refund_fee"=>"1"
+}
+```
+
+### refund_apply_failure:
+```ruby
+{
+   "return_code"=>"SUCCESS",
+   "return_msg"=>"OK",
+   "appid"=>"wxc5acd06cc6a7ac12",
+   "mch_id"=>"12312412312",
+   "sub_mch_id"=>"1526921451",
+   "nonce_str"=>"gMDFilvaKanXW80W",
+   "sign"=>"BA24E81B18B12AAC112DF9F84CA5E21",
+   "result_code"=>"FAIL",
+   "err_code"=>"INVALID_REQUEST",
+   "err_code_des"=>"订单已全额退款"
+}
+
+```
+
+### refund_exec_success:
+```ruby
+{
+   "out_refund_no"=>"16421102919350974",
+   "out_trade_no"=>"1626761001219492162",
+   "refund_account"=>"REFUND_SOURCE_RECHARGE_FUNDS",
+   "refund_fee"=>"1",
+   "refund_id"=>"503014086722221012110826014924",
+   "refund_recv_accout"=>"招商银行信用卡4012",
+   "refund_request_source"=>"API",
+   "refund_status"=>"SUCCESS",
+   "settlement_refund_fee"=>"1",
+   "settlement_total_fee"=>"1",
+   "success_time"=>"2021-07-20 15:11:52",
+   "total_fee"=>"1",
+   "transaction_id"=>"42000011872021002028121998431"
+}
+```
+
+### refund_exec_failure:
+TODO 待补充
+
+
 ## Contributing
 Contribution directions go here.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,5 +1,10 @@
 require "bundler/setup"
 
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
 require "bundler/gem_tasks"
 
 require "rake/testtask"

data/app/assets/config/wechat_payment_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/wechat_payment .css

data/app/assets/stylesheets/wechat_payment/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/wechat_payment/application_controller.rb

@@ -0,0 +1,5 @@
+module WechatPayment
+  class ApplicationController < ActionController::Base
+    skip_forgery_protection
+  end
+end

data/app/controllers/wechat_payment/callback_controller.rb

@@ -0,0 +1,30 @@
+
+module WechatPayment
+  class CallbackController < WechatPayment::ApplicationController
+
+    # 微信支付回调
+    def payment
+      result = Hash.from_xml(request.body.read)["xml"]
+
+      process_result = WechatPayment::Service.handle_payment_notify(result)
+      if process_result.success?
+        render xml: { return_code: "SUCCESS" }.to_xml(root: 'xml', dasherize: false)
+      else
+        render xml: { return_code: "FAIL", return_msg: process_result.errors.first }.to_xml(root: 'xml', dasherize: false)
+      end
+    end
+
+    def refund
+      callback_info = Hash.from_xml(request.body.read)["xml"]["req_info"]
+      refund_result = WechatPayment::Service.handle_refund_notify(callback_info)
+
+      if refund_result.success?
+        render xml: {return_code: "SUCCESS"}.to_xml(root: 'xml', dasherize: false)
+      else
+        render xml: {return_code: "FAIL", return_msg: refund_result.errors.first}.to_xml(root: 'xml', dasherize: false)
+      end
+
+    end
+
+  end
+end

data/app/helpers/wechat_payment/application_helper.rb

@@ -0,0 +1,4 @@
+module WechatPayment
+  module ApplicationHelper
+  end
+end

data/app/jobs/wechat_payment/application_job.rb

@@ -0,0 +1,4 @@
+module WechatPayment
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/wechat_payment/application_mailer.rb

@@ -0,0 +1,6 @@
+module WechatPayment
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/wechat_payment/application_record.rb

@@ -0,0 +1,5 @@
+module WechatPayment
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/wechat_payment/payment_order.rb

@@ -0,0 +1,228 @@
+module WechatPayment
+  class PaymentOrder < ApplicationRecord
+
+    has_many :refund_orders
+    belongs_to :customer, polymorphic: true
+
+    before_save :set_customer_info
+    before_create :gen_out_trade_no
+    belongs_to :goods, polymorphic: true
+
+    enum state: {
+      paid: "paid",
+      pending: "pending",
+      refunded: "refunded",
+      failed: "failed"
+    }, _default: "pending"
+
+    # 将部分用户信息保存至订单
+    def set_customer_info
+      self.open_id = customer.open_id if open_id.blank?
+      self.spbill_create_ip = customer.spbill_create_ip
+    end
+
+    # 生成交易编号
+    def gen_out_trade_no
+      loop do
+        out_trade_no = "#{Time.current.to_i}#{SecureRandom.random_number(999_999_999)}"
+        records_count = WechatPayment::PaymentOrder.where(out_trade_no: out_trade_no).count
+        if records_count == 0
+          self.out_trade_no = out_trade_no
+          break
+        end
+      end
+    end
+
+    # 创建退款订单
+    def create_refund_order(refund_fee)
+      refund_orders.create(
+        out_trade_no: out_trade_no,
+        refund_fee: refund_fee,
+        total_fee: total_fee,
+        goods: goods,
+        customer: customer
+      )
+    end
+
+    def as_order_params
+      {
+        out_trade_no: out_trade_no,
+        spbill_create_ip: spbill_create_ip,
+        total_fee: total_fee,
+        body: body,
+        openid: open_id
+      }
+    end
+
+    # 发起支付
+    #
+    # @return [Hash]
+    #
+    # return example
+    # {
+    #   "appId": "wxf89f9547da823dcd",
+    #   "package": "prepay_id=wx28180521320799e04f6028c55c31bf0000",
+    #   "nonceStr": "62350ff6c414946d0dc4c49b32ad3fd3",
+    #   "timeStamp": "1624874721",
+    #   "signType": "MD5",
+    #   "paySign": "1F5CBC345B86E5DD055F235A22961422",
+    #   "orderId": 17
+    # }
+    def pay
+      order_result = WechatPayment::Service.new(self).order
+      if order_result.success?
+        payload = WechatPayment::Client.gen_js_pay_payload(order_result.data).merge(orderId: id).with_indifferent_access
+        WechatPayment::ServiceResult.new(success: true, data: payload)
+      else
+        order_result
+      end
+    end
+
+    # 重新支付订单
+    def repay
+      gen_out_trade_no
+      save
+      pay
+    end
+
+    # 发起退款
+    # @param [Integer] refund_fee 需要退款的金额，单位：分
+    def refund(refund_fee = total_fee)
+      WechatPayment::Service.new(self).refund(refund_fee)
+    end
+
+    # 判断余额是否足够退款
+    def balance_enough_to_refund?(refund_fee)
+      total_fee - refunded_fee >= refund_fee
+    end
+
+    # 已退款的金额(包括正在退款的金额)
+    def refunded_fee
+      refund_orders.where(state: [:pending, :refunded]).sum(:refund_fee)
+    end
+
+    # 实际已退的金额
+    def actual_refunded_fee
+      refund_orders.where(state: :refunded).sum(:refund_fee)
+    end
+
+    # 订单是否可以退款
+    def refundable?
+      min_refund_fee = 1
+      paid? && balance_enough_to_refund?(min_refund_fee)
+    end
+
+    # 支付下单成功
+    # @param [Hash] result
+    #
+    # result example:
+    #
+    # {
+    #   "return_code"=>"SUCCESS",
+    #   "return_msg"=>"OK",
+    #   "result_code"=>"SUCCESS",
+    #   "mch_id"=>"12312412312",
+    #   "appid"=>"wxc5f26065c6471234",
+    #   "sub_mch_id"=>"1525911234",
+    #   "sub_appid"=>"wxf89f912345823dcd",
+    #   "nonce_str"=>"ZUN2rEf6ATgYU8Lr",
+    #   "sign"=>"3A216DB61196CEC63CE282D53FD1833F",
+    #   "prepay_id"=>"wx281553565159884f81c452eb3f26b90000",
+    #   "trade_type"=>"JSAPI"
+    # }
+    def payment_apply_success(result)
+      update(prepay_id: result["prepay_id"])
+
+      if goods.respond_to? :payment_apply_success
+        goods.payment_apply_success(result)
+      end
+
+      result
+    end
+
+    # 支付下单失败
+    # @param [Hash] result
+    #
+    # result example:
+    #
+    # {
+    #  "return_code"=>"SUCCESS",
+    #  "return_msg"=>"OK",
+    #  "result_code"=>"FAIL",
+    #  "err_code_des"=>"该订单已支付",
+    #  "err_code"=>"ORDERPAID",
+    #  "mch_id"=>"1363241802",
+    #  "appid"=>"wxc5f26065c6471bcf",
+    #  "sub_mch_id"=>"1525918291",
+    #  "sub_appid"=>"wxf89f9547da823dcd",
+    #  "nonce_str"=>"1jWLkg2YZjwnOozl",
+    #  "sign"=>"3C80A1C9BD6CFDB7C37CCFCEAAF9E274"
+    # }
+    def payment_apply_failure(result)
+      update(state: :failed)
+
+      if goods.respond_to? :payment_apply_failure
+        goods.payment_apply_failure(result)
+      end
+
+      result
+    end
+
+    # 支付成功(回调结果)
+    # @param [Hash] result
+    #
+    # result example:
+    #
+    # {
+    #   "appid"=>"wxc5e21215c6471bcf",
+    #   "bank_type"=>"CMB_CREDIT",
+    #   "cash_fee"=>"1",
+    #   "fee_type"=>"CNY",
+    #   "is_subscribe"=>"N",
+    #   "mch_id"=>"144223114",
+    #   "nonce_str"=>"026b7ff3433f482f98610a67bbd8e159",
+    #   "openid"=>"omf2nv3OgYXBYrNqdx9eUucKy7NQ",
+    #   "out_trade_no"=>"1624866836218932068",
+    #   "result_code"=>"SUCCESS",
+    #   "return_code"=>"SUCCESS",
+    #   "sign"=>"442098E6B670B82B88A843CC2A2AB54D",
+    #   "sub_appid"=>"wxf89f95121da823dcd",
+    #   "sub_is_subscribe"=>"N",
+    #   "sub_mch_id"=>"1525911211",
+    #   "sub_openid"=>"ogT7J5YddGnll-ippRvJq62Nv8W0",
+    #   "time_end"=>"20210628155426",
+    #   "total_fee"=>"1",
+    #   "trade_type"=>"JSAPI",
+    #   "transaction_id"=>"4200001174202106282207291730"
+    # }
+    def payment_exec_success(result)
+      update(
+        state: :paid,
+        transaction_id: result["transaction_id"],
+        paid_at: Time.current
+      )
+
+      if goods.respond_to? :payment_exec_success
+        goods.payment_exec_success(result)
+      end
+
+      result
+    end
+
+    # 支付失败(回调结果)
+    # @param [Hash] result
+    #
+    # result example:
+    #
+    def payment_exec_failure(result)
+      if goods.respond_to? :payment_exec_failure
+        goods.payment_exec_failure(result)
+      end
+    end
+
+    # 判断是否已经全额退款
+    def total_fee_refunded?
+      refunded_fee >= total_fee
+    end
+  end
+end