savon 2.17.4 → 3.0.0.rc1

data/lib/savon/client.rb

@@ -1,26 +1,19 @@
 # frozen_string_literal: true
-
 require "savon/operation"
-require "savon/transport/httpi"
-require "savon/transport/faraday"
+require "savon/request"
 require "savon/options"
 require "savon/block_interface"
 require "wasabi"
 
 module Savon
-  # The main entry point for Savon.
-  #
-  # Holds global configuration, owns the WSDL document, and dispatches
-  # named operations. A single Client instance is typically shared across
-  # multiple calls to the same service.
   class Client
+
     def initialize(globals = {}, &block)
-      unless globals.is_a? Hash
+      unless globals.kind_of? Hash
         raise_version1_initialize_error! globals
       end
 
       set_globals(globals, block)
-      @globals.validate_transport!
 
       unless wsdl_or_endpoint_and_namespace_specified?
         raise_initialization_error!
@@ -31,25 +24,13 @@ module Savon
 
     attr_reader :globals, :wsdl
 
-    # Returns the memoized Faraday::Connection for this client.
-    # Callers use this to configure middleware, SSL, auth, timeouts, and any
-    # other transport-level concern before making calls.
-    # Raises ArgumentError if transport is not :faraday.
-    def faraday
-      unless @globals[:transport] == :faraday
-        raise ArgumentError, "client.faraday is only available when transport: :faraday is set"
-      end
-
-      @faraday ||= ::Faraday.new
-    end
-
     def operations
       raise_missing_wsdl_error! unless @wsdl.document?
       @wsdl.soap_actions
     end
 
     def operation(operation_name)
-      Operation.create(operation_name, @wsdl, @globals, build_transport)
+      Operation.create(operation_name, @wsdl, @globals)
     end
 
     def call(operation_name, locals = {}, &block)
@@ -67,15 +48,6 @@ module Savon
 
     private
 
-    # Builds the transport for a single operation.
-    def build_transport
-      if @globals[:transport] == :faraday
-        Transport::Faraday.new(faraday, @globals)
-      else
-        Transport::HTTPI.new(@globals)
-      end
-    end
-
     def set_globals(globals, block)
       globals = GlobalOptions.new(globals)
       BlockInterface.new(globals).evaluate(block) if block
@@ -86,16 +58,12 @@ module Savon
     def build_wsdl_document
       @wsdl = Wasabi::Document.new
 
-      @wsdl.document  = @globals[:wsdl]      if @globals.include? :wsdl
-      @wsdl.endpoint  = @globals[:endpoint]  if @globals.include? :endpoint
-      @wsdl.namespace = @globals[:namespace] if @globals.include? :namespace
+      @wsdl.document    = @globals[:wsdl]        if @globals.include? :wsdl
+      @wsdl.endpoint    = @globals[:endpoint]    if @globals.include? :endpoint
+      @wsdl.namespace   = @globals[:namespace]   if @globals.include? :namespace
+      @wsdl.adapter     = @globals[:adapter]     if @globals.include? :adapter
 
-      if @globals[:transport] == :faraday
-        @wsdl.request = faraday
-      else
-        @wsdl.adapter = @globals[:adapter] if @globals.include? :adapter
-        @wsdl.request = Transport::HTTPI.new(@globals).wsdl_request
-      end
+      @wsdl.request = WSDLRequest.new(@globals).build
     end
 
     def wsdl_or_endpoint_and_namespace_specified?
@@ -104,9 +72,9 @@ module Savon
 
     def raise_version1_initialize_error!(object)
       raise InitializationError,
-            "Some code tries to initialize Savon with the #{object.inspect} (#{object.class}) \n" \
-            "Savon 2 expects a Hash of options for creating a new client and executing requests.\n" \
-            "Please read the updated documentation for version 2: http://savonrb.com/version2.html"
+        "Some code tries to initialize Savon with the #{object.inspect} (#{object.class}) \n" \
+        "Savon 2 expects a Hash of options for creating a new client and executing requests.\n" \
+        "Please read the updated documentation for version 2: http://savonrb.com/version2.html"
     end
 
     def raise_initialization_error!
