wx_pay_api 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 440110a4f048c0b831207aca7f41b72abdb1bb62
+  data.tar.gz: 7a11dcff841ff9f8f930e4f72f9c549de02e8cbf
+SHA512:
+  metadata.gz: dec65a29f8482c7d2778c8b1c16f8490449357c87f03a26bd720019de85d60ade38bca7c270374d38f2c11ecfe5fd0bf1b5c115e58821787e2de47ebd1f5d728
+  data.tar.gz: fc1d9940e7db669552cdac6c82376fefb1599e3bb078b19ac115288ab9ddea0ac71c37b7f98640061b72e8b5541ae0fd2af00e311aec6f655f7088274edd2e99

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Jasl
+
+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.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Tenpay'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/wx_pay/result.rb

@@ -0,0 +1,18 @@
+module WxPay
+  class Result < ::Hash
+    SUCCESS_FLAG = 'SUCCESS'.freeze
+
+    def initialize(result)
+      super
+      if result['xml'].class == Hash
+        result['xml'].each_pair do |k, v|
+          self[k] = v
+        end
+      end
+    end
+
+    def success?
+      self['return_code'] == SUCCESS_FLAG && self['result_code'] == SUCCESS_FLAG
+    end
+  end
+end

data/lib/wx_pay/service.rb

@@ -0,0 +1,144 @@
+require 'rest_client'
+require 'active_support/core_ext/hash/conversions'
+
+module WxPay
+  module Service
+    GATEWAY_URL = 'https://api.mch.weixin.qq.com'.freeze
+
+    INVOKE_UNIFIEDORDER_REQUIRED_FIELDS = %i(body out_trade_no total_fee spbill_create_ip notify_url trade_type)
+    def self.invoke_unifiedorder(params)
+      params = {
+        appid: WxPay.appid,
+        mch_id: WxPay.mch_id
+      }.merge(params)
+      check_required_options(params, INVOKE_UNIFIEDORDER_REQUIRED_FIELDS)
+      r = invoke_remote("#{GATEWAY_URL}/pay/unifiedorder", params)
+      yield r if block_given?
+      r
+    end
+
+    GENERATE_APP_PAY_REQ_REQUIRED_FIELDS = %i(prepayid noncestr)
+    def self.generate_app_pay_req(params)
+      params = {
+        appid: WxPay.appid,
+        partnerid: WxPay.mch_id,
+        package: 'Sign=WXPay',
+        timestamp: Time.now.to_i.to_s
+      }.merge(params)
+      check_required_options(params, GENERATE_APP_PAY_REQ_REQUIRED_FIELDS)
+      params[:sign] = WxPay::Sign.generate(params)
+      params
+    end
+
+    INVOKE_REFUND_REQUIRED_FIELDS = %i(transaction_id out_trade_no out_refund_no total_fee refund_fee cert_path)
+    def self.invoke_refund(params)
+      params = {
+        appid: WxPay.appid,
+        mch_id: WxPay.mch_id,
+        op_user_id: WxPay.mch_id
+      }.merge(params)
+      check_required_options(params, INVOKE_REFUND_REQUIRED_FIELDS)
+      r = invoke_remote("#{GATEWAY_URL}/secapi/pay/refund", params, true)
+      yield(r) if block_given?
+      r
+    end
+
+    # out_trade_no
+    def self.close_order(params)
+      params = {
+        appid: WxPay.appid,
+        mch_id: WxPay.mch_id
+      }.merge(params)
+      r = invoke_remote("#{GATEWAY_URL}/pay/closeorder", params)
+      yield(r) if block_given?
+      r
+    end
+
+    # 查询订单
+    # transaction_id 与 out_trade_no 二选一
+    def self.query_order(params)
+      params = {
+        appid: WxPay.appid,
+        mch_id: WxPay.mch_id
+      }.merge(params)
+      r = invoke_remote("#{GATEWAY_URL}/pay/orderquery", params)
+      yield(r) if block_given?
+      r
+    end
+
+    # 发送红包
+    # https://api.mch.weixin.qq.com/mmpaymkttransfers/sendredpack
+    INVOKE_REDPACK_FIELDS = %i(mch_billno mch_id wxappid send_name re_openid total_amount total_num wishing client_ip act_name remark key cert_path)
+    def self.send_redpack(params)
+      check_required_options(params, INVOKE_REDPACK_FIELDS)
+      r = invoke_remote("#{GATEWAY_URL}/mmpaymkttransfers/sendredpack", params, true)
+      yield(r) if block_given?
+      r
+    end
+
+    # 查询红包
+    # https://api.mch.weixin.qq.com/mmpaymkttransfers/gethbinfo
+    INVOKE_QUERY_REDPACK_FIELDS = %i(mch_billno mch_id appid bill_type key cert_path key)
+    def self.query_redpack(params)
+      check_required_options(params, INVOKE_QUERY_REDPACK_FIELDS)
+      r = invoke_remote("#{GATEWAY_URL}/mmpaymkttransfers/gethbinfo", params, true)
+      yield(r) if block_given?
+      r
+    end
+
+    # 发送裂变红包
+    # https://api.mch.weixin.qq.com/mmpaymkttransfers/sendgroupredpack
+    INVOKE_GROUPREDPACK_FIELDS = %i(mch_billno mch_id wxappid send_name re_openid total_amount total_num wishing act_name remark key amt_type cert_path)
+    def self.send_groupredpack(params)
+      check_required_options(params, INVOKE_GROUPREDPACK_FIELDS)
+      r = invoke_remote("#{GATEWAY_URL}/mmpaymkttransfers/sendgroupredpack", params, true)
+      yield(r) if block_given?
+      r
+    end
+
+    private
+
+      def self.check_required_options(options, names)
+        names.each do |name|
+          warn("WxPay Warn: missing required option: #{name}") unless options.has_key?(name)
+        end
+      end
+
+      def self.make_payload(params)
+        sign = WxPay::Sign.generate(params)
+        params.delete(:key) if params[:key]
+        "<xml>#{params.map { |k, v| "<#{k}>#{v}</#{k}>" }.join}<sign>#{sign}</sign></xml>"
+      end
+
+      def self.invoke_remote(url, params, need_cert=false)
+        apply_apiclient_cert(params) if need_cert
+        params.merge!(nonce_str: SecureRandom.hex)
+        payload = make_payload(params)
+        r = RestClient::Request.execute(
+          {
+            method: :post,
+            url: url,
+            payload: payload,
+            headers: { content_type: 'application/xml' }
+          }.merge(WxPay.extra_rest_client_options)
+        )
+        if r
+          WxPay::Result.new Hash.from_xml(r)
+        else
+          nil
+        end
+      end
+
+      # 微信退款需要双向证书
+      # https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
+      # https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=4_3
+      def self.apply_apiclient_cert(params)
+        apiclient_cert = WxPay.apiclient_cert(params.delete(:cert_path), params[:mch_id])
+        WxPay.extra_rest_client_options = {
+          ssl_client_cert: apiclient_cert.certificate,
+          ssl_client_key: apiclient_cert.key,
+          verify_ssl: OpenSSL::SSL::VERIFY_NONE
+        }
+      end
+  end
+end

