alipay 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0263d712442ba533d3fb7cca219555ba9da7b6
-  data.tar.gz: 84207578dd886906c9c6c682e637a56d0f247081
+  metadata.gz: c8ae97dc76dc98045ecff6a9e98ad1dca72a6d8e
+  data.tar.gz: 82a2d12669ddf0a1ece485b56db7591f503c166b
 SHA512:
-  metadata.gz: a198e204920d8b1c04ff4d4aa970524702478adeac9fcf61b4f0074c75eca23fab9c80b3009cb6324367d62cc3a06363bc74c9de7be7efb64c098da9b66b8fce
-  data.tar.gz: 49556906be591bef1d1b9a54ba61a91e6ea0712d96beca27fd988937221a48b7139681cccf8564ebc8f291bbb5444d88aa505525173175321b09539209d82c73
+  metadata.gz: 27f157fc206253037e9753eb450f0a17f05ee8cb88d599f1a8f33be5166a1ccf481a4e9a8227f7e4fb223b6d6359b0d5fef34653d32a7fcea729cd199a6e67ec
+  data.tar.gz: 5b876eb6dcac358e66bed557dc1acfc72bf3110b274a48cae55174496d7779b4cde89f85949c7e37d94e7267a837d8dfb76d8d133a38f43c373f905277041074

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.4.0 (2015-01-23)
+
+- Add `single_trade_query` service. #19
+
 ## v0.3.1 (2015-01-15)
 
 - Fix xml encoding #18

data/README.md

@@ -45,8 +45,8 @@ Alipay.seller_email = 'YOUR_SELLER_EMAIL'
 
 ```ruby
 options = {
-  :out_trade_no      => 'YOUR_ORDER_ID',         # 20130801000001
-  :subject           => 'YOUR_ORDER_SUBJECCT',   # Writings.io Base Account x 12
+  :out_trade_no      => 'YOUR_ORDER_ID',
+  :subject           => 'YOUR_ORDER_SUBJECCT',
   :logistics_type    => 'DIRECT',
   :logistics_fee     => '0',
   :logistics_payment => 'SELLER_PAY',
@@ -128,6 +128,18 @@ If Alipay fail to close trade, this method will return XML similar to:
 </alipay>
 ```
 
+## Single trade query
+
+The parameters same as [Close trade](#user-content-close-trade)
+
+```ruby
+Alipay::Service.single_trade_query(
+  :trade_no     => 'TRADE_NO',
+  :out_order_no => 'the-out-order-no'
+)
+# => '<?xml version="1.0" encoding="utf-8"?><alipay><is_success>T</is_success><request><param name="trade_no">TRADE_NO</param><param name="_input_charset">utf-8</param><param name="service">single_trade_query</param><param name="partner">PARTNER</param></request><response><trade><additional_trade_status>DAEMON_CONFIRM_CLOSE</additional_trade_status><buyer_email>foo@gmail.com</buyer_email><buyer_id>BUYER_ID</buyer_id><discount>0.00</discount><flag_trade_locked>0</flag_trade_locked><gmt_close>2015-01-20 02:37:00</gmt_close><gmt_create>2015-01-20 02:17:00</gmt_create><gmt_last_modified_time>2015-01-20 02:37:00</gmt_last_modified_time><is_total_fee_adjust>F</is_total_fee_adjust><operator_role>B</operator_role><out_trade_no>OUT_TRADE_NO</out_trade_no><payment_type>1</payment_type><price>640.00</price><quantity>1</quantity><seller_email>bar@example.com</seller_email><seller_id>SELLER_ID</seller_id><subject>YOUR ORDER SUBJECT</subject><to_buyer_fee>0.00</to_buyer_fee><to_seller_fee>0.00</to_seller_fee><total_fee>640.00</total_fee><trade_no>TRADE_NO</trade_no><trade_status>TRADE_CLOSED</trade_status><use_coupon>F</use_coupon></trade></response><sign>SIGN</sign><sign_type>MD5</sign_type></alipay>'
+```
+
 ### Refund
 
 ```ruby

data/lib/alipay/service.rb

@@ -114,6 +114,7 @@ module Alipay
     end
 
     CLOSE_TRADE_REQUIRED_OPTIONS = %w( service partner _input_charset)
+    CLOSE_TRADE_REQUIRED_OPTIONAL_OPTIONS = %w( trade_no out_order_no )
     def self.close_trade(options)
       options = {
         'service'        => 'close_trade',
@@ -122,10 +123,22 @@ module Alipay
       }.merge(Utils.stringify_keys(options))
 
       check_required_options(options, CLOSE_TRADE_REQUIRED_OPTIONS)
+      check_optional_options(options, CLOSE_TRADE_REQUIRED_OPTIONAL_OPTIONS)
 
-      if options['trade_no'].nil? and options['out_order_no'].nil?
-        warn("Ailpay Warn: must specify either trade_no or out_order_no")
-      end
+      open("#{GATEWAY_URL}?#{query_string(options)}").read
+    end
+
+    SINGLE_TRADE_QUERY_OPTIONS = %w( service partner _input_charset)
+    SINGLE_TRADE_QUERY_OPTIONAL_OPTIONS = %w( trade_no out_order_no )
+    def self.single_trade_query(options)
+      options =   {
+        "service"         => 'single_trade_query',
+        "_input_charset"  => "utf-8",
+        "partner"         => Alipay.pid,
+      }.merge(Utils.stringify_keys(options))
+
+      check_required_options(options, SINGLE_TRADE_QUERY_OPTIONS)
+      check_optional_options(options, SINGLE_TRADE_QUERY_OPTIONAL_OPTIONS)
 
       open("#{GATEWAY_URL}?#{query_string(options)}").read
     end
@@ -141,5 +154,9 @@ module Alipay
         warn("Ailpay Warn: missing required option: #{name}") unless options.has_key?(name)
       end
     end
+
+    def self.check_optional_options(options, names)
+      warn("Ailpay Warn: must specify either #{names.join(' or ')}") if names.all? {|name| options[name].nil? }
+    end
   end
 end

data/lib/alipay/version.rb

@@ -1,3 +1,3 @@
 module Alipay
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/test/alipay/service_test.rb

@@ -81,6 +81,58 @@ class Alipay::ServiceTest < Test::Unit::TestCase
     )
   end
 
+  def test_single_trade_query
+    response_body = <<-EOF
+      <?xml version="1.0" encoding="utf-8"?>
+      <alipay>
+        <is_success>T</is_success>
+        <request>
+          <param name="trade_no">20150123123123</param>
+          <param name="_input_charset">utf-8</param>
+          <param name="service">single_trade_query</param>
+          <param name="partner">PARTNER</param>
+        </request>
+        <response>
+          <trade>
+            <additional_trade_status>DAEMON_CONFIRM_CLOSE</additional_trade_status>
+            <buyer_email>foo@gmail.com</buyer_email>
+            <buyer_id>BUYER_ID</buyer_id>
+            <discount>0.00</discount>
+            <flag_trade_locked>0</flag_trade_locked>
+            <gmt_close>2015-01-20 02:37:00</gmt_close>
+            <gmt_create>2015-01-20 02:17:00</gmt_create>
+            <gmt_last_modified_time>2015-01-20 02:37:00</gmt_last_modified_time>
+            <is_total_fee_adjust>F</is_total_fee_adjust>
+            <operator_role>B</operator_role>
+            <out_trade_no>OUT_TRADE_NO</out_trade_no>
+            <payment_type>1</payment_type>
+            <price>640.00</price>
+            <quantity>1</quantity>
+            <seller_email>bar@gmail.com</seller_email>
+            <seller_id>SELLER_ID</seller_id>
+            <subject>ORDER SUBJECT</subject>
+            <to_buyer_fee>0.00</to_buyer_fee>
+            <to_seller_fee>0.00</to_seller_fee>
+            <total_fee>640.00</total_fee>
+            <trade_no>TRADE_NO</trade_no>
+            <trade_status>TRADE_CLOSED</trade_status>
+            <use_coupon>F</use_coupon>
+            </trade></response>
+            <sign>SIGN</sign>
+            <sign_type>MD5</sign_type>
+          </alipay>
+    EOF
+    FakeWeb.register_uri(
+      :get,
+      %r|https://mapi\.alipay\.com/gateway\.do.*|,
+      :body => response_body
+    )
+
+    assert_equal response_body, Alipay::Service.single_trade_query(
+      :out_order_no => 'the-out-order-no'
+    )
+  end
+
   def test_should_send_goods_confirm_by_platform
     body = <<-EOF
       <?xml version="1.0" encoding="utf-8"?>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alipay
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Rei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler