Module: Rews::Util
- Included in:
- Client, Folder::BaseFolderId, Item::ItemId, Shape::Base, View::Base
- Defined in:
- lib/rews/util.rb
Class Method Summary collapse
-
.camel_keys(h) ⇒ Object
camel-case the keys of a
Hash
. -
.camelize(s) ⇒ Object
camel-case a
String
. -
.check_opts(constraints, opts = {}, prefix = nil) ⇒ Object
validates an options hash against a constraints hash in the constraints hash : * keys ending in ! indicate option is required * keys not ending in ! indicate option is not required * non-nil values provide defaults * hash values provide constraints for sub-hashes.
-
.rsxml_to_xml(sexp) ⇒ Object
convert rsxml to xml, transforming tags to CamelCase and prefixing with the t: namespace prefix.
-
.single_error_check(client, status) ⇒ Object
check the status of the response of a single part of a multi-part request.
-
.strip_bang(k) ⇒ Object
strip a ! from the end of a
String
orSymbol
. - .tag_exception(e, tags) ⇒ Object
-
.with_error_check(client, *response_msg_keys) ⇒ Object
check the response codes of an Exchange Web Services request.
Class Method Details
.camel_keys(h) ⇒ Object
camel-case the keys of a Hash
62 63 64 |
# File 'lib/rews/util.rb', line 62 def camel_keys(h) Hash[h.map{|k,v| [camelize(k.to_s), v]}] end |
.camelize(s) ⇒ Object
camel-case a String
57 58 59 |
# File 'lib/rews/util.rb', line 57 def camelize(s) s.split('_').map(&:capitalize).join end |
.check_opts(constraints, opts = {}, prefix = nil) ⇒ Object
validates an options hash against a constraints hash in the constraints hash :
-
keys ending in ! indicate option is required
-
keys not ending in ! indicate option is not required
-
non-nil values provide defaults
-
hash values provide constraints for sub-hashes
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/rews/util.rb', line 23 def check_opts(constraints, opts={}, prefix=nil) required_keys = Hash[constraints.keys.select{|k| k.to_s[-1..-1] == '!'}.map{|k| [strip_bang(k),k]}] optional_keys = constraints.keys.select{|k| k.to_s[-1..-1] != '!'} # check each of the provided options opts.keys.each do |key| raise "unknown option: #{[prefix,key].compact.join(".")}" if !required_keys.include?(key) && !optional_keys.include?(key) ckey = required_keys[key] || key if constraints[ckey].is_a? Hash check_opts(constraints[ckey], opts[key] || {}, [prefix,key].compact.join(".")) end required_keys.delete(key) optional_keys.delete(key) end raise "required options not given: #{required_keys.keys.map{|k| [prefix,k].compact.join('.')}.join(", ")}" if required_keys.size>0 # defaults optional_keys.each{|k| opts[k] = constraints[k] if constraints[k] && !constraints[k].is_a?(Hash)} opts end |
.rsxml_to_xml(sexp) ⇒ Object
convert rsxml to xml, transforming tags to CamelCase and prefixing with the t: namespace prefix
68 69 70 71 72 73 74 |
# File 'lib/rews/util.rb', line 68 def rsxml_to_xml(sexp) Rsxml.to_xml(sexp) do |tag, attrs| ttag = "t:#{camelize(tag.to_s)}" tattrs = Hash[attrs.map{|k,v| [camelize(k.to_s), v]}] [ttag, tattrs] end end |
.single_error_check(client, status) ⇒ Object
check the status of the response of a single part of a multi-part request
105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/rews/util.rb', line 105 def single_error_check(client, status) begin response_class = status[:response_class] rescue raise "no response_class found: #{status.inspect}" if !response_class end if status[:response_class] == "Error" return "#{status[:response_code]} - #{status[:message_text]}" elsif status[:response_class] == "Warning" Rews.log{|logger| logger.warn("#{status[:response_code]} - #{status[:message_text]}")} end end |
.strip_bang(k) ⇒ Object
strip a ! from the end of a String
or Symbol
48 49 50 51 52 53 54 |
# File 'lib/rews/util.rb', line 48 def strip_bang(k) if k.is_a? Symbol k.to_s[0...-1].to_sym else k.to_s[0...-1] end end |
.tag_exception(e, tags) ⇒ Object
10 11 12 13 14 15 |
# File 'lib/rews/util.rb', line 10 def tag_exception(e, ) .each do |k,v| mc = class << e ; self ; end mc.send(:define_method, k){v} end end |
.with_error_check(client, *response_msg_keys) ⇒ Object
check the response codes of an Exchange Web Services request. the supplied block makes a SOAP request, and the response is parsed out and checked
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/rews/util.rb', line 79 def with_error_check(client, *response_msg_keys) raise "no block" if !block_given? begin response = yield hash_response = response.to_hash statuses = hash_response.fetch_in(*response_msg_keys) if statuses.is_a?(Array) all_statuses = statuses else all_statuses = [statuses] end errors = all_statuses.map{|s| single_error_check(client, s)}.compact rescue Exception=>e Rews.log{|logger| logger.warn(e)} tag_exception(e, :savon_response=>response) raise e end raise Error.new(errors.join("\n")) if !errors.empty? statuses end |