savon 0.9.7 → 0.9.8

data/.travis.yml

@@ -1,5 +1,4 @@
 # https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
-bundler_args: --without developer_happiness
 script: "bundle exec rake"
 rvm:
   - 1.8.7
@@ -9,3 +8,5 @@ rvm:
   - rbx
   - rbx-2.0
   - jruby
+notifications:
+  irc: "irc.freenode.org#savon"

data/.yardopts

@@ -1,2 +1,5 @@
+--markup markdown
+--markup-provider redcarpet
 -
-CHANGELOG.rdoc
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 0.9.8 (2012-02-15)
+
+* Feature: Savon now ships with [Savon::Model](http://rubygems.org/gems/savon_model).
+  Savon::Model is a lightweight DSL to be used inside your domain models. It's been refactored
+  and is now [even more useful](http://savonrb.com/#how_to_date_a_model) than before.
+
+* Feature: Merged [pull request 230](https://github.com/rubiii/savon/pull/230) to allow filtering values
+  in logged SOAP request XML messages.
+
+    ``` ruby
+    Savon.configure do |config|
+      config.log_filter = ["password"]
+    end
+    ```
+
+* Feature: Added an option to change the default encoding of the XML directive tag (defaults to UTF-8)
+  to fix [issue 234](https://github.com/rubiii/savon/issues/234).
+
+    ``` ruby
+    client.request(:find_user) do
+      soap.encoding = "UTF-16"
+      soap.body = { :id => 1 }
+    end
+    ```
+
+* Improvement: Merged [pull request 231](https://github.com/rubiii/savon/pull/231) to gracefully handle
+  invalid response bodies by throwing a `Savon::SOAP::InvalidResponseError`.
+
+* Fix: [issue 237](https://github.com/rubiii/savon/issues/237) - Set the Content-Type and Content-Length
+  headers for every request.
+
+* Fix: [pull request 250](https://github.com/rubiii/savon/pull/250) - The Content-Length header should
+  be the size in bytes.
+
 ## 0.9.7 (2011-08-25)
 
 * Feature: Merged [pull request 210](https://github.com/rubiii/savon/pull/210) by

data/Gemfile

@@ -2,8 +2,3 @@ source :rubygems
 gemspec
 
 gem "httpclient", "~> 2.1.5"
-
-# excluded from travis
-group :developer_happiness do
-  gem "autotest"
-end

data/README.md

@@ -1,10 +1,10 @@
-Savon [![Build Status](http://travis-ci.org/rubiii/savon.png)](http://travis-ci.org/rubiii/savon)
+Savon [![Build Status](https://secure.travis-ci.org/rubiii/savon.png)](http://travis-ci.org/rubiii/savon)
 =====
 
 Heavy metal Ruby SOAP client
 
 [Documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) |
-[Mailing list](http://groups.google.com/group/savon-soap) | [Twitter](http://twitter.com/savonrb)
+[Mailing list](https://groups.google.com/forum/#!forum/savonrb) | [Twitter](http://twitter.com/savonrb)
 
 Installation
 ------------
@@ -15,26 +15,28 @@ Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be
 $ gem install savon
 ```
 
-Basic workflow
---------------
+Introduction
+------------
 
 ``` ruby
-# Setting up a Savon::Client representing a SOAP service.
-client = Savon::Client.new "http://service.example.com?wsdl"
+require "savon"
+
+# create a client for your SOAP service
+client = Savon::Client.new("http://service.example.com?wsdl")
 
 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
+# execute a SOAP request to call the "getUser" action
+response = client.request(:get_user) do
   soap.body = { :id => 1 }
 end
 
-response.to_hash
+response.body
 # => { :get_user_response => { :first_name => "The", :last_name => "Hoff" } }
 ```
 
-Ready for more?
----------------
+Documentation
+-------------
 
-[Go ahead and read the official documentation](http://savonrb.com).
+Continue reading at [savonrb.com](http://savonrb.com)

data/Rakefile

@@ -1,11 +1,7 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
-
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w(-c)
-end
+RSpec::Core::RakeTask.new
 
 task :default => :spec
 task :test => :spec

data/lib/savon.rb

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

data/lib/savon/config.rb

@@ -0,0 +1,103 @@
+require "logger"
+require "savon/soap"
+require "savon/hooks/group"
+
+module Savon
+  module Config
+
+    # 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+. Optionally filtered if +xml+ is truthy.
+    def log(message, xml = false)
+      return unless log?
+      message = filter_xml(message) if xml && !log_filter.empty?
+      logger.send log_level, message
+    end
+
+    # Returns the log filter. Defaults to an empty Array.
+    def log_filter
+      @log_filter ||= []
+    end
+
+    # Sets the log filter. Expects an Array.
+    attr_writer :log_filter
+
+    # Filters the given +xml+ based on log filter.
+    def filter_xml(xml)
+      doc = Nokogiri::XML(xml)
+      return xml unless doc.errors.empty?
+
+      log_filter.each do |filter|
+        doc.xpath("//*[local-name()='#{filter}']").map { |node| node.content = "***FILTERED***" }
+      end
+
+      doc.root.to_s
+    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}" if version && !SOAP::Versions.include?(version)
+      @version = version
+    end
+
+    # Returns SOAP version. Defaults to +DefaultVersion+.
+    def soap_version
+      @version ||= SOAP::DefaultVersion
+    end
+
+    # Accessor for the global env_namespace.
+    attr_accessor :env_namespace
+
+    # Accessor for the global soap_header.
+    attr_accessor :soap_header
+
+    # Returns the hooks.
+    def hooks
+      @hooks ||= Hooks::Group.new
+    end
+
+    # Reset to default configuration.
+    def reset_config!
+      self.log = nil
+      self.logger = nil
+      self.log_level = nil
+      self.log_filter = nil
+      self.raise_errors = nil
+      self.soap_version = nil
+      self.env_namespace = nil
+      self.soap_header = nil
+    end
+
+  end
+end
+

data/lib/savon/hooks/group.rb

@@ -0,0 +1,46 @@
+require "savon/hooks/hook"
+
+module Savon
+  module Hooks
+
+    # = Savon::Hooks::Group
+    #
+    # Manages a list of hooks.
+    class Group
+
+      # Accepts an Array of +hooks+ to start with.
+      def initialize(hooks = nil)
+        self.hooks = hooks
+      end
+
+      attr_writer :hooks
+
+      def hooks
+        @hooks ||= []
+      end
+
+      # Adds a new hook.
+      def define(id, hook, &block)
+        hooks << Hook.new(id, hook, &block)
+      end
+
+      # Removes hooks matching the given +ids+.
+      def reject!(*ids)
+        ids = ids.flatten
+        hooks.reject! { |hook| ids.include? hook.id }
+      end
+
+      # Returns a new group for a given +hook+.
+      def select(hook)
+        Group.new hooks.select { |h| h.hook == hook }
+      end
+
+      # Calls the hooks with the given +args+ and returns the
+      # value of the last hooks.
+      def call(*args)
+        hooks.inject(nil) { |memo, hook| hook.call(*args) }
+      end
+
+    end
+  end
+end

data/lib/savon/hooks/hook.rb

@@ -0,0 +1,36 @@
+module Savon
+  module Hooks
+
+    # = Savon::Hooks::Hook
+    #
+    # A hook used somewhere in the system.
+    class Hook
+
+      HOOKS = [
+
+        # Replaces the POST request executed to call a service.
+        # See: Savon::SOAP::Request#response
+        #
+        # Receives the <tt>Savon::SOAP::Request</tt> and is expected to return an <tt>HTTPI::Response</tt>.
+        # It can change the request and return something falsy to still execute the POST request.
+        :soap_request
+
+      ]
+
+      # Expects an +id+, the name of the +hook+ to use and a +block+ to be called.
+      def initialize(id, hook, &block)
+        self.id = id
+        self.hook = hook
+        self.block = block
+      end
+
+      attr_accessor :id, :hook, :block
+
+      # Calls the +block+ with the given +args+.
+      def call(*args)
+        block.call(*args)
+      end
+
+    end
+  end
+end

data/lib/savon/model.rb

@@ -0,0 +1,103 @@
+module Savon
+
+  # = Savon::Model
+  #
+  # Model for SOAP service oriented applications.
+  module Model
+
+    def self.extended(base)
+      base.setup
+    end
+
+    def setup
+      class_action_module
+      instance_action_module
+    end
+
+    # Accepts one or more SOAP actions and generates both class and instance methods named
+    # after the given actions. Each generated method accepts an optional SOAP body Hash and
+    # a block to be passed to <tt>Savon::Client#request</tt> and executes a SOAP request.
+    def actions(*actions)
+      actions.each do |action|
+        define_class_action(action)
+        define_instance_action(action)
+      end
+    end
+
+  private
+
+    # Defines a class-level SOAP action method.
+    def define_class_action(action)
+      class_action_module.module_eval %{
+        def #{action.to_s.snakecase}(body = nil, &block)
+          response = client.request :wsdl, #{action.inspect}, :body => body, &block
+          Savon.hooks.select(:model_soap_response).call(response) || response
+        end
+      }
+    end
+
+    # Defines an instance-level SOAP action method.
+    def define_instance_action(action)
+      instance_action_module.module_eval %{
+        def #{action.to_s.snakecase}(body = nil, &block)
+          self.class.#{action.to_s.snakecase} body, &block
+        end
+      }
+    end
+
+    # Class methods.
+    def class_action_module
+      @class_action_module ||= Module.new do
+
+        # Returns the memoized <tt>Savon::Client</tt>.
+        def client(&block)
+          @client ||= Savon::Client.new(&block)
+        end
+
+        # Sets the SOAP endpoint to the given +uri+.
+        def endpoint(uri)
+          client.wsdl.endpoint = uri
+        end
+
+        # Sets the target namespace.
+        def namespace(uri)
+          client.wsdl.namespace = uri
+        end
+
+        # Sets the WSDL document to the given +uri+.
+        def document(uri)
+          client.wsdl.document = uri
+        end
+
+        # Sets the HTTP headers.
+        def headers(headers)
+          client.http.headers = headers
+        end
+
+        # Sets basic auth +login+ and +password+.
+        def basic_auth(login, password)
+          client.http.auth.basic(login, password)
+        end
+
+        # Sets WSSE auth credentials.
+        def wsse_auth(*args)
+          client.wsse.credentials(*args)
+        end
+
+      end.tap { |mod| extend(mod) }
+    end
+
+    # Instance methods.
+    def instance_action_module
+      @instance_action_module ||= Module.new do
+
+        # Returns the <tt>Savon::Client</tt> from the class instance.
+        def client(&block)
+          self.class.client(&block)
+        end
+
+      end.tap { |mod| include(mod) }
+    end
+
+  end
+end

data/lib/savon/soap/invalid_response_error.rb

@@ -0,0 +1,11 @@
+require "savon/error"
+
+module Savon
+  module SOAP
+    # = Savon::SOAP::InvalidResponseError
+    #
+    # Represents an error when the response was not a valid SOAP envelope.
+    class InvalidResponseError < Error
+    end
+  end
+end