cucumber-api 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f24455a2087518ebd14b824f5429dffe0d74c7e
-  data.tar.gz: 21a09dc92c6674c3e16d1f89fd3ada453896320c
+  metadata.gz: 4ee88961920f3ccbf02d62d5ea0c7343d2f483f0
+  data.tar.gz: 5967edd044ec97f27368cf5a4c4a187004508fc5
 SHA512:
-  metadata.gz: db2290dc5d15a16d7c3e827066e184b46e0a2e18ef19b4fecae7d430d1cc8d4a8f3e74c4e9766152f7ed92a1b62b38e7bb9d04a3ba3c97c893b944262ac3089e
-  data.tar.gz: ab083a9e8ad73fa731b195a4d325e65c686764e64d2106ddf42af9665b4a07069feb0bfc06f383104952e6301b699a9b283408217e5c06b20d53beb140a111bf
+  metadata.gz: b8c3e01637543cf39ad990443fb82759520b4412d5da5d6c45e1a73036d8401930af194f67e3600ea131bc10753ee27b40137213aaabc54915c6b571e349d8ca
+  data.tar.gz: b1d4cbd828bbb829706ce0124e0a9e500f42cc2e1cc309b660e898797cd747f81c4806a20afd32d0ad8267cd87989dc9af22b2760dd5fb85f07be544a86aa5bd

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Change Log
 
-## [Current](https://github.com/hidroh/cucumber-api/compare/0.2...master)
+## [Current](https://github.com/hidroh/cucumber-api/compare/0.4...master)
+
+## [0.4](https://github.com/hidroh/cucumber-api/compare/0.3...0.4) (November 03, 2016)
+* Support additional request headers
+* Allow specifying JSON request body with docstring
+* Support simple JSON response value verification
+* Grabbed values now persist until overridden within scenario, or when scenario exits
+
+## [0.3](https://github.com/hidroh/cucumber-api/compare/0.2...0.3) (March 27, 2015)
+
+* Bumped up gem dependencies, relax to minor versions
+* Added gem license
 
 ## [0.2](https://github.com/hidroh/cucumber-api/compare/0.1...0.2) (March 07, 2015)
 

data/README.md

@@ -44,6 +44,15 @@ Given I send and accept JSON
 Given I send "(.*?)" and accept JSON
 ```
 
+You could also others header's information like:
+
+```gherkin
+Given I send and accept JSON
+And I add Headers:
+  | name1 | value |
+  | name2 | other |  
+```
+
 Specify POST body
 
 ```gherkin
@@ -52,6 +61,13 @@ When I set form request body to:
   | key1 | value1              |
   | key2 | {value2}            |
   | key3 | file://path-to-file |
+When I set JSON request body to:
+"""
+{
+  "key1": "jsonString",
+  "key2":  1
+}
+"""
 ```
 
 Or from YAML/JSON file
@@ -83,13 +99,20 @@ When I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)" with:
   | value1 | value2 | ... |
 ```
 
-Temporarily save values from the last request to use in the next request in the same scenario:
+Temporarily save values from the last request to use in subsequent steps in the same scenario:
 
 ```gherkin
 When I grab "(.*?)" as "(.*?)"
 ```
 
-The saved value can then be used to replace `{placeholder}` in the next request.
+Optionally, auto infer placeholder from grabbed JSON path:
+
+```gherkin
+# Grab and auto assign {id} as placeholder
+When I grab "$..id"
+```
+
+The saved value can then be used to replace `{placeholder}` in the subsequent steps.
 
 Example:
 
@@ -97,16 +120,19 @@ Example:
 When I send a POST request to "http://example.com/token"
 And I grab "$..request_token" as "token"
 And I grab "$..access_type" as "type"
-And I send a GET request to "http://example.com/{token} with:
+And I grab "$..id"
+And I send a GET request to "http://example.com/{token}" with:
   | type            | pretty |
   | {type}          | true   |
+Then the JSON response should have required key "id" of type string and value "{id}"
 ```
 
-Assume that [http://example.com/token](http://example.com/token) have an element `{"request_token": 1, "access_type": "full"}`, **cucumber-api** will execute the followings:
+Assume that [http://example.com/token](http://example.com/token) have an element `{"request_token": 1, "access_type": "full", "id": "user1"}`, **cucumber-api** will execute the followings:
 
 * POST [http://example.com/token](http://example.com/token)
-* Extract the first `request_token` and `access_type` from JSON response and save it for next request
+* Extract the first `request_token`, `access_type` and `id` from JSON response and save it for subsequent steps
 * GET [http://example.com/1?type=full&pretty=true](http://example.com/1?type=full&pretty=true)
+* Verify that JSON response has a pair of JSON key-value: `"id": "user1"`
 * Clear all saved values
 
 This will be handy when one needs to make a sequence of calls to authenticate/authorize API access.
@@ -123,7 +149,8 @@ Then the response status should be "(\d+)"
 Then the JSON response should follow "(.*?)"
 Then the JSON response root should be (object|array)
 Then the JSON response should have key "([^\"]*)"
-Then the JSON response should have (required|optional) key "(.*?)" of type (numeric|string|array|boolean|numeric_string|object|array|any)( or null)
+Then the JSON response should have (required|optional) key "(.*?)" of type (numeric|string|boolean|numeric_string|object|array|any)( or null)
+Then the JSON response should have (required|optional) key "(.*?)" of type (numeric|string|boolean|numeric_string|object|array|any)( or null) and value "(.*?)"
 ```
 
 Example:
@@ -134,6 +161,7 @@ Then the JSON response should follow "features/schemas/example_all.json"
 Then the JSON response root should be array
 Then the JSON response should have key "id"
 Then the JSON response should have optional key "format" of type string or null
+Then the JSON response should have required key "status" of type string and value "foobar"
 ```
 
 Also checkout [sample](/features/sample.feature) for real examples. Run sample with the following command:

data/features/sample.feature

@@ -2,8 +2,10 @@
 Feature: Hacker News REST API validation
 
   Scenario: Verify top stories JSON schema
-    When I send and accept JSON
-    And I send a GET request to "https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty"
+    Given I send and accept JSON
+    And I add Headers:
+      | Cache-Control | no-cache |
+    When I send a GET request to "https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty"
     Then the response status should be "200"
     And the JSON response should follow "features/schemas/topstories.json"
 
@@ -19,9 +21,28 @@ Feature: Hacker News REST API validation
     Then the response status should be "200"
     And the JSON response root should be object
     And the JSON response should have <optionality> key "<key>" of type <value type>
+    And the JSON response should have "id" of type numeric and value "{id}"
 
     Examples:
       | key   | value type | optionality |
       | id    | numeric    | required    |
       | score | numeric    | required    |
       | url   | string     | optional    |
+
+  Scenario: Demonstrate setting the JSON body with a docstring
+    Given I send and accept JSON
+    And   I set JSON request body to:
+    """
+    {
+      "title": "foo",
+      "body":  "bar",
+      "userId": 1
+    }
+    """
+    When I send a POST request to "http://jsonplaceholder.typicode.com/posts"
+    Then the response status should be "201"
+    And  the JSON response should have "id" of type numeric and value "101"
+    And  the JSON response should have "title" of type string and value "foo"
+    And  the JSON response should have "body" of type string and value "bar"
+    And  the JSON response should have "userId" of type numeric and value "1"
+

data/lib/cucumber-api/response.rb

@@ -91,6 +91,21 @@ module CucumberApi
       value.nil? ? value : get_as_type(json_path, type, json)
     end
 
+    # Retrieve value of the first JSON element with given JSON path as given type, and check for a given value
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'string', 'boolean', or 'numeric_string'
+    # @param value [String] value to check for
+    # @param json [String] optional JSON from which to apply JSON path, default to response body
+    # @return [Object] value of first retrieved JSON element in form of given type or nil
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+    # required type or value
+    def get_as_type_and_check_value json_path, type, value, json=nil
+      v = get_as_type json_path, type, json
+      if value != v.to_s
+        raise %/Expect '#{json_path}' to be '#{value}' but was '#{v}'\n#{to_json_s}/
+      end
+    end
+
     # Retrieve pretty JSON response for logging
     # @return [String] pretty JSON response if verbose setting is true, empty string otherwise
     def to_json_s
@@ -101,4 +116,4 @@ module CucumberApi
       end
     end
   end
-end
+end

data/lib/cucumber-api/steps.rb

@@ -21,10 +21,44 @@ Given(/^I send "(.*?)" and accept JSON$/) do |content_type|
   }
 end
 
+Given(/^I add Headers:$/) do |params|
+  params.rows_hash.each do |key, value|
+    @headers[key.to_sym] = value
+  end
+end
+
+When(/^I grab "([^"]+)"$/) do |k|
+  if @response.nil?
+    raise 'No response found.'
+  end
+
+  if k[0] == '$'
+    v = k
+  else
+    v = "$.#{k}"
+  end
+
+  k.gsub!(/[^0-9a-zA-Z_]/, '')
+  instance_variable_set("@#{k}", @response.get(v))
+end
+
+When(/^I grab "([^"]+)" as "([^"]+)"$/) do |k, v|
+  if @response.nil?
+    raise 'No response found.'
+  end
+
+  k = "$.#{k}" unless k[0] == '$'
+  instance_variable_set("@#{v}", @response.get(k))
+end
+
 When(/^I set JSON request body to '(.*?)'$/) do |body|
   @body = JSON.parse body
 end
 
+When(/^I set JSON request body to:$/) do |body|
+  @body = JSON.dump(JSON.parse(body))
+end
+
 When(/^I set form request body to:$/) do |params|
   @body = {}
   params.rows_hash.each do |key, value|
@@ -51,15 +85,6 @@ When(/^I set request body from "(.*?).(yml|json)"$/) do |filename, extension|
   end
 end
 
-When(/^I grab "(.*?)" as "(.*?)"$/) do |json_path, place_holder|
-  if @response.nil?
-    raise 'No response found, a request need to be made first before you can grab response'
-  end
-
-  @grabbed = {} if @grabbed.nil?
-  @grabbed[%/#{place_holder}/] = @response.get json_path
-end
-
 When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)" with:$/) do |method, url, params|
   unless params.hashes.empty?
     query = params.hashes.first.map{|key, value| %/#{key}=#{value}/}.join("&")
@@ -76,7 +101,6 @@ When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"$/) do |method, ur
     @response = $cache[%/#{request_url}/]
     @headers = nil
     @body = nil
-    @grabbed = nil
     next
   end
 
@@ -100,7 +124,6 @@ When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"$/) do |method, ur
   @response = CucumberApi::Response.create response
   @headers = nil
   @body = nil
-  @grabbed = nil
   $cache[%/#{request_url}/] = @response if 'GET' == %/#{method}/
 end
 
@@ -136,7 +159,7 @@ Then(/^the JSON response should have key "([^\"]*)"$/) do |json_path|
 end
 
 Then(/^the JSON response should have (required|optional) key "(.*?)" of type \
-(numeric|string|array|boolean|numeric_string|object|array|any)( or null)?$/) do |optionality, json_path, type, null_allowed|
+(numeric|string|boolean|numeric_string|object|array|any)( or null)?$/) do |optionality, json_path, type, null_allowed|
   next if optionality == 'optional' and not @response.has(json_path)  # if optional and no such key then skip
   if 'any' == type
     @response.get json_path
@@ -147,13 +170,24 @@ Then(/^the JSON response should have (required|optional) key "(.*?)" of type \
   end
 end
 
+Then(/^the JSON response should have "([^"]*)" of type \
+(numeric|string|boolean|numeric_string) and value "([^"]*)"$/) do |json_path, type, value|
+  @response.get_as_type_and_check_value json_path, type, resolve(value)
+end
+
 # Bind grabbed values into placeholders in given URL
 # Ex: http://example.com?id={id} with {id => 1} becomes http://example.com?id=1
 # @param url [String] parameterized URL with placeholders
 # @return [String] binded URL or original URL if no placeholders
 def resolve url
-  unless @grabbed.nil?
-    @grabbed.each { |key, value| url = url.gsub /\{#{key}\}/, %/#{value}/ }
+  url.gsub!(/\{([a-zA-Z0-9_]+)\}/) do |s|
+    s.gsub!(/[\{\}]/, '')
+    if instance_variable_defined?("@#{s}")
+      instance_variable_get("@#{s}")
+    else
+      raise 'Did you forget to "grab" ' + s + '?'
+    end
   end
   url
 end
+

data/lib/cucumber-api/version.rb

@@ -1,3 +1,3 @@
 module CucumberApi
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-api
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Ha Duy Trung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber