soaspec 0.2.32 → 0.2.33

data/lib/soaspec/exchange_handlers/rest_methods.rb

@@ -1,65 +1,65 @@
-# frozen_string_literal: true
-
-module Soaspec
-  # Contains commonly used REST methods. Include this module in the spec where you want to use it
-  #
-  # TODO: For some reason from 'soaspec pry' sinatra always gets loaded instead of this
-  #
-  # @example
-  #   include Soaspec::RestMethods
-  #
-  #   context CustomExchangeHandler.new('Create Notes') do
-  #     post(:minimum_data, body: { subject: 'Minimal' }) do
-  #       it_behaves_like 'success scenario'
-  #       its(:subject) { is_expected.to eq 'Minimal' }
-  #     end
-  #
-  #     post(:one_note, body: { subject: 'One', note: { 'Note 1' } }) do
-  #       it_behaves_like 'success scenario'
-  #       it 'has 1 note' do
-  #         expect(get(subject.id).values_at_path('notes').count).to eq 1
-  #       end
-  #     end
-  #   end
-  module RestMethods
-    # Make REST Post Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def post(name, params = {})
-      Exchange.new(name, method: :post, **params)
-    end
-
-    # Make REST Patch Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def patch(name, params = {})
-      Exchange.new(name, method: :patch, **params)
-    end
-
-    # Make REST Put Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def put(name, params = {})
-      Exchange.new(name, method: :put, **params)
-    end
-
-    # Make REST Get Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def get(name, params = {})
-      Exchange.new(name, method: :get, **params)
-    end
-
-    # Make REST Delete Exchange
-    # @param [String] name Name of test displayed
-    # @param [Hash] params Exchange parameters
-    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-    def delete(name, params = {})
-      Exchange.new(name, method: :delete, **params)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Soaspec
+  # Contains commonly used REST methods. Include this module in the spec where you want to use it
+  #
+  # TODO: For some reason from 'soaspec pry' sinatra always gets loaded instead of this
+  #
+  # @example
+  #   include Soaspec::RestMethods
+  #
+  #   context CustomExchangeHandler.new('Create Notes') do
+  #     post(:minimum_data, body: { subject: 'Minimal' }) do
+  #       it_behaves_like 'success scenario'
+  #       its(:subject) { is_expected.to eq 'Minimal' }
+  #     end
+  #
+  #     post(:one_note, body: { subject: 'One', note: { 'Note 1' } }) do
+  #       it_behaves_like 'success scenario'
+  #       it 'has 1 note' do
+  #         expect(get(subject.id).values_at_path('notes').count).to eq 1
+  #       end
+  #     end
+  #   end
+  module RestMethods
+    # Make REST Post Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def post(name, params = {})
+      Exchange.new(name, method: :post, **params)
+    end
+
+    # Make REST Patch Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def patch(name, params = {})
+      Exchange.new(name, method: :patch, **params)
+    end
+
+    # Make REST Put Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def put(name, params = {})
+      Exchange.new(name, method: :put, **params)
+    end
+
+    # Make REST Get Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def get(name, params = {})
+      Exchange.new(name, method: :get, **params)
+    end
+
+    # Make REST Delete Exchange
+    # @param [String] name Name of test displayed
+    # @param [Hash] params Exchange parameters
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def delete(name, params = {})
+      Exchange.new(name, method: :delete, **params)
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/rest_parameters.rb

