alipay 0.15.0 → 0.15.1

data/doc/rsa_key_cn.md

@@ -0,0 +1,64 @@
+# 配合支付宝使用RSA密钥
+
+[English](rsa_key_en.md)
+
+## 导航
+* [生成应用密钥](#生成应用密钥)
+* [验证参数](#验证参数)
+* [补充格式到支付宝公钥](#补充格式到支付宝公钥)
+
+### 生成应用密钥
+#### 在 Ruby 下生成 RSA2 密钥
+这个会示范在 Ruby 环境下生成RSA2密钥。支付宝推荐使用RSA2密钥来验证。
+```ruby
+require 'openssl'
+
+@app_key = OpenSSL::PKey::RSA.new(2048)
+```
+#### 保存密钥
+你可以使用以下任一方式来保存你的私钥和公钥
+
+将私钥保存到字符串
+```ruby
+app_private_key = @app_key.to_s
+```
+
+将私钥保存为证书文件
+```ruby
+open 'private_key.pem', 'w' do |io| io.write @app_key.to_pem end
+```
+
+将公钥保存到字符串
+```ruby
+app_public_key = @app_key.public_key.to_s
+```
+将公钥保存为证书文件
+```ruby
+open 'public_key.pem', 'w' do |io| io.write @app_key.public_key.to_pem end
+```
+
+#### 提取钥匙内容
+你需要给支付宝提供你所先前生成的公钥内容。但是提供给支付宝之前需要对 Ruby 生成的公钥进行格式清理。清理完后，将清理好的公钥内容提供给支付宝即可。
+```ruby
+key_content = app_public_key.gsub(/(-----BEGIN PUBLIC KEY-----)|(-----END PUBLIC KEY-----)|(\n)/, "")
+puts key_content
+# => 'MII0ey6QDZLB69i0e5Q0....'
+```
+
+### 验证参数
+当你提交你的应用公钥给支付宝后，有一个可选的步骤是验证你的公钥的有效性。支付宝会提供一个参数让你使用你的私钥签名。把签名结果粘贴到支付宝后，支付宝会使用你上传的公钥来解密验证。
+```ruby
+# validate params "a=123"
+Base64.strict_encode64(@app_key.sign('sha256', "a=123"))
+# => 'FokDu5uwgmNG2O/cb0QYD....'
+```
+
+### 补充格式到支付宝公钥
+你上传你的公钥后，支付宝会提供他们的公钥给你的应用来验证支付宝回调的内容有效性。但是他们提供公钥不带格式，所以 Ruby 的 OpneSSL 可能无法识别。将格式补充到支付宝所提供的公钥，你可以使用以下运行脚本。
+
+```ruby
+pub_key = "MIIBI...HpwIDAQAB"
+pub_key.scan(/.{64}|.+$/).join("\n").insert(0, "-----BEGIN PUBLIC KEY-----\n").insert(-1, "\n-----END PUBLIC KEY-----\n")
+# => "-----BEGIN PUBLIC KEY-----\nMIIBI...\n-----END PUBLIC KEY-----\n"
+```
+

data/doc/rsa_key_en.md

@@ -0,0 +1,77 @@
+# RSA Key for Alipay
+
+[中文](rsa_key_cn.md)
+
+## Table of Contents
+
+* [Generate Application Key](#generate-application-key)
+  * [Generate RSA2 Keypair in Ruby](#generate-rsa2-keypair-in-ruby)
+  * [Saving Key](#saving-key)
+  * [Extract Key Content](#extract-key-content)
+* [Signing Parameters](#signing-parameters)
+* [Formatting the Public Key from Alipay](#formatting-the-public-key-from-alipay)
+
+### Generate Application Key
+#### Generate RSA2 Keypair in Ruby
+This example creates a 2048 bits RSA2 key. It is recommended by Alipay that
+you use a RSA2 key.
+```ruby
+require 'openssl'
+
+@app_key = OpenSSL::PKey::RSA.new(2048)
+```
+#### Saving Key
+You can save your private and public key as any of two formats. As long as it can be loaded into the program.
+
+Saving Private Key to String
+```ruby
+app_private_key = @app_key.to_s
+```
+
+Saving Private Key to File
+```ruby
+open 'private_key.pem', 'w' do |io| io.write @app_key.to_pem end
+```
+
+Saving Public Key to String
+```ruby
+app_public_key = @app_key.public_key.to_s
+```
+
+Saving Public Key to File
+```ruby
+open 'public_key.pem', 'w' do |io| io.write @app_key.public_key.to_pem end
+```
+
+#### Extract Key Content
+You will need to submit the application public key that you just created
+to Alipay. However, you will need to strip the header, footer, and new line
+characters from the key and just submit the key content to Alipay.
+```ruby
+key_content = app_public_key.gsub(/(-----BEGIN PUBLIC KEY-----)|(-----END PUBLIC KEY-----)|(\n)/, "")
+puts key_content
+# => 'MII0ey6QDZLB69i0e5Q0....'
+```
+
+### Signing Parameters
+After you submit your application's public key to Alipay. There is an optional
+step to validate the public key that you just uploaded by signing a parameter
+provided by Alipay.
+
+```ruby
+# validate params "a=123"
+Base64.strict_encode64(@app_key.sign('sha256', "a=123"))
+# => 'FokDu5uwgmNG2O/cb0QYD....'
+```
+
+### Formatting the Public Key from Alipay
+The public key from Alipay does not contain any formatting. Ruby's OpenSSL
+library cannot import/read the public key without proper formatting. To add
+formatting back, run the following script.
+
+```ruby
+pub_key = "MIIBI...HpwIDAQAB"
+pub_key.scan(/.{64}|.+$/).join("\n").insert(0, "-----BEGIN PUBLIC KEY-----\n").insert(-1, "\n-----END PUBLIC KEY-----\n")
+# => "-----BEGIN PUBLIC KEY-----\nMIIBI...\n-----END PUBLIC KEY-----\n"
+```
+

data/lib/alipay/client.rb

@@ -44,13 +44,13 @@ module Alipay
     # Example:
     #
     #   alipay_client.sdk_execute(
-    #     method: 'alipay.trade.page.pay',
+    #     method: 'alipay.trade.app.pay',
     #     biz_content: {
     #       out_trade_no: '20160401000000',
     #       product_code: 'QUICK_MSECURITY_PAY',
     #       total_amount: '0.01',
     #       subject: 'test'
-    #     }.to_json,
+    #     }.to_json(ascii_only: true),
     #     timestamp: '2016-04-01 00:00:00'
     #   )
     #   # => 'app_id=2016000000000000&charset=utf-8&sig....'
@@ -64,14 +64,14 @@ module Alipay
     #
     # Example:
     #
-    #   assert_equal url, @client.page_execute_url(
+    #   alipay_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,
+    #     }.to_json(ascii_only: true),
     #     timestamp: '2016-04-01 00:00:00'
     #   )
     #   # => 'https://openapi.alipaydev.com/gateway.do?app_id=2016...'
@@ -88,14 +88,14 @@ module Alipay
     #
     # Example:
     #
-    #   assert_equal url, @client.page_execute_form(
+    #   alipay_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,
+    #     }.to_json(ascii_only: true),
     #     timestamp: '2016-04-01 00:00:00'
     #   )
     #   # => '<form id='alipaysubmit' name='alipaysubmit' action=...'
@@ -115,12 +115,12 @@ module Alipay
     #
     # Example:
     #
-    #   @client.execute(
+    #   alipay_client.execute(
     #     method: 'alipay.data.dataservice.bill.downloadurl.query',
     #     biz_content: {
     #       bill_type: 'trade',
     #       bill_date: '2016-04-01'
-    #     }.to_json
+    #     }.to_json(ascii_only: true)
     #   )
     #   # => '{ "alipay_data_dataservice_bill_downloadurl_query_response":{...'
     def execute(params)

data/lib/alipay/mobile/service.rb

@@ -12,8 +12,8 @@ module Alipay
         params = {
           'service'        => 'mobile.securitypay.pay',
           '_input_charset' => 'utf-8',
-          'partner'        => options[:pid] || Alipay.pid,
-          'seller_id'      => options[:pid] || Alipay.pid,
+          'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+          'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
           'payment_type'   => '1'
         }.merge(params)
 

data/lib/alipay/service.rb

@@ -10,8 +10,8 @@ module Alipay
       params = {
         'service'        => 'create_partner_trade_by_buyer',
         '_input_charset' => 'utf-8',
-        'partner'        => options[:pid] || Alipay.pid,
-        'seller_id'      => options[:pid] || Alipay.pid,
+        'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+        'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
         'payment_type'   => '1'
       }.merge(params)
 
@@ -26,8 +26,8 @@ module Alipay
       params = {
         'service'        => 'trade_create_by_buyer',
         '_input_charset' => 'utf-8',
-        'partner'        => options[:pid] || Alipay.pid,
-        'seller_id'      => options[:pid] || Alipay.pid,
+        'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+        'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
         'payment_type'   => '1'
       }.merge(params)
 
@@ -46,8 +46,8 @@ module Alipay
       params = {
         'service'        => 'create_direct_pay_by_user',
         '_input_charset' => 'utf-8',
-        'partner'        => options[:pid] || Alipay.pid,
-        'seller_id'      => options[:pid] || Alipay.pid,
+        'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+        'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
         'payment_type'   => '1'
       }.merge(params)
 
@@ -62,8 +62,8 @@ module Alipay
       params = {
         'service'        => 'alipay.wap.create.direct.pay.by.user',
         '_input_charset' => 'utf-8',
-        'partner'        => options[:pid] || Alipay.pid,
-        'seller_id'      => options[:pid] || Alipay.pid,
+        'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+        'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
         'payment_type'   => '1'
       }.merge(params)
 
@@ -202,8 +202,8 @@ module Alipay
       params = {
         'service'        => 'create_forex_trade_wap',
         '_input_charset' => 'utf-8',
-        'partner'        => options[:pid] || Alipay.pid,
-        'seller_id'      => options[:pid] || Alipay.pid
+        'partner'        => options[:partner]   || options[:pid] || Alipay.pid,
+        'seller_id'      => options[:seller_id] || options[:pid] || Alipay.pid,
       }.merge(params)
 
       request_uri(params, options).to_s

data/lib/alipay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alipay
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Rei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2018-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,10 @@ files:
 - bin/console
 - config.yml.example
 - doc/legacy_api.md
+- doc/quick_start_cn.md
+- doc/quick_start_en.md
+- doc/rsa_key_cn.md
+- doc/rsa_key_en.md
 - lib/alipay.rb
 - lib/alipay/client.rb
 - lib/alipay/mobile/service.rb