soaspec 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 757cc34fa056aa23860299c614c1e981b96a6c7d
-  data.tar.gz: af77364e1117ea4fc27d7375ab9366c6d6f3d222
+  metadata.gz: 6fc08897eb83281f6c6226c6f0df1768129ec307
+  data.tar.gz: 58e5b2672c36a667471f97159e63dea73ca44dbe
 SHA512:
-  metadata.gz: aabc608e6182a76290d7c546f66f722dd19c4d7b183f263cffd7bcc3f569951c15c9beb2925a455d7e4c71dcb0d6990ebd4919535f1026b6422cae05f49c364e
-  data.tar.gz: 51547871679bbbd4c23c261315f241980f417c9c4bcd1802f450a801c60b2e4abf712c49bcb12c14a692314997377b6c7e2bb18f843194e677d965cc59c39d2f
+  metadata.gz: 603ad5943c9f9e063163ab0cf485af270f0a91639a0c7a4535a9e2aeae757fac9d9ad442b14d039ece23316827e3be39ee3c53532a1cdc148d6526b37e9adc1b
+  data.tar.gz: 03312d09ccada29afa1c5d61a8a1a559287cdd35f96289b53490f25f22d3d07e44368e14824bfdd8ef5dce579de0f4ec2d64e7a76dadc8dfc50cfdfc1bf823d0

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.2.4
+* Enhancements
+  * Enable block to be used when creating exchange with Handler.exchange
+
 Version 0.2.3
 * Enhancements
   * Exchange.until itself method returns itself making it easier to reuse last result in assertions

data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb

@@ -12,7 +12,7 @@ module Soaspec
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def post(params = {})
-      # This is a stub, used for indexing, source code below
+      perform_exchange_with(:post, params)
     end
 
     # Make REST Exchange with 'patch' method within this Handler context
@@ -26,7 +26,7 @@ module Soaspec
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def patch(params)
-      # This is a stub, used for indexing, source code below
+      perform_exchange_with(:patch, params)
     end
 
     # Make REST Exchange with 'put' method within this Handler context
@@ -40,7 +40,7 @@ module Soaspec
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def put(params = {})
-      # This is a stub, used for indexing, source code below
+      perform_exchange_with(:put, params)
     end
 
     # Make REST Exchange with 'get' method within this Handler context.
@@ -55,7 +55,7 @@ module Soaspec
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def get(params = {})
-      # This is a stub, used for indexing, source code below
+      perform_exchange_with(:get, params)
     end
 
     # Make REST Exchange with 'delete' method within this Handler context.
@@ -70,34 +70,42 @@ module Soaspec
     # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def delete(params = {})
-      # This is a stub, used for indexing, source code below
+      perform_exchange_with(:delete, params)
     end
 
-    methods = %w[post patch put get delete]
+    private
 
-    methods.each do |rest_method|
-      # Make REST Exchange within this Handler context
-      # @param [Hash, String] params Exchange parameters.
-      # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-      define_method(rest_method) do |params = {}|
-        unless params.is_a? Hash
-          params = case rest_method
-                   when 'get', 'delete'
-                     { suburl: params.to_s }
-                   when 'post', 'put', 'patch'
-                     { payload: params.to_s }
-                   else
-                     raise "'#{params}' needs to be a 'Hash' but is a #{params.class}"
-                   end
-        end
-        params[:name] ||= rest_method
-        exchange_params = { name: params[:name] }
-        if params[:template_name]
-          exchange_params[:template_name] = params[:template_name]
-          params.delete :template_name
-        end
-        new(exchange_params)
-        Exchange.new(params[:name], method: rest_method.to_sym, **params)
+    # Make REST Exchange within this Handler context
+    # @param [Symbol] rest_method HTTP rest method to use
+    # @param [Hash, String] params Exchange parameters.
+    # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
+    def perform_exchange_with(rest_method, params = {})
+      params = determine_params_for(rest_method, params)
+      params[:name] ||= rest_method.to_s
+      exchange_params = { name: params[:name] }
+      if params[:template_name]
+        exchange_params[:template_name] = params[:template_name]
+        params.delete :template_name
+      end
+      new(exchange_params)
+      exchange = Exchange.new(params[:name], method: rest_method, **params)
+      yield exchange if block_given?
+      exchange
+    end
+
+    # @param [Symbol] method HTTP rest method to use
+    # @param [Hash, String] params Exchange parameters.
+    # @return [Hash] Exchange Parameters after setting shorthand parameters
+    def determine_params_for(method, params)
+      return params if params.is_a? Hash
+
+      case method
+      when :get, :delete
+        { suburl: params.to_s }
+      when :post, :put, :patch
+        { payload: params.to_s }
+      else
+        raise "'#{params}' needs to be a 'Hash' but is a #{params.class}"
       end
     end
   end

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -218,6 +218,7 @@ module Soaspec
           tmp_class.operation = method_name
           exchange = Exchange.new(method_name, *args)
           exchange.exchange_handler = tmp_class
+          yield exchange if block_given?
           exchange
         else
           super

data/lib/soaspec/matchers.rb

@@ -26,7 +26,9 @@ end
 
 # Whether an element exists at expected xpath
 RSpec::Matchers.define :have_element_at_path do |xpath|
-  match do |exchange|
+  match do |object|
+    # Object like `response` returns the Exchange object from which a path can be obtained
+    exchange = object.respond_to?(:exchange) ? object.exchange : object
     expect { exchange[xpath] }.to_not raise_error # Error will be raised if Path returns no value
   end
 
@@ -42,7 +44,9 @@ RSpec::Matchers.alias_matcher :contain_key, :have_element_at_path
 # Whether an element at xpath (defined by key) has value (defined by value).
 # @param [Hash] expected_hash Xpath => Value pair (e.g. '//xmlns:GetWeatherResult' => 'Data Not Found')
 RSpec::Matchers.define :have_xpath_value do |expected_hash|
-  match do |exchange|
+  match do |object|
+    # Object like `response` returns the Exchange object from which a path can be obtained
+    exchange = object.respond_to?(:exchange) ? object.exchange : object
     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
@@ -50,9 +54,10 @@ RSpec::Matchers.define :have_xpath_value do |expected_hash|
   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
 
+RSpec::Matchers.alias_matcher :have_jsonpath_value, :have_xpath_value
+
 RSpec::Matchers.define :be_found do
 
   match do |exchange|

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler