savon 0.7.4 → 0.7.5

data/lib/savon/response.rb

@@ -5,6 +5,9 @@ module Savon
   # Represents the HTTP and SOAP response.
   class Response
 
+    # The maximum HTTP response code considered to be OK.
+    MaxNonErrorResponseCode = 299
+
     # The global setting of whether to raise errors.
     @@raise_errors = true
 
@@ -28,7 +31,7 @@ module Savon
 
     # Returns whether there was a SOAP fault.
     def soap_fault?
-      @soap_fault ? true : false
+      !@soap_fault.blank?
     end
 
     # Returns the SOAP fault message.
@@ -36,7 +39,7 @@ module Savon
 
     # Returns whether there was an HTTP error.
     def http_error?
-      @http_error ? true : false
+      !@http_error.blank?
     end
 
     # Returns the HTTP error message.
@@ -88,7 +91,7 @@ module Savon
     # Handles HTTP errors. Raises a Savon::HTTPError unless the default
     # behavior of raising errors was turned off.
     def handle_http_error
-      if @http.code.to_i >= 300
+      if @http.code.to_i > MaxNonErrorResponseCode
         @http_error = "#{@http.message} (#{@http.code})"
         @http_error << ": #{@http.body}" unless @http.body.empty?
         raise Savon::HTTPError, http_error if self.class.raise_errors?

data/lib/savon/soap.rb

@@ -6,7 +6,7 @@ module Savon
   class SOAP
 
     # SOAP namespaces by SOAP version.
-    SOAPNamespace = {
+    Namespace = {
       1 => "http://schemas.xmlsoap.org/soap/envelope/",
       2 => "http://www.w3.org/2003/05/soap-envelope"
     }
@@ -14,6 +14,15 @@ module Savon
     # Content-Types by SOAP version.
     ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
 
+    # Supported SOAP versions.
+    Versions = [1, 2]
+
+    # SOAP xs:dateTime format.
+    DateTimeFormat = "%Y-%m-%dT%H:%M:%SZ"
+
+    # SOAP xs:dateTime Regexp.
+    DateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
+
     # The global SOAP version.
     @@version = 1
 
@@ -24,7 +33,7 @@ module Savon
 
     # Sets the global SOAP version.
     def self.version=(version)
-      @@version = version if Savon::SOAPVersions.include? version
+      @@version = version if Versions.include? version
     end
 
     # Sets the global SOAP header. Expected to be a Hash that can be translated
@@ -51,7 +60,9 @@ module Savon
     end
 
     # Initialzes the SOAP object.
-    def initialize
+    def initialize(operation, endpoint)
+      @action, @input = operation[:action], operation[:input]
+      @endpoint = endpoint.kind_of?(URI) ? endpoint : URI(endpoint)
       @builder = Builder::XmlMarkup.new
     end
 
@@ -97,7 +108,7 @@ module Savon
     # Returns the namespaces. A Hash containing the namespaces (keys)
     # and the corresponding URI's (values).
     def namespaces
-      @namespaces ||= { "xmlns:env" => SOAPNamespace[version] }
+      @namespaces ||= { "xmlns:env" => Namespace[version] }
     end
 
     # Convenience method for setting the "xmlns:wsdl" namespace.
@@ -107,7 +118,7 @@ module Savon
 
     # Sets the SOAP version.
     def version=(version)
-      @version = version if Savon::SOAPVersions.include? version
+      @version = version if Versions.include? version
     end
 
     # Returns the SOAP version. Defaults to the global default.
@@ -161,9 +172,15 @@ module Savon
     # Defaults to use the name of the SOAP action and may be an empty Array
     # in case the specified SOAP input seems invalid.
     def input_array
-      return input.map { |i| i.is_a?(Hash) ? i : i.to_sym } unless input.blank?
-      return [action.to_sym] unless action.blank?
-      []
+      if !input.blank? && input.kind_of?(Array)
+        [input[0].to_sym, input[1]]
+      elsif !input.blank?
+        [input.to_sym]
+      elsif action.blank?
+        [action.to_sym]
+      else
+        []
+      end
     end
 
   end

data/lib/savon/wsdl.rb

@@ -7,7 +7,7 @@ module Savon
 
     # Initializer, expects a Savon::Request.
     def initialize(request)
-      @request = request
+      @request, @enabled = request, true
     end
 
     # Sets whether to use the WSDL.
@@ -15,7 +15,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 +41,17 @@ 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 a SOAP operation Hash containing the SOAP action and input
+    # for a given +soap_call+.
+    def operation_from(soap_action)
+      return operations[soap_action] if enabled?
+      { :action => soap_action.to_soap_key, :input => soap_action.to_soap_key }
+    end
+
     # Returns the raw WSDL document.
     def to_s
       @document ||= @request.wsdl.body

data/lib/savon/wsdl_stream.rb

@@ -9,8 +9,7 @@ module Savon
     Sections = %w(definitions types message portType binding service)
 
     def initialize
-      @path, @operations = [], {}
-      @namespaces = {}
+      @path, @operations, @namespaces = [], {}, {}
     end
 
     # Returns the namespace URI.
@@ -27,12 +26,12 @@ module Savon
       # read xml namespaces if root element
       read_namespaces(attrs) if @path.empty?
 
-      tag,namespace = tag.split(":").reverse
+      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] == "http://schemas.xmlsoap.org/wsdl/soap/"
+        @section = nil unless @namespaces[namespace].starts_with? "http://schemas.xmlsoap.org/wsdl/soap"
       end
 
       @section = tag.to_sym if Sections.include?(tag) && depth <= 2
@@ -51,19 +50,18 @@ module Savon
     # Reads namespace definitions from a given +attrs+ Hash.
     def read_namespaces(attrs)
       attrs.each do |key, value|
-        @namespaces[key.split(":").last] = value if key =~ /^xmlns:/
+        @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+.
@@ -76,7 +74,6 @@ module Savon
 
         @operations[@input.snakecase.to_sym] = { :action => @action, :input => @input }
         @input, @action = nil, nil
-        @input = nil
       end
     end
 

data/lib/savon/wsse.rb

@@ -9,16 +9,16 @@ module Savon
     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 +30,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 +43,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 +61,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 +71,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.
@@ -129,7 +125,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/readme/client.rdoc

@@ -0,0 +1,18 @@
+Savon::Client is the main object to connect to a SOAP service. It includes methods to access both Savon::WSDL and Savon::Request objects.
+
+== Instantiate Savon::Client
+
+Depending on whether you aim to use Savon with or without Savon::WSDL, you need to instantiate Savon::Client by passing in the WSDL or SOAP endpoint.
+
+  # Client instance with a WSDL endpoint
+  client = Savon::Client.new "http://example.com/UserService?wsdl"
+
+  # Client instance with a SOAP endpoint (for using Savon without a WSDL)
+  client = Savon::Client.new "http://example.com/UserService"
+
+== Using a proxy server
+
+You can specify the URI to a proxy server via optional Hash arguments.
+
+  client = Savon::Client.new "http://example.com/UserService?wsdl",
+  :proxy => "http://proxy.example.com"

data/readme/errors.rdoc

@@ -0,0 +1,11 @@
+== HTTP errors
+
+In case of an HTTP error, a Savon::HTTPError will be raised. Any HTTP response code >= 300 raises this error. The only exception to this rule is when the server also returns a SOAP fault. In this case, a Savon::SOAPFault is raised.
+
+== SOAP faults
+
+A Savon::SOAPFault is raised in case the server returned a SOAP fault.
+
+== Rails tip
+
+In case you're using Savon inside a Rails application, you can use {rescue_from}[http://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html] to handle these errors 

data/readme/logging.rdoc

@@ -0,0 +1,11 @@
+Savon logs each request and response to STDOUT. Specifying your own logger is as easy as it gets:
+
+  Savon::Request.logger = RAILS_DEFAULT_LOGGER
+
+The default log level is set to :debug. In case you need to change this:
+
+  Savon::Request.log_level = :info
+
+You can also disable logging if you need to:
+
+  Savon::Request.log = false

data/readme/participate.rdoc

@@ -0,0 +1,21 @@
+== Provide feedback
+
+Let me know about your experiences using Savon. What's good, what's not? {Open an issue}[http://github.com/rubiii/savon/issues] if you encounter a bug. Feedback is always appreciated.
+
+== Spread the word
+
+Let others know about Savon by talking, tweeting or blogging about it. The more people use Savon, the more stable it becomes.
+
+== Fix bugs or implement features
+
+You're welcome to fork the project to fix bugs, implement features, etc. But please make sure to follow "the rules":
+
+* Follow the coding and naming conventions of the code
+* Do not edit the CHANGELOG and .gemspec files
+* Test all the fucking time!
+
+Also, if you're thinking about adding some big new feature or if you're not sure about how to implement it, please just get in touch.
+
+Please note that Savon {does not require Rubygems}[http://gist.github.com/54177]. So make sure your environment is set up to load the package manager of your choice. In order to run autospec, you could use the following alias:
+
+  alias autospec='RUBYLIB=./lib RUBYOPT=-rubygems AUTOFEATURE=true autospec'

data/readme/request.rdoc

@@ -0,0 +1,37 @@
+Savon::Request handles both WSDL and SOAP requests.
+
+== The Net::HTTP object
+
+You can access the Net::HTTP object used for both WSDL and SOAP requests via:
+
+  client.request.http
+
+Here's an example of how to set open and read timeouts on the Net::HTTP object.
+
+  client.request.http.open_timeout = 30
+  client.request.http.read_timeout = 30
+
+Please refer to the {official documentation}[http://www.ruby-doc.org/stdlib/libdoc/net/http/rdoc/index.html] for more information.
+
+== HTTP basic authentication
+
+Setting credentials for HTTP basic authentication:
+
+  client.request.basic_auth "username", "password"
+
+== SSL client authentication
+
+You can use the methods provided by Net::HTTP to set SSL client authentication or use this shortcut:
+
+  client.request.http.ssl_client_auth(
+    :cert => OpenSSL::X509::Certificate.new(File.read("client_cert.pem")),
+    :key => OpenSSL::PKey::RSA.new(File.read("client_key.pem"), "password if one exists"),
+    :ca_file => "cacert.pem",
+    :verify_mode => OpenSSL::SSL::VERIFY_PEER
+  )
+
+== HTTP headers
+
+There's an accessor for the Hash of HTTP headers sent with any SOAP call:
+
+  client.request.headers["custom"] = "header"

data/readme/response.rdoc

@@ -0,0 +1,46 @@
+The response is wrapped in an object to give you various options of handling it.
+
+== SOAP fault
+
+Assuming the default behavior of raising errors is disabled, you can ask the response object if there was a SOAP fault or an HTTP error and get the SOAP fault or HTTP error message.
+
+  response.soap_fault?
+  => true
+
+  response.soap_fault
+  => "(soap:Server) Fault occurred while processing."
+
+  response.http_error?
+  => true
+
+  response.http_error
+  => "Not found (404)"
+
+== Response as XML
+
+To get the raw SOAP response XML, you can call to_xml or to_s on the response object.
+
+  response.to_xml
+  => "<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  => "..."
+  => "</soap:Envelope>"
+
+== Response as a Hash 
+
+You can also let Savon translate the SOAP response body to a Hash.
+
+  response.to_hash
+  => { :findUserByIdResponse => {
+  =>   :id => "666",
+  =>   :username => "thedude"
+  =>   :firstname => "The",
+  =>   :lastname => "Dude",
+  =>   :active => true
+  => }
+
+== Net::HTTP response
+
+If for reason you need to access the Net::HTTP response object ... you can.
+
+  bc. response.http
+  => #<Net::HTTPOK:0x7f749a1aa4a8>

data/readme/soap.rdoc

@@ -0,0 +1,71 @@
+Savon::SOAP represents the SOAP request. Pass a block to your SOAP call and the SOAP object is passed to it as the first argument. The object allows setting the SOAP version, header, body and namespaces per request.
+
+== Body
+
+The body method lets you specify parameters to be received by the SOAP action. The value is expected to be a Hash (which will be translated to XML via Hash.to_soap_xml) or an XML String.
+
+  response = client.get_user_by_id do |soap|
+    soap.body = { :id => 666 }
+  end
+
+  response = client.get_user_by_id do |soap|
+    soap.body = "<id>666</id>"
+  end
+
+In case your service requires the elements to be in a specific order, you have two options. The first is to specify your body as an XML String. The second is to add an ":order!" key containing an Array of elements in the specific order to your Hash. Here's an example:
+
+  response = client.add_user do |soap|
+    soap.body = { :user => { :name => "Lucy", :id => 666, :order! => [:id, :name] } }
+  end
+
+== Version
+
+Savon defaults to SOAP 1.1. In case your service uses SOAP 1.2, you can use the version method to change the default.
+
+  response = client.get_all_users do |soap|
+    soap.version = 2
+  end
+
+You can also change the default to SOAP 1.2 for all request:
+
+  Savon::SOAP.version = 2
+
+== Header
+
+If you need to add custom XML into the SOAP header, you can use the header method. The value is expected to be a Hash (which will be translated to XML via Hash.to_soap_xml) or an XML String.
+
+  response = client.get_all_users do |soap|
+    soap.header["specialApiKey"] = "secret"
+  end
+
+  response = client.get_all_users do |soap|
+    soap.header = "<specialApiKey>secret</specialApiKey>"
+  end
+
+== Namespaces
+
+The namespaces method contains a Hash of namespaces for the SOAP envelope.
+
+  response = client.get_all_users do |soap|
+    soap.namespaces["xmlns:whatever"] = "http://example.com"
+  end
+
+== Input
+
+You can change the name of the SOAP input node in case you need to.
+
+  response = client.get_all_users do |soap|
+    soap.input = "GetAllUsersRequest"
+  end
+
+The request is going to look something like this:
+
+  => <env:Envelope
+  =>     xmlns:wsdl="http://example.com/user/1.0/UserService"
+  =>     xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+  =>   <env:Header></env:Header>
+  =>   <env:Body>
+  =>     <wsdl:GetAllUsersRequest></wsdl:GetAllUsersRequest>
+  =>   </env:Body>
+  => </env:Envelope>
+