soaspec 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a6648e0e02510021fd5341416a75bb8f97db36
-  data.tar.gz: f87ce73642f1d37186a76aeaa9a6fdffd2aaf1e9
+  metadata.gz: a446e205c6a72dceb41dada3f7b910587629e0c0
+  data.tar.gz: f827d2d372ff408503f1111175b78cfa028a845f
 SHA512:
-  metadata.gz: a4a89d0b12f41915e3a47149521f20a3eeea9175b228208aa9d09d5f050628639fd57d351a1cdbd535efa5a9119545ffb58ca577c0d5aed494aeeb3ddd17b6d9
-  data.tar.gz: 3cabefa3e283c9c01260cbc025fb87ff9fa8327b7dec70ca3bf82e00a7019e11f21f615ab23c46b607144a0dd86415f8abdb8de75565fb21bc648ac3521c3f33
+  metadata.gz: 6cc6e07e30560774e7b5e9c9568bc15941df4cdfbb19102c97e322e53ffb3826d9d34d8e91cbb9182deb6745c710d23fef24dfb9d1c81688ae13131066f7f2e3
+  data.tar.gz: dee062b10eafcef1e52c96137108b4bdc0013d633e2871d9a85227e116580939144466b87ddd9f025f27c4b44e22e0d49b70c52ba94e8652e7172f3d881c9ccb

data/.gitlab-ci.yml

@@ -1,8 +1,9 @@
+image: ruby:2.5
+
 before_script:
-#  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
   - ruby -v
   - which ruby
-  - gem install bundler rake --no-ri --no-rdoc
+  - gem install bundler rake
   - bundle install --jobs $(nproc)  "${FLAGS[@]}"
 
 rspec:
@@ -19,7 +20,7 @@ cucumber:
     - bundle exec cucumber
 
 code_quality:
-  image: docker:stable
+  image: ruby:2.5
   variables:
     DOCKER_DRIVER: overlay2
   allow_failure: true

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.2.8
+* Bug Fix
+  * RSpec-its dependency produces a conflict. Remove specific version reference
+
 Version 0.2.7
 * Bug Fix
   * Fix log issue that was failing in Windows

data/README.md

@@ -3,14 +3,14 @@
 This gem helps to represent multiple API tests against a backend briefly, concisely and clearly.
 It is essentially a wrapper around the Savon and RestClient gems, adding useful functionality including
 
-* Creating multiple API calls from the same base configuration through the use of an `ExchangeHandler`
+* Creating multiple API calls from the same base configuration through the use of an `ExchangeHandler` class
 * Extracting values from response body's through either `XPath` or `JSONPath`
-* Building up a custom RSpec `success scenario` shared example to repeatedly writing the same tests
-* Methods making setting and extracting values from a `Request/Response` pair (`Exchange`) easy
+* Building up a custom RSpec `success scenario` shared example to reuse common tests on an API
+* Methods simplifying setting and extracting values from a `Request/Response` pair (`Exchange`)
 * Waiting for a particular response from an API by polling it
-* Way of abstracting paths to values from a response with business-meaningful method names
-* Generating initial code for an API with `soaspec new`
-* Way of accessing and using an `oauth2` access token
+* Representing paths to values from a response with business-meaningful method names
+* Generating initial code for testing an API with `soaspec new`
+* Accessing and utilising `oauth2` access tokens
 * Hosting a `virtual_server` that simulates REST & SOAP responses from an API
 
 [![Build Status](https://gitlab.com/samuel-garratt/soaspec/badges/master/build.svg)](https://gitlab.com/samuel-garratt/soaspec/pipelines)
@@ -60,12 +60,12 @@ You can also use `soaspec generate` to generate a set of tests from a WSDL. This
 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](specs) and [features](features) for example of usage.
+See [spec](spec) and [features](features) for example of usage.
 
 ### ExchangeHandler
 
-To start with a class inheriting from a ‘Handler’ class for each web service that’s tested needs to be created.
-In this class you define the common parameters used for testing this class.
+To start with, create a class inheriting from a ‘Handler’ class for each web service that needs testing.
+In this class you define the common parameters used for testing it.
 
 For example:
 
@@ -82,13 +82,16 @@ class PuppyService < Soaspec::RestHandler
 end
 ```
 
+> You can easily create a exchange handler with the `soaspec add` command. This will also add comments explaining common methods that can be used
+
 ### Exchange
 
-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.
-Once this request has been made, all following accessors of the response will just use the previous request made.
+After creating the `ExchangeHandler`, you reference this class in creating `Exchange`s (objects that each represent a request / response pair).
+Upon initialization of the Exchange object (or later on through setters), parameters specific to this request are set.
+Most getters of the `Exchange` are on the response & will implicitly trigger the API request to be made.
+Once this request has been made, all following accessors of the response will just use the response of the previous request made.
 
+For example, to create a http post using the above `ExchangeHandler` and extract a value from the response body using JSON PATH.
 ```ruby
 exchange = PuppyService.post(body: { status: 'sold' }) # The 'body' key will convert it's value from a Hash to JSON
 # Create a new Exchange that will post to 'http://petstore.swagger.io/v2/pet' with JSON { "status": "sold" }
@@ -96,8 +99,8 @@ exchange.category_id
 # This will trigger the request to be made & return a value at JSON path $..category.id, throwing an exception if not found
 ```
 
-See [Request Body Parameters](wikis/RequestBodyParameters) for more details on setting a request body.
-See [Creating an Exchange](wikis/CreatingExchange) for details on how to create an Exchange.
+See [Request Body Parameters](https://gitlab.com/samuel-garratt/soaspec/wikis/RequestBodyParameters) for more details on setting a request body.
+See [Creating an Exchange](https://gitlab.com/samuel-garratt/soaspec/wikis/CreatingExchange) for details on how to create an Exchange.
 
 ### RSpec
 
@@ -128,15 +131,15 @@ end
 If you're using `Cucumber` then I would recommend the following
 
 In the `Given` (or background) specify the `Exchange` object.
-Either store this as an instance variable (e.g `@exchange`) or use the global `Soaspec.last_exchange`
+Either store this as an instance variable (e.g `@exchange`) or use the global `Soaspec.last_exchange` (which is automatically set).
 
-In the `When` use the `call` method to make the request `@exchange.call`
+In the `When`, use the `call` method to make the request `@exchange.call`. If problems occur in making the request this should separate such failures from issues with the response.
 
-In the `Then` make the assertions from the `@exchange` object.
+In the `Then`, make the assertions from the `@exchange` object.
 E.g
 ```ruby
 expect(@exchange['message']).to include 'success'
-expect(@exchange.status_code).to eq true
+expect(@exchange.status_code).to eq 200
 ```
 
 ## Development

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.2.8'.freeze
 end

data/soaspec.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'soaspec/version'
@@ -9,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['SamuelGarrattIQA']
   spec.email         = ['samuel.garratt@integrationqa.com']
 
-  spec.summary       = "Helps to create RSpec specs for 'SOAP' or 'REST' apis "
-  spec.description   = "Helps to create RSpec specs for 'SOAP' or 'REST' apis. Easily represent multiple requests with
-the same configuration "
+  spec.summary       = "Helps to create tests for 'SOAP' or 'REST' apis "
+  spec.description   = "Helps to create tests for 'SOAP' or 'REST' apis. Easily represent multiple requests with
+the same configuration. Examples designed for RSpec and Cucumber."
   spec.homepage      = 'https://gitlab.com/samuel-garratt/soaspec'
   spec.license       = 'MIT'
 
@@ -38,7 +37,7 @@ the same configuration "
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'rest-client', '>= 2.0' # REST
   spec.add_dependency 'rspec', '~> 3.0' # This framework is designed to work with RSpec
-  spec.add_dependency 'rspec-its', '>= 1.2.0'
+  spec.add_dependency 'rspec-its'
   spec.add_dependency 'savon', '>= 2' # SOAP
   spec.add_dependency 'sinatra'
   spec.add_dependency 'sinatra-basic-auth'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -332,8 +332,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
-description: "Helps to create RSpec specs for 'SOAP' or 'REST' apis. Easily represent
-  multiple requests with\nthe same configuration "
+description: |-
+  Helps to create tests for 'SOAP' or 'REST' apis. Easily represent multiple requests with
+  the same configuration. Examples designed for RSpec and Cucumber.
 email:
 - samuel.garratt@integrationqa.com
 executables:
@@ -436,5 +437,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Helps to create RSpec specs for 'SOAP' or 'REST' apis
+summary: Helps to create tests for 'SOAP' or 'REST' apis
 test_files: []