savon 2.16.0 → 2.17.0

data/lib/savon/model.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Savon
   module Model
-
     def self.extended(base)
       base.setup
     end
@@ -32,7 +32,7 @@ module Savon
         def #{StringUtils.snakecase(operation.to_s)}(locals = {})
           client.call #{operation.inspect}, locals
         end
-      }
+      }, __FILE__, __LINE__ - 4 # -4 points to the line where the eval string starts
     end
 
     # Defines an instance-level SOAP operation.
@@ -41,13 +41,12 @@ module Savon
         def #{StringUtils.snakecase(operation.to_s)}(locals = {})
           self.class.#{StringUtils.snakecase(operation.to_s)} locals
         end
-      }
+      }, __FILE__, __LINE__ - 4 # -4 points to the line where the eval string starts
     end
 
     # Class methods.
     def class_operation_module
-      @class_operation_module ||= Module.new {
-
+      @class_operation_module ||= Module.new do
         def client(globals = {})
           @client ||= Savon::Client.new(globals)
         rescue InitializationError
@@ -60,26 +59,22 @@ module Savon
 
         def raise_initialization_error!
           raise InitializationError,
-            "Expected the model to be initialized with either a WSDL document or the SOAP endpoint and target namespace options.\n" \
-            "Make sure to setup the model by calling the .client class method before calling the .global method.\n\n" \
-            "client(wsdl: '/Users/me/project/service.wsdl')                              # to use a local WSDL document\n" \
-            "client(wsdl: 'http://example.com?wsdl')                                     # to use a remote WSDL document\n" \
-            "client(endpoint: 'http://example.com', namespace: 'http://v1.example.com')  # if you don't have a WSDL document"
+                "Expected the model to be initialized with either a WSDL document or the SOAP endpoint and target namespace options.\n" \
+                "Make sure to setup the model by calling the .client class method before calling the .global method.\n\n" \
+                "client(wsdl: '/Users/me/project/service.wsdl')                              # to use a local WSDL document\n" \
+                "client(wsdl: 'http://example.com?wsdl')                                     # to use a remote WSDL document\n" \
+                "client(endpoint: 'http://example.com', namespace: 'http://v1.example.com')  # if you don't have a WSDL document"
         end
-
-      }.tap { |mod| extend(mod) }
+      end.tap { |mod| extend(mod) }
     end
 
     # Instance methods.
     def instance_operation_module
-      @instance_operation_module ||= Module.new {
-
+      @instance_operation_module ||= Module.new do
         def client
           self.class.client
         end
-
-      }.tap { |mod| include(mod) }
+      end.tap { |mod| include(mod) }
     end
-
   end
 end

data/lib/savon/operation.rb

@@ -1,28 +1,42 @@
 # frozen_string_literal: true
+
 require "savon/options"
 require "savon/block_interface"
-require "savon/request"
 require "savon/builder"
 require "savon/response"
-require "savon/request_logger"
 require "savon/http_error"
+require "savon/transport/httpi"
+require "savon/transport/faraday"
 require "mail"
 
 module Savon
+  # Represents a single named SOAP operation.
+  #
+  # Bridges the SOAP layer (envelope building, action headers, multipart) and the
+  # transport layer (execution, logging). Knows nothing about transport internals
+  # such as proxy, SSL, or auth.
   class Operation
-
+    # SOAP Content-Type values indexed by SOAP version.
+    # SOAP 1.1 §6 (HTTP binding), SOAP 1.2 Part 2 §7.1.4 (HTTP media type)
+    CONTENT_TYPE = {
+      1 => "text/xml;charset=%s",
+      2 => "application/soap+xml;charset=%s"
+    }.freeze
+
+    # Maps SOAP version to the base MIME type used in multipart requests.
+    # RFC 2387 §3.1 (multipart/related Content-Type parameter)
     SOAP_REQUEST_TYPE = {
       1 => "text/xml",
       2 => "application/soap+xml"
-    }
+    }.freeze
 
-    def self.create(operation_name, wsdl, globals)
+    def self.create(operation_name, wsdl, globals, transport)
       if wsdl.document?
         ensure_name_is_symbol! operation_name
         ensure_exists! operation_name, wsdl
       end
 
-      new(operation_name, wsdl, globals)
+      new(operation_name, wsdl, globals, transport)
     end
 
     def self.ensure_exists!(operation_name, wsdl)
@@ -31,22 +45,21 @@ module Savon
                                      "Operations provided by your service: #{wsdl.soap_actions.inspect}"
       end
     rescue Wasabi::Resolver::HTTPError => e
-      raise HTTPError.new(e.response)
+      raise HTTPError, e.response
     end
 
     def self.ensure_name_is_symbol!(operation_name)
-      unless operation_name.kind_of? Symbol
-        raise ArgumentError, "Expected the first parameter (the name of the operation to call) to be a symbol\n" \
-                             "Actual: #{operation_name.inspect} (#{operation_name.class})"
-      end
-    end
+      return if operation_name.is_a? Symbol
 
-    def initialize(name, wsdl, globals)
-      @name = name
-      @wsdl = wsdl
-      @globals = globals
+      raise ArgumentError, "Expected the first parameter (the name of the operation to call) to be a symbol\n" \
+                           "Actual: #{operation_name.inspect} (#{operation_name.class})"
+    end
 
-      @logger = RequestLogger.new(globals)
+    def initialize(name, wsdl, globals, transport)
+      @name      = name
+      @wsdl      = wsdl
+      @globals   = globals
+      @transport = transport
     end
 
     def build(locals = {}, &block)
@@ -54,20 +67,37 @@ module Savon
       Builder.new(@name, @wsdl, @globals, @locals)
     end
 
