Module: Payjp::Util

Defined in:
lib/payjp/util.rb

Class Method Summary collapse

Class Method Details

.check_api_key!(key) ⇒ Object

Raises:

  • (TypeError) 


130
131
132
133
 
# File 'lib/payjp/util.rb', line 130

def self.check_api_key!(key)
  raise TypeError.new("api_key must be a string") unless key.is_a?(String)
  key
end

.check_string_argument!(key) ⇒ Object

Raises:

  • (TypeError) 


125
126
127
128
 
# File 'lib/payjp/util.rb', line 125

def self.check_string_argument!(key)
  raise TypeError.new("argument must be a string") unless key.is_a?(String)
  key
end

.convert_to_payjp_object(resp, opts) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/payjp/util.rb', line 41

def self.convert_to_payjp_object(resp, opts)
  case resp
  when Array
    resp.map { |i| convert_to_payjp_object(i, opts) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic PayjpObject
    object_classes.fetch(resp[:object], PayjpObject).construct_from(resp, opts)
  else
    resp
  end
end

.flatten_params(params, parent_key = nil) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/payjp/util.rb', line 82

def self.flatten_params(params, parent_key = nil)
  result = []
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(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 



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/payjp/util.rb', line 97

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

.normalize_opts(opts) ⇒ Object

The secondary opts argument can either be a string or hash Turn this value into an api_key and a set of headers



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/payjp/util.rb', line 113

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)
    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
 
# File 'lib/payjp/util.rb', line 18

def self.object_classes
  @object_classes ||= {
    # data structures
    'list' => ListObject,

    # business objects
    'account' => Account,
    'balance' => Balance,
    'card' => Card,
    'charge' => Charge,
    'customer' => Customer,
    'tenant' => Tenant,
    'event' => Event,
    'plan' => Plan,
    'statement' => Statement,
    'subscription' => Subscription,
    'term' => Term,
    'token' => Token,
    'transfer' => Transfer,
    'three_d_secure_request' => ThreeDSecureRequest
  }
end

.objects_to_ids(h) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/payjp/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 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/payjp/util.rb', line 53

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 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/payjp/util.rb', line 69

def self.url_encode(key)
  # URI.escape is obsolete, so just use the code fragment in URI library
  # (from URI::RFC2396_Parser#escape)
  key.to_s.gsub(Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")) do
    us = $&
    tmp = ''
    us.each_byte do |uc|
      tmp << sprintf('%%%02X', uc)
    end
    tmp
  end.force_encoding(Encoding::US_ASCII)
end