Module: Stripe::Util

Defined in:
lib/stripe/util.rb

Constant Summary collapse

OPTS_USER_SPECIFIED =

Options that a user is allowed to specify.

Set[
  :api_key,
  :idempotency_key,
  :stripe_account,
  :stripe_version
].freeze
OPTS_COPYABLE =

Options that should be copyable from one StripeObject to another including options that may be internal.

(
  OPTS_USER_SPECIFIED + Set[:api_base]
).freeze
OPTS_PERSISTABLE =

Options that should be persisted between API requests. This includes client, which is an object containing an HTTP client to reuse.

(
  OPTS_USER_SPECIFIED + Set[:client] - Set[:idempotency_key]
).freeze

Class Method Summary collapse

Class Method Details

.check_api_key!(key) ⇒ Object

Raises:

  • (TypeError) 


200
201
202
203
 
# File 'lib/stripe/util.rb', line 200

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

.check_string_argument!(key) ⇒ Object

Raises:

  • (TypeError) 


195
196
197
198
 
# File 'lib/stripe/util.rb', line 195

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

.convert_to_stripe_object(data, opts = {}) ⇒ Object

Converts a hash of fields or an array of hashes into a StripeObject or array of StripeObjects. These new objects will be created as a concrete type as dictated by their ‘object` field (e.g. an `object` value of `charge` would create an instance of Charge), but if `object` is not present or of an unknown type, the newly created instance will fall back to being a StripeObject.

Attributes

  • data - Hash of fields and values to be converted into a StripeObject.

  • opts - Options for StripeObject like an API key that will be reused on subsequent API calls.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/stripe/util.rb', line 58

def self.convert_to_stripe_object(data, opts = {})
  opts = normalize_opts(opts)

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

.encode_parameters(params) ⇒ Object

Encodes a hash of parameters in a way that’s suitable for use as query parameters in a URI or as form parameters in a request body. This mainly involves escaping special characters from parameter keys and values (e.g. ‘&`).



122
123
124
125
 
# File 'lib/stripe/util.rb', line 122

def self.encode_parameters(params)
  Util.flatten_params(params)
      .map { |k, v| "#{url_encode(k)}=#{url_encode(v)}" }.join("&")
end

.flatten_params(params, parent_key = nil) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/stripe/util.rb', line 138

def self.flatten_params(params, parent_key = nil)
  result = []

  # do not sort the final output because arrays (and arrays of hashes
  # especially) can be order sensitive, but do sort incoming parameters
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{key}]" : key.to_s
    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 



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/stripe/util.rb', line 157

def self.flatten_params_array(value, calculated_key)
  result = []
  value.each_with_index do |elem, i|
    if elem.is_a?(Hash)
      result += flatten_params(elem, "#{calculated_key}[#{i}]")
    elsif elem.is_a?(Array)
      result += flatten_params_array(elem, calculated_key)
    else
      result << ["#{calculated_key}[#{i}]", elem]
    end
  end
  result
end

.log_debug(message, data = {}) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/stripe/util.rb', line 90

def self.log_debug(message, data = {})
  if !Stripe.logger.nil? ||
     !Stripe.log_level.nil? && Stripe.log_level <= Stripe::LEVEL_DEBUG
    log_internal(message, data, color: :blue, level: Stripe::LEVEL_DEBUG,
                                logger: Stripe.logger, out: $stdout)
  end
end

.log_error(message, data = {}) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/stripe/util.rb', line 74

def self.log_error(message, data = {})
  if !Stripe.logger.nil? ||
     !Stripe.log_level.nil? && Stripe.log_level <= Stripe::LEVEL_ERROR
    log_internal(message, data, color: :cyan, level: Stripe::LEVEL_ERROR,
                                logger: Stripe.logger, out: $stderr)
  end
end

.log_info(message, data = {}) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/stripe/util.rb', line 82