+    # Executes the SOAP operation and returns a Savon::Response.
+    #
+    # Observer short-circuit: if any registered observer returns a
+    # Transport::Response (or legacy HTTPI::Response), the HTTP call
+    # is skipped and that response is used directly.
     def call(locals = {}, &block)
-      builder = build(locals, &block)
-
+      builder  = build(locals, &block)
       response = Savon.notify_observers(@name, builder, @globals, @locals)
-      response ||= call_with_logging build_request(builder)
 
-      raise_expected_httpi_response! unless response.kind_of?(HTTPI::Response)
+      response =
+        if response.nil?
+          @transport.post(endpoint.to_s, soap_headers(builder), builder.to_s, @locals)
+        else
+          normalize_observer_response(response)
+        end
 
       create_response(response)
     end
 
+    # Builds and returns the HTTPI::Request that would be sent for this
+    # operation, without executing it. Useful for inspection and debugging.
+    # Not supported with transport: :faraday.
     def request(locals = {}, &block)
+      if @globals[:transport] == :faraday
+        raise ArgumentError, "#request returns an HTTPI::Request and is not supported " \
+                             "with transport: :faraday. Use client.faraday to configure " \
+                             "the connection"
+      end
+
       builder = build(locals, &block)
-      build_request(builder)
+      @transport.to_httpi_request(endpoint.to_s, soap_headers(builder), builder.to_s, @locals)
     end
 
     private
@@ -83,37 +113,33 @@ module Savon
       @locals = locals
     end
 
-    def call_with_logging(request)
-      @logger.log(request) { HTTPI.post(request, @globals[:adapter]) }
-    end
-
-    def build_request(builder)
-      @locals[:soap_action] ||= soap_action
-      @globals[:endpoint] ||= endpoint
-
-      request = SOAPRequest.new(@globals).build(
-        :soap_action => soap_action,
-        :cookies     => @locals[:cookies],
-        :headers     => @locals[:headers]
-      )
-
-      request.url = endpoint
-      request.body = builder.to_s
+    # Assembles the SOAP-level request headers for the given builder.
+    #
+    # Our responsibility regardless of transport:
+    #   * Content-Type (SOAP 1.1 §6 / SOAP 1.2 Part 2 §7.1.4)
+    #   * SOAPAction (SOAP 1.1 §6.1.1)
+    #   * Multipart Content-Type (RFC 2387), MIME-Version (RFC 2045 §4), Accept-Encoding (RFC 9110 §12.5.3)
+    def soap_headers(builder)
+      headers = {}
 
       if builder.multipart
-        request.gzip
-        request.headers["Content-Type"] = ["multipart/related",
-                                           "type=\"#{SOAP_REQUEST_TYPE[@globals[:soap_version]]}\"",
-                                           "start=\"#{builder.multipart[:start]}\"",
-                                           "boundary=\"#{builder.multipart[:multipart_boundary]}\""].join("; ")
-        request.headers["MIME-Version"] = "1.0"
+        # RFC 2387 §3 (multipart/related) - SOAP envelope is the root body part
+        headers["Content-Type"] = [
+          "multipart/related",
+          "type=\"#{SOAP_REQUEST_TYPE[@globals[:soap_version]]}\"",
+          "start=\"#{builder.multipart[:start]}\"",
+          "boundary=\"#{builder.multipart[:multipart_boundary]}\""
+        ].join("; ")
+        headers["MIME-Version"] = "1.0"
+        headers["Accept-Encoding"] = "gzip,deflate"
+      else
+        headers["Content-Type"] = CONTENT_TYPE[@globals[:soap_version]] % @globals[:encoding]
       end
 
-      # TODO: could HTTPI do this automatically in case the header
-      #       was not specified manually? [dh, 2013-01-04]
-      request.headers["Content-Length"] = request.body.bytesize.to_s
+      action = soap_action
+      headers["SOAPAction"] = %("#{action}") if action
 
-      request
+      headers
     end
 
     def soap_action
@@ -122,10 +148,10 @@ module Savon
 
       # get the soap_action from local options
       @locals[:soap_action] ||
-      # with no local option, but a wsdl, ask it for the soap_action
-      @wsdl.document? && @wsdl.soap_action(@name.to_sym) ||
-      # if there is no soap_action up to this point, fallback to a simple default
-      Gyoku.xml_tag(@name, :key_converter => @globals[:convert_request_keys_to])
+        # with no local option, but a wsdl, ask it for the soap_action
+        @wsdl.document? && @wsdl.soap_action(@name.to_sym) ||
+        # if there is no soap_action up to this point, fallback to a simple default
+        Gyoku.xml_tag(@name, key_converter: @globals[:convert_request_keys_to])
     end
 
     def endpoint
@@ -138,10 +164,21 @@ module Savon
       end
     end
 
-    def raise_expected_httpi_response!
-      raise Error, "Observers need to return an HTTPI::Response to mock " \
-                   "the request or nil to execute the request."
-    end
+    # Normalizes an observer return value into a Transport::Response.
+    #
+    # Accepts Transport::Response directly (current contract), wraps
+    # HTTPI::Response with a deprecation warning (legacy observer support),
+    # and raises on anything else.
+    def normalize_observer_response(response)
+      return response if response.is_a?(Transport::Response)
+
+      if response.is_a?(HTTPI::Response)
+        warn "Observers returning HTTPI::Response is deprecated - return Savon::Transport::Response instead."
+        return Transport::Response.from_httpi(response)
+      end
 
+      raise Error, "Observers need to return a Savon::Transport::Response " \
+                   "to mock the request or nil to execute the request."
+    end
   end
 end