cucumber-http 0.5.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70917cc0394f65db06b914e26836bf920b17fc5120127679a53036d379ebe4c1
-  data.tar.gz: e0f37cc9f42f5ccaae713d2552fbd94de84f8d36c1384f981666bb0556515298
+  metadata.gz: 0232a60b32d3567ea573d9d14ed9f20855d73dab6606f0f34f4d99b73c466349
+  data.tar.gz: b7a4607176199b8ec28d08421006cee16c9a87f93550f6022ba0a4eb77130061
 SHA512:
-  metadata.gz: d046821b5b54f7a6ed66c5af93508960c3f5191255f9bae74ab683443434c91a87e817d7c5637c3925b1695682dd835a6e2ce53bc4dba53f020df6e9ee98c3a0
-  data.tar.gz: cf9804b017bb0c10f7ffa132af654fe0d1749b95d5fa06cd18a81e16c40529ca9adf035e385879bbfc35e74e1dd69f047843eeb58c6d1609c5d615934b35856e
+  metadata.gz: faec65815b43fc54d5e99dbfeeb901513d3d8626761f263de337d1f723bbac0283ae7e6fe1b3b93b6c436b4c5c3e7c883921952a5842cf347dcb68187aa9a0e7
+  data.tar.gz: 163dcbabd2c0b8d488ee9f945fa4d56505cc8b32692a3d3d23b906ae3a1bab8b53c12f4321e6d260c743ca2ad2bc51d47c73afccc0d324208cb2362c358672b5

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
@@ -90,6 +109,10 @@ Given /^I send "(.*?)" and accept JSON$/
 Given /^I send and accept JSON$/
 ```
 
+```ruby
+Given 'I set the form data properties to:'
+```
+
 ```ruby
 Given /^I set the JSON request payload to:$/
 ```
@@ -103,7 +126,15 @@ 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
@@ -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/configuration.rb

@@ -0,0 +1,7 @@
+module Cucumber
+  module Http
+    module Configuration
+      attr_accessor :data_directory
+    end
+  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,5 +1,3 @@
-require 'json_spec'
-
 Given /^I set headers?:$/ do |hdrs|
   hdrs.rows_hash.each { |name, value| add_header(name, value) }
 end
@@ -59,7 +57,7 @@ Given(/^I set the JSON request payload to:$/) do |payload|
 end
 
 Given(/^I set the JSON request payload from "(.*?)"$/) do |filename|
-  path = "#{Dir.pwd}/features/support/data/#{filename}"
+  path = "#{Cucumber::Http.data_directory}/#{filename}"
 
   if File.file? path
     set_payload(JSON.parse(resolve(File.read(path))).to_json)
@@ -68,6 +66,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)
@@ -88,16 +93,33 @@ 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        = "#{Cucumber::Http.data_directory}/#{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 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

data/lib/cucumber/http/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module Http
-    VERSION = "0.5.1"
+    VERSION = "0.7.1"
   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,6 +1,14 @@
-require 'cucumber/http/transforms'
 require 'cucumber/http/world_extensions'
 require 'cucumber/http/hooks'
 require 'cucumber/http/http_steps'
 require 'cucumber/http/benchmark_steps'
 require 'cucumber/http/debug_steps'
+require 'cucumber/http/configuration'
+require 'json_spec'
+require 'json_spec/cucumber'
+
+module Cucumber
+  module Http
+    extend Configuration
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-http
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Kristof Willaert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-03-01 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
@@ -72,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
@@ -104,14 +104,15 @@ files:
 - README.md
 - lib/cucumber/http.rb
 - lib/cucumber/http/benchmark_steps.rb
+- lib/cucumber/http/configuration.rb
 - 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

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