savon 2.1.0 → 2.2.0

data/.gitignore

@@ -8,4 +8,5 @@ tmp
 *~
 *.gem
 .bundle
+.rspec
 Gemfile.lock

data/.travis.yml

@@ -1,10 +1,11 @@
 # https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
 language: "ruby"
-script: "bundle exec rake"
+script: "bundle exec rake --trace"
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+### 2.2.0 (2013-04-21)
+
+* Feature: [#416](https://github.com/savonrb/savon/pull/416) The global `namespace_identifier`
+  option can now be set to `nil` to not add a namespace identifier to the message tag.
+
+* Feature: [#408](https://github.com/savonrb/savon/pull/408) Added `Savon::Client#service_name`
+  to return the name of the SOAP service.
+
+* Improvement: When mistyping an option name, Savon used to raise a simple `NoMethodError`.
+  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.
+
+    ```
+    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.
+
+    ```
+    Savon::UnknownOptionError:
+       Unknown global option: :wsdk
+    ```
+
+* Improvement: [#385](https://github.com/savonrb/savon/issues/385) Instead of raising an
+  `ArgumentError` when Wasabi can't find any operations in the WSDL. Savon now raises a
+  `Savon::UnknownOperationError`. This might happen when Wasabi fails to parse the WSDL
+  because of imports for example.
+
+* Fix: [#430](https://github.com/savonrb/savon/pull/430) allows you to rescue and ignore
+  `Savon::Error` errors in production while still having mocks trigger test failures.
+
+* Fix: [#393](https://github.com/savonrb/savon/pull/393) changed `Savon::SOAPFault` to work
+  with generic response Hash keys.
+
+* Fix: [#423](https://github.com/savonrb/savon/issues/423) fixes a problem where Wasabi was
+  not able to find extension base elements defined in imports it didn't follow.
+
 ### 2.1.0 (2013-02-03)
 
 * Feature: [#372](https://github.com/savonrb/savon/pull/372) added global `ssl_cert_key_password` option.

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contribution Guide
+
+This page describes how to contribute changes to Savon.
+
+Please do not create a pull request without reading this guide first.
+Make sure to read the documentation for your version at [savonrb.com](http://savonrb.com/)
+and post questions to the [mailing list](https://groups.google.com/forum/#!forum/savonrb).
+
+**Bug fixes**
+
+If you really think you found a bug, please make sure to add as many information as possible
+to the ticket. You're a developer, we are developers and you know we need tests to reproduce
+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.
+
+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`,
+but Savon actually has with some additional "integration/example specs" at `spec/integration`,
+which you need to run locally to make sure the integration with real world services still works.
+
+Notice that these specs are not run by Travis, because the service's are not guaranteed to work
+all the time and the specs will timeout after a few seconds when the service is currently down.
+
+Please follow this basic workflow for pull requests:
+
+* [Fork the project](https://help.github.com/articles/fork-a-repo)
+* Create a feature branch and make your bug fix
+* Add tests for it!
+* Update the [Changelog](https://github.com/savonrb/savon/blob/master/CHANGELOG.md)
+* [Send a pull request](https://help.github.com/articles/using-pull-requests)
+* [Check that your pull request passes the build](https://travis-ci.org/savonrb/savon/pull_requests)
+
+
+**Improvements and feature requests**
+
+If you have an idea for an improvement or a new feature, please feel free to
+[create a new issue](https://github.com/savonrb/savon/issues/new) and describe your idea
+so that other people can give their insights and opinions. This is also important to avoid
+duplicate work.
+
+Pull requests and issues on GitHub are meant to be used to discuss problems and ideas,
+so please make sure to participate and follow up on questions. In case noone comments
+on your ticket, please keep updating the ticket with additional information.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 gem "httpclient", "~> 2.3.0"

data/README.md

@@ -1,14 +1,16 @@
-Savon [![Build Status](https://secure.travis-ci.org/savonrb/savon.png)](http://travis-ci.org/savonrb/savon)
-=====
+# Savon
 
 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)
+[![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)
 
-Installation
-------------
+
+## Installation
 
 Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
 
@@ -16,30 +18,40 @@ Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be
 $ gem install savon
 ```
 
+or add it to your Gemfile like this:
+
+```
+gem 'savon', '~> 2.1.0'
+```
+
 
-Introduction
-------------
+## Usage example
 
 ``` ruby
-require "savon"
+require 'savon'
 
-# create a client for your SOAP service
-client = Savon.client(wsdl: "http://service.example.com?wsdl")
+# create a client for the service
+client = Savon.client(wsdl: 'http://service.example.com?wsdl')
 
 client.operations
-# => [:create_user, :get_user, :get_all_users]
+# => [:find_user, :list_users]
 
-# execute a SOAP request to call the "getUser" action
-response = client.call(:get_user) do
-  message(user_id: 1)
-end
+# call the 'findUser' operation
+response = client.call(:find_user, message: { id: 42 })
 
 response.body
-# => { :get_user_response => { :first_name => "The", :last_name => "Hoff" } }
+# => { 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).
+
+
+## Documentation
+
+Please make sure to read the documentation for your version:
 
-Documentation
--------------
+* [Version 2](http://savonrb.com/version2.html)
+* [Version 1](http://savonrb.com)
 
-Continue reading at [savonrb.com](http://savonrb.com)
+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).

data/lib/savon.rb

@@ -1,8 +1,10 @@
 module Savon
 
-  Error                = Class.new(RuntimeError)
-  InitializationError  = Class.new(Error)
-  InvalidResponseError = Class.new(Error)
+  Error                 = Class.new(RuntimeError)
+  InitializationError   = Class.new(Error)
+  UnknownOptionError    = Class.new(Error)
+  UnknownOperationError = Class.new(Error)
+  InvalidResponseError  = Class.new(Error)
 
   def self.client(globals = {}, &block)
     Client.new(globals, &block)

data/lib/savon/builder.rb

@@ -1,5 +1,6 @@
 require "savon/header"
 require "savon/message"
+require "nokogiri"
 require "builder"
 require "gyoku"
 
@@ -27,6 +28,10 @@ module Savon
       @used_namespaces = convert_type_namespaces_to_hash
     end
 
+    def pretty
+      Nokogiri.XML(to_s).to_xml(:indent => 2)
+    end
+
     def to_s
       return @locals[:xml] if @locals.include? :xml
 
@@ -72,7 +77,12 @@ module Savon
     def namespaces
       @namespaces ||= begin
         namespaces = SCHEMA_TYPES.dup
-        namespaces["xmlns:#{namespace_identifier}"] = @globals[:namespace] || @wsdl.namespace
+
+        if namespace_identifier == nil
+          namespaces["xmlns"] = @globals[:namespace] || @wsdl.namespace
+        else
+          namespaces["xmlns:#{namespace_identifier}"] = @globals[:namespace] || @wsdl.namespace
+        end
 
         key = ["xmlns"]
         key << env_namespace if env_namespace && env_namespace != ""
@@ -91,7 +101,9 @@ module Savon
     end
 
     def namespaced_message_tag
-      if @used_namespaces[[@operation_name.to_s]]
+      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]
       else
         [namespace_identifier, message_tag, message_attributes]

data/lib/savon/client.rb

@@ -12,9 +12,7 @@ module Savon
         raise_version1_initialize_error! globals
       end
 
-      @globals = GlobalOptions.new(globals)
-
-      BlockInterface.new(@globals).evaluate(block) if block
+      set_globals(globals, block)
 
       unless wsdl_or_endpoint_and_namespace_specified?
         raise_initialization_error!
@@ -38,14 +36,27 @@ module Savon
       operation(operation_name).call(locals, &block)
     end
 
+    def service_name
+      raise_missing_wsdl_error! unless @wsdl.document?
+      @wsdl.service_name
+    end
+
     private
 
+    def set_globals(globals, block)
+      globals = GlobalOptions.new(globals)
+      BlockInterface.new(globals).evaluate(block) if block
+
+      @globals = globals
+    end
+
     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.document    = @globals[:wsdl]        if @globals.include? :wsdl
+      @wsdl.endpoint    = @globals[:endpoint]    if @globals.include? :endpoint
+      @wsdl.namespace   = @globals[:namespace]   if @globals.include? :namespace
+      @wsdl.servicename = @globals[:servicename] if @globals.include? :servicename
 
       @wsdl.request = WSDLRequest.new(@globals).build
     end

data/lib/savon/message.rb

@@ -20,6 +20,8 @@ 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])
       end
 

data/lib/savon/mock.rb

@@ -1,5 +1,5 @@
 module Savon
-  class ExpectationError < Error; end
+  class ExpectationError < StandardError; end
 end
 
 require "savon/mock/expectation"

data/lib/savon/operation.rb

@@ -19,8 +19,8 @@ module Savon
 
     def self.ensure_exists!(operation_name, wsdl)
       unless wsdl.soap_actions.include? operation_name
-        raise ArgumentError, "Unable to find SOAP operation: #{operation_name.inspect}\n" \
-                             "Operations provided by your service: #{wsdl.soap_actions.inspect}"
+        raise UnknownOperationError, "Unable to find SOAP operation: #{operation_name.inspect}\n" \
+                                     "Operations provided by your service: #{wsdl.soap_actions.inspect}"
       end
     end
 
@@ -37,12 +37,13 @@ module Savon
       @globals = globals
     end
 
-    def call(locals = {}, &block)
-      @locals = LocalOptions.new(locals)
-
-      BlockInterface.new(@locals).evaluate(block) if block
+    def build(locals = {}, &block)
+      set_locals(locals, block)
+      Builder.new(@name, @wsdl, @globals, @locals)
+    end
 
-      builder = Builder.new(@name, @wsdl, @globals, @locals)
+    def call(locals = {}, &block)
+      builder = build(locals, &block)
 
       response = Savon.notify_observers(@name, builder, @globals, @locals)
       response ||= call! build_request(builder)
@@ -54,6 +55,13 @@ module Savon
 
     private
 
+    def set_locals(locals, block)
+      locals = LocalOptions.new(locals)
+      BlockInterface.new(locals).evaluate(block) if block
+
+      @locals = locals
+    end
+
     def call!(request)
       log_request(request) if log?
       response = HTTPI.post(request)

data/lib/savon/options.rb

@@ -9,6 +9,8 @@ module Savon
       assign options
     end
 
+    attr_reader :option_type
+
     def [](option)
       @options[option]
     end
@@ -30,11 +32,17 @@ module Savon
       end
     end
 
+    def method_missing(option, _)
+      raise UnknownOptionError, "Unknown #{option_type} option: #{option.inspect}"
+    end
+
   end
 
   class GlobalOptions < Options
 
     def initialize(options = {})
+      @option_type = :global
+
       defaults = {
         :encoding                  => "UTF-8",
         :soap_version              => 1,
@@ -243,6 +251,8 @@ module Savon
   class LocalOptions < Options
 
     def initialize(options = {})
+      @option_type = :local
+
       defaults = {
         :advanced_typecasting => true,
         :response_parser      => :nokogiri

data/lib/savon/soap_fault.rb

@@ -19,20 +19,28 @@ module Savon
     attr_reader :http, :nori
 
     def to_s
-      message_by_version to_hash[:fault]
+      fault = nori.find(to_hash, 'Fault')
+      message_by_version(fault)
     end
 
     def to_hash
-      nori.parse(@http.body)[:envelope][:body]
+      parsed = nori.parse(@http.body)
+      nori.find(parsed, 'Envelope', 'Body')
     end
 
     private
 
     def message_by_version(fault)
-      if fault[:faultcode]
-        "(#{fault[:faultcode]}) #{fault[:faultstring]}"
-      elsif fault[:code]
-        "(#{fault[:code][:value]}) #{fault[:reason][:text]}"
+      if nori.find(fault, 'faultcode')
+        code = nori.find(fault, 'faultcode')
+        text = nori.find(fault, 'faultstring')
+
+        "(#{code}) #{text}"
+      elsif nori.find(fault, 'Code')
+        code = nori.find(fault, 'Code', 'Value')
+        text = nori.find(fault, 'Reason', 'Text')
+
+        "(#{code}) #{text}"
       end
     end
 

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 
 end

data/savon.gemspec

@@ -11,13 +11,13 @@ Gem::Specification.new do |s|
   s.email       = "me@rubiii.com"
   s.homepage    = "http://savonrb.com"
   s.summary     = "Heavy metal SOAP client"
-  s.description = "Delicious SOAP for the Ruby community"
+  s.description = s.summary
 
   s.rubyforge_project = s.name
 
-  s.add_dependency "nori",     "~> 2.0.3"
+  s.add_dependency "nori",     "~> 2.1.0"
   s.add_dependency "httpi",    "~> 2.0.2"
-  s.add_dependency "wasabi",   "~> 3.0.0"
+  s.add_dependency "wasabi",   "~> 3.1.0"
   s.add_dependency "akami",    "~> 1.2.0"
   s.add_dependency "gyoku",    "~> 1.0.0"
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency "nokogiri", ">= 1.4.0"
 
   s.add_development_dependency "rack"
-  s.add_development_dependency "puma",  ">= 2.0.0.b3"
+  s.add_development_dependency "puma",  "2.0.0.b4"
 
   s.add_development_dependency "rake",  "~> 0.9"
   s.add_development_dependency "rspec", "~> 2.10"
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "json",  "~> 1.7"
 
   ignores  = File.readlines(".gitignore").grep(/\S+/).map(&:chomp)
-  dotfiles = %w[.gitignore .rspec .travis.yml .yardopts]
+  dotfiles = %w[.gitignore .travis.yml .yardopts]
 
   all_files_without_ignores = Dir["**/*"].reject { |f|
     File.directory?(f) || ignores.any? { |i| File.fnmatch(i, f) }