savon 0.3.2 → 0.5.0

data/spec/fixtures/multiple_user_response.xml

@@ -0,0 +1,22 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+   <soap:Body>
+      <ns2:findUserResponse xmlns:ns2="http://v1_0.ws.user.example.com">
+         <return>
+            <id>666</id>
+            <email>thedude@example.com</email>
+            <username>thedude</username>
+            <firstname>The</firstname>
+            <lastname>Dude</lastname>
+            <registered>2000-01-22T22:11:21</registered>
+         </return>
+         <return>
+            <id>999</id>
+            <email>anotherdude@example.com</email>
+            <username>anotherdude</username>
+            <firstname>Another</firstname>
+            <lastname>Dude</lastname>
+            <registered>1984-05-26T11:22:12</registered>
+         </return>
+      </ns2:findUserResponse>
+   </soap:Body>
+</soap:Envelope>

data/spec/fixtures/user_fixture.rb

@@ -0,0 +1,42 @@
+class UserFixture
+
+  @namespace_uri = "http://v1_0.ws.user.example.com"
+  @soap_actions = { :find_user => "findUser" }
+
+  @datetime_string = "2010-11-22T11:22:33"
+  @datetime_object = DateTime.parse @datetime_string
+
+  @response_hash = { :id => "666", :active => true, :username => "thedude",
+    :firstname => "The", :lastname => "Dude", :email => "thedude@example.com",
+    :registered => @datetime_object }
+
+  class << self
+
+    attr_accessor :namespace_uri, :soap_actions,
+      :datetime_string, :datetime_object, :response_hash
+
+    def user_wsdl
+      load_fixture :user_wsdl
+    end
+
+    def user_response
+      load_fixture :user_response
+    end
+
+    def multiple_user_response
+      load_fixture :multiple_user_response
+    end
+
+    def soap_fault
+      load_fixture :soap_fault
+    end
+
+  private
+
+    def load_fixture(file)
+      file_path = File.join File.dirname(__FILE__), "#{file}.xml"
+      IO.readlines(file_path, "").to_s
+    end
+
+  end
+end

data/spec/fixtures/user_response.xml

@@ -2,12 +2,14 @@
    <soap:Body>
       <ns2:findUserResponse xmlns:ns2="http://v1_0.ws.user.example.com">
          <return>
-            <id>123</id>
+            <id>666</id>
             <email>thedude@example.com</email>
             <username>thedude</username>
             <firstname>The</firstname>
             <lastname>Dude</lastname>
+						<registered>2010-11-22T11:22:33</registered>
+						<active>true</active>
          </return>
       </ns2:findUserResponse>
    </soap:Body>
-</soap:Envelope>
+</soap:Envelope>

data/spec/http_stubs.rb

@@ -0,0 +1,20 @@
+require "fakeweb"
+
+FakeWeb.allow_net_connect = false
+
+# Register fake WSDL and SOAP request.
+FakeWeb.register_uri :get, SpecHelper.some_endpoint, :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, SpecHelper.soap_call_endpoint, :body => UserFixture.user_response
+
+# Register fake WSDL and SOAP request with multiple "//return" nodes.
+FakeWeb.register_uri :get, SpecHelper.multiple_endpoint, :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, SpecHelper.soap_multiple_endpoint, :body => UserFixture.multiple_user_response
+
+# Register fake WSDL and SOAP request for a Savon::SOAPFault.
+FakeWeb.register_uri :get, SpecHelper.soapfault_endpoint, :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, SpecHelper.soap_soapfault_endpoint, :body => UserFixture.soap_fault
+
+# Register fake WSDL and SOAP request for a Savon::HTTPError.
+FakeWeb.register_uri :get, SpecHelper.httperror_endpoint, :body => UserFixture.user_wsdl
+FakeWeb.register_uri :post, SpecHelper.soap_httperror_endpoint, :body => "",
+  :status => ["404", "Not Found"]

data/spec/savon/client_spec.rb

@@ -0,0 +1,144 @@
+require "spec_helper"
+
+describe Savon::Client do
+  before { @client = new_client_instance }
+
+  def new_client_instance
+    Savon::Client.new SpecHelper.some_endpoint
+  end
+
+  describe "@response_process" do
+    it "expects a Net::HTTPResponse, translates the response" <<
+       "into a Hash and returns the SOAP response body" do
+      response = Savon::Client.response_process.call(http_response_mock)
+
+      response.should be_a Hash
+      UserFixture.response_hash.each do |key, value|
+        response[key].should == value
+      end
+    end
+
+    it "has accessor methods" do
+      response_process = Savon::Client.response_process
+
+      Savon::Client.response_process = "process"
+      Savon::Client.response_process.should == "process"
+      Savon::Client.response_process = response_process
+      Savon::Client.response_process.should == response_process
+    end
+  end
+
+  describe "initialize" do
+    it "expects a SOAP endpoint String" do
+      new_client_instance
+    end
+
+    it "raises an ArgumentError in case of an invalid endpoint" do
+      lambda { Savon::Client.new "invalid" }.should raise_error ArgumentError
+    end
+  end
+
+  describe "wsdl" do
+    it "returns the Savon::WSDL" do
+      @client.find_user
+
+      @client.wsdl.should be_a Savon::WSDL
+      @client.wsdl.to_s.should == UserFixture.user_wsdl
+    end
+  end
+  
+  describe "response" do
+    it "returns the Net::HTTPResponse of the last SOAP request" do
+      @client.find_user
+
+      @client.response.should be_a Net::HTTPResponse
+      @client.response.body.should == UserFixture.user_response
+    end
+  end
+
+  describe "respond_to?" do
+    it "returns true for available SOAP actions" do
+      @client.respond_to?(UserFixture.soap_actions.keys.first).
+        should be_true
+    end
+
+    it "still behaves like usual otherwise" do
+      @client.respond_to?(:object_id).should be_true
+      @client.respond_to?(:some_missing_method).should be_false
+    end
+  end
+
+  describe "method_missing" do
+    it "dispatches SOAP requests for available SOAP actions" do
+      @client.find_user.should be_a Hash
+    end
+
+    it "still returns a NoMethodError for missing methods" do
+      lambda { @client.some_missing_method }.should raise_error NoMethodError
+    end
+
+    it "accepts a Hash for specifying the SOAP body" do
+      soap_body_hash = { :id => 666 }
+      @client.find_user soap_body_hash
+
+      @client.instance_variable_get("@soap").body.
+        should include soap_body_hash.to_soap_xml
+    end
+
+    it "accepts a String for specifying the SOAP body" do
+      soap_body_xml = "<username>dude</username>"
+      @client.find_user soap_body_xml
+
+      @client.instance_variable_get("@soap").body.
+        should include soap_body_xml
+    end
+
+    describe "accepts a Hash of per request options" do
+      it "to specify the SOAP version" do
+        @client.find_user nil, :soap_version => 2
+        @client.instance_variable_get("@soap").version.should == 2
+      end
+
+      it "to specify credentials for WSSE authentication" do
+        @client.find_user nil, :wsse =>
+          { :username => "gorilla", :password => "secret" }
+
+        @client.instance_variable_get("@soap").body.should include "gorilla"
+        @client.instance_variable_get("@soap").body.should include "secret"
+      end
+
+      it "to specify credentials for WSSE digestauthentication" do
+        @client.find_user nil, :wsse =>
+          { :username => "gorilla", :password => "secret", :digest => true }
+
+        @client.instance_variable_get("@soap").body.should include "gorilla"
+        @client.instance_variable_get("@soap").body.should_not include "secret"
+      end
+    end
+
+    it "accepts a block for specifying the response process per request" do
+      @client.find_user { |response| response.body }.
+        should == UserFixture.user_response
+    end
+
+    it "raises a Savon::SOAPFault in case of a SOAP fault" do
+      client = Savon::Client.new SpecHelper.soapfault_endpoint
+      lambda { client.find_user }.should raise_error Savon::SOAPFault
+    end
+
+    it "raises a Savon::HTTPError in case of an HTTP error" do
+      client = Savon::Client.new SpecHelper.httperror_endpoint
+      lambda { client.find_user }.should raise_error Savon::HTTPError
+    end
+  end
+
+  def http_response_mock
+    unless @http_response_mock
+      @http_response_mock = mock "Net::HTTPResponse"
+      @http_response_mock.stubs :code => "200", :message => "OK",
+        :content_type => "text/html", :body => UserFixture.user_response
+    end
+    @http_response_mock
+  end
+
+end

data/spec/savon/core_ext/datetime_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe DateTime do
+
+  describe "to_soap_value" do
+    it "returns an xs:dateTime compliant String" do
+      UserFixture.datetime_object.to_soap_value.
+        should == UserFixture.datetime_string
+    end
+  end
+
+end

data/spec/savon/core_ext/hash_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe Hash do
+
+  describe "to_soap_xml" do
+    describe "returns SOAP request compatible XML" do
+      it "for a simple Hash" do
+        { :some => "user" }.to_soap_xml.should == "<some>user</some>"
+      end
+
+      it "for a nested Hash" do
+        { :some => { :new => "user" } }.to_soap_xml.
+          should == "<some><new>user</new></some>"
+      end
+
+      it "for a Hash with multiple keys" do
+        soap_xml = { :all => "users", :before => "whatever" }.to_soap_xml
+
+        soap_xml.should include "<all>users</all>"
+        soap_xml.should include "<before>whatever</before>"
+      end
+
+      it "for a Hash containing an Array" do
+        { :some => ["user", "gorilla"] }.to_soap_xml.
+          should == "<some>user</some><some>gorilla</some>"
+      end
+
+      it "for a Hash containing an Array of Hashes" do
+        { :some => [{ :new => "user" }, { :old => "gorilla" }] }.to_soap_xml.
+          should == "<some><new>user</new></some><some><old>gorilla</old></some>"
+      end
+    end
+
+    it "converts Hash key Symbols to lowerCamelCase" do
+      { :find_or_create => "user" }.to_soap_xml.
+        should == "<findOrCreate>user</findOrCreate>"
+    end
+
+    it "does not convert Hash key Strings" do
+      { "find_or_create" => "user" }.to_soap_xml.
+        should == "<find_or_create>user</find_or_create>"
+    end
+
+    it "converts DateTime objects to xs:dateTime compliant Strings" do
+      { :before => UserFixture.datetime_object }.to_soap_xml.
+        should == "<before>" << UserFixture.datetime_string << "</before>"
+    end
+
+    it "converts Objects responding to to_datetime to xs:dateTime compliant Strings" do
+      singleton = Object.new
+      def singleton.to_datetime
+        UserFixture.datetime_object
+      end
+
+      { :before => singleton }.to_soap_xml.
+        should == "<before>" << UserFixture.datetime_string << "</before>"
+    end
+
+    it "calls to_s on Strings even if they respond to to_datetime" do
+      singleton = "gorilla"
+      def singleton.to_datetime
+        UserFixture.datetime_object
+      end
+
+      { :name => singleton }.to_soap_xml.should == "<name>gorilla</name>"
+    end
+
+    it "call to_s on any other Object" do
+      [666, true, false, nil].each do |object|
+        { :some => object }.to_soap_xml.should == "<some>#{object}</some>"
+      end
+    end
+  end
+
+  describe "to_soap_fault_message" do
+    it "returns a SOAP fault message for SOAP version 1" do
+      soap_fault = soap_fault_hash(
+        "faultcode" => "soap:Server",
+        "faultstring" => "Fault occurred while processing."
+      )
+
+      soap_fault.to_soap_fault_message.should be_a String
+      soap_fault.to_soap_fault_message.should_not be_empty
+    end
+
+    it "returns a SOAP fault message for SOAP version 2" do
+      soap_fault = soap_fault_hash(
+        "code" => { "value" => "soap:Server" },
+        "reason" => { "text" => "Fault occurred while processing." }
+      )
+
+      soap_fault.to_soap_fault_message.should be_a String
+      soap_fault.to_soap_fault_message.should_not be_empty
+    end
+
+    it "returns nil in case the Hash does not include a SOAP fault" do
+      { :soap_fault => false }.to_soap_fault_message.should be_nil
+    end
+
+    it "returns nil for unknown SOAP faults" do
+      soap_fault_hash.to_soap_fault_message.should be_nil
+    end
+
+    def soap_fault_hash(details = {})
+      { "soap:Envelope" => { "soap:Body" => { "soap:Fault" => details } } }
+    end
+  end
+
+  describe "map_soap_response" do
+    it "converts Hash key Strings to snake_case Symbols" do
+      { "userResponse" => { "accountStatus" => "active" } }.map_soap_response.
+        should == { :user_response => { :account_status => "active" } }
+    end
+
+    it "strips namespaces from Hash keys" do
+      { "ns:userResponse" => { "ns2:id" => "666" } }.map_soap_response.
+        should == { :user_response => { :id => "666" } }
+    end
+
+    it "converts Hash keys and values in Arrays" do
+      { "response" => [{ "name" => "dude" }, { "name" => "gorilla" }] }.map_soap_response.
+        should == { :response=> [{ :name => "dude" }, { :name => "gorilla" }] }
+    end
+
+    it "converts xsi:nil values to nil Objects" do
+      { "userResponse" => { "xsi:nil" => "true" } }.map_soap_response.
+        should == { :user_response => nil }
+    end
+
+    it "converts Hash values matching the xs:dateTime format into DateTime Objects" do
+      { "response" => { "at" => UserFixture.datetime_string } }.map_soap_response.
+        should == { :response => { :at => UserFixture.datetime_object } }
+    end
+
+    it "converts Hash values matching 'true' to TrueClass" do
+      { "response" => { "active" => "false" } }.map_soap_response.
+        should == { :response => { :active => false } }
+    end
+
+    it "converts Hash values matching 'false' to FalseClass" do
+      { "response" => { "active" => "true" } }.map_soap_response.
+        should == { :response => { :active => true } }
+    end
+  end
+
+end

data/spec/savon/core_ext/object_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Object do
+
+  describe "to_soap_key" do
+    it "calls to_s for every Object" do
+      Object.to_soap_key.should == Object.to_s
+    end
+  end
+
+  describe "to_soap_value" do
+    it "returns an xs:dateTime compliant String for Objects responding to to_datetime" do
+      singleton = Object.new
+      def singleton.to_datetime
+        UserFixture.datetime_object
+      end
+
+      singleton.to_soap_value.should == UserFixture.datetime_string
+    end
+
+    it "calls to_s unless the Object responds to to_datetime" do
+      "value".to_soap_value.should == "value".to_s
+    end
+  end
+
+end

data/spec/savon/core_ext/string_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe String do
+
+  describe "snakecase" do
+    it "converts a lowerCamelCase String to snakecase" do
+      "lowerCamelCase".snakecase.should == "lower_camel_case"
+    end
+  end
+
+  describe "lower_camelcase" do
+    it "converts a snakecase String to lowerCamelCase" do
+      "lower_camel_case".lower_camelcase.should == "lowerCamelCase"
+    end
+  end
+
+  describe "strip_namespace" do
+    it "strips the namespace from a namespaced String" do
+      "ns:customer".strip_namespace.should == "customer"
+    end
+
+    it "returns the original String for a String without namespace" do
+      "customer".strip_namespace.should == "customer"
+    end
+  end
+
+  describe "map_soap_response" do
+    it "returns a DateTime Object for Strings matching the xs:dateTime format" do
+      UserFixture.datetime_string.map_soap_response.should ==
+        UserFixture.datetime_object
+    end
+
+    it "returns true for Strings matching 'true'" do
+      "true".map_soap_response.should be_true
+    end
+
+    it "returns false for Strings matching 'false'" do
+      "false".map_soap_response.should be_false
+    end
+
+    it "defaults to return the original value" do
+      "whatever".map_soap_response.should == "whatever"
+    end
+  end
+
+  describe "to_soap_value" do
+    it "calls to_s, bypassing Rails to_datetime extension for Strings" do
+      "string".to_soap_value.should == "string".to_s
+    end
+  end
+
+end