Class: Square::APIHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/square/api_helper.rb

Overview

API utility class

Class Method Summary collapse

Class Method Details

.append_url_with_query_parameters(query_builder, parameters) ⇒ Object

Appends the given set of parameters to the given query string.

Parameters:

  • The (String) —

    query string builder to add the query parameters to.

  • The (Hash) —

    parameters to append.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/square/api_helper.rb', line 65

def self.append_url_with_query_parameters(query_builder, parameters)
  # Perform parameter validation.
  unless query_builder.instance_of? String
    raise ArgumentError, 'Given value for parameter \"query_builder\"
      is invalid.'
  end

  # Return if there are no parameters to replace.
  return query_builder if parameters.nil?

  array_serialization = 'indexed'
  parameters = process_complex_types_parameters(parameters, array_serialization)

  parameters.each do |key, value|
    seperator = query_builder.include?('?') ? '&' : '?'
    unless value.nil?
      if value.instance_of? Array
        value.compact!
        APIHelper.serialize_array(
          key, value, formatting: array_serialization
        ).each do |element|
          seperator = query_builder.include?('?') ? '&' : '?'
          query_builder += "#{seperator}#{element[0]}=#{element[1]}"
        end
      else
        query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
      end
    end
  end
  query_builder
end

.append_url_with_template_parameters(query_builder, parameters) ⇒ Object

Replaces template parameters in the given url. parameters.

Parameters:

  • The (String) —

    query string builder to replace the template

  • The (Hash) —

    parameters to replace in the url.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/square/api_helper.rb', line 28

def self.append_url_with_template_parameters(query_builder, parameters)
  # perform parameter validation
  unless query_builder.instance_of? String
    raise ArgumentError, 'Given value for parameter \"query_builder\" is
      invalid.'
  end

  # Return if there are no parameters to replace.
  return query_builder if parameters.nil?

  parameters.each do |key, val|
    if val.nil?
      replace_value = ''
    elsif val['value'].instance_of? Array
      if val['encode'] == true
        val['value'].map! { |element| CGI.escape(element.to_s) }
      else
        val['value'].map!(&:to_s)
      end
      replace_value = val['value'].join('/')
    else
      replace_value = if val['encode'] == true
                        CGI.escape(val['value'].to_s)
                      else
                        val['value'].to_s
                      end
    end

    # Find the template parameter and replace it with its value.
    query_builder = query_builder.gsub("{#{key}}", replace_value)
  end
  query_builder
end

.clean_hash(hash) ⇒ Object

Removes elements with empty values from a hash.

Parameters:

  • The (Hash) —

    hash to clean.



141
142
143
 
# File 'lib/square/api_helper.rb', line 141

def self.clean_hash(hash)
  hash.delete_if { |_key, value| value.to_s.strip.empty? }
end

.clean_url(url) ⇒ String

Validates and processes the given Url.

Parameters:

  • The (String) —

    given Url to process.

Returns:

  • (String) —

    Pre-processed Url as string.

Raises:

  • (ArgumentError) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/square/api_helper.rb', line 100

def self.clean_url(url)
  # Perform parameter validation.
  raise ArgumentError, 'Invalid Url.' unless url.instance_of? String

  # Ensure that the urls are absolute.
  matches = url.match(%r{^(https?://[^/]+)})
  raise ArgumentError, 'Invalid Url format.' if matches.nil?

  # Get the http protocol match.
  protocol = matches[1]

  # Check if parameters exist.
  index = url.index('?')

  # Remove redundant forward slashes.
  query = url[protocol.length...(!index.nil? ? index : url.length)]
  query.gsub!(%r{//+}, '/')

  # Get the parameters.
  parameters = !index.nil? ? url[url.index('?')...url.length] : ''

  # Return processed url.
  protocol + query + parameters
end

.custom_merge(a, b) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/square/api_helper.rb', line 170

def self.custom_merge(a, b)
  x = {}
  a.each do |key, value_a|
    b.each do |k, value_b|
      next unless key == k

      x[k] = []
      if value_a.instance_of? Array
        value_a.each do |v|
          x[k].push(v)
        end
      else
        x[k].push(value_a)
      end
      if value_b.instance_of? Array
        value_b.each do |v|
          x[k].push(v)
        end
      else
        x[k].push(value_b)
      end
      a.delete(k)
      b.delete(k)
    end
  end
  x.merge!(a)
  x.merge!(b)
  x
end

.data_types ⇒ Object

Array of supported data types



435
436
437
438
439
 
# File 'lib/square/api_helper.rb', line 435

def self.data_types
  [String, Float, Integer,
   TrueClass, FalseClass, Date,
   DateTime, Array, Hash, Object]
end

.deserialize(template, value) ⇒ Object

Deserialize the value against the template (group of types). against which the value will be mapped (oneOf(Integer, String)).

Parameters:

  • The (String) —

    value to be deserialized.

  • The (String) —

    parameter indicates the type-combination



276
277
278
279
 
# File 'lib/square/api_helper.rb', line 276

def self.deserialize(template, value)
  decoded = APIHelper.json_deserialize(value)
  map_types(decoded, template)
end

.form_encode(obj, instance_name, formatting: 'indexed') ⇒ Hash

Form encodes an object. of a hash.

Parameters:

  • An (Dynamic) —

    object to form encode.

  • The (String) —

    name of the object.

Returns:

  • (Hash) —

    A form encoded representation of the object in the form



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/square/api_helper.rb', line 205

def self.form_encode(obj, instance_name, formatting: 'indexed')
  retval = {}

  # Create a form encoded hash for this object.
  if obj.nil?
    nil
  elsif obj.instance_of? Array
    if formatting == 'indexed'
      obj.each_with_index do |value, index|
        retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
      end
    elsif APIHelper.serializable_types.map { |x| obj[0].is_a? x }.any?
      obj.each do |value|
        abc = if formatting == 'unindexed'
                APIHelper.form_encode(value, "#{instance_name}[]",
                                      formatting: formatting)
              else
                APIHelper.form_encode(value, instance_name,
                                      formatting: formatting)
              end
        retval = APIHelper.custom_merge(retval, abc)
      end
    else
      obj.each_with_index do |value, index|
        retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
                                            formatting: formatting))
      end
    end
  elsif obj.instance_of? Hash
    obj.each do |key, value|
      retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
                                          formatting: formatting))
    end
  elsif obj.instance_of? File
    retval[instance_name] = UploadIO.new(
      obj, 'application/octet-stream', File.basename(obj.path)
    )
  else
    retval[instance_name] = obj
  end
  retval
end

.form_encode_parameters(form_parameters) ⇒ Hash

Form encodes a hash of parameters.

Parameters:

  • The (Hash) —

    hash of parameters to encode.

Returns:

  • (Hash) —

    A hash with the same parameters form encoded.



148
149
150
151
152
153
154
155
156
 
# File 'lib/square/api_helper.rb', line 148

def self.form_encode_parameters(form_parameters)
  array_serialization = 'indexed'
  encoded = {}
  form_parameters.each do |key, value|
    encoded.merge!(APIHelper.form_encode(value, key, formatting:
      array_serialization))
  end
  encoded
end

.get_content_type(value) ⇒ Object

Get content-type depending on the value



420
421
422
423
424
425
426
 
# File 'lib/square/api_helper.rb', line 420

def self.get_content_type(value)
  if serializable_types.map { |x| value.is_a? x }.any?
    'text/plain; charset=utf-8'
  else
    'application/json; charset=utf-8'
  end
end

.json_deserialize(json) ⇒ Object

Parses JSON string.

Parameters:

  • A (String) —

    JSON string.



127
128
129
130
131
 
# File 'lib/square/api_helper.rb', line 127

def self.json_deserialize(json)
  JSON.parse(json, symbolize_names: true)
rescue StandardError
  raise TypeError, 'Server responded with invalid JSON.'
end

.json_serialize(obj) ⇒ Object

Parses JSON string.

Parameters:

  • The (object) —

    object to serialize.



135
136
137
 
# File 'lib/square/api_helper.rb', line 135

def self.json_serialize(obj)
  serializable_types.map { |x| obj.is_a? x }.any? ? obj.to_s : obj.to_json
end

.map_array_type(value, type, group_name, matches) ⇒ Object

Validates and processes the value against the [Array] type.

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    possible type of the value.

  • The (String) —

    parameter indicates the group (oneOf|anyOf).

  • The (Integer) —

    parameter indicates the number of matches of value against types.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/square/api_helper.rb', line 354

def self.map_array_type(value, type, group_name, matches)
  if value.instance_of? Array
    decoded = []
    value.each do |val|
      type = type.chomp('[]').to_s
      val = map_types(val, type, group_name: group_name)
      decoded.append(val) unless type.empty?
    rescue ValidationException
      next
    end
    matches += 1 if decoded.length == value.length
    value = decoded unless decoded.empty?
  end
  [value, matches]
end

.map_complex_type(value, type, matches) ⇒ Object

Validates and processes the value against the complex types.

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    possible type of the value.

  • The (Integer) —

    parameter indicates the number of matches of value against types.



390
391
392
393
394
395
396
397
398
399
 
# File 'lib/square/api_helper.rb', line 390

def self.map_complex_type(value, type, matches)
  obj = Square.const_get(type)
  value = if obj.respond_to? 'from_hash'
            obj.send('from_hash', value)
          else
            obj.constants.find { |k| obj.const_get(k) == value }
          end
  matches += 1 unless value.nil?
  [value, matches]
end

.map_data_type(value, element, matches) ⇒ Object

Validates and processes the value against the data types.

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    possible type of the value.

  • The (Integer) —

    parameter indicates the number of matches of value against types.



405
406
407
408
409
410
 
# File 'lib/square/api_helper.rb', line 405

def self.map_data_type(value, element, matches)
  element = element.split('|').map { |x| Object.const_get x }
  matches += 1 if element.all? { |x| APIHelper.data_types.include?(x) } &&
                  element.any? { |x| (value.instance_of? x) || (value.class.ancestors.include? x) }
  [value, matches]
end

.map_hash_type(value, type, group_name, matches) ⇒ Object

Validates and processes the value against the [Hash] type.

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    possible type of the value.

  • The (String) —

    parameter indicates the group (oneOf|anyOf).

  • The (Integer) —

    parameter indicates the number of matches of value against types.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/square/api_helper.rb', line 333

def self.map_hash_type(value, type, group_name, matches)
  if value.instance_of? Hash
    decoded = {}
    value.each do |key, val|
      type = type.chomp('{}').to_s
      val = map_types(val, type, group_name: group_name)
      decoded[key] = val unless type.empty?
    rescue ValidationException
      next
    end
    matches += 1 if decoded.length == value.length
    value = decoded unless decoded.empty?
  end
  [value, matches]
end

.map_response(obj, keys) ⇒ Object

Retrieves a field from a Hash/Array based on an Array of keys/indexes

Parameters:

  • The (Hash, Array) —

    hash to extract data from

  • The (Array<String, Integer>) —

    keys/indexes to use

Returns:

  • (Object) —

    The extracted value



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/square/api_helper.rb', line 252

def self.map_response(obj, keys)
  val = obj
  begin
    keys.each do |key|
      val = if val.is_a? Array
              if key.to_i.to_s == key
                val[key.to_i]
              else
                val = nil
              end
            else
              val.fetch(key.to_sym)
            end
    end
  rescue NoMethodError, TypeError, IndexError
    val = nil
  end
  val
end

.map_type(value, type, _group_name, matches) ⇒ Object

Validates and processes the value against the type.

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    possible type of the value.

  • The (String) —

    parameter indicates the group (oneOf|anyOf).

  • The (Integer) —

    parameter indicates the number of matches of value against types.



375
376
377
378
379
380
381
382
383
384
 
# File 'lib/square/api_helper.rb', line 375

def self.map_type(value, type, _group_name, matches)
  if Square.constants.select do |c|
    Square.const_get(c).to_s == "Square::#{type}"
  end.empty?
    value, matches = map_data_type(value, type, matches)
  else
    value, matches = map_complex_type(value, type, matches)
  end
  [value, matches]
end

.map_types(value, template, group_name: nil) ⇒ Object

Validates and processes the value against the template(group of types).

Parameters:

  • The (String) —

    value to be mapped against the template.

  • The (String) —

    parameter indicates the group of types (oneOf(Integer, String)).

  • The (String) —

    parameter indicates the group (oneOf|anyOf).

Raises:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/square/api_helper.rb', line 285

def self.map_types(value, template, group_name: nil)
  result_value = nil
  matches = 0
  types = []
  group_name = template.partition('(').first if group_name.nil? && template.match?(/anyOf|oneOf/)

  return if value.nil?

  if template.end_with?('{}') || template.end_with?('[]')
    types = template.split(group_name, 2).last.gsub(/\s+/, '').split
  else
    template = template.split(group_name, 2).last.delete_prefix('(').delete_suffix(')')
    types = template.scan(/(anyOf|oneOf)[(]([^[)]]*)[)]/).flatten.combination(2).map { |a, b| "#{a}(#{b})" }
    types.each { |t| template = template.gsub(", #{t}", '') }
    types = template.gsub(/\s+/, '').split(',').push(*types)
  end
  types.each do |element|
    if element.match?(/^(oneOf|anyOf)[(].*$/)
      begin
        result_value = map_types(value, element, matches)
        matches += 1
      rescue ValidationException
        next
      end
    elsif element.end_with?('{}')
      result_value, matches = map_hash_type(value, element, group_name, matches)
    elsif element.end_with?('[]')
      result_value, matches = map_array_type(value, element, group_name, matches)
    else
      begin
        result_value, matches = map_type(value, element, group_name, matches)
      rescue StandardError
        next
      end
    end
    break if group_name == 'anyOf' && matches == 1
  end
  raise ValidationException.new(value, template) unless matches == 1

  value = result_value unless result_value.nil?
  value
end

.process_complex_types_parameters(query_parameters, array_serialization) ⇒ Hash

Process complex types in query_params.

Parameters:

  • The (Hash) —

    hash of query parameters.

Returns:

  • (Hash) —

    A hash with the processed query parameters.



161
162
163
164
165
166
167
168
 
# File 'lib/square/api_helper.rb', line 161

def self.process_complex_types_parameters(query_parameters, array_serialization)
  processed_params = {}
  query_parameters.each do |key, value|
    processed_params.merge!(APIHelper.form_encode(value, key, formatting:
      array_serialization))
  end
  processed_params
end

.serializable_types ⇒ Object

Array of serializable types



429
430
431
432
 
# File 'lib/square/api_helper.rb', line 429

def self.serializable_types
  [String, Numeric, TrueClass,
   FalseClass, Date, DateTime]
end

.serialize_array(key, array, formatting: 'indexed') ⇒ Object

Serializes an array parameter (creates key value pairs).

Parameters:

  • The (String) —

    name of the parameter.

  • The (Array) —

    value of the parameter.

  • The (String) —

    format of the serialization.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/square/api_helper.rb', line 8

def self.serialize_array(key, array, formatting: 'indexed')
  tuples = []

  tuples += case formatting
            when 'csv'
              [[key, array.map { |element| CGI.escape(element.to_s) }.join(',')]]
            when 'psv'
              [[key, array.map { |element| CGI.escape(element.to_s) }.join('|')]]
            when 'tsv'
              [[key, array.map { |element| CGI.escape(element.to_s) }.join("\t")]]
            else
              array.map { |element| [key, element] }
            end
  tuples
end

.validate_types(value, template) ⇒ Object

Validates the value against the template(group of types).

Parameters:

  • The (String) —

    value to be mapped against the type.

  • The (String) —

    parameter indicates the group of types (oneOf(Integer, String)).



415
416
417
 
# File 'lib/square/api_helper.rb', line 415

def self.validate_types(value, template)
  map_types(APIHelper.json_deserialize(value.to_json), template)
end