savon 0.9.7 → 0.9.8

data/lib/savon/soap/request.rb

@@ -14,50 +14,49 @@ 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(request, soap)
-        new(request, soap).response
+      def self.execute(http, soap)
+        new(http, 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)
+      def initialize(http, soap)
+        self.soap = soap
+        self.http = configure(http)
       end
 
-      # Accessor for the <tt>HTTPI::Request</tt>.
-      attr_accessor :request
+      attr_accessor :soap, :http
 
       # Executes the request and returns the response.
       def response
-        @response ||= with_logging { HTTPI.post request }
+        @response ||= SOAP::Response.new(
+          Savon.hooks.select(:soap_request).call(self) || with_logging { HTTPI.post(http) }
+        )
       end
 
     private
 
-      # Sets up the +request+ using a given +soap+ object.
-      def setup(request, soap)
-        url, body = soap.endpoint, soap.to_xml
-
-        request.url = url
-        request.body = body
-        request.headers["Content-Type"] ||= ContentType[soap.version]
-        request.headers["Content-Length"] ||= body.length.to_s
-
-        request
+      # Configures a given +http+ from the +soap+ object.
+      def configure(http)
+        http.url = soap.endpoint
+        http.body = soap.to_xml
+        http.headers["Content-Type"] = ContentType[soap.version]
+        http.headers["Content-Length"] = soap.to_xml.bytesize.to_s
+        http
       end
 
       # Logs the HTTP request, yields to a given +block+ and returns a <tt>Savon::SOAP::Response</tt>.
       def with_logging
-        log_request request.url, request.headers, request.body
+        log_request http.url, http.headers, http.body
         response = yield
         log_response response.code, response.body
-        SOAP::Response.new response
+        response
       end
 
       # 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
+        Savon.log body, :filter
       end
 
       # Logs the SOAP response +code+ and +body+.

data/lib/savon/soap/response.rb

@@ -1,5 +1,6 @@
 require "savon/soap/xml"
 require "savon/soap/fault"
+require "savon/soap/invalid_response_error"
 require "savon/http/error"
 
 module Savon
@@ -50,11 +51,17 @@ module Savon
 
       # Returns the SOAP response header as a Hash.
       def header
+        if !hash.has_key? :envelope
+          raise Savon::SOAP::InvalidResponseError, "Unable to parse response body '#{to_xml}'"
+        end
         hash[:envelope][:header]
       end
 
       # Returns the SOAP response body as a Hash.
       def body
+        if !hash.has_key? :envelope
+          raise Savon::SOAP::InvalidResponseError, "Unable to parse response body '#{to_xml}'"
+        end
         hash[:envelope][:body]
       end
 

data/lib/savon/soap/xml.rb

@@ -125,6 +125,14 @@ module Savon
       # Accessor for the <tt>Savon::WSSE</tt> object.
       attr_accessor :wsse
 
+      # Returns the SOAP request encoding. Defaults to "UTF-8".
+      def encoding
+        @encoding ||= "UTF-8"
+      end
+
+      # Sets the SOAP request encoding.
+      attr_writer :encoding
+
       # Accepts a +block+ and yields a <tt>Builder::XmlMarkup</tt> object to let you create
       # custom body XML.
       def body
@@ -161,7 +169,7 @@ module Savon
     private
 
       # Returns a new <tt>Builder::XmlMarkup</tt> object.
-      def builder(directive_tag = :xml, attrs = {})
+      def builder(directive_tag = :xml, attrs = { :encoding => encoding })
         builder = Builder::XmlMarkup.new
         builder.instruct!(directive_tag, attrs) if directive_tag
         builder

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  Version = "0.9.7"
+  Version = "0.9.8"
 
 end

data/savon.gemspec

@@ -27,6 +27,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha",   "~> 0.9.8"
   s.add_development_dependency "timecop", "~> 0.3.5"
 
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "ZenTest", "4.5.0"
+
   s.files = `git ls-files`.split("\n")
   s.require_path = "lib"
 end

data/spec/savon/model_spec.rb

