savon 0.6.0 → 0.6.4

data/CHANGELOG

@@ -0,0 +1,56 @@
+== 0.6.4 (2009-12-13)
+  * Refactored specs to be less unit-like.
+  * Added a getter for the Savon::Request to Savon::Client and a read_timeout setter for HTTP requests.
+  * Replaced WSDL document with stream parsing.
+
+    Benchmarks (1000 SOAP calls):
+
+           user        system     total       real
+    0.6.4  72.180000   8.280000   80.460000   (750.799011)
+    0.6.3  192.900000  19.630000  212.530000  (914.031865)
+
+== 0.6.3 (2009-12-11)
+  * Removing 2 ruby deprecation warnings for parenthesized arguments. (Dave Woodward <dave@futuremint.com>)
+  * Added global and per request options for disabling Savon::WSDL.
+
+    Benchmarks (1000 SOAP calls):
+
+                   user        system     total       real
+    WSDL           192.900000  19.630000  212.530000  (914.031865)
+    disabled WSDL  5.680000    1.340000   7.020000    (298.265318)
+
+  * Improved XPath expressions for parsing the WSDL document.
+
+    Benchmarks (1000 SOAP calls):
+
+           user        system     total       real
+    0.6.3  192.900000  19.630000  212.530000  (914.031865)
+    0.6.2  574.720000  78.380000  653.100000  (1387.778539)
+
+== 0.6.2 (2009-12-06)
+  * Added support for changing the name of the SOAP input node.
+  * Added a CHANGELOG.
+
+== 0.6.1 (2009-12-06)
+  * Fixed a problem with WSSE credentials, where every request contained a WSSE authentication header.
+
+== 0.6.0 (2009-12-06)
+  * method_missing now yields the SOAP and WSSE objects to a given block.
+  * The response_process (which previously was a block passed to method_missing) was replaced by Savon::Response.
+  * Improved SOAP action handling (another problem that came up with issue #1).
+
+== 0.5.3 (2009-11-30)
+  * Patch for issue #2 (NoMethodError: undefined method `invalid!' for Savon::WSDL)
+
+== 0.5.2 (2009-11-30)
+  * Patch for issue #1 (Calls fail if api methods have periods in them)
+
+== 0.5.1 (2009-11-29)
+  * Optimized default response process.
+  * Added WSSE settings via defaults.
+  * Added SOAP fault and HTTP error handling.
+  * Improved documentation
+  * Added specs
+
+== 0.5.0 (2009-11-29)
+  * Complete rewrite.

data/README.textile

@@ -1,68 +1,70 @@
-h2. Savon
+h1. Savon
 
-p. Savon can be installed as a gem via:
+h4. Heavy metal Ruby SOAP client library
 
 bc. $ gem install savon
 
-h4. Dependencies
+p. Savon expects you to be familiar with SOAP, WSDL and tools like soapUI.
 
-bc. builder >= 2.1.2
-crack >= 0.1.4
+h3. Instantiate a client
 
-h2. Warning
+p. Instantiate Savon::Client, passing in the WSDL of your service.
 
-p. To use this heavy metal library, you should be familiar with SOAP, WSDL and tools like soapUI.
+bc. client = Savon::Client.new "http://example.com/UserService?wsdl"
 
-h2. Instantiate Savon::Client
+h3. Calling a SOAP action
 
-p. Instantiate a new instance of Savon::Client, passing in the WSDL of your service.
+p. Assuming your service applies to the "Defaults":http://wiki.github.com/rubiii/savon/defaults, you can now call any available SOAP action.
 
-bc. proxy = Savon::Client.new "http://example.com/UserService?wsdl"
+bc. response = client.get_all_users
 
-h2. The WSDL
-
-p. You can find out about the SOAP actions available on the webservice by using the WSDL object.
-
-bc. proxy.wsdl.soap_actions
-=> [:get_all_users, :get_user_by_id, :user_magic]
+p. Savon lets you call SOAP actions using snake_case, because even though they will propably be written in lowerCamelCase or CamelCase, it just feels much more natural.
 
-p. Find out more about the "WSDL":http://wiki.github.com/rubiii/savon/wsdl object.
+h3. The WSDL object
 
-h2. Calling a SOAP action
+p. Savon::WSDL represents the WSDL of your service, including information like the namespace URI and available SOAP actions.
 
-p. Now, assuming your service applies to the default "Options":http://wiki.github.com/rubiii/savon/options, you can just call any available SOAP action.
+bc. client.wsdl.soap_actions.keys
+=> [:get_all_users, :get_user_by_id, :user_magic]
 
-bc. response = proxy.get_all_users
+p. More information: "WSDL":http://wiki.github.com/rubiii/savon/wsdl
 
-p. Savon lets you call SOAP actions using snake_case, because even though they will propably be written in lowerCamelCase or CamelCase, it just feels much more natural.
+h3. The SOAP object
 
-h2. Parameters
+p. Savon::SOAP represents the SOAP request. Pass a block to your SOAP call and the SOAP object is passed to it as the first argument. The object allows setting the SOAP version, header, body and namespaces per request.
 
-p. Specifying parameters for the SOAP service, can be done by simply passing a Hash to the SOAP action.
+bc. response = client.get_user_by_id { |soap| soap.body = { :id => 666 } }
 
-bc. response = proxy.get_user_by_id :id => 666
+p. More information: "SOAP":http://wiki.github.com/rubiii/savon/soap
 
-p. Learn more about [[Parameters]].
+h3. The WSSE object
 
-h2. The response
+p. Savon::WSSE represents WSSE authentication. Pass a block to your SOAP call and the WSSE object is passed to it as the second argument. The object allows setting the WSSE username, password and whether to use digest authentication.
 
-p. By default, the SOAP response is translated into a Hash. Take a look at the "Options":http://wiki.github.com/rubiii/savon/options for more information.
+bc. response = client.get_user_by_id do |soap, wsse|
+  wsse.username = "gorilla"
+  wsse.password = "secret"
+  soap.body = { :id => 666 }
+end
 
-bc. proxy.get_user_by_id :id => 666
-=> { :user_response => { :id => "666", :username => "gorilla" } }
+p. More information: "WSSE":http://wiki.github.com/rubiii/savon/wsse
 
-h2. HTTP errors and SOAP faults
+h3. The Response object
 
-p. Savon raises a Savon::SOAPFault in case of a SOAP fault and a Savon::HTTPError in case of an HTTP error. More information about "Errors":http://wiki.github.com/rubiii/savon/errors.
+p. Savon::Response represents the HTTP and SOAP response. It contains and raises errors in case of an HTTP error or SOAP fault (unless disabled). Also you can get the response as XML (for parsing it with an XML library) or translated into a Hash.
+More information: "Response":http://wiki.github.com/rubiii/savon/response
 
-h2. Logging
+h3. HTTP errors and SOAP faults
 
-p. By default Savon logs each request and response to STDOUT. Specifying your own logger is as easy as it gets:
+p. Savon raises a Savon::SOAPFault in case of a SOAP fault and a Savon::HTTPError in case of an HTTP error.
+More information: "Errors":http://wiki.github.com/rubiii/savon/errors
 
-bc. Savon::Request.logger = RAILS_DEFAULT_LOGGER
+h3. Logging
 
-Read more about "Logging":http://wiki.github.com/rubiii/savon/logging.
+p. Savon logs each request and response to STDOUT. But there are a couple of options to change the default behaviour.
+More information: "Logging":http://wiki.github.com/rubiii/savon/logging
 
-h2. RDoc and Wiki
+h3. Documentation
 
-p. Further information: "Wiki":http://wiki.github.com/rubiii/savon and "RDoc":http://rdoc.info/projects/rubiii/savon
+p. Wiki: "wiki.github.com/rubiii/savon":http://wiki.github.com/rubiii/savon
+RDoc: "rdoc.info/projects/rubiii/savon":http://rdoc.info/projects/rubiii/savon

data/Rakefile

@@ -8,7 +8,7 @@ task :default => :spec
 Spec::Rake::SpecTask.new do |spec|
   spec.spec_files = FileList["spec/**/*_spec.rb"]
   spec.spec_opts << "--color"
-  spec.libs << "lib"
+  spec.libs += ["lib", "spec"]
   spec.rcov = true
   spec.rcov_dir = "rcov"
 end

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.4

data/lib/savon/client.rb

@@ -6,14 +6,30 @@ module Savon
   # with SOAP services and XML.
   class Client
 
+    # Defines whether to use Savon::WSDL.
+    @wsdl = true
+
+    class << self
+      # Accessor for whether to use Savon::WSDL.
+      attr_accessor :wsdl
+    end
+
     # Expects a SOAP +endpoint+ String.
     def initialize(endpoint)
       @request = Request.new endpoint
       @wsdl = WSDL.new @request
     end
 
-    # Returns the Savon::WSDL.
-    attr_reader :wsdl
+    # Accessor for Savon::WSDL.
+    attr_accessor :wsdl
+
+    # Returns the Savon::Request.
+    attr_reader :request
+
+    # Returns whether to use Savon::WSDL.
+    def wsdl?
+      self.class.wsdl && @wsdl
+    end
 
     # Returns +true+ for available methods and SOAP actions.
     def respond_to?(method)
@@ -25,7 +41,7 @@ module Savon
 
     # Dispatches requests to SOAP actions matching a given +method+ name.
     def method_missing(method, *args, &block) #:doc:
-      super unless @wsdl.respond_to? method
+      super if wsdl? && !@wsdl.respond_to?(method)
 
       setup method, &block
       dispatch method
@@ -34,12 +50,14 @@ module Savon
     # Expects a SOAP action and sets up Savon::SOAP and Savon::WSSE.
     # Yields them to a given +block+ in case one was given.
     def setup(soap_action, &block)
-      @soap = SOAP.new @wsdl.soap_actions[soap_action]
+      @soap = SOAP.new
+      @soap.action = @wsdl.operations[soap_action][:action] if wsdl?
+      @soap.input = @wsdl.operations[soap_action][:input] if wsdl?
       @wsse = WSSE.new
 
       yield_parameters &block if block
 
-      @soap.namespaces["xmlns:wsdl"] = @wsdl.namespace_uri
+      @soap.namespaces["xmlns:wsdl"] ||= @wsdl.namespace_uri if wsdl?
       @soap.wsse = @wsse
     end
 

data/lib/savon/core_ext/string.rb

@@ -33,7 +33,7 @@ class String
 
   # Translates SOAP response values to more convenient Ruby Objects.
   def map_soap_response
-    return DateTime.parse self if Savon::SOAPDateTimeRegexp === self
+    return DateTime.parse( self ) if Savon::SOAPDateTimeRegexp === self
     return true if self.strip.downcase == "true"
     return false if self.strip.downcase == "false"
     self

data/lib/savon/request.rb

@@ -45,6 +45,11 @@ module Savon
     # Returns the endpoint URI.
     attr_reader :endpoint
 
+    # Sets the read timeout for HTTP requests.
+    def read_timeout=(sec)
+      http.read_timeout = sec
+    end
+
     # Retrieves WSDL document and returns the Net::HTTPResponse.
     def wsdl
       log "Retrieving WSDL from: #{@endpoint}"
@@ -67,7 +72,7 @@ module Savon
     # Logs the SOAP request.
     def log_request
       log "SOAP request: #{@endpoint}"
-      log http_header.map { |key, value| "#{key}: #{value}" }.join ", "
+      log http_header.map { |key, value| "#{key}: #{value}" }.join( ", " )
       log @soap.to_xml
     end
 

data/lib/savon/response.rb

@@ -100,7 +100,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

@@ -29,17 +29,22 @@ module Savon
 
     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]
