module Pingpp::Util

Public Class Methods

check_api_key!(key) click to toggle source
# File lib/pingpp/util.rb, line 180
def self.check_api_key!(key)
  raise TypeError.new("api_key must be a string") unless key.is_a?(String)
  key
end
check_app!(app) click to toggle source
# File lib/pingpp/util.rb, line 185
def self.check_app!(app)
  raise TypeError.new("app must be a string") unless app.is_a?(String)
  app
end
check_user!(user) click to toggle source
# File lib/pingpp/util.rb, line 190
def self.check_user!(user)
  raise TypeError.new("user must be a string") unless user.is_a?(String)
  user
end
convert_to_pingpp_object(resp, opts) click to toggle source
# File lib/pingpp/util.rb, line 49
def self.convert_to_pingpp_object(resp, opts)
  case resp
  when Array
    resp.map { |i| convert_to_pingpp_object(i, opts) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic PingppObject
    object_classes.fetch(resp[:object], PingppObject).construct_from(resp, opts)
  else
    resp
  end
end
encode_parameters(params) click to toggle source
# File lib/pingpp/util.rb, line 151
def self.encode_parameters(params)
  Util.flatten_params(params).
    map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
end
file_readable(file) click to toggle source
# File lib/pingpp/util.rb, line 61
def self.file_readable(file)
  # This is nominally equivalent to File.readable?, but that can
  # report incorrect results on some more oddball filesystems
  # (such as AFS)
  begin
    File.open(file) { |f| }
  rescue
    false
  else
    true
  end
end
flatten_params(params, parent_key=nil) click to toggle source
# File lib/pingpp/util.rb, line 94
def self.flatten_params(params, parent_key=nil)
  result = []
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
    if value.is_a?(Hash)
      result += flatten_params(value, calculated_key)
    elsif value.is_a?(Array)
      result += flatten_params_array(value, calculated_key)
    else
      result << [calculated_key, value]
    end
  end
  result
end
flatten_params_array(value, calculated_key) click to toggle source
# File lib/pingpp/util.rb, line 109
def self.flatten_params_array(value, calculated_key)
  result = []
  value.each do |elem|
    if elem.is_a?(Hash)
      result += flatten_params(elem, calculated_key)
    elsif elem.is_a?(Array)
      result += flatten_params_array(elem, calculated_key)
    else
      result << ["#{calculated_key}[]", elem]
    end
  end
  result
end
format_headers(original_headers) click to toggle source
# File lib/pingpp/util.rb, line 123
def self.format_headers(original_headers)
  new_headers = {}
  if !original_headers.respond_to?("each")
    return nil
  end

  original_headers.each do |k, h|
    if k.is_a?(Symbol)
      k = k.to_s
    end
    k = k[0, 5] == 'HTTP_' ? k[5..-1] : k
    new_k = k.gsub(/-/, '_').downcase.to_sym

    header = nil
    if h.is_a?(Array) && h.length > 0
      header = h[0]
    elsif h.is_a?(String)
      header = h
    end

    if header
      new_headers[new_k] = header
    end
  end

  return new_headers
end
normalize_id(id) click to toggle source
# File lib/pingpp/util.rb, line 156
def self.normalize_id(id)
  if id.kind_of?(Hash) # overloaded id
    params_hash = id.dup
    id = params_hash.delete(:id)
  else
    params_hash = {}
  end
  [id, params_hash]
end
normalize_opts(opts) click to toggle source
# File lib/pingpp/util.rb, line 166
def self.normalize_opts(opts)
  case opts
  when String
    {:api_key => opts}
  when Hash
    check_api_key!(opts.fetch(:api_key)) if opts.has_key?(:api_key)
    check_app!(opts.fetch(:app)) if opts.has_key?(:app)
    check_user!(opts.fetch(:user)) if opts.has_key?(:user)
    opts.clone
  else
    raise TypeError.new('normalize_opts expects a string or a hash')
  end
end
object_classes() click to toggle source
# File lib/pingpp/util.rb, line 18
def self.object_classes
  @object_classes ||= {
    'charge' => Charge,
    'list' => ListObject,
    'refund' => Refund,
    'red_envelope' => RedEnvelope,
    'transfer' => Transfer,
    'batch_refund' => BatchRefund,
    'batch_transfer' => BatchTransfer,
    '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
objects_to_ids(h) click to toggle source
# File lib/pingpp/util.rb, line 3
def self.objects_to_ids(h)
  case h
  when APIResource
    h.id
  when Hash
    res = {}
    h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
    res
  when Array
    h.map { |v| objects_to_ids(v) }
  else
    h
  end
end
symbolize_names(object) click to toggle source
# File lib/pingpp/util.rb, line 74
def self.symbolize_names(object)
  case object
  when Hash
    new_hash = {}
    object.each do |key, value|
      key = (key.to_sym rescue key) || key
      new_hash[key] = symbolize_names(value)
    end
    new_hash
  when Array
    object.map { |value| symbolize_names(value) }
  else
    object
  end
end
url_encode(key) click to toggle source
# File lib/pingpp/util.rb, line 90
def self.url_encode(key)
  CGI.escape(key.to_s).gsub('%5B', '[').gsub('%5D', ']')
end