regenersis-savon 1.0.0

data/lib/savon/soap/xml.rb

@@ -0,0 +1,227 @@
+require "builder"
+require "gyoku"
+require "nori"
+
+require "savon/soap"
+
+Nori.configure do |config|
+  config.strip_namespaces = true
+  config.convert_tags_to { |tag| tag.snakecase.to_sym }
+end
+
+module Savon
+  module SOAP
+
+    # = Savon::SOAP::XML
+    #
+    # Represents the SOAP request XML. Contains various global and per request/instance settings
+    # like the SOAP version, header, body and namespaces.
+    class XML
+
+      # XML Schema Type namespaces.
+      SchemaTypes = {
+        "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+        "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance"
+      }
+
+      # Accepts an +endpoint+, an +input+ tag and a SOAP +body+.
+      def initialize(endpoint = nil, input = nil, body = nil)
+        self.endpoint = endpoint if endpoint
+        self.input = input if input
+        self.body = body if body
+      end
+
+      # Accessor for the SOAP +input+ tag.
+      attr_accessor :input
+
+      # Accessor for the SOAP +endpoint+.
+      attr_accessor :endpoint
+
+      # Sets the SOAP +version+.
+      def version=(version)
+        raise ArgumentError, "Invalid SOAP version: #{version}" unless SOAP::Versions.include? version
+        @version = version
+      end
+
+      # Returns the SOAP +version+. Defaults to <tt>Savon.soap_version</tt>.
+      def version
+        @version ||= Savon.soap_version
+      end
+
+      # Sets the SOAP +header+ Hash.
+      attr_writer :header
+
+      # Returns the SOAP +header+. Defaults to an empty Hash.
+      def header
+        @header ||= Savon.soap_header.nil? ? {} : Savon.soap_header
+      end
+
+      # Sets the SOAP envelope namespace.
+      attr_writer :env_namespace
+
+      # Returns the SOAP envelope namespace. Uses the global namespace if set Defaults to :env.
+      def env_namespace
+        @env_namespace ||= Savon.env_namespace.nil? ? :env : Savon.env_namespace
+      end
+
+      # Sets the +namespaces+ Hash.
+      attr_writer :namespaces
+
+      # Returns the +namespaces+. Defaults to a Hash containing the SOAP envelope namespace.
+      def namespaces
+        @namespaces ||= begin
+          key = env_namespace.blank? ? "xmlns" : "xmlns:#{env_namespace}"
+          { key => SOAP::Namespace[version] }
+        end
+      end
+
+      def namespace_by_uri(uri)
+        namespaces.each do |candidate_identifier, candidate_uri|
+          return candidate_identifier.gsub(/^xmlns:/, '') if candidate_uri == uri
+        end
+        nil
+      end
+
+      def used_namespaces
+        @used_namespaces ||= {}
+      end
+
+      def use_namespace(path, uri)
+        @internal_namespace_count ||= 0
+
+        unless identifier = namespace_by_uri(uri)
+          identifier = "ins#{@internal_namespace_count}"
+          namespaces["xmlns:#{identifier}"] = uri
+          @internal_namespace_count += 1
+        end
+
+        used_namespaces[path] = identifier
+      end
+
+      def types
+        @types ||= {}
+      end
+
+      # Sets the default namespace identifier.
+      attr_writer :namespace_identifier
+
+      # Returns the default namespace identifier.
+      def namespace_identifier
+        @namespace_identifier ||= :wsdl
+      end
+
+      # Returns whether all local elements should be namespaced. Might be set to :qualified,
+      # but defaults to :unqualified.
+      def element_form_default
+        @element_form_default ||= :unqualified
+      end
+
+      # Sets whether all local elements should be namespaced.
+      attr_writer :element_form_default
+
+      # Accessor for the default namespace URI.
+      attr_accessor :namespace
+
+      # Accessor for the <tt>Savon::WSSE</tt> object.
+      attr_accessor :wsse
+
+      # Accepts a +block+ and yields a <tt>Builder::XmlMarkup</tt> object to let you create
+      # custom body XML.
+      def body
+        @body = yield builder(nil) if block_given?
+        @body
+      end
+
+      # Sets the SOAP +body+. Expected to be a Hash that can be translated to XML via `Gyoku.xml`
+      # or any other Object responding to to_s.
+      attr_writer :body
+
+      # Accepts a +block+ and yields a <tt>Builder::XmlMarkup</tt> object to let you create
+      # a completely custom XML.
+      def xml(directive_tag = :xml, attrs = {})
+        @xml = yield builder(directive_tag, attrs) if block_given?
+      end
+
+      # Accepts an XML String and lets you specify a completely custom request body.
+      attr_writer :xml
+
+      # Returns the XML for a SOAP request.
+      def to_xml
+        @xml ||= tag(builder, :Envelope, complete_namespaces) do |xml|
+          tag(xml, :Header) { xml << header_for_xml } unless header_for_xml.empty?
+
+          if input.nil?
+            tag(xml, :Body)
+          else
+            tag(xml, :Body) { xml.tag!(*add_namespace_to_input) { xml << body_to_xml } }
+          end
+        end
+      end
+
+    private
+
+      # Returns a new <tt>Builder::XmlMarkup</tt> object.
+      def builder(directive_tag = :xml, attrs = {})
+        builder = Builder::XmlMarkup.new
+        builder.instruct!(directive_tag, attrs) if directive_tag
+        builder
+      end
+
+      # Expects a builder +xml+ instance, a tag +name+ and accepts optional +namespaces+
+      # and a block to create an XML tag.
+      def tag(xml, name, namespaces = {}, &block)
+        return xml.tag! name, namespaces, &block if env_namespace.blank?
+        xml.tag! env_namespace, name, namespaces, &block
+      end
+
+      # Returns the complete Hash of namespaces.
+      def complete_namespaces
+        defaults = SchemaTypes.dup
+        defaults["xmlns:#{namespace_identifier}"] = namespace if namespace
+        defaults.merge namespaces
+      end
+
+      # Returns the SOAP header as an XML String.
+      def header_for_xml
+        @header_for_xml ||= Gyoku.xml(header) + wsse_header
+      end
+
+      # Returns the WSSE header or an empty String in case WSSE was not set.
+      def wsse_header
+        wsse.respond_to?(:to_xml) ? wsse.to_xml : ""
+      end
+
+      # Returns the SOAP body as an XML String.
+      def body_to_xml
+        return body.to_s unless body.kind_of? Hash
+        Gyoku.xml add_namespaces_to_body(body), :element_form_default => element_form_default, :namespace => namespace_identifier
+      end
+
+      def add_namespaces_to_body(hash, path = [input[1].to_s])
+        return unless hash
+        return hash if hash.kind_of?(Array)
+        return hash.to_s unless hash.kind_of? Hash
+
+        hash.inject({}) do |newhash, (key, value)|
+          camelcased_key = Gyoku::XMLKey.create(key)
+          newpath = path + [camelcased_key]
+
+          if used_namespaces[newpath]
+            newhash.merge(
+              "#{used_namespaces[newpath]}:#{camelcased_key}" =>
+                add_namespaces_to_body(value, types[newpath] ? [types[newpath]] : newpath)
+            )
+          else
+            newhash.merge(key => value)
+          end
+        end
+      end
+
+      def add_namespace_to_input
+        return input.compact unless used_namespaces[[input[1].to_s]]
+        [used_namespaces[[input[1].to_s]], input[1], input[2]]
+      end
+
+    end
+  end
+end

data/lib/savon/version.rb

@@ -0,0 +1,5 @@
+module Savon
+
+  Version = "1.0.0"
+
+end

data/lib/savon/wasabi/document.rb

@@ -0,0 +1,41 @@
+require "wasabi"
+require "httpi/request"
+
+module Savon
+  module Wasabi
+
+    # = Savon::Wasabi::Document
+    #
+    # Extends the document handling of the <tt>Wasabi::Document</tt> by
+    # adding support for remote and local WSDL documents.
+    class Document < ::Wasabi::Document
+
+      # Hooks into Wasabi and extends its document handling.
+      def xml
+        @xml ||= document.kind_of?(String) ? resolve_document : document
+      end
+
+      # Sets the <tt>HTTPI::Request</tt> for remote WSDL documents.
+      attr_writer :request
+
+    private
+
+      # Sets up and returns the <tt>HTTPI::Request</tt>.
+      def request
+        @request ||= HTTPI::Request.new
+        @request.url = document
+        @request
+      end
+
+      # Resolves and returns the raw WSDL document.
+      def resolve_document
+        case document
+          when /^http[s]?:/ then HTTPI.get(request).body
+          when /^</         then document
+          else                   File.read(document)
+        end
+      end
+
+    end
+  end
+end

data/regenersis-savon.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift lib unless $:.include? lib
+
+require "savon/version"
+
+Gem::Specification.new do |s|
+  s.name        = "regenersis-savon"
+  s.version     = Savon::Version
+  s.authors     = "Daniel Harrington"
+  s.email       = "me@rubiii.com"
+  s.homepage    = "http://savonrb.com"
+  s.summary     = "Heavy metal Ruby SOAP client"
+  s.description = "Ruby's heavy metal SOAP client"
+
+  s.rubyforge_project = s.name
+
+  s.add_dependency "builder",  ">= 2.1.2"
+  s.add_dependency "nori",     "~> 1.0"
+  s.add_dependency "regenersis-httpi",    "~> 0.9"
+  s.add_dependency "wasabi",   "~> 2.0"
+  s.add_dependency "akami",    "~> 1.0"
+  s.add_dependency "gyoku",    ">= 0.4.0"
+  s.add_dependency "nokogiri", ">= 1.4.0"
+
+  s.add_development_dependency "rake",    "~> 0.8.7"
+  s.add_development_dependency "rspec",   "~> 2.5.0"
+  s.add_development_dependency "mocha",   "~> 0.9.8"
+  s.add_development_dependency "timecop", "~> 0.3.5"
+
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "ZenTest", "4.5.0"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = "lib"
+end

