pingpp 2.1.3 → 2.2.0

data/lib/pingpp/balance_transaction.rb

@@ -0,0 +1,9 @@
+module Pingpp
+  class BalanceTransaction < AppBasedResource
+    extend Pingpp::APIOperations::List
+
+    def self.object_name
+      'balance_transaction'
+    end
+  end
+end

data/lib/pingpp/balance_transfer.rb

@@ -0,0 +1,10 @@
+module Pingpp
+  class BalanceTransfer < AppBasedResource
+    extend Pingpp::APIOperations::List
+    extend Pingpp::APIOperations::Create
+
+    def self.object_name
+      'balance_transfer'
+    end
+  end
+end

data/lib/pingpp/batch_withdrawal.rb

@@ -0,0 +1,11 @@
+module Pingpp
+  class BatchWithdrawal < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Update
+
+    def self.object_name
+      'batch_withdrawal'
+    end
+  end
+end

data/lib/pingpp/channel.rb

@@ -0,0 +1,8 @@
+module Pingpp
+  class Channel < SubAppBasedResource
+    extend Pingpp::APIOperations::Create
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+  end
+end

data/lib/pingpp/coupon.rb

@@ -0,0 +1,9 @@
+module Pingpp
+  class Coupon < UserBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+  end
+end

data/lib/pingpp/coupon_template.rb

@@ -0,0 +1,29 @@
+module Pingpp
+  class CouponTemplate < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+    def self.object_name
+      'coupon_template'
+    end
+
+    def self.list_coupons(coupon_template, filters={}, opts={})
+      opts = Util.normalize_opts(opts)
+      response, opts = request(:get, coupon_url(coupon_template, opts), filters, opts)
+      ListObject.construct_from(response, opts)
+    end
+
+    def self.create_coupons(coupon_template, params={}, opts={})
+      response, opts = request(:post, coupon_url(coupon_template, opts), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    private
+
+    def self.coupon_url(coupon_template, opts={})
+      resource_url(opts) + "/#{coupon_template}/coupons"
+    end
+  end
+end

data/lib/pingpp/order.rb

@@ -0,0 +1,69 @@
+module Pingpp
+  class Order < APIResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Update
+
+    def pay(params, opts={})
+      response, opts = request(:post, pay_url, params, opts)
+      initialize_from(response, opts)
+    end
+
+    def self.pay(id, params, opts={})
+      response, opts = request(:post, pay_url(id), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.cancel(id, opts={})
+      update(id, {:status => 'canceled'}, opts)
+    end
+
+    def self.retrieve_charge(id, charge_id, opts={})
+      response, opts = request(:get, "#{resource_url}/#{id}/charges/#{charge_id}", {}, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.list_charges(id, params={}, opts={})
+      response, opts = request(:get, "#{resource_url}/#{id}/charges", params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.refund(id, params, opts={})
+      response, opts = request(:post, refund_url(id), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def refund(params, opts={})
+      response, opts = request(:post, refund_url, params, opts)
+      initialize_from(response, opts)
+    end
+
+    def self.retrieve_refund(id, refund_id, opts={})
+      response, opts = request(:get, "#{refund_url(id)}/#{refund_id}", {}, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.list_refunds(id, params={}, opts={})
+      response, opts = request(:get, refund_url(id), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    private
+
+    def pay_url
+      resource_url + '/pay'
+    end
+
+    def self.pay_url(order)
+      "#{resource_url}/#{order}/pay"
+    end
+
+    def refund_url
+      resource_url + '/order_refunds'
+    end
+
+    def self.refund_url(order)
+      "#{resource_url}/#{order}/order_refunds"
+    end
+  end
+end

data/lib/pingpp/recharge.rb

@@ -0,0 +1,36 @@
+module Pingpp
+  class Recharge < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+
+    def refund(params, opts={})
+      response, opts = request(:post, refund_url, params, opts)
+      initialize_from(response, opts)
+    end
+
+    def self.refund(id, params, opts={})
+      response, opts = request(:post, refund_url(id), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.retrieve_refund(id, refund_id, opts={})
+      response, opts = request(:get, "#{refund_url(id)}/#{refund_id}", {}, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.list_refunds(id, params={}, opts={})
+      response, opts = request(:get, refund_url(id), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    private
+
+    def refund_url
+      resource_url + '/refunds'
+    end
+
+    def self.refund_url(id)
+      "#{resource_url}/#{id}/refunds"
+    end
+  end
+end

data/lib/pingpp/royalty.rb

@@ -0,0 +1,14 @@
+module Pingpp
+  class Royalty < APIResource
+    extend Pingpp::APIOperations::List
+
+    def self.batch_update(params, opts={})
+      response, opts = request(:put, resource_url(opts), params, opts)
+      Util.convert_to_pingpp_object(response, opts)
+    end
+
+    def self.resource_url(opt={})
+      '/v1/royalties'
+    end
+  end
+end

data/lib/pingpp/royalty_settlement.rb

@@ -0,0 +1,11 @@
+module Pingpp
+  class RoyaltySettlement < APIResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Update
+
+    def self.object_name
+      'royalty_settlement'
+    end
+  end
+end

data/lib/pingpp/royalty_template.rb

@@ -0,0 +1,12 @@
+module Pingpp
+  class RoyaltyTemplate < APIResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Update
+    include Pingpp::APIOperations::Delete
+
+    def self.object_name
+      'royalty_template'
+    end
+  end
+end

data/lib/pingpp/royalty_transaction.rb

@@ -0,0 +1,9 @@
+module Pingpp
+  class RoyaltyTransaction < APIResource
+    extend Pingpp::APIOperations::List
+
+    def self.object_name
+      'royalty_transaction'
+    end
+  end
+end

data/lib/pingpp/settle_account.rb

@@ -0,0 +1,12 @@
+module Pingpp
+  class SettleAccount < UserBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+    def self.object_name
+      'settle_account'
+    end
+  end
+end

data/lib/pingpp/singleton_app_based_resource.rb

@@ -0,0 +1,26 @@
+module Pingpp
+  class SingletonAppBasedResource < APIResource
+    def self.resource_url(opts={})
+      if self == SingletonAPIResource
+        raise NotImplementedError.new('SingletonAPIResource is an abstract class.')
+      end
+
+      app_id = opts[:app]
+      unless app_id ||= Pingpp.app_id
+        raise InvalidRequestError.new("Please set app_id using Pingpp.app_id = <APP_ID>", 'app_id')
+      end
+
+      "/v1/apps/#{app_id}/#{CGI.escape(uri_object_name.downcase)}"
+    end
+
+    def resource_url(opts={})
+      self.class.resource_url(opts)
+    end
+
+    def self.retrieve(params={}, opts={})
+      instance = self.new(params, Util.normalize_opts(opts))
+      instance.refresh
+      instance
+    end
+  end
+end

data/lib/pingpp/sub_app.rb

@@ -0,0 +1,12 @@
+module Pingpp
+  class SubApp < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+    def self.object_name
+      'sub_app'
+    end
+  end
+end

data/lib/pingpp/sub_app_based_resource.rb

@@ -0,0 +1,35 @@
+module Pingpp
+  class SubAppBasedResource < APIResource
+
+    def self.object_name
+      class_name.downcase
+    end
+
+    def self.resource_url(opts={})
+      if self == SubAppBasedResource
+        raise NotImplementedError.new('SubAppBasedResource is an abstract class. You should perform actions on its subclasses (Channel, etc.)')
+      end
+
+      app_id = opts[:app]
+      unless app_id ||= Pingpp.app_id
+        raise InvalidRequestError.new("Please set app_id using Pingpp.app_id = <APP_ID>", 'app_id')
+      end
+
+      unless sub_app_id = opts[:sub_app]
+        raise InvalidRequestError.new("Please pass sub_app_id in opts like {:sub_app => <SUB_APP_ID>}", 'sub_app')
+      end
+
+      url = "/v1/apps/#{app_id}/sub_apps/#{sub_app_id}"
+
+      if opts.has_key?(:parents)
+        if opts[:parents].is_a?(Array)
+          url + "/#{opts[:parents].join('/')}/#{CGI.escape(uri_object_name.downcase)}s"
+        else
+          raise ArgumentError.new("opts[:parents] should be an Array")
+        end
+      else
+        url + "/#{CGI.escape(uri_object_name.downcase)}s"
+      end
+    end
+  end
+end

data/lib/pingpp/user.rb

@@ -0,0 +1,9 @@
+module Pingpp
+  class User < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Delete
+    include Pingpp::APIOperations::Update
+
+  end
+end

data/lib/pingpp/user_based_resource.rb

@@ -0,0 +1,35 @@
+module Pingpp
+  class UserBasedResource < APIResource
+
+    def self.object_name
+      class_name.downcase
+    end
+
+    def self.resource_url(opts={})
+      if self == UserBasedResource
+        raise NotImplementedError.new('UserBasedResource is an abstract class. You should perform actions on its subclasses (BalanceTransaction, etc.)')
+      end
+
+      app_id = opts[:app]
+      unless app_id ||= Pingpp.app_id
+        raise InvalidRequestError.new("Please set app_id using Pingpp.app_id = <APP_ID>", 'app_id')
+      end
+
+      unless user_id = opts[:user]
+        raise InvalidRequestError.new("Please pass user_id in opts like {:user => <USER_ID>}", 'user')
+      end
+
+      url = "/v1/apps/#{app_id}/users/#{user_id}"
+
+      if opts.has_key?(:parents)
+        if opts[:parents].is_a?(Array)
+          url + "/#{opts[:parents].join('/')}/#{CGI.escape(uri_object_name.downcase)}s"
+        else
+          raise ArgumentError.new("opts[:parents] should be an Array")
+        end
+      else
+        url + "/#{CGI.escape(uri_object_name.downcase)}s"
+      end
+    end
+  end
+end

data/lib/pingpp/util.rb

@@ -24,7 +24,25 @@ module Pingpp
         'transfer' => Transfer,
         'batch_refund' => BatchRefund,
         'batch_transfer' => BatchTransfer,
-        'customs' => Customs
+        'event' => Event,
+        'customs' => Customs,
+        'sub_app' => SubApp,
+        'channel' => Channel,
+        'user' => User,
+        'order' => Order,
+        'recharge' => Recharge,
+        'withdrawal' => Withdrawal,
+        'batch_withdrawal' => BatchWithdrawal,
+        'balance_transfer' => BalanceTransfer,
+        'balance_bonus' => BalanceBonus,
+        'balance_transaction' => BalanceTransaction,
+        'coupon' => Coupon,
+        'coupon_template' => CouponTemplate,
+        'settle_account' => SettleAccount,
+        'royalty' => Royalty,
+        'royalty_settlement' => RoyaltySettlement,
+        'royalty_transaction' => RoyaltyTransaction,
+        'royalty_template' => RoyaltyTemplate,
       }
     end
 

data/lib/pingpp/version.rb

@@ -1,3 +1,3 @@
 module Pingpp
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

data/lib/pingpp/withdrawal.rb

@@ -0,0 +1,15 @@
+module Pingpp
+  class Withdrawal < AppBasedResource
+    extend Pingpp::APIOperations::Create
+    extend Pingpp::APIOperations::List
+    include Pingpp::APIOperations::Update
+
+    def self.cancel(id, opts={})
+      update(id, {:status => 'canceled'}, opts)
+    end
+
+    def self.confirm(id, opts={})
+      update(id, {:status => 'pending'}, opts)
+    end
+  end
+end

data/lib/pingpp.rb

@@ -23,6 +23,8 @@ require 'pingpp/api_operations/request'
 require 'pingpp/util'
 require 'pingpp/pingpp_object'
 require 'pingpp/api_resource'
+require 'pingpp/app_based_resource'
+require 'pingpp/user_based_resource'
 require 'pingpp/singleton_api_resource'
 require 'pingpp/list_object'
 require 'pingpp/charge'
@@ -35,6 +37,25 @@ require 'pingpp/identification'
 require 'pingpp/customs'
 require 'pingpp/batch_refund'
 require 'pingpp/batch_transfer'
+require 'pingpp/user'
+require 'pingpp/balance_transaction'
+require 'pingpp/coupon_template'
+require 'pingpp/coupon'
+require 'pingpp/order'
+require 'pingpp/recharge'
+require 'pingpp/withdrawal'
+require 'pingpp/singleton_app_based_resource'
+require 'pingpp/batch_withdrawal'
+require 'pingpp/sub_app'
+require 'pingpp/sub_app_based_resource'
+require 'pingpp/channel'
+require 'pingpp/settle_account'
+require 'pingpp/royalty'
+require 'pingpp/royalty_settlement'
+require 'pingpp/royalty_transaction'
+require 'pingpp/balance_transfer'
+require 'pingpp/balance_bonus'
+require 'pingpp/royalty_template'
 
 # Errors
 require 'pingpp/errors/pingpp_error'
@@ -57,6 +78,7 @@ module Pingpp
     Errno::ETIMEDOUT,
     RestClient::Conflict,
     RestClient::RequestTimeout,
+    RestClient::BadGateway,
   ].freeze
 
   @api_base = 'https://api.pingxx.com'
@@ -67,16 +89,18 @@ module Pingpp
   @open_timeout = 30
   @timeout = 80
 
-  @max_network_retries = 0
+  @max_network_retries = 1
   @max_network_retry_delay = 2
   @initial_network_retry_delay = 0.5
 
+  @bad_gateway_match = true
+
   HEADERS_TO_PARSE = [:pingpp_one_version, :pingpp_sdk_version]
 
   class << self
     attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version,
                   :parsed_headers, :private_key, :pub_key, :app_id, :timeout,
-                  :open_timeout
+                  :open_timeout, :bad_gateway_match
     attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
@@ -405,8 +429,17 @@ module Pingpp
   end
 
   def self.should_retry?(e, retry_count)
-    retry_count < self.max_network_retries &&
-      RETRY_EXCEPTIONS.any? { |klass| e.is_a?(klass) }
+    if retry_count >= self.max_network_retries
+      return false
+    elsif !RETRY_EXCEPTIONS.any? { |klass| e.is_a?(klass) }
+      return false
+    elsif e.is_a?(RestClient::BadGateway)
+      if self.bad_gateway_match && !e.response.to_s.match(/.+DOCTYPE.+http\-equiv.+refresh.+content.+/m)
+        return false
+      end
+    end
+
+    return true
   end
 
   def self.sleep_time(retry_count)

data/test/balance_bonus_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class BalanceBonusTest < Test::Unit::TestCase
+    # 创建 balance_bonus 余额赠送
+    should "execute should return a new balance_bonus when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :order_no => order_no, # 余额赠送订单号
+        :amount => 100, # 金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100）
+        :user => existed_user_id, # 收款用户
+        :description   => "余额赠送"
+      }
+
+      o = Pingpp::BalanceBonus.create(
+        params,
+        { :app => get_app_id }
+      )
+
+      assert o.order_no == params[:order_no]
+      assert o.app == get_app_id
+      assert o.amount == 100
+      assert o.user == params[:user]
+      assert o.kind_of?(Pingpp::BalanceBonus)
+    end
+
+    should "execute should return an balance_bonus list when passed correct parameters" do
+      o = Pingpp::BalanceBonus.list(
+        { :per_page => 3 },
+        { :app => get_app_id }
+      )
+
+      assert o.object == 'list'
+      assert o.data.count <= 3
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::BalanceBonus)
+    end
+
+    should "execute should return an exist balance_bonus when passed correct id" do
+      o = Pingpp::BalanceBonus.retrieve(
+        existed_balance_bonus_id,
+        { :app => get_app_id }
+      )
+
+      assert o.object == 'balance_bonus'
+      assert o.kind_of?(Pingpp::BalanceBonus)
+    end
+  end
+end

data/test/balance_transaction_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../test_assistant', __FILE__)
+
+module Pingpp
+  class BalanceTransactionTest < Test::Unit::TestCase
+    should "execute should return a balance_transaction list when passed correct parameters" do
+      txns = Pingpp::BalanceTransaction.list({:per_page => 3})
+
+      assert txns.object == 'list'
+      assert txns.data.count <= 3
+    end
+
+    should "execute should return an exist balance_transaction when passed correct id" do
+      txn = Pingpp::BalanceTransaction.retrieve(get_txn_id)
+
+      assert txn.object == 'balance_transaction'
+      assert txn.id == get_txn_id
+    end
+  end
+end

data/test/balance_transfer_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../test_assistant', __FILE__)
+require "digest/md5"
+
+module Pingpp
+  class BalanceTransferTest < Test::Unit::TestCase
+    # 创建 balance_transfer
+    should "execute should return a new balance_transfer when passed correct parameters" do
+      order_no = Digest::MD5.hexdigest(Time.now.to_i.to_s)[0,12]
+
+      params = {
+        :order_no  => order_no, # 转账订单号
+        :amount    => 1, # 转账总金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100）
+        :user => existed_user_id_for_balance_transfer, # 转出用户
+        :recipient => existed_user_id, # 转入用户
+        :description   => "用户间转账" # 描述
+      }
+
+      o = Pingpp::BalanceTransfer.create(
+        params,
+        { :app => get_app_id }
+      )
+
+      assert o.order_no == params[:order_no]
+      assert o.app == get_app_id
+      assert o.amount == params[:amount]
+      assert o.user == params[:user]
+      assert o.recipient == params[:recipient]
+      assert o.kind_of?(Pingpp::BalanceTransfer)
+    end
+
+    # 查询 balance_transfer 列表
+    should "execute should return an balance_transfer list when passed correct parameters" do
+      o = Pingpp::BalanceTransfer.list(
+        { :per_page => 3 },
+        { :app => get_app_id }
+      )
+
+      assert o.object == 'list'
+      assert o.data.count <= 3
+      assert o.kind_of?(Pingpp::ListObject)
+      assert o.data[0].kind_of?(Pingpp::BalanceTransfer)
+    end
+
+    # 查询单笔 balance_transfer
+    should "execute should return an exist balance_transfer when passed correct id" do
+      o = Pingpp::BalanceTransfer.retrieve(
+        existed_balance_transfer_id,
+        { :app => get_app_id }
+      )
+
+      assert o.object == 'balance_transfer'
+      assert o.kind_of?(Pingpp::BalanceTransfer)
+    end
+  end
+end