def self.log_info(message, data = {})
  if !Stripe.logger.nil? ||
     !Stripe.log_level.nil? && Stripe.log_level <= Stripe::LEVEL_INFO
    log_internal(message, data, color: :cyan, level: Stripe::LEVEL_INFO,
                                logger: Stripe.logger, out: $stdout)
  end
end

.normalize_headers(headers) ⇒ Object

Normalizes header keys so that they’re all lower case and each hyphen-delimited section starts with a single capitalized letter. For example, ‘request-id` becomes `Request-Id`. This is useful for extracting certain key values when the user could have set them with a variety of diffent naming schemes.



210
211
212
213
214
215
216
217
 
# File 'lib/stripe/util.rb', line 210

def self.normalize_headers(headers)
  headers.each_with_object({}) do |(k, v), new_headers|
    k = k.to_s.tr("_", "-") if k.is_a?(Symbol)
    k = k.split("-").reject(&:empty?).map(&:capitalize).join("-")

    new_headers[k] = v
  end
end

.normalize_id(id) ⇒ Object 



171
172
173
174
175
176
177
178
179
 
# File 'lib/stripe/util.rb', line 171

def self.normalize_id(id)
  if id.is_a?(Hash) # overloaded id
    params_hash = id.dup
    id = params_hash.delete(:id)
  else
    params_hash = {}
  end
  [id, params_hash]
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



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/stripe/util.rb', line 183

def self.normalize_opts(opts)
  case opts
  when String
    { api_key: opts }
  when Hash
    check_api_key!(opts.fetch(:api_key)) if opts.key?(:api_key)
    opts.clone
  else
    raise TypeError, "normalize_opts expects a string or a hash"
  end
end

.object_classes ⇒ Object 



42
43
44
 
# File 'lib/stripe/util.rb', line 42

def self.object_classes
  @object_classes ||= Stripe::ObjectTypes.object_names_to_classes
end

.objects_to_ids(obj) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/stripe/util.rb', line 27

def self.objects_to_ids(obj)
  case obj
  when APIResource
    obj.id
  when Hash
    res = {}
    obj.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
    res
  when Array
    obj.map { |v| objects_to_ids(v) }
  else
    obj
  end
end

.request_id_dashboard_url(request_id, api_key) ⇒ Object

Generates a Dashboard link to inspect a request ID based off of a request ID value and an API key, which is used to attempt to extract whether the environment is livemode or testmode.



222
223
224
225
 
# File 'lib/stripe/util.rb', line 222

def self.request_id_dashboard_url(request_id, api_key)
  env = !api_key.nil? && api_key.start_with?("sk_live") ? "live" : "test"
  "https://dashboard.stripe.com/#{env}/logs/#{request_id}"
end

.secure_compare(str_a, str_b) ⇒ Object

Constant time string comparison to prevent timing attacks Code borrowed from ActiveSupport



229
230
231
232
233
234
235
236
237
 
# File 'lib/stripe/util.rb', line 229

def self.secure_compare(str_a, str_b)
  return false unless str_a.bytesize == str_b.bytesize

  l = str_a.unpack "C#{str_a.bytesize}"

  res = 0
  str_b.each_byte { |byte| res |= byte ^ l.shift }
  res.zero?
end

.symbolize_names(object) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/stripe/util.rb', line 98

def self.symbolize_names(object)
  case object
  when Hash
    new_hash = {}
    object.each do |key, value|
      key = (begin
               key.to_sym
             rescue StandardError
               key
             end) || 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

Encodes a string in a way that makes it suitable for use in a set of query parameters in a URI or in a set of form parameters in a request body.



130
131
132
133
134
135
136
 
# File 'lib/stripe/util.rb', line 130

def self.url_encode(key)
  CGI.escape(key.to_s).
    # Don't use strict form encoding by changing the square bracket control
    # characters back to their literals. This is fine by the server, and
    # makes these parameter strings easier to read.
    gsub("%5B", "[").gsub("%5D", "]")
end