Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeheft/dry_serialization
Simple gem to dry up some of the responses for success & error responses for different gems. Also has a new feature to deserialize the json api spec payload into a format acceptable for Rails' mass assignment
https://github.com/mikeheft/dry_serialization
blueprinter json-api jsonapi-serializer serialization serializer serializers
Last synced: 28 days ago
JSON representation
Simple gem to dry up some of the responses for success & error responses for different gems. Also has a new feature to deserialize the json api spec payload into a format acceptable for Rails' mass assignment
- Host: GitHub
- URL: https://github.com/mikeheft/dry_serialization
- Owner: mikeheft
- License: mit
- Created: 2020-02-24T13:43:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T20:49:31.000Z (almost 2 years ago)
- Last Synced: 2024-04-19T12:59:02.356Z (8 months ago)
- Topics: blueprinter, json-api, jsonapi-serializer, serialization, serializer, serializers
- Language: Ruby
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# DrySerialization
[](https://badge.fury.io/rb/dry_serialization)
Simple gem to dry up your controllers and provide a uniform interface for serializing Ruby objects. It relys on you to select and install either the blueprinter or jsonapi-serializer gems as well as this one.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'dry_serialization'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install dry_serialization
## Usage
- Install with rails generator
* currently supported serializers are [jsonapi_serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) and [blueprinter](https://github.com/procore/blueprinter)
`rails g dry_serialization::install`
- This generator will assume you have an api controller, and create one if you do not. This is to further keep the api separate from the web controllers.
- The inclusion of the module corresponding to your chosen serializer gem will give you access to `#serialized_resource`.
- The `#serialized_resource` method also takes an optional 'options' hash. For `jsonapi-serializer`, that can come in the form of the `include` hash and/or `meta` or any of the other options available through that gem. Please see their documentation for all options.
- Similarly for `blueprinter` it will also take an optional options hash. Again, please see the official documentation in their repo.
- Conversly, if you choose to not use the install generator, you can simply add your desired serializer gem to the Gemfile and include the relevant modules where needed.
```ruby
user = User.find(params[:id])
render json: serialized_resource(user, UserSerializer) # UserSerializer can be substituted with UserBlueprint if that is the gem you've chosen.
```
- SerializationHelper
- This module provides success and error response helper methods.
- In your controller you can use them like so:
```ruby
def create
user = User.create(create_user_params)
return error_response(user.errors) unless user.errors.empty?
success_response(user, UserSerializer, :created)
end
```
- Both methods take an optional argument for the status. You can either use the symbol representation or the number code.
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mikeyduece/dry_serialization.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).