soaspec 0.2.23 → 0.2.24

data/lib/soaspec/core_ext/hash.rb

@@ -1,35 +1,35 @@
-# Override Hash class with convenience methods
-class Hash
-  # Transform each key in Hash to a symbol. Privately used by non-self method
-  # @param [Object] value Value inside hash to transform keys under
-  def self.transform_keys_to_symbols(value)
-    return value unless value.is_a?(Hash)
-
-    hash = value.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
-    hash
-  end
-
-  # Take keys of hash and transform those to a symbols
-  def transform_keys_to_symbols
-    each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
-  end
-
-  # Value present in nested Hash.
-  # @return [Boolean] Whether value is included in nested Hash
-  def include_value?(value)
-    each_value do |v|
-      return true if v == value
-      next unless v.is_a? Hash
-
-      v.each_value do |v|
-        return true if v == value
-        next unless v.is_a? Hash
-
-        v.each_value do |v|
-          return true if v == value
-        end
-      end
-    end
-    false
-  end
-end
+# Override Hash class with convenience methods
+class Hash
+  # Transform each key in Hash to a symbol. Privately used by non-self method
+  # @param [Object] value Value inside hash to transform keys under
+  def self.transform_keys_to_symbols(value)
+    return value unless value.is_a?(Hash)
+
+    hash = value.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
+    hash
+  end
+
+  # Take keys of hash and transform those to a symbols
+  def transform_keys_to_symbols
+    each_with_object({}) { |(k, v), memo| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); }
+  end
+
+  # Value present in nested Hash.
+  # @return [Boolean] Whether value is included in nested Hash
+  def include_value?(value)
+    each_value do |v|
+      return true if v == value
+      next unless v.is_a? Hash
+
+      v.each_value do |v|
+        return true if v == value
+        next unless v.is_a? Hash
+
+        v.each_value do |v|
+          return true if v == value
+        end
+      end
+    end
+    false
+  end
+end

data/lib/soaspec/cucumber/generic_steps.rb

@@ -1,85 +1,85 @@
-require 'active_support/core_ext/string/inflections'
-
-# @return [Exchange] Return current or last exchange used in Cucumber
-def current_exchange
-  @current_exchange ||= Soaspec.last_exchange
-end
-
-# Pass in the operation (HTTP method or SOAP operation) in first parameter and api name as second.
-# API name can be mulitple words and it will be converted to camel case to find the ExchangeHandler class
-# @example Create an Exchange representing an HTTP 'post' based on the 'Puppy' RestHandler class
-#   I am performing a post on the Puppy API
-# @example Create an Exchange for a 'get_bank' operation on for a 'Banking' SoapHandler class
-#   I am performing a get_bank on the Banking API
-Given 'I am performing a {word} on the {string} API' do |operation, api_name|
-  @current_exchange = api_name.tr(' ', '_').camelize.constantize.send operation
-end
-
-# Set a parameter in the request body
-# @example Set the name element in the request body to Charlie
-#   And I set the name to 'Charlie'
-# @param [String] Element in request body to set
-# @param [String] Value to set it to
-Given 'I set the {word} to {string}' do |key, value|
-  current_exchange[key] = value
-end
-
-# Add onto the base_url to make a complete url for the test
-# @example base_url is 'http://petstore.swagger.io/v2' and I want a post to 'http://petstore.swagger.io/v2/pet'
-#   I use the path pet
-Given 'I use the path {word}' do |suburl|
-  current_exchange.suburl = suburl
-end
-
-# Add a query parameter for http 'get' requests. e.g. will add '?filter_key=filter_value' onto URL
-# @example To create a query for '?status=sold'
-#   And I filter 'status' by 'sold'
-# @example To add a query for 'area' being 'australia' to make a total of '?status=sold&area=austrialia'
-#   And I filter 'area' by 'australia'
-Given 'I filter {string} by {string}' do |filter_key, filter_value|
-  transformed_key = filter_key.to_sym
-  if current_exchange.override_parameters[:q]
-    current_exchange.override_parameters[:q][transformed_key] = filter_value
-  else
-    current_exchange.override_parameters[:q] = { transformed_key => filter_value }
-  end
-end
-
-# Add HTTP header 'header_name' as 'header_value'
-# @example
-#   And I set header 'accept' to 'application/xml'
-Given 'I set header {string} to {string}' do |header_name, header_value|
-  if current_exchange.override_parameters[:params]
-    current_exchange.override_parameters[:params][header_name] = header_value
-  else
-    current_exchange.override_parameters[:params] = { header_name => header_value }
-  end
-end
-
-# Make the API call. This is automatically done when any method extracting a response is made. It can be done
-# explicitly here as it is a meaningful step
-When 'I make the request' do
-  current_exchange.call
-end
-
-# Extract the value from the response that is at the path 'key' and verify it is eq to expected_value
-# @example Assert response body has at the path 'name', the value 'Charlie'
-#   Then it should have the name 'Charlie'
-Then 'it should have the {word} {string}' do |key, expected_value|
-  expect(current_exchange[key]).to eq expected_value
-end
-
-# Extract the value from the response that is at the path 'key_string' and verify it is eq to expected_value
-# Conversion is made on key_string to make it one snake case word
-# @example Assert response body has at the path 'customer_name', the value 'Charlie'
-#   Then it should have the 'customer name' 'Charlie'
-Then 'it should have the {string} {string}' do |key_string, expected_value|
-  key = key_string.tr(' ', '_')
-  actual_value = current_exchange.respond_to?(key) ? current_exchange.send(key) : current_exchange[key]
-  expect(actual_value.to_s).to eq expected_value
-end
-
-# Verify that the HTTP status code is 200..299 and that any defined mandatory elements / mandatory values are as expected
-Then 'it should be successful' do
-  expect(current_exchange).to be_successful
-end
+require 'active_support/core_ext/string/inflections'
+
+# @return [Exchange] Return current or last exchange used in Cucumber
+def current_exchange
+  @current_exchange ||= Soaspec.last_exchange
+end
+
+# Pass in the operation (HTTP method or SOAP operation) in first parameter and api name as second.
+# API name can be mulitple words and it will be converted to camel case to find the ExchangeHandler class
+# @example Create an Exchange representing an HTTP 'post' based on the 'Puppy' RestHandler class
+#   I am performing a post on the Puppy API
+# @example Create an Exchange for a 'get_bank' operation on for a 'Banking' SoapHandler class
+#   I am performing a get_bank on the Banking API
+Given 'I am performing a {word} on the {string} API' do |operation, api_name|
+  @current_exchange = api_name.tr(' ', '_').camelize.constantize.send operation
+end
+
+# Set a parameter in the request body
+# @example Set the name element in the request body to Charlie
+#   And I set the name to 'Charlie'
+# @param [String] Element in request body to set
+# @param [String] Value to set it to
+Given 'I set the {word} to {string}' do |key, value|
+  current_exchange[key] = value
+end
+
+# Add onto the base_url to make a complete url for the test
+# @example base_url is 'http://petstore.swagger.io/v2' and I want a post to 'http://petstore.swagger.io/v2/pet'
+#   I use the path pet
+Given 'I use the path {word}' do |suburl|
+  current_exchange.suburl = suburl
+end
+
+# Add a query parameter for http 'get' requests. e.g. will add '?filter_key=filter_value' onto URL
+# @example To create a query for '?status=sold'
+#   And I filter 'status' by 'sold'
+# @example To add a query for 'area' being 'australia' to make a total of '?status=sold&area=austrialia'
+#   And I filter 'area' by 'australia'
+Given 'I filter {string} by {string}' do |filter_key, filter_value|
+  transformed_key = filter_key.to_sym
+  if current_exchange.override_parameters[:q]
+    current_exchange.override_parameters[:q][transformed_key] = filter_value
+  else
+    current_exchange.override_parameters[:q] = { transformed_key => filter_value }
+  end
+end
+
+# Add HTTP header 'header_name' as 'header_value'
+# @example
+#   And I set header 'accept' to 'application/xml'
+Given 'I set header {string} to {string}' do |header_name, header_value|
+  if current_exchange.override_parameters[:params]
+    current_exchange.override_parameters[:params][header_name] = header_value
+  else
+    current_exchange.override_parameters[:params] = { header_name => header_value }
+  end
+end
+
+# Make the API call. This is automatically done when any method extracting a response is made. It can be done
+# explicitly here as it is a meaningful step
+When 'I make the request' do
+  current_exchange.call
+end
+
+# Extract the value from the response that is at the path 'key' and verify it is eq to expected_value
+# @example Assert response body has at the path 'name', the value 'Charlie'
+#   Then it should have the name 'Charlie'
+Then 'it should have the {word} {string}' do |key, expected_value|
+  expect(current_exchange[key]).to eq expected_value
+end
+
+# Extract the value from the response that is at the path 'key_string' and verify it is eq to expected_value
+# Conversion is made on key_string to make it one snake case word
+# @example Assert response body has at the path 'customer_name', the value 'Charlie'
+#   Then it should have the 'customer name' 'Charlie'
+Then 'it should have the {string} {string}' do |key_string, expected_value|
+  key = key_string.tr(' ', '_')
+  actual_value = current_exchange.respond_to?(key) ? current_exchange.send(key) : current_exchange[key]
+  expect(actual_value.to_s).to eq expected_value
+end
+
+# Verify that the HTTP status code is 200..299 and that any defined mandatory elements / mandatory values are as expected
+Then 'it should be successful' do
+  expect(current_exchange).to be_successful
+end

data/lib/soaspec/demo.rb

@@ -1,4 +1,4 @@
-# Load this file for demoing Soaspec (e.g in IRB). Has common settings applicable for demoing
-
-require_relative '../soaspec'
-Soaspec::SpecLogger.output_to_terminal = true
+# Load this file for demoing Soaspec (e.g in IRB). Has common settings applicable for demoing
+
+require_relative '../soaspec'
+Soaspec::SpecLogger.output_to_terminal = true

data/lib/soaspec/exchange/exchange.rb

@@ -1,111 +1,111 @@
-require_relative '../../soaspec'
-require_relative 'exchange_properties'
-require_relative 'exchange_extractor'
-require_relative 'request_builder'
-require_relative 'exchange_repeater'
-require_relative 'variable_storer'
-
-# This represents a request / response pair
-# Essentially, params in the exchange that are set are related to the request
-# What is returned is related to the response
-class Exchange
-  extend Soaspec::ExchangeProperties
-  include Soaspec::ExchangeExtractor
-  include Soaspec::RequestBuilder
-  include Soaspec::ExchangeRepeater
-  include Soaspec::VariableStorer
-
-  # Instance of ExchangeHandler for which this exchange is made
-  attr_accessor :exchange_handler
-  # How many times to retry for a success
-  attr_accessor :retry_count
-  # Name used for displaying class
-  attr_accessor :test_name
-  # Expect Factory to fail upon trying to create
-  attr_writer :fail_factory
-  # Parameters to override for default params
-  attr_accessor :override_parameters
-
-  # Set retry for success variable to true so that request will be retried
-  # for retry_count until it's true
-  def retry_for_success
-    @retry_for_success = true
-    self
-  end
-
-  # @return [Bool] Whether to keep making request until success code reached
-  def retry_for_success?
-    @retry_for_success
-  end
-
-  # @return [Boolean] Soaspec::ExchangeHandler used by this exchange
-  def default_handler_used
-    nil
-  end
-
-  # Create new Exchange according to parameters set. A response will be made if called
-  # explicitly with 'response' method or through other methods that use it like 'status_code'
-  # @param [Symbol, String] name Name shown in RSpec run
-  # @param [Hash] override_parameters Parameters to override for default params
-  def initialize(name = self.class.to_s, override_parameters = {})
-    self.test_name ||= name.to_s
-    # As a last resort this uses the global parameter. The handler should be set straight before an exchange is made to use this
-    @exchange_handler ||= default_handler_used || Soaspec.api_handler
-    raise '@exchange_handler not set. Set either with `Soaspec.api_handler = Handler.new` or within the exchange' unless @exchange_handler
-
-    @fail_factory = nil
-    @override_parameters = override_parameters
-    @retry_for_success = false
-    self.retry_count = 3
-    @exchange_handler.elements.each { |element| methods_for_element(element) }
-  end
-
-  # Make request to handler with parameters defined
-  # Will retry until success code reached if retry_for_success? is set
-  # @return [Response] Response from Api handler
-  def make_request
-    Soaspec::SpecLogger.info 'Example ' + test_name
-    request_params = @override_parameters
-    (0..retry_count).each do |count|
-      response = exchange_handler.make_request(request_params)
-      return response unless retry_for_success?
-      return response if (200..299).cover? exchange_handler.status_code_for(response)
-
-      sleep 0.5 # Time before retrying
-      break response if count == retry_count
-    end
-  end
-
-  # Name describing this class when used with `RSpec.describe`
-  # This will make the request and store the response
-  # @return [String] Name given when initializing
-  def to_s
-    test_name
-  end
-
-  # @return [RestClient::Response,Savon::Response] Returns response object from Api.
-  #   Will make the request if not made and then cache it for later on
-  # @example For SOAP it will be a Savon response
-  #   response.body (body of response as Hash)
-  #   response.header (head of response as Hash)
-  # @example For REST it will be a RestClient::Response
-  def response
-    require 'forwardable'
-    Soaspec.last_exchange = self
-    @response ||= make_request
-    @response.define_singleton_method(:exchange) { Soaspec.last_exchange } unless @response.respond_to?(:exchange)
-    @response.extend Forwardable
-    @response.delegate %i[value_from_path values_from_path] => :exchange
-    @response
-  end
-
-  # @return [ResponseObject] Currently returning response object. This will change (in 0.3) to be itself to
-  #   allow easy method chaining
-  def call
-    if Soaspec.log_warnings
-      warn 'This "call" method will be changed to return "Exchange" object in 0.3. ' \
-        'Use "response" method if you want the "response" object'
-    end
-    response
-  end
-end
+require_relative '../../soaspec'
+require_relative 'exchange_properties'
+require_relative 'exchange_extractor'
+require_relative 'request_builder'
+require_relative 'exchange_repeater'
+require_relative 'variable_storer'
+
+# This represents a request / response pair
+# Essentially, params in the exchange that are set are related to the request
+# What is returned is related to the response
+class Exchange
+  extend Soaspec::ExchangeProperties
+  include Soaspec::ExchangeExtractor
+  include Soaspec::RequestBuilder
+  include Soaspec::ExchangeRepeater
+  include Soaspec::VariableStorer
+
+  # Instance of ExchangeHandler for which this exchange is made
+  attr_accessor :exchange_handler
+  # How many times to retry for a success
+  attr_accessor :retry_count
+  # Name used for displaying class
+  attr_accessor :test_name
+  # Expect Factory to fail upon trying to create
+  attr_writer :fail_factory
+  # Parameters to override for default params
+  attr_accessor :override_parameters
+
+  # Set retry for success variable to true so that request will be retried
+  # for retry_count until it's true
+  def retry_for_success
+    @retry_for_success = true
+    self
+  end
+
+  # @return [Bool] Whether to keep making request until success code reached
+  def retry_for_success?
+    @retry_for_success
+  end
+
+  # @return [Boolean] Soaspec::ExchangeHandler used by this exchange
+  def default_handler_used
+    nil
+  end
+
+  # Create new Exchange according to parameters set. A response will be made if called
+  # explicitly with 'response' method or through other methods that use it like 'status_code'
+  # @param [Symbol, String] name Name shown in RSpec run
+  # @param [Hash] override_parameters Parameters to override for default params
+  def initialize(name = self.class.to_s, override_parameters = {})
+    self.test_name ||= name.to_s
+    # As a last resort this uses the global parameter. The handler should be set straight before an exchange is made to use this
+    @exchange_handler ||= default_handler_used || Soaspec.api_handler
+    raise '@exchange_handler not set. Set either with `Soaspec.api_handler = Handler.new` or within the exchange' unless @exchange_handler
+
+    @fail_factory = nil
+    @override_parameters = override_parameters
+    @retry_for_success = false
+    self.retry_count = 3
+    @exchange_handler.elements.each { |element| methods_for_element(element) }
+  end
+
+  # Make request to handler with parameters defined
+  # Will retry until success code reached if retry_for_success? is set
+  # @return [Response] Response from Api handler
+  def make_request
+    Soaspec::SpecLogger.info 'Example ' + test_name
+    request_params = @override_parameters
+    (0..retry_count).each do |count|
+      response = exchange_handler.make_request(request_params)
+      return response unless retry_for_success?
+      return response if (200..299).cover? exchange_handler.status_code_for(response)
+
+      sleep 0.5 # Time before retrying
+      break response if count == retry_count
+    end
+  end
+
+  # Name describing this class when used with `RSpec.describe`
+  # This will make the request and store the response
+  # @return [String] Name given when initializing
+  def to_s
+    test_name
+  end
+
+  # @return [RestClient::Response,Savon::Response] Returns response object from Api.
+  #   Will make the request if not made and then cache it for later on
+  # @example For SOAP it will be a Savon response
+  #   response.body (body of response as Hash)
+  #   response.header (head of response as Hash)
+  # @example For REST it will be a RestClient::Response
+  def response
+    require 'forwardable'
+    Soaspec.last_exchange = self
+    @response ||= make_request
+    @response.define_singleton_method(:exchange) { Soaspec.last_exchange } unless @response.respond_to?(:exchange)
+    @response.extend Forwardable
+    @response.delegate %i[value_from_path values_from_path] => :exchange
+    @response
+  end
+
+  # @return [ResponseObject] Currently returning response object. This will change (in 0.3) to be itself to
+  #   allow easy method chaining
+  def call
+    if Soaspec.log_warnings
+      warn 'This "call" method will be changed to return "Exchange" object in 0.3. ' \
+        'Use "response" method if you want the "response" object'
+    end
+    response
+  end
+end