module Screenbeacon::Util

Public Class Methods

check_api_id!(id) click to toggle source
# File lib/screenbeacon/util.rb, line 121
def self.check_api_id!(id)
  raise TypeError.new("api_id must be a string") unless id.is_a?(String)
  id
end
check_api_token!(token) click to toggle source
# File lib/screenbeacon/util.rb, line 125
def self.check_api_token!(token)
  raise TypeError.new("api_token must be a string") unless token.is_a?(String)
  token
end
check_string_argument!(key) click to toggle source
# File lib/screenbeacon/util.rb, line 116
def self.check_string_argument!(key)
  raise TypeError.new("argument must be a string") unless key.is_a?(String)
  key
end
convert_to_screenbeacon_object(resp, opts) click to toggle source
# File lib/screenbeacon/util.rb, line 27
def self.convert_to_screenbeacon_object(resp, opts)
  case resp
  when Array
    resp.map { |i| convert_to_screenbeacon_object(i, opts) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic ScreenbeaconObject
    object_classes.fetch(resp[:object], ScreenbeaconObject).construct_from(resp, opts)
  else
    resp
  end
end
file_readable(file) click to toggle source
# File lib/screenbeacon/util.rb, line 39
def self.file_readable(file)
  # This is nominally equivalent to File.readable?, but that can
  # report incorrect results on some more oddball filesystems
  # (such as AFS)
  begin
    File.open(file) { |f| }
  rescue
    false
  else
    true
  end
end
flatten_params(params, parent_key=nil) click to toggle source
# File lib/screenbeacon/util.rb, line 72
def self.flatten_params(params, parent_key=nil)
  result = []
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
    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/screenbeacon/util.rb, line 87
def self.flatten_params_array(value, calculated_key)
  result = []
  value.each do |elem|
    if elem.is_a?(Hash)
      result += flatten_params(elem, calculated_key)
    elsif elem.is_a?(Array)
      result += flatten_params_array(elem, calculated_key)
    else
      result << ["#{calculated_key}[]", elem]
    end
  end
  result
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/screenbeacon/util.rb, line 103
def self.normalize_opts(opts)
  case opts
  when String
    {:api_key => opts}
  when Hash
    check_api_id!(opts.fetch(:api_id)) if opts.has_key?(:api_id)
    check_api_token!(opts.fetch(:api_token)) if opts.has_key?(:api_token)
    opts.clone
  else
    raise TypeError.new('normalize_opts expects a string or a hash')
  end
end
object_classes() click to toggle source
# File lib/screenbeacon/util.rb, line 18
def self.object_classes
  @object_classes ||= {
    # data structures
    'project' => Project,
    'test' => Test,
    'alert' => Alert
  }
end
objects_to_ids(h) click to toggle source
# File lib/screenbeacon/util.rb, line 3
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
symbolize_names(object) click to toggle source
# File lib/screenbeacon/util.rb, line 52
def self.symbolize_names(object)
  case object
  when Hash
    new_hash = {}
    object.each do |key, value|
      key = (key.to_sym rescue key) || 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
# File lib/screenbeacon/util.rb, line 68
def self.url_encode(key)
  URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
end