smacks-apricoteatsgorilla 0.4.3 → 0.4.4

data/lib/apricoteatsgorilla.rb

@@ -1,4 +1,5 @@
 require "rubygems"
+require "iconv"
 require "hpricot"
 
 # Apricot eats Gorilla is a SOAP communication helper.
@@ -30,11 +31,6 @@ class ApricotEatsGorilla
     # Shortcut method for translating between XML Strings and Ruby Hashes.
     # Delegates to xml_to_hash in case +source+ is of type String or delegates
     # to hash_to_xml in case +source+ is of type Hash. Returns nil otherwise.
-    #
-    # ==== Parameters
-    #
-    # * +source+ - The XML String or Ruby Hash to translate.
-    # * +root_node+ - Optional. Custom root node to start parsing the given XML.
     def [](source, root_node = nil)
       case source
       when String
@@ -58,11 +54,6 @@ class ApricotEatsGorilla
     # The root node itself won't be included in the Hash. Converts tag names
     # from CamelCase/lowerCamelCase to snake_case and into Symbols by default.
     #
-    # ==== Parameters
-    #
-    # * +xml+ - The XML String to translate.
-    # * +root_node+ - Optional. Custom root node to start parsing the given XML.
-    #
     # ==== Examples
     #
     #   xml = "<apricot><eats>Gorilla</eats></apricot>"
@@ -73,23 +64,29 @@ class ApricotEatsGorilla
     #   ApricotEatsGorilla[xml, "//eats"]
     #   # => { :lots_of => "Gorillas" }
     def xml_to_hash(xml, root_node = nil)
-      doc = Hpricot.XML clean_xml(xml)
-      root = root_node ? doc.at(root_node) : doc.root
+      doc = Hpricot.XML remove_whitespace(xml)
+      root = root_node ? doc.search(root_node) : doc.root
+
+      return nil if root.nil?
+      return xml_node_to_hash(root) unless root.respond_to? :each
 
-      return nil if root.nil? # root_node not found
-      if root.children.size == 1 && root.children.first.kind_of?(Hpricot::Text)
-        return root.children.first.to_s  # text-only value
+      if root.size == 1
+        return root.first.children.to_s if root.first.children.first.kind_of?(Hpricot::Text)
+        xml_node_to_hash(root.first)
+      else
+        root.map do |node|
+          if node.children.first.kind_of?(Hpricot::Text)
+            node.children.to_s
+          else
+            xml_node_to_hash(node)
+          end
+        end
       end
-      xml_node_to_hash(root)
     end
 
     # Converts a given Ruby Hash into an XML String. Converts Hash keys from
     # snake_case to lowerCamelCase by default.
     #
-    # ==== Parameters
-    #
-    # * +hash+ - The Ruby Hash to translate.
-    #
     # ==== Examples
     #
     #   hash = { :apricot => { :eats => "Gorilla" } }
@@ -107,10 +104,6 @@ class ApricotEatsGorilla
     # into the envelope body. Accepts a Hash (namespace => namespace_uri) of
     # additional +namespaces+ to set.
     #
-    # ==== Parameters
-    #
-    # * +namespaces+ - A Hash of namespaces and their URI.
-    #
     # ==== Examples
     #
     #  ApricotEatsGorilla.soap_envelope { "<authenticate>me</authenticate>" }
@@ -157,10 +150,6 @@ class ApricotEatsGorilla
 
     # Actual implementation for xml_to_hash. Takes and iterates through a given
     # Hpricot +element+ and returns a Ruby Hash equal to the given content.
-    #
-    # ==== Parameters
-    #
-    # * +element+ - The Hpricot element to translate.
     def xml_node_to_hash(element)
       this_node = {}
       element.each_child do |child|
@@ -168,7 +157,7 @@ class ApricotEatsGorilla
         if child.children.nil? || child.children.empty?
           key, value = child.name, nil
         elsif child.children.size == 1 && child.children.first.text?
-          key, value = child.name, to_boolean(child.children.first.to_html)
+          key, value = child.name, map_to_boolean(child.children.first.to_html)
         else
           key, value = child.name, xml_node_to_hash(child)
         end
@@ -191,11 +180,6 @@ class ApricotEatsGorilla
 
     # Actual implementation for hash_to_xml. Takes a Hash key +name+ and a
     # value +item+ and returns an XML String equal to the given content.
-    #
-    # ==== Parameters
-    #
-    # * +name+ - Root key from Hash to translate.
-    # * +item+ - Root value from Hash to translate.
     def nested_data_to_xml(name, item)
       case item
       when Array
@@ -220,11 +204,6 @@ class ApricotEatsGorilla
 
     # Creates an XML tag. Expects a block for tag content. Defaults to an empty
     # element tag in case no block was supplied.
-    #
-    # ==== Parameters
-    #
-    # * +name+ - The name of the XML tag.
-    # * +attributes+ - Optional. Hash of attributes for the XML tag.
     def tag(name, attributes = {})
       name = to_lower_camel_case(name) unless disable_tag_names_to_lower_camel_case
       if nodes_to_namespace.kind_of? Array
@@ -233,30 +212,27 @@ class ApricotEatsGorilla
       return "<#{name} />" unless block_given?
 
       attr = opt_order(attributes).map { |k, v| %Q( xmlns:#{k}="#{v}") }.to_s
-      body = (yield && !yield.empty?) ? yield : ""
+      body = yield || ""
       "<#{name}#{attr}>" << body << "</#{name}>"
     end
 
-    # Removes line breaks and whitespace between tags from a given +xml+ String.
-    def clean_xml(xml)
-      xml.gsub!(/\n+/, "")
-      xml.gsub!(/(>)\s*(<)/, '\1\2')
-      xml
+    # Removes whitespace between tags of a given +xml+ String.
+    def remove_whitespace(xml)
+      xml.gsub(/(>)\s*(<)/, '\1\2')
     end
 
     # Removes the namespace from a given XML +tag+.
     def remove_namespace(tag)
-      tag.sub!(/.+:(.+)/, '\1')
-      tag
+      tag.sub(/.+:(.+)/, '\1')
     end
 
     # Checks to see if a given +string+ matches "true" or "false" and converts
     # these values to actual Boolean objects. Returns the original String in
     # case it does not match "true" or "false".
-    def to_boolean(string)
+    def map_to_boolean(string)
       return true if string == "true"
       return false if string == "false"
-      string
+      Iconv.new("iso-8859-1", "utf-8").iconv(string)
     end
 
     # Returns a sorted version of a given +hash+ if sort_keys is enabled.

data/test/apricoteatsgorilla/{hash_to_xml_test.rb → test_hash_to_xml.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class HashToXmlTest < Test::Unit::TestCase
+class TestHashToXml < Test::Unit::TestCase
 
   context "Calling hash_to_xml" do
     setup do

data/test/apricoteatsgorilla/{shortcut_method_test.rb → test_shortcut_method.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class ShortcutMethodTest < Test::Unit::TestCase
+class TestShortcutMethod < Test::Unit::TestCase
 
   context "Calling []" do
     setup do

data/test/apricoteatsgorilla/{soap_envelope_test.rb → test_soap_envelope.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class SoapEnvelopeTest < Test::Unit::TestCase
+class TestSoapEnvelope < Test::Unit::TestCase
 
   context "Calling soap_envelope" do
     setup { ApricotEatsGorilla.sort_keys = true }

data/test/apricoteatsgorilla/{xml_to_hash_test.rb → test_xml_to_hash.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class XmlToHashTest < Test::Unit::TestCase
+class TestXmlToHash < Test::Unit::TestCase
 
   context "Calling xml_to_hash" do
     setup do
@@ -55,14 +55,24 @@ class XmlToHashTest < Test::Unit::TestCase
 
     context "with XML containing nodes with attributes" do
       should "return a Hash without tag attributes" do
-        xml = '<todo><paint subject="chair" color="#000000">black</paint></todo>'
-        expected = { :paint => "black" }
+        xml = '<root><user id="123">example</user></root>'
+        expected = { :user => "example" }
 
         result = ApricotEatsGorilla.xml_to_hash(xml)
         assert_equal expected, result
       end
     end
 
+    context "with XML containing multiple custom root nodes" do
+      should "return an Array containing the values of each root node" do
+        xml = '<root><return><id>123</id></return><return><id>456</id></return></root>'
+        expected = [{ :id => "123" }, { :id => "456" }]
+
+        result = ApricotEatsGorilla.xml_to_hash(xml, "//return")
+        assert_equal expected, result
+      end
+    end
+
     context "with XML containing no subnodes at custom root node" do
       should "return the plain content of the custom root node" do
         xml = '<root><return>123</return></root>'
@@ -73,6 +83,26 @@ class XmlToHashTest < Test::Unit::TestCase
       end
     end
 
+    context "with XML containing no subnodes in multiple custom root nodes" do
+      should "return an Array containing the values of each root node" do
+        xml = '<root><return>123</return><return>456</return></root>'
+        expected = ["123", "456"]
+
+        result = ApricotEatsGorilla.xml_to_hash(xml, "//return")
+        assert_equal expected, result
+      end
+    end
+
+    context "with XML containing several subnodes with the same name and text content" do
+      should "return a Hash containing one key and an array of Strings" do
+        xml = '<root><return><items>123</items><items>456</items></return></root>'
+        expected = { :items => ["123", "456"] }
+        
+        result = ApricotEatsGorilla[xml, "//return"]
+        assert_equal expected, result
+      end
+    end
+
     context "with XML containing lowerCamelCase nodes" do
       should "convert lowerCamelCase nodes to snake_case" do
         xml = "<contact><firstName>Jungle</firstName><lastName>Julia</lastName></contact>"

data/test/test_apricoteatsgorilla.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.join(File.dirname(__FILE__), "apricoteatsgorilla"))
+require "test_shortcut_method"
+require "test_xml_to_hash"
+require "test_hash_to_xml"
+require "test_soap_envelope"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -61,9 +61,9 @@ signing_key:
 specification_version: 2
 summary: Apricot eats Gorilla is a SOAP communication helper.
 test_files: 
-- test/apricoteatsgorilla_test.rb
+- test/test_apricoteatsgorilla.rb
 - test/helper.rb
-- test/apricoteatsgorilla/hash_to_xml_test.rb
-- test/apricoteatsgorilla/xml_to_hash_test.rb
-- test/apricoteatsgorilla/shortcut_method_test.rb
-- test/apricoteatsgorilla/soap_envelope_test.rb
+- test/apricoteatsgorilla/test_hash_to_xml.rb
+- test/apricoteatsgorilla/test_xml_to_hash.rb
+- test/apricoteatsgorilla/test_shortcut_method.rb
+- test/apricoteatsgorilla/test_soap_envelope.rb

data/test/apricoteatsgorilla_test.rb

@@ -1,5 +0,0 @@
-$:.unshift(File.join(File.dirname(__FILE__), "apricoteatsgorilla"))
-require "shortcut_method_test"
-require "xml_to_hash_test"
-require "hash_to_xml_test"
-require "soap_envelope_test"