savon 0.6.0 → 0.6.3

data/CHANGELOG

@@ -0,0 +1,32 @@
+== 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.
+
+== 0.6.2 (2009-12-06)
+  * 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 the Savon::Response object.
+  * 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)
+
+== 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/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.3

data/lib/savon/client.rb

@@ -6,14 +6,27 @@ 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 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 +38,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 +47,12 @@ 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(wsdl? ? @wsdl.soap_actions[soap_action] : nil)
       @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

@@ -67,7 +67,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,10 +29,10 @@ 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]
+    # 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.
@@ -41,6 +41,9 @@ module Savon
     # Accessor for the SOAP action.
     attr_accessor :action
 
+    # Accessor for the SOAP input.
+    attr_writer :input
+
     # 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
@@ -84,7 +87,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 +98,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

@@ -12,7 +12,7 @@ module Savon
 
     # Returns the namespace URI from the WSDL.
     def namespace_uri
-      @namespace_uri ||= parse_namespace_uri
+      @namespace_uri ||= document.root.attributes["targetNamespace"] || ""
     end
 
     # Returns a Hash of available SOAP actions mapped to snake_case (keys)
@@ -51,19 +51,13 @@ module Savon
       @document ||= REXML::Document.new wsdl_response.body
     end
 
-    # Parses the WSDL for the namespace URI.
-    def parse_namespace_uri
-      definitions = document.elements["//wsdl:definitions"]
-      definitions.attributes["targetNamespace"] if definitions
-    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"]
+      wsdl_binding = document.elements["wsdl:definitions/wsdl:binding"]
       return {} unless wsdl_binding
 
-      wsdl_binding.elements.inject("//wsdl:operation", {}) do |hash, operation|
+      wsdl_binding.elements.inject("wsdl:operation", {}) do |hash, operation|
         action = operation.elements["*:operation"].attributes["soapAction"] || ""
         action = operation.attributes["name"] if action.empty?
 

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/savon/soap_spec.rb

@@ -60,6 +60,12 @@ describe Savon::SOAP do
     end
   end
 
+  describe "input" do
+    it "sets the name of the SOAP input node" do
+      @soap.input = "FindUserRequest"
+    end
+  end
+
   describe "header" do
     it "is an accessor for the SOAP header" do
       @soap.header.should be_a Hash
@@ -137,4 +143,4 @@ describe Savon::SOAP do
     end
   end
 
-end
+end

data/spec/savon/wsse_spec.rb

@@ -2,9 +2,12 @@ require "spec_helper"
 
 describe Savon::WSSE do
   before do
+    Savon::WSSE.username = nil
+    Savon::WSSE.password = nil
+    Savon::WSSE.digest = false
+
     @wsse = Savon::WSSE.new
-    @username = "gorilla"
-    @password = "secret"
+    @username, @password = "gorilla", "secret"
   end
 
   describe "WSENamespace" do
@@ -22,28 +25,24 @@ describe Savon::WSSE do
   end
 
   describe "@username" do
-    it "defaults to an empty String" do
-      Savon::WSSE.username.should be_a String
-      Savon::WSSE.username.should be_empty
+    it "defaults to nil" do
+      Savon::WSSE.username.should be_nil
     end
 
     it "has accessor methods" do
       Savon::WSSE.username = "gorilla"
       Savon::WSSE.username.should == "gorilla"
-      Savon::WSSE.username = ""
     end
   end
 
   describe "@password" do
-    it "defaults to an empty String" do
-      Savon::WSSE.password.should be_a String
-      Savon::WSSE.password.should be_empty
+    it "defaults to nil" do
+      Savon::WSSE.password.should be_nil
     end
 
     it "has accessor methods" do
       Savon::WSSE.password = "secret"
       Savon::WSSE.password.should == "secret"
-      Savon::WSSE.password = ""
     end
   end
 
@@ -55,33 +54,28 @@ describe Savon::WSSE do
     it "has accessor methods" do
       Savon::WSSE.digest = true
       Savon::WSSE.digest?.should == true
-      Savon::WSSE.digest = false
     end
   end
 
   describe "username" do
-    it "defaults to an empty String" do
-      @wsse.username.should be_a String
-      @wsse.username.should be_empty
+    it "defaults to nil" do
+      @wsse.username.should be_nil
     end
 
     it "has accessor methods" do
       @wsse.username = "gorilla"
       @wsse.username.should == "gorilla"
-      @wsse.username = nil
     end
   end
 
   describe "password" do
-    it "defaults to an empty String" do
-      @wsse.password.should be_a String
-      @wsse.password.should be_empty
+    it "defaults to nil" do
+      @wsse.password.should be_nil
     end
 
     it "has accessor methods" do
       @wsse.password = "secret"
       @wsse.password.should == "secret"
-      @wsse.password = nil
     end
   end
 
@@ -93,7 +87,6 @@ describe Savon::WSSE do
     it "has accessor methods" do
       @wsse.digest = true
       @wsse.digest?.should == true
-      @wsse.digest = false
     end
   end
 
@@ -117,9 +110,6 @@ describe Savon::WSSE do
         header.should include_security_namespaces
         header.should include @username
         header.should include @password
-
-        Savon::WSSE.username = ""
-        Savon::WSSE.password = ""
       end
     end
 
@@ -155,4 +145,4 @@ describe Savon::WSSE do
     end
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: savon
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.3
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 +01:00
+date: 2009-12-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- CHANGELOG
 - README.textile
 - Rakefile
 - VERSION
@@ -142,20 +143,20 @@ signing_key:
 specification_version: 3
 summary: Heavy metal Ruby SOAP client library
 test_files: 
-- spec/fixtures/user_fixture.rb
-- spec/http_stubs.rb
+- spec/spec_helper.rb
+- spec/savon/response_spec.rb
+- spec/savon/savon_spec.rb
+- spec/savon/wsdl_spec.rb
+- spec/savon/request_spec.rb
 - spec/savon/client_spec.rb
-- spec/savon/core_ext/datetime_spec.rb
+- spec/savon/soap_spec.rb
+- spec/savon/core_ext/symbol_spec.rb
 - spec/savon/core_ext/hash_spec.rb
-- spec/savon/core_ext/object_spec.rb
 - spec/savon/core_ext/string_spec.rb
-- spec/savon/core_ext/symbol_spec.rb
+- spec/savon/core_ext/datetime_spec.rb
+- spec/savon/core_ext/object_spec.rb
 - spec/savon/core_ext/uri_spec.rb
-- spec/savon/request_spec.rb
-- spec/savon/response_spec.rb
-- spec/savon/savon_spec.rb
-- spec/savon/soap_spec.rb
-- spec/savon/wsdl_spec.rb
 - spec/savon/wsse_spec.rb
-- spec/spec_helper.rb
 - spec/spec_helper_methods.rb
+- spec/http_stubs.rb
+- spec/fixtures/user_fixture.rb