johnreitano-savon 0.7.2.1 → 0.7.7.1

data/lib/savon/wsdl.rb

@@ -1,13 +1,79 @@
 module Savon
 
-  # Savon::WSDL
+  # = Savon::WSDL
   #
-  # Represents the WSDL document.
+  # Savon::WSDL represents the WSDL of your service, including information like the namespace URI,
+  # the SOAP endpoint and available SOAP actions.
+  #
+  # == The WSDL document
+  #
+  # Retrieve the raw WSDL document:
+  #
+  #   client.wsdl.to_s
+  #
+  # == Available SOAP actions
+  #
+  # Get an array of available SOAP actions:
+  #
+  #   client.wsdl.soap_actions
+  #   # => [:get_all_users, :get_user_by_id]
+  #
+  # == Namespace URI
+  #
+  # Get the namespace URI:
+  #
+  #   client.wsdl.namespace_uri
+  #   # => "http://ws.userservice.example.com"
+  #
+  # == SOAP endpoint
+  #
+  # Get the SOAP endpoint:
+  #
+  #   client.wsdl.soap_endpoint
+  #   # => "http://example.com"
+  #
+  # == Disable Savon::WSDL
+  #
+  # Especially with large services (i.e. Ebay), getting and parsing the WSDL document can really
+  # slow down your request. The WSDL is great for exploring a service, but it's recommended to
+  # disable it for production.
+  #
+  # When disabling the WSDL, you need to pay attention to certain differences:
+  #
+  # 1. You instantiate Savon::Client with the actual SOAP endpoint instead of pointing it to the
+  #    WSDL of your service.
+  # 2. You also need to manually specify the SOAP.namespace.
+  # 3. Append an exclamation mark (!) to your SOAP call:
+  #
+  #   client = Savon::Client.new "http://example.com"
+  #
+  #   client.get_user_by_id! do |soap|
+  #     soap.namespace = "http://example.com/UserService"
+  #     soap.body = { :id => 666 }
+  #   end
+  #
+  # Without the WSDL, Savon also has to guess the name of the SOAP action and input tag. It takes
+  # the name of the method called on its client instance, converts it from snake_case to lowerCamelCase
+  # and uses the result.
+  #
+  # The example above expects a SOAP action with an original name of "getUserById". If you service
+  # uses UpperCamelCase method names, you can just use the original name:
+  #
+  #   client.GetAllUsers!
+  #
+  # For special cases, you could also specify the SOAP.action and SOAP.input inside the block:
+  #
+  #   client.get_user_by_id! do |soap|
+  #     soap.namespace = "http://example.com/UserService"
+  #     soap.action = "GetUserById"
+  #     soap.input = "GetUserByIdRequest"
+  #     soap.body = { :id => 123 }
+  #   end
   class WSDL
 
     # Initializer, expects a Savon::Request.
     def initialize(request)
-      @request = request
+      @request, @enabled = request, true
     end
 
     # Sets whether to use the WSDL.
@@ -15,7 +81,7 @@ module Savon
 
     # Returns whether to use the WSDL. Defaults to +true+.
     def enabled?
-      @enabled.nil? ? true : @enabled
+      @enabled
     end
 
     # Returns the namespace URI of the WSDL.
@@ -41,10 +107,16 @@ module Savon
 
     # Returns +true+ for available methods and SOAP actions.
     def respond_to?(method)
-      return true if soap_actions.include? method
+      return true if !enabled? || soap_actions.include?(method)
       super
     end
 
+    # Returns an Array containg the SOAP action and input for a given +soap_call+.
+    def operation_from(soap_action)
+      return [soap_action.to_soap_key, soap_action.to_soap_key] unless enabled?
+      [operations[soap_action][:action], operations[soap_action][:input]]
+    end
+
     # Returns the raw WSDL document.
     def to_s
       @document ||= @request.wsdl.body
@@ -62,61 +134,4 @@ module Savon
     end
 
   end
-
-  # Savon::WSDLStream
-  #
-  # Stream listener for parsing the WSDL document.
-  class WSDLStream
-
-    # The main sections of a WSDL document.
-    Sections = %w(definitions types message portType binding service)
-
-    def initialize
-      @depth, @operations = 0, {}
-    end
-
-    # Returns the namespace URI.
-    attr_reader :namespace_uri
-
-    # Returns the SOAP operations.
-    attr_reader :operations
-
-    # Returns the SOAP endpoint.
-    attr_reader :soap_endpoint
-
-    # Hook method called when the stream parser encounters a starting tag.
-    def tag_start(tag, attrs)
-      @depth += 1
-      tag = tag.strip_namespace
-
-      @section = tag.to_sym if @depth <= 2 && Sections.include?(tag)
-      @namespace_uri ||= attrs["targetNamespace"] if @section == :definitions
-      @soap_endpoint ||= URI(attrs["location"]) if @section == :service && tag == "address"
-
-      operation_from tag, attrs if @section == :binding && tag == "operation"
-    end
-
-    # Hook method called when the stream parser encounters a closing tag.
-    def tag_end(tag)
-      @depth -= 1
-    end
-
-    # Stores available operations from a given tag +name+ and +attrs+.
-    def operation_from(tag, attrs)
-      @input = attrs["name"] if attrs["name"]
-
-      if attrs["soapAction"]
-        @action = !attrs["soapAction"].blank? ? attrs["soapAction"] : @input
-        @input = @action.split("/").last if !@input || @input.empty?
-
-        @operations[@input.snakecase.to_sym] = { :action => @action, :input => @input }
-        @input, @action = nil, nil
-      end
-    end
-
-    # Catches calls to unimplemented hook methods.
-    def method_missing(method, *args)
-    end
-
-  end
 end

data/lib/savon/wsdl_stream.rb

@@ -0,0 +1,85 @@
+module Savon
+
+  # = Savon::WSDLStream
+  #
+  # Savon::WSDLStream serves as a stream listener for parsing the WSDL document.
+  class WSDLStream
+
+    # The main sections of a WSDL document.
+    Sections = %w(definitions types message portType binding service)
+
+    def initialize
+      @path, @operations, @namespaces = [], {}, {}
+    end
+
+    # Returns the namespace URI.
+    attr_reader :namespace_uri
+
+    # Returns the SOAP operations.
+    attr_reader :operations
+
+    # Returns the SOAP endpoint.
+    attr_reader :soap_endpoint
+
+    # Hook method called when the stream parser encounters a starting tag.
+    def tag_start(tag, attrs)
+      # read xml namespaces if root element
+      read_namespaces(attrs) if @path.empty?
+
+      tag, namespace = tag.split(":").reverse
+      @path << tag
+
+      if @section == :binding && tag == "binding"
+        # ensure that we are in an wsdl/soap namespace
+        @section = nil unless @namespaces[namespace].starts_with? "http://schemas.xmlsoap.org/wsdl/soap"
+      end
+
+      @section = tag.to_sym if Sections.include?(tag) && depth <= 2
+
+      @namespace_uri ||= attrs["targetNamespace"] if @section == :definitions
+      @soap_endpoint ||= URI(attrs["location"]) if @section == :service && tag == "address"
+
+      operation_from tag, attrs if @section == :binding && tag == "operation"
+    end
+
+    # Returns our current depth in the WSDL document.
+    def depth
+      @path.size
+    end
+
+    # Reads namespace definitions from a given +attrs+ Hash.
+    def read_namespaces(attrs)
+      attrs.each do |key, value|
+        @namespaces[key.strip_namespace] = value if key.starts_with? "xmlns:"
+      end
+    end
+
+    # Hook method called when the stream parser encounters a closing tag.
+    def tag_end(tag)
+      @path.pop
+
+      if @section == :binding && @input && tag.strip_namespace == "operation"
+        # no soapAction attribute found till now
+        operation_from tag, "soapAction" => @input
+      end
+    end
+
+    # Stores available operations from a given tag +name+ and +attrs+.
+    def operation_from(tag, attrs)
+      @input = attrs["name"] if attrs["name"]
+
+      if attrs["soapAction"]
+        @action = !attrs["soapAction"].blank? ? attrs["soapAction"] : @input
+        @input = @action.split("/").last if !@input || @input.empty?
+
+        @operations[@input.snakecase.to_sym] = { :action => @action, :input => @input }
+        @input, @action = nil, nil
+      end
+    end
+
+    # Catches calls to unimplemented hook methods.
+    def method_missing(method, *args)
+    end
+
+  end
+end

