Api::Scheme
Provides simple error handling and param processing scheme to make API and other actions for Rail Action Controller
Installation
Add this line to your application's Gemfile:
gem 'api-scheme'
or with explicit require:
gem 'api-scheme', require: 'api/scheme'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rails-api-scheme
Usage
Do:
require 'api/scheme'
before usage. Then add the similar the following scheme into the rails action controller:
class UsersController < ApplicationController
include Api::Scheme
error_map %W(ActionController::ParameterMissing) => 400,
%W(ActiveRecord::RecordNotFound) => 404,
%W(ActiveRecord::RecordInvalid) => 422..0,
%W(ActiveRecord::RecordNotUnique) => 422..1
param_map({
user: [
:first_name,
:last_name,
:email
]
})
use_model 'User'
use_actions :index, :show, :create, :update, :destroy
end
You can also use custom success, and error handlers as follows:
error_map %W(ActionController::ParameterMissing) => 400,
%W(ActiveRecord::RecordInvalid) => 422..0
render_error_with :render_error
render_success_with :render_success
render_error_code 422..0 => :render_error
def render_error text, minor, major
render json: { text: text, code: minor }, status: major
end
def render_success data, status
render json: data, status
end
def render_invalid text, minor, major
render json: { text: text, code: minor, additional: 'invalid' }, status: major
end
Note, that you are able specify a method to proceed an error separately for a specific error code.
Or even define the action method yourself instead of using the defaults, thus just skip use_actions
call,
and declare required methods excplicitly in the controller.
def create
@user = User.create!(permitted_params)
end
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/majioa/rails-api-scheme.