@@ -1,112 +1,112 @@
-# frozen_string_literal: true
-
-module Soaspec
-  # Methods to define parameters specific to REST handler
-  module RestParameters
-    # Defines method 'base_url_value' containing base URL used in REST requests
-    # @param [String] url Base Url to use in REST requests. Suburl is appended to this
-    def base_url(url)
-      raise ArgumentError, "Base Url passed must be a String for #{self} but was #{url.class}" unless url.is_a?(String)
-
-      define_method('base_url_value') { ERB.new(url).result(binding) }
-      # URL used if subclassing handler that sets this previously
-      define_singleton_method('parent_url') { ERB.new(url).result(binding) }
-    end
-
-    # Will create access_token method based on passed parameters
-    # @param [Hash] params OAuth 2 parameters
-    # @option params [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
-    # @option params [client_id] Client ID
-    # @option params [client_secret] Client Secret
-    # @option params [username] Username used in password grant
-    # @option params [password] Password used in password grant
-    # @option params [security_token] Security Token used in password grant
-    def oauth2(params)
-      # @!method oauth_obj Object to handle oauth2
-      define_method('oauth_obj') { OAuth2.new(params, api_username) }
-      # @!method access_token Retrieve OAuth2 access token
-      define_method('access_token') { oauth_obj.access_token }
-      # @!method instance_url Retrieve instance url from OAuth request
-      define_method('instance_url') { oauth_obj.instance_url }
-    end
-
-    # Pass path to YAML file containing OAuth2 parameters
-    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
-    def oauth2_file(path_to_filename)
-      oauth_parameters = load_credentials_hash(path_to_filename)
-      @client_id = oauth_parameters[:client_id] if oauth_parameters[:client_id]
-      oauth2 oauth_parameters
-    end
-
-    # @return [String] Client id obtained from credentials file
-    def client_id
-      raise '@client_id is not set. Set by specifying credentials file with "oauth2_file FILENAME" before this is called' unless @client_id
-
-      @client_id
-    end
-
-    # Define basic authentication
-    # @param [String] user Username to use
-    # @param [String] password Password to use
-    def basic_auth(user: nil, password: nil)
-      raise ArgumentError, "Must pass both 'user' and 'password' for #{self}" unless user && password
-
-      define_method('basic_auth_params') do
-        { user: user, password: password }
-      end
-    end
-
-    # Pass path to YAML file containing Basic Auth parameters (i.e, both username and password)
-    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
-    def basic_auth_file(path_to_filename)
-      basic_auth load_credentials_hash(path_to_filename)
-    end
-
-    # @param [Hash] headers Hash of REST headers used in RestClient
-    def headers(headers)
-      define_method('rest_client_headers') { headers }
-    end
-
-    # Convert each key from snake_case to PascalCase
-    def pascal_keys(set)
-      define_method('pascal_keys?') { set }
-    end
-
-    # Pass block to perform after every response is retrieved
-    # @example Throw exception if response body has an 'error' element equal to true
-    #   after_response do |response, handler|
-    #     raise Soaspec::ResponseError if handler.value_from_path(response, 'error')
-    #   end
-    def after_response
-      define_method('after_response') { |response, _self| yield response, self }
-    end
-
-    # @param [Array] exception_list List of exceptions to retry response on. Default is
-    #   any REST exception
-    # @param [Integer] pause Time to wait before retrying
-    # @param [Integer] count Times to retry
-    def retry_on_exceptions(exception_list = [RestClient::RestHandler], pause: 1,
-                            count: 3)
-      define_method('retry_on_exceptions') { exception_list }
-      define_method('retry_pause_time') { pause }
-      define_method('retry_exception_limit') { count }
-    end
-
-    private
-
-    # Load credentials hash from a YAML using Soaspec.credentials_folder if set, adding '.yml' if not set
-    # @return [Hash] Hash with credentials in it
-    def load_credentials_hash(filename)
-      raise ArgumentError, "Filename passed must be a String for #{self} but was #{filename.class}" unless filename.is_a?(String)
-
-      full_path = Soaspec.credentials_folder ? File.join(Soaspec.credentials_folder, filename) : filename
-      full_path += '.yml' unless full_path.end_with?('.yml') # Automatically add 'yml' extension
-      raise "No file at #{full_path}. 'Soaspec.credentials_folder' is '#{Soaspec.credentials_folder}'" unless File.exist? full_path
-
-      file_hash = YAML.load_file(full_path)
-      raise "File at #{full_path} is not a hash" unless file_hash.is_a? Hash
-
-      file_hash.transform_keys_to_symbols
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Soaspec
+  # Methods to define parameters specific to REST handler
+  module RestParameters
+    # Defines method 'base_url_value' containing base URL used in REST requests
+    # @param [String] url Base Url to use in REST requests. Suburl is appended to this
+    def base_url(url)
+      raise ArgumentError, "Base Url passed must be a String for #{self} but was #{url.class}" unless url.is_a?(String)
+
+      define_method('base_url_value') { ERB.new(url).result(binding) }
+      # URL used if subclassing handler that sets this previously
+      define_singleton_method('parent_url') { ERB.new(url).result(binding) }
+    end
+
+    # Will create access_token method based on passed parameters
+    # @param [Hash] params OAuth 2 parameters
+    # @option params [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @option params [client_id] Client ID
+    # @option params [client_secret] Client Secret
+    # @option params [username] Username used in password grant
+    # @option params [password] Password used in password grant
+    # @option params [security_token] Security Token used in password grant
+    def oauth2(params)
+      # @!method oauth_obj Object to handle oauth2
+      define_method('oauth_obj') { OAuth2.new(params, api_username) }
+      # @!method access_token Retrieve OAuth2 access token
+      define_method('access_token') { oauth_obj.access_token }
+      # @!method instance_url Retrieve instance url from OAuth request
+      define_method('instance_url') { oauth_obj.instance_url }
+    end
+
+    # Pass path to YAML file containing OAuth2 parameters
+    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
+    def oauth2_file(path_to_filename)
+      oauth_parameters = load_credentials_hash(path_to_filename)
+      @client_id = oauth_parameters[:client_id] if oauth_parameters[:client_id]
+      oauth2 oauth_parameters
+    end
+
+    # @return [String] Client id obtained from credentials file
+    def client_id
+      raise '@client_id is not set. Set by specifying credentials file with "oauth2_file FILENAME" before this is called' unless @client_id
+
+      @client_id
+    end
+
+    # Define basic authentication
+    # @param [String] user Username to use
+    # @param [String] password Password to use
+    def basic_auth(user: nil, password: nil)
+      raise ArgumentError, "Must pass both 'user' and 'password' for #{self}" unless user && password
+
+      define_method('basic_auth_params') do
+        { user: user, password: password }
+      end
+    end
+
+    # Pass path to YAML file containing Basic Auth parameters (i.e, both username and password)
+    # @param [String] path_to_filename Will have Soaspec.credentials_folder appended to it if set
+    def basic_auth_file(path_to_filename)
+      basic_auth load_credentials_hash(path_to_filename)
+    end
+
+    # @param [Hash] headers Hash of REST headers used in RestClient
+    def headers(headers)
+      define_method('rest_client_headers') { headers }
+    end
+
+    # Convert each key from snake_case to PascalCase
+    def pascal_keys(set)
+      define_method('pascal_keys?') { set }
+    end
+
+    # Pass block to perform after every response is retrieved
+    # @example Throw exception if response body has an 'error' element equal to true
+    #   after_response do |response, handler|
+    #     raise Soaspec::ResponseError if handler.value_from_path(response, 'error')
+    #   end
+    def after_response
+      define_method('after_response') { |response, _self| yield response, self }
+    end
+
+    # @param [Array] exception_list List of exceptions to retry response on. Default is
+    #   any REST exception
+    # @param [Integer] pause Time to wait before retrying
+    # @param [Integer] count Times to retry
+    def retry_on_exceptions(exception_list = [RestClient::RestHandler], pause: 1,
+                            count: 3)
+      define_method('retry_on_exceptions') { exception_list }
+      define_method('retry_pause_time') { pause }
+      define_method('retry_exception_limit') { count }
+    end
+
+    private
+
+    # Load credentials hash from a YAML using Soaspec.credentials_folder if set, adding '.yml' if not set
+    # @return [Hash] Hash with credentials in it
+    def load_credentials_hash(filename)
+      raise ArgumentError, "Filename passed must be a String for #{self} but was #{filename.class}" unless filename.is_a?(String)
+
+      full_path = Soaspec.credentials_folder ? File.join(Soaspec.credentials_folder, filename) : filename
+      full_path += '.yml' unless full_path.end_with?('.yml') # Automatically add 'yml' extension
+      raise "No file at #{full_path}. 'Soaspec.credentials_folder' is '#{Soaspec.credentials_folder}'" unless File.exist? full_path
+
+      file_hash = YAML.load_file(full_path)
+      raise "File at #{full_path} is not a hash" unless file_hash.is_a? Hash
+
+      file_hash.transform_keys_to_symbols
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/rest_parameters_defaults.rb

@@ -1,42 +1,42 @@
-# frozen_string_literal: true
-
-module Soaspec
-  # Defaults for Soaspec RestParameters methods
-  module RestParametersDefaults
-    # This must be overridden by using 'base_url' method within class definition
-    # @return [String] Set through following method. Base URL in REST requests.
-    def base_url_value
-      nil
-    end
-
-    # This returns the base url that can be accessed by a subclass. It is set by
-    # the 'base_url' method
-    #
-    # @example
-    #   class Parent < Soaspec::RestHandler
-    #     base_url 'parent'
-    #   end
-    #
-    #   class Child < Parent
-    #     base_url "#{parent_url}/child_path"
-    #   end
-    #
-    #   Child.new.base_url_value # => 'parent/child_path'
-    # @return [String] Base url that can be accessed by a subclass.
-    def parent_url
-      raise 'This needs to be set through base_url method'
-    end
-
-    # @return [Hash] Headers used in RestClient
-    def rest_client_headers
-      {}
-    end
-
-    # Whether to convert each key in the request to PascalCase
-    # It will also auto convert simple XPath, JSONPath where '//' or '..' not specified
-    # @return [Boolean] Whether to convert to PascalCase
-    def pascal_keys?
-      false
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Soaspec
+  # Defaults for Soaspec RestParameters methods
+  module RestParametersDefaults
+    # This must be overridden by using 'base_url' method within class definition
+    # @return [String] Set through following method. Base URL in REST requests.
+    def base_url_value
+      nil
+    end
+
+    # This returns the base url that can be accessed by a subclass. It is set by
+    # the 'base_url' method
+    #
+    # @example
+    #   class Parent < Soaspec::RestHandler
+    #     base_url 'parent'
+    #   end
+    #
+    #   class Child < Parent
+    #     base_url "#{parent_url}/child_path"
+    #   end
+    #
+    #   Child.new.base_url_value # => 'parent/child_path'
+    # @return [String] Base url that can be accessed by a subclass.
+    def parent_url
+      raise 'This needs to be set through base_url method'
+    end
+
+    # @return [Hash] Headers used in RestClient
+    def rest_client_headers
+      {}
+    end
+
+    # Whether to convert each key in the request to PascalCase
+    # It will also auto convert simple XPath, JSONPath where '//' or '..' not specified
+    # @return [Boolean] Whether to convert to PascalCase
+    def pascal_keys?
+      false
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -1,241 +1,241 @@
-# frozen_string_literal: true
-
-require_relative 'exchange_handler'
-require_relative '../core_ext/hash'
-require_relative '../errors'
-require_relative 'handler_accessors'
-require_relative '../interpreter'
-require_relative 'request/soap_request'
-require 'forwardable'
-
-module Soaspec
-  # Accessors specific to SOAP handler
-  module SoapAccessors
-    # Define attributes set on root SOAP element
-    # @param [Hash] attributes Attributes used in the root SOAP element
-    def root_attributes(attributes)
-      define_method('request_root_attributes') { attributes }
-    end
-  end
-
-  # Wraps around Savon client defining default values dependent on the soap request
-  class SoapHandler < ExchangeHandler
-    extend Soaspec::SoapAccessors
-    extend Forwardable
-
-    delegate [:operations] => :client
-
-    # Savon client used to make SOAP calls
-    attr_accessor :client
-    # SOAP Operation to use by default
-    attr_accessor :operation
-
-    # Attributes set at the root XML element of SOAP request
-    def request_root_attributes; end
-
-    # Options to log xml request and response
-    def logging_options
-      {
-        log: true, # See request and response. (Put this in traffic file)
-        log_level: :debug,
-        logger: Soaspec::SpecLogger.create,
-        pretty_print_xml: true # Prints XML pretty
-      }
-    end
-
-    # Default Savon options. See http://savonrb.com/version2/globals.html for details
-    # @example Things could go wrong if not set properly
-    #   env_namespace: :soap, # Change environment namespace
-    #   namespace_identifier: :tst, # Change namespace element
-    #   element_form_default: :qualified # Populate each element with namespace
-    #   namespace: 'http://Extended_namespace.xsd' change root namespace
-    #   basic_auth: 'user', 'password'
-    # @return [Hash] Default Savon options for all BasicSoapHandler
-    def default_options
-      {
-        ssl_verify_mode: :none, # Easier for testing. Not so secure
-        follow_redirects: true, # Necessary for many API calls
-        soap_version: 2, # use SOAP 1.2. You will get 415 error if this is incorrect
-        raise_errors: false # HTTP errors not cause failure as often negative test scenarios expect not 200 response
-      }
-    end
-
-    # Add values to here when extending this class to have default Savon options.
-    # See http://savonrb.com/version2/globals.html for details
-    # @return [Hash] Savon options adding to & overriding defaults
-    def savon_options
-      {}
-    end
-
-    # Setup object to handle communicating with a particular SOAP WSDL
-    # @param [String] name Name to describe handler. Used in calling 'to_s'
-    # @param [Hash] options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
-    def initialize(name = self.class.to_s, options = {})
-      if name.is_a?(Hash) && options == {} # If name is not set
-        options = name
-        name = self.class.to_s
-      end
-      super
-      set_remove_keys(options, %i[operation default_hash template_name])
-      merged_options = Soaspec::SpecLogger.log_api_traffic? ? default_options.merge(logging_options) : default_options
-      merged_options.merge! savon_options
-      merged_options.merge!(options)
-      self.client = Savon.client(merged_options)
-    end
-
-    # @param [Hash] override_parameters Parameters for building the request
-    # @return [Hash] Parameters used in making a request
-    def request_parameters(override_parameters)
-      SoapRequest.new(operation, request_body_params(override_parameters), @request_option)
-    end
-
-    # Used in making request via hash or in template via Erb
-    # @param [Hash] request_parameters Hash representing elements to send in request
-    #                                  If the :body key is set, this will be used as the request body
-    def request_body_params(request_parameters)
-      test_values = request_parameters[:body] || request_parameters
-      test_values.transform_keys_to_symbols if Soaspec.always_use_keys?
-      if @request_option == :template
-        test_values = IndifferentHash.new(test_values) # Allow test_values to be either Symbol or String
-        { xml: Soaspec::TemplateReader.new.render_body(template_name, binding) }
-      elsif @request_option == :hash
-        { message: @default_hash.merge(test_values), attributes: request_root_attributes }
-      end
-    end
-
-    # Used in together with Exchange request that passes such override parameters
-    # @param [Hash] request_parameters Parameters used to overwrite defaults in request
-    def make_request(request_parameters)
-      # Call the SOAP operation with the request XML provided
-      request = request_parameters(request_parameters)
-      begin
-        client.call request.operation, request.body # request_body_params(request_parameters)
-      rescue Savon::HTTPError => e
-        soap_error
-      end
-    end
-
-    # @param [Hash] format Format of expected result
-    # @return [Object] Generic body to be displayed in error messages
-    def response_body(response, format: :hash)
-      case format
-      when :hash
-        response.body
-      when :raw
-        response.xml
-      else
-        response.body
-      end
-    end
-
-    # @return [Boolean] Whether the request found the desired value or not
-    def found?(response)
-      status_code_for(response) != 404
-    end
-
-    # Response status code for response. '200' indicates a success
-    # @param [Savon::Response] response
-    # @return [Integer] Status code
-    def status_code_for(response)
-      response.http.code
-    end
-
-    # @return [Boolean] Whether response includes provided string within it
-    def include_in_body?(response, expected)
-      response.to_xml.to_s.include? expected
-    end
-
-    # @param [Symbol] expected
-    # @return [Boolean] Whether response body contains expected key
-    def include_key?(response, expected)
-      body = response.body
-      body.extend Hashie::Extensions::DeepFind
-      !body.deep_find_all(expected).empty?
-    end
-
-    # Convert all XML nodes to lowercase
-    # @param [Nokogiri::XML::Document] xml_doc Xml document to convert
-    def convert_to_lower_case(xml_doc)
-      xml_doc.traverse do |node|
-        node.name = node.name.downcase if node.is_a?(Nokogiri::XML::Element)
-      end
-    end
-
-    # Returns the value at the provided xpath
-    # @param [Savon::Response] response
-    # @param [String] xpath
-    # @return [Enumerable] Elements found through Xpath
-    def xpath_elements_for(response: nil, xpath: nil, attribute: nil)
-      raise ArgumentError('response and xpath must be passed to method') unless response && xpath
-
-      xpath = "//*[@#{attribute}]" unless attribute.nil?
-      xpath = '//' + xpath if xpath[0] != '/'
-      temp_doc = response.doc.dup
-      convert_to_lower_case(temp_doc) if convert_to_lower?
-      if strip_namespaces? && !xpath.include?(':')
-        temp_doc.remove_namespaces!
-        temp_doc.xpath(xpath)
-      else
-        temp_doc.xpath(xpath, temp_doc.collect_namespaces)
-      end
-    end
-
-    # Based on a exchange, return the value at the provided xpath
-    # If the path does not begin with a '/', a '//' is added to it
-    # @param [Savon::Response] response
-    # @param [String] path Xpath
-    # @param [String] attribute Generic attribute to find. Will override path
-    # @return [String] Value at Xpath
-    def value_from_path(response, path, attribute: nil)
-      results = xpath_elements_for(response: response, xpath: path, attribute: attribute)
-      raise NoElementAtPath, "No value at Xpath '#{path}' in XML #{response.doc}" if results.empty?
-      return results.first.inner_text if attribute.nil?
-
-      results.first.attributes[attribute].inner_text
-    end
-
-    # @return [Enumerable] List of values returned from path
-    def values_from_path(response, path, attribute: nil)
-      xpath_elements_for(response: response, xpath: path, attribute: attribute).map(&:inner_text)
-    end
-
-    # alias elements xpath_elements_for
-
-    # @return [Boolean] Whether any of the keys of the Body Hash include value
-    def include_value?(response, expected_value)
-      response.body.include_value?(expected_value)
-    end
-
-    # Hash of response body
-    def to_hash(response)
-      response.body
-    end
-
-    # Convenience methods for once off usage of a SOAP request
-    class << self
-      # Implement undefined setter with []= for FactoryBot to use without needing to define params to set
-      # @param [Object] method_name Name of method not defined
-      # @param [Object] args Arguments passed to method
-      # @param [Object] block
-      def method_missing(method_name, *args, &block)
-        tmp_class = new(method_name)
-        operations = tmp_class.operations
-        if operations.include? method_name
-          tmp_class.operation = method_name
-          exchange = Exchange.new(method_name, *args)
-          exchange.exchange_handler = tmp_class
-          yield exchange if block_given?
-          exchange
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method_name, *args)
-        tmp_class = new(args)
-        operations = tmp_class.operations
-        operations.include?(method_name) || super
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'exchange_handler'
+require_relative '../core_ext/hash'
+require_relative '../errors'
+require_relative 'handler_accessors'
+require_relative '../interpreter'
+require_relative 'request/soap_request'
+require 'forwardable'
+
+module Soaspec
+  # Accessors specific to SOAP handler
+  module SoapAccessors
+    # Define attributes set on root SOAP element
+    # @param [Hash] attributes Attributes used in the root SOAP element
+    def root_attributes(attributes)
+      define_method('request_root_attributes') { attributes }
+    end
+  end
+
+  # Wraps around Savon client defining default values dependent on the soap request
+  class SoapHandler < ExchangeHandler
+    extend Soaspec::SoapAccessors
+    extend Forwardable
+
+    delegate [:operations] => :client
+
+    # Savon client used to make SOAP calls
+    attr_accessor :client
+    # SOAP Operation to use by default
+    attr_accessor :operation
+
+    # Attributes set at the root XML element of SOAP request
+    def request_root_attributes; end
+
+    # Options to log xml request and response
+    def logging_options
+      {
+        log: true, # See request and response. (Put this in traffic file)
+        log_level: :debug,
+        logger: Soaspec::SpecLogger.create,
+        pretty_print_xml: true # Prints XML pretty
+      }
+    end
+
+    # Default Savon options. See http://savonrb.com/version2/globals.html for details
+    # @example Things could go wrong if not set properly
+    #   env_namespace: :soap, # Change environment namespace
+    #   namespace_identifier: :tst, # Change namespace element
+    #   element_form_default: :qualified # Populate each element with namespace
+    #   namespace: 'http://Extended_namespace.xsd' change root namespace
+    #   basic_auth: 'user', 'password'
+    # @return [Hash] Default Savon options for all BasicSoapHandler
+    def default_options
+      {
+        ssl_verify_mode: :none, # Easier for testing. Not so secure
+        follow_redirects: true, # Necessary for many API calls
+        soap_version: 2, # use SOAP 1.2. You will get 415 error if this is incorrect
+        raise_errors: false # HTTP errors not cause failure as often negative test scenarios expect not 200 response
+      }
+    end
+
+    # Add values to here when extending this class to have default Savon options.
+    # See http://savonrb.com/version2/globals.html for details
+    # @return [Hash] Savon options adding to & overriding defaults
+    def savon_options
+      {}
+    end
+
+    # Setup object to handle communicating with a particular SOAP WSDL
+    # @param [String] name Name to describe handler. Used in calling 'to_s'
+    # @param [Hash] options Options defining SOAP request. WSDL, authentication, see http://savonrb.com/version2/globals.html for list of options
+    def initialize(name = self.class.to_s, options = {})
+      if name.is_a?(Hash) && options == {} # If name is not set
+        options = name
+        name = self.class.to_s
+      end
+      super
+      set_remove_keys(options, %i[operation default_hash template_name])
+      merged_options = Soaspec::SpecLogger.log_api_traffic? ? default_options.merge(logging_options) : default_options
+      merged_options.merge! savon_options
+      merged_options.merge!(options)
+      self.client = Savon.client(merged_options)
+    end
+
+    # @param [Hash] override_parameters Parameters for building the request
+    # @return [Hash] Parameters used in making a request
+    def request_parameters(override_parameters)
+      SoapRequest.new(operation, request_body_params(override_parameters), @request_option)
+    end
+
+    # Used in making request via hash or in template via Erb
+    # @param [Hash] request_parameters Hash representing elements to send in request
+    #                                  If the :body key is set, this will be used as the request body
+    def request_body_params(request_parameters)
+      test_values = request_parameters[:body] || request_parameters
+      test_values.transform_keys_to_symbols if Soaspec.always_use_keys?
+      if @request_option == :template
+        test_values = IndifferentHash.new(test_values) # Allow test_values to be either Symbol or String
+        { xml: Soaspec::TemplateReader.new.render_body(template_name, binding) }
+      elsif @request_option == :hash
+        { message: @default_hash.merge(test_values), attributes: request_root_attributes }
+      end
+    end
+
+    # Used in together with Exchange request that passes such override parameters
+    # @param [Hash] request_parameters Parameters used to overwrite defaults in request
+    def make_request(request_parameters)
+      # Call the SOAP operation with the request XML provided
+      request = request_parameters(request_parameters)
+      begin
+        client.call request.operation, request.body # request_body_params(request_parameters)
+      rescue Savon::HTTPError => e
+        soap_error
+      end
+    end
+
+    # @param [Hash] format Format of expected result
+    # @return [Object] Generic body to be displayed in error messages
+    def response_body(response, format: :hash)
+      case format
+      when :hash
+        response.body
+      when :raw
+        response.xml
+      else
+        response.body
+      end
+    end
+
+    # @return [Boolean] Whether the request found the desired value or not
+    def found?(response)
+      status_code_for(response) != 404
+    end
+
+    # Response status code for response. '200' indicates a success
+    # @param [Savon::Response] response
+    # @return [Integer] Status code
+    def status_code_for(response)
+      response.http.code
+    end
+
+    # @return [Boolean] Whether response includes provided string within it
+    def include_in_body?(response, expected)
+      response.to_xml.to_s.include? expected
+    end
+
+    # @param [Symbol] expected
+    # @return [Boolean] Whether response body contains expected key
+    def include_key?(response, expected)
+      body = response.body
+      body.extend Hashie::Extensions::DeepFind
+      !body.deep_find_all(expected).empty?
+    end
+
+    # Convert all XML nodes to lowercase
+    # @param [Nokogiri::XML::Document] xml_doc Xml document to convert
+    def convert_to_lower_case(xml_doc)
+      xml_doc.traverse do |node|
+        node.name = node.name.downcase if node.is_a?(Nokogiri::XML::Element)
+      end
+    end
+
+    # Returns the value at the provided xpath
+    # @param [Savon::Response] response
+    # @param [String] xpath
+    # @return [Enumerable] Elements found through Xpath
+    def xpath_elements_for(response: nil, xpath: nil, attribute: nil)
+      raise ArgumentError('response and xpath must be passed to method') unless response && xpath
+
+      xpath = "//*[@#{attribute}]" unless attribute.nil?
+      xpath = '//' + xpath if xpath[0] != '/'
+      temp_doc = response.doc.dup
+      convert_to_lower_case(temp_doc) if convert_to_lower?
+      if strip_namespaces? && !xpath.include?(':')
+        temp_doc.remove_namespaces!
+        temp_doc.xpath(xpath)
+      else
+        temp_doc.xpath(xpath, temp_doc.collect_namespaces)
+      end
+    end
+
+    # Based on a exchange, return the value at the provided xpath
+    # If the path does not begin with a '/', a '//' is added to it
+    # @param [Savon::Response] response
+    # @param [String] path Xpath
+    # @param [String] attribute Generic attribute to find. Will override path
+    # @return [String] Value at Xpath
+    def value_from_path(response, path, attribute: nil)
+      results = xpath_elements_for(response: response, xpath: path, attribute: attribute)
+      raise NoElementAtPath, "No value at Xpath '#{path}' in XML #{response.doc}" if results.empty?
+      return results.first.inner_text if attribute.nil?
+
+      results.first.attributes[attribute].inner_text
+    end
+
+    # @return [Enumerable] List of values returned from path
+    def values_from_path(response, path, attribute: nil)
+      xpath_elements_for(response: response, xpath: path, attribute: attribute).map(&:inner_text)
+    end
+
+    # alias elements xpath_elements_for
+
+    # @return [Boolean] Whether any of the keys of the Body Hash include value
+    def include_value?(response, expected_value)
+      response.body.include_value?(expected_value)
+    end
+
+    # Hash of response body
+    def to_hash(response)
+      response.body
+    end
+
+    # Convenience methods for once off usage of a SOAP request
+    class << self
+      # Implement undefined setter with []= for FactoryBot to use without needing to define params to set
+      # @param [Object] method_name Name of method not defined
+      # @param [Object] args Arguments passed to method
+      # @param [Object] block
+      def method_missing(method_name, *args, &block)
+        tmp_class = new(method_name)
+        operations = tmp_class.operations
+        if operations.include? method_name
+          tmp_class.operation = method_name
+          exchange = Exchange.new(method_name, *args)
+          exchange.exchange_handler = tmp_class
+          yield exchange if block_given?
+          exchange
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, *args)
+        tmp_class = new(args)
+        operations = tmp_class.operations
+        operations.include?(method_name) || super
+      end
+    end
+  end
+end