s-savon 0.8.6

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+
+gem "httpclient", "~> 2.1.5"

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,37 @@
+Savon
+=====
+
+Heavy metal Ruby SOAP client
+
+[Guide](http://rubiii.github.com/savon) | [Rubydoc](http://rubydoc.info/gems/savon) | [Google Group](http://groups.google.com/group/savon-soap) | [Wishlist](http://savon.uservoice.com) | [Bugs](http://github.com/rubiii/savon/issues)
+
+Installation
+------------
+
+Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
+
+    $ gem install savon
+
+Basic workflow
+--------------
+
+    # Setting up a Savon::Client representing a SOAP service.
+    client = Savon::Client.new do
+      wsdl.document = "http://service.example.com?wsdl"
+    end
+
+    client.wsdl.soap_actions
+    # => [:create_user, :get_user, :get_all_users]
+
+    # Executing a SOAP request to call a "getUser" action.
+    response = client.request :get_user do
+      soap.body = { :id => 1 }
+    end
+
+    response.to_hash
+    # => { :get_user_response => { :first_name => "The", :last_name => "Hoff" } }
+
+Excited to learn more?
+----------------------
+
+Then you might want to go ahead and read the [Savon Guide](http://rubiii.github.com/savon).

data/Rakefile

@@ -0,0 +1,40 @@
+require "rake"
+
+begin
+  require "yard"
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["README.md", "lib/**/*.rb"]
+  end
+rescue LoadError
+  desc message = %{"gem install yard" to generate documentation}
+  task("yard") { abort message }
+end
+
+begin
+  require "metric_fu"
+
+  MetricFu::Configuration.run do |c|
+    c.metrics = [:churn, :flog, :flay, :reek, :roodi, :saikuro] # :rcov seems to be broken
+    c.graphs = [:flog, :flay, :reek, :roodi]
+    c.flay = { :dirs_to_flay => ["lib"], :minimum_score => 20 }
+    c.rcov[:rcov_opts] << "-Ilib -Ispec"
+  end
+rescue LoadError
+  desc message = %{"gem install metric_fu" to generate metrics}
+  task("metrics:all") { abort message }
+end
+
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-fd -c)
+  end
+rescue LoadError
+  desc message = %{"gem install rspec --pre" to run the specs}
+  task(:spec) { abort message }
+end
+
+task :default => :spec
+task :test => :spec

data/lib/savon.rb

@@ -0,0 +1,14 @@
+require "savon/version"
+require "savon/global"
+require "savon/client"
+
+module Savon
+  extend Global
+
+  # Yields this module to a given +block+. Please refer to the
+  # <tt>Savon::Global</tt> module for configuration options.
+  def self.configure
+    yield self if block_given?
+  end
+
+end

data/lib/savon/client.rb

@@ -0,0 +1,157 @@
+require "httpi/request"
+require "savon/soap/xml"
+require "savon/soap/request"
+require "savon/soap/response"
+require "savon/wsdl/document"
+require "savon/wsse"
+
+module Savon
+
+  # = Savon::Client
+  #
+  # Savon::Client is the main object for connecting to a SOAP service. It includes methods to access
+  # both the Savon::WSDL::Document and HTTPI::Request object.
+  class Client
+
+    # Initializes the Savon::Client for a SOAP service. Accepts a +block+ which is evaluated in the
+    # context of this object to let you access the +wsdl+, +http+, and +wsse+ methods.
+    #
+    # == Examples
+    #
+    #   # Using a remote WSDL
+    #   client = Savon::Client.new { wsdl.document = "http://example.com/UserService?wsdl" }
+    #
+    #   # Using a local WSDL
+    #   client = Savon::Client.new { wsdl.document = "../wsdl/user_service.xml" }
+    #
+    #   # Directly accessing a SOAP endpoint
+    #   client = Savon::Client.new do
+    #     wsdl.endpoint = "http://example.com/UserService"
+    #     wsdl.namespace = "http://users.example.com"
+    #   end
+    def initialize(&block)
+      process 1, &block if block
+      wsdl.request = http
+    end
+
+    # Returns the <tt>Savon::WSDL::Document</tt>.
+    def wsdl
+      @wsdl ||= WSDL::Document.new
+    end
+
+    # Returns the <tt>HTTPI::Request</tt>.
+    def http
+      @http ||= HTTPI::Request.new
+    end
+
+    # Returns the <tt>Savon::WSSE</tt> object.
+    def wsse
+      @wsse ||= WSSE.new
+    end
+
+    # Returns the <tt>Savon::SOAP::XML</tt> object. Please notice, that this object is only available
+    # in a block given to <tt>Savon::Client#request</tt>. A new instance of this object is created
+    # per SOAP request.
+    attr_reader :soap
+
+    # Executes a SOAP request for a given SOAP action. Accepts a +block+ which is evaluated in the
+    # context of this object to let you access the +soap+, +wsdl+, +http+ and +wsse+ methods.
+    #
+    # == Examples
+    #
+    #   # Calls a "getUser" SOAP action with the payload of "<userId>123</userId>"
+    #   client.request(:get_user) { soap.body = { :user_id => 123 } }
+    #
+    #   # Prefixes the SOAP input tag with a given namespace: "<wsdl:GetUser>...</wsdl:GetUser>"
+    #   client.request(:wsdl, "GetUser") { soap.body = { :user_id => 123 } }
+    #
+    #   # SOAP input tag with attributes: <getUser xmlns:wsdl="http://example.com">...</getUser>"
+    #   client.request(:get_user, "xmlns:wsdl" => "http://example.com")
+    def request(*args, &block)
+      raise ArgumentError, "Savon::Client#request requires at least one argument" if args.empty?
+
+      self.soap = SOAP::XML.new
+      preconfigure extract_options(args)
+      process &block if block
+      soap.wsse = wsse
+
+      response = SOAP::Request.new(http, soap).response
+      set_cookie response.http.headers
+      response
+    end
+
+  private
+
+    # Writer for the <tt>Savon::SOAP::XML</tt> object.
+    attr_writer :soap
+
+    # Accessor for the original self of a given block.
+    attr_accessor :original_self
+
+    # Passes a cookie from the last request +headers+ to the next one.
+    def set_cookie(headers)
+      http.headers["Cookie"] = headers["Set-Cookie"] if headers["Set-Cookie"]
+    end
+
+    # Expects an Array of +args+ and returns an Array containing the namespace (might be +nil+),
+    # the SOAP input and a Hash of attributes for the input tag (which might be empty).
+    def extract_options(args)
+      attributes = Hash === args.last ? args.pop : {}
+      namespace = args.size > 1 ? args.shift.to_sym : nil
+      input = args.first
+
+      [namespace, input, attributes]
+    end
+
+    # Expects and Array of +options+ and preconfigures the system.
+    def preconfigure(options)
+      soap.endpoint = wsdl.endpoint
+      soap.namespace_identifier = options[0]
+      soap.namespace = wsdl.namespace
+      soap.element_form_default = wsdl.element_form_default if wsdl.present?
+      soap.body = options[2].delete(:body) if options[2][:body]
+
+      set_soap_action options[1]
+      set_soap_input *options
+    end
+
+    # Expects an +input+ and sets the +SOAPAction+ HTTP headers.
+    def set_soap_action(input)
+      soap_action = wsdl.soap_action input.to_sym
+      soap_action ||= input.kind_of?(String) ? input : input.to_s.lower_camelcase
+      http.headers["SOAPAction"] = %{"#{soap_action}"}
+    end
+
+    # Expects a +namespace+, +input+ and +attributes+ and sets the SOAP input.
+    def set_soap_input(namespace, input, attributes)
+      new_input = wsdl.soap_input input.to_sym
+      new_input ||= input.kind_of?(String) ? input.to_sym : input.to_s.lower_camelcase.to_sym
+      soap.input = [namespace, new_input, attributes].compact
+    end
+
+    # Processes a given +block+. Yields objects if the block expects any arguments.
+    # Otherwise evaluates the block in the context of this object.
+    def process(offset = 0, &block)
+      block.arity > 0 ? yield_objects(offset, &block) : evaluate(&block)
+    end
+
+    # Yields a number of objects to a given +block+ depending on how many arguments
+    # the block is expecting.
+    def yield_objects(offset, &block)
+      yield *[soap, wsdl, http, wsse][offset, block.arity]
+    end
+
+    # Evaluates a given +block+ inside this object. Stores the original block binding.
+    def evaluate(&block)
+      self.original_self = eval "self", block.binding
+      instance_eval &block
+    end
+
+    # Handles calls to undefined methods by delegating to the original block binding.
+    def method_missing(method, *args, &block)
+      super unless original_self
+      original_self.send method, *args, &block
+    end
+
+  end
+end

data/lib/savon/core_ext/hash.rb

@@ -0,0 +1,70 @@
+require "builder"
+
+require "savon"
+require "savon/core_ext/object"
+require "savon/core_ext/string"
+
+module Savon
+  module CoreExt
+    module Hash
+
+      # Returns a new Hash with +self+ and +other_hash+ merged recursively.
+      # Modifies the receiver in place.
+      def deep_merge!(other_hash)
+        other_hash.each_pair do |k,v|
+          tv = self[k]
+          self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
+        end
+        self
+      end unless defined? deep_merge!
+
+      # Returns the values from the soap:Header element or an empty Hash in case the element could
+      # not be found.
+      def find_soap_header
+        find_soap_element /.+:Header/
+      end
+
+      # Returns the values from the soap:Body element or an empty Hash in case the element could
+      # not be found.
+      def find_soap_body
+        find_soap_element /.+:Body/
+      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)|
+          value = case value
+            when ::Hash   then value["xsi:nil"] ? nil : value.map_soap_response
+            when ::Array  then value.map { |val| val.map_soap_response rescue val }
+            when ::String then value.map_soap_response
+          end
+
+          new_key = if Savon.strip_namespaces?
+            key.strip_namespace.snakecase.to_sym
+          else
+            key.snakecase
+          end
+
+          if hash[new_key] # key already exists, value should be added as an Array
+            hash[new_key] = [hash[new_key], value].flatten
+            result = hash
+          else
+            result = hash.merge new_key => value
+          end
+          result
+        end
+      end
+
+    private
+
+      def find_soap_element(element)
+        envelope = self[keys.first] || {}
+        element_key = envelope.keys.find { |key| element =~ key } rescue nil
+        element_key ? envelope[element_key].map_soap_response : {}
+      end
+
+    end
+  end
+end
+
+Hash.send :include, Savon::CoreExt::Hash

data/lib/savon/core_ext/object.rb

@@ -0,0 +1,14 @@
+module Savon
+  module CoreExt
+    module Object
+
+      # Returns +true+ if the Object is nil, false or empty. Implementation from ActiveSupport.
+      def blank?
+        respond_to?(:empty?) ? empty? : !self
+      end unless defined? blank?
+
+    end
+  end
+end
+
+Object.send :include, Savon::CoreExt::Object

data/lib/savon/core_ext/string.rb

@@ -0,0 +1,51 @@
+require "savon/soap"
+
+module Savon
+  module CoreExt
+    module String
+
+      # 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 whether the String starts with a given +prefix+.
+      def starts_with?(prefix)
+        prefix = prefix.to_s
+        self[0, prefix.length] == prefix
+      end unless defined? starts_with?
+
+      # Returns the String without namespace.
+      def strip_namespace
+        split(":").last
+      end
+
+      # Translates SOAP response values to Ruby Objects.
+      def map_soap_response
+        return ::DateTime.parse(self) if Savon::SOAP::DateTimeRegexp === self
+        return true if self.strip.downcase == "true"
+        return false if self.strip.downcase == "false"
+        self
+      end
+
+    end
+  end
+end
+
+String.send :include, Savon::CoreExt::String

data/lib/savon/core_ext/time.rb

@@ -0,0 +1,14 @@
+module Savon
+  module CoreExt
+    module Time
+
+      # Returns an xs:dateTime formatted String.
+      def xs_datetime
+        strftime "%Y-%m-%dT%H:%M:%S%Z"
+      end
+
+    end
+  end
+end
+
+Time.send :include, Savon::CoreExt::Time

data/lib/savon/error.rb

@@ -0,0 +1,6 @@
+module Savon
+
+  # Base class for Savon errors.
+  class Error < RuntimeError; end
+
+end

data/lib/savon/global.rb

@@ -0,0 +1,75 @@
+require "logger"
+require "savon/soap"
+
+module Savon
+  module Global
+
+    # Sets whether to log HTTP requests.
+    attr_writer :log
+
+    # Returns whether to log HTTP requests. Defaults to +true+.
+    def log?
+      @log != false
+    end
+
+    # Sets the logger to use.
+    attr_writer :logger
+
+    # Returns the logger. Defaults to an instance of +Logger+ writing to STDOUT.
+    def logger
+      @logger ||= ::Logger.new STDOUT
+    end
+
+    # Sets the log level.
+    attr_writer :log_level
+
+    # Returns the log level. Defaults to :debug.
+    def log_level
+      @log_level ||= :debug
+    end
+
+    # Logs a given +message+.
+    def log(message)
+      logger.send log_level, message if log?
+    end
+
+    # Sets whether to raise HTTP errors and SOAP faults.
+    attr_writer :raise_errors
+
+    # Returns whether to raise errors. Defaults to +true+.
+    def raise_errors?
+      @raise_errors != false
+    end
+
+    # Sets the global SOAP version.
+    def soap_version=(version)
+      raise ArgumentError, "Invalid SOAP version: #{version}" unless SOAP::Versions.include? version
+      @version = version
+    end
+
+    # Returns SOAP version. Defaults to +DefaultVersion+.
+    def soap_version
+      @version ||= SOAP::DefaultVersion
+    end
+
+    # Returns whether to strip namespaces in a SOAP response Hash.
+    # Defaults to +true+.
+    def strip_namespaces?
+      @strip_namespaces != false
+    end
+
+    # Sets whether to strip namespaces in a SOAP response Hash.
+    attr_writer :strip_namespaces
+
+    # Reset to default configuration.
+    def reset_config!
+      self.log = true
+      self.logger = ::Logger.new STDOUT
+      self.log_level = :debug
+      self.raise_errors = true
+      self.soap_version = SOAP::DefaultVersion
+      self.strip_namespaces = true
+    end
+
+  end
+end