data/spec/fixtures/response/another_soap_fault.xml

@@ -0,0 +1,14 @@
+<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <SOAP-ENV:Body>
+    <SOAP-ENV:Fault>
+      <faultcode>ERR_NO_SESSION</faultcode>
+      <faultfactor>doGetItemsInfo - Wrong session</faultfactor>
+      <faultstring>Wrong session message</faultstring>
+      <detail><soapVal><ERRNO xsi:type="xsd:string">80:1289245853:55</ERRNO></soapVal></detail>
+    </SOAP-ENV:Fault>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/fixtures/response/authentication.xml

@@ -0,0 +1,14 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+   <soap:Body>
+      <ns2:authenticateResponse xmlns:ns2="http://v1_0.ws.user.example.com">
+         <return>
+            <authenticationValue>
+              <token>a68d1d6379b62ff339a0e0c69ed4d9cf</token>
+              <tokenHash>AAAJxA;cIedoT;mY10ExZwG6JuKgp2OYKxow==</tokenHash>
+              <client>radclient</client>
+            </authenticationValue>
+            <success>true</success>
+         </return>
+      </ns2:authenticateResponse>
+   </soap:Body>
+</soap:Envelope>

data/spec/fixtures/response/header.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Header xmlns="http://webservices.somewhere.com/definitions">
+    <SessionNumber>ABCD1234</SessionNumber>
+  </soap:Header>
+  <soap:Body>
+    <AuthenticateReply xmlns="http://xml.somewhere.com/ABCD">
+      <processStatus>
+        <statusCode>P</statusCode>
+      </processStatus>
+    </AuthenticateReply>
+  </soap:Body>
+</soap:Envelope>

data/spec/fixtures/response/list.xml

@@ -0,0 +1,18 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+   <soapenv:Body>
+      <MultiNamespacedEntryResponse xmlns="http://www.example.com/BusinessRulesEngine/xsd">
+         <history>
+                <ns10:case xmlns:ns10="http://www.example.com/Common/xsd">
+                    <ns10:logTime>2010-09-21T18:22:01.558+10:00</ns10:logTime>
+                    <ns10:logType>Notes Log</ns10:logType>
+                    <ns10:logText>test</ns10:logText>
+                </ns10:case>
+                <ns11:case xmlns:ns11="http://www.example.com/Common/xsd">
+                    <ns11:logTime>2010-09-21T18:22:07.038+10:00</ns11:logTime>
+                    <ns11:logType>Notes Log</ns11:logType>
+                    <ns11:logText>another test</ns11:logText>
+                </ns11:case>
+         </history>
+      </MultiNamespacedEntryResponse>
+   </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/response/multi_ref.xml

@@ -0,0 +1,39 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+   <soapenv:Body>
+      <ns1:listResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://ws.example.com">
+         <listReturn soapenc:arrayType="ns2:HistoryEntry[3]" xsi:type="soapenc:Array" xmlns:ns2="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+            <listReturn href="#id0"/>
+            <listReturn href="#id1"/>
+            <listReturn href="#id2"/>
+         </listReturn>
+      </ns1:listResponse>
+      <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:HistoryEntry" xmlns:ns5="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-09-22T13:47:23.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id9"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 09-22-2009: Misc</subject>
+      </multiRef>
+      <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:HistoryEntry" xmlns:ns6="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-04-30T06:38:34.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id10"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 04-29-2009: Technical support</subject>
+      </multiRef>
+      <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:HistoryEntry" xmlns:ns7="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-12-18T15:43:21.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id11"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 12-17-2009: Misc</subject>
+      </multiRef>
+      <multiRef id="id11" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">972219</multiRef>
+      <multiRef id="id10" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">708021</multiRef>
+      <multiRef id="id8" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
+      <multiRef id="id9" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">855763</multiRef>
+   </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/response/soap_fault.xml

@@ -0,0 +1,8 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+   <soap:Body>
+      <soap:Fault>
+         <faultcode>soap:Server</faultcode>
+         <faultstring>Fault occurred while processing.</faultstring>
+      </soap:Fault>
+   </soap:Body>
+</soap:Envelope>

data/spec/fixtures/response/soap_fault12.xml

@@ -0,0 +1,18 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:m="http://www.example.org/timeouts">
+  <soap:Body>
+    <soap:Fault>
+      <Code>
+        <Value>soap:Sender</Value>
+        <Subcode>
+          <Value>m:MessageTimeout</Value>
+        </Subcode>
+      </Code>
+      <Reason>
+        <Text xml:lang="en">Sender Timeout</Text>
+      </Reason>
+      <Detail>
+        <m:MaxTime>P5M</m:MaxTime>
+      </Detail>
+    </soap:Fault>
+  </soap:Body>
+</soap:Envelope>