@@ -120,5 +88,6 @@ module Savon
     def raise_missing_wsdl_error!
       raise "Unable to inspect the service without a WSDL document."
     end
+
   end
 end

data/lib/savon/header.rb

@@ -1,136 +1,89 @@
 # frozen_string_literal: true
-
 require "akami"
 require "gyoku"
-require "savon/addressing"
+require "securerandom"
 
 module Savon
-  # Assembles the SOAP +Header+ element of a request envelope and renders it to
-  # XML.
-  #
-  # A SOAP Header carries a request's out-of-band metadata. This object is
-  # responsible for every header block Savon can emit, concatenated in this
-  # order:
-  #
-  # 1. application headers supplied by the caller (the +soap_header+ option),
-  # 2. the WS-Addressing headers, rendered by {Savon::Addressing},
-  # 3. the WS-Security header with UsernameToken credentials, a +wsu:Timestamp+
-  #    and an XML Signature (OASIS WSS SOAP Message Security 1.1).
-  #
-  # WS-Security markup is delegated to Akami and Hash-to-XML conversion to Gyoku.
   class Header
-    # @param globals [Savon::GlobalOptions] client-level options, read for the
-    #   Gyoku key converter (+:convert_request_keys_to+) and the WS-Addressing
-    #   toggle (+:use_wsa_headers+)
-    # @param effective [Savon::EffectiveOptions] resolves the WSSE, soap_header,
-    #   soap_action and endpoint values for the request
-    def initialize(globals, effective)
-      @gyoku_options  = { key_converter: globals[:convert_request_keys_to] }
-
-      @wsse_auth      = effective.wsse_auth
-      @wsse_timestamp = effective.wsse_timestamp
-      @wsse_signature = effective.wsse_signature
-      @soap_header    = effective.soap_header
-
-      @addressing = build_addressing(globals, effective)
-      @header     = build
-    end
 
-    attr_reader :gyoku_options, :wsse_auth, :wsse_timestamp, :wsse_signature
+    def initialize(globals, locals)
+      @gyoku_options  = { :key_converter => globals[:convert_request_keys_to] }
+
+      @wsse_auth      = locals[:wsse_auth].nil? ? globals[:wsse_auth] : locals[:wsse_auth]
+      @wsse_timestamp = locals[:wsse_timestamp].nil? ? globals[:wsse_timestamp] : locals[:wsse_timestamp]
+      @wsse_signature = locals[:wsse_signature].nil? ? globals[:wsse_signature] : locals[:wsse_signature]
 
-    # Returns the XML attributes of the enclosing Header element. Only the
-    # WS-Addressing section declares one, the +xmlns:wsa+ prefix.
-    #
-    # @return [Hash{String => String}]
-    def attributes
-      @addressing.namespace_attributes
+      @global_header  = globals[:soap_header]
+      @local_header   = locals[:soap_header]
+
+      @globals        = globals
+      @locals         = locals
+
+      @header = build
     end
 
-    # @return [Boolean] whether the rendered header is empty, i.e. there is no
-    #   header content to include in the envelope
+    attr_reader :local_header, :global_header, :gyoku_options,
+                :wsse_auth, :wsse_timestamp, :wsse_signature
+
     def empty?
       @header.empty?
     end
 
-    # Returns the rendered SOAP header XML. The header is built once during
-    # construction and cached, so this is a cheap, repeatable read.
-    #
-    # @return [String] the header XML (may be empty)
     def to_s
       @header
     end
 
     private
 
-    # Constructs the WS-Addressing section from the resolved request values.
-    # Resolving the endpoint raises without a WSDL document and without a
-    # global +:endpoint+, so action and endpoint are only resolved when the
-    # +:use_wsa_headers+ global asks for the headers.
-    #
-    # @return [Savon::Addressing]
-    def build_addressing(globals, effective)
-      return Addressing.new(enabled: false) unless globals[:use_wsa_headers]
-
-      Addressing.new(
-        enabled: true,
-        action: effective.soap_action,
-        to: effective.endpoint
-      )
-    end
-
-    # Concatenates the three header sections in document order: caller content,
-    # WS-Addressing, then WSSE security.
-    #
-    # @return [String]
     def build
-      build_header + @addressing.to_xml + build_wsse_header
+      build_header + build_wsa_header + build_wsse_header
     end
 
-    # Renders the resolved soap_header. {Savon::EffectiveOptions#soap_header}
-    # merges the global and local values, so there is nothing to combine here.
-    # Hash-to-XML conversion only. Strings pass through.
-    #
-    # @return [String]
     def build_header
-      convert_to_xml(@soap_header)
+      header =
+        if global_header.kind_of?(Hash) && local_header.kind_of?(Hash)
+          global_header.merge(local_header)
+        elsif local_header
+          local_header
+        else
+          global_header
+        end
+
+      convert_to_xml(header)
     end
 
-    # Builds the WS-Security header via Akami, or an empty string when no WSSE
-    # content (credentials, timestamp or signature) applies.
-    #
-    # @return [String]
     def build_wsse_header
       wsse_header = akami
       wsse_header.respond_to?(:to_xml) ? wsse_header.to_xml : ""
     end
 
-    # Renders a header value to XML. A Hash goes through Gyoku (honouring the
-    # configured key converter), anything else is coerced with +#to_s+.
-    #
-    # @param hash_or_string [Hash, #to_s] the header content
-    # @return [String]
+    def build_wsa_header
+       return '' unless @globals[:use_wsa_headers]
+       convert_to_xml({
+         'wsa:Action' => @locals[:soap_action],
+         'wsa:To' => @globals[:endpoint],
+         'wsa:MessageID' => "urn:uuid:#{SecureRandom.uuid}"
+       })
+    end
+
     def convert_to_xml(hash_or_string)
-      if hash_or_string.is_a? Hash
+      if hash_or_string.kind_of? Hash
         Gyoku.xml(hash_or_string, gyoku_options)
       else
         hash_or_string.to_s
       end
     end
 
-    # Configures an Akami WSSE object from the resolved WSSE options. Sets the
-    # UsernameToken credentials, enables the wsu:Timestamp, and attaches the XML
-    # Signature when a document has been assigned to it.
-    #
-    # @return [Akami::WSSE] configured, not yet serialized
     def akami
       wsse = Akami.wsse
       wsse.credentials(*wsse_auth) if wsse_auth
       wsse.timestamp = wsse_timestamp if wsse_timestamp
-      if wsse_signature&.have_document?
+      if wsse_signature && wsse_signature.have_document?
         wsse.signature = wsse_signature
       end
 
       wsse
     end
+
   end
 end

data/lib/savon/http_error.rb

@@ -2,26 +2,26 @@
 
 module Savon
   class HTTPError < Error
+
     def self.present?(http)
-      http.error?
+      !http.success?
     end
 
-    def initialize(transport_response)
-      @transport_response = transport_response
+    def initialize(http)
+      @http = http
     end
 
-    def http
-      @transport_response
-    end
+    attr_reader :http
 
     def to_s
-      String.new("HTTP error (#{http.code})").tap do |str_error|
-        str_error << ": #{http.body}" unless http.body.empty?
+      String.new("HTTP error (#{@http.status})").tap do |str_error|
+        str_error << ": #{@http.body}" unless @http.body.empty?
       end
     end
 
     def to_hash
-      { code: http.code, headers: http.headers, body: http.body }
+      { :code => @http.status, :headers => @http.headers, :body => @http.body }
     end
+
   end
 end

data/lib/savon/log_message.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-
 require "nokogiri"
 
 module Savon
   class LogMessage
+
     def initialize(message, filters = [], pretty_print = false)
       @message      = message
       @filters      = filters
@@ -46,7 +46,8 @@ module Savon
     end
 
     def nokogiri_options
-      @pretty_print ? { indent: 2 } : { save_with: Nokogiri::XML::Node::SaveOptions::AS_XML }
+      @pretty_print ? { :indent => 2 } : { :save_with => Nokogiri::XML::Node::SaveOptions::AS_XML }
     end
+
   end
 end

data/lib/savon/message.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-
 require "savon/qualified_message"
 require "gyoku"
 
 module Savon
   class Message
+
     def initialize(message_tag, namespace_identifier, types, used_namespaces, message, element_form_default, key_converter, unwrap)
       @message_tag = message_tag
       @namespace_identifier = namespace_identifier
