lib/rews/util.rb in rews-0.1.0 vs lib/rews/util.rb in rews-0.2.0

@@ -4,14 +4,14 @@
   module Util
     module_function
 
     # 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
+    # * 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
     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
@@ -28,30 +28,36 @@
       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].is_a?(Hash)}
+      optional_keys.each{|k| opts[k] = constraints[k] if constraints[k] && !constraints[k].is_a?(Hash)}
       opts
     end
 
+    # strip a ! from the end of a +String+ or +Symbol+
     def strip_bang(k)
       if k.is_a? Symbol
         k.to_s[0...-1].to_sym
       else
         k.to_s[0...-1]
       end
     end
 
+    # camel-case a +String+
     def camelize(s)
       s.split('_').map(&:capitalize).join
     end
 
+    # camel-case the keys of a +Hash+
     def camel_keys(h)
       Hash[h.map{|k,v| [camelize(k.to_s), v]}]
     end
 
+    # 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
     def with_error_check(client, *response_msg_keys)
       raise "no block" if !block_given?
 
       response = yield
       hash_response = response.to_hash
@@ -67,20 +73,21 @@
       raise errors.join("\n") if !errors.empty?
 
       statuses
     end
 
+    # check the status of the response of a single part of a multi-part request
     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 "Rews: #{status[:response_code]} - #{status[:message_text]}"
+        return "#{status[:response_code]} - #{status[:message_text]}"
       elsif status[:response_class] == "Warning"
-        client.log{|logger| logger.warn("#{status[:message_text]}")}
+        client.log{|logger| logger.warn("#{status[:response_code]} - #{status[:message_text]}")}
       end
     end
   end
 end