savon 0.6.7 → 0.6.8

data/CHANGELOG

@@ -1,11 +1,24 @@
-== 0.6.6 (2009-12-14)
-  * Default to use the name of the SOAP action (the method called in a client) in lowerCamelCase for SOAP action
-    and input when Savon::WSDL is disabled. You still need to specify soap.action and maybe soap.input in case
-    your SOAP actions are named any different.
+== 0.6.8 (2010-01-01)
+  * Improved specifications for various kinds of WSDL documents.
+  * Added support for SOAP endpoints which are different than the WSDL endpoint of a service.
+  * Changed how SOAP actions and inputs are retrieved from the WSDL documents. This might break a few existing
+    implementations, but makes Savon work well with even more services. If this change breaks your implementation,
+    please take a look at the +action+ and +input+ methods of the Savon::SOAP object.
+    One specific problem I know of is working with the createsend WSDL and its namespaced actions.
+    To make it work, call the SOAP action without namespace and specify the input manually:
+    client.get_api_key { |soap| soap.input = "User.GetApiKey" }
+
+== 0.6.7 (2009-12-18)
   * Implemented support for a proxy server. The proxy URI can be set through an optional Hash of options passed
     to instantiating Savon::Client (Dave Woodward <dave@futuremint.com>)
   * Implemented support for SSL client authentication. Settings can be set through an optional Hash of arguments
     passed to instantiating Savon::Client (colonhyphenp)
+  * Patch for issue #10 (Problem with operation tags without a namespace).
+
+== 0.6.6 (2009-12-14)
+  * Default to use the name of the SOAP action (the method called in a client) in lowerCamelCase for SOAP action
+    and input when Savon::WSDL is disabled. You still need to specify soap.action and maybe soap.input in case
+    your SOAP actions are named any different.
 
 == 0.6.5 (2009-12-13)
   * Added an open_timeout method to Savon::Request.

data/README.textile

@@ -2,17 +2,23 @@ h1. Savon
 
 h4. Heavy metal Ruby SOAP client library
 
+p. "RDoc":http://rdoc.info/projects/rubiii/savon | "Wiki":http://wiki.github.com/rubiii/savon | "ToDo":http://rubiii.tadalist.com/lists/1459816/public | "Metrics":http://getcaliper.com/caliper/project?repo=git://github.com/rubiii/savon.git
+
+h2. Installation
+
 bc. $ gem install savon
 
 p. Savon expects you to be familiar with SOAP, WSDL and tools like soapUI.
 
-h3. Instantiate a client
+h2. Instantiate a client
 
 p. Instantiate Savon::Client, passing in the WSDL of your service.
 
 bc. client = Savon::Client.new "http://example.com/UserService?wsdl"
 
-h3. Calling a SOAP action
+p. More information: "Client":http://wiki.github.com/rubiii/savon/client
+
+h2. Calling a SOAP action
 
 p. Assuming your service applies to the "Defaults":http://wiki.github.com/rubiii/savon/defaults, you can now call any available SOAP action.
 
@@ -20,7 +26,7 @@ bc. response = client.get_all_users
 
 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 WSDL object
+h2. The WSDL object
 
 p. Savon::WSDL represents the WSDL of your service, including information like the namespace URI and available SOAP actions.
 
@@ -29,7 +35,7 @@ bc. client.wsdl.soap_actions
 
 p. More information: "WSDL":http://wiki.github.com/rubiii/savon/wsdl
 
-h3. The SOAP object
+h2. The SOAP object
 
 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.
 
@@ -37,7 +43,7 @@ bc. response = client.get_user_by_id { |soap| soap.body = { :id => 666 } }
 
 p. More information: "SOAP":http://wiki.github.com/rubiii/savon/soap
 
-h3. The WSSE object
+h2. The WSSE object
 
 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.
 
@@ -49,34 +55,17 @@ end
 
 p. More information: "WSSE":http://wiki.github.com/rubiii/savon/wsse
 
-h3. SSL Client Authentication
-
-p. Savon::Client can accept SSL client certificates, as well as verify the validity of a server certificate.  Syntax inspired by Adam Wiggin's "Rest-Client":http://github.com/adamwiggins/rest-client
-
-bc. client = Savon::Client.new(
-  'https://example.org/wsdl',
-  :ssl_client_cert  =>  OpenSSL::X509::Certificate.new(File.read("client_cert.pem")),
-  :ssl_client_key   =>  OpenSSL::PKey::RSA.new(File.read("client_key.pem"), "password if one exists"),
-  :ssl_ca_file      =>  "cacert.pem",
-  :ssl_verify       =>  OpenSSL::SSL::VERIFY_PEER
-)
-
-h3. The Response object
+h2. The Response object
 
 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
 
-h3. HTTP errors and SOAP faults
+h2. HTTP errors and SOAP faults
 
 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
 
-h3. Logging
+h2. 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
-
-h3. Documentation
-
-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

@@ -1,9 +1,10 @@
 require "rubygems"
 require "rake"
 require "spec/rake/spectask"
+require "spec/rake/verify_rcov"
 require "rake/rdoctask"
 
-task :default => :spec
+task :default => :spec_verify_rcov
 
 Spec::Rake::SpecTask.new do |spec|
   spec.spec_files = FileList["spec/**/*_spec.rb"]
@@ -13,38 +14,14 @@ Spec::Rake::SpecTask.new do |spec|
   spec.rcov_dir = "rcov"
 end
 
+RCov::VerifyTask.new(:spec_verify_rcov => :spec) do |verify|
+  verify.threshold = 100.0
+  verify.index_html = "rcov/index.html"
+end
+
 Rake::RDocTask.new do |rdoc|
   rdoc.title = "Savon"
   rdoc.rdoc_dir = "rdoc"
   rdoc.rdoc_files.include("lib/**/*.rb")
   rdoc.options = ["--line-numbers", "--inline-source"]
 end
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |spec|
-    spec.name = "savon"
-    spec.author = "Daniel Harrington"
-    spec.email = "me@rubiii.com"
-    spec.homepage = "http://github.com/rubiii/savon"
-    spec.summary = "Heavy metal Ruby SOAP client library"
-    spec.description = spec.summary
-
-    spec.files = FileList["[A-Z]*", "{lib,spec}/**/*.{rb,xml}"]
-
-    spec.rdoc_options += [
-      "--title", "Savon",
-      "--line-numbers",
-      "--inline-source"
-    ]
-
-    spec.add_runtime_dependency("builder", ">= 2.1.2")
-    spec.add_runtime_dependency("crack", ">= 0.1.4")
-
-    spec.add_development_dependency("rspec", ">= 1.2.8")
-    spec.add_development_dependency("mocha", ">= 0.9.7")
-    spec.add_development_dependency("fakeweb", ">= 1.2.7")
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end

data/lib/savon.rb

@@ -23,11 +23,12 @@ end
 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 "savon/#{file}"
+  require File.dirname(__FILE__) + "/savon/#{file}"
 end

data/lib/savon/client.rb

@@ -21,7 +21,7 @@ module Savon
 
     # Expects a SOAP +endpoint+ String. Also accepts an optional Hash of
     # +options+ for specifying a proxy server and SSL client authentication.
-    def initialize(endpoint,options = {})
+    def initialize(endpoint, options = {})
       @request = Request.new endpoint, options
       @wsdl = WSDL.new @request
     end
@@ -49,8 +49,8 @@ module Savon
     def method_missing(method, *args, &block) #:doc:
       super if wsdl? && !@wsdl.respond_to?(method)
 
-      setup operation_from(method), &block
-      dispatch method
+      setup_objects operation_from(method), &block
+      Response.new @request.soap(@soap)
     end
 
     # Returns a SOAP operation Hash containing the SOAP action and input
@@ -60,32 +60,30 @@ module Savon
       { :action => method.to_soap_key, :input => method.to_soap_key }
     end
 
+    # Returns the SOAP endpoint.
+    def soap_endpoint
+      wsdl? ? @wsdl.soap_endpoint : @request.endpoint
+    end
+
     # Expects a SOAP operation Hash and sets up Savon::SOAP and Savon::WSSE.
     # Yields them to a given +block+ in case one was given.
-    def setup(operation, &block)
-      @soap = SOAP.new
-      @soap.action, @soap.input = operation[:action], operation[:input]
-      @wsse = WSSE.new
+    def setup_objects(operation, &block)
+      @soap, @wsse = SOAP.new, WSSE.new
+      @soap.action, @soap.input, @soap.endpoint = operation[:action], operation[:input], soap_endpoint
 
-      yield_parameters &block if block
+      yield_objects &block if block
 
       @soap.namespaces["xmlns:wsdl"] ||= @wsdl.namespace_uri if wsdl?
       @soap.wsse = @wsse
     end
 
     # Yields Savon::SOAP and Savon::WSSE to a given +block+.
-    def yield_parameters(&block)
+    def yield_objects(&block)
       case block.arity
         when 1 then yield @soap
         when 2 then yield @soap, @wsse
       end
     end
 
-    # Dispatches a given +soap_action+ and returns a Savon::Response instance.
-    def dispatch(soap_action)
-      response = @request.soap @soap
-      Response.new response
-    end
-
   end
 end

data/lib/savon/core_ext.rb

@@ -1,3 +1,3 @@
 %w(object string symbol datetime hash uri).each do |file|
-  require "savon/core_ext/#{file}"
+  require File.dirname(__FILE__) + "/core_ext/#{file}"
 end

data/lib/savon/core_ext/hash.rb

@@ -34,12 +34,9 @@ class Hash
       key = key.strip_namespace.snakecase.to_sym
 
       value = case value
-        when Hash
-          value["xsi:nil"] ? nil : value.map_soap_response
-        when Array
-          value.map { |a_value| a_value.map_soap_response rescue a_value }
-        when String
-          value.map_soap_response
+        when Hash   then value["xsi:nil"] ? nil : value.map_soap_response
+        when Array  then value.map { |a_value| a_value.map_soap_response rescue a_value }
+        when String then value.map_soap_response
       end
       hash.merge key => value
     end

data/lib/savon/request.rb

@@ -61,15 +61,11 @@ module Savon
     # Returns the proxy URI.
     attr_reader :proxy
 
-    # Sets the open timeout for HTTP requests.
-    def open_timeout=(sec)
-      http.open_timeout = sec
-    end
+    # Accessor for HTTP open timeout.
+    attr_accessor :open_timeout
 
-    # Sets the read timeout for HTTP requests.
-    def read_timeout=(sec)
-      http.read_timeout = sec
-    end
+    # Accessor for HTTP read timeout.
+    attr_accessor :read_timeout
 
     # Retrieves WSDL document and returns the Net::HTTPResponse.
     def wsdl
@@ -83,7 +79,7 @@ module Savon
       @soap = soap
 
       log_request
-      @response = http.request_post @endpoint.path, @soap.to_xml, http_header
+      @response = http(@soap.endpoint).request_post @soap.endpoint.path, @soap.to_xml, http_header
       log_response
       @response
     end
@@ -92,7 +88,7 @@ module Savon
 
     # Logs the SOAP request.
     def log_request
-      log "SOAP request: #{@endpoint}"
+      log "SOAP request: #{@soap.endpoint}"
       log http_header.map { |key, value| "#{key}: #{value}" }.join( ", " )
       log @soap.to_xml
     end
@@ -103,19 +99,29 @@ module Savon
       log @response.body
     end
 
-    # Returns a Net::HTTP instance.
-    def http
-      unless @http
-        @http ||= Net::HTTP::Proxy(@proxy.host, @proxy.port).new @endpoint.host, @endpoint.port
-        @http.use_ssl = true if @endpoint.ssl?
-        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        add_ssl_authentication if @ssl
-      end
+    # Returns a Net::HTTP instance for a given +endpoint+.
+    def http(endpoint = @endpoint)
+      @http = Net::HTTP::Proxy(@proxy.host, @proxy.port).new endpoint.host, endpoint.port
+      set_http_timeout
+      set_ssl_options endpoint.ssl?
+      set_ssl_authentication if @ssl
       @http
     end
 
-    # Adds SSL client authentication to the +@http+ instance.
-    def add_ssl_authentication
+    # Sets HTTP open and read timeout.
+    def set_http_timeout
+      @http.open_timeout = @open_timeout if @open_timeout
+      @http.read_timeout = @read_timeout if @read_timeout
+    end
+
+    # Sets basic SSL options to the +@http+ instance.
+    def set_ssl_options(use_ssl)
+      @http.use_ssl = use_ssl
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    # Sets SSL client authentication to the +@http+ instance.
+    def set_ssl_authentication
       @http.verify_mode = @ssl[:verify] if @ssl[:verify].kind_of? Integer
       @http.cert = @ssl[:client_cert] if @ssl[:client_cert]
       @http.key = @ssl[:client_key] if @ssl[:client_key]

data/lib/savon/soap.rb

@@ -27,23 +27,32 @@ module Savon
       @@version = version if Savon::SOAPVersions.include? version
     end
 
+    def initialize
+      @builder = Builder::XmlMarkup.new
+    end
+
     # Sets the WSSE options.
     attr_writer :wsse
 
-    # Accessor for the SOAP action.
+    # Sets the SOAP action.
     attr_writer :action
 
+    # Returns the SOAP action.
     def action
       @action ||= ""
     end
 
-    # Accessor for the SOAP input.
+    # 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.
     attr_writer :header
@@ -80,17 +89,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.tag!(:wsdl, *input_array) 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
@@ -98,19 +99,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] if input && !input.empty?
-      return [action.to_sym] if action && !action.empty?
+      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