@@ -18,20 +18,21 @@ module Savon
     end
 
     def to_s
-      return @message.to_s unless @message.is_a? Hash
+      return @message.to_s unless @message.kind_of? Hash
 
       if @element_form_default == :qualified
         @message = QualifiedMessage.new(@types, @used_namespaces, @key_converter).to_hash(@message, [@message_tag.to_s])
       end
 
       gyoku_options = {
-        element_form_default: @element_form_default,
-        namespace: @namespace_identifier,
-        key_converter: @key_converter,
-        unwrap: @unwrap
+        :element_form_default => @element_form_default,
+        :namespace            => @namespace_identifier,
+        :key_converter        => @key_converter,
+        :unwrap               => @unwrap
       }
 
       Gyoku.xml(@message, gyoku_options)
     end
+
   end
 end

data/lib/savon/mock/expectation.rb

@@ -1,18 +1,11 @@
 # frozen_string_literal: true
-
-require "httpi"
-require "savon/transport/response"
+require "faraday"
 
 module Savon
-  # A single test expectation set up by Savon's mock interface.
-  # One expectation covers one operation call in one test.
-  #
-  # Records the expected operation name and message, captures what was
-  # actually called, and either returns a synthetic response or raises
-  # an error on mismatch.
   class MockExpectation
+
     def initialize(operation_name)
-      @expected = { operation_name: operation_name }
+      @expected = { :operation_name => operation_name }
       @actual = nil
     end
 
@@ -22,15 +15,15 @@ module Savon
     end
 
     def returns(response)
-      response = { code: 200, headers: {}, body: response } if response.is_a?(String)
+      response = { :code => 200, :headers => {}, :body => response } if response.kind_of?(String)
       @response = response
       self
     end
 
-    def actual(operation_name, _builder, _globals, locals)
+    def actual(operation_name, builder, globals, locals)
       @actual = {
-        operation_name: operation_name,
-        message: locals[:message]
+        :operation_name => operation_name,
+        :message        => locals[:message]
       }
     end
 
@@ -44,49 +37,42 @@ module Savon
       verify_message!
     end
 
-    # Builds and returns a Transport::Response from the configured response hash.
-    #
-    # @return [Transport::Response]
-    # @raise  [ExpectationError] if no response was configured for this expectation
     def response!
       unless @response
         raise ExpectationError, "This expectation was not set up with a response."
       end
-
-      Transport::Response.new(@response[:code], @response[:headers], @response[:body])
+      env = Faraday::Env.from(status: @response[:code], response_headers: @response[:headers], response_body: @response[:body])
+      Faraday::Response.new(env)
     end
 
     private
 
     def verify_operation_name!
-      return if @expected[:operation_name] == @actual[:operation_name]
-
-      raise ExpectationError, "Expected a request to the #{@expected[:operation_name].inspect} operation.\n" \
-                              "Received a request to the #{@actual[:operation_name].inspect} operation instead."
+      unless @expected[:operation_name] == @actual[:operation_name]
+        raise ExpectationError, "Expected a request to the #{@expected[:operation_name].inspect} operation.\n" \
+                                "Received a request to the #{@actual[:operation_name].inspect} operation instead."
+      end
     end
 
     def verify_message!
       return if @expected[:message].eql? :any
+      unless equals_except_any(@expected[:message], @actual[:message])
+        expected_message = "  with this message: #{@expected[:message].inspect}" if @expected[:message]
+        expected_message ||= "  with no message."
 
-      return if equals_except_any(@expected[:message], @actual[:message])
+        actual_message = "  with this message: #{@actual[:message].inspect}" if @actual[:message]
+        actual_message ||= "  with no message."
 
-      expected_message = "  with this message: #{@expected[:message].inspect}" if @expected[:message]
-      expected_message ||= "  with no message."
-
-      actual_message = "  with this message: #{@actual[:message].inspect}" if @actual[:message]
-      actual_message ||= "  with no message."
-
-      raise ExpectationError, "Expected a request to the #{@expected[:operation_name].inspect} operation\n#{expected_message}\n" \
-      "Received a request to the #{@actual[:operation_name].inspect} operation\n#{actual_message}"
+        raise ExpectationError, "Expected a request to the #{@expected[:operation_name].inspect} operation\n#{expected_message}\n" \
+        "Received a request to the #{@actual[:operation_name].inspect} operation\n#{actual_message}"
+      end
     end
 
     def equals_except_any(msg_expected, msg_real)
-      # === allows RSpec matchers (e.g. include(:key)) to be used as expected values
-      return true if msg_expected === msg_real # rubocop:disable Style/CaseEquality
-      return false if msg_expected.nil? || msg_real.nil? # If both are nil has returned true
-
+      return true if msg_expected === msg_real
+      return false if (msg_expected.nil? || msg_real.nil?) # If both are nil has returned true
       msg_expected.each do |key, expected_value|
-        next if expected_value == :any && msg_real.include?(key)
+        next if (expected_value == :any &&  msg_real.include?(key))
         return false if expected_value != msg_real[key]
       end
       true

data/lib/savon/mock/spec_helper.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-
 require "savon/mock"
 
 module Savon
   module SpecHelper
+
     class Interface
+
       def mock!
         Savon.observers << self
       end
@@ -26,12 +27,14 @@ module Savon
       def notify(operation_name, builder, globals, locals)
         expectation = expectations.shift
 
-        raise ExpectationError, "Unexpected request to the #{operation_name.inspect} operation." unless expectation
-
-        expectation.actual(operation_name, builder, globals, locals)
+        if expectation
+          expectation.actual(operation_name, builder, globals, locals)
 
-        expectation.verify!
-        expectation.response!
+          expectation.verify!
+          expectation.response!
+        else
+          raise ExpectationError, "Unexpected request to the #{operation_name.inspect} operation."
+        end
       rescue ExpectationError
         @expectations.clear
         raise
@@ -39,12 +42,12 @@ module Savon
 
       def verify!
         return if expectations.empty?
-
         expectations.each(&:verify!)
       rescue ExpectationError
         @expectations.clear
         raise
       end
+
     end
 
     def savon
@@ -55,5 +58,6 @@ module Savon
       super if defined? super
       savon.verify!
     end
+
   end
 end

data/lib/savon/mock.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module Savon
   class ExpectationError < StandardError; end
 end

data/lib/savon/model.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-
 module Savon
   module Model
+
     def self.extended(base)
       base.setup
     end
@@ -28,30 +28,26 @@ module Savon
 
     # Defines a class-level SOAP operation.
     def define_class_operation(operation)
-      method_name = operation_method_name(operation)
-
-      class_operation_module.define_method(method_name) do |locals = {}|
-        client.call operation, locals
-      end
+      class_operation_module.module_eval %{
+        def #{StringUtils.snakecase(operation.to_s)}(locals = {})
+          client.call #{operation.inspect}, locals
+        end
+      }
     end
 
     # Defines an instance-level SOAP operation.
     def define_instance_operation(operation)
-      method_name = operation_method_name(operation)
-
-      instance_operation_module.define_method(method_name) do |locals = {}|
-        self.class.public_send(method_name, locals)
-      end
-    end
-
-    # Returns the generated Ruby method name for a SOAP operation.
-    def operation_method_name(operation)
-      StringUtils.snakecase(operation.to_s).to_sym
+      instance_operation_module.module_eval %{
+        def #{StringUtils.snakecase(operation.to_s)}(locals = {})
+          self.class.#{StringUtils.snakecase(operation.to_s)} locals
+        end
+      }
     end
 
     # Class methods.
     def class_operation_module
-      @class_operation_module ||= Module.new do
+      @class_operation_module ||= Module.new {
+
         def client(globals = {})
           @client ||= Savon::Client.new(globals)
         rescue InitializationError
@@ -64,22 +60,26 @@ 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
-      end.tap { |mod| extend(mod) }
+
+      }.tap { |mod| extend(mod) }
     end
 
     # Instance methods.
     def instance_operation_module
-      @instance_operation_module ||= Module.new do
+      @instance_operation_module ||= Module.new {
+
         def client
           self.class.client
         end
-      end.tap { |mod| include(mod) }
+
+      }.tap { |mod| include(mod) }
     end
+
   end
 end