soaspec 0.0.72 → 0.0.73

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9bd5b574f650987fe784eaeed4d9733e40cbd03
-  data.tar.gz: c9ab8b52fe53aa3b8ebc3807af2a0253906eceec
+  metadata.gz: 560cab022af5b3297cf79ae3bfd3b71cb023ac3d
+  data.tar.gz: c178b241de61f0ff91001ab1c710dd196ec6e611
 SHA512:
-  metadata.gz: a6b62377f9886cded11a729200f801c110ded422c31139c4dad350203b9404c01e4ade7e0c3a6fc9052a800ae0f2fa6341831e44e0f2a569954ad94354100de7
-  data.tar.gz: 24426a3ba9435bcf73c048d955be8fea9e2e23ccf0741ef442499d900ef46bb76c0b82f11fa5f8fbc9e1351e23a43efb3dfbb473b2bd8f79ed73b7667be9a179
+  metadata.gz: 4aad8d63361904d563c10534248dc90376d493712e579e6da2d1e8a787940664e51261531bcd2d37e038c28bfe19e300665f9df3a65b7c5841a968246ec9fcd7
+  data.tar.gz: 0e93c0c83266d50026b4c36488b63abbe26a31987006fa2f964487b9c94d3c74517c26c228ba0a927c3840716e4f2b9ace495ac6bb8d8bd3e7e3d36a6495c16b

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.0.73
+* Enhancements
+  * Added 'default_handler' method with which define an exchange_handler to be created when an exchange is initialized
+* Refactoring
+  * Use `@exchange_handler` instead of `@api_class` which is more consistent
+
 Version 0.0.72
 * Enhancements
   * Add ability to convert XML response to lower case for simpler xpath searching

data/lib/soaspec/exchange.rb

@@ -1,10 +1,26 @@
 require_relative '../soaspec'
 
+# Convenience methods to set Exchange specific properties
+module ExchangeAccessors
+
+  # Set default exchange handler for this exchange
+  # This is helpful for when you need a new exchange handler created for each exchange
+  def default_handler(handler_class, name = handler_class.to_s, params = {})
+    define_method('default_handler_used') do
+      handler_class.new name, params
+    end
+  end
+end
+
 # 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
 
-  # Class of Api Handler for which this exchange is made
-  attr_accessor :api_class
+  extend ExchangeAccessors
+
+  # Class of Exchange Handler 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
@@ -22,28 +38,38 @@ class Exchange
     @retry_for_success
   end
 
+  # @return [Boolean] Soaspec::ExchangeHandler used by this exchange
+  def default_handler_used
+    nil
+  end
+
+  # @param [String] element Element to define methods for
+  def methods_for_element(element)
+    element_name = element.to_s.split('__custom_path_').last
+    define_singleton_method(element_name) do
+      exchange_handler.__send__(element, response) # Forward the call onto handler to retrieve the element for the response
+    end
+    define_singleton_method("#{element_name}?") do
+      begin
+        __send__ element_name
+        true
+      rescue NoElementAtPath
+        false
+      end
+    end
+  end
+
   # @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
-    @api_class ||= Soaspec.api_handler # This uses the global parameter. The handler should be set straight before an exchange is made
+    # 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
     @override_parameters = override_parameters
     @retry_for_success = false
     self.retry_count = 3
-    @api_class.elements.each do |element|
-      element_name = element.to_s.split('__custom_path_').last
-      define_singleton_method(element_name) do
-        @api_class.__send__(element, response) # Forward the call onto handler to retrieve the element for the response
-      end
-      define_singleton_method("#{element_name}?") do
-        begin
-          __send__ element_name
-          true
-        rescue NoElementAtPath
-          false
-        end
-      end
-    end
+    @exchange_handler.elements.each { |element| methods_for_element(element) }
   end
 
   # Specify a url to add onto the base_url of the ExchangeHandler used
@@ -65,9 +91,9 @@ class Exchange
     Soaspec::SpecLogger.add_to 'Example ' + test_name
     request_params = @override_parameters
     retry_count.times do
-      response = @api_class.make_request(request_params)
+      response = @exchange_handler.make_request(request_params)
       return response unless retry_for_success?
-      return response if (200..299).cover? @api_class.status_code_for(response)
+      return response if (200..299).cover? @exchange_handler.status_code_for(response)
       response
     end
   end
