johnreitano-savon 0.7.2.1 → 0.7.7.1

data/CHANGELOG

@@ -1,10 +1,41 @@
+== 0.7.6 (2010-03-21)
+  * Renamed 
+  * Moved documentation from the Github Wiki to the actual class files and established a much nicer
+    documentation combining examples and implementation (using Hanna) at: http://savon.rubiii.com
+  * Added Savon::Client#call as a workaround for dispatching calls to SOAP actions  named after
+	  existing methods. Fix for issue #48.
+  * Add support for specifying attributes for duplicate tags (via Hash values as Arrays). Fix for issue #45.
+  * Fix for issue #41 (Escape special characters (e.g. &) for XML requests).
+  * Fix for issue #39 and #49. Added Savon::SOAP#xml which let's you specify completely custom SOAP request XML.
+
+== 0.7.5 (2010-02-19)
+  * Fix for issue #34 (soap_actions returns empty for wsdl12).
+  * Fix for issue #36 (Custom WSDL actions broken).
+  * Added feature requested in issue #35 (Setting an attribute on an element?).
+  * Changed the key for specifying the order of tags from :@inorder to :order!
+
+== 0.7.4 (2010-02-02)
+  * Fix for issue #33 (undefined method 'start_with?').
+
+== 0.7.3 (2010-01-31)
+  * Added support for Geotrust-style WSDL documents (Julian Kornberger <github.corny@digineo.de>).
+  * Make HTTP requests include path and query only. This was breaking requests via proxy as scheme and host
+    were repeated (Adrian Mugnolo <adrian@mugnolo.com>)
+  * Avoid warning on 1.8.7 and 1.9.1 (Adrian Mugnolo <adrian@mugnolo.com>).
+  * Fix for issue #29 (WSSE Created Bug?). Default to UTC to xs:dateTime value for WSSE authentication.
+  * Fix for issue #28 (Undefined Method ssl? on URI::Generic).
+  * Fix for issue #27 (http content-type defaults to utf-8). The Content-Type now defaults to UTF-8.
+  * Modification to allow assignment of an Array with an input name and an optional Hash of values to soap.input.
+    Patches issue #30 (stanleydrew <andrewmbenton@gmail.com>).
+  * Fix for issue #25 (header-tag should not be sent if not set).
+
 == 0.7.2 (2010-01-17)
   * Exposed the Net::HTTP response (added by Kevin Ingolfsland). Use the "http" accessor (response.http) on your
     Savon::Response to access the Net::HTTP response object.
-  * Fix for Github issue #21 (savon is stripping ?SOAP off the end of WSDL locations).
-  * Fix for Github issue #22 (REXML::ParseException parsing 401 Unauthorized response body).
-  * Fix for Github issue #19 (Unable to set attribute in name-spaced WSSE password element).
-  * Added support for global header and namespaces. See Github issue #9 (Setting headers and namespaces).
+  * Fix for issue #21 (savon is stripping ?SOAP off the end of WSDL locations).
+  * Fix for issue #22 (REXML::ParseException parsing 401 Unauthorized response body).
+  * Fix for issue #19 (Unable to set attribute in name-spaced WSSE password element).
+  * Added support for global header and namespaces. See issue #9 (Setting headers and namespaces).
 
 == 0.7.1 (2010-01-10)
   * The Hash of HTTP headers for SOAP calls is now public via Savon::Request#headers.
@@ -122,3 +153,4 @@
 
 == 0.5.0 (2009-11-29)
   * Complete rewrite.
+

data/README.rdoc

@@ -0,0 +1,78 @@
+= Savon
+
+==== Heavy metal Ruby SOAP client library
+
+{Documentation}[http://savon.rubiii.com] | {Metrics}[http://getcaliper.com/caliper/project?repo=git://github.com/rubiii/savon.git]
+
+== Installation
+
+  $ gem install savon
+
+Savon expects you to be familiar with SOAP, WSDL and tools like soapUI.
+
+== Instantiate a client
+
+Instantiate Savon::Client, passing in the WSDL of your service.
+
+  client = Savon::Client.new "http://example.com/UserService?wsdl"
+
+For production, it is highly recommended to not use Savon::WSDL. Information on {how to disable the WSDL}[http://savon.rubiii.com/docs/latest/classes/Savon/WSDL.html].
+
+== Choose authentication methods
+
+After the initialization of the client you can choose an authentication method to the requests.
+
+For Basic HTTP authentication:
+
+  client.request.basic_auth("username", "password")
+
+For NTLM HTTP authentication:
+
+  client.request.ntlm_auth("username", "password")
+
+Choose {Basic}[http://en.wikipedia.org/wiki/Basic_access_authentication] or {NTLM}[http://en.wikipedia.org/wiki/NTLM] according your needs.
+
+== Calling a SOAP action
+
+Assuming your service applies to the defaults, you can now call any available SOAP action.
+
+  response = client.get_all_users
+
+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.
+
+== The WSDL object
+
+Savon::WSDL represents the WSDL of your service, including information like the namespace URI and available SOAP actions.
+
+  client.wsdl.soap_actions
+  => [:get_all_users, :get_user_by_id, :user_magic]
+
+== The SOAP object
+
+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.
+
+  response = client.get_user_by_id { |soap| soap.body = { :id => 666 } }
+
+== The WSSE object
+
+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.
+
+  response = client.get_user_by_id do |soap, wsse|
+    wsse.username = "gorilla"
+    wsse.password = "secret"
+    soap.body = { :id => 666 }
+  end
+
+== The Response object
+
+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.
+
+== HTTP errors and SOAP faults
+
+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://savon.rubiii.com/docs/latest/classes/Savon/Response.html]
+
+== Logging
+
+Savon logs each request and response to STDOUT. But there are a couple of options to change the default behavior.
+More information: {Logging}[http://savon.rubiii.com/docs/latest/classes/Savon/Request.html]

data/Rakefile

@@ -1,16 +1,14 @@
 require "rake"
 require "spec/rake/spectask"
 require "spec/rake/verify_rcov"
-require "rake/rdoctask"
 
-task :default => :spec_verify
+task :default => :spec
 
 Spec::Rake::SpecTask.new do |spec|
   spec.spec_files = FileList["spec/{savon}/**/*_spec.rb"]
   spec.spec_opts << "--color"
   spec.libs += ["lib", "spec"]
   spec.rcov = true
-  spec.rcov_dir = "rcov"
 end
 
 RCov::VerifyTask.new(:spec_verify => :spec) do |verify|
@@ -30,16 +28,24 @@ task :spec_integration do
   end
 end
 
-desc "" # make this task invisible for "rake -T"
+desc "" # make this task invisible
 Spec::Rake::SpecTask.new(:run_integration_spec) do |spec|
   spec.spec_files = FileList["spec/{integration}/**/*_spec.rb"]
   spec.spec_opts << "--color"
   spec.libs += ["lib", "spec"]
 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"]
+begin
+  $:.unshift File.join(File.dirname(__FILE__), "..", "hanna", "lib")
+  require "hanna/rdoctask"
+
+  Rake::RDocTask.new do |rdoc|
+    rdoc.title = "Savon - Heavy metal Ruby SOAP client library"
+    rdoc.rdoc_dir = "doc"
+    rdoc.rdoc_files.include("**/*.rdoc").include("lib/**/*.rb")
+    rdoc.options << "--line-numbers"
+    rdoc.options << "--webcvs=http://github.com/rubiii/savon/tree/master/"
+  end
+rescue LoadError
+  puts "'gem install hanna' for documentation"
 end

data/lib/savon.rb

@@ -1,14 +1,5 @@
 module Savon
 
-  # Supported SOAP versions.
-  SOAPVersions = [1, 2]
-
-  # SOAP xs:dateTime format.
-  SOAPDateTimeFormat = "%Y-%m-%dT%H:%M:%S"
-
-  # SOAP xs:dateTime Regexp.
-  SOAPDateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
-
   # Raised in case of an HTTP error.
   class HTTPError < StandardError; end
 
@@ -18,17 +9,24 @@ module Savon
 end
 
 # standard libs
-%w(logger net/https openssl base64 digest/sha1 rexml/document).each do |lib|
-  require lib
-end
+require "logger"
+require "net/https"
+require "base64"
+require "digest/sha1"
+require "rexml/document"
 
-# gems
-require "rubygems"
-%w(builder crack/xml).each do |gem|
-  require gem
-end
+# gem dependencies
+require "builder"
+require "crack/xml"
+require 'net/ntlm_http'
 
 # core files
-%w(core_ext wsse soap request response wsdl client).each do |file|
-  require File.dirname(__FILE__) + "/savon/#{file}"
-end
+require "savon/core_ext"
+require "savon/wsse"
+require "savon/soap"
+require "savon/logger"
+require "savon/request"
+require "savon/response"
+require "savon/wsdl_stream"
+require "savon/wsdl"
+require "savon/client"

data/lib/savon/client.rb

@@ -1,13 +1,47 @@
 module Savon
 
-  # == Savon::Client
+  # = Savon::Client
   #
-  # Heavy metal Ruby SOAP client library. Minimizes the overhead of working
-  # with SOAP services and XML.
+  # Savon::Client is the main object for connecting to a SOAP service. It includes methods to access
+  # both the Savon::WSDL and Savon::Request object.
+  #
+  # == Instantiation
+  #
+  # Depending on whether you aim to use Savon with or without Savon::WSDL, you need to instantiate
+  # Savon::Client by passing in the WSDL or SOAP endpoint.
+  #
+  # Client instance with a WSDL endpoint:
+  #
+  #   client = Savon::Client.new "http://example.com/UserService?wsdl"
+  #
+  # Client instance with a SOAP endpoint (for using Savon without a WSDL):
+  #
+  #   client = Savon::Client.new "http://example.com/UserService"
+  #
+  # It is recommended to not use Savon::WSDL for production. Please take a look at the Documentation
+  # for Savon::WSDL for more information about how to disable it.
+  #
+  # == Using a proxy server
+  #
+  # You can specify the URI to a proxy server via optional hash arguments.
+  #
+  #   client = Savon::Client.new "http://example.com/UserService?wsdl", :proxy => "http://proxy.example.com"
+  #
+  # == Savon::WSDL
+  #
+  # You can access Savon::WSDL via:
+  #
+  #   client.wsdl
+  #
+  # == Savon::Request
+  #
+  # You can also access Savon::Request via:
+  #
+  #   client.request
   class Client
 
-    # Expects a SOAP +endpoint+ String. Also accepts an optional Hash of
-    # +options+ for specifying a proxy server and SSL client authentication.
+    # Expects a SOAP +endpoint+ string. Also accepts an optional hash of +options+ for specifying
+    # a +:proxy+ server to use.
     def initialize(endpoint, options = {})
       @request = Request.new endpoint, options
       @wsdl = WSDL.new @request
@@ -25,34 +59,30 @@ module Savon
       super
     end
 
+    # Same as method_missing. Workaround for SOAP actions that method_missing does not catch
+    # because the method does exist.
+    def call(method, *args, &block)
+      method_missing method, *args, &block
+    end
+
   private
 
     # Dispatches requests to SOAP actions matching a given +method+ name.
     def method_missing(method, *args, &block) #:doc:
-      soap_call = soap_call_from method.to_s
-      super if @wsdl.enabled? && !@wsdl.respond_to?(soap_call)
+      soap_action = soap_action_from method.to_s
+      super unless @wsdl.respond_to? soap_action
 
-      setup_objects operation_from(soap_call), &block
+      setup_objects *@wsdl.operation_from(soap_action), &block
       Response.new @request.soap(@soap)
     end
 
-    # Sets whether to use Savon::WSDL by a given +method+ name and
-    # removes exclamation marks from the given +method+ name.
-    def soap_call_from(method)
-      if method[-1, 1] == "!"
-        @wsdl.enabled = false
-        method[0, method.length-1].to_sym
-      else
-        @wsdl.enabled = true
-        method.to_sym
-      end
-    end
+    # Sets whether to use Savon::WSDL by a given +method+ name and returns the original method name
+    # without exclamation marks.
+    def soap_action_from(method)
+      @wsdl.enabled = !method.ends_with?("!")
 
-    # Returns a SOAP operation Hash containing the SOAP action and input
-    # for a given +soap_call+.
-    def operation_from(soap_call)
-      return @wsdl.operations[soap_call] if @wsdl.enabled?
-      { :action => soap_call.to_soap_key, :input => soap_call.to_soap_key }
+      method.chop! if method.ends_with?("!")
+      method.to_sym
     end
 
     # Returns the SOAP endpoint.
@@ -60,19 +90,17 @@ module Savon
       @wsdl.enabled? ? @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_objects(operation, &block)
-      @soap, @wsse = SOAP.new, WSSE.new
-      @soap.action, @soap.input, @soap.endpoint = operation[:action], operation[:input], soap_endpoint
-
+    # 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_objects(action, input, &block)
+      @soap, @wsse = SOAP.new(action, input, soap_endpoint), WSSE.new
       yield_objects &block if block
-
       @soap.namespaces["xmlns:wsdl"] ||= @wsdl.namespace_uri if @wsdl.enabled?
       @soap.wsse = @wsse
     end
 
-    # Yields Savon::SOAP and Savon::WSSE to a given +block+.
+    # Yields either Savon::SOAP or Savon::SOAP and Savon::WSSE to a given +block+, depending on
+    # the number of arguments expected by the block.
     def yield_objects(&block)
       case block.arity
         when 1 then yield @soap

data/lib/savon/core_ext.rb

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

data/lib/savon/core_ext/array.rb

@@ -0,0 +1,31 @@
+class Array
+
+  # Translates the Array into SOAP compatible XML. See: Hash.to_soap_xml.
+  def to_soap_xml(key, attributes = {})
+    xml = Builder::XmlMarkup.new
+
+    each_with_index do |item, index|
+      attrs = tag_attributes attributes, index
+      case item
+        when Hash then xml.tag!(key, attrs) { xml << item.to_soap_xml }
+        else           xml.tag!(key, attrs) { xml << item.to_soap_value }
+      end
+    end
+
+    xml.target!
+  end
+
+private
+
+  # Takes a Hash of +attributes+ and the +index+ for which to return attributes
+  # for duplicate tags.
+  def tag_attributes(attributes, index)
+    return {} if attributes.empty?
+
+    attributes.inject({}) do |hash, (key, value)|
+      value = value[index] if value.kind_of? Array
+      hash.merge key => value
+    end
+  end
+
+end

data/lib/savon/core_ext/datetime.rb

@@ -2,7 +2,7 @@ class DateTime
 
   # Returns the DateTime as an xs:dateTime formatted String.
   def to_soap_value
-    strftime Savon::SOAPDateTimeFormat
+    strftime Savon::SOAP::DateTimeFormat
   end
 
 end

data/lib/savon/core_ext/hash.rb

@@ -1,78 +1,102 @@
 class Hash
 
-  # Error message for missing :@inorder elements.
-  InOrderMissing = "Missing elements in :@inorder %s"
-
-  # Error message for spurious :@inorder elements.
-  InOrderSpurious = "Spurious elements in :@inorder %s"
-
-  # Returns the values from the 'soap:Body' element or an empty Hash
-  # in case the node could not be found.
+  # Returns the values from the soap:Body element or an empty Hash in case the soap:Body tag could
+  # not be found.
   def find_soap_body
-    envelope = self[self.keys.first] || {}
+    envelope = self[keys.first] || {}
     body_key = envelope.keys.find { |key| /.+:Body/ =~ key } rescue nil
     body_key ? envelope[body_key].map_soap_response : {}
   end
 
-  # Returns the Hash translated into SOAP request compatible XML.
+  # Translates the Hash into SOAP request compatible XML.
+  #
+  #   { :find_user => { :id => 123, "wsdl:Key" => "api" } }.to_soap_xml
+  #   # => "<findUser><id>123</id><wsdl:Key>api</wsdl:Key></findUser>"
+  #
+  # ==== Mapping
+  #
+  # * Hash keys specified as Symbols are converted to lowerCamelCase Strings
+  # * Hash keys specified as Strings are not converted and may contain namespaces
+  # * DateTime values are converted to xs:dateTime Strings
+  # * Objects responding to to_datetime (except Strings) are converted to xs:dateTime Strings
+  # * TrueClass and FalseClass objects are converted to "true" and "false" Strings
+  # * All other objects are expected to be converted to Strings using to_s
+  #
+  # An example:
+  #
+  #   { :magic_request => {
+  #       :perform_move => true,
+  #       "perform_at" => DateTime.new(2010, 11, 22, 11, 22, 33)
+  #     }
+  #   }.to_soap_xml
+  #
+  #   <magicRequest>
+  #     <performMove>true</performMove>
+  #     <perform_at>2012-06-11T10:42:21</perform_at>
+  #   </magicRequest>
+  #
+  # ==== :order!
+  #
+  # In case your service requires the tags to be in a specific order (parameterOrder), you have two
+  # options. The first is to specify your body as an XML string. The second is to specify the order
+  # through an additional array stored under the +:order!+ key.
   #
-  # To control the order of output, add a key of :@inorder with
-  # the value being an Array listing keys in order.
+  #   { :name => "Eve", :id => 123, :order! => [:id, :name] }.to_soap_xml
+  #   # => "<id>123</id><name>Eve</name>"
   #
-  # === Examples
+  # ==== :attributes!
   #
-  #   { :find_user => { :id => 666 } }.to_soap_xml
-  #   => "<findUser><id>666</id></findUser>"
+  # If you need attributes, you could either go with an XML string or add another hash under the
+  # +:attributes!+ key.
   #
-  #   { :find_user => { :name => "Lucy", :id => 666, :@inorder => [:id, :name] } }.to_soap_xml
-  #   => "<findUser><id>666</id><name>Lucy</name></findUser>"
+  #   { :person => "Eve", :attributes! => { :person => { :id => 666 } } }.to_soap_xml
+  #   # => '<person id="666">Eve</person>'
   def to_soap_xml
-    @soap_xml = Builder::XmlMarkup.new
-    inorder(self).each { |key| nested_data_to_soap_xml key, self[key] }
-    @soap_xml.target!
+    xml = Builder::XmlMarkup.new
+    attributes = delete(:attributes!) || {}
+
+    order.each do |key|
+      attrs = attributes[key] || {}
+      value = self[key]
+      key = key.to_soap_key
+
+      case value
+        when Array then xml << value.to_soap_xml(key, attrs)
+        when Hash  then xml.tag!(key, attrs) { xml << value.to_soap_xml }
+        else            xml.tag!(key, attrs) { xml << value.to_soap_value }
+      end
+    end
+
+    xml.target!
   end
 
-  # Maps keys and values of a Hash created from SOAP response XML to
-  # more convenient Ruby Objects.
+  # Maps keys and values of a Hash created from SOAP response XML to more convenient Ruby Objects.
   def map_soap_response
     inject({}) do |hash, (key, value)|
-      key = key.strip_namespace.snakecase.to_sym
-
       value = case value
         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 Array  then value.map { |val| val.map_soap_response rescue val }
         when String then value.map_soap_response
       end
-      hash.merge key => value
+
+      hash.merge key.strip_namespace.snakecase.to_sym => value
     end
   end
 
 private
 
-  # Expects a Hash +key+ and +value+ and recursively creates an XML structure
-  # representing the Hash content.
-  def nested_data_to_soap_xml(key, value)
-    case value
-      when Array
-        value.map { |subitem| nested_data_to_soap_xml key, subitem }
-      when Hash
-        @soap_xml.tag!(key.to_soap_key) do
-          inorder(value).each { |subkey| nested_data_to_soap_xml subkey, value[subkey] }
-        end
-      else
-        @soap_xml.tag!(key.to_soap_key) { @soap_xml << value.to_soap_value }
-    end
-  end
+  # Deletes and returns an Array of keys stored under the :order! key. Defaults to return the actual
+  # keys of this Hash if no :order! key could be found. Raises an ArgumentError in case the :order!
+  # Array does not match the Hash keys.
+  def order
+    order = delete :order!
+    order = keys unless order.kind_of? Array
+
+    missing, spurious = keys - order, order - keys
+    raise ArgumentError, "Missing elements in :order! #{missing.inspect}" unless missing.empty?
+    raise ArgumentError, "Spurious elements in :order! #{spurious.inspect}" unless spurious.empty?
 
-  # Takes a +hash+, removes the :@inorder marker and returns its keys.
-  # Raises an error in case an :@inorder Array does not match the Hash keys.
-  def inorder(hash)
-    inorder = hash.delete :@inorder
-    hash_keys = hash.keys
-    inorder = hash_keys unless inorder.kind_of? Array
-    raise InOrderMissing % (hash_keys - inorder).inspect unless (hash_keys - inorder).empty?
-    raise InOrderSpurious % (inorder - hash_keys).inspect unless (inorder - hash_keys).empty?
-    inorder
+    order
   end
 
-end
+end