soaspec 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be29f2183a787b94831d520bd5f08f50a3db0c51
-  data.tar.gz: 2f04d48ca686b5788f498e1e89878cf0281df642
+  metadata.gz: 1f25cdd5470680bb035c2296f5b29dba6afe1aef
+  data.tar.gz: 7a0b0c4c47d201e2025e8bd702ef208c701c410b
 SHA512:
-  metadata.gz: 21bac4eed696d3f8613f7f9dca483348e16c5e6c843da42f77e71590c7b8b29ca7b8b72143625d28d7c51b6297d50246a3a61e7dd4f031f5b38c72a6b096340a
-  data.tar.gz: 8266742c1d2db5453e900521a60732f6890f6714a42d72b24604acc6636f9c1981b013d56a5d85f612b0b7e13bc4404510ec62545afd0d6c23eabd403d6dce1a
+  metadata.gz: 5f843a8d1775bf6149e398008197225ada75c282693f543ec819ca3cab14d4267316a930256523686bfbef2470d723d0cfc1b45a278e46ded94b07ef5778051a
+  data.tar.gz: 03b8333eddee14dcd7d65415bf390c571fe2079c4f77ec410385d5fde7b101e7dd65cc69309661a67df0ccfbfca413df5729b86fe697b2a8ec1499df62509361

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.17
+* Enhancements
+  * Added Wait class to easily wait for an expected condition to be true, either using global Soaspec::Wait or `exchange.until { true }`
+    See spec/unit/wait_spec for example
+  * Made shorter way to `get` a REST url with `RestHandler.get 'id'` setting the suburl to 'id' automatically
+
 Version 0.1.16
 * Bug fix
   * Retry was not working for OAuth access_token

data/lib/soaspec.rb

@@ -31,6 +31,7 @@ require 'soaspec/test_server/invoices'
 require 'soaspec/test_server/test_namespace'
 require 'soaspec/test_server/id_manager'
 require 'soaspec/wsdl_generator'
+require 'soaspec/wait'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec

data/lib/soaspec/exchange.rb

@@ -235,8 +235,16 @@ class Exchange
     self
   end
 
+  # @return [Hash] Hash representing the response of the API
   def to_hash
     exchange_handler.to_hash(response)
   end
 
+  # Wait until the passed block returns true
+  def until(&script)
+    Soaspec::Wait.until do
+      @response = nil # Reset response so it can be made repeatedly
+      instance_eval(&script)
+    end
+  end
 end

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -278,9 +278,17 @@ module Soaspec
 
       methods.each do |rest_method|
         # Make REST Exchange within this Handler context
-        # @param [Hash] params Exchange parameters
+        # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
         # @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 }
+                     else
+                       params
+                     end
+          end
           params[:name] ||= rest_method
           exchange_params = { name: params[:name] }
           if params[:template_name]

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.16'.freeze
+  VERSION = '0.1.17'.freeze
 end

data/lib/soaspec/wait.rb

@@ -0,0 +1,44 @@
+module Soaspec
+  class TimeOutError < StandardError; end
+  # Class to enable waiting for an expected condition to return true
+  class Wait
+    DEFAULT_TIMEOUT  = 5
+    DEFAULT_INTERVAL = 0.2
+
+    #
+    # Wait until the given block returns a true value.
+    #
+    # @param [Hash] opts Options for this instance
+    # @option opts [Numeric] :timeout (5) Seconds to wait before timing out.
+    # @option opts [Numeric] :interval (0.2) Seconds to sleep between polls.
+    # @option opts [String] :message Exception mesage if timed out.
+    # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Error::NoSuchElementError)
+    # @raise [Error::TimeOutError]
+    # @return [Object] the result of the block
+    #
+    def self.until(opts = {})
+      timeout = opts.fetch(:timeout, DEFAULT_TIMEOUT)
+      ignored = Array(opts[:ignore] || NoElementAtPath)
+      end_time = Time.now + timeout
+      last_error = nil
+
+      until Time.now > end_time
+        begin
+          result = yield
+          return result if result
+        rescue *ignored => last_error
+          # swallowed
+        end
+        sleep opts.fetch(:interval, DEFAULT_INTERVAL)
+      end
+
+      msg = if opts[:message]
+              opts[:message].dup
+            else
+              "timed out after #{timeout} seconds"
+            end
+      msg << " (#{last_error.message})" if last_error
+      raise Soaspec::TimeOutError, msg
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -400,6 +400,7 @@ files:
 - lib/soaspec/test_server/test_namespace.rb
 - lib/soaspec/version.rb
 - lib/soaspec/virtual_server.rb
+- lib/soaspec/wait.rb
 - lib/soaspec/wsdl_generator.rb
 - soaspec.gemspec
 - templates/rest_template.json