alinta-cucumber-api 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97bf6a703704c090f2038cac951976ae1220aab6e03148f1c55fbe10f8124116
+  data.tar.gz: 826bb6992611dce76f58a860938097c9e1423269340ae6684375671791aa7c94
+SHA512:
+  metadata.gz: a1404352a5da68b1af3d8b24d4760ccef6710b29d24359e958a33985577ae61846d6455187e60a87baa7fde93ad753b81cf7ce7481e87ee2827ec195bfe66154
+  data.tar.gz: d62d6e95131d5212ef938a02d31f5954361841b5498707d28a70a6204981850455f5da86c3843100727b747ebbc5d8ab5c666ab88757d945f97267ae7560d7ec

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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
+
+.DS_Store
+.idea

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+
+rvm:
+    - 2.3
+    - 2.4
+    - ruby-head
+
+matrix:
+    allow_failures:
+        - ruby-head
+
+script: "cucumber -p verbose"
+

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Change Log
+
+## [Current](https://github.com/hidroh/cucumber-api/compare/0.5...master)
+
+## [0.5](https://github.com/hidroh/cucumber-api/compare/0.4...0.5) (January 26, 2018)
+* Bump up dependencies, requires min Ruby version 2.3.0
+* Fix bug where grabbed values are not shared #11
+
+## [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)
+
+* Added form request body
+* Added loading request body from file (YAML/JSON)
+
+## [0.1](https://github.com/hidroh/cucumber-api/releases/tag/0.1) (March 01, 2015)
+
+* Initial version
+* Only JSON response supported
+* Only JSON POST request body supported

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,183 @@
+# cucumber-api
+[![Build Status](https://travis-ci.org/hidroh/cucumber-api.svg?branch=master)](https://travis-ci.org/hidroh/cucumber-api) [![Gem Version](https://badge.fury.io/rb/cucumber-api.svg)](http://badge.fury.io/rb/cucumber-api) [![Dependency Status](https://gemnasium.com/hidroh/cucumber-api.svg)](https://gemnasium.com/hidroh/cucumber-api)
+ [![Code Climate](https://codeclimate.com/github/hidroh/cucumber-api/badges/gpa.svg)](https://codeclimate.com/github/hidroh/cucumber-api) [![Total Downloads](http://ruby-gem-downloads-badge.herokuapp.com/cucumber-api?type=total)](https://rubygems.org/gems/cucumber-api)
+
+API validator in BDD style with [Cucumber](https://cukes.info/). **cucumber-api** lets one validate public APIs JSON response in blazingly fast time.
+
+Inspired by [cucumber-api-steps](https://github.com/jayzes/cucumber-api-steps).
+
+Checkout [sample](/features/sample.feature) to see **cucumber-api** in action.
+
+## Installation
+
+Add `cucumber-api` gem to your `Gemfile`:
+
+    gem 'cucumber-api'
+
+Require `cucumber-api` in your Cucumber's `env.rb`:
+
+```ruby
+require 'cucumber-api'
+```
+
+## Configuration
+
+**Verbose logging:** enable verbose logging of API calls and responses by setting `cucumber_api_verbose=true` in your `ENV`, preferably via your `cucumber.yml`
+
+```yaml
+# config/cucumber.yml
+##YAML Template
+---
+verbose     : cucumber_api_verbose=true
+```
+
+## Usage
+
+### Available steps
+
+**Preparation steps**
+
+Specify your request header's `Content-Type` and `Accept`. The only supported option for `Accept` is `application/json` at the moment.
+
+```gherkin
+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
+When I set JSON request body to '(.*?)'
+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
+
+```gherkin
+When I set request body from "(.*?).(yml|json)"
+```
+
+Example:
+
+```Gherkin
+Given I send "www-x-form-urlencoded" and accept JSON
+When I set JSON request body to '{"login": "email@example.com", "password": "password"}'
+When I set form request body to:
+  | login    | email@example.com     |
+  | password | password              |
+When I set request body from "data/json-data.json"
+When I set request body from "data/form-data.yml"
+```
+
+**Request steps**
+
+Specify query string parameters and send an HTTP request to given URL with parameters
+
+```gherkin
+When I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"
+When I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)" with:
+  | param1 | param2 | ... |
+  | value1 | value2 | ... |
+```
+
+Temporarily save values from the last request to use in subsequent steps in the same scenario:
+
+```gherkin
+When I grab "(.*?)" as "(.*?)"
+```
+
+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:
+
+```gherkin
+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 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", "id": "user1"}`, **cucumber-api** will execute the followings:
+
+* POST [http://example.com/token](http://example.com/token)
+* 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.
+
+**Assert steps**
+
+Verify:
+* HTTP response status code
+* JSON response against a JSON schema conforming to [JSON Schema Draft 4](http://tools.ietf.org/html/draft-zyp-json-schema-04)
+* Adhoc JSON response key-value type pair, where key is a [JSON path](http://goessner.net/articles/JsonPath/)
+
+```gherkin
+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|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:
+
+```gherkin
+Then the response status should be "200"
+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:
+
+```
+cucumber -p verbose
+```
+
+### Response caching
+
+Response caching is provided for GET requests by default. This is useful when you have a Scenario Outline or multiple Scenarios that make GET requests to the same endpoint.
+
+Only the first request to that endpoint is made, subsequent requests will use cached response. Response caching is only available for GET method.
+
+## Dependencies
+* [cucumber](https://github.com/cucumber/cucumber) for BDD style specs
+* [jsonpath](https://github.com/joshbuddy/jsonpath) for traversal of JSON response via [JSON path](http://goessner.net/articles/JsonPath/)
+* [json-schema](https://github.com/ruby-json-schema/json-schema) for JSON schema validation
+* [rest-client](https://github.com/rest-client/rest-client) for HTTP REST request

data/config/cucumber.yml

@@ -0,0 +1,4 @@
+# config/cucumber.yml
+##YAML Template
+---
+verbose     : cucumber_api_verbose=true

data/cucumber-api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cucumber-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "alinta-cucumber-api"
+  s.version     = CucumberApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ha Duy Trung"]
+  s.email       = ["haduytrung@gmail.com"]
+  s.homepage    = "https://github.com/hidroh/cucumber-api"
+  s.summary     = %q{API validator with Cucumber}
+  s.description = %q{cucumber-api allows API JSON response validation and verification in BDD style.}
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.3.0'
+  s.license     = 'Apache-2.0'
+
+  s.add_dependency('addressable', '2.5')
+  s.add_dependency('cucumber', '~> 3.1')
+  s.add_dependency('jsonpath', '~> 0.8')
+  s.add_dependency('alinta-rest-client', '~> 2.2')
+  s.add_dependency('json-schema', '~> 2.8')
+end

data/features/sample.feature

@@ -0,0 +1,48 @@
+# https://github.com/HackerNews/API
+Feature: Hacker News REST API validation
+
+  Scenario: Verify top stories JSON schema
+    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"
+
+  Scenario Outline: Verify item 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"
+    Then the response status should be "200"
+    And the JSON response root should be array
+    When I grab "$[0]" as "id"
+    And I send a GET request to "https://hacker-news.firebaseio.com/v0/item/{id}.json" with:
+      | print  |
+      | pretty |
+    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/features/schemas/topstories.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "array",
+  "items": {
+    "type": "number"
+  }
+}

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'cucumber-api'

data/lib/cucumber-api/helpers.rb

@@ -0,0 +1,21 @@
+module CucumberApi
+  module Helpers
+    # 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
+      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
+  end
+end
+
+World(CucumberApi::Helpers)

data/lib/cucumber-api/response.rb

@@ -0,0 +1,117 @@
+require 'json'
+require 'jsonpath'
+require 'rest-client'
+
+module CucumberApi
+
+  # Extension of {RestClient::Response} with support for JSON path traversal and validation
+  module Response
+    # Create a Response with JSON path support
+    # @param response [RestClient::Response] original response
+    # @return [Response] self
+    def self.create response
+      result = response
+      result.extend Response
+      result
+    end
+
+    # Check if given JSON path exists
+    # @param json_path [String] a valid JSON path expression
+    # @param json [String] optional JSON from which to check JSON path, default to response body
+    # @return [true, false] true if JSON path is valid and exists, false otherwise
+    def has json_path, json=nil
+      if json.nil?
+        json = JSON.parse body
+      end
+      not JsonPath.new(json_path).on(json).empty?
+    end
+
+    # Retrieve value of the first JSON element with given JSON path
+    # @param json_path [String] a valid JSON path expression
+    # @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 Ruby object
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found
+    def get json_path, json=nil
+      if json.nil?
+        json = JSON.parse body
+      end
+      results = JsonPath.new(json_path).on(json)
+      if results.empty?
+        raise %/Expected json path '#{json_path}' not found\n#{to_json_s}/
+      end
+      results.first
+    end
+
+    # Retrieve value of the first JSON element with given JSON path as given type
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+    # or 'object'
+    # @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
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+    # required type
+    def get_as_type json_path, type, json=nil
+      value = get json_path, json
+      case type
+        when 'numeric'
+          valid = value.is_a? Numeric
+        when 'array'
+          valid = value.is_a? Array
+        when 'string'
+          valid = value.is_a? String
+        when 'boolean'
+          valid = !!value == value
+        when 'numeric_string'
+          valid = value.is_a?(Numeric) or value.is_a?(String)
+        when 'object'
+          valid = value.is_a? Hash
+        else
+          raise %/Invalid expected type '#{type}'/
+      end
+
+      unless valid
+        raise %/Expect '#{json_path}' as a '#{type}' but was '#{value.class}'\n#{to_json_s}/
+      end
+      value
+    end
+
+    # Retrieve value of the first JSON element with given JSON path as given type, with nil value allowed
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+    # or 'object'
+    # @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
+    def get_as_type_or_null json_path, type, json=nil
+      value = get json_path, json
+      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
+      if ENV['cucumber_api_verbose'] == 'true'
+        JSON.pretty_generate(JSON.parse to_s)
+      else
+        ''
+      end
+    end
+    RestClient::Response.send(:include, self)
+  end
+end

data/lib/cucumber-api/steps.rb

@@ -0,0 +1,177 @@
+require 'cucumber-api/response'
+require 'cucumber-api/helpers'
+require 'rest-client'
+require 'json-schema'
+
+if ENV['cucumber_api_verbose'] == 'true'
+  RestClient.log = 'stdout'
+end
+
+$cache = {}
+
+Given(/^I send and accept JSON$/) do
+  steps %Q{
+    Given I send "application/json" and accept JSON
+  }
+end
+
+Given(/^I send "(.*?)" and accept JSON$/) do |content_type|
+  @headers = {
+      :Accept => 'application/json',
+      :'Content-Type' => %/#{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|
+    p_value = value
+    @grabbed.each { |k, v| p_value = v if value == %/{#{k}}/ } unless @grabbed.nil?
+    p_value = File.new %-#{Dir.pwd}/#{p_value.sub 'file://', ''}- if %/#{p_value}/.start_with? "file://"
+    @body[%/#{key}/] = p_value
+  end
+end
+
+When(/^I set request body from "(.*?).(yml|json)"$/) do |filename, extension|
+  path = %-#{Dir.pwd}/#{filename}.#{extension}-
+  if File.file? path
+    case extension
+      when 'yml'
+        @body = YAML.load File.open(path)
+      when 'json'
+        @body = JSON.parse File.read(path)
+      else
+        raise %/Unsupported file type: '#{path}'/
+    end
+  else
+    raise %/File not found: '#{path}'/
+  end
+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("&")
+    url = url.include?('?') ? %/#{url}&#{query}/ : %/#{url}?#{query}/
+  end
+  steps %Q{
+      When I send a #{method} request to "#{url}"
+    }
+end
+
+When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"$/) do |method, url|
+  request_url = URI.encode resolve(url)
+  if 'GET' == %/#{method}/ and $cache.has_key? %/#{request_url}/
+    @response = $cache[%/#{request_url}/]
+    @headers = nil
+    @body = nil
+    next
+  end
+
+  @headers = {} if @headers.nil?
+  begin
+    case method
+      when 'GET'
+        response = RestClient.get request_url, @headers
+      when 'POST'
+        response = RestClient.post request_url, @body, @headers
+      when 'PATCH'
+        response = RestClient.patch request_url, @body, @headers
+      when 'PUT'
+        response = RestClient.put request_url, @body, @headers
+      else
+        response = RestClient.delete request_url, @headers
+    end
+  rescue RestClient::Exception => e
+    response = e.response
+  end
+  @response = CucumberApi::Response.create response
+  @headers = nil
+  @body = nil
+  $cache[%/#{request_url}/] = @response if 'GET' == %/#{method}/
+end
+
+Then(/^the response status should be "(\d+)"$/) do |status_code|
+  raise %/Expect #{status_code} but was #{@response.code}/ if @response.code != status_code.to_i
+end
+
+Then(/^the JSON response should follow "(.*?)"$/) do |schema|
+  file_path = %-#{Dir.pwd}/#{schema}-
+  if File.file? file_path
+    begin
+      JSON::Validator.validate!(file_path, @response.to_s)
+    rescue JSON::Schema::ValidationError => e
+      raise JSON::Schema::ValidationError.new(%/#{$!.message}\n#{@response.to_json_s}/,
+                                              $!.fragments, $!.failed_attribute, $!.schema)
+    end
+  else
+    puts %/WARNING: missing schema '#{file_path}'/
+    pending
+  end
+end
+
+Then(/^the JSON response root should be (object|array)$/) do |type|
+  steps %Q{
+    Then the JSON response should have required key "$" of type #{type}
+  }
+end
+
+Then(/^the JSON response should have key "([^\"]*)"$/) do |json_path|
+  steps %Q{
+    Then the JSON response should have required key "#{json_path}" of type any
+  }
+end
+
+Then(/^the JSON response should have (required|optional) key "(.*?)" of type \
+(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
+  elsif null_allowed.nil?
+    @response.get_as_type json_path, type
+  else
+    @response.get_as_type_or_null json_path, 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

data/lib/cucumber-api/version.rb

@@ -0,0 +1,3 @@
+module CucumberApi
+  VERSION = "0.5.1"
+end

data/lib/cucumber-api.rb

@@ -0,0 +1 @@
+require 'cucumber-api/steps'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: alinta-cucumber-api
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Ha Duy Trung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: alinta-rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: cucumber-api allows API JSON response validation and verification in
+  BDD style.
+email:
+- haduytrung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- config/cucumber.yml
+- cucumber-api.gemspec
+- features/sample.feature
+- features/schemas/topstories.json
+- features/support/env.rb
+- lib/cucumber-api.rb
+- lib/cucumber-api/helpers.rb
+- lib/cucumber-api/response.rb
+- lib/cucumber-api/steps.rb
+- lib/cucumber-api/version.rb
+homepage: https://github.com/hidroh/cucumber-api
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: API validator with Cucumber
+test_files: []