RubyGems - savon - Versions diffs - 1.2.0 → 2.0.0 - Mend

savon 1.2.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

data/CHANGELOG.md +119 -104
data/README.md +12 -11
data/Rakefile +0 -6
data/lib/savon.rb +16 -14
data/lib/savon/block_interface.rb +26 -0
data/lib/savon/builder.rb +142 -0
data/lib/savon/client.rb +36 -135
data/lib/savon/header.rb +42 -0
data/lib/savon/http_error.rb +27 -0
data/lib/savon/log_message.rb +23 -25
data/lib/savon/message.rb +35 -0
data/lib/savon/mock.rb +5 -0
data/lib/savon/mock/expectation.rb +70 -0
data/lib/savon/mock/spec_helper.rb +62 -0
data/lib/savon/model.rb +39 -61
data/lib/savon/operation.rb +62 -0
data/lib/savon/options.rb +265 -0
data/lib/savon/qualified_message.rb +49 -0
data/lib/savon/request.rb +92 -0
data/lib/savon/response.rb +97 -0
data/lib/savon/soap_fault.rb +40 -0
data/lib/savon/version.rb +1 -1
data/savon.gemspec +10 -8
data/spec/integration/options_spec.rb +536 -0
data/spec/integration/request_spec.rb +31 -16
data/spec/integration/support/application.rb +80 -0
data/spec/integration/support/server.rb +84 -0
data/spec/savon/builder_spec.rb +81 -0
data/spec/savon/client_spec.rb +90 -488
data/spec/savon/http_error_spec.rb +49 -0
data/spec/savon/log_message_spec.rb +33 -0
data/spec/savon/mock_spec.rb +127 -0
data/spec/savon/model_spec.rb +110 -99
data/spec/savon/observers_spec.rb +92 -0
data/spec/savon/operation_spec.rb +49 -0
data/spec/savon/request_spec.rb +145 -0
data/spec/savon/{soap/response_spec.rb → response_spec.rb} +22 -59
data/spec/savon/soap_fault_spec.rb +94 -0
data/spec/spec_helper.rb +5 -3
data/spec/support/fixture.rb +5 -1
metadata +202 -197
data/lib/savon/config.rb +0 -46
data/lib/savon/error.rb +0 -6
data/lib/savon/hooks/group.rb +0 -68
data/lib/savon/hooks/hook.rb +0 -61
data/lib/savon/http/error.rb +0 -42
data/lib/savon/logger.rb +0 -39
data/lib/savon/null_logger.rb +0 -10
data/lib/savon/soap.rb +0 -21
data/lib/savon/soap/fault.rb +0 -59
data/lib/savon/soap/invalid_response_error.rb +0 -13
data/lib/savon/soap/request.rb +0 -86
data/lib/savon/soap/request_builder.rb +0 -205
data/lib/savon/soap/response.rb +0 -117
data/lib/savon/soap/xml.rb +0 -257
data/spec/savon/config_spec.rb +0 -38
data/spec/savon/hooks/group_spec.rb +0 -71
data/spec/savon/hooks/hook_spec.rb +0 -16
data/spec/savon/http/error_spec.rb +0 -52
data/spec/savon/logger_spec.rb +0 -51
data/spec/savon/savon_spec.rb +0 -33
data/spec/savon/soap/fault_spec.rb +0 -89
data/spec/savon/soap/request_builder_spec.rb +0 -207
data/spec/savon/soap/request_spec.rb +0 -112
data/spec/savon/soap/xml_spec.rb +0 -357
data/spec/savon/soap_spec.rb +0 -16

data/spec/savon/http_error_spec.rb ADDED

@@ -0,0 +1,49 @@
+require "spec_helper"
+describe Savon::HTTPError do
+  let(:http_error) { Savon::HTTPError.new new_response(:code => 404, :body => "Not Found") }
+  let(:no_error) { Savon::HTTPError.new new_response }
+  it "inherits from Savon::Error" do
+    expect(Savon::HTTPError.ancestors).to include(Savon::Error)
+  end
+  describe ".present?" do
+    it "returns true if there was an HTTP error" do
+      http = new_response(:code => 404, :body => "Not Found")
+      expect(Savon::HTTPError.present? http).to be_true
+    end
+    it "returns false unless there was an HTTP error" do
+      expect(Savon::HTTPError.present? new_response).to be_false
+    end
+  end
+  describe "#http" do
+    it "returns the HTTPI::Response" do
+      expect(http_error.http).to be_a(HTTPI::Response)
+    end
+  end
+  [:message, :to_s].each do |method|
+    describe "##{method}" do
+      it "returns the HTTP error message" do
+        expect(http_error.send method).to eq("HTTP error (404): Not Found")
+      end
+    end
+  end
+  describe "#to_hash" do
+    it "returns the HTTP response details as a Hash" do
+      expect(http_error.to_hash).to eq(:code => 404, :headers => {}, :body => "Not Found")
+    end
+  end
+  def new_response(options = {})
+    defaults = { :code => 200, :headers => {}, :body => Fixture.response(:authentication) }
+    response = defaults.merge options
+    HTTPI::Response.new response[:code], response[:headers], response[:body]
+  end
+end

data/spec/savon/log_message_spec.rb ADDED

@@ -0,0 +1,33 @@
+require "spec_helper"
+describe Savon::LogMessage do
+  it "returns the message if it's not XML" do
+    message = log_message("hello", [:password], :pretty_print).to_s
+    expect(message).to eq("hello")
+  end
+  it "returns the message if it shouldn't be filtered or pretty printed" do
+    Nokogiri.expects(:XML).never
+    message = log_message("<hello/>", [], false).to_s
+    expect(message).to eq("<hello/>")
+  end
+  it "pretty prints a given message" do
+    message = log_message("<envelope><body>hello</body></envelope>", [], :pretty_print).to_s
+    expect(message).to include("\n<envelope>")
+    expect(message).to include("\n  <body>")
+  end
+  it "filters tags in a given message" do
+    message = log_message("<root><password>secret</password></root>", [:password], false).to_s
+    expect(message).to include("<password>***FILTERED***</password>")
+  end
+  def log_message(*args)
+    Savon::LogMessage.new(*args)
+  end
+end

data/spec/savon/mock_spec.rb ADDED

@@ -0,0 +1,127 @@
+require "spec_helper"
+require "savon/mock/spec_helper"
+describe "Savon's mock interface" do
+  include Savon::SpecHelper
+  before :all do
+    savon.mock!
+  end
+  after :all do
+    savon.unmock!
+  end
+  it "can verify a request and return a fixture response" do
+    message = { :username => "luke", :password => "secret" }
+    savon.expects(:authenticate).with(:message => message).returns("<fixture/>")
+    response = new_client.call(:authenticate) do
+      message(:username => "luke", :password => "secret")
+    end
+    expect(response.http.body).to eq("<fixture/>")
+  end
+  it "accepts a Hash to specify the response code, headers and body" do
+    soap_fault = Fixture.response(:soap_fault)
+    response = { :code => 500, :headers => { "X-Result" => "invalid" }, :body => soap_fault }
+    savon.expects(:authenticate).returns(response)
+    response = new_client(:raise_errors => false).call(:authenticate)
+    expect(response).to_not be_successful
+    expect(response).to be_a_soap_fault
+    expect(response.http.code).to eq(500)
+    expect(response.http.headers).to eq("X-Result" => "invalid")
+    expect(response.http.body).to eq(soap_fault)
+  end
+  it "works with multiple requests" do
+    authentication_message = { :username => "luke", :password => "secret" }
+    savon.expects(:authenticate).with(:message => authentication_message).returns("")
+    find_user_message = { :by_username => "lea" }
+    savon.expects(:find_user).with(:message => find_user_message).returns("")
+    new_client.call(:authenticate, :message => authentication_message)
+    new_client.call(:find_user, :message => find_user_message)
+  end
+  it "fails when the expected operation was not called" do
+    # TODO: find out how to test this! [dh, 2012-12-17]
+    #savon.expects(:authenticate)
+  end
+  it "fails when the return value for an expectation was not specified" do
+    savon.expects(:authenticate)
+    expect { new_client.call(:authenticate) }.
+      to raise_error(Savon::ExpectationError, "This expectation was not set up with a response.")
+  end
+  it "fails with an unexpected request" do
+    expect { new_client.call(:authenticate) }.
+      to raise_error(Savon::ExpectationError, "Unexpected request to the :authenticate operation.")
+  end
+  it "fails with multiple requests" do
+    authentication_message = { :username => "luke", :password => "secret" }
+    savon.expects(:authenticate).with(:message => authentication_message).returns("")
+    create_user_message = { :username => "lea" }
+    savon.expects(:create_user).with(:message => create_user_message).returns("")
+    find_user_message = { :by_username => "lea" }
+    savon.expects(:find_user).with(:message => find_user_message).returns("")
+    # reversed order from previous spec
+    new_client.call(:authenticate, :message => authentication_message)
+    expect { new_client.call(:find_user, :message => find_user_message) }.
+      to raise_error(Savon::ExpectationError, "Expected a request to the :create_user operation.\n" \
+                                              "Received a request to the :find_user operation instead.")
+  end
+  it "fails when the expected SOAP operation does not match the actual one" do
+    savon.expects(:logout).returns("<fixture/>")
+    expect { new_client.call(:authenticate) }.
+      to raise_error(Savon::ExpectationError, "Expected a request to the :logout operation.\n" \
+                                              "Received a request to the :authenticate operation instead.")
+  end
+  it "fails when there is no actual message to match" do
+    message = { :username => "luke" }
+    savon.expects(:find_user).with(:message => message).returns("<fixture/>")
+    expect { new_client.call(:find_user) }.
+      to raise_error(Savon::ExpectationError, "Expected a request to the :find_user operation\n" \
+                                              "  with this message: #{message.inspect}\n" \
+                                              "Received a request to the :find_user operation\n" \
+                                              "  with no message.")
+  end
+  it "fails when there is no expect but an actual message" do
+    savon.expects(:find_user).returns("<fixture/>")
+    message = { :username => "luke" }
+    expect { new_client.call(:find_user, :message => message) }.
+      to raise_error(Savon::ExpectationError, "Expected a request to the :find_user operation\n" \
+                                              "  with no message.\n" \
+                                              "Received a request to the :find_user operation\n" \
+                                              "  with this message: #{message.inspect}")
+  end
+  def new_client(globals = {})
+    defaults = {
+      :endpoint  => "http://example.com",
+      :namespace => "http://v1.example.com",
+      :log       => false
+    }
+    Savon.client defaults.merge(globals)
+  end
+end

data/spec/savon/model_spec.rb CHANGED

@@ -1,144 +1,155 @@
 require "spec_helper"
+require "integration/support/server"
 describe Savon::Model do
-  let(:model) do
-    Class.new { extend Savon::Model }
+  before :all do
+    @server = IntegrationServer.run
   end
-  describe ".client" do
-    it "memoizes the Savon::Client" do
-      model.client.should equal(model.client)
-    end
+  after :all do
+    @server.stop
   end
-  describe ".endpoint" do
-    it "sets the SOAP endpoint" do
-      model.endpoint "http://example.com"
-      model.client.wsdl.endpoint.should == "http://example.com"
+  describe ".client" do
+    it "returns the memoized client" do
+      model = Class.new {
+        extend Savon::Model
+        client :wsdl => Fixture.wsdl(:authentication)
+      }
+      expect(model.client).to be_a(Savon::Client)
+      expect(model.client).to equal(model.client)
     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
+    it "raises if the client was not initialized properly" do
+      model = Class.new { extend Savon::Model }
-  describe ".document" do
-    it "sets the WSDL document" do
-      model.document "http://example.com/?wsdl"
-      model.client.wsdl.document.should == "http://example.com/?wsdl"
+      expect { model.client }.
+        to raise_error(Savon::InitializationError, /^Expected the model to be initialized/)
     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 ".global" do
+    it "sets global options" do
+      model = Class.new {
+        extend Savon::Model
-  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
+        client :wsdl => Fixture.wsdl(:authentication)
-  describe ".wsse_auth" do
-    it "sets WSSE auth credentials" do
-      model.wsse_auth "login", "password", :digest
+        global :soap_version, 2
+        global :open_timeout, 71
+        global :wsse_auth, "luke", "secret", :digest
+      }
-      model.client.wsse.username.should == "login"
-      model.client.wsse.password.should == "password"
-      model.client.wsse.should be_digest
+      expect(model.client.globals[:soap_version]).to eq(2)
+      expect(model.client.globals[:open_timeout]).to eq(71)
+      expect(model.client.globals[:wsse_auth]).to eq(["luke", "secret", :digest])
     end
   end
-  describe ".actions" do
-    before(:all) do
-      model.actions :get_user, "GetAllUsers"
-    end
+  describe ".operations" do
+    subject(:model)
+    it "defines class methods for each operation" do
+      model = Class.new {
+        extend Savon::Model
-    it "defines class methods each action" do
-      model.should respond_to(:get_user, :get_all_users)
-    end
+        client :wsdl => Fixture.wsdl(:authentication)
+        operations :authenticate
+      }
-    it "defines instance methods each action" do
-      model.new.should respond_to(:get_user, :get_all_users)
+      expect(model).to respond_to(:authenticate)
     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 "executes class-level SOAP operations" do
+      repeat_url = @server.url(:repeat)
+      model = Class.new {
+        extend Savon::Model
+        client :endpoint => repeat_url, :namespace => "http://v1.example.com"
+        global :log, false
-      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
+        operations :authenticate
+      }
+      response = model.authenticate(:xml => Fixture.response(:authentication))
+      expect(response.body[:authenticate_response][:return]).to include(:authentication_value)
     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
+    it "defines instance methods for each operation" do
+      model = Class.new {
+        extend Savon::Model
+        client :wsdl => Fixture.wsdl(:authentication)
+        operations :authenticate
+      }
+      model_instance = model.new
+      expect(model_instance).to respond_to(:authenticate)
     end
-  end
-  describe "#client" do
-    it "returns the class-level Savon::Client" do
-      model.new.client.should == model.client
+    it "executes instance-level SOAP operations" do
+      repeat_url = @server.url(:repeat)
+      model = Class.new {
+        extend Savon::Model
+        client :endpoint => repeat_url, :namespace => "http://v1.example.com"
+        global :log, false
+        operations :authenticate
+      }
+      model_instance = model.new
+      response = model_instance.authenticate(:xml => Fixture.response(:authentication))
+      expect(response.body[:authenticate_response][:return]).to include(:authentication_value)
     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
+  it "allows to overwrite class operations" do
+    repeat_url = @server.url(:repeat)
-        supermodel
-      end
+    model = Class.new {
+      extend Savon::Model
+      client :endpoint => repeat_url, :namespace => "http://v1.example.com"
+    }
-      it "works" do
-        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
-        supermodel.expects(:p).with("super")  # stupid, but works
+    supermodel = model.dup
+    supermodel.operations :authenticate
-        supermodel.get_user :id => 1
-      end
+    def supermodel.authenticate(locals = {})
+      p "super"
+      super
     end
-    context "(instance-level)" do
-      let(:supermodel) do
-        supermodel = model.dup
-        supermodel.actions :get_user
-        supermodel = supermodel.new
+    supermodel.client.expects(:call).with(:authenticate, :message => { :username => "luke", :password => "secret" })
+    supermodel.expects(:p).with("super")  # stupid, but works
+    supermodel.authenticate(:message => { :username => "luke", :password => "secret" })
+  end
-        def supermodel.get_user(body = nil, &block)
-          p "super"
-          super
-        end
+  it "allows to overwrite instance operations" do
+    repeat_url = @server.url(:repeat)
-        supermodel
-      end
+    model = Class.new {
+      extend Savon::Model
+      client :endpoint => repeat_url, :namespace => "http://v1.example.com"
+    }
-      it "works" do
-        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
-        supermodel.expects(:p).with("super")  # stupid, but works
+    supermodel = model.dup
+    supermodel.operations :authenticate
+    supermodel = supermodel.new
-        supermodel.get_user :id => 1
-      end
+    def supermodel.authenticate(lcoals = {})
+      p "super"
+      super
     end
+    supermodel.client.expects(:call).with(:authenticate, :message => { :username => "luke", :password => "secret" })
+    supermodel.expects(:p).with("super")  # stupid, but works
+    supermodel.authenticate(:message => { :username => "luke", :password => "secret" })
   end
 end