alipay 0.14.0 → 0.15.0

data/lib/alipay.rb

@@ -5,6 +5,7 @@ require 'alipay/utils'
 require 'alipay/sign'
 require 'alipay/sign/md5'
 require 'alipay/sign/rsa'
+require 'alipay/sign/rsa2'
 require 'alipay/sign/dsa'
 require 'alipay/service'
 require 'alipay/notify'
@@ -13,8 +14,7 @@ require 'alipay/wap/notify'
 require 'alipay/wap/sign'
 require 'alipay/mobile/service'
 require 'alipay/mobile/sign'
-require 'alipay/app/service'
-require 'alipay/app/sign'
+require 'alipay/client'
 
 module Alipay
   @debug_mode = true

data/lib/alipay/client.rb

@@ -0,0 +1,194 @@
+module Alipay
+  class Client
+    # Create a client to manage all API request.
+    #
+    # Example:
+    #
+    #   alipay_client = Alipay::Client.new(
+    #     url: 'https://openapi.alipaydev.com/gateway.do',
+    #     app_id: '2016000000000000',
+    #     app_private_key: APP_PRIVATE_KEY,
+    #     alipay_public_key: ALIPAY_PUBLIC_KEY
+    #   )
+    #
+    # Options:
+    #
+    # [:url]  Alipay Open API gateway,
+    #         'https://openapi.alipaydev.com/gateway.do'(Sandbox) or
+    #         'https://openapi.alipay.com/gateway.do'(Production).
+    #
+    # [:app_id] Your APP ID.
+    #
+    # [:app_private_key] APP private key.
+    #
+    # [:alipay_public_key] Alipay public key.
+    #
+    # [:format] default is 'json', only support 'json'.
+    #
+    # [:charset] default is 'UTF-8', only support 'UTF-8'.
+    #
+    # [:sign_type] default is 'RSA2', support 'RSA2', 'RSA', 'RSA2' is recommended.
+    def initialize(options)
+      options = ::Alipay::Utils.stringify_keys(options)
+      @url = options['url']
+      @app_id = options['app_id']
+      @app_private_key = options['app_private_key']
+      @alipay_public_key = options['alipay_public_key']
+      @format = options['format'] || 'json'
+      @charset = options['charset'] || 'UTF-8'
+      @sign_type = options['sign_type'] || 'RSA2'
+    end
+
+    # Generate a query string that use for APP SDK excute.
+    #
+    # Example:
+    #
+    #   alipay_client.sdk_execute(
+    #     method: 'alipay.trade.page.pay',
+    #     biz_content: {
+    #       out_trade_no: '20160401000000',
+    #       product_code: 'QUICK_MSECURITY_PAY',
+    #       total_amount: '0.01',
+    #       subject: 'test'
+    #     }.to_json,
+    #     timestamp: '2016-04-01 00:00:00'
+    #   )
+    #   # => 'app_id=2016000000000000&charset=utf-8&sig....'
+    def sdk_execute(params)
+      params = prepare_params(params)
+
+      URI.encode_www_form(params)
+    end
+
+    # Generate a url that use to redirect user to Alipay payment page.
+    #
+    # Example:
+    #
+    #   assert_equal url, @client.page_execute_url(
+    #     method: 'alipay.trade.page.pay',
+    #     biz_content: {
+    #       out_trade_no: '20160401000000',
+    #       product_code: 'FAST_INSTANT_TRADE_PAY',
+    #       total_amount: '0.01',
+    #       subject: 'test'
+    #     }.to_json,
+    #     timestamp: '2016-04-01 00:00:00'
+    #   )
+    #   # => 'https://openapi.alipaydev.com/gateway.do?app_id=2016...'
+    def page_execute_url(params)
+      params = prepare_params(params)
+
+      uri = URI(@url)
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+
+    # Generate a form string that use to render in view and auto POST to
+    # Alipay server.
+    #
+    # Example:
+    #
+    #   assert_equal url, @client.page_execute_form(
+    #     method: 'alipay.trade.page.pay',
+    #     biz_content: {
+    #       out_trade_no: '20160401000000',
+    #       product_code: 'FAST_INSTANT_TRADE_PAY',
+    #       total_amount: '0.01',
+    #       subject: 'test'
+    #     }.to_json,
+    #     timestamp: '2016-04-01 00:00:00'
+    #   )
+    #   # => '<form id='alipaysubmit' name='alipaysubmit' action=...'
+    def page_execute_form(params)
+      params = prepare_params(params)
+
+      html = %Q(<form id='alipaysubmit' name='alipaysubmit' action='#{@url}' method='POST'>)
+      params.each do |key, value|
+        html << %Q(<input type='hidden' name='#{key}' value='#{value.gsub("'", "&apos;")}'/>)
+      end
+      html << "<input type='submit' value='ok' style='display:none'></form>"
+      html << "<script>document.forms['alipaysubmit'].submit();</script>"
+      html
+    end
+
+    # Immediately make a API request to Alipay and return response body.
+    #
+    # Example:
+    #
+    #   @client.execute(
+    #     method: 'alipay.data.dataservice.bill.downloadurl.query',
+    #     biz_content: {
+    #       bill_type: 'trade',
+    #       bill_date: '2016-04-01'
+    #     }.to_json
+    #   )
+    #   # => '{ "alipay_data_dataservice_bill_downloadurl_query_response":{...'
+    def execute(params)
+      params = prepare_params(params)
+
+      Net::HTTP.post_form(URI(@url), params).body
+    end
+
+    # Generate sign for params.
+    def sign(params)
+      string = params_to_string(params)
+
+      case @sign_type
+      when 'RSA'
+        ::Alipay::Sign::RSA.sign(@app_private_key, string)
+      when 'RSA2'
+        ::Alipay::Sign::RSA2.sign(@app_private_key, string)
+      else
+        raise "Unsupported sign_type: #{@sign_type}"
+      end
+    end
+
+    # Verify Alipay notification.
+    #
+    # Example:
+    #
+    #   params = {
+    #     out_trade_no: '20160401000000',
+    #     trade_status: 'TRADE_SUCCESS'
+    #     sign_type: 'RSA2',
+    #     sign: '...'
+    #   }
+    #   alipay_client.verify?(params)
+    #   # => true / false
+    def verify?(params)
+      params = Utils.stringify_keys(params)
+      return false if params['sign_type'] != @sign_type
+
+      sign = params.delete('sign')
+      # sign_type does not use in notify sign
+      params.delete('sign_type')
+      string = params_to_string(params)
+      case @sign_type
+      when 'RSA'
+        ::Alipay::Sign::RSA.verify?(@alipay_public_key, string, sign)
+      when 'RSA2'
+        ::Alipay::Sign::RSA2.verify?(@alipay_public_key, string, sign)
+      else
+        raise "Unsupported sign_type: #{@sign_type}"
+      end
+    end
+
+    private
+
+    def prepare_params(params)
+      params = {
+        'app_id' => @app_id,
+        'charset' => @charset,
+        'sign_type' => @sign_type,
+        'version' => '1.0',
+        'timestamp' => Time.now.localtime('+08:00').strftime("%Y-%m-%d %H:%M:%S")
+      }.merge(::Alipay::Utils.stringify_keys(params))
+      params['sign'] = sign(params)
+      params
+    end
+
+    def params_to_string(params)
+      params.sort.map { |item| item.join('=') }.join('&')
+    end
+  end
+end

data/lib/alipay/sign/rsa2.rb

@@ -0,0 +1,18 @@
+require 'openssl'
+require 'base64'
+
+module Alipay
+  module Sign
+    class RSA2
+      def self.sign(key, string)
+        rsa = OpenSSL::PKey::RSA.new(key)
+        Base64.strict_encode64(rsa.sign('sha256', string))
+      end
+
+      def self.verify?(key, string, sign)
+        rsa = OpenSSL::PKey::RSA.new(key)
+        rsa.verify('sha256', Base64.strict_decode64(sign), string)
+      end
+    end
+  end
+end

data/lib/alipay/version.rb

@@ -1,3 +1,3 @@
 module Alipay
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alipay
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Rei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,9 +81,11 @@ files:
 - README.md
 - Rakefile
 - alipay.gemspec
+- bin/console
+- config.yml.example
+- doc/legacy_api.md
 - lib/alipay.rb
-- lib/alipay/app/service.rb
-- lib/alipay/app/sign.rb
+- lib/alipay/client.rb
 - lib/alipay/mobile/service.rb
 - lib/alipay/mobile/sign.rb
 - lib/alipay/notify.rb
@@ -92,26 +94,12 @@ files:
 - lib/alipay/sign/dsa.rb
 - lib/alipay/sign/md5.rb
 - lib/alipay/sign/rsa.rb
+- lib/alipay/sign/rsa2.rb
 - lib/alipay/utils.rb
 - lib/alipay/version.rb
 - lib/alipay/wap/notify.rb
 - lib/alipay/wap/service.rb
 - lib/alipay/wap/sign.rb
-- test/alipay/app/service_test.rb
-- test/alipay/app/sign_test.rb
-- test/alipay/mobile/service_test.rb
-- test/alipay/mobile/sign_test.rb
-- test/alipay/notify_test.rb
-- test/alipay/service_test.rb
-- test/alipay/sign/md5_test.rb
-- test/alipay/sign/rsa_test.rb
-- test/alipay/sign_test.rb
-- test/alipay/utils_test.rb
-- test/alipay/wap/notify_test.rb
-- test/alipay/wap/service_test.rb
-- test/alipay/wap/sign_test.rb
-- test/alipay_test.rb
-- test/test_helper.rb
 homepage: https://github.com/chloerei/alipay
 licenses:
 - MIT
@@ -132,23 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: An unofficial simple alipay gem
-test_files:
-- test/alipay/app/service_test.rb
-- test/alipay/app/sign_test.rb
-- test/alipay/mobile/service_test.rb
-- test/alipay/mobile/sign_test.rb
-- test/alipay/notify_test.rb
-- test/alipay/service_test.rb
-- test/alipay/sign/md5_test.rb
-- test/alipay/sign/rsa_test.rb
-- test/alipay/sign_test.rb
-- test/alipay/utils_test.rb
-- test/alipay/wap/notify_test.rb
-- test/alipay/wap/service_test.rb
-- test/alipay/wap/sign_test.rb
-- test/alipay_test.rb
-- test/test_helper.rb
+test_files: []

data/lib/alipay/app/service.rb

@@ -1,27 +0,0 @@
-module Alipay
-  module App
-    module Service
-      ALIPAY_TRADE_APP_PAY_REQUIRED_PARAMS = %w( app_id biz_content notify_url )
-
-      def self.alipay_trade_app_pay(params, options = {})
-        params = Utils.stringify_keys(params)
-        Alipay::Service.check_required_params(params, ALIPAY_TRADE_APP_PAY_REQUIRED_PARAMS)
-        key = options[:key] || Alipay.key
-
-        params = {
-          'method'         => 'alipay.trade.app.pay',
-          'charset'        => 'utf-8',
-          'version'        => '1.0',
-          'timestamp'      => Time.now.utc.strftime('%Y-%m-%d %H:%M:%S').to_s,
-          'sign_type'      => 'RSA'
-        }.merge(params)
-
-        string = Alipay::App::Sign.params_to_sorted_string(params)
-        sign = CGI.escape(Alipay::Sign::RSA.sign(key, string))
-        encoded_string = Alipay::App::Sign.params_to_encoded_string(params)
-
-        %Q(#{encoded_string}&sign=#{sign})
-      end
-    end
-  end
-end

data/lib/alipay/app/sign.rb

@@ -1,39 +0,0 @@
-require 'erb'
-
-module Alipay
-  module App
-    module Sign
-      ALIPAY_RSA_PUBLIC_KEY = <<-EOF
------BEGIN PUBLIC KEY-----
-MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDI6d306Q8fIfCOaTXyiUeJHkr
-IvYISRcc73s3vF1ZT7XN8RNPwJxo8pWaJMmvyTn9N4HQ632qJBVHf8sxHi/fEsra
-prwCtzvzQETrNRwVxLO5jVmRGi60j8Ue1efIlzPXV9je9mkjzOmdssymZkh2QhUr
-CmZYI/FCEa3/cNMW0QIDAQAB
------END PUBLIC KEY-----
-      EOF
-
-      def self.verify?(params)
-        params = ::Alipay::Utils.stringify_keys(params)
-
-        sign_type = params.delete('sign_type')
-        sign = params.delete('sign')
-        string = ::Alipay::Sign.params_to_string(params)
-
-        case sign_type
-        when 'RSA'
-          ::Alipay::Sign::RSA.verify?(ALIPAY_RSA_PUBLIC_KEY, string, sign)
-        else
-          false
-        end
-      end
-
-      def self.params_to_sorted_string(params)
-        params.sort.map { |key, value| %Q(#{key}=#{value.to_s}) }.join('&')
-      end
-
-      def self.params_to_encoded_string(params)
-        params.sort.map { |key, value| %Q(#{key}=#{ERB::Util.url_encode(value.to_s)}) }.join('&')
-      end
-    end
-  end
-end

data/test/alipay/app/service_test.rb

@@ -1,20 +0,0 @@
-require 'test_helper'
-
-class Alipay::Mobile::ServiceTest < Minitest::Test
-  def test_mobile_securitypay_pay_string
-    assert_equal %q(app_id=2015052600090779&biz_content=%7B%3Atimeout_express%3D%3E%2230m%22%2C%20%3Aseller_id%3D%3E%22%22%2C%20%3Aproduct_code%3D%3E%22QUICK_MSECURITY_PAY%22%2C%20%3Atotal_amount%3D%3E%220.01%22%2C%20%3Asubject%3D%3E%221%22%2C%20%3Abody%3D%3E%22%E6%88%91%E6%98%AF%E6%B5%8B%E8%AF%95%E6%95%B0%E6%8D%AE%22%2C%20%3Aout_trade_no%3D%3E%22IQJZSRC1YMQB5HU%22%7D&charset=utf-8&format=json&method=alipay.trade.app.pay&notify_url=http%3A%2F%2Fdomain.merchant.com%2Fpayment_notify&sign_type=RSA&timestamp=2016-08-25%2020%3A26%3A31&version=1.0&sign=lT%2BwWRpKYDP4QLm8Ore6ngGQv8aHGPw1OuI2e8pRf5aWO55sTAYqN01uJyKDe3Swzat8UYdvby8o9haA3LPQibYXB2sezkZxOBHpfdKVRjXe0u9qTMlACAQUQLQeXQFNfcWRgKUGNLMHARv7ajqz8tCnDN2B3mlAmKs0r4qb6IM%3D), Alipay::App::Service.alipay_trade_app_pay({
-      app_id: '2015052600090779',
-      biz_content: {:timeout_express=>"30m",:seller_id=>"",:product_code=>"QUICK_MSECURITY_PAY",:total_amount=>"0.01",:subject=>"1",:body=>"我是测试数据",:out_trade_no=>"IQJZSRC1YMQB5HU"},
-      charset: 'utf-8',
-      format: 'json',
-      method: 'alipay.trade.app.pay',
-      notify_url: 'http://domain.merchant.com/payment_notify',
-      sign_type: 'RSA',
-      timestamp: '2016-08-25 20:26:31',
-      version: '1.0'
-    }, {
-      sign_type: 'RSA',
-      key: TEST_RSA_PRIVATE_KEY
-    })
-  end
-end

data/test/alipay/app/sign_test.rb

@@ -1,15 +0,0 @@
-require 'test_helper'
-
-class Alipay::App::SignTest < Minitest::Test
-  def test_params_to_sorted_string
-    assert_equal %q(a=2&b=1), Alipay::App::Sign.params_to_sorted_string(b: 1, a: 2)
-  end
-
-  def test_params_to_encoded_string
-    assert_equal %q(biz_content=%7B%3Aname%3D%3E%22%E9%A1%BA%E9%81%93%22%7D&out_trade_no=MEM1234567&total_amount=0.01), Alipay::App::Sign.params_to_encoded_string(
-      biz_content: {:name=>'顺道'},
-      out_trade_no: 'MEM1234567',
-      total_amount: '0.01'
-    )
-  end
-end

data/test/alipay/mobile/service_test.rb

@@ -1,16 +0,0 @@
-require 'test_helper'
-
-class Alipay::Mobile::ServiceTest < Minitest::Test
-  def test_mobile_securitypay_pay_string
-    assert_equal %q(service="mobile.securitypay.pay"&_input_charset="utf-8"&partner="1000000000000000"&seller_id="1000000000000000"&payment_type="1"&out_trade_no="1"&notify_url="/some_url"&subject="subject"&total_fee="0.01"&body="test"&sign="if1qjK4qnT7eQ5fw%2BBddHhO1LY6iuPY9Xmhkx81YKuCdceKWBdv798j%2BrxF9ZAhNW4Y3TMURm%2BXpgxhOh8lj8vorFup%2BMJ6fe2rXRWgxFhK9B8xuP2XH%2F3878g6d8Jq2D2gINTgDDL7%2BB5%2FIWWlwInas40cQTsVngG8mWkzB788%3D"&sign_type="RSA"), Alipay::Mobile::Service.mobile_securitypay_pay_string({
-      out_trade_no: '1',
-      notify_url: '/some_url',
-      subject: 'subject',
-      total_fee: '0.01',
-      body: 'test'
-    }, {
-      sign_type: 'RSA',
-      key: TEST_RSA_PRIVATE_KEY
-    })
-  end
-end

data/test/alipay/mobile/sign_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class Alipay::Mobile::SignTest < Minitest::Test
-  def test_params_to_string
-    assert_equal %q(a="1"&b="2"), Alipay::Mobile::Sign.params_to_string(a: 1, b: 2)
-  end
-end