savon 0.6.3 → 0.6.4

data/CHANGELOG

@@ -1,10 +1,34 @@
+== 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>)
-  * Much faster XPath expressions for parsing the WSDL document.
   * 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)
-  * Support for changing the name of the SOAP input node.
+  * Added support for changing the name of the SOAP input node.
   * Added a CHANGELOG.
 
 == 0.6.1 (2009-12-06)
@@ -12,14 +36,14 @@
 
 == 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 the Savon::Response object.
-  * Improved SOAP action handling (another problem that came up with Issue #1).
+  * 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)
-  * Fix for Issue #2 (NoMethodError: undefined method `invalid!' for Savon::WSDL)
+  * 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)
+  * Patch for issue #1 (Calls fail if api methods have periods in them)
 
 == 0.5.1 (2009-11-29)
   * Optimized default response process.
@@ -29,4 +53,4 @@
   * Added specs
 
 == 0.5.0 (2009-11-29)
-  * Complete rewrite.
+  * Complete rewrite.

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.3
+0.6.4

data/lib/savon/client.rb

@@ -23,6 +23,9 @@ module Savon
     # 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
@@ -47,7 +50,9 @@ 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? ? @wsdl.soap_actions[soap_action] : nil)
+      @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

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}"

data/lib/savon/soap.rb

@@ -29,21 +29,23 @@ module Savon
 
     end
 
-    # Expects a Hash containing the name of the SOAP action and input.
-    def initialize(action = nil)
-      @action = action.kind_of?(Hash) ? action[:name] : ""
-      @input = action.kind_of?(Hash) ? action[: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.
     attr_writer :header
@@ -102,8 +104,8 @@ module Savon
     # 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?
+      return [input.to_sym] if input && !input.empty?
+      return [action.to_sym] if action && !action.empty?
       []
     end
 

data/lib/savon/wsdl.rb

@@ -2,68 +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 ||= document.root.attributes["targetNamespace"] || ""
+      @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
+
+  # Savon::WSDLStream
+  #
+  # Stream listener for parsing the WSDL document.
+  class WSDLStream
+
+    # 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:definitions/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/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"]

data/spec/savon/client_spec.rb

@@ -1,69 +1,68 @@
 require "spec_helper"
 
 describe Savon::Client do
-  before { @client = some_client_instance }
+  before { @client = Savon::Client.new EndpointHelper.wsdl_endpoint }
 
-  def some_client_instance
-    Savon::Client.new SpecHelper.some_endpoint
+  it "is initialized with a SOAP endpoint String" do
+    Savon::Client.new EndpointHelper.wsdl_endpoint
   end
 
-  describe "initialize" do
-    it "expects a SOAP endpoint String" do
-      some_client_instance
-    end
+  it "raises an ArgumentError when initialized with an invalid endpoint" do
+    lambda { Savon::Client.new "invalid" }.should raise_error ArgumentError
+  end
 
-    it "raises an ArgumentError in case of an invalid endpoint" do
-      lambda { Savon::Client.new "invalid" }.should raise_error ArgumentError
-    end
+  it "has a getter for accessing the Savon::WSDL" do
+    @client.wsdl.should be_a Savon::WSDL
   end
 
-  describe "wsdl" do
-    it "returns the Savon::WSDL" do
-      @client.wsdl.should be_a Savon::WSDL
-    end
+  it "has a getter for accessing the Savon::Request" do
+    @client.request.should be_a Savon::Request
   end
 
-  describe "respond_to?" do
-    it "returns true for available SOAP actions" do
-      @client.respond_to?(UserFixture.soap_actions.keys.first).
-        should be_true
-    end
+  it "has a getter for returning whether to use the Savon::WSDL (global setting)" do
+    @client.wsdl?.should be_true
 
-    it "still behaves like usual otherwise" do
-      @client.respond_to?(:object_id).should be_true
-      @client.respond_to?(:some_undefined_method).should be_false
-    end
+    Savon::Client.wsdl = false
+    @client.wsdl?.should be_false
+    Savon::Client.wsdl = true
+
+    @client.wsdl = false
+    @client.wsdl?.should be_false
   end
 
-  describe "method_missing" do
-    it "dispatches SOAP requests for available SOAP actions" do
-      @client.find_user.should be_a Savon::Response
-    end
+  it "responds to SOAP actions while still behaving as usual otherwise" do
+    @client.respond_to?(UserFixture.soap_actions.first).should be_true
+    @client.respond_to?(:object_id).should be_true
+    @client.respond_to?(:some_undefined_method).should be_false
+  end
 
-    it "raises a Savon::SOAPFault in case of a SOAP fault" do
-      client = Savon::Client.new SpecHelper.soapfault_endpoint
-      lambda { client.find_user }.should raise_error Savon::SOAPFault
-    end
+  it "dispatches SOAP calls via method_missing and returns the Savon::Response" do
+    @client.find_user.should be_a Savon::Response
+  end
 
-    it "raises a Savon::HTTPError in case of an HTTP error" do
-      client = Savon::Client.new SpecHelper.httperror_endpoint
-      lambda { client.find_user }.should raise_error Savon::HTTPError
-    end
+  it "raises a Savon::SOAPFault in case of a SOAP fault" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint(:soap_fault)
+    lambda { client.find_user }.should raise_error Savon::SOAPFault
+  end
 
-    it "yields the SOAP object to a block that expects one argument" do
-      @client.find_user { |soap| soap.should be_a Savon::SOAP }
-    end
+  it "raises a Savon::HTTPError in case of an HTTP error" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint(:http_error)
+    lambda { client.find_user }.should raise_error Savon::HTTPError
+  end
 
-    it "yields the SOAP and WSSE object to a block that expects two argument" do
-      @client.find_user do |soap, wsse|
-        soap.should be_a Savon::SOAP
-        wsse.should be_a Savon::WSSE
-      end
-    end
+  it "yields the SOAP object to a block when it expects one argument" do
+    @client.find_user { |soap| soap.should be_a Savon::SOAP }
+  end
 
-    it "still raises a NoMethodError for undefined methods" do
-      lambda { @client.some_undefined_method }.should raise_error NoMethodError
+  it "yields the SOAP and WSSE object to a block when it expects two argument" do
+    @client.find_user do |soap, wsse|
+      soap.should be_a Savon::SOAP
+      wsse.should be_a Savon::WSSE
     end
   end
 
-end
+  it "still raises a NoMethodError for undefined methods" do
+    lambda { @client.some_undefined_method }.should raise_error NoMethodError
+  end
+
+end