pingpp 2.1.3 → 2.2.0

data/test/recharge_test.rb

@@ -0,0 +1,106 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class RechargeTest < Test::Unit::TestCase
+    # 创建一笔充值 (recharge)
+    should "execute should return a new, fully executed recharge when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :user => get_user_id,
+        :charge => {
+          :order_no => order_no,
+          :channel => "alipay", # 支付渠道
+          :client_ip => "127.0.0.1", # 发起支付请求客户端的 IP 地址，格式为 IPV4，如: 127.0.0.1
+          :amount => 100, # 订单总金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100）
+          :body => "Your Body",
+          :subject => "You Subject",
+          :extra => {} # 根据渠道填入参数 https://www.pingxx.com/api#支付渠道-extra-参数说明
+        },
+        :description => "充值描述"
+      }
+
+      o = Pingpp::Recharge.create(
+        params,
+        { :app => get_app_id } # App 信息
+      )
+
+      assert o.charge.order_no == params[:charge][:order_no]
+      assert o.app == get_app_id
+      assert o.object == "recharge"
+      assert o.kind_of?(Pingpp::Recharge)
+      assert o.charge.kind_of?(Pingpp::Charge)
+    end
+
+    # 查询一笔充值 (recharge)
+    should "return an existed recharge when passed correct id" do
+      o = Pingpp::Recharge.retrieve(
+        existed_recharge_id,
+        { :app => get_app_id } # App 信息
+      )
+
+      assert o.app == get_app_id
+      assert o.object == "recharge"
+      assert o.kind_of?(Pingpp::Recharge)
+    end
+
+    # 查询充值列表
+    should "return a list object of recharge" do
+      o = Pingpp::Recharge.list(
+        { :per_page => 3, :page => 1 },
+        { :app => get_app_id } # App 信息
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Recharge)
+    end
+
+    # 查询 recharge 的退款列表
+    should "should return a refund list object of recharge" do
+      recharge_id, _ = existed_refund_id_of_recharge
+      o = Pingpp::Recharge.list_refunds(
+        recharge_id, # Recharge 对象 ID
+        { :per_page => 3, :page => 1 }, # 过滤参数，分页参数
+        { :app => get_app_id } # App 信息
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Refund)
+    end
+
+    # 发起 recharge 的退款
+    should "return a new refund object of recharge" do
+      begin
+        o = Pingpp::Recharge.refund(
+          recharge_to_refund, # Recharge 对象 ID
+          {
+            # required.
+            :description => '退款信息',
+          },
+          { :app => get_app_id } # App 信息
+        )
+
+        assert o.object == 'refund'
+        assert o.kind_of?(Pingpp::Refund)
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError) || e.kind_of?(Pingpp::ChannelError)
+        assert e.message.include?("可退金额为 0") || e.message.include?("refundable amount is 0")
+      end
+    end
+
+    # 查询 recharge 的退款
+    should "should return a refund object of recharge" do
+      recharge_id, refund_id = existed_refund_id_of_recharge
+      o = Pingpp::Recharge.retrieve_refund(
+        recharge_id, # Recharge 对象 ID
+        refund_id, # Refund 对象 ID
+        { :app => get_app_id } # App 信息
+      )
+
+      assert o.object == 'refund'
+      assert o.id == refund_id
+      assert o.kind_of?(Pingpp::Refund)
+    end
+  end
+end

data/test/refund_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class RefundTest < Test::Unit::TestCase
+    should "execute should return a refund list when passed correct parameters" do
+      l = Pingpp::Refund.list(get_charge_id, {:limit => 3})
+
+      assert l.object == 'list'
+      assert l.data.count <= 3
+    end
+
+    should "execute should return a refund when passed correct parameters" do
+      ch_id = get_charge_id
+
+      r = Pingpp::Refund.create(ch_id, {:amount => 1, :description => 'Refund amount test.'})
+
+      assert r.object == 'refund'
+      assert r.charge == ch_id
+    end
+
+    should "execute should return an exist refund when passed correct charge id and refund id" do
+      re_id = get_refund_id
+      ch_id = get_charge_id
+
+      r = Pingpp::Refund.retrieve(ch_id, re_id)
+
+      assert r.object == 'refund'
+      assert r.id == re_id
+      assert r.charge == ch_id
+    end
+  end
+end

data/test/royalty_settlement_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class RoyaltySettlementTest < Test::Unit::TestCase
+    # 创建分润结算
+    should "return a royalty_settlement object when passed correct params" do
+      params = {
+        # 分润发起方所在的 App ID  required|string
+        :payer_app => get_payer_app,
+
+        # 分润的方式  required|string,null; 余额 balance 或渠道名称 [alipay, wx_pub, unionpay, ...]
+        :method => "alipay",
+
+        # 分润创建时间  optional|hash
+        :created => {
+          :gte => 1504875000,
+          :lt => 1504885000
+        },
+      }
+
+      begin
+        o = Pingpp::RoyaltySettlement.create(params)
+
+        assert o.kind_of?(Pingpp::RoyaltySettlement)
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("无有效")
+      end
+    end
+
+    # 查询分润结算对象
+    should "return an existed royalty_settlement object when passed a correct id" do
+      o = Pingpp::RoyaltySettlement.retrieve(existed_royalty_settlement_id)
+
+      assert o.kind_of?(Pingpp::RoyaltySettlement)
+    end
+
+    # 更新/取消分润结算对象
+    should "return an updated royalty_settlement object when passed a correct id" do
+      begin
+        o = Pingpp::RoyaltySettlement.update(
+          existed_royalty_settlement_id,
+          {
+            # 更新状态 required|string; canceled: 取消结算, pending: 确认结算
+            :status => 'canceled'
+          }
+        )
+
+        assert o.kind_of?(Pingpp::RoyaltySettlement)
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError) || e.kind_of?(Pingpp::ChannelError)
+        assert e.message.include?("状态错误")
+      end
+    end
+
+    # 查询分润结算对象列表
+    should "return a list object of royalty_settlement" do
+      o = Pingpp::RoyaltySettlement.list(
+        { :per_page => 3, :page => 1, :payer_app => get_payer_app }
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      if o.data.count > 0
+        assert o.data[0].kind_of?(Pingpp::RoyaltySettlement)
+      end
+    end
+  end
+end

data/test/royalty_template_test.rb

@@ -0,0 +1,102 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class RoyaltyTemplateTest < Test::Unit::TestCase
+    # 创建分润模版
+    should "return a royalty_template object when passed correct parameters" do
+      params = {
+        # App ID  required|string
+        :app => get_app_id,
+
+        # 描述信息  optional|string
+        :description => "TEMPLATE DESCRIPTION",
+
+        # 模版名称  optional|string
+        # :name => "TEMPLATE_NAME",
+
+        # 分润规则  required|hash
+        :rule => {
+          # 分润模式  required|string; rate: 按订单金额（包含优惠券金额）的比例, fixed: 固定金额
+          :royalty_mode => "rate",
+
+          # 分配模式  required|string; 指当订单确定的层级如果少于模板配置层级时，
+          # 模板中多余的分润金额是归属于收款方 `receipt_reserved` 还是服务方 `service_reserved`。
+          :allocation_mode => "receipt_reserved",
+
+          # 退分润模式  required|string; no_refund: 退款时不退分润, proportional: 按比例退分润, full_refund: 一旦退款分润全退
+          :refund_mode => "no_refund",
+
+          # 分润数据列表  required|array
+          :data => [
+            {
+              :level => 0,
+              :value => 10
+            },
+            {
+              :level => 1,
+              :value => 20
+            }
+          ],
+        },
+      }
+
+      o = Pingpp::RoyaltyTemplate.create(params)
+
+      assert o.kind_of?(Pingpp::RoyaltyTemplate)
+    end
+
+    # 查询分润模版
+    should "return an existed royalty_template object when passed a correct id" do
+      o = Pingpp::RoyaltyTemplate.retrieve(existed_royalty_template_id)
+
+      assert o.kind_of?(Pingpp::RoyaltyTemplate)
+    end
+
+    # 查询分润模版列表
+    should "return a list object of royalty_template" do
+      o = Pingpp::RoyaltyTemplate.list(
+        { :per_page => 3, :page => 1 }
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::RoyaltyTemplate)
+    end
+
+    # 更新分润模版
+    should "return a updated royalty_template" do
+      params = {
+        :description => "New description #{Time.now.to_i.to_s}",
+        :rule => {
+          :royalty_mode => "rate",
+          :allocation_mode => "receipt_reserved",
+          :refund_mode => "no_refund",
+          :data => [
+            { :level => 0, :value => 20 },
+            { :level => 1, :value => 30 }
+          ],
+        },
+      }
+      o = Pingpp::RoyaltyTemplate.update(
+        existed_royalty_template_id,
+        params
+      )
+
+      assert o.kind_of?(Pingpp::RoyaltyTemplate)
+      assert o.description == params[:description]
+      assert o.rule.data[0].value == params[:rule][:data][0][:value]
+    end
+
+    # 删除分润模版
+    should "return deleted object with royalty template id" do
+      begin
+        o = Pingpp::RoyaltyTemplate.delete(royalty_template_id_to_delete)
+
+        assert o.id == royalty_template_id_to_delete
+        assert o.deleted
+      rescue => e
+        assert e.kind_of?(Pingpp::InvalidRequestError)
+        assert e.message.include?("找不到分润模板对象")
+      end
+    end
+  end
+end

data/test/royalty_test.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class RoyaltyTest < Test::Unit::TestCase
+    # 批量更新分润对象
+    should "return a royalty list object when passed correct ids" do
+      params = {
+        # 分润 ID 列表  required|array
+        :ids => get_royalty_ids_to_update,
+
+        # 描述信息  optional|string
+        :description => "DESCRIPTION",
+
+        #   optional|string
+        # :method => "manual",
+      }
+
+      o = Pingpp::Royalty.batch_update(params)
+
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::Royalty)
+    end
+
+    # 查询分润对象
+    should "return an existed royalty object when passed a correct id" do
+      o = Pingpp::Royalty.retrieve(existed_royalty_id)
+
+      assert o.kind_of?(Pingpp::Royalty)
+    end
+
+    # 查询分润对象列表
+    should "return a list object of royalties" do
+      o = Pingpp::Royalty.list(
+        { :per_page => 3, :page => 1 }
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      if o.data.count > 0
+        assert o.data[0].kind_of?(Pingpp::Royalty)
+      end
+    end
+  end
+end

data/test/royalty_transaction_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class RoyaltyTransactionTest < Test::Unit::TestCase
+    # 查询分润结算明细
+    should "return an existed royalty_transaction object when passed a correct id" do
+      o = Pingpp::RoyaltyTransaction.retrieve(existed_royalty_transaction_id)
+
+      assert o.kind_of?(Pingpp::RoyaltyTransaction)
+    end
+
+    # 查询分润结算明细列表
+    should "return a list object of royalty_transaction" do
+      o = Pingpp::RoyaltyTransaction.list(
+        { :per_page => 3, :page => 1 }
+      )
+
+      assert o.kind_of?(Pingpp::ListObject)
+      if o.data.count > 0
+        assert o.data[0].kind_of?(Pingpp::RoyaltyTransaction)
+      end
+    end
+  end
+end

data/test/settle_account_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class SettleAccountTest < Test::Unit::TestCase
+    should "settle_account create" do
+      params = {
+        :channel => 'wx_pub',
+        :recipient => {
+          :account => 'oazpsj-ejmwkkskuggaj2h2kaz8ah'
+        }
+      }
+
+      u = Pingpp::SettleAccount.create(params, {:user => get_user_id})
+
+      assert u.object == 'settle_account'
+      assert u.channel == params[:channel]
+    end
+
+    should "settle_account retrieve" do
+      u = Pingpp::SettleAccount.retrieve('320217041815593200000501', {:user => get_user_id})
+
+      assert u.object == 'settle_account'
+      assert u.id == '320217041815593200000501'
+    end
+
+    should "settle_account list" do
+      l = Pingpp::SettleAccount.list({:per_page => 3}, {:user => get_user_id})
+
+      assert l.object == 'list'
+      assert l.data.count <= 3
+    end
+
+    should "settle_account delete" do
+      d = Pingpp::SettleAccount.delete('320217080118072300000201', {}, {:user => get_user_id})
+
+      assert d.deleted
+      assert d.id == '320217080118072300000201'
+    end
+  end
+end

data/test/sub_app_channel_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class SubAppChannelTest < Test::Unit::TestCase
+    # 创建子商户渠道参数 (仅支持 livemode)
+    should "sub_app channel create" do
+      params = {
+        :channel => "bfb",
+        :params => {
+          "fee_rate" => 60,
+          "bfb_sp" => "1600330402",
+          "bfb_key" => "c832cGsdBdErycpTxs3KMQ3cQkawZvzC"
+        },
+        :description => "channel info"
+      }
+
+      channel_info = Pingpp::Channel.create(params, {:sub_app => get_sub_app_id})
+
+      assert channel_info.object == 'channel'
+      assert channel_info.description == params[:description]
+      assert channel_info.params['fee_rate'] == params[:params]["fee_date"]
+      assert channel_info.params['bfb_sp'] == params[:params]["bfb_sp"]
+      assert channel_info.params['bfb_key'] == params[:params]["bfb_key"]
+    end
+
+    # 查询子商户渠道参数 (仅支持 livemode)
+    should "sub_app channel retrieve" do
+      channel_info = Pingpp::Channel.retrieve(
+        "bfb",
+        {
+          :sub_app => get_sub_app_id
+        }
+      )
+
+      assert channel_info.object == 'channel'
+    end
+
+    # 更新子商户渠道参数 (仅支持 livemode)
+    should "sub_app channel update" do
+      new_description = 'Shanghai ' + Time.now.iso8601
+      channel_info = Pingpp::Channel.update(
+        "bfb",
+        {
+          :description => new_description,
+          :params => {
+            "fee_rate" => 60,
+            "bfb_sp" => "1600330404",
+            "bfb_key" => "c832cGscpTxs3KMQ3cQkdBdEryawZvzC"
+          }
+        },
+        { :sub_app => get_sub_app_id }
+      )
+
+      assert channel_info.object == 'channel'
+      assert channel_info.description == new_description
+    end
+
+    # 删除子商户渠道参数 (仅支持 livemode)
+    should "sub_app channel delete" do
+      channel_info = Pingpp::Channel.delete(
+        "bfb",
+        {}
+        { :sub_app => get_sub_app_id }
+      )
+
+      assert o.deleted
+      assert o.channel == "bfb"
+    end
+  end
+end

data/test/sub_app_test.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class SubAppTest < Test::Unit::TestCase
+    # 创建子商户 sub_app
+    should "sub_app create" do
+      user_id = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+      display_name = 'sub_app_' + user_id
+
+      params = {
+        :display_name  => display_name,
+        :user => user_id
+      }
+
+      sub_app = Pingpp::SubApp.create(params)
+
+      assert sub_app.kind_of?(Pingpp::SubApp)
+      assert sub_app.object == 'sub_app'
+      assert sub_app.user == user_id
+      assert sub_app.display_name == display_name
+    end
+
+    # 查询 sub_app
+    should "sub_app retrieve" do
+      sub_app = Pingpp::SubApp.retrieve(get_sub_app_id)
+
+      assert sub_app.object == 'sub_app'
+      assert sub_app.id == get_sub_app_id
+    end
+
+    # 查询 sub_app 列表
+    should "sub_app list" do
+      l = Pingpp::SubApp.list(:per_page => 3)
+
+      assert l.object == 'list'
+      assert l.data.count <= 3
+      assert l.data[0].kind_of?(Pingpp::SubApp)
+    end
+
+    # 更新 sub_app
+    should "sub_app update" do
+      new_description = 'Shanghai ' + Time.now.iso8601
+      sub_app = Pingpp::SubApp.update(get_sub_app_id, {:description => new_description})
+
+      assert sub_app.kind_of?(Pingpp::SubApp)
+      assert sub_app.object == 'sub_app'
+      assert sub_app.id == get_sub_app_id
+      assert sub_app.description == new_description
+    end
+
+    # 删除 sub_app
+    should "sub_app delete" do
+      sub_app = Pingpp::SubApp.delete(sub_app_id_to_delete)
+
+      assert sub_app.deleted
+      assert sub_app.id == sub_app_id_to_delete
+    end
+  end
+end

data/test/test_assistant.rb

@@ -0,0 +1,35 @@
+require 'pingpp'
+require 'test/unit'
+require 'mocha/setup'
+require 'stringio'
+require 'shoulda/context'
+require File.expand_path('../test_data', __FILE__)
+
+module Pingpp
+  @mock_rest_client = nil
+
+  def self.mock_rest_client=(mock_client)
+    @mock_rest_client = mock_client
+  end
+end
+
+class Test::Unit::TestCase
+  include Pingpp::TestData
+  include Mocha
+
+  setup do
+    @mock = mock
+    Pingpp.mock_rest_client = @mock
+    Pingpp.api_key = get_api_key
+
+    Pingpp.private_key_path = File.expand_path('../../example/your_rsa_private_key.pem', __FILE__)
+
+    # 使用账户系统部分接口需要设置该参数，调用相关方法时可传 opts[:app] 参数来覆盖该值
+    Pingpp.app_id = get_app_id
+  end
+
+  teardown do
+    Pingpp.mock_rest_client = nil
+    Pingpp.api_key = nil
+  end
+end