johnreitano-savon 0.7.2.1

data/lib/savon/wsdl.rb

@@ -0,0 +1,122 @@
+module Savon
+
+  # Savon::WSDL
+  #
+  # Represents the WSDL document.
+  class WSDL
+
+    # Initializer, expects a Savon::Request.
+    def initialize(request)
+      @request = request
+    end
+
+    # Sets whether to use the WSDL.
+    attr_writer :enabled
+
+    # Returns whether to use the WSDL. Defaults to +true+.
+    def enabled?
+      @enabled.nil? ? true : @enabled
+    end
+
+    # Returns the namespace URI of the WSDL.
+    def namespace_uri
+      @namespace_uri ||= stream.namespace_uri
+    end
+
+    # Returns an Array of available SOAP actions.
+    def soap_actions
+      @soap_actions ||= stream.operations.keys
+    end
+
+    # Returns a Hash of SOAP operations including their corresponding
+    # SOAP actions and inputs.
+    def operations
+      @operations ||= stream.operations
+    end
+
+    # Returns the SOAP endpoint.
+    def soap_endpoint
+      @soap_endpoint ||= stream.soap_endpoint
+    end
+
+    # Returns +true+ for available methods and SOAP actions.
+    def respond_to?(method)
+      return true if soap_actions.include? method
+      super
+    end
+
+    # Returns the raw WSDL document.
+    def to_s
+      @document ||= @request.wsdl.body
+    end
+
+  private
+
+    # Returns the Savon::WSDLStream.
+    def stream
+      unless @stream
+        @stream = WSDLStream.new
+        REXML::Document.parse_stream to_s, @stream
+      end
+      @stream
+    end
+
+  end
+
+  # Savon::WSDLStream
+  #
+  # Stream listener for parsing the WSDL document.
+  class WSDLStream
+
+    # The main sections of a WSDL document.
+    Sections = %w(definitions types message portType binding service)
+
+    def initialize
+      @depth, @operations = 0, {}
+    end
+
+    # Returns the namespace URI.
+    attr_reader :namespace_uri
+
+    # Returns the SOAP operations.
+    attr_reader :operations
+
+    # Returns the SOAP endpoint.
+    attr_reader :soap_endpoint
+
+    # Hook method called when the stream parser encounters a starting tag.
+    def tag_start(tag, attrs)
+      @depth += 1
+      tag = tag.strip_namespace
+
+      @section = tag.to_sym if @depth <= 2 && Sections.include?(tag)
+      @namespace_uri ||= attrs["targetNamespace"] if @section == :definitions
+      @soap_endpoint ||= URI(attrs["location"]) if @section == :service && tag == "address"
+
+      operation_from tag, attrs if @section == :binding && tag == "operation"
+    end
+
+    # Hook method called when the stream parser encounters a closing tag.
+    def tag_end(tag)
+      @depth -= 1
+    end
+
+    # Stores available operations from a given tag +name+ and +attrs+.
+    def operation_from(tag, attrs)
+      @input = attrs["name"] if attrs["name"]
+
+      if attrs["soapAction"]
+        @action = !attrs["soapAction"].blank? ? attrs["soapAction"] : @input
+        @input = @action.split("/").last if !@input || @input.empty?
+
+        @operations[@input.snakecase.to_sym] = { :action => @action, :input => @input }
+        @input, @action = nil, nil
+      end
+    end
+
+    # Catches calls to unimplemented hook methods.
+    def method_missing(method, *args)
+    end
+
+  end
+end

data/lib/savon/wsse.rb

@@ -0,0 +1,136 @@
+module Savon
+
+  # Savon::WSSE
+  #
+  # Represents parameters for WSSE authentication.
+  class WSSE
+
+    # Base address for WSSE docs.
+    BaseAddress = "http://docs.oasis-open.org/wss/2004/01"
+
+    # Namespace for WS Security Secext.
+    WSENamespace = BaseAddress + "/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+
+    # Namespace for WS Security Utility.
+    WSUNamespace = BaseAddress + "/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+
+    # URI for "wsse:Password/@Type" #PasswordText.
+    PasswordTextURI = BaseAddress + "/oasis-200401-wss-username-token-profile-1.0#PasswordText"
+
+    # URI for "wsse:Password/@Type" #PasswordDigest.
+    PasswordDigestURI = BaseAddress + "/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
+
+    # Global WSSE username.
+    @@username = nil
+
+    # Returns the global WSSE username.
+    def self.username
+      @@username
+    end
+
+    # Sets the global WSSE username.
+    def self.username=(username)
+      @@username = username.to_s if username.respond_to? :to_s
+      @@username = nil if username.nil?
+    end
+
+    # Global WSSE password.
+    @@password = nil
+
+    # Returns the global WSSE password.
+    def self.password
+      @@password
+    end
+
+    # Sets the global WSSE password.
+    def self.password=(password)
+      @@password = password.to_s if password.respond_to? :to_s
+      @@password = nil if password.nil?
+    end
+
+    # Global setting of whether to use WSSE digest.
+    @@digest = false
+
+    # Returns the global setting of whether to use WSSE digest.
+    def self.digest?
+      @@digest
+    end
+
+    # Global setting of whether to use WSSE digest.
+    def self.digest=(digest)
+      @@digest = digest
+    end
+
+    # Sets the WSSE username per request.
+    def username=(username)
+      @username = username.to_s if username.respond_to? :to_s
+      @username = nil if username.nil?
+    end
+
+    # Returns the WSSE username. Defaults to the global setting.
+    def username
+      @username || self.class.username
+    end
+
+    # Sets the WSSE password per request.
+    def password=(password)
+      @password = password.to_s if password.respond_to? :to_s
+      @password = nil if password.nil?
+    end
+
+    # Returns the WSSE password. Defaults to the global setting.
+    def password
+      @password || self.class.password
+    end
+
+    # Sets whether to use WSSE digest per request.
+    attr_writer :digest
+
+    # Returns whether to use WSSE digest. Defaults to the global setting. 
+    def digest?
+      @digest || self.class.digest?
+    end
+
+    # Returns the XML for a WSSE header or an empty String unless both
+    # username and password were specified.
+    def header
+      return "" unless username && password
+
+      builder = Builder::XmlMarkup.new
+      builder.wsse :Security, "xmlns:wsse" => WSENamespace do |xml|
+        xml.wsse :UsernameToken, "xmlns:wsu" => WSUNamespace do
+          xml.wsse :Username, username
+          xml.wsse :Nonce, nonce
+          xml.wsu :Created, timestamp
+          xml.wsse :Password, password_node, :Type => password_type
+        end
+      end
+    end
+
+  private
+
+    # Returns the WSSE password. Encrypts the password for digest authentication.
+    def password_node
+      return password unless digest?
+
+      token = nonce + timestamp + password
+      Base64.encode64(Digest::SHA1.hexdigest(token)).chomp!
+    end
+
+    # Returns the URI for the "wsse:Password/@Type" attribute.
+    def password_type
+      digest? ? PasswordDigestURI : PasswordTextURI
+    end
+
+    # Returns a WSSE nonce.
+    def nonce
+      @nonce ||= Digest::SHA1.hexdigest String.random + timestamp
+    end
+
+    # Returns a WSSE timestamp.
+    def timestamp
+      @timestamp ||= Time.now.strftime Savon::SOAPDateTimeFormat
+    end
+
+  end
+end

data/lib/savon.rb

@@ -0,0 +1,34 @@
+module Savon
+
+  # Supported SOAP versions.
+  SOAPVersions = [1, 2]
+
+  # SOAP xs:dateTime format.
+  SOAPDateTimeFormat = "%Y-%m-%dT%H:%M:%S"
+
+  # SOAP xs:dateTime Regexp.
+  SOAPDateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
+
+  # Raised in case of an HTTP error.
+  class HTTPError < StandardError; end
+
+  # Raised in case of a SOAP fault.
+  class SOAPFault < StandardError; end
+
+end
+
+# standard libs
+%w(logger net/https openssl base64 digest/sha1 rexml/document).each do |lib|
+  require lib
+end
+
+# gems
+require "rubygems"
+%w(builder crack/xml).each do |gem|
+  require gem
+end
+
+# core files
+%w(core_ext wsse soap request response wsdl client).each do |file|
+  require File.dirname(__FILE__) + "/savon/#{file}"
+end

data/spec/basic_spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "rake"
+require "spec"
+require "mocha"
+require "fakeweb"
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require "savon"
+Savon::Request.log = false

data/spec/endpoint_helper.rb

@@ -0,0 +1,22 @@
+class EndpointHelper
+
+  # Returns the WSDL endpoint for a given +type+ of request.
+  def self.wsdl_endpoint(type = nil)
+    case type
+      when :no_namespace       then "http://nons.example.com/Service?wsdl"
+      when :namespaced_actions then "http://nsactions.example.com/Service?wsdl"
+      else                          soap_endpoint(type)
+    end
+  end
+
+  # Returns the SOAP endpoint for a given +type+ of request.
+  def self.soap_endpoint(type = nil)
+    case type
+      when :soap_fault then "http://soapfault.example.com/Service?wsdl"
+      when :http_error then "http://httperror.example.com/Service?wsdl"
+      when :invalid    then "http://invalid.example.com/Service?wsdl"
+      else                  "http://example.com/validation/1.0/AuthenticationService"
+    end
+  end
+
+end

data/spec/fixtures/response/response_fixture.rb

@@ -0,0 +1,36 @@
+class ResponseFixture
+
+  def self.authentication(value = nil)
+    case value
+      when :to_hash
+        { :success => true,
+          :authentication_value => {
+            :token => "a68d1d6379b62ff339a0e0c69ed4d9cf",
+            :token_hash => "AAAJxA;cIedoT;mY10ExZwG6JuKgp2OYKxow==",
+            :client => "radclient"
+          }
+        }
+      else
+        @@authentication ||= load_fixture :authentication
+    end
+  end
+
+  def self.soap_fault
+    @@soap_fault ||= load_fixture :soap_fault
+  end
+
+  def self.soap_fault12
+    @@soap_fault12 ||= load_fixture :soap_fault12
+  end
+
+  def self.multi_ref
+    @@multi_ref ||= load_fixture :multi_ref
+  end
+
+private
+
+  def self.load_fixture(fixture)
+    File.read File.dirname(__FILE__) + "/xml/#{fixture}.xml"
+  end
+
+end

data/spec/fixtures/response/xml/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/xml/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/xml/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/xml/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>