data/lib/wx_pay/sign.rb

@@ -0,0 +1,22 @@
+require 'digest/md5'
+
+module WxPay
+  module Sign
+    def self.generate(params)
+      key = params.delete(:key)
+
+      query = params.sort.map do |key, value|
+        "#{key}=#{value}"
+      end.join('&')
+
+      Digest::MD5.hexdigest("#{query}&key=#{key || WxPay.key}").upcase
+    end
+
+    def self.verify?(params)
+      params = params.dup
+      sign = params.delete('sign') || params.delete(:sign)
+
+      generate(params) == sign
+    end
+  end
+end

data/lib/wx_pay/version.rb

@@ -0,0 +1,3 @@
+module WxPay
+  VERSION = "0.2.1"
+end

data/lib/wx_pay.rb

@@ -0,0 +1,22 @@
+require 'wx_pay/result'
+require 'wx_pay/sign'
+require 'wx_pay/service'
+
+module WxPay
+  class<< self
+    attr_accessor :appid, :mch_id, :key, :apiclient_cert_path
+
+    def extra_rest_client_options=(options)
+      @rest_client_options = options
+    end
+
+    def extra_rest_client_options
+      @rest_client_options || {}
+    end
+
+    def apiclient_cert(cert_path, mch_id)
+      OpenSSL::PKCS12.new(File.read(cert_path), mch_id)
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/hash/conversions'
+require 'minitest/autorun'
+require 'wx_pay'
+require 'fakeweb'
+
+WxPay.appid = 'wxd930ea5d5a258f4f'
+WxPay.key = '8934e7d15453e97507ef794cf7b0519d'
+WxPay.mch_id = '1900000109'
+WxPay.apiclient_cert_path = '/path/to/your/cert/file.p12'

data/test/wx_pay/result_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class WxPay::ResultTest < MiniTest::Test
+  def test_success_method_with_true
+    r = WxPay::Result.new(
+      Hash.from_xml(
+        <<-XML
+        <xml>
+          <return_code>SUCCESS</return_code>
+          <result_code>SUCCESS</result_code>
+        </xml>
+        XML
+      ))
+
+    assert_equal r.success?, true
+  end
+
+  def test_success_method_with_false
+    r = WxPay::Result.new(
+      Hash.from_xml(
+        <<-XML
+        <xml>
+        </xml>
+        XML
+      ))
+
+    assert_equal r.success?, false
+  end
+end

