soaspec 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1be796f9ede9ecbecec8effaa198c8e7393e3648
-  data.tar.gz: c80d4e76e7e5fc58e7457fa774e5a3bd7a3932c5
+  metadata.gz: 757cc34fa056aa23860299c614c1e981b96a6c7d
+  data.tar.gz: af77364e1117ea4fc27d7375ab9366c6d6f3d222
 SHA512:
-  metadata.gz: dadb8d208c81c5158d33790d2f308be0dd940b9ee5585a04b94fd5e88ffbbd31c26b5ffc4ae9f5a0c0f3ae797b89918f1b0dd0bdb87377abe18bc2b69557511b
-  data.tar.gz: c21ab190b0e65a5c750d1d0127c95df18069e31416698e33b7feeafd574ab3a5127ae74866f9d30b200513e266773e6a3c0bb5ed09b1496ead2bb75ee8c427ce
+  metadata.gz: aabc608e6182a76290d7c546f66f722dd19c4d7b183f263cffd7bcc3f569951c15c9beb2925a455d7e4c71dcb0d6990ebd4919535f1026b6422cae05f49c364e
+  data.tar.gz: 51547871679bbbd4c23c261315f241980f417c9c4bcd1802f450a801c60b2e4abf712c49bcb12c14a692314997377b6c7e2bb18f843194e677d965cc59c39d2f

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.2.3
+* Enhancements
+  * Exchange.until itself method returns itself making it easier to reuse last result in assertions
+  * Added parameters to Exchange.until so that timeout, message and interval can be specified
+  * Soaspec cucumber exe to add generic steps to step_definitions folder
+
 Version 0.2.2
 * Enhancements
   * Make accessing test_values from template using indifferent access

data/exe/soaspec

@@ -55,7 +55,14 @@ module Soaspec
     def add(type = 'rest', name = 'TestService')
       raise "Type '#{type}' is not available" unless %w[rest soap].include? type
       @name = name # Use instance variable for ERB
-      create_file(filename: File.join('lib', "#{name.snakecase}.rb"), content: retrieve_contents("lib/new_#{type}_service.rb"))
+      create_file filename: File.join('lib', "#{name.snakecase}.rb"),
+                  content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
+    end
+
+    desc 'cucumber', 'Add cucumber generic steps template within step_definitions folder'
+    def cucumber
+      create_file filename: File.join('features', 'step_definitions', 'generic_steps.rb'),
+                  content: retrieve_contents(File.join('../cucumber', 'generic_steps.rb'), false)
     end
 
     desc 'generate', 'Generate initial test code from wsdl'

data/exe/xml_to_yaml_file

@@ -12,25 +12,6 @@ include Soaspec::ExeHelpers
 
 default_output_file = 'output.yml'
 
-# Create file if not present. If present but different give warning
-def create_file(options)
-  filename = options[:filename]
-  raise 'Need to pass filename' unless filename
-  content = options[:content]
-  raise 'Need to pass contents to insert into file' unless content
-  if File.exist? filename
-    old_content = File.read(filename)
-    if old_content != content
-      warn "!! #{filename} already exists and differs from template"
-    end
-  else
-    File.open(filename, 'w') do |f|
-      f.puts content
-    end
-    puts 'Created: ' + filename
-  end
-end
-
 # For all keys in a Hash, convert Camelcase to underscore separated
 def convert_hash_keys(value)
   case value

data/lib/soaspec/cucumber/generic_steps.rb

@@ -7,11 +7,17 @@ end
 
 # Pass in the operation (HTTP method or SOAP operation) in first parameter and api name as second.
 # API name can be mulitple words and it will be converted to camel case to find the ExchangeHandler class
+# @example Create an Exchange representing an HTTP 'post' based on the 'Puppy' RestHandler class
+#   I am performing a post on the Puppy API
+# @example Create an Exchange for a 'get_bank' operation on for a 'Banking' SoapHandler class
+#   I am performing a get_bank on the Banking API
 Given 'I am performing a {word} on the {string} API' do |operation, api_name|
   @current_exchange = api_name.tr(' ', '_').camelize.constantize.send operation
 end
 
 # Set a parameter in the request body
+# @example Set the name element in the request body to Charlie
+#   And I set the name to 'Charlie'
 # @param [String] Element in request body to set
 # @param [String] Value to set it to
 Given 'I set the {word} to {string}' do |key, value|
@@ -19,11 +25,17 @@ Given 'I set the {word} to {string}' do |key, value|
 end
 
 # Add onto the base_url to make a complete url for the test
