samuelegea / monica

Monica Gellering all api results!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Monica

Have you ever need to organize your rails api results and didn't find any gem with all that is necessary to crack your API to very good standards. For reference, the standards aborded would be based on this, but with a few teaks.

REMINDER: THIS GEM IS NOT READY FOR PRODUCTION, FOR THE MOMENT IT IS JUST A WORK IN PROGRESS!!

Modules

This gem will be composed of the following module: act_as_filterable, act_as_sortable, act_as_paginatable and act_as_searchable, tha could be use separately or in conjunction, and generate methods tha can be easily overwritten, added or extended, if you.

Installation

Add the gem to your gemfile:

$ gem 'monica', '~> 0.1.0'

And now you're good to go!

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/monica. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 Monica project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Monica Gellering all api results!

License:MIT License


Languages

Language:Ruby 98.3%Language:Shell 1.7%