data/test/wx_pay/service_test.rb

@@ -0,0 +1,70 @@
+
+class ServiceTest < MiniTest::Test
+
+  # TODO why put the params of refun in setup method
+  def setup
+    @params = {
+      transaction_id: '1217752501201407033233368018',
+      op_user_id: '10000100',
+      out_refund_no: '1415701182',
+      out_trade_no: '1415757673',
+      refund_fee: 1,
+      total_fee: 1
+    }
+
+    @apiclient_cert = Minitest::Mock.new
+    @apiclient_cert.expect(:certificate, 'certificate')
+    @apiclient_cert.expect(:key, 'key')
+  end
+
+  def test_invoke_refund
+
+
+    response_body = <<-EOF
+     <xml>
+       <return_code><![CDATA[SUCCESS]]></return_code>
+       <return_msg><![CDATA[OK]]></return_msg>
+       <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
+       <mch_id><![CDATA[10000100]]></mch_id>
+       <nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
+       <sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
+       <result_code><![CDATA[SUCCESS]]></result_code>
+       <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
+       <out_trade_no><![CDATA[1415757673]]></out_trade_no>
+       <out_refund_no><![CDATA[1415701182]]></out_refund_no>
+       <refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
+       <refund_channel><![CDATA[]]></refund_channel>
+       <refund_fee>1</refund_fee>
+       <coupon_refund_fee>0</coupon_refund_fee>
+     </xml>
+    EOF
+
+    FakeWeb.register_uri(
+      :post,
+      %r|https://api\.mch\.weixin\.qq\.com*|,
+      body: response_body
+    )
+
+    WxPay.stub :apiclient_cert, @apiclient_cert do
+      r = WxPay::Service.invoke_refund(@params)
+      assert_equal r.success?, true
+    end
+  end
+
+  def test_accept_multiple_app_id_when_invoke
+    params = {
+      body: '测试商品',
+      out_trade_no: 'test003',
+      total_fee: 1,
+      spbill_create_ip: '127.0.0.1',
+      notify_url: 'http://making.dev/notify',
+      trade_type: 'JSAPI',
+      openid: 'OPENID',
+      app_id: 'app_id',
+      mch_id: 'mch_id',
+      key: 'key'
+    }
+    xml_str = '<xml><body>测试商品</body><out_trade_no>test003</out_trade_no><total_fee>1</total_fee><spbill_create_ip>127.0.0.1</spbill_create_ip><notify_url>http://making.dev/notify</notify_url><trade_type>JSAPI</trade_type><openid>OPENID</openid><app_id>app_id</app_id><mch_id>mch_id</mch_id><sign>172A2D487A37D13FDE32B874BA823DD6</sign></xml>'
+    assert_equal xml_str, WxPay::Service.send(:make_payload, params)
+  end
+end

data/test/wx_pay/sign_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class WxPay::SignTest < MiniTest::Test
+  def setup
+    @params = {
+      appid: 'wxd930ea5d5a258f4f',
+      auth_code: 123456,
+      body: 'test',
+      device_info: 123,
+      mch_id: 1900000109,
+      nonce_str: '960f228109051b9969f76c82bde183ac',
+      out_trade_no: '1400755861',
+      spbill_create_ip: '127.0.0.1',
+      total_fee: 1
+    }
+
+    @sign = '729A68AC3DE268DBD9ADE442382E7B24'
+  end
+
+  def test_generate_sign
+    assert_equal @sign, WxPay::Sign.generate(@params)
+  end
+
+  def test_verify_sign
+    assert WxPay::Sign.verify?(@params.merge(:sign => @sign))
+  end
+
+  def test_verify_sign_when_fails
+    assert !WxPay::Sign.verify?(@params.merge(:danger => 'danger', :sign => @sign))
+  end
+
+  def test_accept_pars_key_to_generate_sign
+    @params.merge!(key: "key")
+
+    assert_equal "1454C32E885B8D9E4A05E976D1C45B88", WxPay::Sign.generate(@params)
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: wx_pay_api
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Jasl
+- lanrion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-26 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.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: An unofficial simple wechat pay gem
+email:
+- jasl9187@hotmail.com
+- huaitao-deng@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/wx_pay.rb
+- lib/wx_pay/result.rb
+- lib/wx_pay/service.rb
+- lib/wx_pay/sign.rb
+- lib/wx_pay/version.rb
+- test/test_helper.rb
+- test/wx_pay/result_test.rb
+- test/wx_pay/service_test.rb
+- test/wx_pay/sign_test.rb
+homepage: https://github.com/lanrion/wx_pay_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: An unofficial simple wechat pay gem
+test_files:
+- test/test_helper.rb
+- test/wx_pay/result_test.rb
+- test/wx_pay/service_test.rb
+- test/wx_pay/sign_test.rb