savon 0.9.2 → 0.9.3

data/.gitignore

@@ -3,6 +3,7 @@
 doc
 coverage
 tmp
+*.rbc
 *~
 *.gem
 .bundle

data/.travis.yml

@@ -1,7 +1,8 @@
-script: "rake"
 rvm:
   - 1.8.7
   - 1.9.2
+  - ruby-head
   - ree
   - rbx
+  - rbx-2.0
   - jruby

data/CHANGELOG.md

@@ -1,6 +1,40 @@
+## 0.9.3 (2011-06-30)
+
+* Fix: [issue 138](https://github.com/rubiii/savon/issues/138) -
+  Savon now supports setting a global SOAP header via `Savon.soap_header=`.
+
+* Fixed the namespace for wsse message timestamps from `wsse:Timestamp`
+  to `wsu:Timestamp` as required by the specification.
+
+* Change: Removed support for NTLM authentication until it's stable. If you need it, you can still
+  add the following line to your Gemfile:
+
+      gem "httpi", "0.9.4"
+
+* Refactoring:
+
+  * `Hash#map_soap_response` and some of its helpers are moved to [Nori v1.0.0](http://rubygems.org/gems/nori/versions/1.0.0).
+    Along with replacing core extensions with a proper implementation, Nori now contains a number of methods
+    for configuring its default behavior:
+
+    * The option whether to strip namespaces was moved to Nori.strip_namespaces
+    * You can disable "advanced typecasting" for SOAP response values
+    * And you can configure how SOAP response keys should be converted
+
+    Please take a look at [Nori's CHANGELOG](https://github.com/rubiii/nori/blob/master/CHANGELOG.md)
+    for detailed information.
+
+  * `Savon::SOAP::XML.to_hash`, `Savon::SOAP::XML.parse` and `Savon::SOAP::XML.to_array` are gone.
+    It wasn't worth keeping them around, because they didn't do much. You can simply parse a SOAP
+    response and translate it to a Savon SOAP response Hash via:
+
+        Nori.parse(xml)[:envelope][:body]
+
+  * `Savon::SOAP::Response#basic_hash` is now `Savon::SOAP::Response#hash`.
+
 ## 0.9.2 (2011-04-30)
 
-* Fix: [issue](https://github.com/rubiii/savon/pull/154) -
+* Fix: [issue 154](https://github.com/rubiii/savon/pull/154) -
   Timezone format used by Savon now matches the XML schema spec.
 
 * Improvement: WSSE basic, digest and timestamp authentication are no longer mutually exclusive.

data/README.md

@@ -1,9 +1,10 @@
-Savon
+Savon [![Build Status](http://travis-ci.org/rubiii/savon.png)](http://travis-ci.org/rubiii/savon)
 =====
 
 Heavy metal Ruby SOAP client
 
-[Official documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) | [Google Group](http://groups.google.com/group/savon-soap)
+[Documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) |
+[Mailing list](http://groups.google.com/group/savon-soap) | [Twitter](http://twitter.com/savonrb)
 
 Installation
 ------------
@@ -33,7 +34,7 @@ response.to_hash
 # => { :get_user_response => { :first_name => "The", :last_name => "Hoff" } }
 ```
 
-Excited to learn more?
-----------------------
+Ready for more?
+---------------
 
-Then you might want to [go ahead and read the official documentation](http://savonrb.com).
+[Go ahead and read the official documentation](http://savonrb.com).

data/Rakefile

@@ -1,39 +1,8 @@
 require "rake"
+require "rspec/core/rake_task"
 
-begin
-  require "yard"
-
-  YARD::Rake::YardocTask.new do |t|
-    t.files = ["README.md", "lib/**/*.rb"]
-  end
-rescue LoadError
-  desc message = %{run "bundle install" 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 = %{run "bundle install" 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(-c)
-  end
-rescue LoadError
-  desc message = %{run "bundle install" to run the specs}
-  task(:spec) { abort message }
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(-c)
 end
 
 task :default => :spec

data/lib/savon/client.rb

@@ -113,7 +113,7 @@ module Savon
       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]
+      soap.body = options[2].delete(:body)
 
       set_soap_action options[1]
       set_soap_input *options

data/lib/savon/core_ext/object.rb

@@ -5,7 +5,7 @@ module Savon
       # 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 unless method_defined?(:blank?)
 
     end
   end

data/lib/savon/core_ext/string.rb

@@ -14,7 +14,7 @@ module Savon
         str.tr! "-", "_"
         str.downcase!
         str
-      end
+      end unless method_defined?(:snakecase)
 
       # Returns the String in lowerCamelCase.
       def lower_camelcase
@@ -29,20 +29,7 @@ module Savon
       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 unless method_defined?(:starts_with?)
 
     end
   end

data/lib/savon/global.rb

@@ -55,11 +55,15 @@ module Savon
     # Returns whether to strip namespaces in a SOAP response Hash.
     # Defaults to +true+.
     def strip_namespaces?
-      @strip_namespaces != false
+      Savon.deprecate("use Nori.strip_namespaces? instead of Savon.strip_namespaces?")
+      Nori.strip_namespaces?
     end
 
     # Sets whether to strip namespaces in a SOAP response Hash.
-    attr_writer :strip_namespaces
+    def strip_namespaces=(strip)
+      Savon.deprecate("use Nori.strip_namespaces= instead of Savon.strip_namespaces=")
+      Nori.strip_namespaces = strip
+    end
 
     # Returns the global env_namespace.
     attr_reader :env_namespace
@@ -67,6 +71,27 @@ module Savon
     # Sets the global env_namespace.
     attr_writer :env_namespace
 
+    # Returns the global soap_header.
+    attr_reader :soap_header
+
+    # Sets the global soap_header.
+    attr_writer :soap_header
+
+    # Expects a +message+ and raises a warning if configured.
+    def deprecate(message)
+      warn("Deprecation: #{message}") if deprecate?
+    end
+
+    # Sets whether to warn about deprecations.
+    def deprecate=(deprecate)
+      @deprecate = deprecate
+    end
+
+    # Returns whether to warn about deprecation.
+    def deprecate?
+      @deprecate != false
+    end
+
     # Reset to default configuration.
     def reset_config!
       self.log = true
@@ -76,6 +101,7 @@ module Savon
       self.soap_version = SOAP::DefaultVersion
       self.strip_namespaces = true
       self.env_namespace = nil
+      self.soap_header = {}
     end
 
   end

data/lib/savon/soap.rb

@@ -17,8 +17,5 @@ module Savon
       2 => "http://www.w3.org/2003/05/soap-envelope"
     }
 
-    # SOAP xs:dateTime Regexp.
-    DateTimeRegexp = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
-
   end
 end

data/lib/savon/soap/fault.rb

@@ -30,7 +30,7 @@ module Savon
 
       # Returns the SOAP response body as a Hash.
       def to_hash
-        @hash ||= Savon::SOAP::XML.to_hash http.body
+        @hash ||= Nori.parse(http.body)[:envelope][:body]
       end
 
     private

data/lib/savon/soap/request.rb

@@ -12,6 +12,12 @@ module Savon
       # Content-Types by SOAP version.
       ContentType = { 1 => "text/xml;charset=UTF-8", 2 => "application/soap+xml;charset=UTF-8" }
 
+      # 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(request, soap)
+        new(request, soap).response
+      end
+
       # Expects an <tt>HTTPI::Request</tt> and a <tt>Savon::SOAP::XML</tt> object.
       def initialize(request, soap)
         self.request = setup(request, soap)

data/lib/savon/soap/response.rb

@@ -43,29 +43,38 @@ module Savon
         @http_error ||= HTTP::Error.new http
       end
 
-      # Returns the SOAP response header as a Hash.
-      def header
-        @header_hash ||= basic_hash.find_soap_header
+      # Shortcut accessor for the SOAP response body Hash.
+      def [](key)
+        body[key]
       end
 
-      # Shortcut for the +to_hash+ method.
-      def [](key)
-        to_hash[key]
+      # Returns the SOAP response header as a Hash.
+      def header
+        hash[:envelope][:header]
       end
 
       # Returns the SOAP response body as a Hash.
-      def to_hash
-        @hash ||= Savon::SOAP::XML.to_hash basic_hash
+      def body
+        hash[:envelope][:body]
       end
 
-      # Returns the SOAP response body as an Array.
+      alias to_hash body
+
+      # Traverses the SOAP response body Hash for a given +path+ of Hash keys and returns
+      # the value as an Array. Defaults to return an empty Array in case the path does not
+      # exist or returns nil.
       def to_array(*path)
-        Savon::SOAP::XML.to_array to_hash, *path
+        result = path.inject body do |memo, key|
+          return [] unless memo[key]
+          memo[key]
+        end
+
+        result.kind_of?(Array) ? result.compact : [result].compact
       end
 
       # Returns the complete SOAP response XML without normalization.
-      def basic_hash
-        @basic_hash ||= Savon::SOAP::XML.parse http.body
+      def hash
+        @hash ||= Nori.parse http.body
       end
 
       # Returns the SOAP response XML.

data/lib/savon/soap/xml.rb

@@ -1,9 +1,13 @@
 require "builder"
-require "nori"
 require "gyoku"
+require "nori"
 
 require "savon/soap"
-require "savon/core_ext/hash"
+
+Nori.configure do |config|
+  config.strip_namespaces = true
+  config.convert_tags_to { |tag| tag.snakecase.to_sym }
+end
 
 module Savon
   module SOAP
@@ -20,31 +24,6 @@ module Savon
         "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance"
       }
 
-      # Converts the given SOAP response +value+ (XML or Hash) into a normalized Hash.
-      def self.to_hash(value)
-        value = parse value unless value.kind_of? Hash
-        value.find_soap_body
-      end
-
-      # Converts a given SOAP response +xml+ to a Hash.
-      def self.parse(xml)
-        Nori.parse(xml)
-      end
-
-      # Expects a SOAP response XML or Hash, traverses it for a given +path+ of Hash keys
-      # and returns the value as an Array. Defaults to return an empty Array in case the
-      # path does not exist or returns nil.
-      def self.to_array(object, *path)
-        hash = object.kind_of?(Hash) ? object : to_hash(object)
-
-        result = path.inject hash do |memo, key|
-          return [] unless memo[key]
-          memo[key]
-        end
-
-        result.kind_of?(Array) ? result.compact : [result].compact
-      end
-
       # Accepts an +endpoint+, an +input+ tag and a SOAP +body+.
       def initialize(endpoint = nil, input = nil, body = nil)
         self.endpoint = endpoint if endpoint
@@ -74,7 +53,7 @@ module Savon
 
       # Returns the SOAP +header+. Defaults to an empty Hash.
       def header
-        @header ||= {}
+        @header ||= Savon.soap_header.nil? ? {} : Savon.soap_header
       end
 
       # Sets the SOAP envelope namespace.
@@ -181,4 +160,3 @@ module Savon
     end
   end
 end
-

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  Version = "0.9.2"
+  Version = "0.9.3"
 
 end

data/lib/savon/wsdl/document.rb

@@ -90,7 +90,7 @@ module Savon
       # Executes an HTTP GET request to retrieve a remote WSDL document.
       def http_request
         request.url = @document
-        Request.new(request).response.body
+        Request.execute(request).body
       end
 
       # Reads the WSDL document from a local file.

data/lib/savon/wsdl/request.rb

@@ -8,6 +8,12 @@ module Savon
     # Executes WSDL requests.
     class Request
 
+      # Expects an <tt>HTTPI::Request</tt> to execute a WSDL request
+      # and returns the response.
+      def self.execute(request)
+        new(request).response
+      end
+
       # Expects an <tt>HTTPI::Request</tt>.
       def initialize(request)
         self.request = request

data/lib/savon/wsse.rb

@@ -2,7 +2,6 @@ require "base64"
 require "digest/sha1"
 
 require "savon/core_ext/string"
-require "savon/core_ext/hash"
 require "savon/core_ext/time"
 
 module Savon
@@ -56,20 +55,20 @@ module Savon
       username && password
     end
 
-    # Returns whether to generate a wsse:Timestamp header.
+    # Returns whether to generate a wsu:Timestamp header.
     def timestamp?
-      created_at || expires_at || @wsse_timestamp
+      created_at || expires_at || @wsu_timestamp
     end
 
-    # Sets whether to generate a wsse:Timestamp header.
+    # Sets whether to generate a wsu:Timestamp header.
     def timestamp=(timestamp)
-      @wsse_timestamp = timestamp
+      @wsu_timestamp = timestamp
     end
 
     # Returns the XML for a WSSE header.
     def to_xml
       if username_token? && timestamp?
-        Gyoku.xml wsse_username_token.merge!(wsse_timestamp) {
+        Gyoku.xml wsse_username_token.merge!(wsu_timestamp) {
           |key, v1, v2| v1.merge!(v2) {
             |key, v1, v2| v1.merge!(v2)
           }
@@ -77,7 +76,7 @@ module Savon
       elsif username_token?
         Gyoku.xml wsse_username_token.merge!(hash)
       elsif timestamp?
-        Gyoku.xml wsse_timestamp.merge!(hash)
+        Gyoku.xml wsu_timestamp.merge!(hash)
       else
         ""
       end
@@ -88,33 +87,34 @@ module Savon
     # Returns a Hash containing wsse:UsernameToken details.
     def wsse_username_token
       if digest?
-        wsse_security "UsernameToken",
+        security_hash :wsse, "UsernameToken",
           "wsse:Username" => username,
           "wsse:Nonce" => nonce,
           "wsu:Created" => timestamp,
           "wsse:Password" => digest_password,
           :attributes! => { "wsse:Password" => { "Type" => PasswordDigestURI } }
       else
-        wsse_security "UsernameToken",
+        security_hash :wsse, "UsernameToken",
           "wsse:Username" => username,
           "wsse:Password" => password,
           :attributes! => { "wsse:Password" => { "Type" => PasswordTextURI } }
       end
     end
 
-    # Returns a Hash containing wsse:Timestamp details.
-    def wsse_timestamp
-      wsse_security "Timestamp",
+    # Returns a Hash containing wsu:Timestamp details.
+    def wsu_timestamp
+      security_hash :wsu, "Timestamp",
         "wsu:Created" => (created_at || Time.now).xs_datetime,
         "wsu:Expires" => (expires_at || (created_at || Time.now) + 60).xs_datetime
     end
 
-    # Returns a Hash containing wsse:Security details for a given +tag+ and +hash+.
-    def wsse_security(tag, hash)
+    # Returns a Hash containing wsse/wsu Security details for a given
+    # +namespace+, +tag+ and +hash+.
+    def security_hash(namespace, tag, hash)
       {
         "wsse:Security" => {
-          "wsse:#{tag}" => hash,
-          :attributes! => { "wsse:#{tag}" => { "wsu:Id" => "#{tag}-#{count}", "xmlns:wsu" => WSUNamespace } }
+          "#{namespace}:#{tag}" => hash,
+          :attributes! => { "#{namespace}:#{tag}" => { "wsu:Id" => "#{tag}-#{count}", "xmlns:wsu" => WSUNamespace } }
         },
         :attributes! => { "wsse:Security" => { "xmlns:wsse" => WSENamespace } }
       }