soaspec 0.0.36 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0877db6205f535e6fe2c1999d6fd43efc7c8c968'
-  data.tar.gz: cd409d133b72f33a343dcd2c6dae74e23bda9c00
+  metadata.gz: ab1cb8ee1d09d0721eb978f4ac7e40b6f33f7151
+  data.tar.gz: 77236d1a6feac34f99571fcabbfa4487df14ce82
 SHA512:
-  metadata.gz: 0cf6f5d024199e9a4518bb86054927f768e096ae34c9f9686b8c58a5d79163fe979dbb3fc01448c90c89a2d057399e00f0ac0ff012e7ac3564e27f9d45a5ecd4
-  data.tar.gz: 630e900ca4727d7f17bec11c0d947c12e1378f57acadbe67cfae4442425f69807ca2abdf1dede554d7cbf477861b97002a543f1283d3f6bb64cd66068f64fed6
+  metadata.gz: b69397b682d8fa139f22ae921b6cb1497bd444acd821b9a79ac1c116bf963d9e59c1645e9f0faf02a946d14358f30ba79d7061e45905191b349f4c677866e284
+  data.tar.gz: 2cbfefe2deb59e4c582ca0012d118ae68afad55681859d408175c00c8d6494a988844da044f52a96df2c965f35597cb0b1cb2ffa9aa62a25eb27fd839181c3bc

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.0.37 / 2018-3-16
+* Enhancements
+  * Made retry_for_success method to keep making request until 200 status code if set on exchange
+  * If '$' not included for json_path, by default a '$..' is added for convenience
+
 Version 0.0.36 / 2018-3-15
 * Bug fix
    * Make test name log in correct place

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    soaspec (0.0.36)
+    soaspec (0.0.37)
       jsonpath
       rest-client (>= 2.0)
       rspec (~> 3.0)
@@ -30,7 +30,7 @@ GEM
       builder (>= 2.1.2)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    httpi (2.4.2)
+    httpi (2.4.3)
       rack
       socksify
     i18n (0.9.1)
@@ -44,12 +44,12 @@ GEM
     mini_portile2 (2.3.0)
     multi_json (1.13.1)
     netrc (0.11.0)
-    nokogiri (1.8.1)
+    nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
-    nokogiri (1.8.1-x64-mingw32)
+    nokogiri (1.8.2-x64-mingw32)
       mini_portile2 (~> 2.3.0)
     nori (2.6.0)
-    rack (2.0.3)
+    rack (2.0.4)
     rake (12.2.1)
     require_all (1.5.0)
     rest-client (2.0.2)
