smacks-apricoteatsgorilla 0.2.5 → 0.2.6

data/README.rdoc

@@ -1,11 +1,8 @@
 = Apricot eats Gorilla
 
-Apricot eats Gorilla translates between XML documents and Hashes.
-It's based on CobraVsMongoose but uses Hpricot instead of REXML to parse
-XML and it also doesn't follow the BadgerFish convention.
-
-Its initial purpose was to convert SOAP response messages to Hashes,
-but it quickly evolved into a more general translation tool.
+Apricot eats Gorilla is a helper for working with XML and SOAP messages.
+It's based on CobraVsMongoose but without REXML and the BadgerFish convention.
+Also it offers some extras for working with SOAP messages.
 
 == Install
 
@@ -68,4 +65,4 @@ And it gets converted into a nice little Hash:
 
 == More information
 
-Take a look at the tests for some more examples.
+Take a look at the tests for some more examples.

data/lib/apricoteatsgorilla.rb

@@ -2,22 +2,20 @@
 require 'rubygems'
 require 'hpricot'
 
-# Apricot eats Gorilla translates between XML documents and Hashes.
-# It's based on CobraVsMongoose but uses Hpricot instead of REXML to parse
-# XML and it also doesn't follow the BadgerFish convention.
-# 
-# Its initial purpose was to convert SOAP response messages to Hashes,
-# but it quickly evolved into a more general translation tool.
+# Apricot eats Gorilla is a helper for working with XML and SOAP messages.
+# It's based on CobraVsMongoose but without REXML and the BadgerFish convention.
+# Also it offers some extras for working with SOAP messages.
 class ApricotEatsGorilla
-
   class << self
+
+    # Flag to enable optional sorting of Hash keys. Especially useful for
+    # comparing expected values with actual results while testing.
     attr_accessor :sort_keys
 
     # Converts XML into a Hash. Starts parsing at root node by default.
     # Call with XPath expession (Hpricot search) as second parameter to define
     # a custom root node. The root node itself will not be included in the Hash.
     #
-    # E.g.
     #  xml = "<dude><likes>beer</likes><hates>appletini</hates></dude>"
     #  ApricotEatsGorilla.xml_to_hash(xml)
     #  # => { "hates" => "appletini", "likes" => "beer" }
@@ -29,8 +27,7 @@ class ApricotEatsGorilla
     end
 
     # Converts a Hash to XML.
-    #
-    # E.g.
+    # 
     #  hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
     #  ApricotEatsGorilla.hash_to_xml(hash)
     #  # => "<dude><hates>appletini</hates><likes>beer</likes></dude>"
@@ -38,24 +35,52 @@ class ApricotEatsGorilla
       nested_data_to_xml(hash.keys.first, hash.values.first)
     end
 
+    # Builds a SOAP envelope and includes the content from an expected block
+    # into the envelope body. Pass in a Hash of namespaces and their URI to
+    # set custom namespaces.
+    #
+    #  <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    #    <env:Body>
+    #      yield
+    #    </env:Body>
+    #  </env:Envelope>
+    def soap_envelope(namespaces = {})
+      namespaces["env"] = "http://schemas.xmlsoap.org/soap/envelope/"
+      tag("env:Envelope", namespaces) do
+        tag("env:Body") do
+          yield if block_given?
+        end
+      end
+    end
+
+    # Creates an XML tag. Expects a block for tag content.
+    # Defaults to an empty element tag in case no block was supplied.
+    def tag(name, attributes = {})
+      return "<#{name} />" unless block_given?
+
+      attr = opt_order(attributes).map { |k, v| sprintf(' xmlns:%s="%s"', k, v) }.to_s
+      body = (yield && !yield.empty?) ? yield : ""
+      "<#{name}#{attr}>" << body << "</#{name}>"
+    end
+
   private
 
     # Converts XML into a Hash.
     def xml_node_to_hash(node)
       this_node = {}
-
       node.each_child do |child|
+        # hpricot 0.6.1 returns an empty array, while 0.8 returns nil
         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, string_to_bool?(child.children.first.inner_text)
+          key, value = child.name, booleanize(child.children.first.inner_text)
         else
           key, value = child.name, xml_node_to_hash(child)
         end
 
         current = this_node[key]
         case current
-          when Array:
+          when Array
             this_node[key] << value
           when nil
             this_node[key] = value
@@ -63,7 +88,6 @@ class ApricotEatsGorilla
             this_node[key] = [current.dup, value]
         end
       end
-
       this_node
     end
 
