savon 2.2.0 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cae0817f78856aab3d2755e35f8d8eae26f13ab1
+  data.tar.gz: f072a4794247d9bbd34e1c20884c398524b34ef3
+SHA512:
+  metadata.gz: 60c8697a66a84e2405318c27900207f14734231baa672ca609e77c8425e9ed6e6a897df1e1e62759775acfb14d66194bb08c32210552b0d19cb570c9ff927d70
+  data.tar.gz: 1467af7b259d9a6d67b724eabe9cd9905b37580b923c552ce0b7a76251e6a3e960379dab11ba8e3f2555502aebf56b7f8728a1f331c51975b5a905212da1ed1c

data/.gitignore

@@ -2,6 +2,7 @@
 .DS_Store
 .yardoc
 doc
+rdox
 coverage
 tmp
 *.rbc

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+### 2.3.0 (2013-07-27)
+
+Combined release ticket: [#481](https://github.com/savonrb/savon/issues/481)
+
+* Feature: [#405](https://github.com/savonrb/savon/issues/405) Improved NTLM support based on HTTPI v2.1.0.
+
+* Feature: [#424](https://github.com/savonrb/savon/issues/424) Adds support for multipart responses
+  through the updated [savon-multipart](https://github.com/savonrb/savon-multipart) gem. You can now
+  specify `multipart: true` either as a global or local option. Please make sure you have the
+  updated `savon-multipart` gem installed and loaded, as it is not a direct dependency of Savon.
+
+    ``` ruby
+    require 'savon'
+    require 'savon-multipart'
+
+    # expect multipart responses for every operation
+    client = Savon.client(wsdl: wsdl, multipart: true)
+
+    # only expect a multipart response for this operation
+    client.call(:my_operation, multipart: true)
+    ```
+
+* Feature: [#470](https://github.com/savonrb/savon/issues/470) Added a local `:soap_header` option
+  to allow setting the SOAP header per request.
+
+* Feature: [#402](https://github.com/savonrb/savon/issues/402) Makes it possible to create mocks
+  that don't care about the message sent by using `:any` for the `:message` option.
+
+    ``` ruby
+    savon.expects(:authenticate).with(message: :any)
+    ```
+
+* Fix: [#450](https://github.com/savonrb/savon/pull/450) Added `Savon::Response#soap_fault`
+  and `Savon::Response#http_error` which were present in version 1.
+
+* Fix: [#474](https://github.com/savonrb/savon/issues/474) Changed `Savon::Response#header` and
+  `Savon::Response#body` to respect the global `:convert_response_tags_to` and `:strip_namespaces`
+  options and return the expected result instead of raising a `Savon::InvalidResponseError`.
+
+* Fix: [#461](https://github.com/savonrb/savon/issues/461) Fixed two problems related to namespace
+  qualified messages and the element `:order!`.
+
+* Fix: [#476](https://github.com/savonrb/savon/issues/476) fixes a problem where the namespace
+  for the message tag was not correctly determined from the WSDL.
+
+* Fix: [#468](https://github.com/savonrb/savon/issues/468) Changed the dependency on Nokogiri
+  to < 1.6, because Nokogiri 1.6 dropped support for Ruby 1.8.
+
 ### 2.2.0 (2013-04-21)
 
 * Feature: [#416](https://github.com/savonrb/savon/pull/416) The global `namespace_identifier`
@@ -10,14 +58,14 @@
   This is because regardless of whether you're using the Hash or block syntax to pass global
   or local options, both are just method calls on some options object.
 
-    ```
+    ``` ruby
     NoMethodError: undefined method 'wsdk' for #<Savon::GlobalOptions:0x007fed95a55228>
     ```
 
   As of this change, Savon now catches those errors and raise a `Savon::UnknownOptionError`
   with a slightly more helpful error message instead.
 
-    ```
+    ``` ruby
     Savon::UnknownOptionError:
        Unknown global option: :wsdk
     ```

data/CONTRIBUTING.md

@@ -14,7 +14,7 @@ problems and make sure they don't come back.
 
 So if you can reproduce your problem in a spec, that would be awesome! If you can't, please
 let us know how we could make this easier for you. Also, provide code and the WSDL of the
-service your working with so others can try to come up with a spec for your problem.
+service you're working with so others can try to come up with a spec for your problem.
 
 After we have a failing spec, it obviously needs to be fixed. Make sure your new spec is the
 only failing one under the `spec` directory. Travis only runs the "unit tests" at `spec/savon`,

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem "httpclient", "~> 2.3.0"
-gem "simplecov", :require => false, :group => :test
+gem "httpclient", "~> 2.3.4"
+
+gem "simplecov", :require => false
+gem "coveralls", :require => false

data/README.md

@@ -5,14 +5,15 @@ Heavy metal SOAP client
 [Documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) |
 [Mailing list](https://groups.google.com/forum/#!forum/savonrb) | [Twitter](http://twitter.com/savonrb)
 
-[![Build Status](https://secure.travis-ci.org/savonrb/savon.png)](http://travis-ci.org/savonrb/savon)
+[![Build Status](https://secure.travis-ci.org/savonrb/savon.png?branch=version2)](http://travis-ci.org/savonrb/savon)
 [![Gem Version](https://badge.fury.io/rb/savon.png)](http://badge.fury.io/rb/savon)
 [![Code Climate](https://codeclimate.com/github/savonrb/savon.png)](https://codeclimate.com/github/savonrb/savon)
+[![Coverage Status](https://coveralls.io/repos/savonrb/savon/badge.png?branch=version2)](https://coveralls.io/r/savonrb/savon)
 
 
-## Installation
+## Version 2
 
-Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
+Savon version 2 is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
 
 ```
 $ gem install savon
@@ -21,7 +22,7 @@ $ gem install savon
 or add it to your Gemfile like this:
 
 ```
-gem 'savon', '~> 2.1.0'
+gem 'savon', '~> 2.2.0'
 ```
 
 
@@ -43,15 +44,23 @@ response.body
 # => { find_user_response: { id: 42, name: 'Hoff' } }
 ```
 
-For more examples, you should check out the [integration tests](https://github.com/savonrb/savon/tree/master/spec/integration).
+For more examples, you should check out the
+[integration tests](https://github.com/savonrb/savon/tree/version2/spec/integration).
 
 
-## Documentation
+## Give back
+
+If you're using Savon and you or your company is making money from it, then please consider
+donating via [Gittip](https://www.gittip.com/rubiii/) so that I can continue to improve it.
+
+[![donate](donate.png)](https://www.gittip.com/rubiii/)
 
-Please make sure to read the documentation for your version:
 
-* [Version 2](http://savonrb.com/version2.html)
-* [Version 1](http://savonrb.com)
+## Documentation
+
+Please make sure to [read the documentation](http://savonrb.com/version2/).
 
 And if you find any problems with it or if you think something's missing,  
 feel free to [help out and improve the documentation](https://github.com/savonrb/savonrb.com).
+
+Donate icon from the [Noun Project](http://thenounproject.com/noun/donate/#icon-No285).

data/lib/savon/builder.rb

@@ -101,12 +101,13 @@ module Savon
     end
 
     def namespaced_message_tag
+      tag_name = message_tag
       if namespace_identifier == nil
-        [message_tag, message_attributes]
-      elsif @used_namespaces[[@operation_name.to_s]]
-        [@used_namespaces[[@operation_name.to_s]], message_tag, message_attributes]
+        [tag_name, message_attributes]
+      elsif @used_namespaces[[tag_name.to_s]]
+        [@used_namespaces[[tag_name.to_s]], tag_name, message_attributes]
       else
-        [namespace_identifier, message_tag, message_attributes]
+        [namespace_identifier, tag_name, message_attributes]
       end
     end
 

data/lib/savon/core_ext/string.rb

@@ -1,4 +1,3 @@
-require "savon/soap"
 
 module Savon
   module CoreExt

data/lib/savon/header.rb

@@ -5,37 +5,65 @@ module Savon
   class Header
 
     def initialize(globals, locals)
-      @globals = globals
-      @locals = locals
-      @wsse = create_wsse
+      @gyoku_options  = { :key_converter => globals[:convert_request_keys_to] }
+
+      @wsse_auth      = globals[:wsse_auth]
+      @wsse_timestamp = globals[:wsse_timestamp]
+
+      @global_header  = globals[:soap_header]
+      @local_header   = locals[:soap_header]
+
+      @header = build
     end
 
+    attr_reader :local_header, :global_header, :gyoku_options,
+                :wsse_auth, :wsse_timestamp
+
     def empty?
-      to_s.empty?
+      @header.empty?
     end
 
     def to_s
-      return @header if @header
-
-      gyoku_options = { :key_converter => @globals[:convert_request_keys_to] }
-      @header = (Hash === header ? Gyoku.xml(header, gyoku_options) : header) + wsse_header
+      @header
     end
 
     private
 
-    def create_wsse
-      wsse = Akami.wsse
-      wsse.credentials(*@globals[:wsse_auth]) if @globals.include? :wsse_auth
-      wsse.timestamp = @globals[:wsse_timestamp] if @globals.include? :wsse_timestamp
-      wsse
+    def build
+      build_header + build_wsse_header
     end
 
-    def header
-      @header ||= @globals.include?(:soap_header) ? @globals[:soap_header] : {}
+    def build_header
+      header =
+        if global_header.kind_of?(Hash) && local_header.kind_of?(Hash)
+          global_header.merge(local_header)
+        elsif local_header
+          local_header
+        else
+          global_header
+        end
+
+      convert_to_xml(header)
+    end
+
+    def build_wsse_header
+      wsse_header = akami
+      wsse_header.respond_to?(:to_xml) ? wsse_header.to_xml : ""
     end
 
-    def wsse_header
-      @wsse.respond_to?(:to_xml) ? @wsse.to_xml : ""
+    def convert_to_xml(hash_or_string)
+      if hash_or_string.kind_of? Hash
+        Gyoku.xml(hash_or_string, gyoku_options)
+      else
+        hash_or_string.to_s
+      end
+    end
+
+    def akami
+      wsse = Akami.wsse
+      wsse.credentials(*wsse_auth) if wsse_auth
+      wsse.timestamp = wsse_timestamp if wsse_timestamp
+      wsse
     end
 
   end

data/lib/savon/message.rb

@@ -20,9 +20,7 @@ module Savon
 
       if @element_form_default == :qualified
         translated_operation_name = Gyoku.xml_tag(@operation_name, :key_converter => @key_converter).to_s
-        # XXX: there is no `@request_key_converter` instance variable!
-        #      the third argument is therefore always `nil`. [dh, 2013-03-09]
-        @message = QualifiedMessage.new(@types, @used_namespaces, @request_key_converter).to_hash(@message, [translated_operation_name])
+        @message = QualifiedMessage.new(@types, @used_namespaces, @key_converter).to_hash(@message, [translated_operation_name])
       end
 
       gyoku_options = {

data/lib/savon/mock/expectation.rb

@@ -54,6 +54,7 @@ module Savon
     end
 
     def verify_message!
+      return if @expected[:message] == :any
       unless @expected[:message] == @actual[:message]
         expected_message = "  with this message: #{@expected[:message].inspect}" if @expected[:message]
         expected_message ||= "  with no message."

data/lib/savon/operation.rb

@@ -3,7 +3,7 @@ require "savon/block_interface"
 require "savon/request"
 require "savon/builder"
 require "savon/response"
-require "savon/log_message"
+require "savon/request_logger"
 
 module Savon
   class Operation
@@ -35,6 +35,8 @@ module Savon
       @name = name
       @wsdl = wsdl
       @globals = globals
+
+      @logger = RequestLogger.new(globals)
     end
 
     def build(locals = {}, &block)
@@ -46,15 +48,33 @@ module Savon
       builder = build(locals, &block)
 
       response = Savon.notify_observers(@name, builder, @globals, @locals)
-      response ||= call! build_request(builder)
+      response ||= call_with_logging build_request(builder)
 
       raise_expected_httpi_response! unless response.kind_of?(HTTPI::Response)
 
-      Response.new(response, @globals, @locals)
+      create_response(response)
     end
 
     private
 
+    def create_response(response)
+      if multipart_supported?
+        Multipart::Response.new(response, @globals, @locals)
+      else
+        Response.new(response, @globals, @locals)
+      end
+    end
+
+    def multipart_supported?
+      return false unless @globals[:multipart] || @locals[:multipart]
+
+      if Savon.const_defined? :Multipart
+        true
+      else
+        raise 'Unable to find Savon::Multipart. Make sure the savon-multipart gem is installed and loaded.'
+      end
+    end
+
     def set_locals(locals, block)
       locals = LocalOptions.new(locals)
       BlockInterface.new(locals).evaluate(block) if block
@@ -62,12 +82,8 @@ module Savon
       @locals = locals
     end
 
-    def call!(request)
-      log_request(request) if log?
-      response = HTTPI.post(request)
-      log_response(response) if log?
-
-      response
+    def call_with_logging(request)
+      @logger.log(request) { HTTPI.post(request) }
     end
 
     def build_request(builder)
@@ -102,33 +118,6 @@ module Savon
       @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

@@ -53,7 +53,8 @@ module Savon
         :pretty_print_xml          => false,
         :raise_errors              => true,
         :strip_namespaces          => true,
-        :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym }
+        :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym},
+        :multipart                 => false,
       }
 
       options = defaults.merge(options)
@@ -117,7 +118,7 @@ module Savon
       @options[:encoding] = encoding
     end
 
-    # The global SOAP header. Expected to be a Hash.
+    # The global SOAP header. Expected to be a Hash or responding to #to_s.
     def soap_header(header)
       @options[:soap_header] = header
     end
@@ -219,6 +220,11 @@ module Savon
       @options[:digest_auth] = credentials.flatten
     end
 
+    # NTLM auth credentials.
+    def ntlm(*credentials)
+      @options[:ntlm] = credentials.flatten
+    end
+
     # WSSE auth credentials for Akami.
     def wsse_auth(*credentials)
       @options[:wsse_auth] = credentials.flatten
@@ -246,6 +252,11 @@ module Savon
     def convert_response_tags_to(converter = nil, &block)
       @options[:convert_response_tags_to] = block || converter
     end
+
+    # Instruct Savon to create a multipart response if available.
+    def multipart(multipart)
+      @options[:multipart] = multipart
+    end
   end
 
   class LocalOptions < Options
@@ -255,12 +266,20 @@ module Savon
 
       defaults = {
         :advanced_typecasting => true,
-        :response_parser      => :nokogiri
+        :response_parser      => :nokogiri,
+        :multipart            => false
       }
 
       super defaults.merge(options)
     end
 
+    # The local SOAP header. Expected to be a Hash or respond to #to_s.
+    # Will be merged with the global SOAP header if both are Hashes.
+    # Otherwise the local option will be prefered.
+    def soap_header(header)
+      @options[:soap_header] = header
+    end
+
     # The SOAP message to send. Expected to be a Hash or a String.
     def message(message)
       @options[:message] = message
@@ -302,5 +321,10 @@ module Savon
       @options[:response_parser] = parser
     end
 
+    # Instruct Savon to create a multipart response if available.
+    def multipart(multipart)
+      @options[:multipart] = multipart
+    end
+
   end
 end