wechat_pay 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1de3b364757da264d21ac3b5bbbebf2b76f1ea78
-  data.tar.gz: ef2ffe65e34a698dec0ac6c43a103ed9c17b916f
+  metadata.gz: 07e529110ae4ceb6bcdfe49478d9fa2793c5c08f
+  data.tar.gz: 63acebb5f8625dbab449bf8fbcef4df8dbff1dae
 SHA512:
-  metadata.gz: 91e1f4d712eeb7dae91c8622fbfd367f3e0ca30faff807bb067d36d411ef4adbd0473ad0d6c0430f6a839dd4fd62a915e32352a732155f888976211b3a6ccd12
-  data.tar.gz: 217fa61b7ee54d66db3b7af8faed2dac69d134b7bd56a01312b87ef6a19d55e85670905bdcb456908c6e2a1eac501aad863e291b40dcace5e61db5fa08c02a74
+  metadata.gz: 0a68658c3180520d68a7af857e8968750e3a1852a70be6ceda5a92631b115785bdb4c46af3f77e201dc422d3b96f5c4851524c4ca0c78ac27d46fbfe2cbfd56b
+  data.tar.gz: e5fc8dbc37a2338dbab9ca5b298cf01ac4a3a807a2edc9513651b3bb076aaf6a806cf5cd5b0772c6b7f77353a2622e1c3e3e557e8259b5c8c7c74aa0c476d6b2

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-# Change Log
+# Changelog
+
+## Version 0.2.0
+
+### Add
+
+* `WechatPay::Notify.verify?`
 
 ## Version 0.1.0
 
 ### Breaking Change
 
-* 修改 `WechatPay::App.payment` 返回值 [c10c1c](https://github.com/HungYuHei/wechat_pay/commit/c10c1cc40ff54c584f3855d0d3264207e45778d0)
+* 修改 `WechatPay::App.payment` 返回值  [c10c1c](https://github.com/HungYuHei/wechat_pay/commit/c10c1cc40ff54c584f3855d0d3264207e45778d0)

data/README.md

@@ -1,17 +1,22 @@
 # WechatPay
 
-Wechat Pay: https://open.weixin.qq.com/cgi-bin/frame?t=home/pay_tmpl&lang=zh_CN
+微信支付: https://open.weixin.qq.com/cgi-bin/frame?t=home/pay_tmpl&lang=zh_CN
 
 It contains:
 
-* generate access_token
-* generate payment params for App
+* generate access-token
+* App payment
+* verify notify
+* Native payment (Work In Process)
+* JS payment (Work In Process)
+
+MRI Ruby 2.0.0 and newer are supported. 1.9.2 should work as well but not tested.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'wechat_pay', '~> 0.1.0'
+    gem 'wechat_pay'
 
 And then execute:
 
@@ -39,7 +44,7 @@ WechatPay.partner_key  = 'YOUR_PARTNER_KEY'
 WechatPay::AccessToken.generate # => { access_token: 'ACCESS_TOKEN', expires_in: 7200 }
 ```
 
-Your should cache the `access_token`, see [http://mp.weixin.qq.com/wiki...](http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96access_token)
+Your should cache the `access_token`, see [http://mp.weixin.qq.com/wiki/index.php...](http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96access_token)
 
 You may wanna do something like this in Rails:
 
@@ -73,6 +78,26 @@ WechatPay::App.payment('ACCESS_TOKEN', params)
 #     sign:       'sign'
 #   }
 ```
+### Verify notify
+
+```ruby
+# Rails example
+
+def app_notify
+  # except :controller_name, :action_name, :host, etc.
+  notify_params = params.except(*request.path_parameters.keys)
+
+  if WechatPay::Notify.verify?(notify_params)
+    # Valid notify status
+    if params[:trade_state] == '0'
+      # Code your business logic
+    end
+    render text: 'success'
+  else
+    render text: 'error'
+  end
+end
+```
 
 ## Contributing
 
@@ -81,3 +106,7 @@ WechatPay::App.payment('ACCESS_TOKEN', params)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+[WTFPL](http://wtfpl.org)

data/lib/wechat_pay/app.rb

@@ -1,9 +1,3 @@
-require 'uri'
-require 'json'
-require 'rest_client'
-require 'securerandom'
-require 'digest/md5'
-
 module WechatPay
   module App
 
@@ -12,22 +6,14 @@ module WechatPay
     def self.payment(access_token, params)
       noncestr = SecureRandom.hex(16)
       timestamp = Time.now.to_i.to_s
-      package = generate_package(params)
+      package = Package::App.generate(params)
 
-      app_signature = generate_app_signature(
+      prepay_id = PrepayId::App.generate(
+        access_token,
+        traceid:   params[:traceid],
         noncestr:  noncestr,
-        timestamp: timestamp,
         package:   package,
-        traceid:   params[:traceid],
-      )
-
-      prepay_id = generate_prepay_id(
-        access_token,
-        traceid:       params[:traceid],
-        noncestr:      noncestr,
-        package:       package,
-        timestamp:     timestamp,
-        app_signature: app_signature
+        timestamp: timestamp
       )
 
       attrs = {
@@ -39,7 +25,7 @@ module WechatPay
         prepayid:  prepay_id,
         timestamp: timestamp
       }
-      sign = Sign.generate(attrs)
+      sign = Sign.sha1(attrs)
 
       {
         sign:       sign,
@@ -51,67 +37,5 @@ module WechatPay
       }
     end
 
-    private
-
-    def self.generate_prepay_id(access_token, params)
-      url = "https://api.weixin.qq.com/pay/genprepay?access_token=#{access_token}"
-
-      params = {
-        appid:         WechatPay.app_id,
-        traceid:       params[:traceid],
-        noncestr:      params[:noncestr],
-        package:       params[:package],
-        timestamp:     params[:timestamp],
-        app_signature: params[:app_signature],
-        sign_method:   'sha1'
-      }
-
-      RestClient.post(url, JSON.generate(params)) do |response|
-        JSON.parse(response.body)['prepayid']
-      end
-    end
-
-    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(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)
-
-      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=#{package_sign(params)}"
-    end
-
-    def self.generate_app_signature(signature_params)
-      params = {
-        appid: WechatPay.app_id,
-        appkey: WechatPay.pay_sign_key,
-        noncestr: signature_params[:noncestr],
-        package: signature_params[:package],
-        timestamp: signature_params[:timestamp],
-        traceid: signature_params[:traceid]
-      }
-
-      Sign.generate(params)
-    end
-
-    def self.package_sign(params)
-      str = params.sort.map { |item| item.join('=') }.join('&')
-      str << "&key=#{WechatPay.partner_key}"
-      Digest::MD5.hexdigest(str).upcase
-    end
   end
 end

data/lib/wechat_pay/notify.rb

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

data/lib/wechat_pay/package.rb

@@ -0,0 +1,29 @@
+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
+      ]
+
+      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)
+
+        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
+    end
+  end
+end

data/lib/wechat_pay/prepay_id.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'rest_client'
+
+module WechatPay
+  module PrepayId
+    module App
+
+      # required params:
+      #   traceid, noncestr, package, timestamp
+      def self.generate(access_token, params)
+        url = "https://api.weixin.qq.com/pay/genprepay?access_token=#{access_token}"
+        app_signature = generate_app_signature(params)
+
+        prepay_params = {
+          appid:         WechatPay.app_id,
+          app_signature: app_signature,
+          traceid:       params[:traceid],
+          noncestr:      params[:noncestr],
+          package:       params[:package],
+          timestamp:     params[:timestamp],
+          sign_method:   'sha1'
+        }
+
+        RestClient.post(url, JSON.generate(prepay_params)) do |response|
+          JSON.parse(response.body)['prepayid']
+        end
+      end
+
+      private
+
+      def self.generate_app_signature(signature_params)
+        params = {
+          appid: WechatPay.app_id,
+          appkey: WechatPay.pay_sign_key,
+          noncestr: signature_params[:noncestr],
+          package: signature_params[:package],
+          timestamp: signature_params[:timestamp],
+          traceid: signature_params[:traceid]
+        }
+
+        Sign.sha1(params)
+      end
+    end
+  end
+end

data/lib/wechat_pay/sign.rb

@@ -1,10 +1,17 @@
 require 'digest/sha1'
+require 'digest/md5'
 
 module WechatPay
   module Sign
-    def self.generate(params)
+    def self.sha1(params)
       str = params.sort.map { |item| item.join('=') }.join('&')
       Digest::SHA1.hexdigest(str)
     end
+
+    def self.md5(params)
+      str = params.sort.map { |item| item.join('=') }.join('&')
+      str << "&key=#{WechatPay.partner_key}"
+      Digest::MD5.hexdigest(str).upcase
+    end
   end
 end

data/lib/wechat_pay/version.rb

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

data/lib/wechat_pay.rb

@@ -1,15 +1,14 @@
-require 'wechat_pay/version'
-require 'wechat_pay/access_token'
 require 'wechat_pay/app'
 require 'wechat_pay/sign'
 require 'wechat_pay/utils'
+require 'wechat_pay/notify'
+require 'wechat_pay/version'
+require 'wechat_pay/package'
+require 'wechat_pay/prepay_id'
+require 'wechat_pay/access_token'
 
 module WechatPay
   class << self
-    attr_accessor :app_id
-    attr_accessor :app_secret
-    attr_accessor :pay_sign_key
-    attr_accessor :partner_id
-    attr_accessor :partner_key
+    attr_accessor :app_id, :app_secret, :pay_sign_key, :partner_id, :partner_key
   end
 end

data/spec/wechat_pay/app_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe WechatPay::App do
+  let(:prepay_id) { 'TEST_PREPAY_ID' }
+
+  before do
+    FakeWeb.register_uri(
+      :post,
+      %r|https://api\.weixin\.qq\.com/pay/genprepay.+|,
+      body: %Q({"prepayid":"#{prepay_id}","errcode":0,"errmsg":"Success"})
+    )
+  end
 
   it ".payment" do
-    prepay_id = "PREPAY_ID"
-    prepay_params = {
+    params = {
       traceid:          'traceid',
       body:             'body',
       out_trade_no:     'out_trade_no',
@@ -13,13 +21,7 @@ describe WechatPay::App do
       spbill_create_ip: '192.168.1.1'
     }
 
-    FakeWeb.register_uri(
-      :post,
-      %r|https://api\.weixin\.qq\.com/pay/genprepay.+|,
-      body: %Q({"prepayid":"#{prepay_id}","errcode":0,"errmsg":"Success"})
-    )
-
-    payment = WechatPay::App.payment('access_token', prepay_params)
+    payment = WechatPay::App.payment('access_token', params)
 
     payment[:partner_id].must_equal WechatPay.partner_id
     payment[:nonce_str].wont_be_empty

data/spec/wechat_pay/notify_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe WechatPay::Notify do
+  describe ".verify?" do
+    it "with nil sign" do
+      WechatPay::Notify.verify?({}).must_equal(false)
+    end
+  end
+end

data/spec/wechat_pay/package_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe WechatPay::Package do
+  it ".generate" do
+    params = {
+      body: 'body',
+      out_trade_no: 'out_trade_no',
+      total_fee: '1',
+      notify_url: 'http://test.com',
+      spbill_create_ip: '127.0.0.1'
+    }
+
+    WechatPay::Package::App.generate(params).must_include '&sign='
+  end
+end

data/spec/wechat_pay/prepay_id_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe WechatPay::PrepayId do
+  let(:prepay_id) { 'TEST_PREPAY_ID' }
+
+  before do
+    FakeWeb.register_uri(
+      :post,
+      %r|https://api\.weixin\.qq\.com/pay/genprepay.+|,
+      body: %Q({"prepayid":"#{prepay_id}","errcode":0,"errmsg":"Success"})
+    )
+  end
+
+  it ".generate" do
+    params = {
+      traceid: 'traceid',
+      noncestr: 'noncestr',
+      package: 'package',
+      timestamp: Time.now.to_i.to_s,
+    }
+    WechatPay::PrepayId::App.generate('ACCESS_TOKEN', params).must_equal(prepay_id)
+  end
+end

data/spec/wechat_pay/sign_spec.rb

@@ -1,8 +1,13 @@
 require 'spec_helper'
 
 describe WechatPay::Sign do
-  it ".generate" do
+  it ".sha1" do
     params = { appid: 'appid', appkey: 'appkey' }
-    WechatPay::Sign.generate(params).wont_be_empty
+    WechatPay::Sign.sha1(params).wont_be_empty
+  end
+
+  it ".md5" do
+    params = { appid: 'appid' }
+    WechatPay::Sign.sha1(params).wont_be_empty
   end
 end

data/wechat_pay.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = WechatPay::VERSION
   spec.authors       = ["HungYuHei"]
   spec.email         = ["kongruxi@gmail.com"]
-  spec.summary       = "Wechat pay"
-  spec.description   = "Wechat pay"
+  spec.summary       = "微信支付"
+  spec.description   = "微信支付"
   spec.homepage      = "https://github.com/HungYuHei/wechat_pay"
-  spec.license       = "MIT"
+  spec.license       = "WTFPL"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat_pay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HungYuHei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,7 +66,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-description: Wechat pay
+description: 微信支付
 email:
 - kongruxi@gmail.com
 executables: []
@@ -76,24 +76,29 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/wechat_pay.rb
 - lib/wechat_pay/access_token.rb
 - lib/wechat_pay/app.rb
+- lib/wechat_pay/notify.rb
+- lib/wechat_pay/package.rb
+- lib/wechat_pay/prepay_id.rb
 - lib/wechat_pay/sign.rb
 - lib/wechat_pay/utils.rb
 - lib/wechat_pay/version.rb
 - spec/spec_helper.rb
 - spec/wechat_pay/access_token_spec.rb
 - spec/wechat_pay/app_spec.rb
+- spec/wechat_pay/notify_spec.rb
+- spec/wechat_pay/package_spec.rb
+- spec/wechat_pay/prepay_id_spec.rb
 - spec/wechat_pay/sign_spec.rb
 - spec/wechat_pay/utils_spec.rb
 - wechat_pay.gemspec
 homepage: https://github.com/HungYuHei/wechat_pay
 licenses:
-- MIT
+- WTFPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -114,10 +119,13 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Wechat pay
+summary: 微信支付
 test_files:
 - spec/spec_helper.rb
 - spec/wechat_pay/access_token_spec.rb
 - spec/wechat_pay/app_spec.rb
+- spec/wechat_pay/notify_spec.rb
+- spec/wechat_pay/package_spec.rb
+- spec/wechat_pay/prepay_id_spec.rb
 - spec/wechat_pay/sign_spec.rb
 - spec/wechat_pay/utils_spec.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 HungYuHei
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.