savon 0.7.9 → 0.8.0.beta.1

data/lib/savon/response.rb

@@ -1,174 +0,0 @@
-module Savon
-
-  # = Savon::Response
-  #
-  # Savon::Response represents both HTTP and SOAP response.
-  #
-  # == 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 => "123",
-  #   =>   :username => "eve"
-  #   =>   :active => true
-  #   => }
-  #
-  # When translating the SOAP response to a Hash, some XML tags and values are converted to more
-  # convenient Ruby objects. Translation is done through John Nunemaker's {Crack}[http://github.com/jnunemaker/crack]
-  # library along with some custom mapping.
-  #
-  # * XML tags (Hash keys) are converted to snake_case Symbols and namespaces are stripped off
-  # * SOAP xs:nil values are converted to nil objects
-  # * XML values specified in xs:DateTime format are converted to DateTime objects
-  # * XML values of "true" and "false" are converted to TrueClass and FalseClass
-  #
-  # == Net::HTTP response
-  #
-  # If for some reason you need to access the Net::HTTP response object ... you can.
-  #
-  #   bc. response.http
-  #   => #<Net::HTTPOK:0x7f749a1aa4a8>
-  class Response
-
-    # The maximum HTTP response code considered to be OK.
-    MaxNonErrorResponseCode = 299
-
-    # The global setting of whether to raise errors.
-    @@raise_errors = true
-
-    # Sets the global setting of whether to raise errors.
-    def self.raise_errors=(raise_errors)
-      @@raise_errors = raise_errors
-    end
-
-    # Returns the global setting of whether to raise errors.
-    def self.raise_errors?
-      @@raise_errors
-    end
-
-    # Expects a Net::HTTPResponse and handles errors.
-    def initialize(http)
-      @http = http
-
-      handle_soap_fault
-      handle_http_error
-    end
-
-    # Returns whether there was a SOAP fault.
-    def soap_fault?
-      !@soap_fault.blank?
-    end
-
-    # Returns the SOAP fault message.
-    attr_reader :soap_fault
-
-    # Returns whether there was an HTTP error.
-    def http_error?
-      !@http_error.blank?
-    end
-
-    # Returns the HTTP error message.
-    attr_reader :http_error
-
-    # Returns the SOAP response body as a Hash.
-    def to_hash
-      @hash ||= (Crack::XML.parse(body) rescue {}).find_soap_body
-    end
-
-    # Returns the SOAP response XML.
-    def to_xml
-      body
-    end
-
-    # Returns the HTTP response object.
-    attr_reader :http
-
-    alias :to_s :to_xml
-
-  private
-
-    # Returns the response body.
-    def body
-      @body || gzipped_body? ? decoded_body : @http.body
-    end
-
-    # Returns whether the body is gzipped.
-    def gzipped_body?
-      @http["content-encoding"] == "gzip" || @http.body[0..1] == "\x1f\x8b"
-    end
-
-    # Returns the gzip decoded body.
-    def decoded_body
-      gz = Zlib::GzipReader.new StringIO.new(@http.body)
-      gz.read
-    ensure
-      gz.close
-    end
-
-    # Handles SOAP faults. Raises a Savon::SOAPFault unless the default behavior of raising errors
-    # was turned off.
-    def handle_soap_fault
-      if soap_fault_message
-        @soap_fault = soap_fault_message
-        raise Savon::SOAPFault, @soap_fault if self.class.raise_errors?
-      end
-    end
-
-    # Returns a SOAP fault message in case a SOAP fault was found.
-    def soap_fault_message
-      @soap_fault_message ||= soap_fault_message_by_version to_hash[:fault]
-    end
-
-    # Expects a Hash that might contain information about a SOAP fault. Returns the SOAP fault
-    # message in case one was found.
-    def soap_fault_message_by_version(soap_fault)
-      return unless soap_fault
-
-      if soap_fault.keys.include? :faultcode
-        "(#{soap_fault[:faultcode]}) #{soap_fault[:faultstring]}"
-      elsif soap_fault.keys.include? :code
-        "(#{soap_fault[:code][:value]}) #{soap_fault[:reason][:text]}"
-      end
-    end
-
-    # 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 > MaxNonErrorResponseCode
-        @http_error = "#{@http.message} (#{@http.code})"
-        @http_error << ": #{body}" unless body.empty?
-        raise Savon::HTTPError, http_error if self.class.raise_errors?
-      end
-    end
-
-  end
-end
-

data/lib/savon/wsdl.rb

@@ -1,137 +0,0 @@
-module Savon
-
-  # = Savon::WSDL
-  #
-  # 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
-
-    # Expects a Savon::Request and accepts a custom +soap_endpoint+.
-    def initialize(request, soap_endpoint = nil)
-      @request, @enabled, @soap_endpoint = request, true, soap_endpoint
-    end
-
-    # Sets whether to use the WSDL.
-    attr_writer :enabled
-
-    # Returns whether to use the WSDL. Defaults to +true+.
-    def enabled?
-      @enabled
-    end
-
-    # Returns the namespace URI of the WSDL.
-    def namespace_uri
-      @namespace_uri ||= stream.namespace_uri
-    end
-
-    # Returns an Array of available SOAP actions.
-    def soap_actions
-      @soap_actions ||= stream.operations.keys
-    end
-
-    # Returns a Hash of SOAP operations including their corresponding
-    # SOAP actions and inputs.
-    def operations
-      @operations ||= stream.operations
-    end
-
-    # Returns the SOAP endpoint.
-    def soap_endpoint
-      @soap_endpoint ||= stream.soap_endpoint
-    end
-
-    # Returns +true+ for available methods and SOAP actions.
-    def respond_to?(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
-    end
-
-  private
-
-    # Returns the Savon::WSDLStream.
-    def stream
-      unless @stream
-        @stream = WSDLStream.new
-        REXML::Document.parse_stream to_s, @stream
-      end
-      @stream
-    end
-
-  end
-end

data/lib/savon/wsdl_stream.rb

@@ -1,85 +0,0 @@
-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/spec/basic_spec_helper.rb

@@ -1,11 +0,0 @@
-require "rake"
-require "spec"
-require "mocha"
-require "fakeweb"
-
-Spec::Runner.configure do |config|
-  config.mock_with :mocha
-end
-
-require "savon"
-Savon::Request.log = false

data/spec/endpoint_helper.rb

@@ -1,23 +0,0 @@
-class EndpointHelper
-
-  # Returns the WSDL endpoint for a given +type+ of request.
-  def self.wsdl_endpoint(type = nil)
-    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
-
-  # Returns the SOAP endpoint for a given +type+ of request.
-  def self.soap_endpoint(type = nil)
-    case type
-      when :soap_fault then "http://soapfault.example.com/Service?wsdl"
-      when :http_error then "http://httperror.example.com/Service?wsdl"
-      when :invalid    then "http://invalid.example.com/Service?wsdl"
-      else                  "http://example.com/validation/1.0/AuthenticationService"
-    end
-  end
-
-end

data/spec/http_stubs.rb

@@ -1,26 +0,0 @@
-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