soaspec 0.2.33 → 0.3.1

data/lib/soaspec.rb

@@ -1,106 +1,118 @@
-# frozen_string_literal: true
-
-require 'rest-client' # REST
-require 'erb' # Embedded ruby
-require 'yaml' # Reading yaml
-require 'rspec' # Testing framework
-require 'rspec/its'
-require 'savon' # SOAP
-require 'nokogiri' # XPath
-require 'date'
-require 'jsonpath'
-
-require 'soaspec/version'
-require 'soaspec/indifferent_hash'
-require 'soaspec/o_auth2'
-require 'soaspec/template_reader'
-require 'soaspec/exchange_handlers/soap_handler'
-require 'soaspec/exchange_handlers/exchange_handler'
-require 'soaspec/exchange_handlers/rest_methods'
-require 'soaspec/exchange/exchange'
-require 'soaspec/matchers'
-require 'soaspec/soaspec_shared_examples'
-require 'soaspec/core_ext/hash'
-require 'soaspec/spec_logger'
-require 'soaspec/exe_helpers'
-require 'soaspec/exchange_handlers/rest_handler'
-require 'soaspec/exchange_handlers/handler_accessors'
-require 'soaspec/interpreter'
-require 'soaspec/errors'
-require 'soaspec/wait'
-require 'soaspec/baseline'
-
-# Gem for handling SOAP and REST api tests
-module Soaspec
-  @template_folder = 'templates'
-  @auto_oauth = true
-  @log_warnings = true
-  # @return [String] Folder in which credentials are stored
-  @credentials_folder = 'credentials'
-
-  class << self
-    # Folder used to store templates for API calls
-    # @return [String]
-    attr_reader :template_folder
-    # Stores last exchange
-    # @return [Exchange]
-    attr_accessor :last_exchange
-    # Automatically add Authorization header to RestHandler where oauth2 credentials are specified
-    # @return [Boolean] Whether to add authorization header
-    attr_accessor :auto_oauth
-
-    # Folder used to store templates for API calls
-    # Converts folder / folders into an array depending upon string passed
-    def template_folder=(folder)
-      @template_folder = folder.include?('\\') ? folder.split('\\') : folder.split('/')
-    end
-
-    # Credentials folder used to store secret data (not in source control) E.g passwords
-    # Used in oauth2_file command
-    # @return [String] Folder in which credentials are stored
-    attr_accessor :credentials_folder
-
-    # Used so that exchange class knows what context it's in.
-    # @return [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
-    attr_accessor :api_handler
-
-    # Set whether to transform strings to keys in request automatically.
-    # @return [Boolean]
-    attr_writer :always_use_keys
-
-    # @return [Boolean] Whether to log warnings such as methods that may change usage in the future
-    attr_accessor :log_warnings
-
-    # @return [Boolean] Whether to transform strings to keys in request automatically
-    def always_use_keys?
-      @always_use_keys || true
-    end
-
-    # @return [Boolean] Whether to see params sent to & received from oauth URL
-    def debug_oauth?
-      puts 'Soaspec.debug_oauth? now deprecated. Please use Soaspec::OAuth2.debug_oauth? instead'
-      Soaspec::OAuth2.debug_oauth?
-    end
-
-    # Specify whether to see params sent to and retrieved from oauth.
-    # This will put password in log file, only recommended for debugging
-    # @param [String] set Whether to debug oauth
-    def debug_oauth=(set)
-      puts 'Soaspec.debug_oauth= now deprecated. Please use Soaspec::OAuth2.debug_oauth= instead'
-      Soaspec::OAuth2.debug_oauth = set
-    end
-
-    # Whether to log all API traffic
-    # @param [Boolean] set
-    def log_api_traffic=(set)
-      puts 'Soaspec.log_api_traffic= now deprecated. Please use Soaspec::SpecLogger.log_api_traffic= instead'
-      Soaspec::SpecLogger.log_api_traffic = set
-    end
-
-    # @return [Boolean] Whether to log all API traffic
-    def log_api_traffic?
-      puts 'Soaspec.log_api_traffic? now deprecated. Please use Soaspec::SpecLogger.log_api_traffic? instead'
-      Soaspec::SpecLogger.log_api_traffic?
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rest-client' # REST
+require 'erb' # Embedded ruby
+require 'yaml' # Reading yaml
+require 'rspec' # Testing framework
+require 'rspec/its'
+require 'savon' # SOAP
+require 'nokogiri' # XPath
+require 'date'
+require 'jsonpath'
+
+require 'soaspec/version'
+require 'soaspec/indifferent_hash'
+require 'soaspec/o_auth2'
+require 'soaspec/template_reader'
+require 'soaspec/exchange_handlers/soap_handler'
+require 'soaspec/exchange_handlers/exchange_handler'
+require 'soaspec/exchange_handlers/rest_methods'
+require 'soaspec/exchange/exchange'
+require 'soaspec/matchers'
+require 'soaspec/soaspec_shared_examples'
+require 'soaspec/core_ext/hash'
+require 'soaspec/spec_logger'
+require 'soaspec/exe_helpers'
+require 'soaspec/exchange_handlers/rest_handler'
+require 'soaspec/exchange_handlers/handler_accessors'
+require 'soaspec/interpreter'
+require 'soaspec/errors'
+require 'soaspec/wait'
+require 'soaspec/baseline'
+
+# Gem for handling SOAP and REST api tests
+module Soaspec
+  @template_folder = 'templates'
+  @auto_oauth = true
+  @log_warnings = true
+  # @return [String] Folder in which credentials are stored
+  @credentials_folder = 'credentials'
+  # @return [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler.
+  #   Exchange class uses this to determine how to work
+  @api_handler = nil
+
+  class << self
+    # Folder used to store templates for API calls
+    # @return [String]
+    attr_reader :template_folder
+    # Stores last exchange
+    # @return [Exchange]
+    attr_accessor :last_exchange
+    # Automatically add Authorization header to RestHandler where oauth2 credentials are specified
+    # @return [Boolean] Whether to add authorization header
+    attr_accessor :auto_oauth
+
+    # Folder used to store templates for API calls
+    # Converts folder / folders into an array depending upon string passed
+    def template_folder=(folder)
+      @template_folder = folder.include?('\\') ? folder.split('\\') : folder.split('/')
+    end
+
+    # Credentials folder used to store secret data (not in source control) E.g passwords
+    # Used in oauth2_file command
+    # @return [String] Folder in which credentials are stored
+    attr_accessor :credentials_folder
+
+    # Used so that exchange class knows what context it's in.
+    # @return [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
+    attr_writer :api_handler
+
+    # @return [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
+    def api_handler
+      unless @api_handler
+        raise Soaspec::Error, '@exchange_handler not set. ' \
+        'Set either with `Soaspec.api_handler = Handler.new` or within the exchange'
+      end
+      @api_handler
+    end
+
+    # Set whether to transform strings to keys in request automatically.
+    # @return [Boolean]
+    attr_writer :always_use_keys
+
+    # @return [Boolean] Whether to log warnings such as methods that may change usage in the future
+    attr_accessor :log_warnings
+
+    # @return [Boolean] Whether to transform strings to keys in request automatically
+    def always_use_keys?
+      @always_use_keys || true
+    end
+
+    # @return [Boolean] Whether to see params sent to & received from oauth URL
+    def debug_oauth?
+      puts 'Soaspec.debug_oauth? now deprecated. Please use Soaspec::OAuth2.debug_oauth? instead'
+      Soaspec::OAuth2.debug_oauth?
+    end
+
+    # Specify whether to see params sent to and retrieved from oauth.
+    # This will put password in log file, only recommended for debugging
+    # @param [String] set Whether to debug oauth
+    def debug_oauth=(set)
+      puts 'Soaspec.debug_oauth= now deprecated. Please use Soaspec::OAuth2.debug_oauth= instead'
+      Soaspec::OAuth2.debug_oauth = set
+    end
+
+    # Whether to log all API traffic
+    # @param [Boolean] set
+    def log_api_traffic=(set)
+      puts 'Soaspec.log_api_traffic= now deprecated. Please use Soaspec::SpecLogger.log_api_traffic= instead'
+      Soaspec::SpecLogger.log_api_traffic = set
+    end
+
+    # @return [Boolean] Whether to log all API traffic
+    def log_api_traffic?
+      puts 'Soaspec.log_api_traffic? now deprecated. Please use Soaspec::SpecLogger.log_api_traffic? instead'
+      Soaspec::SpecLogger.log_api_traffic?
+    end
+  end
+end

data/lib/soaspec/baseline.rb

@@ -1,23 +1,83 @@
-require_relative 'exe_helpers'
-
-module Soaspec
-  # Used for defining parameters for recording and asserting against
-  # a baseline
-  module Baseline
-    @folder = File.join('config', 'baseline')
-    class << self
-      # @return [String] Folder where baselines are recorded and retrieved
-      attr_accessor :folder
-
-      # @param [Exchange] exchange Exchange object to baseline response for
-      # @return [String] File where baseline is stored
-      def file(exchange)
-        File.join(folder,
-                  exchange.exchange_handler.to_s.snakecase,
-                  "#{exchange.request_parameters.flatten.join('_')}.yml")
-      end
-
-      include Soaspec::ExeHelpers
-    end
-  end
+require_relative 'exe_helpers'
+
+module Soaspec
+  # Used for defining parameters for recording and asserting against
+  # a baseline
+  class Baseline
+    include Soaspec::ExeHelpers
+    @folder = File.join('config', 'baseline')
+
+    # @return [Array] List of allowed formats
+    ALLOWED_FORMATS = [:raw, :hash]
+
+    # @return [Exchange] Exchange object to save/assert baseline for
+    attr_accessor :exchange
+    # @return [Symbol] Format in which baseline is stored. Either :raw or :hash
+    attr_accessor :format
+    # @return [String] Name of file including folders describing baseline
+    attr_writer :description
+
+    # @param [Exchange] exchange Exchange object to baseline response for
+    # @param [Symbol] format Format of baseline
+    def initialize(exchange, format)
+      self.exchange = exchange
+      self.format = format
+      unless ALLOWED_FORMATS.include? format
+        raise ArgumentError, "Expected format #{format} to be " \
+            "either #{ALLOWED_FORMATS}"
+      end
+    end
+
+    # Compare baseline with expected result. This will create baseline
+    # if not created
+    # @return [Boolean] Whether response matches baseline
+    def matches?
+      if File.exist?(file)
+        actual_content == read_baseline
+      else
+        create_file filename: file, content: content_to_save
+        raise Soaspec::BaselineError,
+              "Created baseline at #{file}. Inspect file to ensure it is
+               correct and rerun to ensure baseline is stable"
+      end
+    end
+
+    # Content to save as a baseline
+    def content_to_save
+      format == :raw ? exchange.pretty_response_body : YAML.dump(exchange.to_hash)
+    end
+
+    # @return [String, Hash] Actual response from API
+    def actual_content
+      if format == :hash
+        exchange.to_hash
+      elsif format == :raw
+        exchange.pretty_response_body.strip
+      else
+        raise NotImplementedError, "Format #{format} is not #{ALLOWED_FORMATS}"
+      end
+    end
+
+    # @return [String] Result of reading baseline
+    def read_baseline
+      format == :raw ? File.read(file).strip : YAML.load_file(file)
+    end
+
+    # @return [String] File where baseline is stored
+    def file
+      File.join(self.class.folder,
+                exchange.exchange_handler.to_s.snakecase,
+                "#{description}.#{format == :raw ? exchange.format : 'yml'}")
+    end
+
+    # @return [String] Name of file including folders describing baseline
+    def description
+      @description || exchange.request_parameters.description
+    end
+
+    class << self
+      # @return [String] Folder where baselines are recorded and retrieved
+      attr_accessor :folder
+    end
+  end
 end

data/lib/soaspec/core_ext/hash.rb

@@ -1,44 +1,44 @@
-# frozen_string_literal: true
-
-# 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
-  # @example
-  #   hash = { 'a' => 1, 'b' => { c: 4 } }
-  #   hash.transform_keys_to_symbols # => { a: 1, b: { c: 4 } }
-  # @return [Hash] Hash will all keys converted to 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.
-  # @example
-  #   hash = { a: { b: 25 }, c: 3 }
-  #   hash.include_value?(25) #=> true
-  # @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
+# frozen_string_literal: true
+
+# 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
+  # @example
+  #   hash = { 'a' => 1, 'b' => { c: 4 } }
+  #   hash.transform_keys_to_symbols # => { a: 1, b: { c: 4 } }
+  # @return [Hash] Hash will all keys converted to 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.
+  # @example
+  #   hash = { a: { b: 25 }, c: 3 }
+  #   hash.include_value?(25) #=> true
+  # @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,94 +1,94 @@
-# frozen_string_literal: true
-
-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 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/basic.json'
-#   I use the path 'basic.json'
-Given 'I use the path {string}' 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
+# frozen_string_literal: true
+
+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 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/basic.json'
+#   I use the path 'basic.json'
+Given 'I use the path {string}' 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