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.



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

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 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/square/api_helper.rb', line 164

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

.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



199
200
201
202
203
204
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
 
# File 'lib/square/api_helper.rb', line 199

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

  serializable_types = [String, Numeric, TrueClass,
                        FalseClass, Date, DateTime]

  # 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 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.



142
143
144
145
146
147
148
149
150
 
# File 'lib/square/api_helper.rb', line 142

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

.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

.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



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

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

.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.



155
156
157
158
159
160
161
162
 
# File 'lib/square/api_helper.rb', line 155

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

.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