api_spec 0.9

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.3@api_spec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in api_spec.gemspec
+gemspec

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

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

data/api_spec.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "api_spec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api_spec"
+  s.version     = ApiSpec::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jay Zeschin", "Joseph DelCioppio"]
+  s.email       = ["jay.zeschin@factorylabs.com", "joe@rentingsmart.com"]
+  s.homepage    = "http://github.com/rentingsmart/api_spec"
+  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_development_dependency  'capybara'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

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 'api_spec/cucumber'

data/lib/api_spec/cucumber.rb

@@ -0,0 +1,76 @@
+require 'jsonpath'
+
+World(Rack::Test::Methods)
+
+Given /^I send and accept (XML|JSON)$/ do |type|
+  page.driver.header 'Accept', "application/#{type.downcase}"
+  page.driver.header 'Content-Type', "application/#{type.downcase}"
+end
+
+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 (GET|POST|PUT|DELETE) request (?:for|to) "([^"]*)"(?: with the following:)?$/ do |*args|
+  request_type = args.shift
+  path = args.shift
+  body = args.shift
+  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.response
+end
+
+Then /^the response status should be "([^"]*)"$/ do |status|
+  if page.respond_to? :should
+    page.driver.response.status.should == status.to_i
+  else
+    assert_equal status.to_i, page.driver.response.status
+  end
+end
+
+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)
+    if negative.present?
+      results.should_not include(text)
+    else
+      results.should include(text)
+    end
+  else
+    if negative.present?
+      assert !results.include?(text)
+    else
+      assert results.include?(text)
+    end
+  end
+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 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
+

data/lib/api_spec/version.rb

@@ -0,0 +1,3 @@
+module ApiSpec
+  VERSION = "0.9"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: api_spec
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Jay Zeschin
+- Joseph DelCioppio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: &70119405930560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119405930560
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70119405929660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119405929660
+- !ruby/object:Gem::Dependency
+  name: bueller
+  requirement: &70119405929120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119405929120
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70119405928400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119405928400
+description: Cucumber steps to easily test REST-based XML and JSON APIs
+email:
+- jay.zeschin@factorylabs.com
+- joe@rentingsmart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- api_spec.gemspec
+- features/support/env.rb
+- lib/api_spec/cucumber.rb
+- lib/api_spec/version.rb
+homepage: http://github.com/rentingsmart/api_spec
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Cucumber steps to easily test REST-based XML and JSON APIs
+test_files:
+- features/support/env.rb