cucumber-api 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f7c67985f42b789f8476a2b893acc3f9b447372
-  data.tar.gz: 2079108bc4ad00e34da9183527a1138fda2c15c2
+  metadata.gz: 55a5a265a37af8eafb9ffd06172b125a5ec25f28
+  data.tar.gz: 221235246f1c3156a5765467a96a324773a46ba3
 SHA512:
-  metadata.gz: 645a5ecd4a3ae2f81d0e7e5026eef5bd8e03cb7da1d6a09bea3f1a688c217e8c39376cddcbaa6df0853e2cbf78991c7de3125084b34f740ec4ca152393461d0f
-  data.tar.gz: 9a8f7abf9e2fda3ee51831ceda64a4a454b198ca2fab18369a8db33894b2a05b078107e0ca533f4ad6c0c6e28880cb1f427c842efbae2e174ea77297fe4efd19
+  metadata.gz: 0396739e1f53262ee865c3ec7d3b57cf93917d7a888ddab8308d02de6a3c1915ba14e2828470f696e14e8a51a20b2c35a9d22971215b9d889c18233716360cbc
+  data.tar.gz: 2bf203c41587dfd2728c5dd039897f4ff50e49fe6accfbbff5956635f6655f1a99d9302a1fe1ec2e4154500be8302f9118a6d74bf33293ddc859ff4503efc9fe

data/.travis.yml

@@ -0,0 +1,2 @@
+language: ruby
+script: "cucumber -p verbose"

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+## [Current](https://github.com/hidroh/cucumber-api/compare/0.1...master)
+
+* 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/README.md

@@ -1,4 +1,7 @@
 # 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)](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.
 
 Inspired by [cucumber-api-steps](https://github.com/jayzes/cucumber-api-steps).
@@ -13,16 +16,20 @@ Add `cucumber-api` gem to your `Gemfile`:
 
 Require `cucumber-api` in your Cucumber's `env.rb`:
 
-    require 'cucumber-api'
+```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`
 
-    # config/cucumber.yml
-    ##YAML Template
-    ---
-    verbose     : cucumber_api_verbose=true
+```yaml
+# config/cucumber.yml
+##YAML Template
+---
+verbose     : cucumber_api_verbose=true
+```
 
 ## Usage
 
@@ -32,46 +39,78 @@ Require `cucumber-api` in your Cucumber's `env.rb`:
 
 Specify your request header's `Content-Type` and `Accept`. The only supported option for `Accept` is `application/json` at the moment.
 
-    Given I send and accept JSON
-    Given I send "(.*?)" and accept JSON
-    When I set JSON request body to '(.*?)'
+```gherkin
+Given I send and accept JSON
+Given I send "(.*?)" and accept JSON
+```
+
+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 |
+```
+
+Or from YAML/JSON file
+
+```gherkin
+When I set request body from "(.*?).(yml|json)"
+```
 
 Example:
 
-    Given I send "www-x-form-urlencoded" and accept JSON
-    When I set JSON request body to '{"login": "email@example.com", "password": "password"}'
+```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
 
-    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 | ... |
+```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 the next request in the same scenario:
 
-    When I grab "(.*?)" as "(.*?)"
+```gherkin
+When I grab "(.*?)" as "(.*?)"
+```
 
 The saved value can then be used to replace `{placeholder}` in the next request.
 
 Example:
 
-    When I send a GET request to "http://example.com/all"
-    And I grab "$..id" as "detail_id"
-    And I grab "$..format" as "detail_format"
-    And I send a GET request to "http://example.com/{detail_id} with:
-      | format          | pretty |
-      | {detail_format} | true   |
+```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 send a GET request to "http://example.com/{token} with:
+  | type            | pretty |
+  | {type}          | true   |
+```
 
-Assume that [http://example.com/all](http://example.com/all) have an element `{"id": 1, "format": "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"}`, **cucumber-api** will execute the followings:
 
-* GET [http://example.com/all](http://example.com/all)
-* Extract the first `id` and `format` from JSON response and save it for next request
-* GET [http://example.com/1?format=full&pretty=true](http://example.com/1?format=full&pretty=true)
+* 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
+* GET [http://example.com/1?type=full&pretty=true](http://example.com/1?type=full&pretty=true)
 * 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:
@@ -79,7 +118,7 @@ Verify:
 * 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)
@@ -89,13 +128,19 @@ Then the JSON response should have (required|optional) key "(.*?)" of type (nume
 
 Example:
 
-    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
+```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
+```
+
+Also checkout [sample](/features/sample.feature) for real examples. Run sample with the following command:
 
-Also checkout [sample](/features/sample.feature) for real examples.
+```
+cucumber -p verbose
+```
 
 ### Response caching
 
@@ -107,4 +152,4 @@ Only the first request to that endpoint is made, subsequent requests will use ca
 * [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
+* [rest-client](https://github.com/rest-client/rest-client) for HTTP REST request

data/lib/cucumber-api/response.rb

@@ -40,7 +40,7 @@ module CucumberApi
       end
       results = JsonPath.new(json_path).on(json)
       if results.empty?
-        raise %/Expected json path '#{json_path}' not found\n#{log_response}/
+        raise %/Expected json path '#{json_path}' not found\n#{to_json_s}/
       end
       results.first
     end
@@ -73,7 +73,7 @@ module CucumberApi
       end
 
       unless valid
-        raise %/Expect '#{json_path}' as a '#{type}' but was '#{value.class}'\n#{log_response}/
+        raise %/Expect '#{json_path}' as a '#{type}' but was '#{value.class}'\n#{to_json_s}/
       end
       value
     end
@@ -91,13 +91,14 @@ module CucumberApi
       value.nil? ? value : get_as_type(json_path, type, json)
     end
 
-    private
-      def log_response
-        if ENV['cucumber_api_verbose'] == 'true'
-          JSON.pretty_generate(JSON.parse to_s)
-        else
-          ''
-        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
   end
 end

data/lib/cucumber-api/steps.rb

@@ -25,6 +25,32 @@ When(/^I set JSON request body to '(.*?)'$/) do |body|
   @body = 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 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'
@@ -85,7 +111,12 @@ end
 Then(/^the JSON response should follow "(.*?)"$/) do |schema|
   file_path = %-#{Dir.pwd}/#{schema}-
   if File.file? file_path
-    JSON::Validator.validate!(file_path, @response.to_s)
+    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

data/lib/cucumber-api/version.rb

@@ -1,3 +1,3 @@
 module CucumberApi
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-api
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Ha Duy Trung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -75,6 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md