data/lib/savon/wsse.rb

@@ -1,24 +1,55 @@
 module Savon
 
-  # Savon::WSSE
+  # = Savon::WSSE
   #
-  # Represents parameters for WSSE authentication.
+  # Savon::WSSE represents WSSE authentication. Pass a block to your SOAP call and the WSSE object
+  # is passed to it as the second argument. The object allows setting the WSSE username, password
+  # and whether to use digest authentication.
+  #
+  # == Credentials
+  #
+  # By default, Savon does not use WSSE authentication. Simply specify a username and password to
+  # change this.
+  #
+  #   response = client.get_all_users do |soap, wsse|
+  #     wsse.username = "eve"
+  #     wsse.password = "secret"
+  #   end
+  #
+  # == Digest
+  #
+  # To use WSSE digest authentication, just use the digest method and set it to +true+.
+  #
+  #   response = client.get_all_users do |soap, wsse|
+  #     wsse.username = "eve"
+  #     wsse.password = "secret"
+  #     wsse.digest = true
+  #   end
+  #
+  # == Default to WSSE
+  #
+  # In case all you're services require WSSE authentication, you can set your credentials and whether
+  # to use WSSE digest for every request:
+  #
+  #   Savon::WSSE.username = "eve"
+  #   Savon::WSSE.password = "secret"
+  #   Savon::WSSE.digest = true
   class WSSE
 
     # Base address for WSSE docs.
     BaseAddress = "http://docs.oasis-open.org/wss/2004/01"
 
     # Namespace for WS Security Secext.
-    WSENamespace = BaseAddress + "/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+    WSENamespace = "#{BaseAddress}/oasis-200401-wss-wssecurity-secext-1.0.xsd"
 
     # Namespace for WS Security Utility.
-    WSUNamespace = BaseAddress + "/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+    WSUNamespace = "#{BaseAddress}/oasis-200401-wss-wssecurity-utility-1.0.xsd"
 
     # URI for "wsse:Password/@Type" #PasswordText.
-    PasswordTextURI = BaseAddress + "/oasis-200401-wss-username-token-profile-1.0#PasswordText"
+    PasswordTextURI = "#{BaseAddress}/oasis-200401-wss-username-token-profile-1.0#PasswordText"
 
     # URI for "wsse:Password/@Type" #PasswordDigest.
-    PasswordDigestURI = BaseAddress + "/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
+    PasswordDigestURI = "#{BaseAddress}/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
 
     # Global WSSE username.
     @@username = nil
@@ -30,8 +61,7 @@ module Savon
 
     # Sets the global WSSE username.
     def self.username=(username)
-      @@username = username.to_s if username.respond_to? :to_s
-      @@username = nil if username.nil?
+      @@username = username.nil? ? nil : username.to_s
     end
 
     # Global WSSE password.
@@ -44,8 +74,7 @@ module Savon
 
     # Sets the global WSSE password.
     def self.password=(password)
-      @@password = password.to_s if password.respond_to? :to_s
-      @@password = nil if password.nil?
+      @@password = password.nil? ? nil : password.to_s
     end
 
     # Global setting of whether to use WSSE digest.
@@ -63,8 +92,7 @@ module Savon
 
     # Sets the WSSE username per request.
     def username=(username)