@@ -76,7 +102,7 @@ class Exchange
   # @param [Symbol] name Name of method to use to access this value within handler
   # @param [String] value Path to value to store
   def store(name, value)
-    @api_class.store(name, self[value])
+    @exchange_handler.store(name, self[value])
   end
 
   # Retrieve the stored value from the Api Handler
@@ -84,8 +110,8 @@ class Exchange
   # @return [Object] value from the Api Handler stored previously
   def retrieve(name)
     method = '__stored_val__' + name.to_s
-    raise ArgumentError('Value not stored at ') unless api_class.respond_to? method
-    @api_class.send(method)
+    raise ArgumentError('Value not stored at ') unless exchange_handler.respond_to? method
+    exchange_handler.send(method)
   end
 
   # Name describing this class when used with `RSpec.describe`
@@ -108,7 +134,7 @@ class Exchange
   # 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)
+    @exchange_handler.status_code_for(response)
   end
 
   # Dummy request used to make a request without verifying it and ignoring WSDL errors
@@ -134,7 +160,7 @@ class Exchange
   # @param [Object] path Path to return element for api class E.g - for SOAP this is XPath string. For JSON, this is Hash dig Array
   # @return [String] Value at path
   def [](path)
-    @api_class.value_from_path(response, path.to_s)
+    @exchange_handler.value_from_path(response, path.to_s)
   end
 
   # Set a parameter request in the request body.

data/lib/soaspec/matchers.rb

@@ -5,22 +5,22 @@ require_relative 'not_found_errors'
 # Whether response has any element with the provided value
 RSpec::Matchers.define :contain_value do |expected|
   match do |actual|
-    expect(actual.api_class.include_value?(actual.response, expected)).to be true
+    expect(actual.exchange_handler.include_value?(actual.response, expected)).to be true
   end
 
   failure_message do |actual|
-    "expected that #{actual.api_class.response_body(actual.response, format: :hash)} would contain value #{expected}"
+    "expected that #{actual.exchange_handler.response_body(actual.response, format: :hash)} would contain value #{expected}"
   end
 end
 
 # Whether substring exists in body of response (more general than above)
 RSpec::Matchers.define :include_in_body do |expected|
   match do |actual|
-    expect(actual.api_class.include_in_body?(actual.response, expected)).to be true
+    expect(actual.exchange_handler.include_in_body?(actual.response, expected)).to be true
   end
 
   failure_message do |actual|
-    "expected that #{actual.api_class.response_body(actual.response, format: :raw)} would contain value #{expected}"
+    "expected that #{actual.exchange_handler.response_body(actual.response, format: :raw)} would contain value #{expected}"
   end
 end
 
@@ -32,7 +32,7 @@ RSpec::Matchers.define :have_element_at_path do |xpath|
 
   # TODO: Would be better to print failure message
   failure_message do |actual|
-    "expected that #{actual.api_class.response_body(actual.response, format: :raw)} would have element at path '#{xpath}'"
+    "expected that #{actual.exchange_handler.response_body(actual.response, format: :raw)} would have element at path '#{xpath}'"
   end
 end
 
@@ -56,7 +56,7 @@ end
 RSpec::Matchers.define :be_found do
 
   match do |exchange|
-    expect(exchange.api_class.found?(exchange.response)).to be true
+    expect(exchange.exchange_handler.found?(exchange.response)).to be true
   end
 
   failure_message do |exchange|

data/lib/soaspec/soaspec_shared_examples.rb

@@ -5,18 +5,18 @@ shared_examples_for 'success scenario' do
     expect(200..299).to cover described_class.status_code
   end
   context 'has expected mandatory elements' do
-    described_class.api_class.expected_mandatory_elements.each do |mandatory_element|
+    described_class.exchange_handler.expected_mandatory_elements.each do |mandatory_element|
       it mandatory_element do
         expect(described_class).to contain_key mandatory_element
       end
     end
   end
-  described_class.api_class.expected_mandatory_xpath_values.each do |xpath, value|
+  described_class.exchange_handler.expected_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
-  described_class.api_class.expected_mandatory_json_values.each do |xpath, value|
+  described_class.exchange_handler.expected_mandatory_json_values.each do |xpath, value|
     it "has xpath '#{xpath}' equal to '#{value}'" do
       expect(described_class).to have_xpath_value(xpath => value)
     end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.72'.freeze
+  VERSION = '0.0.73'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.72
+  version: 0.0.73
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler