julianmorrison-savon 0.6.8

data/CHANGELOG

@@ -0,0 +1,92 @@
+== UPCOMING
+  * Changed the way you can disable Savon::WSDL. More information at: http://wiki.github.com/rubiii/savon/wsdl
+    Instead of disabling the WSDL globally/per request via two different methods, you now simply append an
+    exclamation mark (!) to your SOAP call. For example: client.get_all_users!
+    The Wiki page will be updated to relect this change as soon as it's released.
+  * Setting the "xmlns:wsdl" can be done by using the soap#namespaces method which returns a Hash of namespaces.
+    For example: soap.namespaces["xmlns:wsdl"] = "http://example.com"
+    I added soap#namespace as a convenience method to simplify setting the "xmlns:wsdl" namespace.
+    For example: soap.namespace = "http://example.com"
+
+== 0.6.8 (2010-01-01)
+  * Improved specifications for various kinds of WSDL documents.
+  * Added support for SOAP endpoints which are different than the WSDL endpoint of a service.
+  * Changed how SOAP actions and inputs are retrieved from the WSDL documents. This might break a few existing
+    implementations, but makes Savon work well with even more services. If this change breaks your implementation,
+    please take a look at the +action+ and +input+ methods of the Savon::SOAP object.
+    One specific problem I know of is working with the createsend WSDL and its namespaced actions.
+    To make it work, call the SOAP action without namespace and specify the input manually:
+    client.get_api_key { |soap| soap.input = "User.GetApiKey" }
+
+== 0.6.7 (2009-12-18)
+  * Implemented support for a proxy server. The proxy URI can be set through an optional Hash of options passed
+    to instantiating Savon::Client (Dave Woodward <dave@futuremint.com>)
+  * Implemented support for SSL client authentication. Settings can be set through an optional Hash of arguments
+    passed to instantiating Savon::Client (colonhyphenp)
+  * Patch for issue #10 (Problem with operation tags without a namespace).
+
+== 0.6.6 (2009-12-14)
+  * Default to use the name of the SOAP action (the method called in a client) in lowerCamelCase for SOAP action
+    and input when Savon::WSDL is disabled. You still need to specify soap.action and maybe soap.input in case
+    your SOAP actions are named any different.
+
+== 0.6.5 (2009-12-13)
+  * Added an open_timeout method to Savon::Request.
+
+== 0.6.4 (2009-12-13)
+  * Refactored specs to be less unit-like.
+  * Added a getter for the Savon::Request to Savon::Client and a read_timeout setter for HTTP requests.
+  * wsdl.soap_actions now returns an Array of SOAP actions. For the previous "mapping" please use wsdl.operations.
+  * Replaced WSDL document with stream parsing.
+
+    Benchmarks (1000 SOAP calls):
+
+           user        system     total       real
+    0.6.4  72.180000   8.280000   80.460000   (750.799011)
+    0.6.3  192.900000  19.630000  212.530000  (914.031865)
+
+== 0.6.3 (2009-12-11)
+  * Removing 2 ruby deprecation warnings for parenthesized arguments. (Dave Woodward <dave@futuremint.com>)
+  * Added global and per request options for disabling Savon::WSDL.
+
+    Benchmarks (1000 SOAP calls):
+
+                   user        system     total       real
+    WSDL           192.900000  19.630000  212.530000  (914.031865)
+    disabled WSDL  5.680000    1.340000   7.020000    (298.265318)
+
+  * Improved XPath expressions for parsing the WSDL document.
+
+    Benchmarks (1000 SOAP calls):
+
+           user        system     total       real
+    0.6.3  192.900000  19.630000  212.530000  (914.031865)
+    0.6.2  574.720000  78.380000  653.100000  (1387.778539)
+
+== 0.6.2 (2009-12-06)
+  * Added support for changing the name of the SOAP input node.
+  * Added a CHANGELOG.
+
+== 0.6.1 (2009-12-06)
+  * Fixed a problem with WSSE credentials, where every request contained a WSSE authentication header.
+
+== 0.6.0 (2009-12-06)
+  * method_missing now yields the SOAP and WSSE objects to a given block.
+  * The response_process (which previously was a block passed to method_missing) was replaced by Savon::Response.
+  * Improved SOAP action handling (another problem that came up with issue #1).
+
+== 0.5.3 (2009-11-30)
+  * Patch for issue #2 (NoMethodError: undefined method `invalid!' for Savon::WSDL)
+
+== 0.5.2 (2009-11-30)
+  * Patch for issue #1 (Calls fail if api methods have periods in them)
+
+== 0.5.1 (2009-11-29)
+  * Optimized default response process.
+  * Added WSSE settings via defaults.
+  * Added SOAP fault and HTTP error handling.
+  * Improved documentation
+  * Added specs
+
+== 0.5.0 (2009-11-29)
+  * Complete rewrite.

data/README.textile

@@ -0,0 +1,71 @@
+h1. Savon
+
+h4. Heavy metal Ruby SOAP client library
+
+p. "RDoc":http://rdoc.info/projects/rubiii/savon | "Wiki":http://wiki.github.com/rubiii/savon | "ToDo":http://rubiii.tadalist.com/lists/1459816/public | "Metrics":http://getcaliper.com/caliper/project?repo=git://github.com/rubiii/savon.git
+
+h2. Installation
+
+bc. $ gem install savon
+
+p. Savon expects you to be familiar with SOAP, WSDL and tools like soapUI.
+
+h2. Instantiate a client
+
+p. Instantiate Savon::Client, passing in the WSDL of your service.
+
+bc. client = Savon::Client.new "http://example.com/UserService?wsdl"
+
+p. More information: "Client":http://wiki.github.com/rubiii/savon/client
+
+h2. Calling a SOAP action
+
+p. Assuming your service applies to the "Defaults":http://wiki.github.com/rubiii/savon/defaults, you can now call any available SOAP action.
+
+bc. response = client.get_all_users
+
+p. 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.
+
+h2. The WSDL object
+
+p. Savon::WSDL represents the WSDL of your service, including information like the namespace URI and available SOAP actions.
+
+bc. client.wsdl.soap_actions
+=> [:get_all_users, :get_user_by_id, :user_magic]
+
+p. More information: "WSDL":http://wiki.github.com/rubiii/savon/wsdl
+
+h2. The SOAP object
+
+p. 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.
+
+bc. response = client.get_user_by_id { |soap| soap.body = { :id => 666 } }
+
+p. More information: "SOAP":http://wiki.github.com/rubiii/savon/soap
+
+h2. The WSSE object
+
+p. 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.
+
+bc. response = client.get_user_by_id do |soap, wsse|
+  wsse.username = "gorilla"
+  wsse.password = "secret"
+  soap.body = { :id => 666 }
+end
+
+p. More information: "WSSE":http://wiki.github.com/rubiii/savon/wsse
+
+h2. The Response object
+
+p. 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.
+More information: "Response":http://wiki.github.com/rubiii/savon/response
+
+h2. HTTP errors and SOAP faults
+
+p. 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://wiki.github.com/rubiii/savon/errors
+
+h2. Logging
+
+p. Savon logs each request and response to STDOUT. But there are a couple of options to change the default behaviour.
+More information: "Logging":http://wiki.github.com/rubiii/savon/logging

data/Rakefile

@@ -0,0 +1,27 @@
+require "rubygems"
+require "rake"
+require "spec/rake/spectask"
+require "spec/rake/verify_rcov"
+require "rake/rdoctask"
+
+task :default => :spec_verify_rcov
+
+Spec::Rake::SpecTask.new do |spec|
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
+  spec.spec_opts << "--color"
+  spec.libs += ["lib", "spec"]
+  spec.rcov = true
+  spec.rcov_dir = "rcov"
+end
+
+RCov::VerifyTask.new(:spec_verify_rcov => :spec) do |verify|
+  verify.threshold = 100.0
+  verify.index_html = "rcov/index.html"
+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"]
+end

data/lib/savon.rb

@@ -0,0 +1,34 @@
+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
+
+  # Raised in case of a SOAP fault.
+  class SOAPFault < StandardError; end
+
+end
+
+# standard libs
+%w(logger net/http net/https openssl uri base64 digest/sha1 rexml/document).each do |lib|
+  require lib
+end
+
+# gems
+require "rubygems"
+%w(builder crack/xml).each do |gem|
+  require gem
+end
+
+# core files
+%w(core_ext wsse soap request response wsdl client).each do |file|
+  require File.dirname(__FILE__) + "/savon/#{file}"
+end

data/lib/savon/client.rb

@@ -0,0 +1,84 @@
+module Savon
+
+  # == Savon::Client
+  #
+  # Heavy metal Ruby SOAP client library. Minimizes the overhead of working
+  # with SOAP services and XML.
+  class Client
+
+    # Expects a SOAP +endpoint+ String. Also accepts an optional Hash of
+    # +options+ for specifying a proxy server and SSL client authentication.
+    def initialize(endpoint, options = {})
+      @request = Request.new endpoint, options
+      @wsdl = WSDL.new @request
+    end
+
+    # Returns the Savon::WSDL.
+    attr_reader :wsdl
+
+    # Returns the Savon::Request.
+    attr_reader :request
+
+    # Returns +true+ for available methods and SOAP actions.
+    def respond_to?(method)
+      return true if @wsdl.respond_to? method
+      super
+    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)
+
+      setup_objects operation_from(soap_call), &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
+
+    # 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 }
+    end
+
+    # Returns the SOAP endpoint.
+    def soap_endpoint
+      @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
+
+      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+.
+    def yield_objects(&block)
+      case block.arity
+        when 1 then yield @soap
+        when 2 then yield @soap, @wsse
+      end
+    end
+
+  end
+end

data/lib/savon/core_ext.rb

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

data/lib/savon/core_ext/datetime.rb

@@ -0,0 +1,8 @@
+class DateTime
+
+  # Returns the DateTime as an xs:dateTime formatted String.
+  def to_soap_value
+    strftime Savon::SOAPDateTimeFormat
+  end
+
+end

data/lib/savon/core_ext/hash.rb

@@ -0,0 +1,78 @@
+class Hash
+
+  # Expects an Array of Regexp Objects of which every Regexp recursively
+  # matches a key to be accessed. Returns the value of the last Regexp filter
+  # found in the Hash or an empty Hash in case the path of Regexp filters
+  # did not match the Hash structure.
+  def find_regexp(regexp)
+    regexp = [regexp] unless regexp.kind_of? Array
+    result = dup
+
+    regexp.each do |pattern|
+      result_key = result.keys.find { |key| key.to_s.match pattern }
+      result = result[result_key] ? result[result_key] : {}
+    end
+    result
+  end
+
+  # Returns the Hash translated into SOAP request compatible XML.
+  #
+  # To control the order of output, add a key of :@inorder with
+  # the value being an array listing the other keys in order.
+  #
+  # === Example
+  #
+  #   { :find_user => { :id => 666 } }.to_soap_xml
+  #   => "<findUser><id>666</id></findUser>"
+  #
+  #   { :find_user => { :name => 'Lucy', :id => 666, :@inorder => [:id,:name] } }.to_soap_xml
+  #   => "<findUser><id>666</id><name>Lucy</name></findUser>"
+  def to_soap_xml
+    @soap_xml = Builder::XmlMarkup.new
+    i = self.delete :@inorder # retrieve the hash element keyed by :@inorder if it exists
+    k = self.keys
+    i = k unless (i and i.class == Array)
+    raise "missing elements in :@inorder #{(k - i).inspect}" unless (k - i).empty?
+    raise "spurious elements in :@inorder #{(i - k).inspect}" unless (i - k).empty?
+    i.each {|key| nested_data_to_soap_xml key, self[key] }
+    @soap_xml.target!
+  end
+
+  # 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 String then value.map_soap_response
+      end
+      hash.merge key => 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 { |sitem| nested_data_to_soap_xml key, sitem }
+      when Hash
+        @soap_xml.tag!(key.to_soap_key) do
+          i = value.delete :@inorder
+          k = value.keys
+          i = k unless (i and i.class == Array)
+          raise "missing elements in :@inorder #{(k - i).inspect}" unless (k - i).empty?
+          raise "spurious elements in :@inorder #{(i - k).inspect}" unless (i - k).empty?
+          i.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
+
+end

data/lib/savon/core_ext/object.rb

@@ -0,0 +1,21 @@
+class Object
+
+  # Returns +true+ if the Object is false, empty, or a whitespace string.
+  # For example, "", false, nil, [], and {} are blank.
+  # Implementation from ActiveSupport.
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end unless defined? blank?
+
+  # Returns the Object as a SOAP request compliant key.
+  def to_soap_key
+    to_s
+  end
+
+  # Returns the Object as a SOAP request compliant value.
+  def to_soap_value
+    return to_s unless respond_to? :to_datetime
+    to_datetime.to_soap_value
+  end
+
+end

data/lib/savon/core_ext/string.rb

@@ -0,0 +1,47 @@
+class String
+
+  # Returns a random String of a given +length+.
+  def self.random(length = 100)
+    (0...length).map { ("a".."z").to_a[rand(26)] }.join
+  end
+
+  # Returns the String in snake_case.
+  def snakecase
+    str = dup
+    str.gsub! /::/, '/'
+    str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+    str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+    str.tr! ".", "_"
+    str.tr! "-", "_"
+    str.downcase!
+    str
+  end
+
+  # Returns the String in lowerCamelCase.
+  def lower_camelcase
+    str = dup
+    str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
+    str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
+    str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
+    str
+  end
+
+  # Returns the String without namespace.
+  def strip_namespace
+    gsub /(.+:)(.+)/, '\2'
+  end
+
+  # Translates SOAP response values to more convenient Ruby Objects.
+  def map_soap_response
+    return DateTime.parse( self ) if Savon::SOAPDateTimeRegexp === self
+    return true if self.strip.downcase == "true"
+    return false if self.strip.downcase == "false"
+    self
+  end
+
+  # Returns the String as a SOAP request compliant value.
+  def to_soap_value
+    to_s
+  end
+
+end