-      @username = username.to_s if username.respond_to? :to_s
-      @username = nil if username.nil?
+      @username = username.nil? ? nil : username.to_s
     end
 
     # Returns the WSSE username. Defaults to the global setting.
@@ -74,8 +102,7 @@ module Savon
 
     # Sets the WSSE password per request.
     def password=(password)
-      @password = password.to_s if password.respond_to? :to_s
-      @password = nil if password.nil?
+      @password = password.nil? ? nil : password.to_s
     end
 
     # Returns the WSSE password. Defaults to the global setting.
@@ -86,13 +113,13 @@ module Savon
     # Sets whether to use WSSE digest per request.
     attr_writer :digest
 
-    # Returns whether to use WSSE digest. Defaults to the global setting. 
+    # Returns whether to use WSSE digest. Defaults to the global setting.
     def digest?
       @digest || self.class.digest?
     end
 
-    # Returns the XML for a WSSE header or an empty String unless both
-    # username and password were specified.
+    # Returns the XML for a WSSE header or an empty String unless both username and password
+    # were specified.
     def header
       return "" unless username && password
 
@@ -129,7 +156,7 @@ module Savon
 
     # Returns a WSSE timestamp.
     def timestamp
-      @timestamp ||= Time.now.strftime Savon::SOAPDateTimeFormat
+      @timestamp ||= Time.now.strftime Savon::SOAP::DateTimeFormat
     end
 
   end

data/spec/basic_spec_helper.rb

@@ -1,4 +1,3 @@
-require "rubygems"
 require "rake"
 require "spec"
 require "mocha"

data/spec/endpoint_helper.rb

@@ -5,6 +5,7 @@ class EndpointHelper
     case type
       when :no_namespace       then "http://nons.example.com/Service?wsdl"
       when :namespaced_actions then "http://nsactions.example.com/Service?wsdl"
+      when :geotrust           then "https://test-api.geotrust.com/webtrust/query.jws?WSDL"
       else                          soap_endpoint(type)
     end
   end

data/spec/fixtures/wsdl/xml/geotrust.xml

@@ -0,0 +1,156 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<s0:definitions name="queryDefinitions" targetNamespace="http://api.geotrust.com/webtrust/query" xmlns="" xmlns:s0="http://schemas.xmlsoap.org/wsdl/" xmlns:s1="http://api.geotrust.com/webtrust/query" xmlns:s2="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s3="http://www.openuri.org/2006/12/wsdl/upgradedJWS">
+  <s0:types>
+    <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://api.geotrust.com/webtrust/query" xmlns:s0="http://schemas.xmlsoap.org/wsdl/" xmlns:s1="http://api.geotrust.com/webtrust/query" xmlns:s2="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s3="http://www.openuri.org/2006/12/wsdl/upgradedJWS" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+      <xs:complexType name="GetQuickApproverListInput">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="QueryRequestHeader" type="quer:queryRequestHeader" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="Domain" type="xs:string"/>
+          <xs:element minOccurs="0" name="IncludeUserAgreement" type="quer:includeUserAgreement" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="queryRequestHeader">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="PartnerCode" type="xs:string"/>
+          <xs:element minOccurs="0" name="AuthToken" type="quer:authToken" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="ReplayToken" type="xs:string"/>
+          <xs:element minOccurs="0" name="UseReplayToken" type="xs:boolean"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="authToken">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="UserName" type="xs:string"/>
+          <xs:element minOccurs="0" name="Password" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="includeUserAgreement">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="UserAgreementProductCode" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="GetUserAgreementInput">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="QueryRequestHeader" type="quer:queryRequestHeader" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="UserAgreementProductCode" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="GetQuickApproverListOutput">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="QueryResponseHeader" type="quer:queryResponseHeader" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="ApproverList" type="quer:ArrayOfApprover" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="UserAgreement" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="queryResponseHeader">
+        <xs:sequence>
+          <xs:element name="SuccessCode" type="xs:int"/>
+          <xs:element minOccurs="0" name="Errors" type="quer:ArrayOfError" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          <xs:element minOccurs="0" name="Timestamp" type="xs:dateTime"/>
+          <xs:element name="ReturnCount" type="xs:int"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="Error">
+        <xs:sequence>
+          <xs:element name="ErrorCode" type="xs:int"/>
+          <xs:element minOccurs="0" name="ErrorField" type="xs:string"/>
+          <xs:element minOccurs="0" name="ErrorMessage" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="ArrayOfError">
+        <xs:sequence>
+          <xs:element maxOccurs="unbounded" minOccurs="0" name="Error" type="quer:Error" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:element name="ArrayOfError" type="quer:ArrayOfError" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+      <xs:complexType name="Approver">
+        <xs:sequence>
+          <xs:element minOccurs="0" name="ApproverType" type="xs:string"/>
+          <xs:element minOccurs="0" name="ApproverEmail" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:complexType name="ArrayOfApprover">
+        <xs:sequence>
+          <xs:element maxOccurs="unbounded" minOccurs="0" name="Approver" type="quer:Approver" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:element name="ArrayOfApprover" type="quer:ArrayOfApprover" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+      <xs:complexType name="ArrayOfString">
+        <xs:sequence>
+          <xs:element maxOccurs="unbounded" minOccurs="0" name="String" type="xs:string"/>
+        </xs:sequence>
+      </xs:complexType>
+      <xs:element name="ArrayOfString" type="quer:ArrayOfString" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+      <xs:element name="GetQuickApproverList">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element minOccurs="0" name="Request" type="quer:GetQuickApproverListInput" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="GetQuickApproverListResponse">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element minOccurs="0" name="GetQuickApproverListResult" type="quer:GetQuickApproverListOutput" xmlns:quer="http://api.geotrust.com/webtrust/query"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="hello">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element minOccurs="0" name="Input" type="xs:string"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="helloResponse">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element minOccurs="0" name="helloResult" type="xs:string"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:schema>
+  </s0:types>
+  <s0:message name="hello">
+    <s0:part element="s1:hello" name="parameters"/>
+  </s0:message>
+  <s0:message name="helloResponse">
+    <s0:part element="s1:helloResponse" name="helloResultPart"/>
+  </s0:message>
+  <s0:portType name="querySoap">
+    <s0:operation name="GetQuickApproverList" parameterOrder="parameters">
+      <s0:input message="s1:GetQuickApproverList"/>
+      <s0:output message="s1:GetQuickApproverListResponse"/>
+    </s0:operation>
+    <s0:operation name="hello" parameterOrder="parameters">
+      <s0:input message="s1:hello"/>
+      <s0:output message="s1:helloResponse"/>
+    </s0:operation>
+  </s0:portType>
+  <s0:binding name="querySoapBinding" type="s1:querySoap">
+    <s2:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+    <s0:operation name="GetQuickApproverList">
+      <s2:operation style="document"/>
+      <s0:input>
+        <s2:body parts="parameters" use="literal"/>
+      </s0:input>
+      <s0:output>
+        <s2:body parts="GetQuickApproverListResultPart" use="literal"/>
+      </s0:output>
+    </s0:operation>
+    <s0:operation name="hello">
+      <s2:operation style="document"/>
+      <s0:input>
+        <s2:body parts="parameters" use="literal"/>
+      </s0:input>
+      <s0:output>
+        <s2:body parts="helloResultPart" use="literal"/>
+      </s0:output>
+    </s0:operation>
+  </s0:binding>
+  <s0:service name="query">
+    <s3:upgraded81/>
+    <s0:port binding="s1:querySoapBinding" name="querySoap">
+      <s2:address location="https://test-api.geotrust.com:443/webtrust/query.jws"/>
+    </s0:port>
+  </s0:service>
+</s0:definitions>