cucumber-api-steps 0.4 → 0.5

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.DS_Store

data/README.md

@@ -0,0 +1,35 @@
+# Cucumber API Steps
+
+A set of [Cucumber](https://github.com/aslakhellesoy/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.
+
+## Dependencies
+
+Requires [Cucumber](https://github.com/aslakhellesoy/cucumber) (obviously).  Also makes use of [JSONPath](https://github.com/joshbuddy/jsonpath) for setting criteria against JSON responses.  See the gemspec for more info.
+
+## Installation
+
+Add the following line to your Gemfile, preferably in the test or cucumber group:
+
+    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'
+  
+# 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.  
+
+One major caveat is that the way the steps are currently built, the PUT and POST steps accept a heredoc-style string (demarcated with lines of three double quotes) as a body, instead of a hash as many people seem to expect.  I found this way to be more natural/flexible for how I write API tests, but it seems like others do not, so I'll be changing the steps to accept either a hash or a string soon.
+
+# Contributors
+* Jay Zeschin
+* Justin Smestad
+
+## Copyright
+
+Copyright (c) 2011 Jay Zeschin. Distributed under the MIT License.

data/Rakefile

@@ -2,4 +2,10 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'bueller'
-Bueller::Tasks.new
+Bueller::Tasks.new
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end

data/cucumber-api-steps.gemspec

@@ -12,9 +12,10 @@ Gem::Specification.new do |s|
   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.add_dependency 'jsonpath', '>= 0.1.2'
-  s.add_dependency 'cucumber', '>= 0.8.3'
-  s.add_development_dependency 'bueller'
+  s.add_dependency              'jsonpath', '>= 0.1.2'
+  s.add_dependency              'cucumber',  '>= 0.8.3'
+  s.add_development_dependency  'bueller'
+  s.add_development_dependency  'capybara'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+require 'capybara/cucumber'
+
+# Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In
+# order to ease the transition to Capybara we set the default here. If you'd
+# prefer to use XPath just remove this line and adjust any selectors in your
+# steps to use the XPath syntax.
+Capybara.default_selector = :css
+Capybara.default_driver = :rack_test
+
+require 'cucumber/api_steps'

data/lib/cucumber/api_steps.rb

@@ -2,80 +2,71 @@ require 'jsonpath'
 
 World(Rack::Test::Methods)
 
-Given /^I send and accept XML$/ do
-  page.driver.header 'Accept', 'text/xml'
-  page.driver.header 'Content-Type', 'text/xml'
+Given /^I send and accept (XML|JSON)$/ do |type|
+  page.driver.header 'Accept', "text/#{type.downcase}"
+  page.driver.header 'Content-Type', "text/#{type.downcase}"
 end
 
-Given /^I send and accept JSON$/ do
-  page.driver.header 'Accept', 'application/json'
-  page.driver.header 'Content-Type', 'application/json'
-end
-
-When /^I authenticate as the user "([^\"]*)" with the password "([^\"]*)"$/ do |user, pass|
-  page.driver.authorize(user, pass)
-end
-
-When /^I send a GET request (?:for|to) "([^\"]*)"$/ do |path|
-  page.driver.get path
-end
-
-When /^I send a POST request to "([^\"]*)"$/ do |path|
-  page.driver.post path
-end
-
-When /^I send a POST request to "([^\"]*)" with the following:$/ do |path, body|
-  page.driver.post path, body
-end
-
-When /^I send a PUT request to "([^\"]*)" with the following:$/ do |path, body|
-  page.driver.put path, body
+When /^I authenticate as the user "([^"]*)" with the password "([^"]*)"$/ do |user, pass|
+  if page.driver.respond_to?(:basic_auth)
+    page.driver.basic_auth(user, pass)
+  elsif page.driver.respond_to?(:basic_authorize)
+    page.driver.basic_authorize(user, pass)
+  elsif page.driver.respond_to?(:browser) && page.driver.browser.respond_to?(:basic_authorize)
+    page.driver.browser.basic_authorize(user, pass)
+  elsif page.driver.respond_to?(:authorize)
+    page.driver.authorize(user, pass)
+  else
+    raise "Can't figure out how to log in with the current driver!"
+  end
 end
 
-When /^I send a DELETE request to "([^\"]*)"$/ do |path|
-  page.driver.delete path
+When /^I send a (GET|POST|PUT|DELETE) request (?:for|to) "([^"]*)"(?: with the following:)?$/ do |request_type, path, body|
+  if body.present?
+    page.driver.send(request_type.downcase.to_sym, path, body)
+  else
+    page.driver.send(request_type.downcase.to_sym, path)
+  end
 end
 
 Then /^show me the response$/ do
-  p page.driver.last_response
+  p page.driver.response
 end
 
-Then /^the response status should be "([^\"]*)"$/ do |status|
+Then /^the response status should be "([^"]*)"$/ do |status|
   if page.respond_to? :should
-    page.driver.last_response.status.should == status.to_i
+    page.driver.response.status.should == status.to_i
   else
-    assert_equal status.to_i, page.driver.last_response.status
+    assert_equal status.to_i, page.driver.response.status
   end
 end
 
-Then /^the JSON response should have "([^\"]*)" with the text "([^\"]*)"$/ do |json_path, text|
-  json    = JSON.parse(page.driver.last_response.body)
+Then /^the JSON response should (not)?\s?have "([^"]*)" with the text "([^"]*)"$/ do |negative, json_path, text|
+  json    = JSON.parse(page.driver.response.body)
   results = JsonPath.new(json_path).on(json).to_a.map(&:to_s)
-  if page.respond_to? :should
-    results.should include(text)
+  if page.respond_to?(:should)
+    if negative.present?
+      results.should_not include(text)
+    else
+      results.should include(text)
+    end
   else
-    assert results.include?(text)
+    if negative.present?
+      assert !results.include?(text)
+    else
+      assert results.include?(text)
+    end
   end
 end
 
-Then /^the JSON response should not have "([^\"]*)" with the text "([^\"]*)"$/ do |json_path, text|
-  json    = JSON.parse(page.driver.last_response.body)
-  results = JsonPath.new(json_path).on(json).to_a.map(&:to_s) 
-  if page.respond_to? :should
-    results.should_not include(text)
-  else
-    assert !results.include?(text)
-  end
-end
-
-Then /^the XML response should have "([^\"]*)" with the text "([^\"]*)"$/ do |xpath, text|
+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 page.respond_to? :should
+  if page.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}"
   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}"
-  end    
-end
+  end
+end

data/lib/cucumber/api_steps/version.rb

@@ -1,5 +1,5 @@
 module Cucumber
   module ApiSteps
-    VERSION = "0.4"
+    VERSION = "0.5"
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-api-steps
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
-  - 4
-  version: "0.4"
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Jay Zeschin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 -06:00
+date: 2011-10-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Cucumber steps to easily test REST-based XML and JSON APIs
 email: 
 - jay.zeschin@factorylabs.com
@@ -76,8 +90,10 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
+- README.md
 - Rakefile
 - cucumber-api-steps.gemspec
+- features/support/env.rb
 - lib/cucumber/api_steps.rb
 - lib/cucumber/api_steps/version.rb
 has_rdoc: true
@@ -110,9 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Cucumber steps to easily test REST-based XML and JSON APIs
-test_files: []
-
+test_files: 
+- features/support/env.rb