soaspec 0.0.19 → 0.0.20

data/lib/soaspec/exchange.rb

@@ -1,57 +1,57 @@
-require_relative '../soaspec'
-
-# This represents a request / response pair
-class Exchange
-
-  def initialize(name, override_parameters = {})
-    @test_name = name.to_s
-    @api_class = Soaspec::Environment.api_handler
-    @override_parameters = override_parameters
-  end
-
-  # Make request to handler with parameters defined
-  def make_request
-    @api_class.make_request(@override_parameters)
-  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
-    Soaspec::SpecLogger.add_to 'Example ' + @test_name
-    @response = make_request
-    @test_name
-  end
-
-  # Elements a shared 'success scenario' is expected to have
-  def mandatory_elements
-    @api_class.mandatory_elements
-  end
-
-  # Elements a shared 'success scenario' is expected to have
-  def mandatory_xpath_values
-    @api_class.mandatory_xpath_values
-  end
-
-  # Returns response object from Api
-  # For example for SOAP it will be a Savon response
-  # response.body (body of response as Hash)
-  # response.header (head of response as Hash)
-  def response
-    @response
-  end
-
-  # Get status code from api class. This is http response for Web Api
-  # @return [Integer] Status code from api class
-  def status_code
-    @api_class.status_code_for(@response)
-  end
-
-  # Extract value from path api class
-  # @param [String] path Path to return element for api class E.g - for SOAP this is XPath
-  # @return [String] Value at path
-  def [](path)
-    @api_class.value_from_path(self, path)
-  end
-
+require_relative '../soaspec'
+
+# This represents a request / response pair
+class Exchange
+
+  def initialize(name, override_parameters = {})
+    @test_name = name.to_s
+    @api_class = Soaspec::Environment.api_handler
+    @override_parameters = override_parameters
+  end
+
+  # Make request to handler with parameters defined
+  def make_request
+    @api_class.make_request(@override_parameters)
+  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
+    Soaspec::SpecLogger.add_to 'Example ' + @test_name
+    @response = make_request
+    @test_name
+  end
+
+  # Elements a shared 'success scenario' is expected to have
+  def mandatory_elements
+    @api_class.mandatory_elements
+  end
+
+  # Elements a shared 'success scenario' is expected to have
+  def mandatory_xpath_values
+    @api_class.mandatory_xpath_values
+  end
+
+  # Returns response object from Api
+  # For example for SOAP it will be a Savon response
+  # response.body (body of response as Hash)
+  # response.header (head of response as Hash)
+  def response
+    @response
+  end
+
+  # Get status code from api class. This is http response for Web Api
+  # @return [Integer] Status code from api class
+  def status_code
+    @api_class.status_code_for(@response)
+  end
+
+  # Extract value from path api class
+  # @param [String] path Path to return element for api class E.g - for SOAP this is XPath
+  # @return [String] Value at path
+  def [](path)
+    @api_class.value_from_path(self, path)
+  end
+
 end

data/lib/soaspec/hash_methods.rb

@@ -1,72 +1,72 @@
-
-# Override Hash class with convience methods
-class Hash
-
-  def self.transform_keys_to_symbols(value)
-    return value if not value.is_a?(Hash)
-    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
-    return hash
-  end
-
-  # Take keys of hash and transform those to a symbols
-  def transform_keys_to_symbols
-    inject({}){|memo, (k, v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
-  end
-
-  def find_all_values_for(key)
-    result = []
-    result << self[key]
-    self.values.each do |hash_value|
-      next if hash_value.is_a? Array
-      values = [hash_value]
-      values.each do |value|
-        result += value.find_all_values_for(key) if value.is_a? Hash
-      end
-    end
-    result.compact
-  end
-
-  # Value present 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
-
-  # Whether key is present at least once
-  def include_key?(key)
-    result = find_all_values_for key
-    result != []
-  end
-
-  # Loop through each item within a key within a Hash if the key exists
-  # @param [Key] Key within hash to iterate through
-  def each_if_not_null(key)
-    case key.class.to_s
-    when 'String'
-      if self[key]
-        self[key].each do |list_item|
-          yield(list_item)
-        end
-      end
-    when 'Array', 'Hash'
-      if self[key[0]]
-        if self[key[0]][key[1]]
-          self[key[0]][key[1]].each do |list_item|
-            yield(list_item)
-          end
-        end
-      end
-    end
-  end
-
+
+# Override Hash class with convience methods
+class Hash
+
+  def self.transform_keys_to_symbols(value)
+    return value if not value.is_a?(Hash)
+    hash = value.inject({}){|memo,(k,v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
+    return hash
+  end
+
+  # Take keys of hash and transform those to a symbols
+  def transform_keys_to_symbols
+    inject({}){|memo, (k, v)| memo[k.to_sym] = Hash.transform_keys_to_symbols(v); memo}
+  end
+
+  def find_all_values_for(key)
+    result = []
+    result << self[key]
+    self.values.each do |hash_value|
+      next if hash_value.is_a? Array
+      values = [hash_value]
+      values.each do |value|
+        result += value.find_all_values_for(key) if value.is_a? Hash
+      end
+    end
+    result.compact
+  end
+
+  # Value present 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
+
+  # Whether key is present at least once
+  def include_key?(key)
+    result = find_all_values_for key
+    result != []
+  end
+
+  # Loop through each item within a key within a Hash if the key exists
+  # @param [Key] Key within hash to iterate through
+  def each_if_not_null(key)
+    case key.class.to_s
+    when 'String'
+      if self[key]
+        self[key].each do |list_item|
+          yield(list_item)
+        end
+      end
+    when 'Array', 'Hash'
+      if self[key[0]]
+        if self[key[0]][key[1]]
+          self[key[0]][key[1]].each do |list_item|
+            yield(list_item)
+          end
+        end
+      end
+    end
+  end
+
 end

data/lib/soaspec/matchers.rb

@@ -1,40 +1,41 @@
-
-require_relative 'hash_methods'
-
-RSpec::Matchers.define :contain_value do |expected|
-  match do |actual|
-    expect(actual.response.body.include_value?(expected)).to be true
-  end
-
-  failure_message do |actual|
-    "expected that #{actual.response.body} would contain value #{expected}"
-  end
-end
-
-RSpec::Matchers.define :contain_key do |expected|
-  match do |actual|
-    expect(actual.response.body.include_key?(expected)).to be true
-  end
-
-  failure_message do |actual|
-    "expected that #{actual.response.body} would contain key #{expected}"
-  end
-end
-
-RSpec::Matchers.define :have_element_at_xpath do |xpath|
-  match do |exchange|
-    expect(exchange[xpath]).not_to be_empty
-  end
-end
-
-RSpec::Matchers.define :have_xpath_value do |expected_hash|
-  match do |exchange|
-    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring
-    expect(exchange[expected_hash.keys.first]).to eq expected_hash.values.first
-  end
-
-  failure_message do |actual|
-    "expected that xpath '#{expected_hash.keys.first}' has value '#{expected_hash.values.first}' but was '#{actual[expected_hash.keys.first]}'"
-  end
-
+
+require_relative 'hash_methods'
+require_relative 'xpath_not_found'
+
+RSpec::Matchers.define :contain_value do |expected|
+  match do |actual|
+    expect(actual.response.body.include_value?(expected)).to be true
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.response.body} would contain value #{expected}"
+  end
+end
+
+RSpec::Matchers.define :contain_key do |expected|
+  match do |actual|
+    expect(actual.response.body.include_key?(expected)).to be true
+  end
+
+  failure_message do |actual|
+    "expected that #{actual.response.body} would contain key #{expected}"
+  end
+end
+
+RSpec::Matchers.define :have_element_at_xpath do |xpath|
+  match do |exchange|
+    expect { exchange[xpath] }.to_not raise_error NoElementAtXpath
+  end
+end
+
+RSpec::Matchers.define :have_xpath_value do |expected_hash|
+  match do |exchange|
+    expected_hash = Hash[*expected_hash.flatten] if expected_hash.is_a?(Array) # For some reason Array was occuring
+    expect(exchange[expected_hash.keys.first]).to eq expected_hash.values.first
+  end
+
+  failure_message do |actual|
+    "expected that xpath '#{expected_hash.keys.first}' has value '#{expected_hash.values.first}' but was '#{actual[expected_hash.keys.first]}'"
+  end
+
 end

data/lib/soaspec/soaspec_shared_examples.rb

@@ -1,19 +1,19 @@
-require 'rspec'
-
-shared_examples_for 'success scenario' do
-  it 'has status code of 200' do
-    expect(described_class.status_code).to eq 200
-  end
-  context 'has expected mandatory elements' do
-    described_class.mandatory_elements.each do |mandatory_element|
-      it mandatory_element do
-        expect(described_class).to contain_key mandatory_element
-      end
-    end
-  end
-  described_class.mandatory_xpath_values.each do |xpath, value|
-    it "has xpath '#{xpath}' equal to '#{value}'" do
-      expect(described_class).to have_xpath_value(xpath => value)
-    end
-  end
+require 'rspec'
+
+shared_examples_for 'success scenario' do
+  it 'has status code of 200' do
+    expect(described_class.status_code).to eq 200
+  end
+  context 'has expected mandatory elements' do
+    described_class.mandatory_elements.each do |mandatory_element|
+      it mandatory_element do
+        expect(described_class).to contain_key mandatory_element
+      end
+    end
+  end
+  described_class.mandatory_xpath_values.each do |xpath, value|
+    it "has xpath '#{xpath}' equal to '#{value}'" do
+      expect(described_class).to have_xpath_value(xpath => value)
+    end
+  end
 end

data/lib/soaspec/spec_logger.rb

@@ -1,18 +1,18 @@
-
-module Soaspec
-  require 'logger'
-
-  # Handles logs of API requests and responses
-  class SpecLogger
-    def self.create
-      @logger = Logger.new('logs/traffic.log') # Where request and responses of APIs are stored
-      @logger.level = Logger::DEBUG
-      @logger
-    end
-
-    def self.add_to(message)
-      @logger.info(message)
-    end
-
-  end
+
+module Soaspec
+  require 'logger'
+
+  # Handles logs of API requests and responses
+  class SpecLogger
+    def self.create
+      @logger = Logger.new('logs/traffic.log') # Where request and responses of APIs are stored
+      @logger.level = Logger::DEBUG
+      @logger
+    end
+
+    def self.add_to(message)
+      @logger.info(message)
+    end
+
+  end
 end

data/lib/soaspec/tester.rb

@@ -1,31 +1,31 @@
-
-module Soaspec
-  # Has basic methods common for methods defining RSpec tests in YAML
-  class Tester
-
-    # Retrieve the name of the template file to be used in the API request
-    attr_reader :template_name
-
-    # Set instance variable name
-    # @param [String, Symbol] name Name used when describing API test
-    # @param [Hash] options Parameters defining
-    def initialize(name, options)
-      @name = name
-    end
-
-    # Sets api handler variable globally. This is used in 'Exchange' class
-    # @return [String] Name set upon initialisation
-    def to_s
-      Soaspec::Environment.api_handler = self
-      @name
-    end
-
-    # Set the request option type and the template name
-    # @param [String] name Name of file inside 'template' folder excluding extension
-    def template_name=(name)
-      @request_option = :template
-      @template_name = name
-    end
-
-  end
+
+module Soaspec
+  # Has basic methods common for methods defining RSpec tests in YAML
+  class Tester
+
+    # Retrieve the name of the template file to be used in the API request
+    attr_reader :template_name
+
+    # Set instance variable name
+    # @param [String, Symbol] name Name used when describing API test
+    # @param [Hash] options Parameters defining
+    def initialize(name, options)
+      @name = name
+    end
+
+    # Sets api handler variable globally. This is used in 'Exchange' class
+    # @return [String] Name set upon initialisation
+    def to_s
+      Soaspec::Environment.api_handler = self
+      @name
+    end
+
+    # Set the request option type and the template name
+    # @param [String] name Name of file inside 'template' folder excluding extension
+    def template_name=(name)
+      @request_option = :template
+      @template_name = name
+    end
+
+  end
 end