cucumber-http 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59c38771ab6ab918565cef8d236428c1454fd342
-  data.tar.gz: 80b809a9b7f1ea12963cff9581e44263c133ac8a
+SHA256:
+  metadata.gz: 3f339b7fcb6e66665649610987e764d35477b0863e41f858c655b9b42f2dd3d0
+  data.tar.gz: 649424fb563c9694a4fbc3abf55c84af851967b2c888f86eb44f63b69fbcf6bd
 SHA512:
-  metadata.gz: 10cb64500e459962ab3e75826e49a159bfe99e9bfce85214ba4220f4405f37368575d95548ab34f8f9716184feb6e380c28850ad004c618bc927f6f79dd24140
-  data.tar.gz: 88f97fa87c0031c282fd5a22b69234a663c39a22aa5804eb1ef46b8f9c7e47fb51100b0ceee13763086067e1f65623eaa7c91c1259f0566bccbd4cc39d01367a
+  metadata.gz: 228e304b1837735dc8c95b3f261c40ee29c8463d9e839de284dfd40b27ff495449c0d2b1890946984d76edfbad0f1691925bbc5cb5a841f853b0fbccec6028b7
+  data.tar.gz: 91d3f65830cadcbf13b7442c746183baede530983d37b4c5ede0f4b6e1064e9e04f083189139a055c0ddf54bbe32a180cd096ea866fb9a4bab02a73695ba4fa2

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 create 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 create 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/debug_steps.rb

@@ -1,14 +1,25 @@
+Then /^show me the request$/ do
+  puts "Method: " + request[:method]
+  puts "URL: " + request[:url]
+  puts "Parameters: " + request[:parameters].inspect
+  puts "Headers: " + request[:headers].inspect
+  puts "Payload: " + request[:payload].to_s
+end
+
 Then /^show me the( unparsed)? response$/ do |unparsed|
-  if unparsed
-    puts response[:body]
-  elsif response[:headers]['Content-Type'] =~ /json/
-    puts JSON.pretty_generate(JSON.parse(response['body']))
-  elsif response[:headers]['Content-Type'] =~ /xml/
-    puts Nokogiri::XML(response[:body])
-  else
-    puts response[:headers]
-    puts response[:body]
+  body = response[:body]
+
+  if unparsed.nil?
+    if response[:headers]['content-type'][0] =~ /json/
+      body = JSON.pretty_generate(JSON.parse(response[:body]))
+    elsif response[:headers]['content-type'][0] =~ /xml/
+      body = Nokogiri::XML(response[:body])
+    end
   end
+
+  puts "Status: " + response[:status].to_s
+  puts "Headers: " + response[:headers].map { |k,v| { k.split('-').map(&:capitalize).join('-') => v.join } }.reduce(:merge).to_s
+  puts "Body: " + body
 end
 
 Then /^show me the kept values?$/ do

data/lib/cucumber/http/hooks.rb

@@ -3,5 +3,6 @@ After do
   clear_parameters
   clear_headers
   clear_payload
+  clear_request
   clear_response
 end

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.3.0"
   end
 end

data/lib/cucumber/http/world_extensions/headers.rb

@@ -6,11 +6,11 @@ module Cucumber
       end
 
       def add_header(key, value)
-        headers[key.to_sym] = value
+        headers[key] = value
       end
 
       def remove_header(key)
-        headers.tap { |hdrs| hdrs.delete(key.to_sym)}
+        headers.tap { |hdrs| hdrs.delete(key)}
       end
 
       def clear_headers

data/lib/cucumber/http/world_extensions/parameters.rb

@@ -6,11 +6,11 @@ module Cucumber
       end
 
       def add_parameter(key, value)
-        parameters[key.to_sym] = value
+        parameters[key] = value
       end
 
       def remove_parameter(key)
-        parameters.tap { |pars| pars.delete(key.to_sym)}
+        parameters.tap { |pars| pars.delete(key)}
       end
 
       def clear_parameters

data/lib/cucumber/http/world_extensions/request.rb

@@ -3,6 +3,14 @@ require 'rest-client'
 module Cucumber
   module Http
     module Request
+      def request
+        @request ||= {}
+      end
+
+      def set_request(key, value)
+        request[key.to_sym] = value
+      end
+
       def perform_request(method, path)
         add_header('params', parameters)
 
@@ -17,9 +25,19 @@ module Cucumber
           r = e.response
         end
 
+        set_request('url', path)
+        set_request('method', method.upcase)
+        set_request('headers', headers)
+        set_request('parameters', parameters)
+        set_request('payload', payload)
+
         set_response('status', r.code)
         set_response('body', r.body)
-        set_response('headers', r.headers)
+        set_response('headers', r.raw_headers)
+      end
+
+      def clear_request
+        request.clear
       end
     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,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-http
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kristof Willaert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ dependencies:
         version: '1.9'
 description: Cucumber steps to easily test external XML and JSON APIs
 email:
-- kristof.willaert@cultuurnet.be
+- kristof.willaert@publiq.be
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -150,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Cucumber steps to easily test XML and JSON APIs