cucumber-http 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 760307f677ade8fcdc3a4b6629f7143e311377f2856d57664f0a4ccfed60fa24
-  data.tar.gz: 68e7faacc18737c3ef9ceb560ae4f362610dfeaf92a4fa08dd0723c2ef36827b
+  metadata.gz: 505a70f70933a819f67d4fa163985fe75115233481959ff1742cffc61cac4adb
+  data.tar.gz: 2ae449691aa78c1008fedf802b5309cf0f74b29b75d08fa1e274335b0e0630e0
 SHA512:
-  metadata.gz: 8500cc4964f737ee94d3a28ceb1f10c1b2996e29171f04219ba7e0ed0039b996190a4d1ec57bbaae56d5bdf1eb8ae5a0422440f69561b6398cb1ab645651967d
-  data.tar.gz: 9373aad646952bac2bb998744238f5ff7f143531c385df8e4cf391f429fe2560af3c37f6c60ad66b985cd99f0ecf2366701b2c3d284ea2438c4c5951be205e2f
+  metadata.gz: 46653d3f35be042a2f0c10333e241cffc4c4ae64e10731b6e6b10769d9809e764eb8ebf4932b1ab402eb598781cde0531f55d0e16acde1d6bd34b5a5b2199d88
+  data.tar.gz: 17d7bbabe915ec23ca015a39806f275e4ae44f0d90d6b65b4f71a92666f6fb406f310bbdd6df69a2b9147bb738f4b76bbb102b2c0e4ee3f6ca01c5fb7a3cf77c

data/README.md

@@ -50,6 +50,25 @@ Feature: Test the UDB3 labels API
      And the JSON response at "privacy" should be "public"
 ```
 
+```ruby
+@api @images
+Feature: Test the UDB3 image API
+
+  Background:
+    Given I am using the UDB3 development environment
+     And I am authorized as user "centraal_beheerder"
+     And I accept "application/json"
+
+   @imagecreate
+   Scenario: Create image
+     Given I set the form data properties to:
+        | description     | logo |
+        | copyrightHolder | me   |
+        | language        | nl   |
+     When I upload "file" from path "images/UDB.jpg" to "/images/"
+     Then the response status should be "201"
+```
+
 #### Benchmarking
 
 ```ruby
@@ -57,7 +76,7 @@ Given /^I am benchmarking$/
 ```
 
 ```ruby
-Then /^the elapsed time should be less than (#{CAPTURE_FLOAT}) seconds?$/
+Then 'the elapsed time should be less than {float} second(s)'
 ```
 
 #### HTTP
@@ -83,11 +102,15 @@ Given /^I send "(.*?)" and accept "(.*?)"$/
 ```
 
 ```ruby
-Given /^I send "(.*?)" and accept (XML|JSON)$/
+Given /^I send "(.*?)" and accept JSON$/
 ```
 
 ```ruby
-Given /^I send and accept (XML|JSON)$/
+Given /^I send and accept JSON$/
+```
+
+```ruby
+Given 'I set the form data properties to:'
 ```
 
 ```ruby
@@ -103,11 +126,19 @@ When /^I send a (GET|POST|PATCH|PUT|DELETE) request to "([^"]*)"(?: with paramet
 ```
 
 ```ruby
-Then /^the response status should( not)? be "(#{CAPTURE_INTEGER})"$/
+When 'I upload {string} from path {string} to {string}"'
+```
+
+```ruby
+Then 'the response status should be "{int}"'
+```
+
+```ruby
+Then 'the response status should not be "{int}"'
 ```
 
 ```ruby
-Then /^the response body should be valid (XML|JSON)$/
+Then /^the response body should be valid JSON$/
 ```
 
 #### Debugging
@@ -138,7 +169,7 @@ Examples for testing the [REST API](https://apidoc.uitdatabank.be) of
 
 Creating an organizer with a random name:
 ```ruby
-When /^I create an organizer with a random name of (#{CAPTURE_INTEGER}) characters?$/ do |characters|
+When 'I create an organizer with a random name of {integer} character(s)' do |characters|
   name = Faker::Lorem.characters(characters)
   steps %Q{
     Given I am using the UDB3 development environment
@@ -155,7 +186,7 @@ end
 
 Creating a role with a random name:
 ```ruby
-When /^I create a role with a random name of (#{CAPTURE_INTEGER}) characters?$/ do |characters|
+When 'I create a role with a random name of {integer} character(s)' do |characters|
   name = Faker::Lorem.characters(characters)
   steps %Q{
     Given I am using the UDB3 development environment

data/lib/cucumber/http/benchmark_steps.rb

@@ -2,7 +2,7 @@ Given /^I am benchmarking$/ do
   @scenario_start_time = Time.now
 end
 
-Then /^the elapsed time should be less than (#{CAPTURE_FLOAT}) seconds?$/ do |time|
+Then 'the elapsed time should be less than {float} second(s)' do |time|
   elapsed = Time.now - @scenario_start_time
 
   expect(elapsed).to be < time

data/lib/cucumber/http/debug_steps.rb

@@ -12,8 +12,6 @@ Then /^show me the( unparsed)? response$/ do |unparsed|
   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
 

data/lib/cucumber/http/hooks.rb

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

data/lib/cucumber/http/http_steps.rb

@@ -1,4 +1,3 @@
-require 'nokogiri'
 require 'json_spec'
 
 Given /^I set headers?:$/ do |hdrs|
@@ -35,19 +34,19 @@ Given /^I send "(.*?)" and accept "(.*?)"$/ do |content_type, accept_type|
   }
 end
 
-Given /^I send "(.*?)" and accept (XML|JSON)$/ do |content_type, accept_type|
+Given /^I send "(.*?)" and accept JSON$/ do |content_type|
   steps %Q{
     Given I set headers:
-      | Content-Type | #{content_type}                     |
-      | Accept       | application/#{accept_type.downcase} |
+      | Content-Type | #{content_type}  |
+      | Accept       | application/json |
   }
 end
 
-Given /^I send and accept (XML|JSON)$/ do |type|
+Given /^I send and accept JSON$/ do
   steps %Q{
     Given I set headers:
-      | Content-Type | application/#{type.downcase} |
-      | Accept       | application/#{type.downcase} |
+      | Content-Type | application/json |
+      | Accept       | application/json |
   }
 end
 
@@ -69,6 +68,13 @@ Given(/^I set the JSON request payload from "(.*?)"$/) do |filename|
   end
 end
 
+Given 'I set the form data properties to:' do |table|
+  table.rows_hash.each { |name, value| add_multipart_payload(name, value) }
+
+  remove_header('Content-Type')
+  add_multipart_payload('multipart', true)
+end
+
 When /^I send a (GET|POST|PATCH|PUT|DELETE) request to "([^"]*)"(?: with parameters?:)?$/ do |*args|
   method = args.shift
   endpoint = resolve(args.shift)
@@ -89,23 +95,35 @@ When /^I send a (GET|POST|PATCH|PUT|DELETE) request to "([^"]*)"(?: with paramet
   perform_request(method, request_url)
 end
 
+When 'I upload {string} from path {string} to {string}' do |key, filename, endpoint|
+  method      = 'post'
+  payload_key = key
+  path        = "#{Dir.pwd}/features/support/data/#{filename}"
+
+  request_url = URI.join(url, URI::encode(endpoint)).to_s
+
+  if File.file? path
+    remove_header('Content-Type')
+    add_multipart_payload(payload_key, File.new(path, 'rb'))
+  else
+    raise "File not found: '#{path}'"
+  end
+
+  perform_request(method, request_url)
+end
+
 When /^(?:I )?keep the value of the (?:JSON|json)(?: response)?(?: at "(.*)")? as "(.*)"$/ do |path, key|
   JsonSpec.memorize(key, parse_json(last_json, path))
 end
 
-Then /^the response status should( not)? be "(#{CAPTURE_INTEGER})"$/ do |negative, status_code|
-  if negative
-    expect(response[:status]).not_to eq(status_code)
-  else
-    expect(response[:status]).to eq(status_code)
-  end
+Then 'the response status should be "{int}"' do |status_code|
+  expect(response[:status]).to eq(status_code)
 end
 
-Then /^the response body should be valid (XML|JSON)$/ do |type|
-  case type
-  when 'XML'
-    expect { Nokogiri::XML(response[:body]) { |config| config.strict } }.not_to raise_error
-  when 'JSON'
-    expect { JSON.parse(response[:body]) }.not_to raise_error
-  end
+Then 'the response status should not be "{int}"' do |status_code|
+  expect(response[:status]).not_to eq(status_code)
+end
+
+Then /^the response body should be valid JSON$/ do
+  expect { JSON.parse(response[:body]) }.not_to raise_error
 end

data/lib/cucumber/http/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module Http
-    VERSION = "0.4.0"
+    VERSION = "0.7.0"
   end
 end

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

@@ -0,0 +1,21 @@
+module Cucumber
+  module Http
+    module Payload
+      def multipart_payload
+        @multipart_payload ||= {}
+      end
+
+      def add_multipart_payload(key, value)
+        multipart_payload[key] = value
+      end
+
+      def remove_multipart_payload(key)
+        multipart_payload.tap { |p| p.delete(key)}
+      end
+
+      def clear_multipart_payload
+        multipart_payload.clear
+      end
+    end
+  end
+end

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

@@ -14,12 +14,14 @@ module Cucumber
       def perform_request(method, path)
         add_header('params', parameters)
 
+        request_payload = multipart_payload.empty? ? payload : multipart_payload
+
         begin
           r = RestClient::Request.execute(
             method: method.downcase,
             url: path,
             headers: headers,
-            payload: payload
+            payload: request_payload
           )
         rescue RestClient::Exception => e
           r = e.response
@@ -27,13 +29,16 @@ module Cucumber
 
         set_request('url', path)
         set_request('method', method.upcase)
-        set_request('headers', headers)
+        set_request('headers', headers.tap { |hdrs| hdrs.delete('params')})
         set_request('parameters', parameters)
-        set_request('payload', payload)
+        set_request('payload', request_payload)
 
         set_response('status', r.code)
         set_response('body', r.body)
         set_response('headers', r.raw_headers)
+
+        clear_multipart_payload
+        clear_payload
       end
 
       def clear_request

data/lib/cucumber/http/world_extensions.rb

@@ -2,6 +2,7 @@ require_relative 'world_extensions/json_spec_interface'
 require_relative 'world_extensions/headers'
 require_relative 'world_extensions/parameters'
 require_relative 'world_extensions/payload'
+require_relative 'world_extensions/multipart_payload'
 require_relative 'world_extensions/request'
 require_relative 'world_extensions/response'
 require_relative 'world_extensions/url'

data/lib/cucumber/http.rb

@@ -1,4 +1,3 @@
-require 'cucumber/http/transforms'
 require 'cucumber/http/world_extensions'
 require 'cucumber/http/hooks'
 require 'cucumber/http/http_steps'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-http
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kristof Willaert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json_spec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-description: Cucumber steps to easily test external XML and JSON APIs
+description: Cucumber steps to easily test external JSON APIs
 email:
 - kristof.willaert@publiq.be
 executables: []
@@ -121,11 +107,11 @@ files:
 - lib/cucumber/http/debug_steps.rb
 - lib/cucumber/http/hooks.rb
 - lib/cucumber/http/http_steps.rb
-- lib/cucumber/http/transforms.rb
 - lib/cucumber/http/version.rb
 - lib/cucumber/http/world_extensions.rb
 - lib/cucumber/http/world_extensions/headers.rb
 - lib/cucumber/http/world_extensions/json_spec_interface.rb
+- lib/cucumber/http/world_extensions/multipart_payload.rb
 - lib/cucumber/http/world_extensions/parameters.rb
 - lib/cucumber/http/world_extensions/payload.rb
 - lib/cucumber/http/world_extensions/request.rb
@@ -153,5 +139,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Cucumber steps to easily test XML and JSON APIs
+summary: Cucumber steps to easily test JSON APIs
 test_files: []

data/lib/cucumber/http/transforms.rb

@@ -1,7 +0,0 @@
-CAPTURE_INTEGER = Transform /^(-?\d+)$/ do |number_string|
-  number_string.to_i
-end
-
-CAPTURE_FLOAT = Transform /^(-?[\d.]+)$/ do |number_string|
-  number_string.to_f
-end