Camerata

A serializer for JSONAPI included with a host of decoupled tools for fast and flexible responses.

Camerata aims to be opinionated but is designed to be used piece-meal decoupled from existing tools.

Upcoming

• DSL

• Write directly to socket

• Build out network timeout handler

• Add support for yajl-ruby

  • Direct socket connection
  • Rack Request
  • Rack Response

• Metadata

• Fields

• Pagination

• Query management; aggregated query

• Count

• Group

• Sorting

• Eager loading support

• Cache loaded relationships

• Includes

• Middleware support

• Command design pattern service integration

• Tests:

  • Large number of properties
  • Large property value
  • Large number or relationships
  • Relationship-of-relationships

Installation

Add this line to your application's Gemfile:

gem 'camerata'

And then execute:

$ bundle

Or install it yourself as:

$ gem install camerata

Usage

TODO: Write usage instructions here

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/[USERNAME]/camerata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Camerata project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

What does Camerata mean?

What does the word camerata mean? Why camerata?

Camerata is a shout out to an analogy coined by Jessica Kerr at RubyConf 2019. Rubyists are akin to the Florentine Camerata coming together as a community from varying disciplines.

The modern term camerata refers to a small chamber orchestra or choir. An API is likewise in many projects the collaboration of several different hands in a harmonizing composition of services.