soaspec 0.2.21 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1028921ecb551ea11797baf3cc3f857a63ffe605b17e14d2fdf96789fc8b12
-  data.tar.gz: b09a3d92546409cccfc28b2ee29b8207547fab372028605594c1751ccf175044
+  metadata.gz: 2f3a41968e523901e869b24522b1fe2c630518239fed2e3600f2e8f5b67a9fb5
+  data.tar.gz: f9af632f2e025cccf4da721120ca44e5aed446d0b5b2353e860d347fbfd28594
 SHA512:
-  metadata.gz: 2d546e2a961ad5dd77d92587193b6b1cb7bbbcdcd355a4d33f16f84a0f62318e9b45a51607b39fdf7e1ba71e77359bc77f93e224e846ef4212320390e22c7d37
-  data.tar.gz: aa2d86da44ddcd01187979b43f8021c21bec56627a4796d056a29104da32a4bd992ab9c342aba22471a9b2d1ad90dc843101df5779949839190f0a002185aaaa
+  metadata.gz: a1eb7bf52e74e6c355bf5f078707a97998c90c6084caaae85e4647ad3750e1c5daa9f593f1dbb4aa4bc688a410fa1c3c04a13e06037949a53547d1c3b04305f4
+  data.tar.gz: 77f6623886cb834aac76e5bdc275bee97260ddec1d0277c7f57bdb042355d45b03e94902900526520d2ffd2b0e05a23c41980d6c5eae11eee8aadf3c0f4375b2

data/ChangeLog

@@ -1,3 +1,11 @@
+Version 0.2.22
+* Bug Fix
+  * Allow negated version of 'be_successful' to work
+  * Fix `Exchange.retry_count` so that it retries after first try the correct number of times
+* Enhancement
+  * Make 'value_from_path' and 'values_from_path' methods accessible from 'response' object
+  * Get extracting text via RegEx actually working
+
 Version 0.2.21
 * Enhancement
   * Enable deprecation warnings to be removed so that they're not annoying with `Soaspec.log_warnings`

data/lib/soaspec/exchange/exchange.rb

@@ -66,12 +66,12 @@ class Exchange
   def make_request
     Soaspec::SpecLogger.info 'Example ' + test_name
     request_params = @override_parameters
-    (1..retry_count).each do |count|
+    (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
+      sleep 0.5 # Time before retrying
       break response if count == retry_count
     end
   end
@@ -90,9 +90,12 @@ class Exchange
   #   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
 
@@ -100,7 +103,8 @@ class Exchange
   #   allow easy method chaining
   def call
     if Soaspec.log_warnings
-      warn 'This method will be changed to return "Exchange" object in 0.3. Use "response" method if you want the response object'
+      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

data/lib/soaspec/exchange/exchange_extractor.rb

@@ -27,6 +27,8 @@ module Soaspec
       exchange_handler.value_from_path(response, path.to_s)
     end
 
+    alias_method :value_from_path, :[]
+
     # Using same path syntax as []. Returns true of false depending on whether an element is found
     # @return [Boolean] Whether an element exists at the path
     def element?(path)

data/lib/soaspec/exchange/exchange_properties.rb

@@ -19,12 +19,8 @@ module Soaspec
     # Set retry_for_success to true, retrying response until a successful status code is returned
     # @param [Integer] retry_count Times to retry to get a positive response
     def expect_positive_status(retry_count: 3)
-      define_method('retry_count') do
-        retry_count
-      end
-      define_method('retry_for_success?') do
-        true
-      end
+      define_method('retry_count') { retry_count }
+      define_method('retry_for_success?') { true }
     end
   end
 end

data/lib/soaspec/exchange_handlers/exchange_handler.rb

@@ -6,6 +6,10 @@ module Soaspec
   class ExchangeHandler
     extend Soaspec::HandlerAccessors
 
+    def self.use
+      new.use
+    end
+
     # Retrieve the name of the template file to be used in the API request
     attr_reader :template_name
 

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -163,6 +163,24 @@ module Soaspec
       JsonPath.on(response.body, path)
     end
 
+    # Calculate all JSON path values based on rules. ',', pascal_case
+    # @param [RestClient::Response] response Response from API
+    # @param [Object] path Xpath, JSONPath or other path identifying how to find element
+    # @param [String] attribute Generic attribute to find. Will override path
+    # @param [Boolean] not_empty Whether to fail if result is empty
+    # @return [Array] Paths to check as first and matching values (List of values matching JSON Path) as second
+    def calculated_json_path_matches(path, response, attribute, not_empty: false)
+      path = add_pascal_path(path)
+      paths_to_check = path.split(',')
+      paths_to_check = paths_to_check.map { |path_to_check| prefix_json_path(path_to_check) }
+      matching_values = paths_to_check.collect do |path_to_check|
+        json_path_values_for(response, path_to_check, attribute: attribute)
+      end.reject(&:empty?)
+      raise NoElementAtPath, "No value at JSONPath '#{paths_to_check}' in '#{response.body}'" if matching_values.empty? && not_empty
+
+      matching_values.first
+    end
+
     # Based on a exchange, return the value at the provided xpath
     # If the path does not begin with a '/', a '//' is added to it
     # @param [RestClient::Response] response Response from API
@@ -179,21 +197,12 @@ module Soaspec
 
         return result.attributes[attribute].inner_text
       when :json
-        path = add_pascal_path(path)
-        paths_to_check = path.split(',')
-        paths_to_check = paths_to_check.map { |path_to_check| prefix_json_path(path_to_check) }
-        matching_values = paths_to_check.collect do |path_to_check|
-          json_path_values_for(response, path_to_check, attribute: attribute)
-        end.reject(&:empty?)
-        raise NoElementAtPath, "No value at JSONPath '#{paths_to_check}' in '#{response.body}'" if matching_values.empty?
-
-        matching_values.first.first
-      when :hash
-        response.dig(path.split('.')) # Use path as Hash dig expression separating params via '.' TODO: Unit test
-      else
+        matching_values = calculated_json_path_matches(path, response, attribute, not_empty: true)
+        matching_values.first
+      else # Assume this is a String
         raise NoElementAtPath, 'Response is empty' if response.to_s.empty?
 
-        response.to_s[/path/] # Perform regular expression using path if not XML nor JSON TODO: Unit test
+        response.to_s[/#{path}/] # Perform regular expression using path if not XML nor JSON
       end
     end
 
@@ -204,7 +213,9 @@ module Soaspec
       when :xml
         xpath_elements_for(response: response, xpath: path, attribute: attribute).map(&:inner_text)
       when :json
-        json_path_values_for(response, path, attribute: attribute)
+        result = calculated_json_path_matches(path, response, attribute)
+        result || []
+        # json_path_values_for(response, path, attribute: attribute)
       else
         raise "Unable to interpret type of #{response.body}"
       end

data/lib/soaspec/interpreter.rb

@@ -11,7 +11,7 @@ class Interpreter
         elsif json?
           :json
         else
-          :unknown
+          :string
         end
       elsif response.is_a? Hash
         :hash

data/lib/soaspec/matchers.rb

@@ -71,9 +71,16 @@ end
 
 # Whether response has successful status code and correct mandatory elements and values
 RSpec::Matchers.define :be_successful do
-  match do |actual|
+  # @param [Exchange, RestClient::Response] actual Object that returns Exchange or is Exchange
+  # @return [Exchange] Exchange to use
+  def exchange_from(actual)
+    actual.respond_to?(:exchange) ? actual.exchange : actual
+  end
+
+  # @param [Exchange, RestClient::Response] exchange Object that returns Exchange or is Exchange
+  # @return [Array] List of errors when checking Exchange response is successful
+  def collect_errors(exchange)
     failure_list = []
-    exchange = actual.respond_to?(:exchange) ? actual.exchange : actual
     failure_list << "#{exchange.status_code} not valid status code" unless (200..299).cover?(exchange.status_code)
     exchange.exchange_handler.expected_mandatory_elements.each do |mandatory_element_path|
       begin
@@ -88,8 +95,20 @@ RSpec::Matchers.define :be_successful do
     exchange.exchange_handler.expected_mandatory_json_values.each do |path, value|
       failure_list << "Expected value at json '#{path}' to be '#{value}' but was '#{exchange[path]}'" unless exchange[path] == value
     end
+    failure_list
+  end
+
+  match do |actual|
+    exchange = exchange_from actual
+    failure_list = collect_errors exchange
     raise failure_list.to_s unless failure_list.empty?
+    true
+  end
 
+  match_when_negated do |actual|
+    exchange = exchange_from actual
+    failure_list = collect_errors exchange
+    raise "Expected failure. Status code is #{exchange.status_code}" if failure_list.empty?
     true
   end
 end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.21'.freeze
+  VERSION = '0.2.22'.freeze
 end

data/lib/soaspec/virtual_server.rb

@@ -30,7 +30,7 @@ module Soaspec
 
     documentation 'Nothing under /. Go look at /docs' do
       response 'redirects to the documentation page'
-      status 303
+      status 302
     end
     get '/' do
       redirect '/docs'
@@ -38,6 +38,20 @@ module Soaspec
 
     doc_endpoint '/docs'
 
+    documentation 'Simulate server error' do
+      status 500
+    end
+    get '/server_error' do
+      [500, {}, 'Internal Server Error']
+    end
+
+    documentation 'Used to verify extract from text response' do
+      response 'Plain text with a pattern to match in it'
+    end
+    get '/text_response' do
+      'This is some text. In here it says ID=12345 to indicate value to obtain'
+    end
+
     documentation 'Used to test attributes' do
       response 'A simple Note XML with a date attribute'
     end
@@ -63,6 +77,7 @@ module Soaspec
       JSON.generate(success: Soaspec::TestServer::IdManager.result_for(num, id), id: id)
     end
 
+    documentation 'Sets status as developed'
     post '/packages/developed' do
       Soaspec::TestServer::IdManager.developed = request.body.include?('true')
       Soaspec::TestServer::IdManager.developed.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.22
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler