tictoc-savon 0.7.9

data/spec/fixtures/wsdl/xml/no_namespace.xml

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions name="Api" xmlns:typens="urn:ActionWebService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" targetNamespace="urn:ActionWebService" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns="http://schemas.xmlsoap.org/wsdl/">
+  <types>
+    <xsd:schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:ActionWebService">
+      <xsd:complexType name="MpUser">
+        <xsd:all>
+          <xsd:element name="avatar_thumb_url" type="xsd:string"/>
+          <xsd:element name="speciality" type="xsd:string"/>
+          <xsd:element name="avatar_icon_url" type="xsd:string"/>
+          <xsd:element name="firstname" type="xsd:string"/>
+          <xsd:element name="city" type="xsd:string"/>
+          <xsd:element name="mp_id" type="xsd:int"/>
+          <xsd:element name="lastname" type="xsd:string"/>
+          <xsd:element name="login" type="xsd:string"/>
+        </xsd:all>
+      </xsd:complexType>
+      <xsd:complexType name="MpUserArray">
+        <xsd:complexContent>
+          <xsd:restriction base="soapenc:Array">
+            <xsd:attribute wsdl:arrayType="typens:MpUser[]" ref="soapenc:arrayType"/>
+          </xsd:restriction>
+        </xsd:complexContent>
+      </xsd:complexType>
+      <xsd:complexType name="McContact">
+        <xsd:all>
+          <xsd:element name="last_name" type="xsd:string"/>
+          <xsd:element name="email" type="xsd:string"/>
+          <xsd:element name="mp_id" type="xsd:int"/>
+          <xsd:element name="role" type="xsd:int"/>
+          <xsd:element name="login" type="xsd:string"/>
+          <xsd:element name="first_name" type="xsd:string"/>
+        </xsd:all>
+      </xsd:complexType>
+      <xsd:complexType name="McContactArray">
+        <xsd:complexContent>
+          <xsd:restriction base="soapenc:Array">
+            <xsd:attribute wsdl:arrayType="typens:McContact[]" ref="soapenc:arrayType"/>
+          </xsd:restriction>
+        </xsd:complexContent>
+      </xsd:complexType>
+    </xsd:schema>
+  </types>
+  <message name="GetUserLoginById">
+    <part name="api_key" type="xsd:string"/>
+    <part name="id" type="xsd:int"/>
+  </message>
+  <message name="GetUserLoginByIdResponse">
+    <part name="return" type="xsd:string"/>
+  </message>
+  <message name="GetAllContacts">
+    <part name="api_key" type="xsd:string"/>
+    <part name="login" type="xsd:string"/>
+  </message>
+  <message name="GetAllContactsResponse">
+    <part name="return" type="typens:McContactArray"/>
+  </message>
+  <message name="SearchUser">
+    <part name="api_key" type="xsd:string"/>
+    <part name="phrase" type="xsd:string"/>
+    <part name="page" type="xsd:string"/>
+    <part name="per_page" type="xsd:string"/>
+  </message>
+  <message name="SearchUserResponse">
+    <part name="return" type="typens:MpUserArray"/>
+  </message>
+  <portType name="ApiApiPort">
+    <operation name="GetUserLoginById">
+      <input message="typens:GetUserLoginById"/>
+      <output message="typens:GetUserLoginByIdResponse"/>
+    </operation>
+    <operation name="GetAllContacts">
+      <input message="typens:GetAllContacts"/>
+      <output message="typens:GetAllContactsResponse"/>
+    </operation>
+    <operation name="SearchUser">
+      <input message="typens:SearchUser"/>
+      <output message="typens:SearchUserResponse"/>
+    </operation>
+  </portType>
+  <binding name="ApiApiBinding" type="typens:ApiApiPort">
+    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="rpc"/>
+    <operation name="GetUserLoginById">
+      <soap:operation soapAction="/api/api/GetUserLoginById"/>
+      <input>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </input>
+      <output>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </output>
+    </operation>
+    <operation name="GetAllContacts">
+      <soap:operation soapAction="/api/api/GetAllContacts"/>
+      <input>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </input>
+      <output>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </output>
+    </operation>
+    <operation name="SearchUser">
+      <soap:operation soapAction="/api/api/SearchUser"/>
+      <input>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </input>
+      <output>
+        <soap:body encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="urn:ActionWebService" use="encoded"/>
+      </output>
+    </operation>
+  </binding>
+  <service name="ApiService">
+    <port name="ApiApiPort" binding="typens:ApiApiBinding">
+      <soap:address location="http://example.com/api/api"/>
+    </port>
+  </service>
+</definitions>

data/spec/http_stubs.rb

@@ -0,0 +1,26 @@
+FakeWeb.allow_net_connect = false
+
+# Some WSDL and SOAP request.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint, :body => WSDLFixture.authentication
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint, :body => ResponseFixture.authentication
+
+# WSDL and SOAP request with a Savon::SOAPFault.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:soap_fault), :body => WSDLFixture.authentication
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:soap_fault), :body => ResponseFixture.soap_fault
+
+# WSDL and SOAP request with a Savon::HTTPError.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:http_error), :body => WSDLFixture.authentication
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:http_error), :body => "", :status => ["404", "Not Found"]
+
+# WSDL and SOAP request with an invalid endpoint.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:invalid), :body => ""
+FakeWeb.register_uri :post, EndpointHelper.soap_endpoint(:invalid), :body => "", :status => ["404", "Not Found"]
+
+# WSDL request returning a WSDL document where the main sections are not namespaced.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:no_namespace), :body => WSDLFixture.no_namespace
+
+# WSDL request returning a WSDL document with namespaced SOAP actions.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:namespaced_actions), :body => WSDLFixture.namespaced_actions
+
+# WSDL request returning a WSDL document with geotrust SOAP actions.
+FakeWeb.register_uri :get, EndpointHelper.wsdl_endpoint(:geotrust), :body => WSDLFixture.geotrust

data/spec/integration/http_basic_auth_spec.rb

@@ -0,0 +1,16 @@
+require "basic_spec_helper"
+
+describe Savon do
+  before { @client = Savon::Client.new "http://localhost:8080/http-basic-auth" }
+
+  it "should be able to handle HTTP basic authentication" do
+    @client.request.basic_auth "user", "password"
+    response = @client.do_something!
+    response.to_hash[:authenticate_response][:return][:success].should == true
+  end
+
+  it "should raise a Savon::HTTPError in case authentication failed" do
+    lambda { @client.do_something! }.should raise_error(Savon::HTTPError)
+  end
+
+end

data/spec/integration/server.rb

@@ -0,0 +1,51 @@
+require "webrick"
+
+include WEBrick
+
+# Run WEBrick. Yields the server to a given block.
+def run_webrick(config = {})
+  config.update :Port => 8080
+  server = HTTPServer.new config
+  yield server if block_given?
+  ["INT", "TERM"].each { |signal| trap(signal) { server.shutdown } }
+  server.start
+end
+
+# Returns the SOAP response fixture for a given +file+.
+def respond_with(file)
+  response_path = File.dirname(__FILE__) + "/../fixtures/response/xml"
+  File.read "#{response_path}/#{file}.xml"
+end
+
+# Returns HTML links for a given Hash of link URI's and names.
+def link_to(links)
+  links.map { |link| "<a href='#{link[:uri]}'>#{link[:name]}</a>" }.join("<br>")
+end
+
+run_webrick do |server|
+  user, password, realm = "user", "password", "realm"
+
+  htdigest = HTTPAuth::Htdigest.new "/tmp/webrick-htdigest"
+  htdigest.set_passwd realm, user, password
+  authenticator = HTTPAuth::DigestAuth.new :UserDB => htdigest, :Realm => realm
+
+  # Homepage including links to subpages.
+  server.mount_proc("/") do |request, response|
+    response.body = link_to [
+      { :uri => "http-basic-auth", :name => "HTTP basic auth" },
+      { :uri => "http-digest-auth", :name => "HTTP digest auth" }
+    ]
+  end
+
+  # HTTP basic authentication.
+  server.mount_proc("/http-basic-auth") do |request, response|
+    HTTPAuth.basic_auth(request, response, realm) { |u, p| u == user && p == password }
+    response.body = respond_with :authentication
+  end
+
+  # HTTP digest authentication.
+  server.mount_proc("/http-digest-auth") do |request, response|
+    authenticator.authenticate request, response
+    response.body = "HTTP digest authentication successfull"
+  end
+end

data/spec/savon/client_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe Savon::Client do
+  before { @client = Savon::Client.new EndpointHelper.wsdl_endpoint }
+
+  it "should be initialized with an endpoint String" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint
+    client.request.http.proxy?.should be_false
+  end
+
+  it "should accept a proxy URI via an optional Hash of options" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint, :proxy => "http://proxy"
+    client.request.http.proxy?.should be_true
+    client.request.http.proxy_address == "http://proxy"
+  end
+
+  it "should accept a SOAP endpoint via an optional Hash of options" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint, :soap_endpoint => "http://localhost"
+    client.wsdl.soap_endpoint.should == "http://localhost"
+  end
+
+  it "should have a method that returns the Savon::WSDL" do
+    @client.wsdl.should be_a(Savon::WSDL)
+  end
+
+  it "should have a method that returns the Savon::Request" do
+    @client.request.should be_a(Savon::Request)
+  end
+
+  it "should respond to available SOAP actions while behaving as expected otherwise" do
+    WSDLFixture.authentication(:operations).keys.each do |soap_action|
+      @client.respond_to?(soap_action).should be_true
+    end
+
+    @client.respond_to?(:object_id).should be_true
+    @client.respond_to?(:some_undefined_method).should be_false
+  end
+
+  it "should dispatch available SOAP calls via method_missing and return the Savon::Response" do
+    @client.authenticate.should be_a(Savon::Response)
+  end
+
+  it "should disable the Savon::WSDL when passed a method with an exclamation mark" do
+    @client.wsdl.enabled?.should be_true
+    [:operations, :namespace_uri, :soap_endpoint].each do |method|
+      Savon::WSDL.any_instance.expects(method).never
+    end
+
+    response = @client.authenticate! do |soap|
+      soap.input.should == "authenticate"
+      soap.input.should == "authenticate"
+    end
+    response.should be_a(Savon::Response)
+    @client.wsdl.enabled?.should be_false
+  end
+
+  it "should raise a Savon::SOAPFault in case of a SOAP fault" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint(:soap_fault)
+    lambda { client.authenticate! }.should raise_error(Savon::SOAPFault)
+  end
+
+  it "should raise a Savon::HTTPError in case of an HTTP error" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint(:http_error)
+    lambda { client.authenticate! }.should raise_error(Savon::HTTPError)
+  end
+
+  it "should yield an instance of Savon::SOAP to a given block expecting one argument" do
+    @client.authenticate { |soap| soap.should be_a(Savon::SOAP) }
+  end
+
+  it "should yield an instance of Savon::SOAP and Savon::WSSE to a gven block expecting two arguments" do
+    @client.authenticate do |soap, wsse|
+      soap.should be_a(Savon::SOAP)
+      wsse.should be_a(Savon::WSSE)
+    end
+  end
+
+  it "should have a call method that forwards to method_missing for SOAP actions named after existing methods" do
+    @client.call(:authenticate) { |soap| soap.should be_a(Savon::SOAP) }
+  end
+
+  it "should raise a NoMethodError when the method does not match an available SOAP action or method" do
+    lambda { @client.some_undefined_method }.should raise_error(NoMethodError)
+  end
+
+end

data/spec/savon/core_ext/array_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Array do
+
+  describe "to_soap_xml" do
+    it "should return the XML for an Array of Hashes" do
+      array = [{ :name => "adam" }, { :name => "eve" }]
+      result = "<user><name>adam</name></user><user><name>eve</name></user>"
+      
+      array.to_soap_xml("user").should == result
+    end
+
+    it "should return the XML for an Array of different Objects" do
+      array = [:symbol, "string", 123]
+      result = "<value>symbol</value><value>string</value><value>123</value>"
+      
+      array.to_soap_xml("value").should == result
+    end
+
+    it "should default to escape special characters" do
+      array = ["<tag />", "adam & eve"]
+      result = "<value>&lt;tag /&gt;</value><value>adam &amp; eve</value>"
+      
+      array.to_soap_xml("value").should == result
+    end
+
+    it "should not escape special characters when told to" do
+      array = ["<tag />", "adam & eve"]
+      result = "<value><tag /></value><value>adam & eve</value>"
+      
+      array.to_soap_xml("value", false).should == result
+    end
+
+    it "should add attributes to a given tag" do
+      array = ["adam", "eve"]
+      result = '<value active="true">adam</value><value active="true">eve</value>'
+      
+      array.to_soap_xml("value", :escape_xml, :active => true).should == result
+    end
+
+    it "should add attributes to duplicate tags" do
+      array = ["adam", "eve"]
+      result = '<value id="1">adam</value><value id="2">eve</value>'
+      
+      array.to_soap_xml("value", :escape_xml, :id => [1, 2]).should == result
+    end
+  end
+
+end

data/spec/savon/core_ext/datetime_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe DateTime do
+  before do
+    @datetime = DateTime.new 2012, 03, 22, 16, 22, 33
+    @datetime_string = "2012-03-22T16:22:33Z"
+  end
+
+  describe "to_soap_value" do
+    it "should return an xs:dateTime compliant String" do
+      @datetime.to_soap_value.should == @datetime_string
+    end
+  end
+
+  describe "to_soap_value!" do
+    it "should act like :to_soap_value" do
+      @datetime.to_soap_value.should == @datetime_string
+    end
+  end
+
+end

data/spec/savon/core_ext/hash_spec.rb

@@ -0,0 +1,190 @@
+require "spec_helper"
+
+describe Hash do
+
+  describe "find_soap_body" do
+    it "should return the content from the 'soap:Body' element" do
+      soap_body = { "soap:Envelope" => { "soap:Body" => "content" } }
+      soap_body.find_soap_body.should == "content"
+    end
+
+    it "should return an empty Hash in case the 'soap:Body' element could not be found" do
+      soap_body = { "some_hash" => "content" }
+      soap_body.find_soap_body.should == {}
+    end
+  end
+
+  describe "to_soap_xml" do
+    describe "should return SOAP request compatible XML" do
+      it "for a simple Hash" do
+        hash, result = { :some => "user" }, "<some>user</some>"
+        hash.to_soap_xml.should == result
+      end
+
+      it "for a nested Hash" do
+        hash, result = { :some => { :new => "user" } }, "<some><new>user</new></some>"
+        hash.to_soap_xml.should == result
+      end
+
+      it "for a Hash with multiple keys" do
+        hash = { :all => "users", :before => "whatever" }
+        hash.to_soap_xml.should include("<all>users</all>", "<before>whatever</before>")
+      end
+
+      it "for a Hash containing an Array" do
+        hash, result = { :some => ["user", "gorilla"] }, "<some>user</some><some>gorilla</some>"
+        hash.to_soap_xml.should == result
+      end
+
+      it "for a Hash containing an Array of Hashes" do
+        hash = { :some => [{ :new => "user" }, { :old => "gorilla" }] }
+        result = "<some><new>user</new></some><some><old>gorilla</old></some>"
+
+        hash.to_soap_xml.should == result
+      end
+    end
+
+    it "should convert Hash key Symbols to lowerCamelCase" do
+      hash, result = { :find_or_create => "user" }, "<findOrCreate>user</findOrCreate>"
+      hash.to_soap_xml.should == result
+    end
+
+    it "should not convert Hash key Strings" do
+      hash, result = { "find_or_create" => "user" }, "<find_or_create>user</find_or_create>"
+      hash.to_soap_xml.should == result
+    end
+
+    it "should convert DateTime objects to xs:dateTime compliant Strings" do
+      hash = { :before => DateTime.new(2012, 03, 22, 16, 22, 33) }
+      result = "<before>2012-03-22T16:22:33Z</before>"
+
+      hash.to_soap_xml.should == result
+    end
+
+    it "should convert Objects responding to to_datetime to xs:dateTime compliant Strings" do
+      singleton = Object.new
+      def singleton.to_datetime
+        DateTime.new(2012, 03, 22, 16, 22, 33)
+      end
+
+      hash, result = { :before => singleton }, "<before>2012-03-22T16:22:33Z</before>"
+      hash.to_soap_xml.should == result
+    end
+
+    it "should call to_s on Strings even if they respond to to_datetime" do
+      object = "gorilla"
+      object.expects(:to_datetime).never
+
+      hash, result = { :name => object }, "<name>gorilla</name>"
+      hash.to_soap_xml.should == result
+    end
+
+    it "should 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
+
+    it "should default to escape special characters" do
+      result = { :some => { :nested => "<tag />" }, :tag => "<tag />" }.to_soap_xml
+      result.should include("<tag>&lt;tag /&gt;</tag>")
+      result.should include("<some><nested>&lt;tag /&gt;</nested></some>")
+    end
+
+    it "should not escape special characters for keys marked with an exclamation mark" do
+      result = { :some => { :nested! => "<tag />" }, :tag! => "<tag />" }.to_soap_xml
+      result.should include("<tag><tag /></tag>")
+      result.should include("<some><nested><tag /></nested></some>")
+    end
+
+    it "should preserve the order of Hash keys and values specified through :order!" do
+      hash = { :find_user => { :name => "Lucy", :id => 666, :order! => [:id, :name] } }
+      result = "<findUser><id>666</id><name>Lucy</name></findUser>"
+      hash.to_soap_xml.should == result
+
+      hash = { :find_user => { :mname => "in the", :lname => "Sky", :fname => "Lucy", :order! => [:fname, :mname, :lname] } }
+      result = "<findUser><fname>Lucy</fname><mname>in the</mname><lname>Sky</lname></findUser>"
+      hash.to_soap_xml.should == result
+    end
+
+    it "should raise an error if the :order! Array does not match the Hash keys" do
+      hash = { :name => "Lucy", :id => 666, :order! => [:name] }
+      lambda { hash.to_soap_xml }.should raise_error(ArgumentError)
+
+      hash = { :by_name => { :name => "Lucy", :lname => "Sky", :order! => [:mname, :name] } }
+      lambda { hash.to_soap_xml }.should raise_error(ArgumentError)
+    end
+
+    it "should add attributes to Hash keys specified through :attributes!" do
+      hash = { :find_user => { :person => "Lucy", :attributes! => { :person => { :id => 666 } } } }
+      result = '<findUser><person id="666">Lucy</person></findUser>'
+      hash.to_soap_xml.should == result
+
+      hash = { :find_user => { :person => "Lucy", :attributes! => { :person => { :id => 666, :city => "Hamburg" } } } }
+      soap_xml = hash.to_soap_xml
+      soap_xml.should include('id="666"', 'city="Hamburg"')
+    end
+
+    it "should add attributes to duplicate Hash keys specified through :attributes!" do
+      hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :id => [1, 3] } } } }
+      result = '<findUser><person id="1">Lucy</person><person id="3">Anna</person></findUser>'
+      hash.to_soap_xml.should == result
+      
+      hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :active => "true" } } } }
+      result = '<findUser><person active="true">Lucy</person><person active="true">Anna</person></findUser>'
+      hash.to_soap_xml.should == result
+    end
+  end
+
+  describe "map_soap_response" do
+    it "should convert Hash key Strings to snake_case Symbols" do
+      soap_response = { "userResponse" => { "accountStatus" => "active" } }
+      result = { :user_response => { :account_status => "active" } }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should strip namespaces from Hash keys" do
+      soap_response = { "ns:userResponse" => { "ns2:id" => "666" } }
+      result = { :user_response => { :id => "666" } }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should convert Hash keys and values in Arrays" do
+      soap_response = { "response" => [{ "name" => "dude" }, { "name" => "gorilla" }] }
+      result = { :response=> [{ :name => "dude" }, { :name => "gorilla" }] }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should convert xsi:nil values to nil Objects" do
+      soap_response = { "userResponse" => { "xsi:nil" => "true" } }
+      result = { :user_response => nil }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should convert Hash values matching the xs:dateTime format into DateTime Objects" do
+      soap_response = { "response" => { "at" => "2012-03-22T16:22:33" } }
+      result = { :response => { :at => DateTime.new(2012, 03, 22, 16, 22, 33) } }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should convert Hash values matching 'true' to TrueClass" do
+      soap_response = { "response" => { "active" => "false" } }
+      result = { :response => { :active => false } }
+
+      soap_response.map_soap_response.should == result
+    end
+
+    it "should convert Hash values matching 'false' to FalseClass" do
+      soap_response = { "response" => { "active" => "true" } }
+      result = { :response => { :active => true } }
+
+      soap_response.map_soap_response.should == result
+    end
+  end
+
+end