savon 0.9.9 → 0.9.10

data/.travis.yml

@@ -1,4 +1,5 @@
 # https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
+language: "ruby"
 script: "bundle exec rake"
 rvm:
   - 1.8.7

data/.yardopts

@@ -3,3 +3,4 @@
 -
 CHANGELOG.md
 LICENSE
+lib/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 0.9.10 (2012-06-06)
+
+* Feature: [#289](https://github.com/rubiii/savon/pull/289) - Allow the SOAP envelope header to be set as a String.
+
+* Feature: In addition to the global configuration, there's now also one configuration per client.
+  The global config is cloned when a new client is initialized and gets used instead of the global one.
+  In addition, for `Savon::Model` classes, the config is cloned per class.
+
+  Closes [#84](https://github.com/rubiii/savon/issues/84) by allowing one logger per client and 
+  [#270](https://github.com/rubiii/savon/issues/270) by allowing to specify error handling per client.
+
+* Feature: Added an option to pretty print XML in log messages. Closes [#256](https://github.com/rubiii/savon/issues/256)
+  and [#280](https://github.com/rubiii/savon/issues/280).
+
+    ``` ruby
+    # global
+    Savon.configure do |config|
+      config.pretty_print_xml = true
+    end
+
+    # per client
+    client.config.pretty_print_xml = true
+    ```
+
+* Refactoring:
+  * Added `Savon.client` as a shortcut for creating a new `Savon::Client`
+  * Changed `Savon::Config` from a module to a class.
+  * Moved logging to the new `Savon::Logger` object.
+  * Removed the `blank?` extension from `Object`.
+
 ## 0.9.9 (2012-02-17)
 
 * Improvement: [pull request 255](https://github.com/rubiii/savon/pull/255) - Raise an error if fetching

data/Rakefile

@@ -1,7 +1,20 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new
+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
+
+# http://stackoverflow.com/q/5771758/279024
+task :require_ruby_18 do
+  raise "This must be run on Ruby 1.8" unless RUBY_VERSION =~ /^1\.8/
+end
+task :release => [:require_ruby_18]
 
 task :default => :spec
 task :test => :spec

data/lib/savon.rb

@@ -4,12 +4,20 @@ require "savon/client"
 require "savon/model"
 
 module Savon
-  extend Config
+  extend self
 
-  # Yields this module to a given +block+. Please refer to the
-  # <tt>Savon::Config</tt> module for configuration options.
-  def self.configure
-    yield self if block_given?
+  def client(*args)
+    Client.new(*args)
   end
 
+  def configure
+    yield config
+  end
+
+  def config
+    @config ||= Config.default
+  end
+
+  attr_writer :config
+
 end

data/lib/savon/client.rb

@@ -30,11 +30,16 @@ module Savon
     #     wsdl.namespace = "http://users.example.com"
     #   end
     def initialize(wsdl_document = nil, &block)
+      self.config = Savon.config.clone
       wsdl.document = wsdl_document if wsdl_document
+
       process 1, &block if block
       wsdl.request = http
     end
 
+    # Accessor for the <tt>Savon::Config</tt>.
+    attr_accessor :config
+
     # Returns the <tt>Savon::Wasabi::Document</tt>.
     def wsdl
       @wsdl ||= Wasabi::Document.new
@@ -71,12 +76,12 @@ module Savon
     def request(*args, &block)
       raise ArgumentError, "Savon::Client#request requires at least one argument" if args.empty?
 
-      self.soap = SOAP::XML.new
+      self.soap = SOAP::XML.new(config)
       preconfigure extract_options(args)
       process &block if block
       soap.wsse = wsse
 
-      response = SOAP::Request.new(http, soap).response
+      response = SOAP::Request.new(config, http, soap).response
       set_cookie response.http.headers
       response
     end

data/lib/savon/config.rb

@@ -1,103 +1,27 @@
-require "logger"
-require "savon/soap"
+require "savon/logger"
 require "savon/hooks/group"
+require "savon/soap"
 
 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
+  Config = Struct.new(:logger, :pretty_print_xml, :raise_errors, :soap_version, :env_namespace, :soap_header) do
 
-    # Returns whether to raise errors. Defaults to +true+.
-    def raise_errors?
-      @raise_errors != false
+    def self.default
+      config = new
+      config.logger = Logger.new
+      config.raise_errors = true
+      config.soap_version = SOAP::DefaultVersion
+      config
     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
+    def clone
+      config = super
+      config.logger = config.logger.clone
+      config
     end
 
   end
 end
-

data/lib/savon/log_message.rb

@@ -0,0 +1,47 @@
+module Savon
+  class LogMessage
+
+    def initialize(message, filter, options = {})
+      self.message     = message
+      self.filter      = filter
+      self.with_pretty = options[:pretty]
+      self.with_filter = options[:filter]
+    end
+
+    attr_accessor :message, :filter, :with_pretty, :with_filter
+
+    def filter?
+      with_filter && filter.any?
+    end
+
+    def pretty?
+      with_pretty
+    end
+
+    def to_s
+      return message unless pretty? || filter?
+
+      doc = Nokogiri::XML(message)
+      doc = apply_filter(doc) if filter?
+      doc.to_xml(pretty_options)
+    end
+
+    private
+
+    def apply_filter(doc)
+      return doc unless doc.errors.empty?
+
+      filter.each do |fi|
+        doc.xpath("//*[local-name()='#{fi}']").each { |node| node.content = "***FILTERED***" }
+      end
+
+      doc
+    end
+
+    def pretty_options
+      return {} unless pretty?
+      { :indent => 2 }
+    end
+
+  end
+end

data/lib/savon/logger.rb

@@ -0,0 +1,37 @@
+require "logger"
+require "nokogiri"
+require "savon/log_message"
+
+module Savon
+  class Logger
+
+    def initialize(device = $stdout)
+      self.device = device
+    end
+
+    attr_accessor :device
+
+    def log(message, options = {})
+      log_raw LogMessage.new(message, filter, options).to_s
+    end
+
+    def log_raw(message)
+      subject.send(level, message)
+    end
+
+    attr_writer :subject, :level, :filter
+
+    def subject
+      @subject ||= ::Logger.new(device)
+    end
+
+    def level
+      @level ||= :debug
+    end
+
+    def filter
+      @filter ||= []
+    end
+
+  end
+end

data/lib/savon/model.rb

@@ -31,7 +31,7 @@ module Savon
       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
+          config.hooks.select(:model_soap_response).call(response) || response
         end
       }
     end
@@ -49,6 +49,11 @@ module Savon
     def class_action_module
       @class_action_module ||= Module.new do
 
+        # Returns the memoized <tt>Savon::Config</tt>.
+        def config
+          @config ||= Savon.config.clone
+        end
+
         # Returns the memoized <tt>Savon::Client</tt>.
         def client(&block)
           @client ||= Savon::Client.new(&block)

data/lib/savon/soap/request.rb

@@ -14,23 +14,26 @@ module Savon
 
       # Expects an <tt>HTTPI::Request</tt> and a <tt>Savon::SOAP::XML</tt> object
       # to execute a SOAP request and returns the response.
-      def self.execute(http, soap)
-        new(http, soap).response
+      def self.execute(config, http, soap)
+        new(config, http, soap).response
       end
 
-      # Expects an <tt>HTTPI::Request</tt> and a <tt>Savon::SOAP::XML</tt> object.
-      def initialize(http, soap)
+      # Expects an <tt>HTTPI::Request</tt>, a <tt>Savon::SOAP::XML</tt> object
+      # and a <tt>Savon::Config</tt>.
+      def initialize(config, http, soap)
+        self.config = config
         self.soap = soap
         self.http = configure(http)
       end
 
-      attr_accessor :soap, :http
+      attr_accessor :soap, :http, :config
 
       # Executes the request and returns the response.
       def response
-        @response ||= SOAP::Response.new(
-          Savon.hooks.select(:soap_request).call(self) || with_logging { HTTPI.post(http) }
-        )
+        @response ||= begin
+          response = config.hooks.select(:soap_request).call(self) || with_logging { HTTPI.post(http) }
+          SOAP::Response.new(config, response)
+        end
       end
 
     private
@@ -54,15 +57,15 @@ module Savon
 
       # Logs the SOAP request +url+, +headers+ and +body+.
       def log_request(url, headers, body)
-        Savon.log "SOAP request: #{url}"
-        Savon.log headers.map { |key, value| "#{key}: #{value}" }.join(", ")
-        Savon.log body, :filter
+        config.logger.log "SOAP request: #{url}"
+        config.logger.log headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+        config.logger.log body, :pretty => config.pretty_print_xml, :filter => true
       end
 
       # Logs the SOAP response +code+ and +body+.
       def log_response(code, body)
-        Savon.log "SOAP response (status #{code}):"
-        Savon.log body
+        config.logger.log "SOAP response (status #{code}):"
+        config.logger.log body, :pretty => config.pretty_print_xml
       end
 
     end

data/lib/savon/soap/response.rb

@@ -12,12 +12,13 @@ module Savon
     class Response
 
       # Expects an <tt>HTTPI::Response</tt> and handles errors.
-      def initialize(response)
+      def initialize(config, response)
+        self.config = config
         self.http = response
-        raise_errors if Savon.raise_errors?
+        raise_errors if config.raise_errors
       end
 
-      attr_accessor :http
+      attr_accessor :http, :config
 
       # Returns whether the request was successful.
       def success?

data/lib/savon/soap/xml.rb

@@ -25,12 +25,15 @@ module Savon
       }
 
       # Accepts an +endpoint+, an +input+ tag and a SOAP +body+.
-      def initialize(endpoint = nil, input = nil, body = nil)
+      def initialize(config, endpoint = nil, input = nil, body = nil)
+        self.config = config
         self.endpoint = endpoint if endpoint
         self.input = input if input
         self.body = body if body
       end
 
+      attr_accessor :config
+
       # Accessor for the SOAP +input+ tag.
       attr_accessor :input
 
@@ -43,9 +46,9 @@ module Savon
         @version = version
       end
 
-      # Returns the SOAP +version+. Defaults to <tt>Savon.soap_version</tt>.
+      # Returns the SOAP +version+. Defaults to <tt>Savon.config.soap_version</tt>.
       def version
-        @version ||= Savon.soap_version
+        @version ||= config.soap_version
       end
 
       # Sets the SOAP +header+ Hash.
@@ -53,7 +56,7 @@ module Savon
 
       # Returns the SOAP +header+. Defaults to an empty Hash.
       def header
-        @header ||= Savon.soap_header.nil? ? {} : Savon.soap_header
+        @header ||= config.soap_header.nil? ? {} : config.soap_header
       end
 
       # Sets the SOAP envelope namespace.
@@ -61,7 +64,7 @@ module Savon
 
       # Returns the SOAP envelope namespace. Uses the global namespace if set Defaults to :env.
       def env_namespace
-        @env_namespace ||= Savon.env_namespace.nil? ? :env : Savon.env_namespace
+        @env_namespace ||= config.env_namespace.nil? ? :env : config.env_namespace
       end
 
       # Sets the +namespaces+ Hash.
@@ -70,8 +73,9 @@ module Savon
       # Returns the +namespaces+. Defaults to a Hash containing the SOAP envelope namespace.
       def namespaces
         @namespaces ||= begin
-          key = env_namespace.blank? ? "xmlns" : "xmlns:#{env_namespace}"
-          { key => SOAP::Namespace[version] }
+          key = ["xmlns"]
+          key << env_namespace if env_namespace && env_namespace != ""
+          { key.join(":") => SOAP::Namespace[version] }
         end
       end
 
@@ -172,8 +176,11 @@ module Savon
       # Expects a builder +xml+ instance, a tag +name+ and accepts optional +namespaces+
       # and a block to create an XML tag.
       def tag(xml, name, namespaces = {}, &block)
-        return xml.tag! name, namespaces, &block if env_namespace.blank?
-        xml.tag! env_namespace, name, namespaces, &block
+        if env_namespace && env_namespace != ""
+          xml.tag! env_namespace, name, namespaces, &block
+        else
+          xml.tag! name, namespaces, &block
+        end
       end
 
       # Returns the complete Hash of namespaces.
@@ -185,7 +192,7 @@ module Savon
 
       # Returns the SOAP header as an XML String.
       def header_for_xml
-        @header_for_xml ||= Gyoku.xml(header) + wsse_header
+        @header_for_xml ||= (Hash === header ? Gyoku.xml(header) : header) + wsse_header
       end
 
       # Returns the WSSE header or an empty String in case WSSE was not set.