cucumber-api 0.4 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ee88961920f3ccbf02d62d5ea0c7343d2f483f0
-  data.tar.gz: 5967edd044ec97f27368cf5a4c4a187004508fc5
+SHA256:
+  metadata.gz: eb9862462c5142f231325c27317b186d462e5f0c06655e8f429459b34b822585
+  data.tar.gz: 6d2c5f53a30b2c55c6694211d57b7af194f4ed560d1a3dcf171c4fca70fb57f6
 SHA512:
-  metadata.gz: b8c3e01637543cf39ad990443fb82759520b4412d5da5d6c45e1a73036d8401930af194f67e3600ea131bc10753ee27b40137213aaabc54915c6b571e349d8ca
-  data.tar.gz: b1d4cbd828bbb829706ce0124e0a9e500f42cc2e1cc309b660e898797cd747f81c4806a20afd32d0ad8267cd87989dc9af22b2760dd5fb85f07be544a86aa5bd
+  metadata.gz: ec7eff4ad9c6713ee2a215202aeec1f4415c6d0a9730b1b4c20d5ee86501d2f62e27612694a0e731bd71dd58ce2866027122ee18ac2081e19c7aaf0aa60fe432
+  data.tar.gz: 3858d5dc859df864a60629c9cf7f66f3f97f4d24a7ee8ee38057c1325e1cce4c80547f29b52a47389260dafb359160b37bc59e836472da987a34caf76a65777f

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 
-## [Current](https://github.com/hidroh/cucumber-api/compare/0.4...master)
+## [Current](https://github.com/hidroh/cucumber-api/compare/0.9...master)
+
+## [0.9](https://github.com/hidroh/cucumber-api/compare/0.9...0.8) (Mar 25, 2021)
+*  Replace URI.encode with CGI.escape #33
+
+## [0.8](https://github.com/hidroh/cucumber-api/compare/0.8...0.7) (Mar 23, 2021)
+*  Raise error when schema is expected but missing #32
+
+## [0.7](https://github.com/hidroh/cucumber-api/compare/0.6...0.7) (Aug 29, 2018)
+* Allow clearing GET response cache #25
+
+## [0.6](https://github.com/hidroh/cucumber-api/compare/0.5...0.6) (May 08, 2018)
+* Allow headers to use grabbed values #24
+
+## [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

data/README.md

@@ -2,7 +2,7 @@
 [![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 BBD style with [Cucumber](https://cukes.info/). **cucumber-api** lets one validate public APIs JSON response in blazingly fast time.
+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).
 
@@ -176,6 +176,12 @@ Response caching is provided for GET requests by default. This is useful when yo
 
 Only the first request to that endpoint is made, subsequent requests will use cached response. Response caching is only available for GET method.
 
+The response cache can also be cleared if needed:
+
+```gherkin
+Given I clear the response cache
+```
+
 ## 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/)

data/cucumber-api.gemspec

@@ -13,11 +13,12 @@ Gem::Specification.new do |s|
   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 = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.3.0'
   s.license     = 'Apache-2.0'
 
-  s.add_dependency('cucumber', '~> 2.0')
-  s.add_dependency('jsonpath', '~> 0.5')
-  s.add_dependency('rest-client', '~> 1.8')
-  s.add_dependency('json-schema', '~> 2.5')
-end
+  s.add_dependency('addressable', '2.5')
+  s.add_dependency('cucumber', '~> 3.1.0')
+  s.add_dependency('jsonpath', '~> 0.8')
+  s.add_dependency('rest-client', '~> 2.0.2')
+  s.add_dependency('json-schema', '~> 2.8.0')
+end

data/features/sample.feature

@@ -1,17 +1,18 @@
 # https://github.com/HackerNews/API
 Feature: Hacker News REST API validation
 
-  Scenario: Verify top stories JSON schema
+  Background:
     Given I send and accept JSON
-    And I add Headers:
+
+  Scenario: Verify top stories JSON schema
+    When I add Headers:
       | Cache-Control | no-cache |
-    When I send a GET request to "https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty"
+    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 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"
+    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 root should be array
     When I grab "$[0]" as "id"
@@ -30,8 +31,7 @@ Feature: Hacker News REST API validation
       | 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:
+    When I set JSON request body to:
     """
     {
       "title": "foo",
@@ -39,7 +39,7 @@ Feature: Hacker News REST API validation
       "userId": 1
     }
     """
-    When I send a POST request to "http://jsonplaceholder.typicode.com/posts"
+    And  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"

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}")
+          CGI.escape %/#{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

@@ -6,9 +6,6 @@ module CucumberApi
 
   # Extension of {RestClient::Response} with support for JSON path traversal and validation
   module Response
-
-    include RestClient::Response
-
     # Create a Response with JSON path support
     # @param response [RestClient::Response] original response
     # @return [Response] self
@@ -115,5 +112,6 @@ module CucumberApi
         ''
       end
     end
+    RestClient::Response.send(:include, self)
   end
 end

data/lib/cucumber-api/steps.rb

@@ -1,4 +1,5 @@
 require 'cucumber-api/response'
+require 'cucumber-api/helpers'
 require 'rest-client'
 require 'json-schema'
 
@@ -8,6 +9,10 @@ end
 
 $cache = {}
 
+Given(/^I clear the response cache$/) do
+  $cache = {}
+end
+
 Given(/^I send and accept JSON$/) do
   steps %Q{
     Given I send "application/json" and accept JSON
@@ -23,7 +28,7 @@ end
 
 Given(/^I add Headers:$/) do |params|
   params.rows_hash.each do |key, value|
-    @headers[key.to_sym] = value
+    @headers[key.to_sym] = resolve(value)
   end
 end
 
@@ -87,7 +92,7 @@ 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("&")
+    query = params.hashes.first.map{|key, value| %/CGI.escape #{key}=#{value}/}.join("&")
     url = url.include?('?') ? %/#{url}&#{query}/ : %/#{url}?#{query}/
   end
   steps %Q{
@@ -96,7 +101,7 @@ When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)" with:$/) do |meth
 end
 
 When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"$/) do |method, url|
-  request_url = URI.encode resolve(url)
+  request_url = resolve(url)
   if 'GET' == %/#{method}/ and $cache.has_key? %/#{request_url}/
     @response = $cache[%/#{request_url}/]
     @headers = nil
@@ -141,8 +146,7 @@ Then(/^the JSON response should follow "(.*?)"$/) do |schema|
                                               $!.fragments, $!.failed_attribute, $!.schema)
     end
   else
-    puts %/WARNING: missing schema '#{file_path}'/
-    pending
+    raise %/Schema not found: '#{file_path}'/
   end
 end
 
@@ -174,20 +178,3 @@ 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
-  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.4"
-end
+  VERSION = "0.9"
+end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-api
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.9'
 platform: ruby
 authors:
 - Ha Duy Trung
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2021-03-25 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: '2.0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.8.0
 description: cucumber-api allows API JSON response validation and verification in
   BDD style.
 email:
@@ -86,6 +100,7 @@ files:
 - 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
@@ -93,7 +108,7 @@ homepage: https://github.com/hidroh/cucumber-api
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,16 +116,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: API validator with Cucumber
 test_files: []