@@ -0,0 +1,194 @@
+require "spec_helper"
+
+describe Savon::Model do
+
+  let(:model) do
+    Class.new { extend Savon::Model }
+  end
+
+  describe ":model_soap_response hook" do
+
+    before(:all) do
+      model.actions :get_user, "GetAllUsers"
+    end
+
+    after do
+      Savon.hooks.reject! :test_hook
+    end
+
+    it "can be used for pre-processing SOAP responses" do
+      Savon.hooks.define(:test_hook, :model_soap_response) do |response|
+        "hello #{response}"
+      end
+
+      model.client.stubs(:request).returns("world")  #
+      model.get_user.should == "hello world"
+    end
+
+  end
+
+  describe ".client" do
+
+    it "passes a given block to a new Savon::Client"
+
+    it "memoizes the Savon::Client" do
+      model.client.should equal(model.client)
+    end
+
+  end
+
+  describe ".endpoint" do
+
+    it "sets the SOAP endpoint" do
+      model.endpoint "http://example.com"
+      model.client.wsdl.endpoint.should == "http://example.com"
+    end
+
+  end
+
+  describe ".namespace" do
+
+    it "sets the target namespace" do
+      model.namespace "http://v1.example.com"
+      model.client.wsdl.namespace.should == "http://v1.example.com"
+    end
+
+  end
+
+  describe ".document" do
+
+    it "sets the WSDL document" do
+      model.document "http://example.com/?wsdl"
+      model.client.wsdl.document.should == "http://example.com/?wsdl"
+    end
+
+  end
+
+  describe ".headers" do
+
+    it "sets the HTTP headers" do
+      model.headers("Accept-Charset" => "utf-8")
+      model.client.http.headers.should == { "Accept-Charset" => "utf-8" }
+    end
+
+  end
+
+  describe ".basic_auth" do
+
+    it "sets HTTP Basic auth credentials" do
+      model.basic_auth "login", "password"
+      model.client.http.auth.basic.should == ["login", "password"]
+    end
+
+  end
+
+  describe ".wsse_auth" do
+
+    it "sets WSSE auth credentials" do
+      model.wsse_auth "login", "password", :digest
+
+      model.client.wsse.username.should == "login"
+      model.client.wsse.password.should == "password"
+      model.client.wsse.should be_digest
+    end
+
+  end
+
+  describe ".actions" do
+
+    before(:all) do
+      model.actions :get_user, "GetAllUsers"
+    end
+
+    it "defines class methods each action" do
+      model.should respond_to(:get_user, :get_all_users)
+    end
+
+    it "defines instance methods each action" do
+      model.new.should respond_to(:get_user, :get_all_users)
+    end
+
+    context "(class-level)" do
+
+      it "executes SOAP requests with a given body" do
+        model.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        model.get_user :id => 1
+      end
+
+      it "accepts and passes Strings for action names" do
+        model.client.expects(:request).with(:wsdl, "GetAllUsers", :body => { :id => 1 })
+        model.get_all_users :id => 1
+      end
+    end
+
+    context "(instance-level)" do
+
+      it "delegates to the corresponding class method" do
+        model.expects(:get_all_users).with(:active => true)
+        model.new.get_all_users :active => true
+      end
+
+    end
+
+  end
+
+  describe "#client" do
+
+    it "returns the class-level Savon::Client" do
+      model.new.client.should == model.client
+    end
+
+  end
+
+  describe "overwriting action methods" do
+
+    context "(class-level)" do
+
+      let(:supermodel) do
+        supermodel = model.dup
+        supermodel.actions :get_user
+
+        def supermodel.get_user(body = nil, &block)
+          p "super"
+          super
+        end
+
+        supermodel
+      end
+
+      it "works" do
+        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        supermodel.expects(:p).with("super")  # stupid, but works
+
+        supermodel.get_user :id => 1
+      end
+
+    end
+
+    context "(instance-level)" do
+
+      let(:supermodel) do
+        supermodel = model.dup
+        supermodel.actions :get_user
+        supermodel = supermodel.new
+
+        def supermodel.get_user(body = nil, &block)
+          p "super"
+          super
+        end
+
+        supermodel
+      end
+
+      it "works" do
+        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        supermodel.expects(:p).with("super")  # stupid, but works
+
+        supermodel.get_user :id => 1
+      end
+
+    end
+
+  end
+
+end

data/spec/savon/savon_spec.rb

@@ -19,6 +19,39 @@ describe Savon do
         Savon.configure { |config| config.log = false }
         Savon.log?.should be_false
       end
+
+      context "when instructed to filter" do
+        before do
+          Savon.log = true
+        end
+
+        context "and no log filter set" do
+          it "should not filter the message" do
+            Savon.logger.expects(Savon.log_level).with(Fixture.response(:authentication))
+            Savon.log(Fixture.response(:authentication), :filter)
+          end
+        end
+
+        context "and multiple log filters" do
+          before do
+            Savon.configure { |config| config.log_filter = ["logType", "logTime"] }
+          end
+
+          it "should filter element values" do
+            filtered_values = /Notes Log|2010-09-21T18:22:01|2010-09-21T18:22:07/
+
+            Savon.logger.expects(Savon.log_level).with do |msg|
+              msg !~ filtered_values &&
+              msg.include?('<ns10:logTime>***FILTERED***</ns10:logTime>') &&
+              msg.include?('<ns10:logType>***FILTERED***</ns10:logType>') &&
+              msg.include?('<ns11:logTime>***FILTERED***</ns11:logTime>') &&
+              msg.include?('<ns11:logType>***FILTERED***</ns11:logType>')
+            end
+
+            Savon.log(Fixture.response(:list), :filter)
+          end
+        end
+      end
     end
 
     describe "logger" do
@@ -69,17 +102,6 @@ describe Savon do
         lambda { Savon.soap_version = 3 }.should raise_error(ArgumentError)
       end
     end
-
-    describe "strip_namespaces" do
-      it "should default to true" do
-        Savon.strip_namespaces?.should == true
-      end
-
-      it "should not strip namespaces when set to false" do
-        Savon.strip_namespaces = false
-        Savon.strip_namespaces?.should == false
-      end
-    end
   end
 
 end

data/spec/savon/soap/request_spec.rb

@@ -20,30 +20,34 @@ describe Savon::SOAP::Request do
 
   describe ".new" do
     it "uses the SOAP endpoint for the request" do
-      soap_request.request.url.should == URI(soap.endpoint)
+      soap_request.http.url.should == URI(soap.endpoint)
     end
 
     it "sets the SOAP body for the request" do
-      soap_request.request.body.should == soap.to_xml
+      soap_request.http.body.should == soap.to_xml
     end
 
     it "sets the Content-Type header for SOAP 1.1" do
-      soap_request.request.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[1]
+      soap_request.http.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[1]
     end
 
     it "sets the Content-Type header for SOAP 1.2" do
       soap.version = 2
-      soap_request.request.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[2]
+      soap_request.http.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[2]
     end
 
-    it "does not set the Content-Type header if it's already specified" do
-      headers = { "Content-Type" => "text/plain" }
-      soap_request = Savon::SOAP::Request.new HTTPI::Request.new(:headers => headers), soap
-      soap_request.request.headers["Content-Type"].should == headers["Content-Type"]
+    it "sets the Content-Length header" do
+      soap_request.http.headers["Content-Length"].should == soap.to_xml.length.to_s
     end
 
-    it "sets the Content-Length header" do
-      soap_request.request.headers["Content-Length"].should == soap.to_xml.length.to_s
+    it "sets the Content-Length header for every request" do
+      http = HTTPI::Request.new
+      soap_request = Savon::SOAP::Request.new(http, soap)
+      http.headers.should include("Content-Length" => "272")
+
+      soap = Savon::SOAP::XML.new Endpoint.soap, [nil, :create_user, {}], :id => 123
+      soap_request = Savon::SOAP::Request.new(http, soap)
+      http.headers.should include("Content-Length" => "280")
     end
   end
 
@@ -52,6 +56,16 @@ describe Savon::SOAP::Request do
       HTTPI.expects(:post).returns(HTTPI::Response.new 200, {}, Fixture.response(:authentication))
       soap_request.response.should be_a(Savon::SOAP::Response)
     end
+
+    it "logs the filtered SOAP request body" do
+      HTTPI.stubs(:post).returns(HTTPI::Response.new 200, {}, "")
+
+      Savon.stubs(:log).times(2)
+      Savon.expects(:log).with(soap.to_xml, :filter)
+      Savon.stubs(:log).times(2)
+
+      soap_request.response
+    end
   end
 
 end