Module: Telnyx::Util

Defined in:
lib/telnyx/util.rb

Constant Summary collapse

OPTS_USER_SPECIFIED =

Options that a user is allowed to specify.

Set[
  :api_key,
].freeze
OPTS_COPYABLE =

Options that should be copyable from one TelnyxObject 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]
).freeze

Class Method Summary collapse

Class Method Details

.check_api_key!(key) ⇒ Object

Raises:

  • (TypeError) 


217
218
219
220
 
# File 'lib/telnyx/util.rb', line 217

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) 


212
213
214
215
 
# File 'lib/telnyx/util.rb', line 212

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

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

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

Attributes

  • Data - Hash of fields and values to be converted into a TelnyxObject.

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/telnyx/util.rb', line 71

def self.convert_to_telnyx_object(data, opts = {})
  case data
  when Array
    data.map { |i| convert_to_telnyx_object(i, opts) }
  when Hash
    # Try converting to a known object class. If none available, fall back to generic TelnyxObject
    if data[:data].is_a?(Array)
      ListObject.construct_from(data, opts)
    elsif data[:data].is_a?(Hash) && data[:data][:record_type]
      object_classes.fetch(data[:data][:record_type], TelnyxObject).construct_from(data[:data], opts)
    elsif data[:record_type]
      object_classes.fetch(data[:record_type], TelnyxObject).construct_from(data, opts)
    else
      TelnyxObject.construct_from(data, opts)
    end
  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. ‘&`).



139
140
141
142
 
# File 'lib/telnyx/util.rb', line 139

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 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/telnyx/util.rb', line 155

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 



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/telnyx/util.rb', line 174

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 



107
108
109
110
111
112
113
 
# File 'lib/telnyx/util.rb', line 107

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

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



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

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

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



99
100
101
102
103
104
105
 
# File 'lib/telnyx/util.rb', line 99

def self.log_info(message, data = {})
  if !Telnyx.logger.nil? ||
     !Telnyx.log_level.nil? && Telnyx.log_level <= Telnyx::LEVEL_INFO
    log_internal(message, data, color: :cyan,
                                level: Telnyx::LEVEL_INFO, logger: Telnyx.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.



227
228
229
230
231
232
233
234
 
# File 'lib/telnyx/util.rb', line 227

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 



188
189
190
191
192
193
194
195
196
 
# File 'lib/telnyx/util.rb', line 188

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



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/telnyx/util.rb', line 200

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 



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

def self.object_classes
  @object_classes ||= APIResource.descendants
                                 .select { |klass| klass.constants(false).include? :OBJECT_NAME }
                                 .map { |klass| [klass::OBJECT_NAME, klass] }
                                 .to_h
                                 .merge(
                                   "credential"                                  => TelephonyCredential,
                                   "messaging_settings"                          => MessagingPhoneNumber,
                                   "phone_number_regulatory_group"               => PhoneNumberRegulatoryRequirement,
                                   "phone_number_reservation"                    => NumberReservation,
                                   "verification_profile"                        => VerifyProfile,
                                   "verification"                                => Verification::Response
                                 )
end

.objects_to_ids(h) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/telnyx/util.rb', line 24

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

.push_object_class(key, klass) ⇒ Object 



54
55
56
57
 
# File 'lib/telnyx/util.rb', line 54

def self.push_object_class(key, klass)
  object_classes
  @object_classes[key] = klass
end

.secure_compare(a, b) ⇒ Object

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



238
239
240
241
242
243
244
245
246
 
# File 'lib/telnyx/util.rb', line 238

def self.secure_compare(a, b)
  return false unless a.bytesize == b.bytesize

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

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

.symbolize_names(object) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/telnyx/util.rb', line 115

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.



147
148
149
150
151
152
153
 
# File 'lib/telnyx/util.rb', line 147

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