smacks-apricoteatsgorilla 0.5.1 → 0.5.2

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/apricoteatsgorilla.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apricoteatsgorilla}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harrington"]
-  s.date = %q{2009-08-29}
+  s.date = %q{2009-08-30}
   s.description = %q{SOAP communication helper.}
   s.email = %q{me@d-harrington.com}
   s.extra_rdoc_files = [

data/lib/apricoteatsgorilla/apricoteatsgorilla.rb

@@ -22,7 +22,8 @@ class ApricotEatsGorilla
     # Flag to disable conversion of Hash keys to Symbols.
     attr_accessor :disable_hash_keys_to_symbols
 
-    # Hash of namespaces and XML nodes to apply these namespaces to.
+    # Hash of namespaces (keys) and XML nodes (values) to apply these
+    # namespaces to.
     attr_accessor :nodes_to_namespace
 
     # Shortcut method for translating between XML Strings and Ruby Hashes.
@@ -39,7 +40,8 @@ class ApricotEatsGorilla
       end
     end
 
-    # Yields this class in case a +block+ was given.
+    # Yields this class to a given +block+ for wrapping the setup of multiple
+    # flags at once.
     def setup
       yield self if block_given?
     end
@@ -50,9 +52,10 @@ class ApricotEatsGorilla
     # +root_node+ parameter for defining a custom root node to start parsing
     # at using an XPath-Expression (Hpricot search).
     #
-    # Notice that the root node itself won't be included in the Hash.
+    # Notice that both namespaces and attributes get removed and the root node
+    # itself won't be included in the Hash.
     #
-    # ==== Example
+    # ==== Examples
     #
     #   xml = '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     #       <soap:Body>
@@ -66,13 +69,16 @@ class ApricotEatsGorilla
     #       </soap:Body>
     #     </soap:Envelope>'
     #
+    #   ApricotEatsGorilla.xml_to_hash(xml)
+    #   # => { :body => { :authenticate_response => { :return => { :apricot => { :eats => "Gorilla" } } } } }
+    #
     #   ApricotEatsGorilla.xml_to_hash(xml, "//return")
     #   # => { :apricot => { :eats => "Gorilla" } }
     def xml_to_hash(xml, root_node = nil)
       doc = Hpricot.XML remove_whitespace(xml)
       root = root_node ? doc.search(root_node) : doc.root
 
-      return nil if root.nil?
+      return nil if root.nil? || (root.respond_to?(:size) && root.size == 0)
       if !root.respond_to? :each
         xml_node_to_hash(root)
       elsif root.size == 1
@@ -84,20 +90,26 @@ class ApricotEatsGorilla
 
     # Translates a given Ruby +hash+ into an XML String.
     #
-    # ==== Example
+    # ==== Examples
     #
     #   hash = { :apricot => { :eats => "Gorilla" } }
-    #
     #   ApricotEatsGorilla.hash_to_xml(hash)
+    #
     #   # => "<apricot><eats>Gorilla</eats></apricot>"
+    #
+    #   hash = { :apricot => { :eats => ["Gorillas", "Snakes"] } }
+    #   ApricotEatsGorilla.hash_to_xml(hash)
+    #
+    #   # => "<apricot><eats>Gorillas</eats><eats>Snakes</eats></apricot>"
     def hash_to_xml(hash)
       nested_data_to_xml(hash.keys.first, hash.values.first)
     end
 
-    # Builds a SOAP request envelope and includes the content from a given
-    # +block+ into the envelope body. Accepts a Hash of +namespaces+ to set.
+    # Builds a SOAP request envelope and includes the content of a given
+    # +block+ into the envelope body. Accepts a Hash of additional +namespaces+
+    # to set.
     #
-    # ==== Example
+    # ==== Examples
     #
     #   ApricotEatsGorilla.soap_envelope do
     #     "<apricot><eats>Gorilla</eats></apricot>"
@@ -108,6 +120,14 @@ class ApricotEatsGorilla
     #   # =>      <apricot><eats>Gorilla</eats></apricot>
     #   # =>    </env:Body>
     #   # =>  </env:Envelope>'
+    #
+    #   ApricotEatsGorilla.soap_envelope(:wsdl => "http://example.com") { "pureText" }
+    #
+    #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://example.com">
+    #   # =>    <env:Body>
+    #   # =>      pureText
+    #   # =>    </env:Body>
+    #   # =>  </env:Envelope>'
     def soap_envelope(namespaces = {})
       namespaces[:env] = "http://schemas.xmlsoap.org/soap/envelope/"
 

data/lib/apricoteatsgorilla/xml_node.rb

@@ -1,13 +1,13 @@
 # == XMLNode
 #
 # Representation of an XML node. Inherits from String and includes some
-# useful methods for namespaces, attributes, body content etc.
+# useful XML-specific methods for namespaces, attributes, node content etc.
 class XMLNode < String
 
   # Hash of attributes.
   attr_writer :attributes
 
-  # Body content.
+  # Node body content.
   attr_writer :body
 
   # Strips the namespace from this node.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-29 00:00:00 -07:00
+date: 2009-08-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency