savon-SU 2.11.1b

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 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`,
+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

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+gemspec
+
+gem "httpclient", "~> 2.3.4"
+
+gem "simplecov", :require => false
+gem "coveralls", :require => false
+
+platform :rbx do
+  gem 'json'
+  gem 'racc'
+  gem 'rubysl'
+  gem 'rubinius-coverage'
+end
+
+platform :jruby do
+  gem 'json'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Harrington
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# 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?branch=master)](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)
+
+
+## Version 2
+
+Savon version 2 is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
+
+```
+$ gem install savon
+```
+
+or add it to your Gemfile like this:
+
+```
+gem 'savon', '~> 2.10.0'
+```
+
+## Usage example
+
+``` ruby
+require 'savon'
+
+# create a client for the service
+client = Savon.client(wsdl: 'http://service.example.com?wsdl')
+
+client.operations
+# => [:find_user, :list_users]
+
+# call the 'findUser' operation
+response = client.call(:find_user, message: { id: 42 })
+
+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/version2/spec/integration).
+
+## FAQ
+
+* URI::InvalidURIError -- if you see this error, then it is likely that the http client you are using cannot parse the URI for your WSDL. Try `gem install httpclient` or add it to your `Gemfile`.
+  - See https://github.com/savonrb/savon/issues/488 for more info
+
+## 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/tjarratt/) so that I can continue to improve it.
+
+[![donate](donate.png)](https://www.gittip.com/tjarratt/)
+
+
+## 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/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/savon/**/*_spec.rb"
+end
+
+desc "Run RSpec integration examples"
+RSpec::Core::RakeTask.new "spec:integration" do |t|
+  t.pattern = "spec/integration/**/*_spec.rb"
+end
+
+task :default => :spec
+task :test => :spec

data/lib/savon.rb

@@ -0,0 +1,27 @@
+module Savon
+
+  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)
+  end
+
+  def self.observers
+    @observers ||= []
+  end
+
+  def self.notify_observers(operation_name, builder, globals, locals)
+    observers.inject(nil) do |response, observer|
+      observer.notify(operation_name, builder, globals, locals)
+    end
+  end
+
+end
+
+require "savon/version"
+require "savon/client"
+require "savon/model"

data/lib/savon/block_interface.rb

@@ -0,0 +1,26 @@
+module Savon
+  class BlockInterface
+
+    def initialize(target)
+      @target = target
+    end
+
+    def evaluate(block)
+      if block.arity > 0
+        block.call(@target)
+      else
+        @original = eval("self", block.binding)
+        instance_eval(&block)
+      end
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      @target.send(method, *args, &block)
+    rescue NoMethodError
+      @original.send(method, *args, &block)
+    end
+
+  end
+end

data/lib/savon/builder.rb

@@ -0,0 +1,205 @@
+require "savon/header"
+require "savon/message"
+require "nokogiri"
+require "builder"
+require "gyoku"
+
+module Savon
+  class Builder
+
+    SCHEMA_TYPES = {
+      "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+      "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance"
+    }
+
+    SOAP_NAMESPACE = {
+      1 => "http://schemas.xmlsoap.org/soap/envelope/",
+      2 => "http://www.w3.org/2003/05/soap-envelope"
+    }
+
+    WSA_NAMESPACE = "http://www.w3.org/2005/08/addressing"
+
+    def initialize(operation_name, wsdl, globals, locals)
+      @operation_name = operation_name
+
+      @wsdl      = wsdl
+      @globals   = globals
+      @locals    = locals
+      @signature = @locals[:wsse_signature] || @globals[:wsse_signature]
+
+      @types = convert_type_definitions_to_hash
+      @used_namespaces = convert_type_namespaces_to_hash
+    end
+
+    def pretty
+      Nokogiri.XML(to_s).to_xml(:indent => 2)
+    end
+
+    def build_document
+      xml = tag(builder, :Envelope, namespaces_with_globals) do |xml|
+        tag(xml, :Header, header_attributes) { xml << header.to_s } unless header.empty?
+        if @globals[:no_message_tag]
+          tag(xml, :Body, body_attributes) { xml << message.to_s }
+        else
+          tag(xml, :Body, body_attributes) { xml.tag!(*namespaced_message_tag) { xml << message.to_s } }
+        end
+      end
+
+      # if we have a signature sign the document
+      if @signature
+        @signature.document = xml
+
+        2.times do
+          @header = nil
+          @signature.document = tag(builder, :Envelope, namespaces_with_globals) do |xml|
+            tag(xml, :Header, header_attributes) { xml << header.to_s } unless header.empty?
+            if @globals[:no_message_tag]
+              tag(xml, :Body, body_attributes) { xml << message.to_s }
+            else
+              tag(xml, :Body, body_attributes) { xml.tag!(*namespaced_message_tag) { xml << message.to_s } }
+            end
+          end
+        end
+
+        xml = @signature.document
+      end
+
+      xml
+    end
+
+    def header_attributes
+      @globals[:use_wsa_headers] ? { 'xmlns:wsa' => WSA_NAMESPACE } : {}
+    end
+
+    def body_attributes
+      @body_attributes ||= @signature.nil? ? {} : @signature.body_attributes
+    end
+
+    def to_s
+      return @locals[:xml] if @locals.include? :xml
+      build_document
+    end
+
+    private
+
+    def convert_type_definitions_to_hash
+      @wsdl.type_definitions.inject({}) do |memo, (path, type)|
+        memo[path] = type
+        memo
+      end
+    end
+
+    def convert_type_namespaces_to_hash
+      @wsdl.type_namespaces.inject({}) do |memo, (path, uri)|
+        key, value = use_namespace(path, uri)
+        memo[key] = value
+        memo
+      end
+    end
+
+    def use_namespace(path, uri)
+      @internal_namespace_count ||= 0
+
+      unless identifier = namespace_by_uri(uri)
+        identifier = "ins#{@internal_namespace_count}"
+        namespaces["xmlns:#{identifier}"] = uri
+        @internal_namespace_count += 1
+      end
+
+      [path, identifier]
+    end
+
+    def namespaces_with_globals
+      namespaces.merge @globals[:namespaces]
+    end
+
+    def namespaces
+      @namespaces ||= begin
+        namespaces = SCHEMA_TYPES.dup
+
+        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 != ""
+        namespaces[key.join(":")] = SOAP_NAMESPACE[@globals[:soap_version]]
+
+        namespaces
+      end
+    end
+
+    def env_namespace
+      @env_namespace ||= @globals[:env_namespace] || :env
+    end
+
+    def header
+      @header ||= Header.new(@globals, @locals)
+    end
+
+    def namespaced_message_tag
+      tag_name = message_tag
+      if namespace_identifier == nil
+        [tag_name, message_attributes]
+      elsif @used_namespaces[[tag_name.to_s]]
+        [@used_namespaces[[tag_name.to_s]], tag_name, message_attributes]
+      else
+        [namespace_identifier, tag_name, message_attributes]
+      end
+    end
+
+    def message_tag
+      message_tag = @locals[:message_tag]
+      message_tag ||= @wsdl.soap_input(@operation_name.to_sym) if @wsdl.document?
+      message_tag ||= Gyoku.xml_tag(@operation_name, :key_converter => @globals[:convert_request_keys_to])
+
+      @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]
+      Message.new(message_tag, namespace_identifier, @types, @used_namespaces, @locals[:message],
+                  element_form_default, @globals[:convert_request_keys_to], @globals[:unwrap])
+    end
+
+    def namespace_identifier
+      return @globals[:namespace_identifier] if @globals.include? :namespace_identifier
+      return @namespace_identifier if @namespace_identifier
+
+      operation = @wsdl.operations[@operation_name] if @wsdl.document?
+      namespace_identifier = operation[:namespace_identifier] if operation
+      namespace_identifier ||= "wsdl"
+
+      @namespace_identifier = namespace_identifier.to_sym
+    end
+
+    def namespace_by_uri(uri)
+      namespaces.each do |candidate_identifier, candidate_uri|
+        return candidate_identifier.gsub(/^xmlns:/, '') if candidate_uri == uri
+      end
+      nil
+    end
+
+    def builder
+      builder = ::Builder::XmlMarkup.new
+      builder.instruct!(:xml, :encoding => @globals[:encoding])
+      builder
+    end
+
+    def tag(xml, name, namespaces = {}, &block)
+      if env_namespace && env_namespace != ""
+        xml.tag! env_namespace, name, namespaces, &block
+      else
+        xml.tag! name, namespaces, &block
+      end
+    end
+
+  end
+end

data/lib/savon/client.rb

@@ -0,0 +1,102 @@
+require "savon/operation"
+require "savon/request"
+require "savon/options"
+require "savon/block_interface"
+require "wasabi"
+
+module Savon
+  class Client
+
+    def initialize(globals = {}, &block)
+      unless globals.kind_of? Hash
+        raise_version1_initialize_error! globals
+      end
+
+      set_globals(globals, block)
+
+      unless wsdl_or_endpoint_and_namespace_specified?
+        raise_initialization_error!
+      end
+
+      build_wsdl_document
+    end
+
+    attr_reader :globals
+
+    def operations
+      raise_missing_wsdl_error! unless @wsdl.document?
+      @wsdl.soap_actions
+    end
+
+    def parameters(operation_name)
+      raise_missing_wsdl_error! unless @wsdl.document?
+      if !@wsdl.operations.[](operation_name).[](:parameters).nil?
+        @wsdl.operations.[](operation_name).[](:parameters).keys
+      else
+        return nil
+      end
+    end
+
+    def operation(operation_name)
+      Operation.create(operation_name, @wsdl, @globals)
+    end
+
+    def call(operation_name, locals = {}, &block)
+      operation(operation_name).call(locals, &block)
+    end
+
+    def service_name
+      raise_missing_wsdl_error! unless @wsdl.document?
+      @wsdl.service_name
+    end
+
+    def build_request(operation_name, locals = {}, &block)
+      operation(operation_name).request(locals, &block)
+    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.servicename = @globals[:servicename] if @globals.include? :servicename
+      @wsdl.adapter     = @globals[:adapter]     if @globals.include? :adapter
+
+      @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" \
+            "Savon.client(wsdl: '/Users/me/project/service.wsdl')                              # to use a local WSDL document\n" \
+            "Savon.client(wsdl: 'http://example.com?wsdl')                                     # to use a remote WSDL document\n" \
+            "Savon.client(endpoint: 'http://example.com', namespace: 'http://v1.example.com')  # if you don't have a WSDL document"
+    end
+
+    def raise_missing_wsdl_error!
+      raise "Unable to inspect the service without a WSDL document."
+    end
+
+  end
+end