cucumber-rest-bdd 0.5.3 → 0.6.0.pre.183

data/lib/cucumber-rest-bdd/url.rb

@@ -1,4 +1,7 @@
 def get_url(path)
     raise %/Please set an 'endpoint' environment variable provided with the url of the api/ if !ENV.has_key?('endpoint')
-    url = %/#{ENV['endpoint']}#{path}/
+    url = ENV['endpoint']
+    url = "#{url}/" unless url.end_with?("/")
+    url = "#{url}#{@urlbasepath}/" unless @urlbasepath.to_s.empty?
+    url = "#{url}#{path}" unless path.empty?
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-rest-bdd
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0.pre.183
 platform: ruby
 authors:
 - Harry Bragg
+- Matt Hosking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-api
@@ -16,21 +17,24 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: cucumber-expressions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +42,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.17
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: easy_diff
   requirement: !ruby/object:Gem::Requirement
@@ -55,32 +76,16 @@ dependencies:
 description: Series of BDD cucumber rules for testing API endpoints
 email:
 - harry.bragg@graze.com
+- Matt.Hosking@alintaenergy.com.au
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Dockerfile
-- LICENSE
-- Makefile
-- README.md
-- STEPS.md
-- cucumber-rest-bdd.gemspec
-- docker-compose.yml
-- features/errors.feature
-- features/functional.feature
-- features/grabs.feature
-- features/headers.feature
-- features/levels.feature
-- features/methods.feature
-- features/response.feature
-- features/status.feature
-- features/support/env.rb
-- features/types.feature
 - lib/cucumber-rest-bdd.rb
+- lib/cucumber-rest-bdd/data.rb
 - lib/cucumber-rest-bdd/hash.rb
 - lib/cucumber-rest-bdd/level.rb
+- lib/cucumber-rest-bdd/list.rb
 - lib/cucumber-rest-bdd/steps.rb
 - lib/cucumber-rest-bdd/steps/functional.rb
 - lib/cucumber-rest-bdd/steps/resource.rb
@@ -88,10 +93,7 @@ files:
 - lib/cucumber-rest-bdd/steps/status.rb
 - lib/cucumber-rest-bdd/types.rb
 - lib/cucumber-rest-bdd/url.rb
-- server/db.json
-- server/error.js
-- server/routes.json
-homepage: http://github.com/graze/cucumber-rest-bdd
+homepage: https://github.com/graze/cucumber-rest-bdd
 licenses:
 - MIT
 metadata: {}
@@ -106,12 +108,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: BDD Rest API specifics for cucumber

data/.gitignore

@@ -1,50 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.travis.yml

@@ -1,23 +0,0 @@
-language: shell
-sudo: required
-services:
-- docker
-install:
-- make build
-script:
-- make test
-deploy:
-  - provider: rubygems
-    api_key:
-      secure: obDis+hzVaV8Dk0i2V9bd3QiFhjdEpMZ6SxmTWDnbLcnYuhJyY7VPO3Jk9hINAWZPxH//uByVT+5p2r3YpmKUQxxoMtqJ7R8+aybfvlrDC9ZNoyE6lYF/Ysnj03pXMA5qwfqXt5ZVZuMvqAUj8J3sQBRSFwq7f/tlsAQdG1nowPL9lkxqOE++z+WvMvzkTs4x2RosrBg81eFNiCe0XKUXQGFbIneUA34Xjf/Mg+dls0UckyKBJO/3yoq3aCjYAaMGeA0UtfXwVqBdv7xhv8edzuJwbwrnstgQmwk6pR6XVIPff8wqHvRMHRXcFlPvRYv9WW4/CIxi6nvdpSlgeVXs9q1I22Z7f5sJy0As41wLoG95NVokqb2tFRz7ZwZU6tFNsJvK2tO8Bas0Gx6KTTThb2NTNdWQFczYBI/ERtYUB9qVRVlPDsK+iLRmFLi71H50aSbwnuXGEAfinXRmXvpLgPe1ZMYxMq+uz/ETBpCBfD26FQm3ieXIEb92GG7eswbIyv/LktCglEhNXR6FImqf1Ni2OOSXskJH+DTGnOkDHVFq5AhGQ8MtvJdsnJdm4p3PKzddzMPJ58cTwDOEd4uq7uNR/PGtE1w5FE3FNVIXr5ny1f9CpDwMpLL9xQ/AbgV9bJxBzqseBvXhn3HondJyZld1rfiUopvz/XGrydRvAo=
-    gem: cucumber-rest-bdd
-    on:
-      branch: master
-      repo: graze/cucumber-rest-bdd
-  - provider: rubygems
-    api_key:
-      secure: obDis+hzVaV8Dk0i2V9bd3QiFhjdEpMZ6SxmTWDnbLcnYuhJyY7VPO3Jk9hINAWZPxH//uByVT+5p2r3YpmKUQxxoMtqJ7R8+aybfvlrDC9ZNoyE6lYF/Ysnj03pXMA5qwfqXt5ZVZuMvqAUj8J3sQBRSFwq7f/tlsAQdG1nowPL9lkxqOE++z+WvMvzkTs4x2RosrBg81eFNiCe0XKUXQGFbIneUA34Xjf/Mg+dls0UckyKBJO/3yoq3aCjYAaMGeA0UtfXwVqBdv7xhv8edzuJwbwrnstgQmwk6pR6XVIPff8wqHvRMHRXcFlPvRYv9WW4/CIxi6nvdpSlgeVXs9q1I22Z7f5sJy0As41wLoG95NVokqb2tFRz7ZwZU6tFNsJvK2tO8Bas0Gx6KTTThb2NTNdWQFczYBI/ERtYUB9qVRVlPDsK+iLRmFLi71H50aSbwnuXGEAfinXRmXvpLgPe1ZMYxMq+uz/ETBpCBfD26FQm3ieXIEb92GG7eswbIyv/LktCglEhNXR6FImqf1Ni2OOSXskJH+DTGnOkDHVFq5AhGQ8MtvJdsnJdm4p3PKzddzMPJ58cTwDOEd4uq7uNR/PGtE1w5FE3FNVIXr5ny1f9CpDwMpLL9xQ/AbgV9bJxBzqseBvXhn3HondJyZld1rfiUopvz/XGrydRvAo=
-    gem: cucumber-rest-bdd
-    on:
-      tags: true
-      repo: graze/cucumber-rest-bdd

data/Dockerfile

@@ -1,24 +0,0 @@
-FROM ruby
-
-MAINTAINER "Harry Bragg <harry.bragg@graze.com>"
-LABEL version="0.5.3" \
-      license="MIT"
-
-COPY . /usr/local/cucumber-rest-bdd
-WORKDIR /usr/local/cucumber-rest-bdd
-
-RUN gem build cucumber-rest-bdd.gemspec \
-    && gem install cucumber-rest-bdd-*.gem \
-    && rm -rf /usr/local/cucumber-rest-bdd
-
-WORKDIR /opt/src
-
-ENV field_separator=_
-ENV field_camel=false
-ENV resource_single=false
-ENV cucumber_api_verbose=false
-ENV data_key=
-ENV error_key=error
-ENV set_parent_id=false
-
-CMD ["cucumber"]

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 graze.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Makefile

@@ -1,15 +0,0 @@
-TAG := graze/cucumber-rest-bdd
-RUN := docker run --rm -it -v $(PWD):/opt/src -w /opt/src ${TAG}
-
-build:
-	docker-compose build runner
-
-test: start-test-server
-	docker-compose run --rm runner cucumber --order random --format progress
-	make stop-test-server > /dev/null 2>&1 &
-
-start-test-server: stop-test-server
-	docker-compose up -d test-server
-
-stop-test-server:
-	docker-compose stop test-server

data/README.md

@@ -1,338 +0,0 @@
-# Cucumber Rest BDD
-
-[![Build Status](https://travis-ci.org/graze/cucumber-rest-bdd.svg?branch=master)](https://travis-ci.org/graze/cucumber-rest-bdd)
-[![](https://images.microbadger.com/badges/image/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own image badge on microbadger.com")
-[![](https://images.microbadger.com/badges/version/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own version badge on microbadger.com")
-[![](https://images.microbadger.com/badges/license/graze/cucumber-rest-bdd.svg)](https://microbadger.com/images/graze/cucumber-rest-bdd "Get your own license badge on microbadger.com")
-[![Gem Version](https://badge.fury.io/rb/cucumber-rest-bdd.svg)](https://badge.fury.io/rb/cucumber-rest-bdd)
-
-A set of Behavioural tests that can be run against a REST API.
-
-![Giphy](https://media3.giphy.com/media/Tv7VPg6Os488g/giphy.gif)
-
-This is based from: http://gregbee.ch/blog/effective-api-testing-with-cucumber
-
-A list of [Steps](STEPS.md) shows the comparison between Behavioural and Functional tests provided by this package.
-
-## Usage
-
-You can include this as a gem in your features, or run directly through docker
-
-**Gem:**
-
-```bash
-$ gem install cucumber-rest-bdd
-```
-
-**Docker:**
-```bash
-$ docker run --rm -v $(pwd):/opt/src -e endpoint=http://server/ graze/cucumber-rest-bdd
-```
-
-## Configuration
-
-The following environment variables modify how this will operate:
-
-- `endpoint` - (string) the base url to call for each request
-- `data_key` - (string) the root data key (if applicable) (for example: `"data"` if all responses have a `{"data":{}}` field)
-- `error_key` - (string) this will ignore the `data_key` when checking for errors
-- `field_separator` - (string) the separator used between words by the api
-- `field_camel` - (bool [`true`|`false`]) does this endpoint use camelCase for fields (default: `false`)
-- `resource_single` - (bool [`true`|`false`]) if each resource should be singularized or not (default: `false`)
-- `set_parent_id` - (bool [`true`|`false`]) when creating sub resources, automatically add parent ids
-
-## Examples
-
-- For a full list of steps see: [STEPS](STEPS.md)
-- These examples are taken from the test [features](features)
-
-### Retrieve items
-
-```gherkin
-Given I am a client
-When I request the post "1"
-Then the request was successful
-And the response has the following attributes:
-    | attribute | type    | value |
-    | User Id   | numeric | 1     |
-    | Id        | numeric | 1     |
-    | Title     | string  | sunt aut facere repellat provident occaecati excepturi optio reprehenderit |
-    | Body      | string  | quia et suscipit\\nsuscipit recusandae consequuntur expedita et cum\\nreprehenderit molestiae ut ut quas totam\\nnostrum rerum est autem sunt rem eveniet architecto |
-```
-
-```gherkin
-Given I am a client
-When I request the photo "1" for album "1" for user "1"
-Then the request was successful
-And the response has the attributes:
-    | attribute | type   | value                                              |
-    | title     | string | accusamus beatae ad facilis cum similique qui sunt |
-```
-
-```gherkin
-Given I am a client
-When I request a list of posts with:
-    | User Id | 2 |
-Then the request is successful
-And the response is a list of at least 2 posts
-And one response has the following attributes:
-    | attribute | type    | value |
-    | User Id   | numeric | 2     |
-    | Id        | numeric | 11    |
-    | Title     | string  | et ea vero quia laudantium autem |
-    | Body      | string  | delectus reiciendis molestiae occaecati non minima eveniet qui voluptatibus\\naccusamus in eum beatae sit\\nvel qui neque voluptates ut commodi qui incidunt\nut animi commodi |
-```
-
-You can inspect child objects by using `:` in between the names
-
-```gherkin
-Given I am a client
-When I request the comment "1" with:
-    | `_expand` | post |
-Then the response has the following attributes:
-    | attribute    | type   | value |
-    | name         | string | id labore ex et quam laborum |
-    | email        | string | Eliseo@gardner.biz |
-    | body         | string | laudantium enim quasi est quidem magnam voluptate ipsam eos\\ntempora quo necessitatibus\\ndolor quam autem quasi\\nreiciendis et nam sapiente accusantium |
-    | post : title | string | sunt aut facere repellat provident occaecati excepturi optio reprehenderit |
-    | post : body  | string | quia et suscipit\\nsuscipit recusandae consequuntur expedita et cum\\nreprehenderit molestiae ut ut quas totam\\nnostrum rerum est autem sunt rem eveniet architecto |
-```
-
-Alternatively you can inspect child arrays and objects by describing the path of the object with attributes
-
-```gherkin
-Given I am a client
-When I set JSON request body to:
-    """
-    {"title":"test","body":"multiple",
-    "comments":[
-        {"common":1,"id":1,"title":"fish","body":"cake","image":{"href":"some_url"}},
-        {"common":1,"id":2,"title":"foo","body":"bar","image":{"href":"some_url"}}
-    ]}
-    """
-And I send a POST request to "http://test-server/posts"
-Then the response has the attributes:
-    | attribute | type   | value    |
-    | title     | string | test     |
-    | body      | string | multiple |
-And the response has a list of comments
-And the response has a list of 2 comments
-And the response has two comments with attributes:
-    | attribute | type    | value |
-    | common    | integer | 1     |
-And the response has two comments with an image with attributes:
-    | attribute | type    | value    |
-    | href      | string  | some_url |
-And the response has one comment with attributes:
-    | attribute | type    | value |
-    | Id        | integer | 1     |
-    | Title     | string  | fish  |
-    | Body      | string  | cake  |
-And the response has one comment with attributes:
-    | attribute | type    | value |
-    | Id        | integer | 2     |
-    | Title     | string  | foo   |
-    | Body      | string  | bar   |
-```
-
-Each numeric request can be prefixed with a modifier to modify the number specified
-
-```gherkin
-Given I am a client
-When I request a list of posts with:
-    | `_embed` | comments |
-Then the response is a list of posts
-Then the response is a list of more than 5 posts
-Then the response is a list of at least 10 posts
-Then more than three posts have the attributes:
-    | attribute | type    | value |
-    | User Id   | integer | 5     |
-Then less than 200 posts have more than four comments
-Then more than 50 posts have less than six comments
-Then more than 80 posts have a list of comments
-Then at least 90 posts have a list of five comments
-Then more than 10 posts have five comments
-Then less than 200 posts have five comments
-```
-
-#### Errors
-
-If the `error_key` environment variable is set, if that key is used as the initial step it will ignore any `data_key`
-setting.
-
-Example: `error_key=error`, `data_key=data`
-
-```gherkin
-Then the response has a list of posts       | {"data":[{"id": 12}]}
-
-Then the response has one error             | {"errors":[{"message": "Error"}]}
-
-Then the response has an error              | {"error": {"message": "Error}}
-```
-
-Example: `error_key=`, `data_key=data`
-
-```gherkin
-Then the response has a list of posts       | {"data":[{"id": 12}]}
-
-Then the response has one error             | {"data": {"errors":[{"message": "Error"}]}}
-
-Then the response has an error              | {"data": {"error": {"message": "Error}}}
-```
-
-### Creation
-
-```gherkin
-Given I am a client
-When I request to create a post with:
-    | attribute | type    | value |
-    | Title     | string  | foo   |
-    | Body      | string  | bar   |
-    | User Id   | numeric | 1     |
-Then the request is successful and a post was created
-And the response has the following attributes:
-    | attribute | type    | value |
-    | User Id   | numeric | 1     |
-    | Title     | string  | foo   |
-    | Body      | string  | bar   |
-```
-
-If the environment variable: `set_parent_id` is set to `true` then when you create sub resources it will add the level aboves id into the json, otherwise it will rely on the api to do it for you
-
-```gherkin
-Given I am a client
-When I request to create a photo in album "2" for user "1" with:
-    | attribute | type   | value |
-    | title     | string | foo   |
-Then the comment was created
-And the response has the attributes:
-    | attribute | type   | value |
-    | Album Id  | int    | 2     |
-    | Title     | string | foo   |
-When I request a list of photos for album "2" for user "1"
-Then the request was successful
-And one comment has the attributes:
-    | attribute | type   | value |
-    | Title     | string | foo   |
-```
-
-### Removal
-
-```gherkin
-Given I am a client
-When I request to remove the post "20"
-Then the request is successful
-```
-
-### Modification
-
-```gherkin
-Given I am a client
-When I request to modify the post "21" with:
-    | attribute | type    | value |
-    | Title     | string  | foo   |
-Then the request is successful
-And the response has the following attributes:
-    | attribute | type    | value |
-    | User Id   | numeric | 3     |
-    | Title     | string  | foo   |
-    | Body      | string  | repellat aliquid praesentium dolorem quo\\nsed totam minus non itaque\\nnihil labore molestiae sunt dolor eveniet hic recusandae veniam\\ntempora et tenetur expedita sunt |
-```
-
-### Multiple Requests
-
-```gherkin
-Given I am a client
-When I request to create a post with:
-    | attribute | type    | value |
-    | Title     | string  | foo   |
-    | Body      | string  | bar   |
-    | User Id   | integer | 12    |
-Then the request is successful
-When I save "id"
-And I request the post "{id}"
-Then the request is successful
-And the response has the following attributes:
-    | attribute | type    | value |
-    | Title     | string  | foo   |
-    | Body      | string  | bar   |
-    | User Id   | numeric | 12    |
-    | Id        | numeric | {id}  |
-```
-
-## Resources
-
-A resource "name" is attempted to be retrieved from the given name of the item to be retrieved. This pluralises, ensures everything is lower case, removes any unparameterisable characters and uses a `-` separator.
-
-```
-Token -> tokens
-User -> users
-Big Life -> big-lifes
-octopus -> octopi
-```
-
-If the environment variable: `resource_single` is set to `true` then it will not attempt to pluralise the resources.
-
-```
-Token -> token
-User -> user
-```
-
-You can directly pass what you want using:
-```
-`field`
-```
-this will not modify the field.
-
-## Attributes
-
-### Types
-
-Attribute types:
-The following types are supported:
-
-| type    | other names           | example   |
-|---------|-----------------------|-----------|
-| integer | numeric, number, long | 12        |
-| float   | double, decimal       | 4.8       |
-| string  | text                  | "text"    |
-| array   | array                 | ["a"]     |
-| object  | object                | {"a":"b"} |
-| null    | nil                   |           |
-| bool    | boolean               | true      |
-
-### Name conversion
-
-attributes are converted into singular parametrised versions of the provided name:
-
-The conversion is based on the provided environment variables `field_camel` and `field_separator`
-
-**Default**
-```
-field_camel=false
-field_separator=_
-
-Someid -> someid
-Product Id -> product_id
-Bodies -> body
-```
-
-**CamelCase**
-```
-field_camel=true
-field_separator=_
-
-Someid -> someid
-Product Id -> productId
-Bodies -> body
-```
-
-**Other separator**
-```
-field_camel=false
-field_separator=-
-
-Someid -> someid
-Product Id -> product-id
-Bodies -> body
-```