module Zaius::Util

Constants

COLOR_CODES

private

OPTS_COPYABLE

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

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

Options that a user is allowed to specify.

Public Class Methods

check_api_key!(key) click to toggle source
# File lib/zaius/util.rb, line 193
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) click to toggle source
# File lib/zaius/util.rb, line 188
def self.check_string_argument!(key)
  raise TypeError, "argument must be a string" unless key.is_a?(String)
  key
end
convert_to_zaius_object(data, opts = {}) click to toggle source

Converts a hash of fields or an array of hashes into a ZaiusObject or array of +ZaiusObject+s. 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 ZaiusObject.

Attributes

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

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

# File lib/zaius/util.rb, line 58
def self.convert_to_zaius_object(data, opts = {})
  case data
  when Array
    data.map { |i| convert_to_zaius_object(i, opts) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic ZaiusObject
    object_classes.fetch(data[:object], ZaiusObject).construct_from(data, opts)
  else
    data
  end
end
encode_parameters(params) click to toggle source

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. `&`).

# File lib/zaius/util.rb, line 115
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) click to toggle source
# File lib/zaius/util.rb, line 131
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) click to toggle source
# File lib/zaius/util.rb, line 150
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 = {}) click to toggle source
# File lib/zaius/util.rb, line 77
def self.log_debug(message, data = {})
  if !Zaius.logger.nil? ||
     !Zaius.log_level.nil? && Zaius.log_level <= Zaius::LEVEL_DEBUG
    log_internal(message, data, color: :cyan, out: $stderr)
  end
end
log_error(message, data = {}) click to toggle source
# File lib/zaius/util.rb, line 84
def self.log_error(message, data = {})
  if !Zaius.logger.nil? ||
     !Zaius.log_level.nil? && Zaius.log_level <= Zaius::LEVEL_ERROR
    log_internal(message, data, color: :cyan, out: $stderr)
  end
end
log_info(message, data = {}) click to toggle source
# File lib/zaius/util.rb, line 70
def self.log_info(message, data = {})
  if !Zaius.logger.nil? ||
     !Zaius.log_level.nil? && Zaius.log_level <= Zaius::LEVEL_INFO
    log_internal(message, data, color: :cyan, out: $stderr)
  end
end
normalize_headers(headers) click to toggle source

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.

# File lib/zaius/util.rb, line 203
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) click to toggle source
# File lib/zaius/util.rb, line 164
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) click to toggle source

The secondary opts argument can either be a string or hash Turn this value into an api_key and a set of headers

# File lib/zaius/util.rb, line 176
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() click to toggle source
# File lib/zaius/util.rb, line 39
def self.object_classes
  @object_classes ||= {
    ListObject::OBJECT_NAME => ListObject,
    Subscription::OBJECT_NAME => Subscription,
  }
end
objects_to_ids(h) click to toggle source
# File lib/zaius/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
secure_compare(a, b) click to toggle source

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

# File lib/zaius/util.rb, line 214
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) click to toggle source
# File lib/zaius/util.rb, line 91
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) click to toggle source

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.

# File lib/zaius/util.rb, line 123
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

Private Class Methods

colorize(val, color, isatty) click to toggle source

Uses an ANSI escape code to colorize text if it's going to be sent to a TTY.

# File lib/zaius/util.rb, line 243
def self.colorize(val, color, isatty)
  return val unless isatty

  mode = 0 # default
  foreground = 30 + COLOR_CODES.fetch(color)
  background = 40 + COLOR_CODES.fetch(:default)

  "\033[#{mode};#{foreground};#{background}m#{val}\033[0m"
end
level_name(level) click to toggle source

Turns an integer log level into a printable name.

# File lib/zaius/util.rb, line 255
def self.level_name(level)
  level
end
log_internal(message, data = {}, color: nil, level: nil, logger: nil, out: nil) click to toggle source

TODO: Make these named required arguments when we drop support for Ruby 2.0.

# File lib/zaius/util.rb, line 262
def self.log_internal(message, data = {}, color: nil, level: nil, logger: nil, out: nil)
  data_str = data.reject { |_k, v| v.nil? }
                 .map do |(k, v)|
    format("%s=%s", colorize(k, color, logger.nil? && !out.nil? && out.isatty), wrap_logfmt_value(v))
  end.join(" ")

  if !logger.nil?
    # the library's log levels are mapped to the same values as the
    # standard library's logger
    logger.log(level,
               format("message=%s %s", wrap_logfmt_value(message), data_str))
  elsif out.isatty
    out.puts format("%s %s %s", nil, message, data_str)
  else
    out.puts format("message=%s level=%s %s", wrap_logfmt_value(message), level_name(level), data_str)
  end
end
wrap_logfmt_value(val) click to toggle source

Wraps a value in double quotes if it looks sufficiently complex so that it can be read by logfmt parsers.

# File lib/zaius/util.rb, line 283
def self.wrap_logfmt_value(val)
  # If value is any kind of number, just allow it to be formatted directly
  # to a string (this will handle integers or floats).
  return val if val.is_a?(Numeric)

  # Hopefully val is a string, but protect in case it's not.
  val = val.to_s

  if %r{[^\w\-/]} =~ val
    # If the string contains any special characters, escape any double
    # quotes it has, remove newlines, and wrap the whole thing in quotes.
    format(%("%s"), val.gsub('"', '\"').delete("\n"))
  else
    # Otherwise use the basic value if it looks like a standard set of
    # characters (and allow a few special characters like hyphens, and
    # slashes)
    val
  end
end