apricoteatsgorilla 0.5.9 → 0.5.10

data/README.rdoc

@@ -6,7 +6,11 @@ for working with SOAP services.
 
 == Install
 
-  $ gem install rubiii-apricoteatsgorilla -s http://gems.github.com
+  The gem for Apricot eats Gorilla is in the {gemcutter}[http://gemcutter.org] repository.
+  Please follow the steps on their website to set up your rubygems installation.
+  Afterwards you can install the gem like this:
+
+  $ gem install apricoteatsgorilla
 
 == Dependencies
 

data/VERSION

@@ -1 +1 @@
-0.5.9
+0.5.10

data/apricoteatsgorilla.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apricoteatsgorilla}
-  s.version = "0.5.9"
+  s.version = "0.5.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harrington"]
-  s.date = %q{2009-10-06}
+  s.date = %q{2009-10-08}
   s.description = %q{SOAP communication helper}
   s.email = %q{me@rubiii.com}
   s.extra_rdoc_files = [
@@ -31,16 +31,16 @@ Gem::Specification.new do |s|
      "spec/apricoteatsgorilla/xml_to_hash_spec.rb",
      "spec/spec_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/rubiii/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.rubygems_version = %q{1.3.5}
   s.summary = %q{SOAP communication helper}
   s.test_files = [
     "spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb",
      "spec/apricoteatsgorilla/hash_to_xml_spec.rb",
      "spec/apricoteatsgorilla/soap_envelope_spec.rb",
+     "spec/apricoteatsgorilla/wsse_spec.rb",
      "spec/apricoteatsgorilla/xml_node_spec.rb",
      "spec/apricoteatsgorilla/xml_to_hash_spec.rb",
      "spec/spec_helper.rb"
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hpricot>, ["= 0.8.241"])

data/lib/apricoteatsgorilla/apricoteatsgorilla.rb

@@ -1,4 +1,4 @@
-%w(digest/sha1 rubygems hpricot).each do |gem|
+%w(rubygems hpricot).each do |gem|
   require gem
 end
 
@@ -8,25 +8,20 @@ end
 # SOAP messages (XML) and Ruby Hashes and comes with some additional helpers
 # for working with SOAP services.
 class ApricotEatsGorilla
-  class << self
-
-    # SOAP dateTime format.
-    SOAPDateTimeFormat = "%Y-%m-%dT%H:%M:%S"
 
-    # SOAP dateTime Regexp.
-    SOAPDateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
+  # SOAP dateTime format.
+  SOAPDateTimeFormat = "%Y-%m-%dT%H:%M:%S"
 
-    # SOAP namespaces by SOAP version.
-    SOAPNamespace = {
-      1 => "http://schemas.xmlsoap.org/soap/envelope/",
-      2 => "http://www.w3.org/2003/05/soap-envelope"
-    }
+  # SOAP dateTime Regexp.
+  SOAPDateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
 
-    # Namespace for WS Security Secext
-    WSENamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+  # SOAP namespaces by SOAP version.
+  SOAPNamespace = {
+    1 => "http://schemas.xmlsoap.org/soap/envelope/",
+    2 => "http://www.w3.org/2003/05/soap-envelope"
+  }
 
-    # Namespace for WS Security Utility
-    WSUNamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+  class << self
 
     # Flag to enable sorting of Hash keys.
     attr_accessor :sort_keys
@@ -124,8 +119,11 @@ class ApricotEatsGorilla
     end
 
     # Builds a SOAP request envelope and includes the content of a given
-    # +block+ into the envelope body. Accepts a Hash of additional +namespaces+
-    # to set. Also accepts an optional +version+ to specify the SOAP envelope
+    # +block+ into the envelope body.
+    #
+    # Takes an optional Hash of additional +namespaces+ to set on the SOAP envelope.
+    # Takes an optional Hash of +wsse+ details for WSSE authentication.
+    # Furthermore accepts an optional +version+ to specify the SOAP envelope
     # namespace to use by SOAP version.
     #
     # ==== Examples
@@ -135,22 +133,66 @@ class ApricotEatsGorilla
     #   end
     #
     #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    #   # =>    <env:Header />
     #   # =>    <env:Body>
     #   # =>      <apricot><eats>Gorilla</eats></apricot>
     #   # =>    </env:Body>
     #   # =>  </env:Envelope>'
     #
-    #   ApricotEatsGorilla.soap_envelope(:wsdl => "http://example.com") { "pureText" }
+    # Customize namespaces:
+    #
+    #   soap_env = { "xmlns:wsdl" => "http://example.com" }
+    #   ApricotEatsGorilla.soap_envelope(soap_env)
     #
     #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://example.com">
-    #   # =>    <env:Body>
-    #   # =>      pureText
-    #   # =>    </env:Body>
+    #   # =>    <env:Header />
+    #   # =>    <env:Body />
     #   # =>  </env:Envelope>'
-    def soap_envelope(namespaces = {}, wsse = {}, version = 1)
-      namespaces[:env] ||= SOAPNamespace[version] if SOAPNamespace[version]
+    #
+    # WSSE authentication (PasswordText):
+    # 
+    #   wsse_args = { :username => 'dude', :password => 'secret' }
+    #   ApricotEatsGorilla.soap_envelope(nil, wsse_args)
+    #
+    #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    #   # =>    <env:Header>
+    #   # =>      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+    #   # =>        <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    #   # =>          <wsse:Username>dude</wsse:Username>
+    #   # =>          <wsse:Password>secret</wsse:Password>
+    #   # =>          <wsse:Nonce>c5e4eab16eed977a71fa6797999319e0749b3a70</wsse:Nonce>
+    #   # =>          <wsu:Created>2009-10-06T14:48:13</wsu:Created>
+    #   # =>        </wsse:UsernameToken>
+    #   # =>      </wsse:Security>
+    #   # =>    </env:Header>
+    #   # =>    <env:Body />
+    #   # =>  </env:Envelope>'
+    #
+    # WSSE authentication (PasswordDigest):
+    # 
+    #   wsse_args = { :username => 'dude', :password => 'secret', :digest => true }
+    #   ApricotEatsGorilla.soap_envelope(nil, wsse_args)
+    #
+    #   # => '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    #   # =>    <env:Header>
+    #   # =>      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+    #   # =>        <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    #   # =>          <wsse:Username>dude</wsse:Username>
+    #   # =>          <wsse:Password Type="wsse:PasswordDigest">MTJjYzcyNjY1MDM5MzJmYjZlYzRmMGZhZDY2YTI0MjFiMzYwYzE0ZQ==</wsse:Password>
+    #   # =>          <wsse:Nonce>fea0cf847cf2d1f9e402975b359e7268cc3a65d4</wsse:Nonce>
+    #   # =>          <wsu:Created>2009-10-06T19:24:30</wsu:Created>
+    #   # =>        </wsse:UsernameToken>
+    #   # =>      </wsse:Security>
+    #   # =>    </env:Header>
+    #   # =>    <env:Body />
+    #   # =>  </env:Envelope>'
+    def soap_envelope(namespaces = nil, wsse = nil, version = 1)
+      namespaces = {} unless namespaces.kind_of? Hash
+      if namespaces["xmlns:env"].nil? && SOAPNamespace[version]
+        namespaces["xmlns:env"] = SOAPNamespace[version]
+      end
 
-      header = xml_node("env:Header") { soap_header(wsse) }
+      header = xml_node("env:Header") { wsse_soap_header(wsse) }
       body = xml_node("env:Body") { (yield if block_given?) || nil }
 
       xml_node("env:Envelope", namespaces) { header + body }
@@ -158,31 +200,17 @@ class ApricotEatsGorilla
 
   private
 
-    def soap_header(wsse)
-      return nil if !wsse || wsse.empty?
-
-      now = Time.now
-      xml_node("wsse:Security", :wsse => WSENamespace) do
-        xml_node("wsse:UsernameToken", :wsu => WSUNamespace) do
-          xml_node("wsse:Username") { wsse[:username] } <<
-          xml_node("wsse:Password") { wsse[:password] } <<
-          xml_node("wsse:Nonce") { wsse_nonce(now) } <<
-          xml_node("wsu:Created") { now.strftime(SOAPDateTimeFormat) }
-        end
+    # Returns the SOAP header for WSSE authentication. Expects a Hash with +wsse+
+    # details including :username, :password and an optional boolean value for
+    # :digest, indicating if passwordDigest should be used.
+    def wsse_soap_header(wsse)
+      if wsse
+        WSSE.soap_header(wsse[:username], wsse[:password], wsse[:digest])
+      else
+        nil
       end
     end
 
-    # Returns a random WSSE nonce.
-    def wsse_nonce(now = nil)
-      now ||= Time.now
-      Digest::SHA1.hexdigest(random_string + now.to_i.to_s)
-    end
-
-    # Returns a random string of a certain +length+.
-    def random_string(length = 20)
-      (0...length).map { ("a".."z").to_a[rand(26)] }.join
-    end
-
     # Translates a single XML root node to a Ruby Hash.
     def single_xml_root_node_to_hash(root)
       if root.first.children.nil?
@@ -215,12 +243,9 @@ class ApricotEatsGorilla
         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 ]
+          when Array then hash[key] << value
+          when nil   then hash[key] = value
+          else            hash[key] = [ hash[key].dup, value ]
         end
       end
 
@@ -273,12 +298,13 @@ class ApricotEatsGorilla
     # 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)
+    def xml_node(name, attributes = nil)
+      node = XMLNode.new(name.to_s, nodes_to_namespace)
       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
 
@@ -290,14 +316,10 @@ class ApricotEatsGorilla
     # Converts XML values to more natural Ruby objects.
     def map_xml_value(value)
       case value
-        when SOAPDateTimeRegexp
-          DateTime.parse(value)
-        when "true"
-          true
-        when "false"
-          false
-        else
-          value
+        when SOAPDateTimeRegexp then DateTime.parse(value)
+        when "true"             then true
+        when "false"            then false
+        else                         value
       end
     end
 
@@ -316,7 +338,7 @@ class ApricotEatsGorilla
 
     # Returns a sorted version of a given +hash+ if +sort_keys+ is enabled.
     def sort_hash_keys(hash)
-      return hash unless sort_keys
+      return hash unless hash && sort_keys
       hash.keys.sort_by { |key| key.to_s }.map { |key| [ key, hash[key] ] }
     end
 

data/lib/apricoteatsgorilla/xml_node.rb

@@ -10,6 +10,12 @@ class XMLNode < String
   # Node body content.
   attr_writer :body
 
+  # Initializer + expects the node +name+ and an optional Hash of +namespaces+.
+  def initialize(name, namespaces = {})
+    super(name)
+    set_namespace(namespaces)
+  end
+
   # Strips the namespace from this node.
   def strip_namespace!
     sub!(/.+:(.+)/, '\1')
@@ -27,14 +33,6 @@ class XMLNode < String
     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)
-    if namespaces && !namespaces.empty?
-      namespaces.each { |ns, nodes| @namespace = ns if self_included? nodes }
-    end
-  end
-
   # Returns this node as an XML tag including a namespace, attributes
   # and a body in case these values were supplied.
   def to_tag
@@ -47,6 +45,14 @@ class XMLNode < String
 
 private
 
+  # 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 set_namespace(namespaces)
+    if namespaces && !namespaces.empty?
+      namespaces.each { |ns, nodes| @namespace = ns if self_included? nodes }
+    end
+  end
+
   # Returns +true+ if self as a String or a Symbol is included in a
   # given +array+. Returns +false+ otherwise.
   def self_included?(array)
@@ -63,7 +69,7 @@ private
   # in case no attributes were defined.
   def attributes
     if @attributes
-      @attributes.map { |key, value| %Q( xmlns:#{key}="#{value}") }
+      @attributes.map { |key, value| " #{key}=\"#{value}\"" }
     else
       ""
     end

data/lib/apricoteatsgorilla.rb

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

data/spec/apricoteatsgorilla/soap_envelope_spec.rb

@@ -12,7 +12,7 @@ describe ApricotEatsGorilla do
     end
 
     it "returns a SOAP envelope with a custom namespace and body content" do
-      ApricotEatsGorilla.soap_envelope(:wsdl => "http://example.com") do
+      ApricotEatsGorilla.soap_envelope("xmlns:wsdl" => "http://example.com") do
         "<id>123</id>"
       end.should == '<env:Envelope' <<
         ' xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"' <<
@@ -22,23 +22,39 @@ describe ApricotEatsGorilla do
     end
 
     it "does not change an already defined SOAP envelope namespace" do
-      ApricotEatsGorilla.soap_envelope(:env => "http://example.com").should ==
+      ApricotEatsGorilla.soap_envelope("xmlns:env" => "http://example.com").should ==
         '<env:Envelope xmlns:env="http://example.com">' <<
         '<env:Header />' <<
         '<env:Body /></env:Envelope>'
     end
 
     it "sets the SOAP envelope namespace for SOAP version 1.2 if requested" do
-      ApricotEatsGorilla.soap_envelope({}, {}, 2).should ==
+      ApricotEatsGorilla.soap_envelope(nil, nil, 2).should ==
         '<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">' <<
         '<env:Header />' <<
         '<env:Body /></env:Envelope>'
     end
 
     it "does not set a SOAP envelope namespace in case of an invalid SOAP version" do
-      ApricotEatsGorilla.soap_envelope({}, {}, 123).should ==
+      ApricotEatsGorilla.soap_envelope(nil, nil, 123).should ==
         '<env:Envelope><env:Header /><env:Body /></env:Envelope>'
     end
+
+    it "adds WSSE authentication details to the SOAP header" do
+      wsse = { :username => "apricot", :password => "gorilla" }
+      result = ApricotEatsGorilla.soap_envelope(nil, wsse)
+
+      ApricotEatsGorilla[result, "//env:Header//wsse:Username"].should == wsse[:username]
+      ApricotEatsGorilla[result, "//env:Header//wsse:Password"].should == wsse[:password]
+    end
+
+    it "adds WSSE authentication details for passwordDigest to the SOAP header" do
+      wsse = { :username => "apricot", :password => "gorilla", :digest => true }
+      result = ApricotEatsGorilla.soap_envelope(nil, wsse)
+
+      ApricotEatsGorilla[result, "//env:Header//wsse:Username"].should == wsse[:username]
+      ApricotEatsGorilla[result, "//env:Header//wsse:Password"].should_not == wsse[:password]
+    end
   end
 
 end

data/spec/apricoteatsgorilla/wsse_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe WSSE do
+
+  # soap_header
+  describe "soap_header" do
+    before do
+      @username = "apricot"
+      @password = "gorilla"
+    end
+
+    it "returns a SOAP header for WSSE authentication" do
+      xml_header = WSSE.soap_header(@username, @password)
+      hash_header = ApricotEatsGorilla[xml_header, "wsse:Security//wsse:UsernameToken"]
+
+      hash_header[:username].should == @username
+      hash_header[:password].should == @password
+      hash_header[:nonce].should be_a(String)
+      hash_header[:created].should be_a(DateTime)
+    end
+
+    it "returns a SOAP header for WSSE authentication with :digest set to +true+" do
+      xml_header = WSSE.soap_header(@username, @password, true)
+      hash_header = ApricotEatsGorilla[xml_header, "wsse:Security//wsse:UsernameToken"]
+
+      hash_header[:username].should == @username
+      hash_header[:password].should_not == @password
+      hash_header[:nonce].should be_a(String)
+      hash_header[:created].should be_a(DateTime)
+    end
+  end
+
+  # password_node
+  describe "password_node" do
+    before do
+      @password = "gorilla"
+      @created_at = Time.now.strftime(ApricotEatsGorilla::SOAPDateTimeFormat)
+    end
+
+    it "returns a WSSE password node containing the password as plain-text" do
+      WSSE.password_node(@password, @created_at).should == 
+        "<wsse:Password>" << @password << "</wsse:Password>"
+    end
+
+    it "returns a WSSE password node containing a password digest when :digest was set to +true+" do
+      WSSE.password_node(@password, @created_at, true).match(@password).should be_nil
+    end
+  end
+
+end

data/spec/apricoteatsgorilla/xml_node_spec.rb

@@ -2,6 +2,30 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper")
 
 describe XMLNode do
 
+  # initialize
+  describe "initialize" do
+    it "does not require any namespaces" do
+      node = XMLNode.new("apricot")
+
+      node.should == "apricot"
+      node.to_tag.should == "<apricot />"
+    end
+
+    it "namespaces the node if it's included in the given Hash of namespaces" do
+      node = XMLNode.new("apricot", :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 of namespaces" do
+      node = XMLNode.new("apricot", :wsdl => [ :some_key ])
+
+      node.should == "apricot"
+      node.to_tag.should == "<apricot />"
+    end
+  end
+
   # strip_namespace!
   describe "strip_namespace!" do
     it "strips the namespace from the node" do
@@ -29,25 +53,6 @@ describe XMLNode do
     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
@@ -56,15 +61,13 @@ describe XMLNode do
     end
 
     it "returns a namespaced empty-element tag for a namespaced node" do
-      node = XMLNode.new("apricot")
-      node.namespace_from_hash!(:wsdl => [ :apricot ])
-
+      node = XMLNode.new("apricot", :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.attributes = { "xmlns:wsdl" => "http://example.com" }
 
       node.to_tag.should == '<apricot xmlns:wsdl="http://example.com" />'
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +02:00
+date: 2009-10-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,12 +87,13 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: SOAP communication helper
 test_files: 
 - spec/apricoteatsgorilla/apricoteatsgorilla_spec.rb
 - spec/apricoteatsgorilla/hash_to_xml_spec.rb
 - spec/apricoteatsgorilla/soap_envelope_spec.rb
+- spec/apricoteatsgorilla/wsse_spec.rb
 - spec/apricoteatsgorilla/xml_node_spec.rb
 - spec/apricoteatsgorilla/xml_to_hash_spec.rb
 - spec/spec_helper.rb