@@ -79,12 +79,12 @@ GEM
     rspec-support (3.7.0)
     rspec_junit_formatter (0.3.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    savon (2.11.2)
+    savon (2.12.0)
       akami (~> 1.2)
       builder (>= 2.1.2)
       gyoku (~> 1.2)
       httpi (~> 2.3)
-      nokogiri (>= 1.4.0)
+      nokogiri (>= 1.8.1)
       nori (~> 2.4)
       wasabi (~> 3.4)
     socksify (1.7.1)

data/README.md

@@ -21,9 +21,11 @@ Or install it yourself as:
 
 ## Todo
 
-Handle REST
-Give examples and convenience methods for building classes for each SOAP or REST operation
-Potentially have in built use of 'vcr' and 'http_stub' gems
+* Give examples and convenience methods for building classes for each SOAP or REST operation
+* Handle REST template (similar way to REST)
+* Potentially have in built use of 'vcr' and 'http_stub' gems
+* Handle proxies to record traffic for MiddleWare testing
+* Much more
 
 ## Getting Started
 
@@ -44,10 +46,13 @@ Then you can run the tests with:
 rake spec
 ```
 
+You can also use `soaspec-generate` to generate a set of tests from a WSDL. This is still in trial period
+
 ## Usage
 
-* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'basic_soap_handler.rb'-'default_options' method
+* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'soap_handler.rb'-'default_options' method
 for such defaults. When describing an API override this in 'savon_options' method  
+* REST - this uses the resource class from the Rest-Client gem behind the scenes.
 
 See specs for example of usage. This will be added to later. 
 

data/exe/soaspec-generate

@@ -162,7 +162,7 @@ create_file filename: "lib/#{@name.snakecase}.rb", content: ERB.new(@class_conte
   if details[:parameters]
     details[:parameters].each do |element, details|
       @use_camel_case = true if (/[[:upper:]]/.match(element.to_s[0]) != nil)
-      @content += "  #{underscore_key element}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
+      @content += "  #{element.snakecase}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
       # TODO: If details is a Hash need to loop again
     end
   end

data/exe/xml_to_yaml_file

@@ -37,7 +37,7 @@ def convert_hash_keys(value)
   when Array
     value.map { |v| convert_hash_keys(v) }
   when Hash
-    Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+    Hash[value.map { |k, v| [k.snakecase, convert_hash_keys(v)] }]
   else
     value
   end

data/lib/soaspec/accessors.rb

@@ -6,6 +6,19 @@ module Soaspec
     # Defines expected_mandatory_elements method used in 'success_scenario' shared examples
     # to indicate certain elements must be present
     # @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
+    #
+    # @example Inside class
+    #   mandatory_elements :GetWeatherResult
+    #
+    # Or for a list
+    #
+    # @example Inside class
+    #   mandatory_elements [:GetWeatherResult, :GetResultStatus]
+    #
+    # In test
+    # describe Exchange(:name) do
+    #   it_behaves_like 'success scenario' # Includes checks for mandatory elements
+    # end
     def mandatory_elements(elements)
       define_method('expected_mandatory_elements') do
         return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
@@ -41,7 +54,7 @@ module Soaspec
     # end
     #
     def mandatory_json_values(json_value_pairs)
-      raise ArgumentError('Hash of {jsonpath => expected values} expected ') unless json_value_pairs.is_a? Hash
+      raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
       define_method('expected_mandatory_json_values') do
         json_value_pairs
       end

data/lib/soaspec/exchange.rb

@@ -4,6 +4,20 @@ require_relative '../soaspec'
 class Exchange
 
   attr_reader :api_class
+  # How many times to retry for a success
+  attr_accessor :retry_count
+
+  # Set retry for success variable to true so that request will be retried
+  # for retry_count until it's true
+  def retry_for_success
+    @retry_for_success = true
+    self
+  end
+
+  # @return [Bool] Whether to keep making request until success code reached
+  def retry_for_success?
+    @retry_for_success
+  end
 
   # @param [Symbol, String] name Name shown in RSpec run
   # @param [Hash] override_parameters Parameters to override for default params
@@ -11,12 +25,21 @@ class Exchange
     @test_name = name.to_s
     @api_class = Soaspec::Environment.api_handler
     @override_parameters = override_parameters
+    @retry_for_success = false
+    self.retry_count = 3
   end
 
   # Make request to handler with parameters defined
+  # Will retry until success code reached if retry_for_success? is set
+  # @return [Response] Response from Api handler
   def make_request
     Soaspec::SpecLogger.add_to 'Example ' + @test_name
-    @api_class.make_request(@override_parameters)
+    retry_count.times do
+      response = @api_class.make_request(@override_parameters)
+      return response unless retry_for_success?
+      return response if @api_class.status_code_for(response) == 200
+      response
+    end
   end
 
   # Name describing this class when used with `RSpec.describe`
@@ -40,6 +63,17 @@ class Exchange
     @api_class.status_code_for(response)
   end
 
+  # Dummy request used to make a request without verifying it and ignoring WSDL errors
+  # @return [Boolean] Always returns true. Unless of course an unexpected exception occurs
+  def dummy_request
+    make_request
+    true
+  rescue Savon::HTTPError
+    puts 'Resolver error'
+    # This seems to occur first time IP address asks for WSDL
+    true
+  end
+
   # Extract value from path api class
   # @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

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -227,6 +227,7 @@ module Soaspec
         path = '//' + path if path[0] != '/'
         xpath_value_for(exchange: exchange, xpath: path)
       when :json
+        path = '$..' + path if path[0] != '$'
         matching_values = JsonPath.on(exchange.response.body, path)
         raise NoElementInHash, "Element in #{exchange.response.body} not found with path '#{path}'" if matching_values.empty?
         matching_values.first

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -84,12 +84,16 @@ module Soaspec
       test_values = override_parameters # Used in Erb
       # Erb parses template file, executing Ruby code in `<% %>` blocks to work out final request
       test_values = test_values.transform_keys_to_symbols if Soaspec::Environment.always_use_keys?
-      if @request_option == :template
-        request_body = File.read('template/' + template_name + '.xml')
-        render_body = ERB.new(request_body).result(binding)
-        @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
-      elsif @request_option == :hash
-        @client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
+      begin
+        if @request_option == :template
+          request_body = File.read('template/' + template_name + '.xml')
+          render_body = ERB.new(request_body).result(binding)
+          @client.call(operation, xml: render_body) # Call the SOAP operation with the request XML provided
+        elsif @request_option == :hash
+          @client.call(operation, message: @default_hash.merge(test_values), attributes: request_root_attributes)
+        end
+      rescue Savon::HTTPError => e
+        e
       end
     end
 

data/lib/soaspec/exe_helpers.rb

@@ -123,15 +123,5 @@ Reports are shown in the 'logs' folder. By default Rake produces a junit, an htm
     EOF
     end
 
-    # Convert key in camelcase to underscore separated (snakecase)
-    def underscore_key(key)
-      key.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-         .tr('-', '_')
-         .gsub(/\s/, '_')
-         .gsub(/__+/, '_')
-         .downcase
-    end
-
   end
 end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.36'
+  VERSION = '0.0.37'
 end

metadata

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