savon 0.6.0 → 0.7.0

data/lib/savon/request.rb

@@ -8,66 +8,97 @@ module Savon
     # Content-Types by SOAP version.
     ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
 
-    # Defines whether to log HTTP requests.
-    @log = true
+    # Whether to log HTTP requests.
+    @@log = true
 
     # The default logger.
-    @logger = Logger.new STDOUT
+    @@logger = Logger.new STDOUT
 
     # The default log level.
-    @log_level = :debug
+    @@log_level = :debug
 
-    class << self
-      # Sets whether to log HTTP requests.
-      attr_writer :log
+    # Sets whether to log HTTP requests.
+    def self.log=(log)
+      @@log = log
+    end
 
-      # Returns whether to log HTTP requests.
-      def log?
-        @log
-      end
+    # Returns whether to log HTTP requests.
+    def self.log?
+      @@log
+    end
 
-      # Accessor for the default logger.
-      attr_accessor :logger
+    # Sets the logger.
+    def self.logger=(logger)
+      @@logger = logger
+    end
 
-      # Accessor for the default log level.
-      attr_accessor :log_level
+    # Returns the logger.
+    def self.logger
+      @@logger
     end
 
-    # Expects an endpoint String. Raises an exception in case the given
-    # +endpoint+ does not seem to be valid.
-    def initialize(endpoint)
-      raise ArgumentError, "Invalid endpoint: #{endpoint}" unless
-        /^(http|https):\/\// === endpoint
+    # Sets the log level.
+    def self.log_level=(log_level)
+      @@log_level = log_level
+    end
 
+    # Returns the log level.
+    def self.log_level
+      @@log_level
+    end
+
+    # Expects a SOAP +endpoint+ String. Also accepts an optional Hash
+    # of +options+ for specifying a proxy server.
+    def initialize(endpoint, options = {})
       @endpoint = URI endpoint
+      @proxy = options[:proxy] ? URI(options[:proxy]) : URI("")
     end
 
     # Returns the endpoint URI.
     attr_reader :endpoint
 
-    # Retrieves WSDL document and returns the Net::HTTPResponse.
+    # Returns the proxy URI.
+    attr_reader :proxy
+
+    # Sets the +username+ and +password+ for HTTP basic authentication.
+    def basic_auth(username, password)
+      @basic_auth = [username, password]
+    end
+
+    # Retrieves WSDL document and returns the Net::HTTP response.
     def wsdl
       log "Retrieving WSDL from: #{@endpoint}"
-      http.get @endpoint.to_s
+      http.endpoint @endpoint.host, @endpoint.port
+      http.use_ssl = @endpoint.ssl?
+      http.start { |h| h.request request(:wsdl) }
     end
 
     # Executes a SOAP request using a given Savon::SOAP instance and
-    # returns the Net::HTTPResponse.
+    # returns the Net::HTTP response.
     def soap(soap)
       @soap = soap
+      http.endpoint @soap.endpoint.host, @soap.endpoint.port
+      http.use_ssl = @soap.endpoint.ssl?
 
       log_request
-      @response = http.request_post @endpoint.path, @soap.to_xml, http_header
+      @response = http.start do |h|
+        h.request request(:soap) { |request| request.body = @soap.to_xml }
+      end
       log_response
       @response
     end
 
+    # Returns the Net::HTTP object.
+    def http
+      @http ||= Net::HTTP::Proxy(@proxy.host, @proxy.port).new @endpoint.host, @endpoint.port
+    end
+
   private
 
     # Logs the SOAP request.
     def log_request
-      log "SOAP request: #{@endpoint}"
-      log http_header.map { |key, value| "#{key}: #{value}" }.join ", "
+      log "SOAP request: #{@soap.endpoint}"
+      log http_header.map { |key, value| "#{key}: #{value}" }.join(", ")
       log @soap.to_xml
     end
 
@@ -77,13 +108,22 @@ module Savon
       log @response.body
     end
 
-    # Returns a Net::HTTP instance.
-    def http
-      unless @http
-        @http ||= Net::HTTP.new @endpoint.host, @endpoint.port
-        @http.use_ssl = true if @endpoint.ssl?
+    # Returns a Net::HTTP request for a given +type+. Yields the request
+    # to an optional block.
+    def request(type)
+      request = case type
+        when :wsdl then Net::HTTP::Get.new wsdl_endpoint
+        when :soap then Net::HTTP::Post.new @soap.endpoint.path, http_header
       end
-      @http
+      request.basic_auth *@basic_auth if @basic_auth
+      yield request if block_given?
+      request
+    end
+
+    # Returns the WSDL endpoint.
+    def wsdl_endpoint
+      return @endpoint.path unless @endpoint.query
+      "#{@endpoint.path}?#{@endpoint.query}"
     end
 
     # Returns a Hash containing the header for an HTTP request.
@@ -96,7 +136,7 @@ module Savon
       self.class.logger.send self.class.log_level, message if log?
     end
 
-    # Returns whether logging is possible.
+    # Returns whether to log.
     def log?
       self.class.log? && self.class.logger.respond_to?(self.class.log_level)
     end

data/lib/savon/response.rb

@@ -5,19 +5,17 @@ module Savon
   # Represents the HTTP and SOAP response.
   class Response
 
-    # The default of whether to raise errors.
-    @raise_errors = true
+    # The global setting of whether to raise errors.
+    @@raise_errors = true
 
-    class << self
-
-      # Sets the default of whether to raise errors.
-      attr_writer :raise_errors
-
-      # Returns the default of whether to raise errors.
-      def raise_errors?
-        @raise_errors
-      end
+    # Sets the global setting of whether to raise errors.
+    def self.raise_errors=(raise_errors)
+      @@raise_errors = raise_errors
+    end
 
+    # Returns the global setting of whether to raise errors.
+    def self.raise_errors?
+      @@raise_errors
     end
 
     # Expects a Net::HTTPResponse and handles errors.
@@ -30,7 +28,7 @@ module Savon
 
     # Returns whether there was a SOAP fault.
     def soap_fault?
-      @soap_fault
+      @soap_fault ? true : false
     end
 
     # Returns the SOAP fault message.
@@ -38,15 +36,15 @@ module Savon
 
     # Returns whether there was an HTTP error.
     def http_error?
-      @http_error
+      @http_error ? true : false
     end
 
     # Returns the HTTP error message.
     attr_reader :http_error
 
-    # Returns the SOAP response as a Hash.
+    # Returns the SOAP response body as a Hash.
     def to_hash
-      @body.find_regexp(/.+/).map_soap_response
+      @body ||= Crack::XML.parse(@response.body).find_soap_body
     end
 
     # Returns the SOAP response XML.
@@ -54,44 +52,33 @@ module Savon
       @response.body
     end
 
-    alias :to_s  :to_xml
+    alias :to_s :to_xml
 
   private
 
-    # Returns the SOAP response body as a Hash.
-    def body
-      unless @body
-        body = Crack::XML.parse @response.body
-        @body = body.find_regexp [/.+:Envelope/, /.+:Body/]
-      end
-      @body
-    end
-
     # Handles SOAP faults. Raises a Savon::SOAPFault unless the default
     # behavior of raising errors was turned off.
     def handle_soap_fault
       if soap_fault_message
         @soap_fault = soap_fault_message
-        raise Savon::SOAPFault, soap_fault_message if self.class.raise_errors?
+        raise Savon::SOAPFault, @soap_fault if self.class.raise_errors?
       end
     end
 
     # Returns a SOAP fault message in case a SOAP fault was found.
     def soap_fault_message
-      unless @soap_fault_message
-        soap_fault = body.find_regexp [/.+:Fault/]
-        @soap_fault_message = soap_fault_message_by_version(soap_fault)
-      end
-      @soap_fault_message
+      @soap_fault_message ||= soap_fault_message_by_version to_hash[:fault]
     end
 
     # Expects a Hash that might contain information about a SOAP fault.
     # Returns the SOAP fault message in case one was found.
     def soap_fault_message_by_version(soap_fault)
-      if soap_fault.keys.include? "faultcode"
-        "(#{soap_fault['faultcode']}) #{soap_fault['faultstring']}"
-      elsif soap_fault.keys.include? "code"
-        "(#{soap_fault['code']['value']}) #{soap_fault['reason']['text']}"
+      return unless soap_fault
+
+      if soap_fault.keys.include? :faultcode
+        "(#{soap_fault[:faultcode]}) #{soap_fault[:faultstring]}"
+      elsif soap_fault.keys.include? :code
+        "(#{soap_fault[:code][:value]}) #{soap_fault[:reason][:text]}"
       end
     end
 
@@ -100,7 +87,7 @@ module Savon
     def handle_http_error
       if @response.code.to_i >= 300
         @http_error = "#{@response.message} (#{@response.code})"
-        @http_error += ": #{@response.body}" unless @response.body.empty?
+        @http_error << ": #{@response.body}" unless @response.body.empty?
         raise Savon::HTTPError, http_error if self.class.raise_errors?
       end
     end

