Module: Braintree::Util

Defined in:
lib/braintree/util.rb

Defined Under Namespace

Modules: IdEquality, TokenEquality

Class Method Summary collapse

Class Method Details

._flatten_hash_keys(element, namespace = nil) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/braintree/util.rb', line 167

def self._flatten_hash_keys(element, namespace = nil)
  element = [element] if element.is_a?(String)

  element.inject([]) do |result, (key, value)|
    full_key = (namespace ? "#{namespace}[#{key}]" : key.to_s)
    if value.is_a?(Hash)
      result += _flatten_hash_keys(value, full_key)
    elsif value.is_a?(Array)
      value.each do |item|
        result += _flatten_hash_keys(item, full_key)
      end
    else
      result << full_key
    end
    result
  end.sort
end

._flatten_valid_keys(valid_keys, namespace = nil) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/braintree/util.rb', line 149

def self._flatten_valid_keys(valid_keys, namespace = nil)
  valid_keys.inject([]) do |result, key|
    if key.is_a?(Hash)
      full_key = key.keys[0]
      full_key = (namespace ? "#{namespace}[#{full_key}]" : full_key)
      nested_keys = key.values[0]
      if nested_keys.is_a?(Array)
        result += _flatten_valid_keys(nested_keys, full_key)
      else
        result << "#{full_key}[#{nested_keys}]"
      end
    else
      result << (namespace ? "#{namespace}[#{key}]" : key.to_s)
    end
    result
  end.sort
end

._get_invalid_keys(valid_keys, hash) ⇒ Object 



196
197
198
199
200
 
# File 'lib/braintree/util.rb', line 196

def self._get_invalid_keys(valid_keys, hash)
  flattened_valid_keys = _flatten_valid_keys(valid_keys)
  keys = _flatten_hash_keys(hash) - flattened_valid_keys
  _remove_wildcard_keys(flattened_valid_keys, keys)
end

._remove_wildcard_keys(valid_keys, invalid_keys) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/braintree/util.rb', line 185

def self._remove_wildcard_keys(valid_keys, invalid_keys)
  wildcard_keys = valid_keys.select { |k| k.include? "[_any_key_]" }
  return invalid_keys if wildcard_keys.empty?
  wildcard_keys.map! { |wk| wk.sub "[_any_key_]", "" }
  invalid_keys.select do |invalid_key|
    wildcard_keys.all? do |wildcard_key|
      invalid_key.index(wildcard_key) != 0
    end
  end
end

.extract_attribute_as_array(hash, attribute) ⇒ Object

Raises:



8
9
10
11
12
 
# File 'lib/braintree/util.rb', line 8

def self.extract_attribute_as_array(hash, attribute)
  raise UnexpectedError.new("Unprocessable entity due to an invalid request") if hash.nil?
  value = hash.has_key?(attribute) ? hash.delete(attribute) : []
  value.is_a?(Array) ? value : [value]
end

.hash_to_query_string(hash, namespace = nil) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/braintree/util.rb', line 14

def self.hash_to_query_string(hash, namespace = nil)
  hash.collect do |key, value|
    full_key = namespace ? "#{namespace}[#{key}]" : key
    if value.is_a?(Hash)
      hash_to_query_string(value, full_key)
    else
      url_encode(full_key) + "=" + url_encode(value)
    end
  end.sort * "&"
end

.inspect_amount(amount) ⇒ Object 



120
121
122
 
# File 'lib/braintree/util.rb', line 120

def self.inspect_amount(amount)
  amount ? "amount: #{amount.to_s("F").inspect}" : "amount: nil"
end

.invalid_path_segment?(value) ⇒ Boolean

Allowlist of the characters that make up a Braintree id/token.

Returns:

  • (Boolean) 


4
5
6
 
# File 'lib/braintree/util.rb', line 4

def self.invalid_path_segment?(value)
  !value.to_s.match?(/\A[A-Za-z0-9_-]+\z/)
end

.keys_valid?(valid_keys, hash) ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
135
136
 
# File 'lib/braintree/util.rb', line 132

def self.keys_valid?(valid_keys, hash)
  invalid_keys = _get_invalid_keys(valid_keys, hash)

  !invalid_keys.any?
end

.parse_query_string(qs) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/braintree/util.rb', line 25

def self.parse_query_string(qs)
  qs.split("&").inject({}) do |result, couplet|
    pair = couplet.split("=")
    result[CGI.unescape(pair[0]).to_sym] = CGI.unescape(pair[1] || "")
    result
  end
end

.raise_exception_for_graphql_error(response) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/braintree/util.rb', line 78

def self.raise_exception_for_graphql_error(response)
  return if !response[:errors]

  for error in response[:errors]
    if error[:extensions] && error[:extensions][:errorClass]
      case error[:extensions][:errorClass]
      when "VALIDATION"
        next # skip raising an error if it is a validation error
      when "AUTHENTICATION"
        raise AuthenticationError
      when "AUTHORIZATION"
        raise AuthorizationError, error[:message]
      when "NOT_FOUND"
        raise NotFoundError
      when "UNSUPPORTED_CLIENT"
        raise UpgradeRequiredError, "Please upgrade your client library."
      when "RESOURCE_LIMIT"
        raise TooManyRequestsError
      when "INTERNAL"
        raise ServerError
      when "SERVICE_AVAILABILITY"
        raise ServiceUnavailableError
      else
        raise UnexpectedError, "Unexpected Response: #{error[:message]}"
      end
    else
     raise UnexpectedError, "Unexpected Response: #{error[:message]}"
    end
  end
end

.raise_exception_for_status_code(status_code, message = nil) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/braintree/util.rb', line 53

def self.raise_exception_for_status_code(status_code, message=nil)
  case status_code.to_i
  when 401
    raise AuthenticationError
  when 403
    raise AuthorizationError, message
  when 404
    raise NotFoundError
  when 408
    raise RequestTimeoutError
  when 426
    raise UpgradeRequiredError, "Please upgrade your client library."
  when 429
    raise TooManyRequestsError
  when 500
    raise ServerError
  when 503
    raise ServiceUnavailableError
  when 504
    raise GatewayTimeoutError
  else
    raise UnexpectedError, "Unexpected HTTP_RESPONSE #{status_code.to_i}"
  end
end

.replace_key(hash, target_key, replacement_key) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/braintree/util.rb', line 138

def self.replace_key(hash, target_key, replacement_key)
  hash.inject({}) do |new_hash, (key, value)|
    if value.is_a?(Hash)
      value = replace_key(value, target_key, replacement_key)
    end

    key = replacement_key if key == target_key
    new_hash.merge(key => value)
  end
end

.symbolize_keys(hash) ⇒ Object 



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

def self.symbolize_keys(hash)
  hash.inject({}) do |new_hash, (key, value)|
    if value.is_a?(Hash)
      value = symbolize_keys(value)
    elsif value.is_a?(Array) && value.all? { |v| v.is_a?(Hash) }
      value = value.map { |v| symbolize_keys(v) }
    end

    new_hash.merge(key.to_sym => value)
  end
end

.to_big_decimal(decimal) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/braintree/util.rb', line 109

def self.to_big_decimal(decimal)
  case decimal
  when BigDecimal, NilClass
    decimal
  when String
    BigDecimal(decimal)
  else
    raise ArgumentError, "Argument must be a String or BigDecimal"
  end
end

.url_decode(text) ⇒ Object 



33
34
35
 
# File 'lib/braintree/util.rb', line 33

def self.url_decode(text)
  CGI.unescape text.to_s.to_str
end

.url_encode(text) ⇒ Object 



37
38
39
 
# File 'lib/braintree/util.rb', line 37

def self.url_encode(text)
  CGI.escape text.to_s.to_str
end

.verify_keys(valid_keys, hash) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/braintree/util.rb', line 124

def self.verify_keys(valid_keys, hash)
  invalid_keys = _get_invalid_keys(valid_keys, hash)
  if invalid_keys.any?
    sorted = invalid_keys.sort_by { |k| k.to_s }.join(", ")
    raise ArgumentError, "invalid keys: #{sorted}"
  end
end