acts_as_api ¶ ↑

acts_as_api makes creating XML/JSON responses in Rails 3 easy and fun.

It provides a simple interface to determine the representation of your model data, that should be rendered in your API responses.

In addition to Rails it theoretically can be used with any ruby app and any database (ActiveRecord and Mongoid are supported out of the box) as it only has few dependencies.

Introduction¶ ↑

acts_as_api enriches the models and controllers of your app in a Rails-like way so you can easily determine how your API responses should look like:

class User < ActiveRecord::Base

  acts_as_api

  api_accessible :public do |template|
    template.add :first_name
    template.add :age        
  end

  api_accessible :private do |template|
    template.add :first_name
    template.add :last_name
    template.add :age
    template.add :birthday                
  end

end

Getting started¶ ↑

A nice introduction about acts_as_api with examples can be found here:

fabrik42.github.com/acts_as_api

See the Wiki for a lot of usage examples and features:

github.com/fabrik42/acts_as_api/wiki

There are a lot of how-tos like:

• Extending existing api templates

• Include attributes and all other kinds of methods of your model

• Include child associations (if they also act_as_api this will be considered)

• Rename attributes, methods, associations

• Keep your API templates out of your models

• and much more…

Features:¶ ↑

• DRY templates for your api responses

• Easy but very flexible syntax for defining the templates

• XML, JSON and JSON-P support out of the box, easy to extend

• Support for Rails 3 Responders

• Minimal dependecies (you can also use it without Rails)

• Ships with support for ActiveRecord and Mongoid

• Supports multiple api rendering templates per model. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile.

Requirements:¶ ↑

• ActiveModel (>= 3.0.0)

• ActiveSupport (>= 3.0.0)

• Rack (>= 1.1.0)

Links¶ ↑

• Introduction: fabrik42.github.com/acts_as_api

• Docs: rdoc.info/projects/fabrik42/acts_as_api

• Found a bug? github.com/fabrik42/acts_as_api/issues

• Wiki: github.com/fabrik42/acts_as_api/wiki

Travis CI build status ¶ ↑

Specs run with 1.9.2, 1.8.7 and REE: travis-ci.org/#!/fabrik42/acts_as_api

Tested with:¶ ↑

• MRI 1.9.2-p180

• MRI 1.8.7-p334

• But it just should work fine with other versions too… :)

Downwards Compatibility¶ ↑

Note that upgrading to 0.3.0 will break code that worked with previous versions due to a complete overhaul of the lib. For a legacy version of this readme file look here: github.com/fabrik42/acts_as_api/wiki/legacy-acts_as_api-0.2-readme

LICENSE:¶ ↑

(The MIT License)

Copyright © 2010 Christian Bäuerlein

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.