wechat_pay 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07e529110ae4ceb6bcdfe49478d9fa2793c5c08f
-  data.tar.gz: 63acebb5f8625dbab449bf8fbcef4df8dbff1dae
+  metadata.gz: 3bb85404b21e4c632faaf11bc41ac83afc2454cc
+  data.tar.gz: 496b4ab34af115b96ba39590f8edc9a0d14f3100
 SHA512:
-  metadata.gz: 0a68658c3180520d68a7af857e8968750e3a1852a70be6ceda5a92631b115785bdb4c46af3f77e201dc422d3b96f5c4851524c4ca0c78ac27d46fbfe2cbfd56b
-  data.tar.gz: e5fc8dbc37a2338dbab9ca5b298cf01ac4a3a807a2edc9513651b3bb076aaf6a806cf5cd5b0772c6b7f77353a2622e1c3e3e557e8259b5c8c7c74aa0c476d6b2
+  metadata.gz: 3f719333568cda9c390455acfb6bf6808745aac8afdfa6d92404fd4b3adbb5c7a2625a6841773a8fdb5789b28cc21342100ddef20d984510a00245872da6606b
+  data.tar.gz: b93d3a3dcae5d50b1ddf1f062e46d5506e51a94d41ee0cda88c04b71ccd797b9a3b2c0ddf1a5eca7b5c724f9bbae0034a01cfa9d1b65124ffda1f966ca40e9f3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+### Add
+
+* `WechatPay::JS.payment`
+* `WechatPay::DeliverNotify.request`
+* `WechatPay::OrderQuery.request`
+
 ## Version 0.2.0
 
 ### Add

data/README.md

@@ -5,10 +5,12 @@
 It contains:
 
 * generate access-token
-* App payment
+* app payment
+* js payment
+* native payment (work in process)
 * verify notify
-* Native payment (Work In Process)
-* JS payment (Work In Process)
+* deliver notify
+* order query
 
 MRI Ruby 2.0.0 and newer are supported. 1.9.2 should work as well but not tested.
 
@@ -49,12 +51,12 @@ Your should cache the `access_token`, see [http://mp.weixin.qq.com/wiki/index.ph
 You may wanna do something like this in Rails:
 
 ```ruby
-Rails.cache.fetch(:wechat_pay_access_token, expires_in: 7200.seconds raw: true) do
+Rails.cache.fetch(:wechat_pay_access_token, expires_in: 7200.seconds, raw: true) do
   WechatPay::AccessToken.generate[:access_token]
 end
 ```
 
-### Payment params
+### App Payment params
 
 ```ruby
 # Please keep in mind that all key MUST be Symbol
@@ -78,11 +80,64 @@ WechatPay::App.payment('ACCESS_TOKEN', params)
 #     sign:       'sign'
 #   }
 ```
+
+### JS Payment params
+
+###### In Controller
+
+```ruby
+params = {
+  body:             'body',
+  out_trade_no:     'out_trade_no'
+  total_fee:        '100'
+  notify_url:       'http://your_domain.com/notify',
+  spbill_create_ip: '192.168.1.1'
+}
+
+@order_params = WechatPay::JS.payment(params)
+
+# =>
+#    {
+#      app_id:    "app_id",
+#      timestamp: "1407165191",
+#      nonce_str: "noncestr",
+#      package:   "Sign=WXpay",
+#      pay_sign:  "pay_sign",
+#      sign_type: 'SHA1'
+#    }
+```
+
+###### In View (slim)
+
+```ruby
+= link_to "wechat_payment_btn", "javascript:void(0)", id: "wechatPaymentBtn"
+
+javascript:
+  var orderParams = { 
+    appId:     "#{@order_params[:app_id]}",
+    timeStamp: "#{@order_params[:timestamp]}",
+    nonceStr:  "#{@order_params[:nonce_str]}",
+    package:   "#{@order_params[:package]}",
+    paySign:   "#{@order_params[:pay_sign]}",
+    signType:  "#{@order_params[:sign_type]}"
+  };
+  document.addEventListener('WeixinJSBridgeReady', function onBridgeReady() {
+    $('#wechatPaymentBtn').click(function(){
+      WeixinJSBridge.invoke('getBrandWCPayRequest', orderParams, function(res) {
+        if (res.err_msg == "get_brand_wcpay_request:ok") {
+          alert('pay for success!');
+        } else {
+          alert(res.err_msg);
+        }
+      });
+    });
+  }, false);
+```
+
 ### Verify notify
 
 ```ruby
 # Rails example
-
 def app_notify
   # except :controller_name, :action_name, :host, etc.
   notify_params = params.except(*request.path_parameters.keys)
@@ -99,6 +154,30 @@ def app_notify
 end
 ```
 
+### Deliver Notify
+
+```ruby
+# Please keep in mind that all key MUST be Symbol
+params = {
+  openid: 'openid',
+  transid: 'transid',
+  out_trade_no: 'out_trade_no',
+  deliver_msg: 'ok',              # optional, default is 'ok'
+  deliver_status: '1',            # optional, default is '1'
+  deliver_timestamp: '1410105134' # optional, default is `Time.now.to_i.to_s`
+}
+
+WechatPay::DeliverNotify.request('ACCESS_TOKEN', params)
+# => { errcode: 0, errmsg: 'ok' }
+```
+
+### Order Query
+
+```ruby
+WechatPay::OrderQuery.request('ACCESS_TOKEN', 'YOUR_OUT_TRADE_NO')
+# => { errcode: 0, errmsg: 'ok', order_info: { ret_code: 0, ... } }
+```
+
 ## Contributing
 
 1. Fork it

data/lib/wechat_pay.rb

@@ -1,3 +1,4 @@
+require 'wechat_pay/js'
 require 'wechat_pay/app'
 require 'wechat_pay/sign'
 require 'wechat_pay/utils'
@@ -5,7 +6,9 @@ require 'wechat_pay/notify'
 require 'wechat_pay/version'
 require 'wechat_pay/package'
 require 'wechat_pay/prepay_id'
+require 'wechat_pay/order_query'
 require 'wechat_pay/access_token'
+require 'wechat_pay/deliver_notify'
 
 module WechatPay
   class << self

data/lib/wechat_pay/app.rb

@@ -6,7 +6,7 @@ module WechatPay
     def self.payment(access_token, params)
       noncestr = SecureRandom.hex(16)
       timestamp = Time.now.to_i.to_s
-      package = Package::App.generate(params)
+      package = Package.generate(params)
 
       prepay_id = PrepayId::App.generate(
         access_token,

data/lib/wechat_pay/deliver_notify.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'rest_client'
+
+module WechatPay
+  module DeliverNotify
+    def self.request(access_token, params)
+      url = "https://api.weixin.qq.com/pay/delivernotify?access_token=#{access_token}"
+
+      params = {
+        deliver_msg: 'ok',
+        deliver_status: '1',
+        deliver_timestamp: Time.now.to_i.to_s
+      }.merge(params)
+
+      app_signature = generate_app_signature(params)
+
+      data = {
+        appid:             WechatPay.app_id,
+        openid:            params[:openid],
+        transid:           params[:transid],
+        sign_method:       "sha1",
+        deliver_msg:       params[:deliver_msg],
+        out_trade_no:      params[:out_trade_no],
+        app_signature:     app_signature,
+        deliver_status:    params[:deliver_status],
+        deliver_timestamp: params[:deliver_timestamp]
+      }
+
+      RestClient.post(url, JSON.generate(data)) do |response|
+        JSON.parse(response.body, symbolize_names: true)
+      end
+    end
+
+    private
+
+    def self.generate_app_signature(params)
+      attrs = {
+        appid: WechatPay.app_id,
+        appkey: WechatPay.pay_sign_key
+      }.merge(params)
+
+      Sign.sha1(attrs)
+    end
+  end
+end

data/lib/wechat_pay/js.rb

@@ -0,0 +1,23 @@
+module WechatPay
+  module JS
+    def self.payment(params)
+      sign_attrs = {
+        package:   Package.generate(params),
+        appid:     WechatPay.app_id,
+        appkey:    WechatPay.pay_sign_key,
+        noncestr:  SecureRandom.hex(16),
+        timestamp: Time.now.to_i.to_s
+      }
+      pay_sign = Sign.sha1(sign_attrs)
+
+      {
+        app_id:    sign_attrs[:appid],
+        timestamp: sign_attrs[:timestamp],
+        nonce_str: sign_attrs[:noncestr],
+        package:   sign_attrs[:package],
+        pay_sign:  pay_sign,
+        sign_type: 'SHA1'
+      }
+    end
+  end
+end

data/lib/wechat_pay/notify.rb

@@ -2,7 +2,7 @@ module WechatPay
   module Notify
     def self.verify?(params)
       sign = params.delete(:sign) || params.delete('sign')
-      !!sign && sign == Sign.md5(params)
+      !!sign && sign == Sign.md5_with_partner_key(params)
     end
   end
 end

data/lib/wechat_pay/order_query.rb

@@ -0,0 +1,42 @@
+require 'json'
+require 'rest_client'
+
+module WechatPay
+  module OrderQuery
+    def self.request(access_token, out_trade_no)
+      url = "https://api.weixin.qq.com/pay/orderquery?access_token=#{access_token}"
+      timestamp = Time.now.to_i.to_s
+      package = generate_package(out_trade_no)
+      app_signature = generate_app_signature(timestamp, package)
+
+      data = {
+        appid:         WechatPay.app_id,
+        package:       package,
+        timestamp:     timestamp,
+        sign_method:   "sha1",
+        app_signature: app_signature
+      }
+
+      RestClient.post(url, JSON.generate(data)) do |response|
+        JSON.parse(response.body, symbolize_names: true)
+      end
+    end
+
+    private
+
+    def self.generate_package(out_trade_no)
+      attrs = { out_trade_no: out_trade_no, partner: WechatPay.partner_id }
+      package = attrs.sort.map { |item| item.join('=') }.join('&')
+      "#{package}&sign=#{Sign.md5_with_partner_key(attrs)}"
+    end
+
+    def self.generate_app_signature(timestamp, package)
+      Sign.sha1(
+        appid:     WechatPay.app_id,
+        appkey:    WechatPay.pay_sign_key,
+        package:   package,
+        timestamp: timestamp
+      )
+    end
+  end
+end

data/lib/wechat_pay/package.rb

@@ -1,29 +1,27 @@
 module WechatPay
   module Package
-    module App
-      PACKAGE_PARAMS = [
-        :bank_type, :body, :attach, :partner, :out_trade_no, :total_fee, :fee_type,
-        :notify_url, :spbill_create_ip, :time_start, :time_expire, :transport_fee,
-        :product_fee, :goods_tag, :input_charset
-      ]
+    PACKAGE_PARAMS = [
+      :bank_type, :body, :attach, :partner, :out_trade_no, :total_fee, :fee_type,
+      :notify_url, :spbill_create_ip, :time_start, :time_expire, :transport_fee,
+      :product_fee, :goods_tag, :input_charset
+    ]
 
-      def self.generate(package_params)
-        package_params = Utils.slice_hash(package_params, *PACKAGE_PARAMS)
+    def self.generate(package_params)
+      package_params = Utils.slice_hash(package_params, *PACKAGE_PARAMS)
 
-        params = {
-          bank_type: 'WX',
-          fee_type: '1',
-          input_charset: 'UTF-8',
-          partner: WechatPay.partner_id
-        }.merge(package_params)
+      params = {
+        bank_type: 'WX',
+        fee_type: '1',
+        input_charset: 'UTF-8',
+        partner: WechatPay.partner_id
+      }.merge(package_params)
 
-        regexp = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
-        escaped_params_str = params.sort.map do |key, value|
-          "#{key}=#{URI.escape(value.to_s, regexp)}"
-        end.join('&')
+      regexp = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+      escaped_params_str = params.sort.map do |key, value|
+        "#{key}=#{URI.escape(value.to_s, regexp)}"
+      end.join('&')
 
-        "#{escaped_params_str}&sign=#{Sign.md5(params)}"
-      end
+      "#{escaped_params_str}&sign=#{Sign.md5_with_partner_key(params)}"
     end
   end
 end

data/lib/wechat_pay/sign.rb

@@ -8,7 +8,7 @@ module WechatPay
       Digest::SHA1.hexdigest(str)
     end
 
-    def self.md5(params)
+    def self.md5_with_partner_key(params)
       str = params.sort.map { |item| item.join('=') }.join('&')
       str << "&key=#{WechatPay.partner_key}"
       Digest::MD5.hexdigest(str).upcase

data/lib/wechat_pay/version.rb

@@ -1,3 +1,3 @@
 module WechatPay
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/wechat_pay/deliver_notify_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe WechatPay::DeliverNotify do
+  before do
+    FakeWeb.register_uri(
+      :post,
+      %r|https://api\.weixin\.qq\.com/pay/delivernotify.+|,
+      body: %Q({"errcode":0,"errmsg":"ok"})
+    )
+  end
+
+  it ".request" do
+    params = {
+      openid: 'openid',
+      transid: 'transid',
+      out_trade_no: 'out_trade_no'
+    }
+
+    response = WechatPay::DeliverNotify.request('ACCESS_TOKEN', params)
+    response[:errcode].must_equal 0
+    response[:errmsg].must_equal 'ok'
+  end
+end

data/spec/wechat_pay/js_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe WechatPay::JS do
+  it ".payment" do
+    params = {
+      body:             'body',
+      out_trade_no:     'out_trade_no',
+      total_fee:        '2',
+      notify_url:       'http://your_domain.com/notify',
+      spbill_create_ip: '192.168.1.1'
+    }
+
+    package = WechatPay::Package.generate(params)
+    payment = WechatPay::JS.payment(params)
+
+    payment[:app_id].must_equal WechatPay.app_id
+    payment[:package].must_equal package
+    payment[:timestamp].wont_be_empty
+    payment[:nonce_str].wont_be_empty
+    payment[:pay_sign].wont_be_empty
+    payment[:sign_type].must_equal 'SHA1'
+  end
+end

data/spec/wechat_pay/notify_spec.rb

@@ -5,5 +5,14 @@ describe WechatPay::Notify do
     it "with nil sign" do
       WechatPay::Notify.verify?({}).must_equal(false)
     end
+
+    it "success" do
+      params = {b: 'b', a: 'a'}
+      str = params.sort.map { |i| i.join('=') }.join('&')
+      str << "&key=#{WechatPay.partner_key}"
+      sign = Digest::MD5.hexdigest(str).upcase
+
+      WechatPay::Notify.verify?(params.merge(sign: sign)).must_equal(true)
+    end
   end
 end

data/spec/wechat_pay/order_query_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe WechatPay::OrderQuery do
+  before do
+    FakeWeb.register_uri(
+      :post,
+      %r|https://api\.weixin\.qq\.com/pay/orderquery.+|,
+      body: %Q({"errcode":0,"errmsg":"ok","order_info":{"ret_code":0}})
+    )
+  end
+
+  it ".request" do
+    response = WechatPay::OrderQuery.request('ACCESS_TOKEN', 'OUT_TRADE_NO')
+    response[:errcode].must_equal 0
+    response[:errmsg].must_equal 'ok'
+    response[:order_info].wont_be_nil
+  end
+end

data/spec/wechat_pay/package_spec.rb

@@ -10,6 +10,6 @@ describe WechatPay::Package do
       spbill_create_ip: '127.0.0.1'
     }
 
-    WechatPay::Package::App.generate(params).must_include '&sign='
+    WechatPay::Package.generate(params).must_include '&sign='
   end
 end

data/spec/wechat_pay/sign_spec.rb

@@ -6,8 +6,8 @@ describe WechatPay::Sign do
     WechatPay::Sign.sha1(params).wont_be_empty
   end
 
-  it ".md5" do
+  it ".md5_with_partner_key" do
     params = { appid: 'appid' }
-    WechatPay::Sign.sha1(params).wont_be_empty
+    WechatPay::Sign.md5_with_partner_key(params).wont_be_empty
   end
 end

metadata

@@ -1,79 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: wechat_pay
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - HungYuHei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 微信支付
+description: "微信支付"
 email:
 - kongruxi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -81,7 +81,10 @@ files:
 - lib/wechat_pay.rb
 - lib/wechat_pay/access_token.rb
 - lib/wechat_pay/app.rb
+- lib/wechat_pay/deliver_notify.rb
+- lib/wechat_pay/js.rb
 - lib/wechat_pay/notify.rb
+- lib/wechat_pay/order_query.rb
 - lib/wechat_pay/package.rb
 - lib/wechat_pay/prepay_id.rb
 - lib/wechat_pay/sign.rb
@@ -90,7 +93,10 @@ files:
 - spec/spec_helper.rb
 - spec/wechat_pay/access_token_spec.rb
 - spec/wechat_pay/app_spec.rb
+- spec/wechat_pay/deliver_notify_spec.rb
+- spec/wechat_pay/js_spec.rb
 - spec/wechat_pay/notify_spec.rb
+- spec/wechat_pay/order_query_spec.rb
 - spec/wechat_pay/package_spec.rb
 - spec/wechat_pay/prepay_id_spec.rb
 - spec/wechat_pay/sign_spec.rb
@@ -106,12 +112,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -119,12 +125,15 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: 微信支付
+summary: "微信支付"
 test_files:
 - spec/spec_helper.rb
 - spec/wechat_pay/access_token_spec.rb
 - spec/wechat_pay/app_spec.rb
+- spec/wechat_pay/deliver_notify_spec.rb
+- spec/wechat_pay/js_spec.rb
 - spec/wechat_pay/notify_spec.rb
+- spec/wechat_pay/order_query_spec.rb
 - spec/wechat_pay/package_spec.rb
 - spec/wechat_pay/prepay_id_spec.rb
 - spec/wechat_pay/sign_spec.rb