savon-xaop 0.7.2.1

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,23 @@
+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

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,77 @@
+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 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
+    [:respond_to?, :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 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/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
+      DateTime.new(2012, 03, 22, 16, 22, 33).to_soap_value.
+        should == "2012-03-22T16:22:33"
+    end
+  end
+
+end

data/spec/savon/core_ext/hash_spec.rb

@@ -0,0 +1,138 @@
+require "spec_helper"
+
+describe Hash do
+
+  describe "find_soap_body" do
+    it "returns the content from the 'soap:Body' element" do
+      { "soap:Envelope" => { "soap:Body" => "content" } }.find_soap_body.should == "content"
+    end
+
+    it "returns an empty Hash in case the 'soap:Body' element could not be found" do
+      { "some_hash" => "content" }.find_soap_body.should == {}
+    end
+  end
+
+  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 => DateTime.new(2012, 03, 22, 16, 22, 33) }.to_soap_xml.
+        should == "<before>" << "2012-03-22T16:22:33" << "</before>"
+    end
+
+    it "converts 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
+
+      { :before => singleton }.to_soap_xml.
+        should == "<before>" << "2012-03-22T16:22:33" << "</before>"
+    end
+
+    it "calls to_s on Strings even if they respond to to_datetime" do
+      object = "gorilla"
+      object.expects(:to_s).returns object
+      object.expects(:to_datetime).never
+
+      { :name => object }.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
+
+    it "preserves the order of Hash keys and values specified through :@inorder" do
+      { :find_user => { :name => "Lucy", :id => 666, :@inorder => [:id, :name] } }.to_soap_xml.
+        should == "<findUser><id>666</id><name>Lucy</name></findUser>"
+
+      { :find_user => { :by_name => { :mname => "in the", :lname => "Sky", :fname => "Lucy",
+        :@inorder => [:fname, :mname, :lname] } } }.to_soap_xml. should ==
+        "<findUser><byName><fname>Lucy</fname><mname>in the</mname><lname>Sky</lname></byName></findUser>"
+    end
+
+    it "raises an error if the :@inorder Array does not match the Hash keys" do
+      lambda { { :name => "Lucy", :id => 666, :@inorder => [:name] }.to_soap_xml }.
+        should raise_error(RuntimeError)
+
+      lambda { { :by_name => { :name => "Lucy", :lname => "Sky", :@inorder => [:mname, :name] } }.to_soap_xml }.
+        should raise_error(RuntimeError)
+    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" => "2012-03-22T16:22:33" } }.map_soap_response.
+        should == { :response => { :at => DateTime.new(2012, 03, 22, 16, 22, 33) } }
+    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/net_http_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Net::HTTP do
+  before do
+    @some_uri = URI "http://example.com"
+    @another_uri = URI "http://example.org"
+    @http = Net::HTTP.new @some_uri.host, @some_uri.port
+  end
+
+  describe "endpoint" do
+    it "changes the address and port of a Net::HTTP object" do
+      @http.address.should == @some_uri.host
+      @http.port.should == @some_uri.port
+
+      @http.endpoint @another_uri.host, @another_uri.port
+      @http.address.should == @another_uri.host
+      @http.port.should == @another_uri.port
+    end
+  end
+
+  describe "ssl_client_auth" do
+    it "accepts a Hash of options for SSL client authentication" do
+      @http.cert.should be_nil
+      @http.key.should be_nil
+      @http.ca_file.should be_nil
+      @http.verify_mode.should be_nil
+
+      @http.ssl_client_auth :cert => "cert", :key => "key",
+        :ca_file => "ca_file", :verify_mode => OpenSSL::SSL::VERIFY_PEER
+
+      @http.cert.should == "cert"
+      @http.key.should == "key"
+      @http.ca_file.should == "ca_file"
+      @http.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+    end
+  end
+
+end

data/spec/savon/core_ext/object_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Object do
+
+  describe "blank?" do
+    it "returns true for Objects perceived to be blank" do
+      ["", false, nil, [], {}].each do |object|
+        object.should be_blank
+      end
+    end
+
+    it "returns false for every other Object" do
+      ["!blank", true, [:a], {:a => "b"}].each do |object|
+        object.should_not be_blank
+      end
+    end
+  end
+
+  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
+        DateTime.new(2012, 03, 22, 16, 22, 33)
+      end
+
+      singleton.to_soap_value.should == "2012-03-22T16:22:33"
+    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,68 @@
+require "spec_helper"
+
+describe String do
+
+  describe "self.random" do
+    it "returns a random 100-character String" do
+      String.random.should be_a(String)
+      String.random.length.should == 100
+    end
+
+    it "returns a random String of a given length" do
+      String.random(50).should be_a(String)
+      String.random(50).length.should == 50
+    end
+  end
+
+  describe "snakecase" do
+    it "converts a lowerCamelCase String to snakecase" do
+      "lowerCamelCase".snakecase.should == "lower_camel_case"
+    end
+
+    it "converts period characters to underscores" do
+      "User.GetEmail".snakecase.should == "user_get_email"
+    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
+      "2012-03-22T16:22:33".map_soap_response.should ==
+        DateTime.new(2012, 03, 22, 16, 22, 33)
+    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

data/spec/savon/core_ext/symbol_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Symbol do
+
+  describe "to_soap_key" do
+    it "converts the Symbol from snake_case to a lowerCamelCase String" do
+      :lower_camel_case.to_soap_key.should == "lowerCamelCase"
+    end
+  end
+
+end

data/spec/savon/core_ext/uri_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe URI::HTTP do
+
+  describe "ssl?" do
+    it "returns true for https URI's" do
+      URI("https://example.com").ssl?.should be_true
+    end
+
+    it "returns false for non-https URI's" do
+      URI("http://example.com").ssl?.should be_false
+    end
+  end
+
+end