Module: Screenbeacon::Util
- Defined in:
- lib/screenbeacon/util.rb
Class Method Summary collapse
- .check_api_id!(id) ⇒ Object
- .check_api_token!(token) ⇒ Object
- .check_string_argument!(key) ⇒ Object
- .convert_to_screenbeacon_object(resp, opts) ⇒ Object
- .file_readable(file) ⇒ Object
- .flatten_params(params, parent_key = nil) ⇒ Object
- .flatten_params_array(value, calculated_key) ⇒ Object
-
.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.
- .object_classes ⇒ Object
- .objects_to_ids(h) ⇒ Object
- .symbolize_names(object) ⇒ Object
- .url_encode(key) ⇒ Object
Class Method Details
.check_api_id!(id) ⇒ Object
121 122 123 124 |
# 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) ⇒ Object
125 126 127 128 |
# 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) ⇒ Object
116 117 118 119 |
# 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) ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 |
# 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) ⇒ Object
39 40 41 42 43 44 45 46 47 48 49 50 |
# 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) ⇒ Object
72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# 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) ⇒ Object
87 88 89 90 91 92 93 94 95 96 97 98 99 |
# 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) ⇒ Object
The secondary opts argument can either be a string or hash Turn this value into an api_key and a set of headers
103 104 105 106 107 108 109 110 111 112 113 114 |
# 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 ⇒ Object
18 19 20 21 22 23 24 25 |
# 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) ⇒ Object
3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
# 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) ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# 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) ⇒ Object
68 69 70 |
# File 'lib/screenbeacon/util.rb', line 68 def self.url_encode(key) URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")) end |