smacks-apricoteatsgorilla 0.1.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:minor: 1
+:patch: 0
+:major: 0

data/lib/apricoteatsgorilla.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+require 'hpricot'
+
+# ApricotEatsGorilla converts SOAP response messages to Ruby hashes.
+# It's based on CobraVsMongoose but uses Hpricot instead of REXML and it
+# also doesn't follow the BadgerFish convention.
+class ApricotEatsGorilla
+
+  # Converts a given SOAP response message into a Ruby Hash.
+  def self.soap_response_to_hash(xml, root_node = nil)
+    xml = prepare_xml(xml)
+    root_node ||= "//return"
+    doc = Hpricot.XML(xml)
+    xml_node_to_hash doc.at(root_node)
+  end
+
+private
+
+  # Converts XML nodes into a Ruby Hash. Recursively calls itself to grab
+  # nested XML nodes and values.
+  def self.xml_node_to_hash(node)
+    this_node = {}
+
+    node.each_child do |child|
+      if child.children.nil?
+        key, value = child.name, nil
+      elsif child.children.size == 1 && child.children.first.text?
+        key, value = child.name, string_to_bool?(child.children.first.raw_string)
+      else
+        key, value = child.name, xml_node_to_hash(child)
+      end
+
+      current = this_node[key]
+      case current
+        when Array:
+          this_node[key] << value
+        when nil
+          this_node[key] = value
+        else
+          this_node[key] = [current.dup, value]
+      end
+    end
+
+    this_node
+  end
+
+  # Helper to remove line breaks and whitespace between XML nodes.
+  def self.prepare_xml(xml)
+    xml = xml.gsub(/\n+/, "")
+    xml = xml.gsub(/(>)\s*(<)/, '\1\2')
+  end
+
+  # Helper to convert "true" and "false" strings to boolean values.
+  # Returns the original string in case it doesn't match "true" or "false".
+  def self.string_to_bool?(string)
+    return true if string == "true"
+    return false if string == "false"
+    string
+  end
+
+end

data/tests/apricoteatsgorilla_test.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
+
+class ApricotEatsGorillaTest < 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.soap_response_to_hash(xml)
+    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.soap_response_to_hash(xml, '//root')
+    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.soap_response_to_hash(xml, '//contact')
+    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.soap_response_to_hash(xml, '//todo')
+    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.soap_response_to_hash(xml, '//root')
+    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.soap_response_to_hash(xml, '//root')
+    assert_equal expected, result
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: smacks-apricoteatsgorilla
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.164
+    version: 
+description: Apricot eats Gorilla converts SOAP response messages to Ruby hashes
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- VERSION.yml
+- lib/apricoteatsgorilla.rb
+has_rdoc: true
+homepage: http://github.com/smacks/apricoteatsgorilla
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Apricot eats Gorilla converts SOAP response messages to Ruby hashes
+test_files: 
+- tests/apricoteatsgorilla_test.rb