smacks-apricoteatsgorilla 0.3.3 → 0.3.6

data/README.rdoc

@@ -12,7 +12,7 @@ uses Hpricot instead of REXML and doesn't follow the BadgerFish convention.
 
 == Dependencies
 
-  Hpricot 0.6.164 (also available for JRuby)
+  hpricot 0.6.164 (also available for JRuby)
 
 == How to use
 

data/lib/apricoteatsgorilla.rb

@@ -7,20 +7,33 @@ require "hpricot"
 # be used to build a SOAP request envelope. It is based on CobraVsMongoose but
 # uses Hpricot instead of REXML and doesn't follow the BadgerFish convention.
 #
-# === Translating an XML String into a Ruby Hash
+# === xml_to_hash(xml, root_node = nil)
 #
-#   xml = "<apricot><eats>Gorilla</eats></apricot>"
-#   ApricotEatsGorilla[xml]
-#   # => { :eats => "Gorilla" }
+#   xml = '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+#     <soap:Body>
+#       <ns2:authenticateResponse xmlns:ns2="http://v1_0.ws.example.com/">
+#         <return>
+#           <authValue>
+#             <token>secret</token>
+#             <client>example</client>
+#           </authValue>
+#         </return>
+#       </ns2:authenticateResponse>
+#     </soap:Body>
+#   </soap:Envelope>'
 #
-# === Translating a Ruby Hash into an XML String
+#   ApricotEatsGorilla[xml, "//return"]
+#   # => { :auth_value => { :token => "secret", :client => "example" } }
+#
+# === hash_to_xml(hash)
 #
 #   hash = { :apricot => { :eats => "Gorilla" } }
+#
 #   ApricotEatsGorilla[hash]
 #   # => "<apricot><eats>Gorilla</eats></apricot>"
 #
-# === Creating a SOAP request envelope
-# 
+# === soap_envelope(namespaces = {})
+#
 #   ApricotEatsGorilla.soap_envelope { "<authenticate>me</authenticate>" }
 #
 #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
@@ -76,6 +89,8 @@ class ApricotEatsGorilla
       xml = clean_xml(xml)
       doc = Hpricot.XML(xml)
       root = root_node ? doc.at(root_node) : doc.root
+
+      return nil if root.nil?
       xml_node_to_hash(root)
     end
 
@@ -164,7 +179,7 @@ class ApricotEatsGorilla
           when nil
             this_node[key] = value
           else
-            this_node[key] = [current, value]
+            this_node[key] = [current.dup, value]
         end
       end
       this_node

data/test/apricoteatsgorilla/hash_to_xml_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), "..", "helper")
+
+class HashToXmlTest < Test::Unit::TestCase
+
+  context "Calling hash_to_xml" do
+    setup { ApricotEatsGorilla.sort_keys = true }
+
+    context "with a Hash consisting of a single key-value-pair" do
+      should "returns an XML String containing one node and a value" do
+        hash = { "apricot" => "eats gorilla" }
+        expected = "<apricot>eats gorilla</apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+    end
+
+    context "with a Hash containing another Hash" do
+      should "returns an XML String representing the given structure" do
+        hash = { "apricot" => { "eats" => "gorilla", "drinks" => "beer" } }
+        expected = "<apricot><drinks>beer</drinks><eats>gorilla</eats></apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+    end
+
+    context "with a Hash containing a Hash containing an Array" do
+      should "returns an XML String representing the given structure" do
+        hash = { "apricot" => { "eats" => [ "gorilla", "snake" ] } }
+        expected = "<apricot><eats>gorilla</eats><eats>snake</eats></apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+    end
+
+    context "with a Hash containing a Hash containing an Array containing a Hash" do
+      should "returns an XML String representing the given structure" do
+        hash = { "apricot" =>
+          { "eats" => [ { "lotsOf" => "gorillas" }, { "justSome" => "snakes" } ]
+        } }
+        expected = "<apricot><eats><lotsOf>gorillas</lotsOf></eats>" <<
+          "<eats><justSome>snakes</justSome></eats></apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+    end
+  end
+
+end

data/test/apricoteatsgorilla/shortcut_method_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), "..", "helper")
+
+class ShortcutMethodTest < Test::Unit::TestCase
+
+  context "Calling []" do
+    setup { ApricotEatsGorilla.sort_keys = true }
+
+    context "with an XML String" do
+      should "return a Hash containing the XML content" do
+        xml = "<root><name>Jungle Julia</name></root>"
+        expected = { :name => "Jungle Julia" }
+
+        result = ApricotEatsGorilla[xml]
+        assert_equal expected, result
+      end
+    end
+
+    context "with an XML String and a custom root node" do
+      should "return a Hash containing the XML content starting at custom root" do
+        xml = "<root><something><name>Jungle Julia</name></something></root>"
+        expected = { :name => "Jungle Julia" }
+
+        result = ApricotEatsGorilla[xml, "//something"]
+        assert_equal expected, result
+      end
+    end
+
+    context "with a Hash" do
+      should "return an XML String containing the XML content" do
+        hash = { "apricot" => "eats gorilla" }
+        expected = "<apricot>eats gorilla</apricot>"
+
+        result = ApricotEatsGorilla[hash]
+        assert_equal expected, result
+      end
+    end
+  end
+
+end

data/test/apricoteatsgorilla/soap_envelope_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "..", "helper")
+
+class SoapEnvelopeTest < Test::Unit::TestCase
+
+  context "Calling soap_envelope" do
+    setup { ApricotEatsGorilla.sort_keys = true }
+
+    context "without parameter and block" do
+      should "returns a SOAP envelope without body content" do
+        expected = '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">' <<
+          '<env:Body></env:Body></env:Envelope>'
+
+        result = ApricotEatsGorilla.soap_envelope
+        assert_equal expected, result
+      end
+    end
+    
+    context "with a Hash containing a custom namespace and a block" do
+      should "returns a SOAP envelope with custom namespace and body content" do
+        expected = '<env:Envelope ' <<
+          'xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" ' <<
+          'xmlns:wsdl="http://example.com">' <<
+          '<env:Body><id>123</id></env:Body></env:Envelope>'
+
+        result = ApricotEatsGorilla.soap_envelope "wsdl" => "http://example.com" do
+          "<id>123</id>"
+        end
+        assert_equal expected, result
+      end
+    end
+  end
+
+end

data/test/apricoteatsgorilla/xml_to_hash_test.rb

@@ -0,0 +1,70 @@
+require File.join(File.dirname(__FILE__), "..", "helper")
+
+class XmlToHashTest < Test::Unit::TestCase
+
+  context "Calling xml_to_hash" do
+    setup { ApricotEatsGorilla.sort_keys = true }
+
+    context "with a SOAP response example and a custom root node" do
+      should "return a Hash containing the XML content" do
+        xml = '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+          <soap:Body>
+            <ns2:authenticateResponse xmlns:ns2="http://v1_0.ws.example.com/">
+              <return>
+                <authValue>
+                  <token>secret</token>
+                  <client>example</client>
+                </authValue>
+              </return>
+            </ns2:authenticateResponse>
+          </soap:Body>
+        </soap:Envelope>'
+        expected = { :auth_value => { :token => "secret", :client => "example" } }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml, "//return")
+        assert_equal expected, result
+      end
+    end
+
+    context "with XML containing 'true' and 'false' Strings" do
+      should "convert these Strings into actual Boolean objects" do
+        xml = "<root><yes>true</yes><no>false</no><text>something</text></root>"
+        expected = { :yes => true, :no => false, :text => "something" }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml)
+        assert_equal expected, result
+      end
+    end
+
+    context "with XML containing empty element tags" do
+      should "convert empty element tags to nil" do
+        xml = "<contact><name>Jungle Julia</name><email /><phone/></contact>"
+        expected = { :name => "Jungle Julia", :email => nil, :phone => nil }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml)
+        assert_equal expected, result
+      end
+    end
+
+    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" }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml)
+        assert_equal expected, result
+      end
+    end
+
+    context "with XML containing nodes with the same name" do
+      should "group these nodes into an Array" do
+        xml = "<root><items>first</items><items>second</items></root>"
+        expected = { :items => [ "first", "second" ] }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml)
+        assert_equal expected, result
+      end
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+require "test/unit"
+require "shoulda"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.3.6
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -61,4 +61,9 @@ signing_key:
 specification_version: 2
 summary: Apricot eats Gorilla is a SOAP communication helper.
 test_files: 
-- tests/apricoteatsgorilla_test.rb
+- test/apricoteatsgorilla_test.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