soaspec 0.2.33 → 0.3.1

data/lib/soaspec/exchange_handlers/exchange_handler_defaults.rb

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-# Default values set for methods on ExchangeHandler
-module ExchangeHandlerDefaults
-  # Will be used in 'success_scenarios' shared examples.
-  # Set though 'mandatory_elements' method
-  # @return [Array] Array of symbols specifying element names
-  def expected_mandatory_elements
-    []
-  end
-
-  # Change this through 'mandatory_xpath_values' method to specify xpath results that must be present in the response
-  # Will be used in 'success_scenarios' shared examples
-  # @return [Hash] Hash of 'xpath' => 'expected value' pairs
-  def expected_mandatory_xpath_values
-    {}
-  end
-
-  # Change this through 'mandatory_json_values' method to specify json results that must be present in the response
-  # Will be used in 'success_scenarios' shared examples
-  # @return [Hash] Hash of 'json/path' => 'expected value' pairs
-  def expected_mandatory_json_values
-    {}
-  end
-
-  # @return [Boolean] Whether all xpaths will be done with XML that is converted to lower case
-  def convert_to_lower?
-    false
-  end
-
-  # @return [Boolean] Whether to remove namespaces in xpath assertion automatically
-  def strip_namespaces?
-    false
-  end
-
-  # Request of API call. Either intended request or actual request
-  # @param [Object] response Response from calling exchange
-  def request(response)
-    return "Request not yet sent Request option is #{@request_option}" unless response
-
-    'Specific API handler should implement this'
-  end
-
-  # Set through 'retry_on_exceptions' method
-  # @return [Array] List of exceptions to retry for
-  def retry_on_exceptions
-    []
-  end
-
-  # Set this through 'retry_on_exceptions' on ExchangeHandler
-  # @return [Integer] Time to wait before retrying each request. Default of 1
-  def retry_pause_time
-    1
-  end
-
-  # Set this through 'retry_on_exceptions' on ExchangeHandler
-  # @return [Integer] Times to retry before raising exception. Default of 3
-  def retry_exception_limit
-    3
-  end
-end
+# frozen_string_literal: true
+
+# Default values set for methods on ExchangeHandler
+module ExchangeHandlerDefaults
+  # Will be used in 'success_scenarios' shared examples.
+  # Set though 'mandatory_elements' method
+  # @return [Array] Array of symbols specifying element names
+  def expected_mandatory_elements
+    []
+  end
+
+  # Change this through 'mandatory_xpath_values' method to specify xpath results that must be present in the response
+  # Will be used in 'success_scenarios' shared examples
+  # @return [Hash] Hash of 'xpath' => 'expected value' pairs
+  def expected_mandatory_xpath_values
+    {}
+  end
+
+  # Change this through 'mandatory_json_values' method to specify json results that must be present in the response
+  # Will be used in 'success_scenarios' shared examples
+  # @return [Hash] Hash of 'json/path' => 'expected value' pairs
+  def expected_mandatory_json_values
+    {}
+  end
+
+  # @return [Boolean] Whether all xpaths will be done with XML that is converted to lower case
+  def convert_to_lower?
+    false
+  end
+
+  # @return [Boolean] Whether to remove namespaces in xpath assertion automatically
+  def strip_namespaces?
+    false
+  end
+
+  # Request of API call. Either intended request or actual request
+  # @param [Object] response Response from calling exchange
+  def request(response)
+    return "Request not yet sent Request option is #{@request_option}" unless response
+
+    'Specific API handler should implement this'
+  end
+
+  # Set through 'retry_on_exceptions' method
+  # @return [Array] List of exceptions to retry for
+  def retry_on_exceptions
+    []
+  end
+
+  # Set this through 'retry_on_exceptions' on ExchangeHandler
+  # @return [Integer] Time to wait before retrying each request. Default of 1
+  def retry_pause_time
+    1
+  end
+
+  # Set this through 'retry_on_exceptions' on ExchangeHandler
+  # @return [Integer] Times to retry before raising exception. Default of 3
+  def retry_exception_limit
+    3
+  end
+end

data/lib/soaspec/exchange_handlers/handler_accessors.rb