-    end
-
     # Sets the WSSE options.
     attr_writer :wsse
 
     # Accessor for the SOAP action.
-    attr_accessor :action
+    attr_writer :action
+
+    def action
+      @action ||= ""
+    end
+
+    # Accessor for the SOAP input.
+    attr_writer :input
+
+    def input
+      @input ||= ""
+    end
 
     # 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.
@@ -84,7 +89,7 @@ module Savon
             xml << (header.to_soap_xml rescue header.to_s) + wsse_header
           end
           xml.env(:Body) do
-            xml.wsdl(@input.to_sym) do
+            xml.tag!(:wsdl, *input_array) do
               xml << (@body.to_soap_xml rescue @body.to_s)
             end
           end
@@ -95,6 +100,15 @@ module Savon
 
   private
 
+    # 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] if input && !input.empty?
+      return [action.to_sym] if action && !action.empty?
+      []
+    end
+
     # Returns the WSSE header or an empty String in case WSSE was not set.
     def wsse_header
       return "" unless @wsse.respond_to? :header

data/lib/savon/wsdl.rb

@@ -2,74 +2,104 @@ 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.
+    # 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 +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
 
-    # Returns a REXML::Document of the WSDL.
-    def document
-      @document ||= REXML::Document.new wsdl_response.body
-    end
+  end
+
+  # Savon::WSDLStream
+  #
+  # Stream listener for parsing the WSDL document.
+  class WSDLStream
 