@@ -71,15 +95,15 @@ class ApricotEatsGorilla
     def nested_data_to_xml(name, item)
       case item
       when String
-        make_tag(name) { item }
+        tag(name) { item }
       when Array
         item.map { |subitem| nested_data_to_xml(name, subitem) }.join
       when Hash
-        make_tag(name) do
+        tag(name) do
           opt_order(item).map { |tag, value|
             case value
             when String
-              make_tag(tag) { value }
+              tag(tag) { value }
             when Array
               value.map { |subitem| nested_data_to_xml(tag, subitem) }.join
             when Hash
@@ -90,17 +114,7 @@ class ApricotEatsGorilla
       end
     end
 
-    # Helper to create an XML tag. Expects a block for tag content.
-    # Defaults to an empty element tag in case no block was supplied.
-    def make_tag(name)
-      body = yield
-      if body && !body.empty?
-        "<#{name}>" << body << "</#{name}>"
-      else
-        "<#{name} />"
-      end
-    end
-
+    # Returns a sorted version of a given Hash in case :sort_keys is enabled.
     def opt_order(hash)
       if sort_keys
         hash.sort_by{ |kv| kv.first }
@@ -117,7 +131,7 @@ class ApricotEatsGorilla
 
     # Helper to convert "true" and "false" strings to boolean values.
     # Returns the original string in case it doesn't match "true" or "false".
-    def string_to_bool?(string)
+    def booleanize(string)
       return true if string == "true"
       return false if string == "false"
       string

data/tests/apricoteatsgorilla_test.rb

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
+
+class ApricotEatsGorillaTest < Test::Unit::TestCase
+
+  def setup
+    ApricotEatsGorilla.sort_keys = true
+  end
+
+  # xml_to_hash
+  def test_xml_to_hash_with_soap_response_example
+    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 = { 'authValue' => { 'token' => 'secret', 'client' => 'example' } }
+
+    result = ApricotEatsGorilla.xml_to_hash(xml, '//return')
+    assert_equal expected, result
+  end
+
+  def test_xml_to_hash_make_sure_boolean_values_get_converted_to_boolean_objects
+    xml = '<root><yes>true</yes><no>false</no><txt>something</txt></root>'
+    expected = { 'yes' => true, 'no' => false, 'txt' => 'something' }
+
+    result = ApricotEatsGorilla.xml_to_hash(xml)
+    assert_equal expected, result
+  end
+
+  def test_xml_to_hash_make_sure_empty_element_tags_get_converted_to_nil
+    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
+
+  def test_xml_to_hash_make_sure_node_attributes_get_removed
+    xml = '<todo><paint subject="chair" color="#000000">black</paint></todo>'
+    expected = { 'paint' => 'black' }
+
+    result = ApricotEatsGorilla.xml_to_hash(xml)
+    assert_equal expected, result
+  end
+
+  def test_xml_to_hash_make_sure_node_groups_with_text_values_get_converted_to_arrays
+    xml = '<root><items>first</items><items>second</items></root>'
+    expected = { 'items' => [ 'first', 'second' ] }
+
+    result = ApricotEatsGorilla.xml_to_hash(xml)
+    assert_equal expected, result
+  end
+
+  def test_xml_to_hash_make_sure_node_groups_with_nesting_get_converted_to_arrays_with_hashes
+    xml = '<root><items><name>first</name></items><items><name>second</name></items></root>'
+    expected = { 'items' => [ { 'name' => 'first' }, { 'name' => 'second' } ] }
+
+    result = ApricotEatsGorilla.xml_to_hash(xml)
+    assert_equal expected, result
+  end
+
+  # hash_to_xml
+  def test_hash_to_xml_with_simple_hash
+    hash = { "dude" => "likes beer" }
+    expected = "<dude>likes beer</dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_hash_to_xml_with_nested_hash
+    hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
+    expected = "<dude><hates>appletini</hates><likes>beer</likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_hash_to_xml_with_nested_hash_and_array
+    hash = { "dude" => { "likes" => [ "beer", "helicopters" ] } }
+    expected = "<dude><likes>beer</likes><likes>helicopters</likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_hash_to_xml_with_nested_hash_and_array_containing_a_hash
+    hash = { "dude" => { "likes" => [ { "beer" => "a lot" }, { "helicopters" => "a little more" } ] } }
+    expected = "<dude><likes><beer>a lot</beer></likes><likes><helicopters>a little more</helicopters></likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  # soap_envelope
+  def test_soap_envelope_without_namespace_and_block_returns_pure_envelope
+    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
+
+  def test_soap_envelope_with_namespace_and_block_returns_envelope_with_namespace_and_content
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.6.164
     version: 
-description: Apricot eats Gorilla translates between XML documents and Hashes.
+description: Apricot eats Gorilla is a helper for working with XML and SOAP messages.
 email: 
 executables: []
 
@@ -59,8 +59,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Apricot eats Gorilla translates between XML documents and Hashes.
+summary: Apricot eats Gorilla is a helper for working with XML and SOAP messages.
 test_files: 
-- tests/apricot_eats_gorilla_testsuite.rb
-- tests/hash_to_xml_test.rb
-- tests/xml_to_hash_test.rb
+- tests/apricoteatsgorilla_test.rb

data/tests/apricot_eats_gorilla_testsuite.rb

@@ -1,3 +0,0 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), "hash_to_xml_test")
-require File.join(File.dirname(__FILE__), "xml_to_hash_test")

data/tests/hash_to_xml_test.rb

@@ -1,43 +0,0 @@
-# -*- coding: utf-8 -*-
-require 'test/unit'
-require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
-
-class HashToXmlTest < Test::Unit::TestCase
-
-  def setup
-    ApricotEatsGorilla.sort_keys = true
-  end
-
-  def test_dead_simple
-    hash = { "dude" => "likes beer" }
-    expected = "<dude>likes beer</dude>"
-
-    result = ApricotEatsGorilla.hash_to_xml(hash)
-    assert_equal expected, result
-  end
-
-  def test_nested_hash
-    hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
-    expected = "<dude><hates>appletini</hates><likes>beer</likes></dude>"
-
-    result = ApricotEatsGorilla.hash_to_xml(hash)
-    assert_equal expected, result
-  end
-
-  def test_nested_hash_with_array
-    hash = { "dude" => { "likes" => [ "beer", "helicopters" ] } }
-    expected = "<dude><likes>beer</likes><likes>helicopters</likes></dude>"
-
-    result = ApricotEatsGorilla.hash_to_xml(hash)
-    assert_equal expected, result
-  end
-
-  def test_nested_hash_with_array_containing_a_hash
-    hash = { "dude" => { "likes" => [ { "beer" => "a lot" }, { "helicopters" => "a little more" } ] } }
-    expected = "<dude><likes><beer>a lot</beer></likes><likes><helicopters>a little more</helicopters></likes></dude>"
-
-    result = ApricotEatsGorilla.hash_to_xml(hash)
-    assert_equal expected, result
-  end
-
-end

data/tests/xml_to_hash_test.rb

@@ -1,66 +0,0 @@
-# -*- coding: utf-8 -*-
-require 'test/unit'
-require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
-
-class XmlToHashTest < Test::Unit::TestCase
-
-  def test_soap_response_example
-    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 = { 'authValue' => { 'token' => 'secret', 'client' => 'example' } }
-
-    result = ApricotEatsGorilla.xml_to_hash(xml, '//return')
-    assert_equal expected, result
-  end
-
-  def test_that_boolean_string_values_are_converted_to_actual_boolean_objects
-    xml = '<root><yes>true</yes><no>false</no><txt>something</txt></root>'
-    expected = { 'yes' => true, 'no' => false, 'txt' => 'something' }
-
-    result = ApricotEatsGorilla.xml_to_hash(xml)
-    assert_equal expected, result
-  end
-
-  def test_that_empty_element_tags_are_converted_to_nil
-    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
-
-  def test_that_attributes_get_removed
-    xml = '<todo><paint subject="chair" color="#000000">black</paint></todo>'
-    expected = { 'paint' => 'black' }
-
-    result = ApricotEatsGorilla.xml_to_hash(xml)
-    assert_equal expected, result
-  end
-
-  def test_that_node_groups_with_text_values_get_converted_to_arrays
-    xml = '<root><items>first</items><items>second</items></root>'
-    expected = { 'items' => [ 'first', 'second' ] }
-
-    result = ApricotEatsGorilla.xml_to_hash(xml)
-    assert_equal expected, result
-  end
-
-  def test_that_node_groups_with_nesting_get_converted_to_arrays_with_hashes
-    xml = '<root><items><name>first</name></items><items><name>second</name></items></root>'
-    expected = { 'items' => [ { 'name' => 'first' }, { 'name' => 'second' } ] }
-
-    result = ApricotEatsGorilla.xml_to_hash(xml)
-    assert_equal expected, result
-  end
-
-end