cucumber-http 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59c38771ab6ab918565cef8d236428c1454fd342
-  data.tar.gz: 80b809a9b7f1ea12963cff9581e44263c133ac8a
+  metadata.gz: db09007776b7080549a13a86e301a75f4c979741
+  data.tar.gz: b7ef953e7f55853ad877f4a5f7cdada6327c101c
 SHA512:
-  metadata.gz: 10cb64500e459962ab3e75826e49a159bfe99e9bfce85214ba4220f4405f37368575d95548ab34f8f9716184feb6e380c28850ad004c618bc927f6f79dd24140
-  data.tar.gz: 88f97fa87c0031c282fd5a22b69234a663c39a22aa5804eb1ef46b8f9c7e47fb51100b0ceee13763086067e1f65623eaa7c91c1259f0566bccbd4cc39d01367a
+  metadata.gz: a5a566e3103706625fc736859a05af63f97dd709c7c90c955d4ba5aa6080c664e2277f2dea1f6eb2f37c87967c7496c59d07b995ee45f968ff00753ef2b038c2
+  data.tar.gz: f8aaa79b60e1eb017faceb048c79a404e0441dace6d62c802dbc69026f9312a5640d575e30b8924699cce030cc20b650d278b07411b9ef0e92b622f387e6a50e

data/README.md

@@ -1,6 +1,10 @@
 # Cucumber::Http
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cucumber/http`.
+This library provides Cucumber steps to test JSON HTTP API's. The
+steps are rather verbose (technical) in nature, somewhat contrary to the
+Cucumber philosophy of high-level, descriptive tests. This is intentional as
+it allows these steps to be bundled in larger, more high-level tests by
+non-developers.
 
 ## Installation
 
@@ -20,6 +24,136 @@ Or install it yourself as:
 
 ## Usage
 
+### Bundled steps
+
+#### Examples
+
+Examples for testing the [REST API](https://apidoc.uitdatabank.be) of
+[UiTDatabank](https://www.uitdatabank.be):
+
+```ruby
+@api @labels
+Feature: Test the UDB3 labels API
+
+  Background:
+    Given I am using the UDB3 development environment
+     And I am authorized as user "centraal_beheerder"
+     And I send and accept JSON
+
+  @labelcreate
+  Scenario: Create label
+    When I create a label with a random name of 10 characters
+     And I keep the value of the JSON response at "uuid" as "uuid"
+     And I send a GET request to "/labels/%{uuid}"
+    Then the response status should be "200"
+     And the JSON response at "visibility" should be "visible"
+     And the JSON response at "privacy" should be "public"
+```
+
+#### Benchmarking
+
+```ruby
+Given /^I am benchmarking$/
+```
+
+```ruby
+Then /^the elapsed time should be less than (#{CAPTURE_FLOAT}) seconds?$/
+```
+
+#### HTTP
+
+```ruby
+Given /^I set headers?:$/
+```
+
+```ruby
+Given /^I send "(.*?)" and accept (XML|JSON)$/
+```
+
+```ruby
+Given /^I send and accept (XML|JSON)$/
+```
+
+```ruby
+Given /^I set the JSON request payload to:$/
+```
+
+```ruby
+Given /^I set the JSON request payload from "(.*?)"$/
+```
+
+```ruby
+When /^I send a (GET|POST|PATCH|PUT|DELETE) request to "([^"]*)"(?: with parameters?:)?$/
+```
+
+```ruby
+Then /^the response status should( not)? be "(#{CAPTURE_INTEGER})"$/
+```
+
+```ruby
+Then /^the response body should be valid (XML|JSON)$/
+```
+
+#### Debugging
+
+```ruby
+Then /^show me the( unparsed)? response$/
+```
+
+```ruby
+Then /^show me the kept values?$/
+```
+
+#### JSON (through JsonSpec)
+
+These steps are documented in the [json_spec README](https://github.com/collectiveidea/json_spec#cucumber)
+
+### Making larger, more descriptive tests
+
+The steps in this library are overly technical for use in Cucumber as a communication
+tool between developers and business people. They are meant to be encapsulated in
+larger, more general steps through the use of the `steps` method in Cucumber.
+
+This allows easier reuse of code and the ability for non-developers to write
+requirements.
+
+Examples for testing the [REST API](https://apidoc.uitdatabank.be) of
+[UiTDatabank](https://www.uitdatabank.be):
+
+Creating an organizer with a random name:
+```ruby
+When /^I(?: have)? created? an organizer with a random name of (#{CAPTURE_INTEGER}) characters?$/ do |characters|
+  name = Faker::Lorem.characters(characters)
+  steps %Q{
+    Given I am using the UDB3 development environment
+      And I am authorized as user "centraal_beheerder"
+      And I send and accept JSON
+     When I set the JSON request payload to:
+       """
+       {"mainLanguage":"nl","website":"https://www.#{name}.be","name":"#{name}","contact":[]}
+       """
+      And I send a POST request to "/organizers/"
+  }
+end
+```
+
+Creating a role with a random name:
+```ruby
+When /^I(?: have)? created? a role with a random name of (#{CAPTURE_INTEGER}) characters?$/ do |characters|
+  name = Faker::Lorem.characters(characters)
+  steps %Q{
+    Given I am using the UDB3 development environment
+      And I am authorized as user "centraal_beheerder"
+      And I send and accept JSON
+     When I set the JSON request payload to:
+       """
+       { "name": "#{name}" }
+       """
+      And I send a POST request to "/roles/"
+  }
+end
+```
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/cucumber/http/http_steps.rb

@@ -44,7 +44,7 @@ When /^I send a (GET|POST|PATCH|PUT|DELETE) request to "([^"]*)"(?: with paramet
   endpoint = resolve(args.shift)
   params = args.shift
 
-  request_url = URI.join(url, endpoint).to_s
+  request_url = URI.join(url, URI::encode(endpoint)).to_s
 
   unless params.nil?
     if params.class == Cucumber::MultilineArgument::DataTable

data/lib/cucumber/http/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module Http
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/cucumber/http/world_extensions.rb

@@ -1,10 +1,10 @@
 require_relative 'world_extensions/json_spec_interface'
-require_relative 'world_extensions/url'
 require_relative 'world_extensions/headers'
 require_relative 'world_extensions/parameters'
 require_relative 'world_extensions/payload'
 require_relative 'world_extensions/request'
 require_relative 'world_extensions/response'
+require_relative 'world_extensions/url'
 
 World(JsonSpecInterface)
 World(Cucumber::Http::Headers)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-http
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kristof Willaert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Cucumber steps to easily test XML and JSON APIs