+# @example base_url is 'http://petstore.swagger.io/v2' and I want a post to 'http://petstore.swagger.io/v2/pet'
+#   I use the path pet
 Given 'I use the path {word}' do |suburl|
   current_exchange.suburl = suburl
 end
 
 # Add a query parameter for http 'get' requests. e.g. will add '?filter_key=filter_value' onto URL
+# @example To create a query for '?status=sold'
+#   And I filter 'status' by 'sold'
+# @example To add a query for 'area' being 'australia' to make a total of '?status=sold&area=austrialia'
+#   And I filter 'area' by 'australia'
 Given 'I filter {string} by {string}' do |filter_key, filter_value|
   transformed_key = filter_key.to_sym
   if current_exchange.override_parameters[:q]
@@ -34,6 +46,8 @@ Given 'I filter {string} by {string}' do |filter_key, filter_value|
 end
 
 # Add HTTP header 'header_name' as 'header_value'
+# @example
+#   And I set header 'accept' to 'application/xml'
 Given 'I set header {string} to {string}' do |header_name, header_value|
   if current_exchange.override_parameters[:params]
     current_exchange.override_parameters[:params][header_name] = header_value
@@ -49,12 +63,16 @@ When 'I make the request' do
 end
 
 # Extract the value from the response that is at the path 'key' and verify it is eq to expected_value
+# @example Assert response body has at the path 'name', the value 'Charlie'
+#   Then it should have the name 'Charlie'
 Then 'it should have the {word} {string}' do |key, expected_value|
   expect(current_exchange[key]).to eq expected_value
 end
 
 # Extract the value from the response that is at the path 'key_string' and verify it is eq to expected_value
 # Conversion is made on key_string to make it one snake case word
+# @example Assert response body has at the path 'customer_name', the value 'Charlie'
+#   Then it should have the 'customer name' 'Charlie'
 Then 'it should have the {string} {string}' do |key_string, expected_value|
   key = key_string.tr(' ', '_')
   actual_value = current_exchange.respond_to?(key) ? current_exchange.send(key) : current_exchange[key]

data/lib/soaspec/exchange.rb

@@ -219,10 +219,17 @@ class Exchange
   end
 
   # Wait until the passed block returns true
-  def until(&script)
-    Soaspec::Wait.until do
+  # @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)
+  # @return [Self] Returns itself so operations can be done on the exchange after it's done waiting
+  def until(opts = {}, &script)
+    Soaspec::Wait.until(opts) do
       @response = nil # Reset response so it can be made repeatedly
       instance_eval(&script)
     end
+    self
   end
 end

data/lib/soaspec/exe_helpers.rb

@@ -34,7 +34,11 @@ module Soaspec
     # @param [String] filename Filename within 'lib/generator' to file retrieve contents from
     # @param [Boolean] erb Whether to process file with ERB
     def retrieve_contents(filename, erb = true)
-      default_file = File.join(File.dirname(__FILE__), 'generator', filename + (erb ? '.erb' : ''))
+      default_file = if filename.start_with?('../')
+                       File.join(File.dirname(__FILE__), filename[3..-1] + (erb ? '.erb' : ''))
+                     else
+                       File.join(File.dirname(__FILE__), 'generator', filename + (erb ? '.erb' : ''))
+                     end
       contents = File.read(default_file)
       erb ? ERB.new(contents).result(binding) : contents
     end

data/lib/soaspec/version.rb

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

data/lib/soaspec/wait.rb

@@ -19,6 +19,7 @@ module Soaspec
     def self.until(opts = {})
       timeout = opts.fetch(:timeout, DEFAULT_TIMEOUT)
       ignored = Array(opts[:ignore] || NoElementAtPath)
+      interval = opts.fetch(:interval, DEFAULT_INTERVAL)
       end_time = Time.now + timeout
       last_error = nil
 
@@ -29,14 +30,10 @@ module Soaspec
         rescue *ignored => last_error
           # swallowed
         end
-        sleep opts.fetch(:interval, DEFAULT_INTERVAL)
+        sleep interval
       end
 
-      msg = if opts[:message]
-              opts[:message].dup
-            else
-              "timed out after #{timeout} seconds"
-            end
+      msg = opts[:message] ? opts[:message].dup : "timed out after #{timeout} seconds with interval of #{interval}"
       msg << " (#{last_error.message})" if last_error
       raise Soaspec::TimeOutError, msg
     end

metadata

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