-    # Parses the WSDL for the namespace URI.
-    def parse_namespace_uri
-      definitions = document.elements["//wsdl:definitions"]
-      definitions.attributes["targetNamespace"] if definitions
+    # Initializer, sets an empty Hash of operations.
+    def initialize
+      @operations = {}
     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
+    # Returns the namespace URI from the WSDL document.
+    attr_reader :namespace_uri
 
-      wsdl_binding.elements.inject("//wsdl:operation", {}) do |hash, operation|
-        action = operation.elements["*:operation"].attributes["soapAction"] || ""
-        action = operation.attributes["name"] if action.empty?
+    # Returns the SOAP operations found in the WSDL document.
+    attr_reader :operations
+ 
+    # Hook method called when the stream parser encounters a tag.
+    def tag_start(name, attrs)
+      section_from name
+      @namespace_uri ||= attrs["targetNamespace"] if @section == :definitions
+      operation_from name, attrs if @section == :binding && /.+:operation/ === name
+    end
+
+    # Sets the current section of the WSDL document from a given tag +name+.
+    def section_from(name)
+      section = case name
+        when "wsdl:definitions" then :definitions
+        when "wsdl:types"       then :types
+        when "wsdl:message"     then :message
+        when "wsdl:portType"    then :port_type
+        when "wsdl:binding"     then :binding
+        when "wsdl:service"     then :service
+      end
+      @section = section if section
+    end
 
-        hash.merge action.split("/").last => action
+    # Stores available operations from a given tag +name+ and +attrs+.
+    def operation_from(name, attrs)
+      if name == "wsdl:operation"
+        @action = attrs["name"]
+      elsif /.+:operation/ === name
+        @action = attrs["soapAction"] if attrs["soapAction"] && !attrs["soapAction"].empty?
+        input = @action.split("/").last
+        @operations[input.snakecase.to_sym] = { :action => @action, :input => input }
       end
     end
 
+    # Catches calls to unimplemented hook methods.
+    def method_missing(method, *args)
+    end
+
   end
 end

data/lib/savon/wsse.rb

@@ -12,10 +12,10 @@ module Savon
     WSUNamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
 
     # Default WSSE username.
-    @username = ""
+    @username = nil
 
     # Default WSSE password.
-    @password = ""
+    @password = nil
 
     # Default for whether to use WSSE digest.
     @digest = false
@@ -28,6 +28,7 @@ module Savon
       # Sets the default WSSE username.
       def username=(username)
         @username = username.to_s if username.respond_to? :to_s
+        @username = nil if username.nil?
       end
 
       # Returns the default WSSE password.
@@ -36,6 +37,7 @@ module Savon
       # Sets the default WSSE password.
       def 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.
@@ -51,6 +53,7 @@ module Savon
     # Sets the WSSE username.
     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.