@@ -1,132 +1,132 @@
-# frozen_string_literal: true
-
-module Soaspec
-  # Describes methods test handlers use to easily set attributes
-  # Some are included in 'success scenarios' and to configure the request sent
-  module HandlerAccessors
-    # Defines expected_mandatory_elements method used in 'success_scenario' shared examples
-    # to indicate certain elements must be present
-    # @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
-    #
-    # @example Inside class
-    #   mandatory_elements :GetWeatherResult
-    #
-    # Or for a list
-    #
-    # @example Inside class
-    #   mandatory_elements [:GetWeatherResult, :GetResultStatus]
-    #
-    # In test
-    # describe Exchange(:name) do
-    #   it_behaves_like 'success scenario' # Includes checks for mandatory elements
-    # end
-    def mandatory_elements(elements)
-      define_method('expected_mandatory_elements') do
-        return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
-
-        elements
-      end
-    end
-
-    # Defines mandatory xpaths value pairs to be included in 'success scenario' shared example
-    #
-    # @example Inside class
-    #   mandatory_xpath_values '//xmlns:GetWeatherResult' => 'Data Not Found'
-    #
-    # @example In test
-    #   describe Exchange(:name) do
-    #     it_behaves_like 'success scenario' # Includes xpath pair validation
-    #   end
-    #
-    # @param [Hash] xpath_value_pairs Hash of element => expected value that must appear
-    #                                 in a successful response body
-    def mandatory_xpath_values(xpath_value_pairs)
-      raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
-
-      define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
-    end
-
-    # Defines mandatory json path value pairs to be included in 'success scenario' shared example
-    #
-    # @example Inside class
-    #   mandatory_json_values '$..GetWeatherResult' => 'Found'
-    #
-    # @example In test
-    #   describe Exchange(:name) do
-    #     it_behaves_like 'success scenario' # Includes json pair validation
-    #   end
-    #
-    # @param [Hash] json_value_pairs Hash of element => expected value that must appear
-    #                                in a successful response body
-    def mandatory_json_values(json_value_pairs)
-      raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
-
-      define_method('expected_mandatory_json_values') { json_value_pairs }
-    end
-
-    # Links a particular path to a meaningful method that can be accessed from Exchange class.
-    # This will use the 'value_from_path' method which
-    # should be implemented by each ExchangeHandler
-    # @param [String, Symbol] name Method name used to access element
-    # @param [String, Symbol] path Path to find object (e.g, XPath, JSONPath).
-    #                              For JSONPath a ',' can be put to get an element either path
-    def element(name, path)
-      define_method("__custom_path_#{name}") do |response|
-        value_from_path(response, path.to_s)
-      end
-    end
-
-    # Links an attribute to a meaningful method that can be accessed from Exchange class.
-    # This will use the 'value_from_path' method which
-    # should be implemented by each ExchangeHandler
-    # @param [String, Symbol] name Method name used to access attribute
-    # @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
-    def attribute(name, attribute = nil)
-      attribute_used = attribute || name.to_s
-      define_method("__custom_path_#{name}") do |response|
-        value_from_path(response, 'implicit', attribute: attribute_used)
-      end
-    end
-
-    # All xpath will be done with XML that is converted to lower case
-    # You must then use lower case in the xpath's to obtain the desired values
-    # @param [Boolean] set Whether to convert all xml in response to lower case before performing XPath
-    def convert_to_lower(set)
-      return unless set
-
-      define_method('convert_to_lower?') { true }
-    end
-
-    # Whether to remove namespaces from response in Xpath assertion automatically
-    # For why this may not be a good thing in general see
-    # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
-    # This will be overridden if xpath has a ':' in it
-    # @param [Boolean] set Whether to strip namespaces form XML response
-    def strip_namespaces(set)
-      return unless set
-
-      # Whether to remove namespaces in xpath assertion automatically
-      define_method('strip_namespaces?') { true }
-    end
-
-    # Set the default hash representing data to be used in making a request
-    # This will set the @request_option instance variable too
-    # @param [Hash] hash Default hash of request
-    def default_hash(hash)
-      define_method('default_hash_value') do
-        @request_option = :hash
-        Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
-      end
-    end
-
-    # Set the request option type and the template name
-    # Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
-    # @param [String] name Name of file inside 'template' folder excluding extension
-    def template_name(name)
-      define_method('template_name_value') do
-        @request_option = :template
-        name
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Soaspec
+  # Describes methods test handlers use to easily set attributes
+  # Some are included in 'success scenarios' and to configure the request sent
+  module HandlerAccessors
+    # Defines expected_mandatory_elements method used in 'success_scenario' shared examples
+    # to indicate certain elements must be present
+    # @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
+    #
+    # @example Inside class
+    #   mandatory_elements :GetWeatherResult
+    #
+    # Or for a list
+    #
+    # @example Inside class
+    #   mandatory_elements [:GetWeatherResult, :GetResultStatus]
+    #
+    # In test
+    # describe Exchange(:name) do
+    #   it_behaves_like 'success scenario' # Includes checks for mandatory elements
+    # end
+    def mandatory_elements(elements)
+      define_method('expected_mandatory_elements') do
+        return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
+
+        elements
+      end
+    end
+
+    # Defines mandatory xpaths value pairs to be included in 'success scenario' shared example
+    #
+    # @example Inside class
+    #   mandatory_xpath_values '//xmlns:GetWeatherResult' => 'Data Not Found'
+    #
+    # @example In test
+    #   describe Exchange(:name) do
+    #     it_behaves_like 'success scenario' # Includes xpath pair validation
+    #   end
+    #
+    # @param [Hash] xpath_value_pairs Hash of element => expected value that must appear
+    #                                 in a successful response body
+    def mandatory_xpath_values(xpath_value_pairs)
+      raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
+
+      define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
+    end
+
+    # Defines mandatory json path value pairs to be included in 'success scenario' shared example
+    #
+    # @example Inside class
+    #   mandatory_json_values '$..GetWeatherResult' => 'Found'
+    #
+    # @example In test
+    #   describe Exchange(:name) do
+    #     it_behaves_like 'success scenario' # Includes json pair validation
+    #   end
+    #
+    # @param [Hash] json_value_pairs Hash of element => expected value that must appear
+    #                                in a successful response body
+    def mandatory_json_values(json_value_pairs)
+      raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
+
+      define_method('expected_mandatory_json_values') { json_value_pairs }
+    end
+
+    # Links a particular path to a meaningful method that can be accessed from Exchange class.
+    # This will use the 'value_from_path' method which
+    # should be implemented by each ExchangeHandler
+    # @param [String, Symbol] name Method name used to access element
+    # @param [String, Symbol] path Path to find object (e.g, XPath, JSONPath).
+    #                              For JSONPath a ',' can be put to get an element either path
+    def element(name, path)
+      define_method("__custom_path_#{name}") do |response|
+        value_from_path(response, path.to_s)
+      end
+    end
+
+    # Links an attribute to a meaningful method that can be accessed from Exchange class.
+    # This will use the 'value_from_path' method which
+    # should be implemented by each ExchangeHandler
+    # @param [String, Symbol] name Method name used to access attribute
+    # @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
+    def attribute(name, attribute = nil)
+      attribute_used = attribute || name.to_s
+      define_method("__custom_path_#{name}") do |response|
+        value_from_path(response, 'implicit', attribute: attribute_used)
+      end
+    end
+
+    # All xpath will be done with XML that is converted to lower case
+    # You must then use lower case in the xpath's to obtain the desired values
+    # @param [Boolean] set Whether to convert all xml in response to lower case before performing XPath
+    def convert_to_lower(set)
+      return unless set
+
+      define_method('convert_to_lower?') { true }
+    end
+
+    # Whether to remove namespaces from response in Xpath assertion automatically
+    # For why this may not be a good thing in general see
+    # http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
+    # This will be overridden if xpath has a ':' in it
+    # @param [Boolean] set Whether to strip namespaces form XML response
+    def strip_namespaces(set)
+      return unless set
+
+      # Whether to remove namespaces in xpath assertion automatically
+      define_method('strip_namespaces?') { true }
+    end
+
+    # Set the default hash representing data to be used in making a request
+    # This will set the @request_option instance variable too
+    # @param [Hash] hash Default hash of request
+    def default_hash(hash)
+      define_method('default_hash_value') do
+        @request_option = :hash
+        Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
+      end
+    end
+
+    # Set the request option type and the template name
+    # Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
+    # @param [String] name Name of file inside 'template' folder excluding extension
+    def template_name(name)
+      define_method('template_name_value') do
+        @request_option = :template
+        name
+      end
+    end
+  end
+end

data/lib/soaspec/exchange_handlers/request/rest_request.rb

@@ -1,59 +1,77 @@
-# frozen_string_literal: true
-
-module Soaspec
-  # Models a request made to a REST API
-  class RestRequest
-    # @example GET method
-    #   :get
-    # @return [Symbol] REST method used
-    attr_accessor :method
-    # @example JSON body
-    #   {"test":5}
-    # @return [String] Body of request sent
-    attr_accessor :body
-    # @return [String] Name given to test to describe it
-    attr_accessor :test_name
-    # @return [String] User used in basic auth
-    attr_accessor :basic_auth_user
-    # @return [String] Password used in basic auth
-    attr_accessor :basic_auth_password
-    # @return [String] Url appended to base_url
-    attr_accessor :suburl
-    # @return [Hash] Miscellaneous parameters
-    attr_accessor :other_params
-    # Headers. Keys that are `symbols` will be converted from `snake_case` to `Word-Word2`
-    # @return [Hash] Headers sent as part of request
-    attr_accessor :headers
-
-    # @param [Hash] overall Overall parameters used in Request
-    # @param [Hash] options Headers and basic auth options
-    # @param [String] body Body of Request to be sent
-    def initialize(overall, options, body)
-      overall_params = overall.dup # Must duplicate hash as deletion occurring
-      self.body = body
-      self.method = overall_params.delete(:method)
-      self.suburl = overall_params.delete(:suburl)
-      self.test_name = overall_params.delete(:name)
-      self.other_params = overall_params
-      self.basic_auth_user = options[:user]
-      self.basic_auth_password = options[:password]
-      self.headers = options[:headers]
-    end
-
-    # @param [String, Symbol] value Message to send to object retrieving a value
-    # @return [Object] Result of retrieving value
-    def [](value)
-      send(value)
-    end
-
-    # @return [String] Show inspection of all parameters
-    def to_s
-      inspect
-    end
-
-    # @return [Array] Array containing parameters used in making a request
-    def flatten
-      [method] + [suburl].flatten + other_params[:q].flatten
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Soaspec
+  # Models a request made to a REST API
+  class RestRequest
+    # @example GET method
+    #   :get
+    # @return [Symbol] REST method used
+    attr_accessor :method
+    # @example JSON body
+    #   {"test":5}
+    # @return [String] Body of request sent
+    attr_accessor :body
+    # @return [String] Name given to test to describe it
+    attr_accessor :test_name
+    # @return [String] User used in basic auth
+    attr_accessor :basic_auth_user
+    # @return [String] Password used in basic auth
+    attr_accessor :basic_auth_password
+    # @return [String] Url appended to base_url
+    attr_accessor :suburl
+    # @return [Hash] Miscellaneous parameters
+    attr_accessor :other_params
+    # Headers. Keys that are `symbols` will be converted from `snake_case` to `Word-Word2`
+    # @return [Hash] Headers sent as part of request
+    attr_accessor :headers
+
+    # @param [Hash] overall Overall parameters used in Request
+    # @param [Hash] options Headers and basic auth options
+    # @param [String] body Body of Request to be sent
+    def initialize(overall, options, body)
+      overall_params = overall.dup # Must duplicate hash as deletion occurring
+      self.body = body
+      self.method = overall_params.delete(:method)
+      self.suburl = overall_params.delete(:suburl)
+      self.test_name = overall_params.delete(:name)
+      self.other_params = overall_params
+      self.basic_auth_user = options[:user]
+      self.basic_auth_password = options[:password]
+      self.headers = options[:headers]
+    end
+
+    # @return [Hash] Query parameters for a REST Request
+    def query
+      other_params[:q]
+    end
+
+    # @param [String, Symbol] value Message to send to object retrieving a value
+    # @return [Object] Result of retrieving value
+    def [](value)
+      send(value)
+    end
+
+    # @return [String] Show inspection of all parameters
+    def to_s
+      inspect
+    end
+
+    # @return [Array] Array containing parameters used in making a request
+    def flatten
+      [method] + [suburl].flatten + query.flatten
+    end
+
+    # @return [String] Description that could be used in filename
+    def description
+      suburl_desc = suburl.is_a?(Array) ? File.join(suburl) : suburl
+      query_desc = ''
+      if query
+        query.each do |key, value|
+          query_desc = File.join(query_desc, "#{key}_#{value}")
+        end
+      end
+      components = [method.to_s, suburl_desc, query_desc, 'response']
+      File.join(*components.collect!(&:to_s))
+    end
+  end
+end