data/lib/savon/soap.rb

@@ -14,32 +14,44 @@ module Savon
     # Content-Types by SOAP version.
     ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
 
-    # The default SOAP version.
-    @version = 1
+    # The global SOAP version.
+    @@version = 1
 
-    class << self
-
-      # Returns the default SOAP version.
-      attr_reader :version
-
-      # Sets the default SOAP version.
-      def version=(version)
-        @version = version if Savon::SOAPVersions.include? version
-      end
+    # Returns the global SOAP version.
+    def self.version
+      @@version
+    end
 
+    # Sets the global SOAP version.
+    def self.version=(version)
+      @@version = version if Savon::SOAPVersions.include? version
     end
 
-    # Expects an +action_map+ containing the name of the SOAP action and input.
-    def initialize(action_map)
-      @action = action_map[:name]
-      @input = action_map[:input]
+    def initialize
+      @builder = Builder::XmlMarkup.new
     end
 
     # Sets the WSSE options.
     attr_writer :wsse
 
-    # Accessor for the SOAP action.
-    attr_accessor :action
+    # Sets the SOAP action.
+    attr_writer :action
+
+    # Returns the SOAP action.
+    def action
+      @action ||= ""
+    end
+
+    # Sets the SOAP input.
+    attr_writer :input
+
+    # Returns the SOAP input.
+    def input
+      @input ||= ""
+    end
+
+    # Accessor for the SOAP endpoint.
+    attr_accessor :endpoint
 
     # Sets the SOAP header. Expected to be a Hash that can be translated
     # to XML via Hash.to_soap_xml or any other Object responding to to_s.
@@ -64,6 +76,11 @@ module Savon
       @namespaces ||= { "xmlns:env" => SOAPNamespace[version] }
     end
 
+    # Convenience method for setting the "xmlns:wsdl" namespace.
+    def namespace=(namespace)
+      namespaces["xmlns:wsdl"] = namespace
+    end
+
     # Sets the SOAP version.
     def version=(version)
       @version = version if Savon::SOAPVersions.include? version
@@ -77,17 +94,9 @@ module Savon
     # Returns the SOAP envelope XML.
     def to_xml
       unless @xml_body
-        builder = Builder::XmlMarkup.new
-
-        @xml_body = builder.env :Envelope, namespaces do |xml|
-          xml.env(:Header) do
-            xml << (header.to_soap_xml rescue header.to_s) + wsse_header
-          end
-          xml.env(:Body) do
-            xml.wsdl(@input.to_sym) do
-              xml << (@body.to_soap_xml rescue @body.to_s)
-            end
-          end
+        @xml_body = @builder.env :Envelope, namespaces do |xml|
+          xml_header xml
+          xml_body xml
         end
       end
       @xml_body
@@ -95,10 +104,34 @@ module Savon
 
   private
 
+    # Adds a SOAP XML header to a given +xml+ Object.
+    def xml_header(xml)
+      xml.env(:Header) do
+        xml << (header.to_soap_xml rescue header.to_s) + wsse_header
+      end
+    end
+
+    # Adds a SOAP XML body to a given +xml+ Object.
+    def xml_body(xml)
+      xml.env(:Body) do
+        xml.tag!(:wsdl, *input_array) do
+          xml << (@body.to_soap_xml rescue @body.to_s)
+        end
+      end
+    end
+
+    # Returns an Array of SOAP input names to append to the :wsdl namespace.
+    # Defaults to use the name of the SOAP action and may be an empty Array
+    # in case the specified SOAP input seems invalid.
+    def input_array
+      return [input.to_sym] unless input.blank?
+      return [action.to_sym] unless action.blank?
+      []
+    end
+
     # Returns the WSSE header or an empty String in case WSSE was not set.
     def wsse_header
-      return "" unless @wsse.respond_to? :header
-      @wsse.header
+      @wsse.respond_to?(:header) ? @wsse.header : ""
     end
 
   end

data/lib/savon/wsdl.rb

@@ -2,74 +2,121 @@ module Savon
 
   # Savon::WSDL
   #
-  # Represents a WSDL document.
+  # Represents the WSDL document.
   class WSDL
 
-    # Expects a Savon::Request object.
+    # Initializer, expects a Savon::Request.
     def initialize(request)
       @request = request
     end
 
-    # Returns the namespace URI from the WSDL.
+    # 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 ||= parse_namespace_uri
+      @namespace_uri ||= stream.namespace_uri
     end
 
-    # Returns a Hash of available SOAP actions mapped to snake_case (keys)
-    # and their original names and inputs in another Hash (values).
+    # Returns an Array of available SOAP actions.
     def soap_actions
-      @soap_actions ||= parse_soap_operations.inject({}) do |hash, (input, action)|
-        hash.merge input.snakecase.to_sym => { :name => action, :input => input }
-      end
+      @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.keys.include? method
+      return true if soap_actions.include? method
       super
     end
 
-    # Returns the WSDL document.
+    # Returns the raw WSDL document.
     def to_s
-      wsdl_response.body
+      @document ||= @request.wsdl.body
     end
 
   private
 
-    # Retrieves and returns the WSDL response. Raises an ArgumentError in
-    # case the WSDL seems to be invalid. 
-    def wsdl_response
-      unless @wsdl_response
-        @wsdl_response ||= @request.wsdl
-        raise ArgumentError, "Invalid WSDL: #{@request.endpoint}" if soap_actions.empty?
+    # Returns the Savon::WSDLStream.
+    def stream
+      unless @stream
+        @stream = WSDLStream.new
+        REXML::Document.parse_stream to_s, @stream
       end
-      @wsdl_response
+      @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 a REXML::Document of the WSDL.
-    def document
-      @document ||= REXML::Document.new wsdl_response.body
+    # 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
 
-    # Parses the WSDL for the namespace URI.
-    def parse_namespace_uri
-      definitions = document.elements["//wsdl:definitions"]
-      definitions.attributes["targetNamespace"] if definitions
+    # Hook method called when the stream parser encounters a closing tag.
+    def tag_end(tag)
+      @depth -= 1
     end
 
-    # Parses the WSDL for available SOAP actions and inputs. Returns a Hash
-    # containing the SOAP action inputs and corresponding SOAP actions.
-    def parse_soap_operations
-      wsdl_binding = document.elements["//wsdl:binding"]
-      return {} unless wsdl_binding
+    # Stores available operations from a given tag +name+ and +attrs+.
+    def operation_from(tag, attrs)
+      @input = attrs["name"] if attrs["name"]
 
-      wsdl_binding.elements.inject("//wsdl:operation", {}) do |hash, operation|
-        action = operation.elements["*:operation"].attributes["soapAction"] || ""
-        action = operation.attributes["name"] if action.empty?
+      if attrs["soapAction"]
+        @action = !attrs["soapAction"].blank? ? attrs["soapAction"] : @input
+        @input = @action.split("/").last if !@input || @input.empty?
 
-        hash.merge action.split("/").last => action
+        @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

@@ -11,73 +11,79 @@ module Savon
     # Namespace for WS Security Utility.
     WSUNamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
 
-    # Default WSSE username.
-    @username = ""
+    # Global WSSE username.
+    @@username = nil
 
-    # Default WSSE password.
-    @password = ""
-
-    # Default for whether to use WSSE digest.
-    @digest = false
-
-    class << self
+    # Returns the global WSSE username.
+    def self.username
+      @@username
+    end
 
-      # Returns the default WSSE username.
-      attr_reader :username
+    # 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
 
-      # Sets the default WSSE username.
-      def username=(username)
-        @username = username.to_s if username.respond_to? :to_s
-      end
+    # Global WSSE password.
+    @@password = nil
 
-      # Returns the default WSSE password.
-      attr_reader :password
+    # Returns the global WSSE password.
+    def self.password
+      @@password
+    end
 
-      # Sets the default WSSE password.
-      def password=(password)
-        @password = password.to_s if password.respond_to? :to_s
-      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
 
-      # Sets whether to use WSSE digest by default.
-      attr_writer :digest
+    # Global setting of whether to use WSSE digest.
+    @@digest = false
 
-      # Returns whether to use WSSE digest by default.
-      def digest?
-        @digest
-      end
+    # 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.
+    # 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 default.
+    # Returns the WSSE username. Defaults to the global setting.
     def username
       @username || self.class.username
     end
 
-    # Sets the WSSE password.
+    # 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 default.
+    # Returns the WSSE password. Defaults to the global setting.
     def password
       @password || self.class.password
     end
 
-    # Sets whether to use WSSE digest.
+    # Sets whether to use WSSE digest per request.
     attr_writer :digest
 
-    # Returns whether to use WSSE digest. Defaults to the global default. 
+    # 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 username
-    # and password are specified.
+    # Returns the XML for a WSSE header or an empty String unless both
+    # username and password were specified.
     def header
       return "" unless username && password