Module: Pingpp::Util

Defined in:
lib/pingpp/util.rb

Class Method Summary collapse

Class Method Details

.check_api_key!(key) ⇒ Object

Raises:

  • (TypeError) 


180
181
182
183
 
# 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) ⇒ Object

Raises:

  • (TypeError) 


185
186
187
188
 
# 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) ⇒ Object

Raises:

  • (TypeError) 


190
191
192
193
 
# 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) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# 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) ⇒ Object 



151
152
153
154
 
# 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) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# 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) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# 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) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# 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) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# 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) ⇒ Object 



156
157
158
159
160
161
162
163
164
 
# 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) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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 ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# 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) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# 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) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# 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) ⇒ Object 



90
91
92
 
# File 'lib/pingpp/util.rb', line 90

def self.url_encode(key)
  CGI.escape(key.to_s).gsub('%5B', '[').gsub('%5D', ']')
end