Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saulosilva/sinatra-active-model-serializers
Adapter on ActiveModelSerializer for the Sinatra
https://github.com/saulosilva/sinatra-active-model-serializers
Last synced: 2 months ago
JSON representation
Adapter on ActiveModelSerializer for the Sinatra
- Host: GitHub
- URL: https://github.com/saulosilva/sinatra-active-model-serializers
- Owner: SauloSilva
- License: mit
- Created: 2015-02-02T22:00:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T23:55:38.000Z (about 2 years ago)
- Last Synced: 2024-04-26T01:04:00.991Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 54.7 KB
- Stars: 9
- Watchers: 2
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[ ](https://codeship.com/projects/60665)
[](https://coveralls.io/github/SauloSilva/sinatra-active-model-serializers?branch=adding_each_serializer)
[](https://codeclimate.com/github/SauloSilva/sinatra-active-model-serializers)
# Sinatra::ActiveModelSerializers
[](http://badge.fury.io/rb/sinatra-active-model-serializers)
This gem has the function of adapt the Active Model Serializers to work in Sinatra from a more practical way with models.
If do you use everything at the default, just require `sinatra_active_model_serializers` for serializers work correctly the a json response.
## Requirements
Ruby 1.9.2 or greater, Sinatra 1.4.5 or greater and Sinatra Contrib 1.4.2 or greater.
## Installation
`gem install sinatra-active-model-serializers`
or with bundler
```ruby
# Gemfile
source 'http://rubygems.org'
gem 'sinatra', '1.4.6'
gem 'sinatra-contrib', '1.4.6'
gem 'sinatra-active-model-serializers', '0.2.0'
```
## Configure
It's very easy. Look at the example:
```ruby
require 'rubygems'
require 'bundler'
Bundler.require :default
Dir['./app/models/**/*.rb'].each { |file| require file }
class App < Sinatra::Base
get '/' do
json Test.first
end
end
```
## Sets
#### active_model_serializers
This attribute is an object, all inserted configuration this object it will be passed on to Active Model Serializers, eg.
```ruby
set :active_model_serializers, { root: false }
```
#### serializers_path
By default, path is `app/serializers`. If you need a different path you can set your path, eg.
```ruby
set :serializers_path, './whatever_path/serializers'
```
or you can disable auto require
```ruby
set :serializers_path, false
```
## Response JSON
When you return a json, you can send a the second parameter.
This the second parameter is an object. This object may contain new configurations to assign to the Active Model Serializers or to rewrite any already set by default, eg.
#### root
```ruby
get '/' do
json Resource.first, { root: false }
end
```
#### scope
```ruby
get '/' do
json Resource.first, { scope: self }
end
```
## Specify a serializer
If you wish to use an another serializer than the default, you can explicitly pass it through the renderer
1. For a resource:
```ruby
json Resource.first, { serializer: ResourcePreviewSerializer }
```
2. For an array resource:
Use the default `ArraySerializer`, which will use `each_serializer` to
serialize each element.
```ruby
json @resources, { each_serializer: ResourcePreviewSerializer }
```
## License
[MIT](https://github.com/SauloSilva/sinatra-active-model-serializers/blob/master/LICENSE)