soaspec 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56ac205ff7703289265257468f900434409c01a9
-  data.tar.gz: 484529924c2c37a100e95670ce57e1d3e136b07e
+  metadata.gz: 1c1e38e1213ce6461e1bca9a181d6be4130295a4
+  data.tar.gz: 9e2170b74242c21f8c9ac3fe51fccf5676a4db49
 SHA512:
-  metadata.gz: feae39ed4711cdf52ad5f1090e143af59e12dfb565c569ae5e864242692bf029fe132ec58279f52f430d3c7f456d773e8d2958736fd7836c14bda5b8cca72f17
-  data.tar.gz: b2c63f622cecd0e6e39eb7b6ae9a2a432a9aafbd02b2fa8cf6bce1ed0355c5c75888f7518b606c16775beeef6f5071fccb2a1b3e5cd95887d36414b531569767
+  metadata.gz: 9c41202a31e2e2740688628efada58bb0631cd91b5f1b60f624219d0f254c1cb5e823f00d2ea2451f16890b8059594fe8add22c9db4cb4d4db3acca8f06dcd90
+  data.tar.gz: 76bbf2ad8ba5a5e1333cb33653ba45220c9dcca5d8257b7e5c235dc849dfd85ea0b5783d3e1100ee7b606c3072a9cf95c5e4e362e91ba2b4f3c1a8586ccb0d05

data/.gitlab-ci.yml

@@ -18,6 +18,23 @@ cucumber:
   script:
     - bundle exec cucumber
 
+code_quality:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [gl-code-quality-report.json]
+
 pages:
   stage: deploy
   dependencies:

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.1.3
+* Enhancements
+  * Ability to set template folder
+  * Json Path handle multiple paths separated by commas
+
 Version 0.1.1
 * Enhancements
   * Added ability to turn off logs (helpful if making a lot of API calls)

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ## Getting Started
 
-To create a new test suite using this you can use the 'soaspec-init' binary.
+To create a new test suite using this you can use the 'soaspec' binary.
 
 Example:
 
@@ -51,10 +51,38 @@ for such defaults. When describing an API override this in 'savon_options' metho
 
 See specs for example of usage. This will be added to later. 
 
-### Recommended
+Basically you create a class inheriting from a ‘Handler’ class for each web service that’s tested.
+In this class you define the common parameters used for testing this class.
+
+For example:
+
+```ruby
+class PuppyService < Soaspec::RestHandler
+
+  headers accept: 'application/json', content_type: 'application/json'
+
+  base_url 'http://petstore.swagger.io/v2/pet'
+
+  element :id, :id
+  element :category_id, '$..category.id'
+end
+```
+
+Then you reference this class in creating `Exchange`’s (representing a request / response pair).
+Upon initialization of the Exchange object or later on through setters, parameters specific to this request are set
+All getters of the Exchange are on the response & will implicitly trigger the API request to be made.
+
+For example:
+
+```ruby
+context PuppyService.new('Order Puppies') do
+  describe post(:create_pet, body: { status: 'sold' }) do # Post with status as sold in request
+    its(['status']) { is_expected.to eq 'sold' } # Check responses status is sold
+  end
+end
+```
 
-It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
-that class. See 'weather_web_service.rb' class in spec/soaspec/soap folder for example.
+### Recommended
 
 If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the 
 backtrace.

data/lib/soaspec.rb

@@ -32,9 +32,13 @@ require 'soaspec/wsdl_generator'
 # Gem for handling SOAP and REST api tests
 module Soaspec
 
+  @template_folder = 'template'
+
   class << self
     # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
     attr_writer :debug_oauth
+    # Folder used to store templates for API calls
+    attr_accessor :template_folder
 
     # Folder used to store credentials
     # Used in auth2_file command
@@ -75,6 +79,11 @@ module Soaspec
       @debug_oauth || false
     end
 
+    # @return [String] Folder used to store templates for API calls
+    # def template_folder
+    #   @template_folder || 'template'
+    # end
+
     # Whether to log all API traffic
     def log_api_traffic=(set)
       @log_api_traffic = set

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -229,9 +229,12 @@ module Soaspec
         return result.inner_text if attribute.nil?
         return result.attributes[attribute].inner_text
       when :json
-        matching_values = json_path_values_for(response, path, attribute: attribute)
-        raise NoElementAtPath, "Element in #{response.body} not found with path '#{path}'" if matching_values.empty?
-        matching_values.first
+        paths_to_check = path.split(',')
+        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, "Path '#{path}' not found 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
@@ -273,7 +276,7 @@ module Soaspec
       if test_values[:body]
         test_values[:payload] = JSON.generate(hash_used_in_request(test_values[:body])).to_s
       elsif @request_option == :template
-        request_body = File.read('template/' + template_name)
+        request_body = File.read(File.join(Soaspec.template_folder, template_name))
         ERB.new(request_body).result(binding)
       else
         test_values[:payload]

data/lib/soaspec/exchange_handlers/soap_handler.rb

@@ -101,7 +101,7 @@ module Soaspec
       test_values = request_body_params request_parameters
       begin
         if @request_option == :template
-          request_body = File.read('template/' + template_name)
+          request_body = File.read(File.join(Soaspec.template_folder, template_name))
           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

data/lib/soaspec/not_found_errors.rb

@@ -1,4 +1,3 @@
-
 # Raised to represent when there's no element at an Xpath
 class NoElementAtPath < StandardError
   def initialize(msg = 'No element at path found')
@@ -11,4 +10,4 @@ class NoElementInHash < StandardError
   def initialize(msg = 'No element in Hash found')
     super
   end
-end
+end

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler