soaspec 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f25cdd5470680bb035c2296f5b29dba6afe1aef
-  data.tar.gz: 7a0b0c4c47d201e2025e8bd702ef208c701c410b
+  metadata.gz: 2d67dcecc12aa7ed80c4064617ae5b4edf939c38
+  data.tar.gz: d38ea5011a5668761890aa5b66b93e8703f385cc
 SHA512:
-  metadata.gz: 5f843a8d1775bf6149e398008197225ada75c282693f543ec819ca3cab14d4267316a930256523686bfbef2470d723d0cfc1b45a278e46ded94b07ef5778051a
-  data.tar.gz: 03b8333eddee14dcd7d65415bf390c571fe2079c4f77ec410385d5fde7b101e7dd65cc69309661a67df0ccfbfca413df5729b86fe697b2a8ec1499df62509361
+  metadata.gz: 445f7ce4e2883bbbe784a9e2b672860f90f68c46ad9b3b2e39659efd6c81375b646fe51a5b147df5b30e807f08628b52d6a276031314901519e7d9fe1f5dbd43
+  data.tar.gz: 8531ebc72ae98481f5d2b701b6ef719cc8ad77a94297b33469cdcb3a7ada81e4a11f21b5075e05d2e7c83bd81fe5a173fcfe520179abaa2c68fb275d5da4f24c

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.18
+* Enhancements
+  * Define 'exchange' method on response object so original exchange can be accessed
+  * Make simply approach for setting body of request with just a string passed `ExchangeHandler.post(message_body)` where message_body is not
+    a `Hash` but a `String`
+
 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 }`

data/README.md

@@ -1,6 +1,17 @@
 # Soaspec
 
-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. Note it is still in early stages of development.
+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`
+* 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
+* 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
+* 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)
 [![Coverage](https://gitlab.com/samuel-garratt/soaspec/badges/master/coverage.svg)](https://samuel-garratt.gitlab.io/soaspec)
@@ -49,28 +60,46 @@ 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 for example of usage. This will be added to later. 
+See [specs](specs) and [features](features) for example of usage.
 
-Basically you create a class inheriting from a ‘Handler’ class for each web service that’s tested.
+### 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.
 
 For example:
 
 ```ruby
+# Classes are set up through inheriting from either `Soaspec::RestHandler` or `Soaspec::SoapHandler`
 class PuppyService < Soaspec::RestHandler
 
-  headers accept: 'application/json', content_type: 'application/json'
+  headers accept: 'application/json', content_type: 'application/json' # Set default headers for all `Exchanges` using this class
 
-  base_url 'http://petstore.swagger.io/v2/pet'
+  base_url 'http://petstore.swagger.io/v2/pet' # URL for which all requests using this class will start with
 
-  element :id, :id
-  element :category_id, '$..category.id'
+  element :id, :id # Define a method 'id' that can be obtained with either XPATH '//id' or JSONPath '$..id'
+  element :category_id, '$..category.id' # Define method to obtain a category id through JSON Path
 end
 ```
 
+### 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.
+
+```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" }
+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.
+
+### RSpec
 
 For example:
 
@@ -82,9 +111,9 @@ context PuppyService.new('Order Puppies') do
 end
 ```
 
-### Recommended
+#### Tips
 
-If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the 
+If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the
 backtrace.
 
 RSpec.configure do |config|
@@ -94,6 +123,22 @@ RSpec.configure do |config|
   ]
 end
 
+### Cucumber
+
+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`
+
+In the `When` use the `call` method to make the request `@exchange.call`
+
+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
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Todo.md

@@ -7,5 +7,7 @@
 * 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
 * Handle proxies to record traffic for MiddleWare testing
-* Get wsdl generator working for non complex gems (Put on hold til new Savon version)
+* soaspec generate
+  * Get wsdl generator working for non complex gems (Put on hold til new Savon version)
+  * Generate from a RAML
 * Much more - please raise an issue for suggestion

data/lib/soaspec/exchange.rb

@@ -148,9 +148,12 @@ class Exchange
   # @example For SOAP it will be a Savon response
   #   response.body (body of response as Hash)
   #   response.header (head of response as Hash)
+  # @example For REST it will be a RestClient::Response
   def response
     Soaspec.last_exchange = self
     @response ||= make_request
+    @response.define_singleton_method(:exchange) { Soaspec.last_exchange } unless @response.respond_to?(:exchange)
+    @response
   end
 
   alias call response

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -285,6 +285,8 @@ module Soaspec
             params = case rest_method
                      when 'get', 'delete'
                        { suburl: params.to_s }
+                     when 'post', 'put', 'patch'
+                       { payload: params.to_s }
                      else
                        params
                      end

data/lib/soaspec/version.rb

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

metadata

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