Cucumber JSON API Steps

Some Cucumber steps to make easier to build JSON API with Rails.

Installation

Milestone: v1.0.0

Install Cucumber, then add the gem to your Gemfile:

group :development, :test do
  gem 'cucumber_json_api_steps'
end

Usage

Note: This usage section acts as a roadmap for development following the README-driven development principles. Not everything that is described here will be available at any moment, however, I'll try to keep things clear in comments.

Once installed, you can include the JSON API steps in your features definitions or use the built-in generators to create common features.

Steps

Base Steps

Milestone: v1.0.0

Scaffolded Resource Steps

Milestone: v1.0.0

Associations Steps

Milestone: undefined

JSON API Steps

Milestone: undefined

Note: I'm not sure yet that these will be a distinct set of steps, or if all steps will be JSON-API-compliant, however, I think it could be a good thing to keep both concerns separated so you can first build your API and then ensure it complies with the JSON API standard. That would help to refactor existing API to implement the standard.

These steps allow you to ensure the API follows the JSON API standard, which makes it compatible out-of-the-box with clients that follow this standard (Ember.js with a DS.ActiveModelAdapter from Ember Data for example).

Generators

Milestone: undefined

Credits

This gem wouldn't exist without the Anthony Eden API steps and inspiring talk. Thanks!

License

Cucumber JSON API Steps
Copyright (C) 2013-2014 Gonzalo Bulnes Guilpain

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

gonzalo-bulnes / cucumber_json_api_steps Goto Github PK