cucumber-rest-bdd 0.3.6 → 0.4.0.pre.107

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd1abd3c2538bdf0c32fc94daf9d4cdf61b928d8
-  data.tar.gz: 6c5bc5781281a5b2027ee0dc868adc79bda06cdc
+  metadata.gz: 7bd9df6fe6b0ed73ad283c752d2e38df0d32c020
+  data.tar.gz: 320037080282cf11d62ea58f8dd08c0ef044943e
 SHA512:
-  metadata.gz: 52c3d547a50e345b7b3b4e4faff609252798f3b0423833430766a886eed86c55a238e3664926227161c27812abe958bd7e49893476412cb491c5559b07755c7d
-  data.tar.gz: 8f67cd63a6fe5f3b2efb5d246fb18e907b1619f764f952cf2495e1d8d53f380baeb03ba15c68c697c2a3bf12dad2974beb8da2910f9e0283d744d9d3eaf1cb00
+  metadata.gz: 762d3ff737827b4c43b10f468fda469f20309c7b11e57c722ce2b739c3a5f8bab14b55949e02af34b123612de03ced3ec620d50c3d198cbe59c77db89f6af975
+  data.tar.gz: 3f61671e6ec3e5f75dba30bcc180bae6fcf1aea471b12b7bf688101850442db5a113435d5705803cc80a048573bd9e02552811e98567f937f63ed0bb5ea83761

data/Dockerfile

@@ -1,6 +1,8 @@
 FROM ruby
 
 MAINTAINER "Harry Bragg <harry.bragg@graze.com>"
+LABEL version="0.4.0" \
+      license="MIT"
 
 COPY . /usr/local/cucumber-rest-bdd
 WORKDIR /usr/local/cucumber-rest-bdd
@@ -16,5 +18,6 @@ ENV field_camel=false
 ENV resource_single=false
 ENV cucumber_api_verbose=false
 ENV data_key=
+ENV set_parent_id=false
 
 CMD ["cucumber"]

data/README.md

@@ -4,6 +4,7 @@
 [![](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.
 
@@ -37,6 +38,7 @@ The following environment variables modify how this will operate:
 - `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
 
@@ -57,6 +59,15 @@ And the response has the following attributes:
     | 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:
@@ -160,6 +171,25 @@ And the response has the following attributes:
     | 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

data/STEPS.md

@@ -86,12 +86,12 @@ Then the request failed because I am unauthorised   Then the response status sho
 Then the request failed because it was forbidden    Then the response status should be "403"
 
 Then the request failed because the item was not    Then the response status should be "404"
-  found  
+  found
 
 Then the request failed because it was not allowed  Then the response status should be "405"
 
 Then the request failed because there was a         Then the response status should be "409"
-  conflict    
+  conflict
 
 Then the request failed because the item has gone   Then the response status should be "410"
 
@@ -127,7 +127,7 @@ Then two items have have the following attributes:  <N/A>
     | Body      | string  | bar   |
 
 Then more than two items have have the following    <N/A>
-    attributes:
+  attributes:
     | attribute | type    | value |
     | User Id   | integer | 12    |
     | Title     | string  | foo   |
@@ -148,6 +148,33 @@ When I save "User Id" as "user"                     When I grab "$.userId" as "u
 And I request the user "{user}"                     And I send a GET request to "http://url/users/{user}"
 ```
 
+### Nested requests
+
+```
+Behavioural                                         Functional
+--------------------------------------------------- --------------------------------------------------------------
+When I request a list of comments for post "1"      When I send a GET request to "http://url/posts/1/comments"
+
+When I request the comment "2" for post "3"         When I send a GET request to "http://url/posts/2/comments/3"
+
+When I request the photo "3" in album "4" for user  When I send a GET request to
+  "5"                                                 "http://url/users/5/albums/4/photos/3"
+
+When I request a list of photos in album "6" for    When I send a GET request to
+  user "7"                                            "http://url/users/7/albums/6/photos"
+
+When I request to create a comment for post "8"     When I send a POST request to "http://url/posts/8/comments"
+
+When I request to modify the comment "9" for post   When I send a PATCH request to
+  "10"                                                "http://url/posts/10/comments/9"
+
+When I request to set photo "11" in album "12" to:  When I set JSON request body to:
+    | attribute | type   | value                |       """
+    | url       | string | http://url/image.jpg |       {"url":"http://url/image.jpg"}
+                                                        """
+                                                    And I send a PUT request to "http://url/albums/12/photos/11"
+```
+
 ### Nested responses
 
 ```

data/cucumber-rest-bdd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'cucumber-rest-bdd'
-  s.version       = '0.3.6'
+  s.version       = '0.4.0'
   s.version       = "#{s.version}-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS'] && ENV['TRAVIS_TAG'] == ''
   s.platform      = Gem::Platform::RUBY
   s.date          = '2017-01-10'

data/docker-compose.yml

@@ -2,8 +2,9 @@ version: '2'
 services:
     test-server:
         image: clue/json-server
+        command: --routes /data/routes.json
         volumes:
-            - ./server/db.json:/data/db.json:ro
+            - ./server:/data:ro
 
     runner:
         image: graze/cucumber-rest-bdd
@@ -18,3 +19,4 @@ services:
             - field_camel=true
             - resource_single=false
             - data_key=
+            - set_parent_id=true

data/features/levels.feature

@@ -0,0 +1,121 @@
+Feature: Request multiple levels of REST api
+    As a user
+    I would like to query a url with multiple levels of depth
+    So that I can get all the data from this api
+
+    Background:
+        Given I am a client
+
+    Scenario: get single id from sub layer
+        When I request the comment "1" for post "1"
+        Then the request was successful
+        And the response has the attributes:
+            | attribute | type   | value |
+            | id        | int    | 1     |
+
+    Scenario: get list from sub layer
+        When I request a list of comments for post "1"
+        Then the request was successful
+        And the response is a list of more than 4 comments
+        And one comment has the attributes:
+            | attribute | type   | value |
+            | id        | int    | 1     |
+
+    Scenario: multiple sub levels
+        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 |
+
+    Scenario: request a list of multiple sub levels
+        When I request a list of photos for album "1" for user "1"
+        Then the request was successful
+        And the response is a list of more than 2 photos
+        And one photo has the attributes:
+            | attribute | type   | value                                              |
+            | title     | string | accusamus beatae ad facilis cum similique qui sunt |
+
+    Scenario: create a item as a child
+        When I request to create a comment for post "18" with:
+            | attribute | type   | value |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+        Then the comment was created
+        And the response has the attributes:
+            | attribute | type   | value |
+            | Post Id   | string | 18    |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+        When I request a list of comments for post "18"
+        Then the request was successful
+        And one comment has the attributes:
+            | attribute | type   | value |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+
+    Scenario: create a 2nd level child item
+        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   |
+
+    Scenario: delete a child item
+        When I request to delete the comment "91" for post "19"
+        Then the request was successful
+        When I request a list of comments for post "19"
+        Then the request was successful
+        And zero comments have the attributes:
+            | attribute | type | value |
+            | id        | int  | 91    |
+
+    Scenario: modify a child item
+        When I request to modify the comment "102" for post "21" with:
+            | attribute | type   | value |
+            | Name      | string | foo   |
+            | Body      | string | bar   |
+        Then the request was successful
+        And the response has the attributes:
+            | attribute | type   | value |
+            | Post Id   | int    | 21    |
+            | Name      | string | foo   |
+            | Body      | string | bar   |
+        When I request a list of comments for post "21"
+        Then the request was successful
+        And one comment has the attributes:
+            | attribute | type   | value |
+            | Name      | string | foo   |
+            | Body      | string | bar   |
+
+    Scenario: modify a child item
+        When I request to replace the comment "106" for post "22" with:
+            | attribute | type   | value |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+        Then the request was successful
+        And the response has the attributes:
+            | attribute | type   | value |
+            | Post Id   | int    | 22    |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+        When I request a list of comments for post "22"
+        Then the request was successful
+        And one comment has the attributes:
+            | attribute | type   | value |
+            | Title     | string | foo   |
+            | Body      | string | bar   |
+        When I request the comment "106"
+        Then the request was successful
+        And the response has the attributes:
+            | attribute | type   | value |
+            | Title     | string | foo   |
+            | Body      | string | bar   |

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

@@ -0,0 +1,47 @@
+require 'cucumber-rest-bdd/types'
+require 'active_support/inflector'
+
+LEVELS = %{(?: (?:for|in|on) [^"]+?(?: with (?:key|id))? "[^"]+")*}%
+
+class Level
+    @urls = []
+
+    def initialize(levels)
+        arr = []
+        while matches = /^ (?:for|in|on) ([^"]+?)(?: with (?:key|id))? "([^"]*)"/.match(levels)
+            levels = levels[matches[0].length, levels.length]
+            item = {
+                resource: get_resource(matches[1]),
+                id: matches[2]
+            }
+            item[:id] = item[:id].to_i if item[:id].match(/^\d+$/)
+            arr.append(item)
+        end
+        @urls = arr.reverse
+    end
+
+    def url
+        @urls.map{ |l| "#{l[:resource]}/#{l[:id]}/"}.join()
+    end
+
+    def hash
+        hash = {}
+        @urls.each{ |l| hash[get_parameter("#{get_parameter(l[:resource]).singularize}_id")] = l[:id] }
+        hash
+    end
+
+    def last_hash
+        last = @urls.last
+        if !last.nil?
+            key = get_parameter("#{get_parameter(last[:resource]).singularize}_id")
+            return {
+                key => last[:id]
+            }
+        end
+        return {}
+    end
+
+    def to_s
+        self.url
+    end
+end

data/lib/cucumber-rest-bdd/steps/resource.rb

@@ -3,6 +3,7 @@ require 'cucumber-api/steps'
 require 'active_support/inflector'
 require 'cucumber-rest-bdd/url'
 require 'cucumber-rest-bdd/types'
+require 'cucumber-rest-bdd/level'
 require 'cucumber-rest-bdd/hash'
 require 'easy_diff'
 
@@ -14,15 +15,15 @@ end
 
 # GET
 
-When(/^I request (?:an?|the) (.+?)(?: with (?:key|id))? "([^"]*)"$/) do |resource, token|
+When(/^I request (?:an?(?! list)|the) ([^"]+?)(?: with (?:key|id))? "([^"]*)"(#{LEVELS})?$/) do |resource, id, levels|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}/#{token}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}/#{id}")
     steps %Q{When I send a GET request to "#{url}"}
 end
 
-When(/^I request (?:an?|the) (.+?)(?: with (?:key|id))? "([^"]*)" with:$/) do |resource, token, params|
+When(/^I request (?:an?(?! list)|the) (.+?)(?: with (?:key|id))? "([^"]*)"(#{LEVELS})? with:$/) do |resource, id, levels, params|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}/#{token}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}/#{id}")
     unless params.raw.empty?
         query = params.raw.map{|key, value| %/#{get_parameter(key)}=#{resolve(value)}/}.join("&")
         url = "#{url}?#{query}"
@@ -30,15 +31,15 @@ When(/^I request (?:an?|the) (.+?)(?: with (?:key|id))? "([^"]*)" with:$/) do |r
     steps %Q{When I send a GET request to "#{url}"}
 end
 
-When(/^I request a list of ([^:]+)$/) do |resource|
+When(/^I request a list of ([^:]+?)(#{LEVELS})?$/) do |resource, levels|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}")
     steps %Q{When I send a GET request to "#{url}"}
 end
 
-When(/^I request a list of (.+) with:$/) do |resource, params|
+When(/^I request a list of (.+?)(#{LEVELS})? with:$/) do |resource, levels, params|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}")
     unless params.raw.empty?
         query = params.raw.map{|key, value| %/#{get_parameter(key)}=#{resolve(value)}/}.join("&")
         url = "#{url}?#{query}"
@@ -48,25 +49,37 @@ end
 
 # DELETE
 
-When(/^I request to (?:delete|remove) the (.+) "([^"]*)"$/) do |resource, token|
+When(/^I request to (?:delete|remove) the ([^"]+?) "([^"]*)"(#{LEVELS})?$/) do |resource, id, levels|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}/#{token}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}/#{id}")
     steps %Q{When I send a DELETE request to "#{url}"}
 end
 
 # POST
 
-When(/^I request to create an? ([^:]+?)$/) do |resource|
+When(/^I request to create an? ([^:]+?)(#{LEVELS})?$/) do |resource, levels|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}")
+    level = Level.new(levels)
+    if ENV['set_parent_id'] == 'true'
+        json = MultiJson.dump(level.last_hash)
+        steps %Q{
+            When I set JSON request body to:
+            """
+            #{json}
+            """
+        }
+    end
+    url = get_url("#{level.url}#{resource_name}")
     steps %Q{When I send a POST request to "#{url}"}
 end
 
-When(/^I request to create an? ([^"]+?) with:$/) do |resource, params|
+When(/^I request to create an? ((?!<.+?(?: for | in | on ))[^"]+?)(#{LEVELS})? with:$/) do |resource, levels, params|
     resource_name = get_resource(resource)
     request_hash = get_attributes(params.hashes)
+    level = Level.new(levels)
+    request_hash = request_hash.merge(level.last_hash) if ENV['set_parent_id'] == 'true'
     json = MultiJson.dump(request_hash)
-    url = get_url("#{resource_name}")
+    url = get_url("#{level.url}#{resource_name}")
     steps %Q{
         When I set JSON request body to:
             """
@@ -78,19 +91,31 @@ end
 
 # PUT
 
-When(/^I request to (?:create|replace) (?:an?|the) ([^"]+?)(?: with (?:key|id))? "([^"]+)"$/) do |resource, id|
+When(/^I request to (?:create|replace) (?:an?|the) ((?![^"]+?(?: for | in | on ))[^"]+?)(?: with (?:key|id))? "([^"]+)"(#{LEVELS})?$/) do |resource, id, levels|
     resource_name = get_resource(resource)
-    url = get_url("#{resource_name}/#{id}")
+    level = Level.new(levels)
+    if ENV['set_parent_id'] == 'true'
+        json = MultiJson.dump(level.last_hash)
+        steps %Q{
+            When I set JSON request body to:
+            """
+            #{json}
+            """
+        }
+    end
+    url = get_url("#{level.url}#{resource_name}/#{id}")
     steps %Q{
         When I send a PUT request to "#{url}"
     }
 end
 
-When(/^I request to (?:create|replace) (?:an?|the) ([^"]+?)(?: with (?:key|id))? "([^"]+)" with:$/) do |resource, id, params|
+When(/^I request to (?:create|replace|set) (?:an?|the) ((?![^"]+?(?: for | in | on ))[^"]+?)(?: with (?:key|id))? "([^"]+)"(#{LEVELS})? (?:with|to):$/) do |resource, id, levels, params|
     resource_name = get_resource(resource)
     request_hash = get_attributes(params.hashes)
+    level = Level.new(levels)
+    request_hash = request_hash.merge(level.last_hash) if ENV['set_parent_id'] == 'true'
     json = MultiJson.dump(request_hash)
-    url = get_url("#{resource_name}/#{id}")
+    url = get_url("#{level.url}#{resource_name}/#{id}")
     steps %Q{
         When I set JSON request body to:
             """
@@ -102,11 +127,11 @@ end
 
 # PATCH
 
-When(/^I request to modify the (.+?)(?: with (?:key|id))? "([^"]+)" with:$/) do |resource, id, params|
+When(/^I request to modify the ((?![^"]+?(?: for | in | on ))[^"]+?)(?: with (?:key|id))? "([^"]+)"(#{LEVELS})? with:$/) do |resource, id, levels, params|
     resource_name = get_resource(resource)
     request_hash = get_attributes(params.hashes)
     json = MultiJson.dump(request_hash)
-    url = get_url("#{resource_name}/#{id}")
+    url = get_url("#{Level.new(levels).url}#{resource_name}/#{id}")
     steps %Q{
         When I set JSON request body to:
             """

data/lib/cucumber-rest-bdd/steps/response.rb

@@ -17,7 +17,7 @@ Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{C
         type: 'single'
     })
     data = @response.get get_root_json_path()
-    raise %/Could not find a match for: #{nesting}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
+    raise %/Could not find a match for: #{nesting}\n#{expected.inspect}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
 end
 
 Then(/^the response ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+)\s?)+)$/) do |nesting|
@@ -42,7 +42,7 @@ Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM}
         count_mod: count_mod
     })
     data = @response.get get_root_json_path()
-    raise %/Expected #{compare_to_string(count_mod)}#{count} items in array with attributes for: #{nesting}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
+    raise %/Expected #{compare_to_string(count_mod)}#{count} items in array with attributes for: #{nesting}\n#{expected.inspect}\n#{@response.to_json_s}/ if !nest_match(data, grouping, expected)
 end
 
 Then(/^(#{FEWER_MORE_THAN})?\s*(#{CAPTURE_INT}|\d+) (?:.*?) ((?:#{HAVE_SYNONYM} (?:a|an|(?:(?:#{FEWER_MORE_THAN})?\s*#{CAPTURE_INT}|\d+)) (?:\w+)\s?)+)$/) do |count_mod, count, nesting|

data/lib/cucumber-rest-bdd/steps/status.rb

@@ -13,6 +13,10 @@ Then(/^(?:it|the request) fail(?:s|ed)$/) do
     raise %/Expected failed response code 4xx\/5xx but was #{@response.code}/ if @response.code < 400 || @response.code >= 600
 end
 
+Then(/^the (?!request)(?:.+?) (?:is|was) created$/) do
+    steps %Q{Then the response status should be "201"}
+end
+
 Then(/^the request (?:is|was) successful and (?:a resource|.+) (?:is|was) created$/) do
     steps %Q{Then the response status should be "201"}
 end

data/server/routes.json

@@ -0,0 +1,5 @@
+{
+  "/:r1/:id1/:r2/:id2": "/:r2/:id2",
+  "/users/:uid/albums/:alid/photos": "/photos?albumId=:alid",
+  "/users/:uid/albums/:alid/photos/:pid": "/photos/:pid"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-rest-bdd
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0.pre.107
 platform: ruby
 authors:
 - Harry Bragg
@@ -71,6 +71,7 @@ files:
 - features/functional.feature
 - features/grabs.feature
 - features/headers.feature
+- features/levels.feature
 - features/methods.feature
 - features/response.feature
 - features/status.feature
@@ -78,6 +79,7 @@ files:
 - features/types.feature
 - lib/cucumber-rest-bdd.rb
 - lib/cucumber-rest-bdd/hash.rb
+- lib/cucumber-rest-bdd/level.rb
 - lib/cucumber-rest-bdd/steps.rb
 - lib/cucumber-rest-bdd/steps/functional.rb
 - lib/cucumber-rest-bdd/steps/resource.rb
@@ -86,6 +88,7 @@ files:
 - lib/cucumber-rest-bdd/types.rb
 - lib/cucumber-rest-bdd/url.rb
 - server/db.json
+- server/routes.json
 homepage: http://github.com/graze/cucumber-rest-bdd
 licenses:
 - MIT
@@ -101,9 +104,9 @@ 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.4.8