pingpp 2.1.3 → 2.2.0

data/test/batch_refund_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class BatchRefundTest < Test::Unit::TestCase
+    should "execute should return a new batch_refund when passed correct parameters" do
+      batch_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :app => get_app_id,
+        :batch_no => batch_no,
+        :charges => make_charges_for_batch_refund,
+        :description => 'This is a batch_refund test.',
+        :metadata => {
+          :custom_key => 'custom_content'
+        }
+      }
+
+      batre = Pingpp::BatchRefund.create(params)
+      assert batre.object == 'batch_refund'
+
+      assert batre.charges == params[:charges]
+      assert batre.batch_no = params[:batch_no]
+    end
+
+    should "execute should return a batch_refund list" do
+      batres = Pingpp::BatchRefund.list(:per_page => 3)
+
+      assert batres.object == 'list'
+      assert batres.url.start_with?('/v1/batch_refunds')
+      assert batres.data.length <= 3
+    end
+
+    should "execute should return an exist batch_refund when passed correct id" do
+      batre = Pingpp::BatchRefund.retrieve(get_bat_re_id)
+
+      assert batre.id == get_bat_re_id
+      assert batre.object == 'batch_refund'
+    end
+  end
+end

data/test/batch_transfer_test.rb

@@ -0,0 +1,61 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class BatchTransferTest < Test::Unit::TestCase
+    should "execute should return a new batch_transfer when passed correct parameters" do
+      batch_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :app => get_app_id,
+        :batch_no => batch_no,
+        :channel => 'alipay',
+        :amount => 1000,
+        :type => 'b2c',
+        :description => 'This is a batch_transfer test.',
+        :metadata => {
+          :custom_key => 'custom_content'
+        },
+        :currency => 'cny',
+        :recipients => [
+          {
+            :account => 'account01@gmail.com',
+            :amount => 300,
+            :name => 'name01'
+          }, {
+            :account => 'account02@gmail.com',
+            :amount => 300,
+            :name => 'name02'
+          }, {
+            :account => 'account03@gmail.com',
+            :amount => 400,
+            :name => 'name03'
+          }
+        ]
+      }
+
+      battr = Pingpp::BatchTransfer.create(params)
+
+      assert battr.object == 'batch_transfer'
+      assert battr.amount == params[:amount]
+      assert battr.batch_no = params[:batch_no]
+      assert battr.app == params[:app]
+      assert battr.recipients.count == params[:recipients].count
+    end
+
+    should "execute should return a batch_transfer list" do
+      batres = Pingpp::BatchTransfer.list(:per_page => 3)
+
+      assert batres.object == 'list'
+      assert batres.url.start_with?('/v1/batch_transfers')
+      assert batres.data.count <= 3
+    end
+
+    should "execute should return an exist batch_transfer when passed correct id" do
+      batre = Pingpp::BatchTransfer.retrieve(get_bat_tr_id)
+
+      assert batre.id == get_bat_tr_id
+      assert batre.object == 'batch_transfer'
+    end
+  end
+end

data/test/batch_withdrawal_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class BatchWithdrawalTest < Test::Unit::TestCase
+    # 创建 batch_withdrawal (确认)
+    should "return a batch_withdrawal object when passed correct parameters" do
+      withdrawal_ids = get_created_withdrawals
+      if withdrawal_ids.count > 0
+        params = {
+          :withdrawals  => withdrawal_ids,
+
+          # optional|string; 确认为 pending，取消为 canceled
+          :status => "pending",
+        }
+        o = Pingpp::BatchWithdrawal.create(params)
+
+        assert o.kind_of?(Pingpp::BatchWithdrawal)
+      end
+    end
+
+    # 创建 batch_withdrawal (取消)
+    should "return a batch_withdrawal(canceled) object when passed correct parameters" do
+      withdrawal_ids = get_created_withdrawals
+      if withdrawal_ids.count > 0
+        params = {
+          :withdrawals  => withdrawal_ids,
+
+          # optional|string; 确认为 pending，取消为 canceled
+          :status => "canceled",
+        }
+        o = Pingpp::BatchWithdrawal.create(params)
+
+        assert o.kind_of?(Pingpp::BatchWithdrawal)
+      end
+    end
+
+    # 查询单笔 batch_withdrawal
+    should "return an existed batch_withdrawal object when passed correct id" do
+      o = Pingpp::BatchWithdrawal.retrieve(existed_batch_withdrawal_id)
+
+      assert o.kind_of?(Pingpp::BatchWithdrawal)
+    end
+
+    # 查询 batch_withdrawal 列表
+    should "return a batch_withdrawal list object" do
+      params = {
+        :page => 1,
+        :per_page => 3,
+      }
+      o = Pingpp::BatchWithdrawal.list(params)
+
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::BatchWithdrawal)
+    end
+
+    def get_created_withdrawals
+      o = Pingpp::Withdrawal.list(
+        {
+          :per_page => 1,
+          :page => 1,
+          :status => 'created',
+          :channel => 'alipay',
+          :created => { :gte => 1503158400 }
+        },
+        { :app => get_app_id } # App 信息
+      )
+
+      withdrawals = []
+      o.data.each { |withdrawal|
+        withdrawals.push(withdrawal.id)
+      }
+
+      return withdrawals
+    end
+  end
+end

data/test/charge_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class ChargeTest < Test::Unit::TestCase
+    should "execute should return a new, fully executed charge when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+      channel = 'wx'
+
+      params = {
+        :order_no  => order_no,
+        :app       => { :id => get_app_id },
+        :channel   => channel, # 支付使用的第三方支付渠道取值，请参考：https://www.pingxx.com/api#api-c-new
+        :amount    => 128000, # 订单总金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100）
+        :client_ip => "127.0.0.1", # 发起支付请求客户端的 IP 地址，格式为 IPV4，如: 127.0.0.1
+        :currency  => "cny",
+        :subject   => "Your Subject",
+        :body      => "Your Body",
+        :extra     => {}
+      }
+
+      c = Pingpp::Charge.create(params)
+
+      assert c.order_no == params[:order_no]
+      assert c.app == get_app_id
+      assert c.channel == params[:channel]
+      assert c.amount == params[:amount]
+      assert c.paid == false
+    end
+
+    should "execute should return a charge list when passed correct parameters" do
+      l = Pingpp::Charge.list(
+        :app => { :id => get_app_id },
+        :limit => 3,
+        :paid => true,
+        :refunded => false
+      )
+
+      assert l.object == 'list'
+      assert l.data.count <= 3
+    end
+
+    should "execute should return an exist charge when passed correct charge id" do
+      ch_id = get_charge_id
+      c = Pingpp::Charge.retrieve(ch_id)
+
+      assert c.object == 'charge'
+      assert c.id == ch_id
+    end
+  end
+end

data/test/coupon_template_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class CouponTemplateTest < Test::Unit::TestCase
+    # 创建优惠券模版
+    should "execute should return a new coupon_template when passed correct parameters" do
+      ctmpl = Pingpp::CouponTemplate.create({
+        # 类型  required|integer; 优惠券模板的类型 1：现金券；2：折扣券
+        :type => 1,
+
+        # 折扣金额  conditional|integer; 当 type 为 1 时，必传。
+        :amount_off => 30,
+
+        # 折扣百分比  conditional|integer; 例: 20 表示 8 折, 100 表示免费。当 type 为 2 时，必传。
+        # :percent_off => 15,
+
+        # optional|integer; 订单金额大于等于该值时，优惠券有效（适用于满减）；0 表示无限制，默认 0。
+        :amount_available => 100,
+      })
+
+      assert ctmpl.kind_of?(Pingpp::CouponTemplate)
+    end
+
+    # 查询优惠券模板列表
+    should "execute should return a coupon_template list when passed correct parameters" do
+      ctmpl = Pingpp::CouponTemplate.list({:per_page => 3})
+
+      assert ctmpl.kind_of?(Pingpp::ListObject)
+      assert ctmpl.data.count <= 3
+      assert ctmpl.data[0].kind_of?(Pingpp::CouponTemplate)
+    end
+
+    # 查询优惠券模板
+    should "execute should return an exist coupon_template when passed correct id" do
+      ctmpl = Pingpp::CouponTemplate.retrieve(get_coupon_template_id)
+
+      assert ctmpl.kind_of?(Pingpp::CouponTemplate)
+      assert ctmpl.object == 'coupon_template'
+      assert ctmpl.id == get_coupon_template_id
+    end
+
+    # 更新优惠券模板
+    should "execute should return an updated coupon_template when passed correct id" do
+      new_params = { :metadata => { :custom_key => Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12] }}
+      ctmpl = Pingpp::CouponTemplate.update(
+        get_coupon_template_id,
+        new_params
+      )
+
+      assert ctmpl.kind_of?(Pingpp::CouponTemplate)
+      assert ctmpl.id == get_coupon_template_id
+      assert ctmpl.metadata.custom_key == new_params[:metadata][:custom_key]
+    end
+
+    # 删除优惠券模板
+    should "return a deleted object when passed existed coupon_template id" do
+      begin
+        o = Pingpp::CouponTemplate.delete(coupon_template_id_to_delete)
+
+        assert o.deleted
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("未找到") || e.message.include?("No such coupon_template")
+      end
+    end
+  end
+end

data/test/coupon_test.rb

@@ -0,0 +1,81 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class CouponTest < Test::Unit::TestCase
+    # 为用户创建优惠券
+    should "return a new coupon for user when passed correct parameters" do
+      begin
+        o = Pingpp::Coupon.create(
+          { :coupon_template => existed_coupon_template_id },
+          { :user => get_user_id }
+        )
+
+        assert o.kind_of?(Pingpp::Coupon)
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError) || e.kind_of?(Pingpp::ChannelError)
+        assert e.message.include?("优惠券已到达当前用户最大生成数量") || e.message.include?("coupon exceed max user circulation")
+      end
+    end
+
+    # 查询用户的优惠券列表
+    should "execute should return a coupon when passed correct parameters" do
+      coupons = Pingpp::Coupon.list({:per_page => 3}, {:user => get_user_id})
+
+      assert coupons.kind_of?(Pingpp::ListObject)
+      assert coupons.data.count <= 3
+      assert coupons.data[0].kind_of?(Pingpp::Coupon)
+    end
+
+    # 查询用户的优惠券
+    should "execute should return a coupon object when passed correct parameters" do
+      coupon_id, user_id = coupon_id_and_user
+      coupon = Pingpp::Coupon.retrieve(coupon_id, {:user => user_id})
+
+      assert coupon.kind_of?(Pingpp::Coupon)
+    end
+
+    # 更新用户的优惠券
+    should "return a updated coupon object when passed correct id and parameters" do
+      coupon_id, user_id = coupon_id_and_user_to_update
+      o = Pingpp::Coupon.update(
+        coupon_id,
+        { :metadata => { :new_key => 'new value' } },
+        { :user => user_id }
+      )
+
+      assert o.kind_of?(Pingpp::Coupon)
+    end
+
+    # 删除用户的优惠券
+    should "execute should return a deleted object when passed correct parameters" do
+      coupon_id, user_id = coupon_id_and_user_to_delete
+      begin
+        deleted = Pingpp::Coupon.delete(coupon_id, {}, {:user => user_id})
+
+        assert deleted.deleted
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("未找到") || e.message.include?("No such coupon")
+      end
+    end
+
+    # 使用优惠券模板批量创建优惠券
+    should "execute should return a coupon list made from coupon_template when passed correct coupon_template_id and parameters" do
+      user_id = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+      coupons = Pingpp::CouponTemplate.create_coupons(get_coupon_template_id, {:users => [user_id]})
+
+      assert coupons.kind_of?(Pingpp::ListObject)
+      assert coupons.data.count <= 3
+      assert coupons.data[0].kind_of?(Pingpp::Coupon)
+    end
+
+    # 查询优惠券模板创建的优惠券列表
+    should "execute should return a coupon list made from coupon_template when passed correct coupon_template_id" do
+      coupons = Pingpp::CouponTemplate.list_coupons(get_coupon_template_id, {:per_page => 3})
+
+      assert coupons.kind_of?(Pingpp::ListObject)
+      assert coupons.object == 'list'
+      assert coupons.data.count <= 3
+    end
+  end
+end

data/test/customs_test_bak.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class CustomsTest < Test::Unit::TestCase
+    should "execute should return a new customs when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+      channel = 'upacp'
+
+      params = {
+        :app => get_app_id,
+        :charge => get_charge_id,
+        :channel => channel,
+        :trade_no => order_no,
+        :customs_code => 'GUANGZHOU',
+        :amount => 10,
+        :transport_amount => 1,
+        :is_split => true,
+        :sub_order_no => 'subord11010002',
+        :extra => {
+          :pay_account => '1234567890',
+          :certif_type => '02',
+          :customer_name => 'name',
+          :certif_id => '1234',
+          :tax_amount => 1
+        }
+      }
+      cu = Pingpp::Customs.create(params)
+    end
+  end
+end

data/test/order_test.rb

@@ -0,0 +1,181 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class OrderTest < Test::Unit::TestCase
+    # 创建订单 (order)
+    should "execute should return a new, fully executed order when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :merchant_order_no  => order_no,
+        :app       => get_app_id,
+        :amount    => 100, # 订单总金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100）
+        :client_ip => "127.0.0.1", # 发起支付请求客户端的 IP 地址，格式为 IPV4，如: 127.0.0.1
+        :currency  => "cny",
+        :subject   => "Your Subject",
+        :body      => "Your Body",
+        :uid       => get_user_id,
+
+        # 分润信息  optional|hash; 指定用户的形式
+        :royalty_users => [
+          { :user => 'user_007', :amount => 30 },
+          { :user => 'test_user_001', :amount => 20 },
+        ],
+
+        # 分润模版  optional|string; 该参数与 royalty_users 同时传时，会忽略 royalty_template
+        # :royalty_template => existed_royalty_template_id,
+      }
+
+      o = Pingpp::Order.create(params)
+
+      assert o.merchant_order_no == params[:merchant_order_no]
+      assert o.app == get_app_id
+      assert o.amount == 100
+      assert o.paid == false
+    end
+
+    # 查询订单列表
+    should "execute should return an order list when passed correct parameters" do
+      o = Pingpp::Order.list(
+        {
+          :app => get_app_id,
+          :per_page => 3,
+          :paid => true,
+          :refunded => false,
+        }
+      )
+
+      assert o.object == 'list'
+      assert o.data.count <= 3
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Order)
+    end
+
+    # 取消一笔订单
+    should "execute should return an canceled order when passed correct id" do
+      begin
+        o = Pingpp::Order.cancel(order_to_cancel)
+
+        assert o.object == 'order'
+        assert o.kind_of?(Pingpp::Order)
+        assert o.status == 'canceled'
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("已取消") || e.message.include?("canceled") ||
+          e.message.include?("expired") || e.message.include?("已过期")
+      end
+
+    end
+
+    # 查询一笔存在的订单
+    should "execute should return an exist order when passed correct id" do
+      o = Pingpp::Order.retrieve(existed_order_id)
+
+      assert o.object == 'order'
+      assert o.kind_of?(Pingpp::Order)
+      assert o.id == existed_order_id
+    end
+
+    # 为一笔已创建的订单创建支付 (charge)
+    should "execute should return an order with credential when passed correct id and parameters" do
+      begin
+        o = Pingpp::Order.pay(
+          order_to_pay,
+          {
+            :charge_amount => 1000,
+            :channel => 'balance'
+          }
+        )
+
+        assert o.kind_of?(Pingpp::Order)
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("已支付") || e.message.include?("paid")
+      end
+    end
+
+    # 查询 order 的 charge 列表
+    should "return a charge list object" do
+      order_id, _ = existed_charge_id_of_order
+      o = Pingpp::Order.list_charges(
+        order_id,
+        { :per_page => 3, :page => 1 }
+      )
+
+      assert o.object == 'list'
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Charge)
+    end
+
+    # 查询 order 的 charge 对象
+    should "should return a charge object" do
+      order_id, charge_id = existed_charge_id_of_order
+      o = Pingpp::Order.retrieve_charge(
+        order_id,
+        charge_id
+      )
+
+      assert o.kind_of?(Pingpp::Charge)
+    end
+
+    # 查询 order 的退款列表
+    should "should return a list object of refunds already created" do
+      order_id, _ = existed_refund_id_of_order
+      o = Pingpp::Order.list_refunds(
+        order_id,
+        { :per_page => 3, :page => 1 }
+      )
+
+      assert o.object == 'list'
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Refund)
+    end
+
+    # 发起 order 的退款
+    should "should return a list object of new refunds" do
+      order_id, charge_id = order_and_charge_to_refund
+      o = Pingpp::Order.refund(
+        order_id,
+        {
+          # optional. 要退款的 Charge ID，不填则将 Order 包含的所有 Charge 都退款。
+          :charge => charge_id,
+
+          # optional. 退款金额，不填则退剩余可退金额。
+          :charge_amount => 1,
+
+          # required.
+          :description => '退款信息',
+
+          # optional. 退款模式。原路退回：to_source，退至余额：to_balance。默认为原路退回。
+          :refund_mode => 'to_source',
+
+          # optional. 退款资金来源。unsettled_funds：使用未结算资金退款；recharge_funds：使用可用余额退款。
+          # 该参数仅适用于所有微信渠道，包括 wx、wx_pub、wx_pub_qr、wx_lite、wx_wap 五个渠道。
+          # :funding_source => 'unsettled_funds',
+
+          # optional. 退分润的用户列表，默认分润全退，不是分润全退时，需要填写所有分润的用户。
+          # :royalty_users => [
+          #   { :user => '', :amount_refunded => 10 }
+          # ],
+        }
+      )
+
+      assert o.object == 'list'
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Refund)
+    end
+
+    # 查询 order 的退款
+    should "should return a refund object" do
+      order_id, refund_id = existed_refund_id_of_order
+      o = Pingpp::Order.retrieve_refund(
+        order_id,
+        refund_id
+      )
+
+      assert o.kind_of?(Pingpp::Refund)
+      assert o.id == refund_id
+    end
+  end
+end