@@ -61,6 +64,7 @@ module Savon
     # Sets the WSSE password.
     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.

data/spec/fixtures/user_fixture.rb

@@ -1,9 +1,9 @@
 class UserFixture
 
   @namespace_uri = "http://v1_0.ws.user.example.com"
-  @soap_actions = {
-    :user_find_by_id => { :name => "User.FindById", :input => "User.FindById" },
-    :find_user => { :name => "findUser", :input => "findUser" }
+  @operations = {
+    :user_find_by_id => { :action => "User.FindById", :input => "User.FindById" },
+    :find_user => { :action => "findUser", :input => "findUser" }
   }
 
   @datetime_string = "2010-11-22T11:22:33"
@@ -24,9 +24,13 @@ class UserFixture
 
   class << self
 
-    attr_accessor :namespace_uri, :soap_actions,
+    attr_accessor :namespace_uri, :operations,
       :datetime_string, :datetime_object, :response_hash
 
+    def soap_actions
+      @operations.keys
+    end
+
     def user_wsdl
       load_fixture :user_wsdl
     end

data/spec/http_stubs.rb

@@ -2,24 +2,22 @@ require "fakeweb"
 
 FakeWeb.allow_net_connect = false
 
-# Register fake WSDL and SOAP request.
-FakeWeb.register_uri :get, SpecHelper.some_endpoint, :body => UserFixture.user_wsdl
-FakeWeb.register_uri :post, SpecHelper.soap_call_endpoint, :body => UserFixture.user_response
+# Some WSDL and SOAP request.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint, :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint, :body => UserFixture.user_response
 
-# Register fake WSDL and SOAP request with multiple "//return" nodes.
-FakeWeb.register_uri :get, SpecHelper.multiple_endpoint, :body => UserFixture.user_wsdl
-FakeWeb.register_uri :post, SpecHelper.soap_multiple_endpoint, :body => UserFixture.multiple_user_response
+# WSDL and SOAP request with multiple "//return" nodes.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:multiple), :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:multiple), :body => UserFixture.multiple_user_response
 
-# Register fake WSDL and SOAP request for a Savon::SOAPFault.
-FakeWeb.register_uri :get, SpecHelper.soapfault_endpoint, :body => UserFixture.user_wsdl
-FakeWeb.register_uri :post, SpecHelper.soap_soapfault_endpoint, :body => UserFixture.soap_fault
+# WSDL and SOAP request with a Savon::SOAPFault.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:soap_fault), :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:soap_fault), :body => UserFixture.soap_fault
 
-# Register fake WSDL and SOAP request for a Savon::HTTPError.
-FakeWeb.register_uri :get, SpecHelper.httperror_endpoint, :body => UserFixture.user_wsdl
-FakeWeb.register_uri :post, SpecHelper.soap_httperror_endpoint, :body => "",
-  :status => ["404", "Not Found"]
+# WSDL and SOAP request with a Savon::HTTPError.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:http_error), :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:http_error), :body => "", :status => ["404", "Not Found"]
 
-# Register fake WSDL and SOAP request for an invalid endpoint.
-FakeWeb.register_uri :get, SpecHelper.invalid_endpoint, :body => ""
-FakeWeb.register_uri :post, SpecHelper.soap_invalid_endpoint, :body => "",
-  :status => ["404", "Not Found"]
+# WSDL and SOAP request with an invalid endpoint.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:invalid), :body => ""
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:invalid), :body => "", :status => ["404", "Not Found"]