savon 2.0.3 → 2.1.0

data/.gitignore

@@ -1,3 +1,4 @@
+.rvmrc
 .DS_Store
 .yardoc
 doc

data/CHANGELOG.md

@@ -1,9 +1,41 @@
-## 2.0.3 (2013-01-19)
+### 2.1.0 (2013-02-03)
+
+* Feature: [#372](https://github.com/savonrb/savon/pull/372) added global `ssl_cert_key_password` option.
+
+* Feature: [#361](https://github.com/savonrb/savon/issues/361) added the local `:attributes`
+  option to allow adding XML attributes to the SOAP message tag.
+
+* Improvement: [#363](https://github.com/savonrb/savon/issues/363) Savon 2.0 remembers the cookies from
+  the last response and passes it to the next request, which is not a proper way to handle cookies.
+  I removed this behavior and introduced an easy way to handle cookies manually instead.
+
+* Improvement: [#380](https://github.com/savonrb/savon/pull/380) changed the gemspec to not rely on git.
+
+* Fix: [#378](https://github.com/savonrb/savon/pull/378) use the proxy option for WSDL requests.
+
+* Fix: [#369](https://github.com/savonrb/savon/pull/369) use HTTP basic and digest authentication
+  credentials to retrieve WSDL files.
+  Fixes [#367](https://github.com/savonrb/savon/issues/367#issuecomment-12720307).
+
+* Fix: [#349](https://github.com/savonrb/savon/issues/349) global timeout and SSL options are
+  now used to retrieve a remote WSDL document.
+
+* Fix: [#353](https://github.com/savonrb/savon/issues/353) simplified logging. the global `:log`
+  option is now only used to store whether Savon should log instead of creating a new `Logger`
+  and changing its logdev to `$stdout` or `/dev/null` depending on the what was passed.
+
+  This also fixes [rubiii/savon#2](https://github.com/rubiii/savon/issues/2) and
+  [#379](https://github.com/savonrb/savon/issues/379).
+
+* Fix: [#376](https://github.com/savonrb/savon/issues/376) added a global `namespaces` option
+  for adding namespaces to the SOAP envelope.
+
+### 2.0.3 (2013-01-19)
 
 * Upgraded Nori dependency to prevent people from using a version that is vulnerable to
   the recent [remote code execution bug](https://gist.github.com/4532291).
 
-## 2.0.2 (2012-12-20)
+### 2.0.2 (2012-12-20)
 
 * Fix: [#297](https://github.com/savonrb/savon/issues/297#issuecomment-11536517) added the global
   `:ssl_verify_mode` and `:ssl_version` options which were missing.
@@ -11,13 +43,13 @@
 * Fix: [#344](https://github.com/savonrb/savon/issues/344) added missing global ssl cert options
   `:ssl_cert_file`, `:ssl_cert_key_file` and `:ssl_ca_cert_file`.
 
-## 2.0.1 (2012-12-19)
+### 2.0.1 (2012-12-19)
 
 * Fix [#342](https://github.com/savonrb/savon/issues/342) fixes an issue where namespaces could
   not be resolved if the actual operation name to call did not match the operation name passed
   to the client's `#call` method. For example: `:get_stations` for a `getStations` operation.
 
-## 2.0.0 (2012-12-18)
+### 2.0.0 (2012-12-18)
 
 * Read about all the changes in the [updated documentation](http://savonrb.com/version2.html).
 
@@ -32,7 +64,7 @@
 
 * Fix: [321](https://github.com/savonrb/savon/issues/321) preserve `[false]` values in Hashes.
 
-## 1.2.0 (2012-09-15)
+### 1.2.0 (2012-09-15)
 
 * Fix: [#312](https://github.com/savonrb/savon/pull/312) recursively determines the proper namespaces
   for SOAP body Hashes with nested Arrays of Hashes.
@@ -42,7 +74,7 @@
 
 * Refactoring: Use the `Wasabi::Document` with resolver instead of the custom `Savon::Wasabi::Document`.
 
-## 1.1.0 (2012-06-28)
+### 1.1.0 (2012-06-28)
 
 * Improvement: Changed Savon's core dependencies to be more strict and only allow bug fix changes.
   Major or minor releases of these dependencies now need a release of Savon so they can be used.

data/Gemfile

@@ -2,3 +2,4 @@ source :rubygems
 gemspec
 
 gem "httpclient", "~> 2.3.0"
+gem "simplecov", :require => false, :group => :test

data/lib/savon.rb

@@ -1,8 +1,8 @@
 module Savon
 
-  class Error < RuntimeError; end
-  class InitializationError < Error; end
-  class InvalidResponseError < Error; end
+  Error                = Class.new(RuntimeError)
+  InitializationError  = Class.new(Error)
+  InvalidResponseError = Class.new(Error)
 
   def self.client(globals = {}, &block)
     Client.new(globals, &block)

data/lib/savon/builder.rb

@@ -30,7 +30,7 @@ module Savon
     def to_s
       return @locals[:xml] if @locals.include? :xml
 
-      tag(builder, :Envelope, namespaces) do |xml|
+      tag(builder, :Envelope, namespaces_with_globals) do |xml|
         tag(xml, :Header) { xml << header.to_s } unless header.empty?
         tag(xml, :Body)   { xml.tag!(*namespaced_message_tag) { xml << message.to_s } }
       end
@@ -65,6 +65,10 @@ module Savon
       [path, identifier]
     end
 
+    def namespaces_with_globals
+      namespaces.merge @globals[:namespaces]
+    end
+
     def namespaces
       @namespaces ||= begin
         namespaces = SCHEMA_TYPES.dup
@@ -87,8 +91,11 @@ module Savon
     end
 
     def namespaced_message_tag
-      return [namespace_identifier, message_tag] unless @used_namespaces[[@operation_name.to_s]]
-      [@used_namespaces[[@operation_name.to_s]], message_tag]
+      if @used_namespaces[[@operation_name.to_s]]
+        [@used_namespaces[[@operation_name.to_s]], message_tag, message_attributes]
+      else
+        [namespace_identifier, message_tag, message_attributes]
+      end
     end
 
     def message_tag
@@ -99,6 +106,10 @@ module Savon
       @message_tag = message_tag.to_sym
     end
 
+    def message_attributes
+      @locals[:attributes] || {}
+    end
+
     def message
       element_form_default = @globals[:element_form_default] || @wsdl.element_form_default
       # TODO: clean this up! [dh, 2012-12-17]

data/lib/savon/client.rb

@@ -1,4 +1,5 @@
 require "savon/operation"
+require "savon/request"
 require "savon/options"
 require "savon/block_interface"
 require "wasabi"
@@ -7,6 +8,10 @@ module Savon
   class Client
 
     def initialize(globals = {}, &block)
+      unless globals.kind_of? Hash
+        raise_version1_initialize_error! globals
+      end
+
       @globals = GlobalOptions.new(globals)
 
       BlockInterface.new(@globals).evaluate(block) if block
@@ -15,10 +20,7 @@ module Savon
         raise_initialization_error!
       end
 
-      @wsdl = Wasabi::Document.new
-      @wsdl.document  = @globals[:wsdl]      if @globals.include? :wsdl
-      @wsdl.endpoint  = @globals[:endpoint]  if @globals.include? :endpoint
-      @wsdl.namespace = @globals[:namespace] if @globals.include? :namespace
+      build_wsdl_document
     end
 
     attr_reader :globals
@@ -33,21 +35,32 @@ module Savon
     end
 
     def call(operation_name, locals = {}, &block)
-      response = operation(operation_name).call(locals, &block)
-      persist_last_response(response)
-      response
+      operation(operation_name).call(locals, &block)
     end
 
     private
 
-    def persist_last_response(response)
-      @globals[:last_response] = response.http
+    def build_wsdl_document
+      @wsdl = Wasabi::Document.new
+
+      @wsdl.document  = @globals[:wsdl]      if @globals.include? :wsdl
+      @wsdl.endpoint  = @globals[:endpoint]  if @globals.include? :endpoint
+      @wsdl.namespace = @globals[:namespace] if @globals.include? :namespace
+
+      @wsdl.request = WSDLRequest.new(@globals).build
     end
 
     def wsdl_or_endpoint_and_namespace_specified?
       @globals.include?(:wsdl) || (@globals.include?(:endpoint) && @globals.include?(:namespace))
     end
 
+    def raise_version1_initialize_error!(object)
+      raise InitializationError,
+        "Some code tries to initialize Savon with the #{object.inspect} (#{object.class}) \n" \
+        "Savon 2 expects a Hash of options for creating a new client and executing requests.\n" \
+        "Please read the updated documentation for version 2: http://savonrb.com/version2.html"
+    end
+
     def raise_initialization_error!
       raise InitializationError,
             "Expected either a WSDL document or the SOAP endpoint and target namespace options.\n\n" \

data/lib/savon/operation.rb

@@ -2,6 +2,8 @@ require "savon/options"
 require "savon/block_interface"
 require "savon/request"
 require "savon/builder"
+require "savon/response"
+require "savon/log_message"
 
 module Savon
   class Operation
@@ -41,10 +43,9 @@ module Savon
       BlockInterface.new(@locals).evaluate(block) if block
 
       builder = Builder.new(@name, @wsdl, @globals, @locals)
-      request = Request.new(@name, @wsdl, @globals, @locals)
 
       response = Savon.notify_observers(@name, builder, @globals, @locals)
-      response ||= request.call(builder.to_s)
+      response ||= call! build_request(builder)
 
       raise_expected_httpi_response! unless response.kind_of?(HTTPI::Response)
 
@@ -53,6 +54,73 @@ module Savon
 
     private
 
+    def call!(request)
+      log_request(request) if log?
+      response = HTTPI.post(request)
+      log_response(response) if log?
+
+      response
+    end
+
+    def build_request(builder)
+      request = SOAPRequest.new(@globals).build(
+        :soap_action => soap_action,
+        :cookies     => @locals[:cookies]
+      )
+
+      request.url = endpoint
+      request.body = builder.to_s
+
+      # TODO: could HTTPI do this automatically in case the header
+      #       was not specified manually? [dh, 2013-01-04]
+      request.headers["Content-Length"] = request.body.bytesize.to_s
+
+      request
+    end
+
+    def soap_action
+      # soap_action explicitly set to something falsy
+      return if @locals.include?(:soap_action) && !@locals[:soap_action]
+
+      # get the soap_action from local options
+      soap_action = @locals[:soap_action]
+      # with no local option, but a wsdl, ask it for the soap_action
+      soap_action ||= @wsdl.soap_action(@name.to_sym) if @wsdl.document?
+      # if there is no soap_action up to this point, fallback to a simple default
+      soap_action ||= Gyoku.xml_tag(@name, :key_converter => @globals[:convert_request_keys_to])
+    end
+
+    def endpoint
+      @globals[:endpoint] || @wsdl.endpoint
+    end
+
+    def log_request(request)
+      logger.info  "SOAP request: #{request.url}"
+      logger.info  headers_to_log(request.headers)
+      logger.debug body_to_log(request.body)
+    end
+
+    def log_response(response)
+      logger.info  "SOAP response (status #{response.code})"
+      logger.debug body_to_log(response.body)
+    end
+
+    def headers_to_log(headers)
+      headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+    end
+
+    def body_to_log(body)
+      LogMessage.new(body, @globals[:filters], @globals[:pretty_print_xml]).to_s
+    end
+
+    def logger
+      @globals[:logger]
+    end
+
+    def log?
+      @globals[:log]
+    end
+
     def raise_expected_httpi_response!
       raise Error, "Observers need to return an HTTPI::Response to mock " \
                    "the request or nil to execute the request."

data/lib/savon/options.rb

@@ -38,7 +38,9 @@ module Savon
       defaults = {
         :encoding                  => "UTF-8",
         :soap_version              => 1,
+        :namespaces                => {},
         :logger                    => Logger.new($stdout),
+        :log                       => true,
         :filters                   => [],
         :pretty_print_xml          => false,
         :raise_errors              => true,
@@ -48,14 +50,12 @@ module Savon
 
       options = defaults.merge(options)
 
-      # these options are shortcuts on the logger which needs to be set
-      # before it can be modified to set these options.
-      delayed_log = options.delete(:log)
+      # this option is a shortcut on the logger which needs to be set
+      # before it can be modified to set the option.
       delayed_level = options.delete(:log_level)
 
       super(options)
 
-      log(delayed_log) unless delayed_log.nil?
       log_level(delayed_level) unless delayed_level.nil?
     end
 
@@ -79,6 +79,11 @@ module Savon
       @options[:namespace_identifier] = identifier
     end
 
+    # Namespaces for the SOAP envelope.
+    def namespaces(namespaces)
+      @options[:namespaces] = namespaces
+    end
+
     # Proxy server to use for all requests.
     def proxy(proxy)
       @options[:proxy] = proxy
@@ -135,16 +140,8 @@ module Savon
 
     # Whether or not to log.
     def log(log)
-      if log
-        HTTPI.log = true
-        target = $stdout
-      else
-        HTTPI.log = false
-        windows = RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i
-        target = windows ? "NUL:" : "/dev/null"
-      end
-
-      @options[:logger] = Logger.new(target)
+      HTTPI.log = log
+      @options[:log] = log
     end
 
     # The logger to use. Defaults to a Savon::Logger instance.
@@ -174,12 +171,6 @@ module Savon
       @options[:pretty_print_xml] = pretty_print_xml
     end
 
-    # Used by Savon to store the last response to pass
-    # its cookies to the next request.
-    def last_response(last_response)
-      @options[:last_response] = last_response
-    end
-
     # Specifies the SSL version to use.
     def ssl_version(version)
       @options[:ssl_version] = version
@@ -195,6 +186,11 @@ module Savon
       @options[:ssl_cert_key_file] = file
     end
 
+    # Sets the cert key password to use.
+    def ssl_cert_key_password(password)
+      @options[:ssl_cert_key_password] = password
+    end
+
     # Sets the cert file to use.
     def ssl_cert_file(file)
       @options[:ssl_cert_file] = file
@@ -266,11 +262,21 @@ module Savon
       @options[:message_tag] = message_tag
     end
 
+    # Attributes for the SOAP message tag.
+    def attributes(attributes)
+      @options[:attributes] = attributes
+    end
+
     # Value of the SOAPAction HTTP header.
     def soap_action(soap_action)
       @options[:soap_action] = soap_action
     end
 
+    # Cookies to be used for the next request.
+    def cookies(cookies)
+      @options[:cookies] = cookies
+    end
+
     # The SOAP request XML to send. Expected to be a String.
     def xml(xml)
       @options[:xml] = xml

data/lib/savon/qualified_message.rb

@@ -11,7 +11,7 @@ module Savon
 
     def to_hash(hash, path)
       return unless hash
-      return hash.map { |value| add_namespaces_to_body(value, path) } if hash.kind_of?(Array)
+      return hash.map { |value| to_hash(value, path) } if hash.kind_of?(Array)
       return hash.to_s unless hash.kind_of? Hash
 
       hash.inject({}) do |newhash, (key, value)|
@@ -21,7 +21,7 @@ module Savon
         if @used_namespaces[newpath]
           newhash.merge(
             "#{@used_namespaces[newpath]}:#{translated_key}" =>
-              add_namespaces_to_body(value, @types[newpath] ? [@types[newpath]] : newpath)
+              to_hash(value, @types[newpath] ? [@types[newpath]] : newpath)
           )
         else
           add_namespaces_to_values(value, path) if key == :order!
@@ -32,10 +32,6 @@ module Savon
 
     private
 
-    def add_namespaces_to_body(value, path)
-      QualifiedMessage.new(@types, @used_namespaces, @key_converter).to_hash(value, path)
-    end
-
     def add_namespaces_to_values(values, path)
       values.collect! { |value|
         camelcased_value = Gyoku.xml_tag(value, :key_converter => @key_converter)

data/lib/savon/request.rb

@@ -1,114 +1,87 @@
 require "httpi"
-require "savon/response"
-require "savon/log_message"
 
 module Savon
-  class Request
+  class HTTPRequest
 
-    CONTENT_TYPE = {
-      1 => "text/xml;charset=%s",
-      2 => "application/soap+xml;charset=%s"
-    }
-
-    def initialize(operation_name, wsdl, globals, locals)
-      @operation_name = operation_name
-
-      @wsdl    = wsdl
+    def initialize(globals, http_request = nil)
       @globals = globals
-      @locals  = locals
-      @http    = create_http_client
+      @http_request = http_request || HTTPI::Request.new
     end
 
-    attr_reader :http
-
-    def call(xml)
-      @http.body = xml
-      @http.headers["Content-Length"] = xml.bytesize.to_s
-
-      log_request @http.url, @http.headers, @http.body
-      response = HTTPI.post(@http)
-      log_response response.code, response.body
-
-      response
+    def build
+      @http_request
     end
 
     private
 
-    def create_http_client
-      http = HTTPI::Request.new
-
-      configure_request(http)
-      configure_timeouts(http)
-      configure_headers(http)
-      configure_ssl(http)
-      configure_auth(http)
-
-      http
+    def configure_proxy
+      @http_request.proxy = @globals[:proxy] if @globals.include? :proxy
     end
 
-    def configure_request(http)
-      http.url = @globals[:endpoint] || @wsdl.endpoint
-      http.proxy = @globals[:proxy] if @globals.include? :proxy
-      http.set_cookies @globals[:last_response] if @globals.include? :last_response
+    def configure_timeouts
+      @http_request.open_timeout = @globals[:open_timeout] if @globals.include? :open_timeout
+      @http_request.read_timeout = @globals[:read_timeout] if @globals.include? :read_timeout
     end
 
-    def configure_timeouts(http)
-      http.open_timeout = @globals[:open_timeout] if @globals.include? :open_timeout
-      http.read_timeout = @globals[:read_timeout] if @globals.include? :read_timeout
+    def configure_ssl
+      @http_request.auth.ssl.ssl_version   = @globals[:ssl_version]       if @globals.include? :ssl_version
+      @http_request.auth.ssl.verify_mode   = @globals[:ssl_verify_mode]   if @globals.include? :ssl_verify_mode
+
+      @http_request.auth.ssl.cert_key_file = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
+      @http_request.auth.ssl.cert_file     = @globals[:ssl_cert_file]     if @globals.include? :ssl_cert_file
+      @http_request.auth.ssl.ca_cert_file  = @globals[:ssl_ca_cert_file]  if @globals.include? :ssl_ca_cert_file
+
+      @http_request.auth.ssl.cert_key_password = @globals[:ssl_cert_key_password] if @globals.include? :ssl_cert_key_password
     end
 
-    def configure_headers(http)
-      http.headers = @globals[:headers] if @globals.include? :headers
-      http.headers["SOAPAction"] ||= %{"#{soap_action}"} if soap_action
-      http.headers["Content-Type"] = CONTENT_TYPE[@globals[:soap_version]] % @globals[:encoding]
+    def configure_auth
+      @http_request.auth.basic(*@globals[:basic_auth])   if @globals.include? :basic_auth
+      @http_request.auth.digest(*@globals[:digest_auth]) if @globals.include? :digest_auth
     end
 
-    def configure_ssl(http)
-      http.auth.ssl.ssl_version = @globals[:ssl_version] if @globals.include? :ssl_version
-      http.auth.ssl.verify_mode = @globals[:ssl_verify_mode] if @globals.include? :ssl_verify_mode
+  end
 
-      http.auth.ssl.cert_key_file = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
-      http.auth.ssl.cert_file = @globals[:ssl_cert_file] if @globals.include? :ssl_cert_file
-      http.auth.ssl.ca_cert_file = @globals[:ssl_ca_cert_file] if @globals.include? :ssl_ca_cert_file
-    end
+  class WSDLRequest < HTTPRequest
+
+    def build
+      configure_proxy
+      configure_timeouts
+      configure_ssl
+      configure_auth
 
-    def configure_auth(http)
-      http.auth.basic(*@globals[:basic_auth]) if @globals.include? :basic_auth
-      http.auth.digest(*@globals[:digest_auth]) if @globals.include? :digest_auth
+      @http_request
     end
 
-    def soap_action
-      return if @locals.include?(:soap_action) && !@locals[:soap_action]
-      return @soap_action if defined? @soap_action
+  end
 
-      soap_action = @locals[:soap_action]
-      soap_action ||= @wsdl.soap_action(@operation_name.to_sym) if @wsdl.document?
-      soap_action ||= Gyoku.xml_tag(@operation_name, :key_converter => @globals[:convert_request_keys_to])
+  class SOAPRequest < HTTPRequest
 
-      @soap_action = soap_action
-    end
+    CONTENT_TYPE = {
+      1 => "text/xml;charset=%s",
+      2 => "application/soap+xml;charset=%s"
+    }
 
-    def log_request(url, headers, body)
-      logger.info  "SOAP request: #{url}"
-      logger.info  headers_to_log(headers)
-      logger.debug body_to_log(body)
-    end
+    def build(options = {})
+      configure_proxy
+      configure_cookies options[:cookies]
+      configure_timeouts
+      configure_headers options[:soap_action]
+      configure_ssl
+      configure_auth
 
-    def log_response(code, body)
-      logger.info  "SOAP response (status #{code})"
-      logger.debug body_to_log(body)
+      @http_request
     end
 
-    def headers_to_log(headers)
-      headers.map { |key, value| "#{key}: #{value}" }.join(", ")
-    end
+    private
 
-    def body_to_log(body)
-      LogMessage.new(body, @globals[:filters], @globals[:pretty_print_xml]).to_s
+    def configure_cookies(cookies)
+      @http_request.set_cookies(cookies) if cookies
     end
 
-    def logger
-      @globals[:logger]
+    def configure_headers(soap_action)
+      @http_request.headers = @globals[:headers] if @globals.include? :headers
+      @http_request.headers["SOAPAction"]   ||= %{"#{soap_action}"} if soap_action
+      @http_request.headers["Content-Type"] ||= CONTENT_TYPE[@globals[:soap_version]] % @globals[:encoding]
     end
 
   end