cucumber-api-steps 0.13 → 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: beed2bd382872e4de2fc3b3b0ada4d4939a92f2d
+  data.tar.gz: 6adf6b1020a01d5e8ead8fe4af3ba1429e89c9d9
+SHA512:
+  metadata.gz: 3a73d19cd6789f60cd0afdd36f8787832d9d2d0e30af243c1a63596668b92592eaa3f02f2ea720c16653a8d856de0c4ec7d984e2227e3488bdc9c22b34faa767
+  data.tar.gz: 7761f745dd825681491b9446a500314a48ffff9d6710cb56990018c75e1d06b6535cdd2c1941b2349b0f50f9f652126e02e302eb2e310effc36570cbe8d23cb7

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
+  - "2.1.2"
   - jruby-19mode # JRuby in 1.9 mode
   - jruby-20mode # JRuby in 1.9 mode

data/README.md

@@ -3,11 +3,11 @@
 [![Build Status](https://travis-ci.org/jayzes/cucumber-api-steps.png)](https://travis-ci.org/jayzes/cucumber-api-steps)
 [![Gem Version](https://badge.fury.io/rb/cucumber-api-steps.png)](http://badge.fury.io/rb/cucumber-api-steps)
 
-A set of [Cucumber](https://github.com/aslakhellesoy/cucumber) step definitions utilizing
+A set of [Cucumber](https://github.com/cucumber/cucumber) step definitions utilizing
 [Rack-Test](https://github.com/brynary/rack-test) that ease basic
 testing of REST-style APIs using either XML or JSON formats.
 
-Adapted from [a blog post by Anthony Eden](http://www.anthonyeden.com/2010/11/testing-rest-apis-with-cucumber-and-rack-test/) with a few additions based on my own needs.  I found myself copying these step definitions around to multiple projects, and decided that it would be worthwhile to gem them up to keep things nice and DRY.
+Adapted from [a blog post by Anthony Eden](http://anthonyeden.com/2013/07/10/testing-rest-apis-with-cucumber-and-rack.html) with a few additions based on my own needs.  I found myself copying these step definitions around to multiple projects, and decided that it would be worthwhile to gem them up to keep things nice and DRY.
 
 ## Dependencies
 
@@ -17,60 +17,64 @@ Requires [Cucumber](https://github.com/aslakhellesoy/cucumber) (obviously).  Als
 
 Add the following line to your Gemfile, preferably in the test or cucumber group:
 
-    gem 'cucumber-api-steps', :require => false
+```ruby
+gem 'cucumber-api-steps', :require => false
+```
 
 Then add the following line to your env.rb to make the step definitions available in your features:
 
-    require 'cucumber/api_steps'
+```ruby
+require 'cucumber/api_steps'
+```
 
 # Usage
 
 Still a work in progress.  For now, read the api_steps.rb file or check out the [stashboard-rails](https://github.com/jayzes/stashboard-rails) project - its Cucumber features make extensive use of the steps in this gem.
 
 # Examples
-
-    Feature: API
-
-      Scenario: List tweets in JSON
-        When I send and accept JSON
-        And I send a GET request to "/api/tweets"
-        Then the response status should be "200"
-        And the JSON response should be:
-          """
-          [{"tweet":"Hello World!"},{"tweet":"New Rails has been released"}]
-          """
-        And the JSON response should have "$..tweet" with the text "Hello World!"
-        And the JSON response should have "$..tweet" with a length of 2
-
-      Scenario: List tweets in XML
-        When I send and accept XML
-        And I send a GET request to "/api/tweets"
-        Then the XML response should have "tweet" with text "Hello World!"
-
-      Scenario: Post tweet using POST-params
-        When I send a POST request to "/api/tweets" with the following:
-          | tweet | Hello World! |
-          | lat   | 42.848282    |
-          | lng   | 74.634933    |
-        Then the response status should be "201"
-
-      Scenario: Post tweet using json in POST body
-        When I send a POST request to "/api/tweets" with the following:
-          """
-          {"tweet":"Hello World!","lat":"42.848282", "lng":"74.634933"}
-          """
-        Then the response status should be "201"
-
-      Scenario: Basic authentication
-        When I authenticate as the user "joe" with the password "password123"
-        And I send a GET request to "/api/tweets"
-        Then the response status should be "200"
-
-      Scenario: Digest authentication
-        When I digest-authenticate as the user "joe" with the password "password123"
-        And I send a GET request to "/api/tweets"
-        Then the response status should be "200"
-
+```cucumber
+Feature: API
+
+  Scenario: List tweets in JSON
+    When I send and accept JSON
+    And I send a GET request to "/api/tweets"
+    Then the response status should be "200"
+    And the JSON response should be:
+      """
+      [{"tweet":"Hello World!"},{"tweet":"New Rails has been released"}]
+      """
+    And the JSON response should have "$..tweet" with the text "Hello World!"
+    And the JSON response should have "$..tweet" with a length of 2
+
+  Scenario: List tweets in XML
+    When I send and accept XML
+    And I send a GET request to "/api/tweets"
+    Then the XML response should have "tweet" with text "Hello World!"
+
+  Scenario: Post tweet using POST-params
+    When I send a POST request to "/api/tweets" with the following:
+      | tweet | Hello World! |
+      | lat   | 42.848282    |
+      | lng   | 74.634933    |
+    Then the response status should be "201"
+
+  Scenario: Post tweet using json in POST body
+    When I send a POST request to "/api/tweets" with the following:
+      """
+      {"tweet":"Hello World!","lat":"42.848282", "lng":"74.634933"}
+      """
+    Then the response status should be "201"
+
+  Scenario: Basic authentication
+    When I authenticate as the user "joe" with the password "password123"
+    And I send a GET request to "/api/tweets"
+    Then the response status should be "200"
+
+  Scenario: Digest authentication
+    When I digest-authenticate as the user "joe" with the password "password123"
+    And I send a GET request to "/api/tweets"
+    Then the response status should be "200"
+```
 # Contributors
 * Jay Zeschin
 * Justin Smestad

data/cucumber-api-steps.gemspec

@@ -7,16 +7,18 @@ Gem::Specification.new do |s|
   s.version     = Cucumber::ApiSteps::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jay Zeschin"]
-  s.email       = ["jay.zeschin@modeset.com"]
+  s.email       = ["jay@zeschin.org"]
   s.homepage    = "http://github.com/jayzes/cucumber-api-steps"
   s.summary     = %q{Cucumber steps to easily test REST-based XML and JSON APIs}
   s.description = %q{Cucumber steps to easily test REST-based XML and JSON APIs}
 
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_dependency              'jsonpath', '>= 0.1.2'
-  s.add_dependency              'cucumber',  '>= 1.2.1'
-  s.add_dependency              'rspec',  '>= 2.12.0'
+  s.add_dependency              'jsonpath',       '>= 0.1.2'
+  s.add_dependency              'cucumber',       '>= 2.0.2'
+  s.add_development_dependency  'activesupport',  '>= 3.0.0'
+  s.add_development_dependency  'rspec',          '~> 3.3.0'
+  s.add_development_dependency  'sinatra',        '~> 1.4.3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/features/fixtures/fake_app.rb

@@ -15,7 +15,7 @@ module CucumberApiSteps
       if request.accept.empty? || request.accept?('application/json')
         content_type :json
         books.to_json
-      elsif request.accept?('application/xml') 
+      elsif request.accept?('application/xml')
         content_type :xml
         books.to_xml
       end
@@ -25,6 +25,10 @@ module CucumberApiSteps
       status 201 if params.values == ["Metaprograming ruby", "Pragprog"]
     end
 
+    patch '/api/books' do
+      status 200 if params.values == ["Metaprograming ruby", "Pragprog"]
+    end
+
     post '/api/publishers' do
       input_data = JSON.parse request.env["rack.input"].read, symbolize_names: true
       status 201 if input_data == {publisher: 'Pragprog'}

data/features/request.feature

@@ -16,6 +16,15 @@ Feature:
       """
     Then the response status should be "201"
 
+  Scenario: PATCH request with params
+    When I perform the following step with table:
+      """
+      I send a PATCH request to "/api/books" with the following:
+      | title     | Metaprograming ruby |
+      | publisher | Pragprog            |
+      """
+    Then the response status should be "200"
+
   Scenario: POST request with string
     When I perform the following step with string:
       """

data/features/step_definitions/api_test_steps.rb

@@ -1,3 +1,4 @@
+require 'active_support'
 require 'active_support/core_ext'
 
 When /^I perform the following steps?:$/ do |step_strings|
@@ -6,7 +7,7 @@ When /^I perform the following steps?:$/ do |step_strings|
 end
 
 Then /^the response should equal:$/ do |response_body|
-  last_response.body.should eq(response_body)
+  expect(last_response.body).to eq(response_body)
 end
 
 When /^I perform the following step with table:$/ do |step_definition|
@@ -32,13 +33,13 @@ end
 Then /^the request headers should be:$/ do |headers|
   headers_hash = headers.rows_hash
   request '/'
-  last_request.env.slice(*headers_hash.keys).values.should eq(headers_hash.values)
+  expect(last_request.env.slice(*headers_hash.keys).values).to eq(headers_hash.values)
 end
 
 Then /^I should be authenticated$/ do
-  last_request.env["HTTP_AUTHORIZATION"].should eq("Basic #{Base64.encode64("joe:god")}")
+  expect(last_request.env["HTTP_AUTHORIZATION"]).to eq("Basic #{Base64.encode64("joe:god")}")
 end
 
 Then /^I should be digest authenticated$/ do
-  last_request.env["HTTP_AUTHORIZATION"].starts_with?("Digest ").should be_true
+  expect(last_request.env["HTTP_AUTHORIZATION"].starts_with?("Digest ")).to be true
 end

data/lib/cucumber/api_steps.rb

@@ -36,7 +36,7 @@ When /^I digest\-authenticate as the user "(.*?)" with the password "(.*?)"$/ do
   digest_authorize user, pass
 end
 
-When /^I send a (GET|POST|PUT|DELETE) request (?:for|to) "([^"]*)"(?: with the following:)?$/ do |*args|
+When /^I send a (GET|PATCH|POST|PUT|DELETE) request (?:for|to) "([^"]*)"(?: with the following:)?$/ do |*args|
   request_type = args.shift
   path = args.shift
   input = args.shift
@@ -44,10 +44,10 @@ When /^I send a (GET|POST|PUT|DELETE) request (?:for|to) "([^"]*)"(?: with the f
   request_opts = {method: request_type.downcase.to_sym}
 
   unless input.nil?
-    if input.class == Cucumber::Ast::Table
+    if input.class == Cucumber::MultilineArgument::DataTable
       request_opts[:params] = input.rows_hash
     else
-      request_opts[:input] = input
+      request_opts[:input] = StringIO.new input
     end
   end
 
@@ -69,8 +69,8 @@ Then /^show me the (unparsed)?\s?response$/ do |unparsed|
 end
 
 Then /^the response status should be "([^"]*)"$/ do |status|
-  if self.respond_to? :should
-    last_response.status.should == status.to_i
+  if self.respond_to?(:expect)
+    expect(last_response.status).to eq(status.to_i)
   else
     assert_equal status.to_i, last_response.status
   end
@@ -79,11 +79,11 @@ end
 Then /^the JSON response should (not)?\s?have "([^"]*)"$/ do |negative, json_path|
   json    = JSON.parse(last_response.body)
   results = JsonPath.new(json_path).on(json).to_a.map(&:to_s)
-  if self.respond_to?(:should)
+  if self.respond_to?(:expect)
     if negative.present?
-      results.should be_empty
+      expect(results).to be_empty
     else
-      results.should_not be_empty
+      expect(results).not_to be_empty
     end
   else
     if negative.present?
@@ -98,11 +98,11 @@ end
 Then /^the JSON response should (not)?\s?have "([^"]*)" with the text "([^"]*)"$/ do |negative, json_path, text|
   json    = JSON.parse(last_response.body)
   results = JsonPath.new(json_path).on(json).to_a.map(&:to_s)
-  if self.respond_to?(:should)
+  if self.respond_to?(:expect)
     if negative.present?
-      results.should_not include(text)
+      expect(results).not_to include(text)
     else
-      results.should include(text)
+      expect(results).to include(text)
     end
   else
     if negative.present?
@@ -116,11 +116,11 @@ end
 Then /^the XML response should (not)?\s?have "([^"]*)"$/ do |negative, xpath|
   parsed_response = Nokogiri::XML(last_response.body)
   elements = parsed_response.xpath(xpath)
-  if self.respond_to?(:should)
+  if self.respond_to?(:expect)
     if negative.present?
-      elements.should be_empty
+      expect(elements).to be_empty
     else
-      elements.should_not be_empty
+      expect(elements).not_to be_empty
     end
   else
     if negative.present?
@@ -134,9 +134,9 @@ end
 Then /^the XML response should have "([^"]*)" with the text "([^"]*)"$/ do |xpath, text|
   parsed_response = Nokogiri::XML(last_response.body)
   elements = parsed_response.xpath(xpath)
-  if self.respond_to?(:should)
-    elements.should_not be_empty, "could not find #{xpath} in:\n#{last_response.body}"
-    elements.find { |e| e.text == text }.should_not be_nil, "found elements but could not find #{text} in:\n#{elements.inspect}"
+  if self.respond_to?(:expect)
+    expect(elements).not_to be_empty, "could not find #{xpath} in:\n#{last_response.body}"
+    expect(elements.find { |e| e.text == text }).not_to be_nil, "found elements but could not find #{text} in:\n#{elements.inspect}"
   else
     assert !elements.empty?, "could not find #{xpath} in:\n#{last_response.body}"
     assert elements.find { |e| e.text == text }, "found elements but could not find #{text} in:\n#{elements.inspect}"
@@ -147,8 +147,8 @@ Then /^the JSON response should be:$/ do |json|
   expected = JSON.parse(json)
   actual = JSON.parse(last_response.body)
 
-  if self.respond_to?(:should)
-    actual.should == expected
+  if self.respond_to?(:expect)
+    expect(actual).to eq(expected)
   else
     assert_equal actual, response
   end
@@ -157,8 +157,8 @@ end
 Then /^the JSON response should have "([^"]*)" with a length of (\d+)$/ do |json_path, length|
   json = JSON.parse(last_response.body)
   results = JsonPath.new(json_path).on(json)
-  if self.respond_to?(:should)
-    results.length.should == length.to_i
+  if self.respond_to?(:expect)
+    expect(results.length).to eq(length.to_i)
   else
     assert_equal length.to_i, results.length
   end

data/lib/cucumber/api_steps/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module ApiSteps
-    VERSION = "0.13"
+    VERSION = "0.14.0"
   end
 end

metadata

@@ -1,74 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-api-steps
 version: !ruby/object:Gem::Version
-  version: '0.13'
-  prerelease: 
+  version: 0.14.0
 platform: ruby
 authors:
 - Jay Zeschin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-09 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :runtime
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 1.4.3
 description: Cucumber steps to easily test REST-based XML and JSON APIs
 email:
-- jay.zeschin@modeset.com
+- jay@zeschin.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -84,27 +104,26 @@ files:
 - lib/cucumber/api_steps/version.rb
 homepage: http://github.com/jayzes/cucumber-api-steps
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cucumber steps to easily test REST-based XML and JSON APIs
 test_files:
 - features/authentication.feature

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@cucumber-api-steps