smacks-apricoteatsgorilla 0.5.0 → 0.5.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+nbproject
+.autotest

data/README.rdoc

@@ -11,7 +11,8 @@ for working with SOAP services.
 == Dependencies
 
   hpricot 0.8.241 (the latest JRuby-compatible version)
-  Also available from the Github download page of Apricot eats Gorilla.
+
+Also available at: {GitHub Downloads}[http://github.com/smacks/apricoteatsgorilla/downloads]
 
 == Translate an XML String into a Ruby Hash
 

data/Rakefile

@@ -17,3 +17,27 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
   rdoc.options = ["--line-numbers", "--inline-source"]
 end
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |spec|
+    spec.name = "apricoteatsgorilla"
+    spec.author = "Daniel Harrington"
+    spec.email = "me@d-harrington.com"
+    spec.homepage = "http://github.com/smacks/apricoteatsgorilla"
+    spec.summary = "SOAP communication helper."
+    spec.description = spec.summary
+
+    spec.rdoc_options += [
+      "--title", "Apricot eats Gorilla",
+      "--main", "README.rdoc",
+      "--line-numbers",
+      "--inline-source"
+    ]
+
+    spec.add_runtime_dependency("hpricot", "0.8.241")
+    spec.add_development_dependency("rspec", ">= 1.2.8")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/apricoteatsgorilla.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apricoteatsgorilla}
+  s.version = "0.5.1"
+
+  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.description = %q{SOAP communication helper.}
+  s.email = %q{me@d-harrington.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "apricoteatsgorilla.gemspec",
+     "lib/apricoteatsgorilla.rb",
+     "lib/apricoteatsgorilla/apricoteatsgorilla.rb",
+     "lib/apricoteatsgorilla/xml_node.rb",
+     "spec/apricoteatsgorilla/apricoteatsgorilla_hash_to_xml_spec.rb",
+     "spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb",
+     "spec/apricoteatsgorilla/apricoteatsgorilla_xml_to_hash_spec.rb",
+     "spec/apricoteatsgorilla/xml_node_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/smacks/apricoteatsgorilla}
+  s.rdoc_options = ["--charset=UTF-8", "--title", "Apricot eats Gorilla", "--main", "README.rdoc", "--line-numbers", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{SOAP communication helper.}
+  s.test_files = [
+    "spec/apricoteatsgorilla/apricoteatsgorilla_hash_to_xml_spec.rb",
+     "spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb",
+     "spec/apricoteatsgorilla/apricoteatsgorilla_xml_to_hash_spec.rb",
+     "spec/apricoteatsgorilla/xml_node_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, ["= 0.8.241"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
+    else
+      s.add_dependency(%q<hpricot>, ["= 0.8.241"])
+      s.add_dependency(%q<rspec>, [">= 1.2.8"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, ["= 0.8.241"])
+    s.add_dependency(%q<rspec>, [">= 1.2.8"])
+  end
+end

data/lib/apricoteatsgorilla.rb

@@ -0,0 +1,3 @@
+%w(apricoteatsgorilla xml_node).each do |file|
+  require File.join(File.dirname(__FILE__), "apricoteatsgorilla", file)
+end

data/lib/apricoteatsgorilla/apricoteatsgorilla.rb

@@ -0,0 +1,239 @@
+%w(rubygems hpricot).each do |gem|
+  require gem
+end
+
+# == ApricotEatsGorilla
+# 
+# Apricot eats Gorilla is a SOAP communication helper. It translates between
+# SOAP messages (XML) and Ruby Hashes and comes with some additional helpers
+# for working with SOAP services.
+class ApricotEatsGorilla
+  class << self
+
+    # Flag to enable sorting of Hash keys.
+    attr_accessor :sort_keys
+
+    # Flag to disable conversion of XML tags to lowerCamelCase.
+    attr_accessor :disable_tag_names_to_lower_camel_case
+
+    # Flag to disable conversion of Hash keys to snake_case.
+    attr_accessor :disable_hash_keys_to_snake_case
+
+    # 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.
+    attr_accessor :nodes_to_namespace
+
+    # Shortcut method for translating between XML Strings and Ruby Hashes.
+    # Delegates to +xml_to_hash+ in case +source+ is a String or delegates
+    # to +hash_to_xml+ in case +source+ is a Hash. Returns nil otherwise.
+    def [](source, root_node = nil)
+      case source
+        when String
+          xml_to_hash(source, root_node)
+        when Hash
+          hash_to_xml(source)
+        else
+          nil
+      end
+    end
+
+    # Yields this class in case a +block+ was given.
+    def setup
+      yield self if block_given?
+    end
+
+    # Translates a given +xml+ String into a Ruby Hash.
+    #
+    # Starts parsing at the XML root node by default. Accepts an optional
+    # +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.
+    #
+    # ==== 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>
+    #             <apricot>
+    #               <eats>Gorilla</eats>
+    #             </apricot>
+    #           </return>
+    #         </ns2:authenticateResponse>
+    #       </soap:Body>
+    #     </soap:Envelope>'
+    #
+    #   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?
+      if !root.respond_to? :each
+        xml_node_to_hash(root)
+      elsif root.size == 1
+        single_xml_root_node_to_hash(root)
+      else
+        multiple_xml_root_nodes_to_hash(root)
+      end
+    end
+
+    # Translates a given Ruby +hash+ into an XML String.
+    #
+    # ==== Example
+    #
+    #   hash = { :apricot => { :eats => "Gorilla" } }
+    #
+    #   ApricotEatsGorilla.hash_to_xml(hash)
+    #   # => "<apricot><eats>Gorilla</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.
+    #
+    # ==== Example
+    #
+    #   ApricotEatsGorilla.soap_envelope do
+    #     "<apricot><eats>Gorilla</eats></apricot>"
+    #   end
+    #
+    #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    #   # =>    <env:Body>
+    #   # =>      <apricot><eats>Gorilla</eats></apricot>
+    #   # =>    </env:Body>
+    #   # =>  </env:Envelope>'
+    def soap_envelope(namespaces = {})
+      namespaces[:env] = "http://schemas.xmlsoap.org/soap/envelope/"
+
+      xml_node("env:Envelope", namespaces) do
+        xml_node("env:Body") { yield if block_given? }
+      end
+    end
+
+  private
+
+    # Translates a single XML root node to a Ruby Hash.
+    def single_xml_root_node_to_hash(root)
+      if root.first.children.first.kind_of? Hpricot::Text
+        map_xml_value(root.first.children.to_s)
+      else
+        xml_node_to_hash(root.first)
+      end
+    end
+
+    # Translates multiple XML root nodes to a Ruby Hash.
+    def multiple_xml_root_nodes_to_hash(root)
+      root.map do |node|
+        if node.children.first.kind_of? Hpricot::Text
+          map_xml_value(node.children.to_s)
+        else
+          xml_node_to_hash(node)
+        end
+      end
+    end
+
+    # Iterates through a given Hpricot +element+ and returns a Ruby Hash
+    # equal to the XML content of the given element.
+    def xml_node_to_hash(element)
+      hash = {}
+
+      element.each_child do |child|
+        key = create_hash_key(child.name)
+        value = create_hash_value(child)
+
+        case hash[key]
+          when Array
+            hash[key] << value
+          when nil
+            hash[key] = value
+          else
+            hash[key] = [ hash[key].dup, value ]
+        end
+      end
+
+      hash
+    end
+
+    # Returns a Hash key for +xml_node_to_hash+ by a given +name+.
+    def create_hash_key(name)
+      key = XMLNode.new(name)
+      key.strip_namespace!
+      key.to_snake_case! unless disable_hash_keys_to_snake_case
+      key = disable_hash_keys_to_symbols ? key.to_s : key.to_sym
+    end
+
+    # Returns a Hash value for +xml_node_to_hash+ by a given +value+.
+    def create_hash_value(value)
+      if value.children.nil? || value.children.empty?
+        nil
+      elsif value.children.size == 1 && value.children.first.text?
+        map_xml_value(value.children.first.to_html)
+      else
+        xml_node_to_hash(value)
+      end
+    end
+
+    # Expects a Hash +key+ and a Hash +value+. Iterates through the given Hash
+    # +value+ and returns an XML String of the given Hash structure.
+    def nested_data_to_xml(key, value)
+      case value
+        when Array
+          value.map { |subitem| nested_data_to_xml(key, subitem) }.join
+        when Hash
+          xml_node(key) do
+            sort_hash_keys(value).map do |subkey, subvalue|
+              case subvalue
+              when Array
+                subvalue.map { |subitem| nested_data_to_xml(subkey, subitem) }.join
+              when Hash
+                nested_data_to_xml(subkey, subvalue)
+              else
+                xml_node(subkey) { subvalue.to_s } if subvalue.respond_to? :to_s
+              end
+            end.join
+          end
+        else
+          xml_node(key) { value.to_s } if value.respond_to? :to_s
+      end
+    end
+
+    # Returns an XML tag with a given +name+. Accepts a +block+ for tag content.
+    # Defaults to returning an empty-element tag in case no block was given.
+    # Also accepts a Hash of +attributes+ to be added to the XML tag.
+    def xml_node(name, attributes = {})
+      node = XMLNode.new(name.to_s)
+      node.to_lower_camel_case! unless disable_tag_names_to_lower_camel_case
+      node.namespace_from_hash!(nodes_to_namespace)
+      node.attributes = sort_hash_keys(attributes)
+      node.body = yield if block_given?
+      node.to_tag
+    end
+
+    # Removes whitespace between tags of a given +xml+ String.
+    def remove_whitespace(xml)
+      xml.gsub(/(>)\s*(<)/, '\1\2')
+    end
+
+    # Converts XML values to more natural Ruby objects.
+    def map_xml_value(value)
+      case value
+        when "true"  then true
+        when "false" then false
+        else              value
+      end
+    end
+
+    # Returns a sorted version of a given +hash+ if +sort_keys+ is enabled.
+    def sort_hash_keys(hash)
+      return hash unless sort_keys
+      hash.keys.sort_by { |key| key.to_s }.map { |key| [ key, hash[key] ] }
+    end
+
+  end
+end

data/lib/apricoteatsgorilla/xml_node.rb

@@ -0,0 +1,72 @@
+# == XMLNode
+#
+# Representation of an XML node. Inherits from String and includes some
+# useful methods for namespaces, attributes, body content etc.
+class XMLNode < String
+
+  # Hash of attributes.
+  attr_writer :attributes
+
+  # Body content.
+  attr_writer :body
+
+  # Strips the namespace from this node.
+  def strip_namespace!
+    sub!(/.+:(.+)/, '\1')
+  end
+
+  # Converts this node to snake_case.
+  def to_snake_case!
+    gsub!(/[A-Z]/, '_\0')
+    gsub!(/^_/, '')
+    downcase!
+  end
+
+  # Converts this node to lowerCamelCase.
+  def to_lower_camel_case!
+    gsub!(/_(.)/) { $1.upcase }
+  end
+
+  # Checks if this node is included in a given Hash of +namespaces+ and
+  # sets the namespace for this node in case it was found in the Hash.
+  def namespace_from_hash!(namespaces)
+    namespaces.each do |namespace, nodes|
+      @namespace = namespace if self_included? nodes
+    end unless namespaces.nil? || namespaces.empty?
+  end
+
+  # Returns this node as an XML tag including a namespace, attributes
+  # and a body in case these values were supplied.
+  def to_tag
+    return "<#{namespace}#{self}#{attributes} />" unless @body
+    "<#{namespace}#{self}#{attributes}>#{body}</#{namespace}#{self}>"
+  end
+
+private
+
+  # Returns +true+ if self as a String or a Symbol is included in a
+  # given +array+. Returns +false+ otherwise.
+  def self_included?(array)
+    array.include?(self.to_s) || array.include?(self.to_sym)
+  end
+
+  # Returns the namespace of this node. Defaults to an empty String
+  # in case no namespace was defined.
+  def namespace
+    @namespace ? "#{@namespace}:" : ""
+  end
+
+  # Returns the attributes of this node. Defaults to an empty String
+  # in case no attributes were defined.
+  def attributes
+    return "" if @attributes.nil?
+    @attributes.map { |key, value| %Q( xmlns:#{key}="#{value}") }
+  end
+
+  # Returns the body of this node. Defaults to an empty String in case
+  # no body was defined.
+  def body
+    @body ? @body : ""
+  end
+
+end

data/spec/apricoteatsgorilla/apricoteatsgorilla_hash_to_xml_spec.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe ApricotEatsGorilla do
+  include SpecHelper
+
+  # hash_to_xml
+  describe "hash_to_xml" do
+    before { reset_library_options }
+
+    it "converts Hash key Symbols into Strings" do
+      hash = { :apricot => { :eats => [ :gorilla, "snake" ] } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><eats>gorilla</eats><eats>snake</eats></apricot>"
+    end
+
+    it "converts lowerCamelCase Hash keys to snake_case" do
+      hash = { :apricot => { :eats => { :lots_of => "gorillas" } } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><eats><lotsOf>gorillas</lotsOf></eats></apricot>"
+    end
+
+    it "does not convert lowerCamelCase Hash keys to snake_case if this was disabled" do
+      ApricotEatsGorilla.disable_tag_names_to_lower_camel_case = true
+      hash = { :apricot => { :eats => { :lots_of => "gorillas" } } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><eats><lots_of>gorillas</lots_of></eats></apricot>"
+    end
+
+    it "converts values responding to to_s into Strings" do
+      date_time = DateTime.now
+      hash = { :apricot => {
+        :at => date_time,
+        :with => 100.01,
+        :when => nil,
+        :what => :gorillas
+      }}
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><at>#{date_time}</at><what>gorillas</what>" <<
+        "<when></when><with>100.01</with></apricot>"
+    end
+
+    it "applies namespaces nodes defined via nodes_to_namespace" do
+      ApricotEatsGorilla.nodes_to_namespace = { :wsdl => [ :apricot ] }
+      hash = { :apricot => { :eats => "Gorilla" } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<wsdl:apricot><eats>Gorilla</eats></wsdl:apricot>"
+    end
+
+    it "converts a Hash containing only one key and a value into one node with content" do
+      hash = { "apricot" => "eats Gorilla" }
+      ApricotEatsGorilla.hash_to_xml(hash).should == "<apricot>eats Gorilla</apricot>"
+    end
+
+    it "converts a nested Hash into nested nodes" do
+      hash = { "apricot" => { "eats" => "gorilla", "drinks" => "beer" } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><drinks>beer</drinks><eats>gorilla</eats></apricot>"
+    end
+
+    it "converts a Hash containing an Array into multiple nodes" do
+      hash = { "apricot" => { "eats" => [ "gorilla", "snake" ] } }
+      ApricotEatsGorilla.hash_to_xml(hash).should ==
+        "<apricot><eats>gorilla</eats><eats>snake</eats></apricot>"
+    end
+  end
+
+end

data/spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe ApricotEatsGorilla do
+  include SpecHelper
+
+  # setup
+  describe "setup" do
+    it "yields self to a given block" do
+      ApricotEatsGorilla.setup do |yielded|
+        yielded.should == ApricotEatsGorilla
+      end
+    end
+  end
+
+  # soap_envelope
+  describe "soap_envelope" do
+    before { ApricotEatsGorilla.sort_keys = true }
+
+    it "returns a SOAP envelope with an empty-element body tag" do
+      ApricotEatsGorilla.soap_envelope.should ==
+        '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">' <<
+        '<env:Body /></env:Envelope>'
+    end
+    
+    it "returns a SOAP envelope with a custom namespace and body content" do
+      result = ApricotEatsGorilla.soap_envelope(:wsdl => "http://example.com") do
+        "<id>123</id>"
+      end
+      result.should == '<env:Envelope' <<
+        ' xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"' <<
+        ' xmlns:wsdl="http://example.com">' <<
+        '<env:Body><id>123</id></env:Body></env:Envelope>'
+    end
+  end
+
+  # []
+  describe "[]" do
+    before { reset_library_options }
+
+    it "converts a given XML into a Hash" do
+      xml = "<root><name>Jungle Julia</name></root>"
+      ApricotEatsGorilla[xml].should == { :name => "Jungle Julia" }
+    end
+
+    it "converts a given XML with a custom root node into a Hash" do
+      xml = "<root><something><name>Jungle Julia</name></something></root>"
+      ApricotEatsGorilla[xml, "//something"].should == { :name => "Jungle Julia" }
+    end
+
+    it "converts a given Hash into XML" do
+      hash = { "apricot" => "eats gorilla" }
+      ApricotEatsGorilla[hash] == "<apricot>eats gorilla</apricot>"
+    end
+  end
+
+end

data/spec/apricoteatsgorilla/apricoteatsgorilla_xml_to_hash_spec.rb

@@ -0,0 +1,78 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe ApricotEatsGorilla do
+  include SpecHelper
+
+  # xml_to_hash
+  describe "xml_to_hash" do
+    before { reset_library_options }
+
+    it "converts Hash keys to Symbols" do
+      xml = "<root><name>Jungle Julia</name></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :name => "Jungle Julia" }
+    end
+
+    it "does not convert Hash keys to Symbols if this was disabled" do
+      ApricotEatsGorilla.disable_hash_keys_to_symbols = true
+      xml = "<root><name>Jungle Julia</name></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { "name" => "Jungle Julia" }
+    end
+
+    it "converts String values of 'true' and 'false' into TrueClass and FalseClass" do
+      xml = "<root><yes>true</yes><no>false</no></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :yes => true, :no => false }
+    end
+
+    it "converts empty-element tags to 'nil'" do
+      xml = "<contact><name>Jungle Julia</name><email /></contact>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :name => "Jungle Julia", :email => nil }
+    end
+
+    it "converts lowerCamelCase nodes to snake_case" do
+      xml = "<root><firstName>Jungle</firstName><lastName>Julia</lastName></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :first_name => "Jungle", :last_name => "Julia" }
+    end
+
+    it "does not convert lowerCamelCase nodes to snake_case if this was disabled" do
+      ApricotEatsGorilla.disable_hash_keys_to_snake_case = true
+      xml = "<root><firstName>Jungle</firstName><lastName>Julia</lastName></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :firstName => "Jungle", :lastName => "Julia" }
+    end
+
+    it "removes namespaces from nodes" do
+      xml = "<root><wsdl:apricot><eats>Gorilla</eats></wsdl:apricot></root>"
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :apricot => { :eats => "Gorilla" } }
+    end
+
+    it "removes attributes from nodes" do
+      xml = '<root><contact id="123">Jungle Julia</contact></root>'
+      ApricotEatsGorilla.xml_to_hash(xml).should == { :contact => "Jungle Julia" }
+    end
+
+    it "starts translating XML at a given custom root node" do
+      xml = '<root><contact><name>Jungle Julia</name></contact></root>'
+      ApricotEatsGorilla.xml_to_hash(xml, "//contact").should == { :name => "Jungle Julia" }
+    end
+
+    it "returns an Array of nodes and values in case of multiple root nodes" do
+      xml = '<root><return><id>1</id></return><return><id>2</id></return></root>'
+      ApricotEatsGorilla.xml_to_hash(xml, "//return").should == [{ :id => "1" }, { :id => "2" }]
+    end
+
+    it "returns the value of a node if it does not contain any subnodes" do
+      xml = '<root><return>123</return></root>'
+      ApricotEatsGorilla.xml_to_hash(xml, "//return").should == "123"
+    end
+
+    it "returns an Array of values in case of multiple root nodes without subnodes" do
+     xml = '<root><return>123</return><return>456</return></root>'
+     ApricotEatsGorilla.xml_to_hash(xml, "//return").should == ["123", "456"]
+    end
+
+    it "returns a Hash containing an Array of content for multiple subnodes" do
+      xml = '<root><return><items>first</items><items>second</items></return></root>'
+      ApricotEatsGorilla.xml_to_hash(xml, "//return").should == { :items => ["first", "second"] }
+    end
+  end
+
+end

data/spec/apricoteatsgorilla/xml_node_spec.rb

@@ -0,0 +1,80 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe XMLNode do
+
+  # strip_namespace!
+  describe "strip_namespace!" do
+    it "strips the namespace from the node" do
+      node = XMLNode.new("wsdl:apricot")
+      node.strip_namespace!
+
+      node.should == "apricot"
+    end
+  end
+
+  # to_snake_case!
+  describe "to_snake_case!" do
+    it "converts the node from CamelCase to snake_case" do
+      node = XMLNode.new("ApricotEatsGorilla")
+      node.to_snake_case!
+
+      node.should == "apricot_eats_gorilla"
+    end
+    
+    it "converts the node from lowerCamelCase to snake_case" do
+      node = XMLNode.new("apricotEatsGorilla")
+      node.to_snake_case!
+
+      node.should == "apricot_eats_gorilla"
+    end
+  end
+
+  # namespace_from_hash!
+  describe "namespace_from_hash!" do
+    it "namespaces the node if it's included in the given Hash" do
+      node = XMLNode.new("apricot")
+      node.namespace_from_hash!(:wsdl => [ :apricot ])
+
+      node.should == "apricot"
+      node.to_tag.should == "<wsdl:apricot />"
+    end
+
+    it "does nothing if the node is not included in the given Hash" do
+      node = XMLNode.new("apricot")
+      node.namespace_from_hash!(:wsdl => [ :some_key ])
+
+      node.should == "apricot"
+      node.to_tag.should == "<apricot />"
+    end
+  end
+
+  # to_tag
+  describe "to_tag" do
+    it "returns an empty-element tag for a bare node" do
+      node = XMLNode.new("apricot")
+      node.to_tag.should == "<apricot />"
+    end
+
+    it "returns a namespaced empty-element tag for a namespaced node" do
+      node = XMLNode.new("apricot")
+      node.namespace_from_hash!(:wsdl => [ :apricot ])
+
+      node.to_tag.should == "<wsdl:apricot />"
+    end
+
+    it "returns an empty-element tag with an attribute for an attributed node" do
+      node = XMLNode.new("apricot")
+      node.attributes = { :wsdl => "http://example.com" }
+
+      node.to_tag.should == '<apricot xmlns:wsdl="http://example.com" />'
+    end
+
+    it "returns a node with body content for a node with content" do
+      node = XMLNode.new("apricot")
+      node.body = "eats gorilla"
+
+      node.to_tag.should == "<apricot>eats gorilla</apricot>"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "rubygems"
+gem "rspec", ">= 1.2.8"
+require "spec"
+require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+module SpecHelper
+  def reset_library_options
+    ApricotEatsGorilla.setup do |setup|
+      setup.sort_keys = true
+      setup.disable_tag_names_to_lower_camel_case = false
+      setup.disable_hash_keys_to_snake_case = false
+      setup.disable_hash_keys_to_symbols = false
+      setup.nodes_to_namespace = nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-16 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,25 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
 - README.rdoc
 - Rakefile
+- VERSION
+- apricoteatsgorilla.gemspec
+- lib/apricoteatsgorilla.rb
+- lib/apricoteatsgorilla/apricoteatsgorilla.rb
+- lib/apricoteatsgorilla/xml_node.rb
+- spec/apricoteatsgorilla/apricoteatsgorilla_hash_to_xml_spec.rb
+- spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb
+- spec/apricoteatsgorilla/apricoteatsgorilla_xml_to_hash_spec.rb
+- spec/apricoteatsgorilla/xml_node_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/smacks/apricoteatsgorilla
+licenses: 
 post_install_message: 
 rdoc_options: 
+- --charset=UTF-8
 - --title
 - Apricot eats Gorilla
 - --main
@@ -70,9 +83,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: Translates between SOAP messages (XML) and Ruby Hashes.
-test_files: []
-
+summary: SOAP communication helper.
+test_files: 
+- spec/apricoteatsgorilla/apricoteatsgorilla_hash_to_xml_spec.rb
+- spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb
+- spec/apricoteatsgorilla/apricoteatsgorilla_xml_to_hash_spec.rb
+- spec/apricoteatsgorilla/xml_node_spec.rb
+- spec/spec_helper.rb