Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Nedomas/databound
Provides Javascript a simple API to the Ruby on Rails CRUD.
https://github.com/Nedomas/databound
Last synced: 12 days ago
JSON representation
Provides Javascript a simple API to the Ruby on Rails CRUD.
- Host: GitHub
- URL: https://github.com/Nedomas/databound
- Owner: Nedomas
- License: mit
- Created: 2014-10-22T20:58:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-04-11T12:32:30.000Z (over 9 years ago)
- Last Synced: 2024-10-30T23:03:21.576Z (14 days ago)
- Language: CoffeeScript
- Homepage:
- Size: 679 KB
- Stars: 456
- Watchers: 19
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://rubygems.org/gems/databound)
[](http://bower.io/search/?q=databound)
[](https://www.npmjs.com/package/databound)
[](https://codeclimate.com/github/Nedomas/databound)
[](https://travis-ci.org/Nedomas/databound)
Provides Javascript a simple CRUD API to the Ruby on Rails backend.
**Check out live examples on the Databound website** [databound.me](http://databound.me).
**Backend gem repo** [github.com/Nedomas/databound-rails](http://github.com/Nedomas/databound-rails).
## Usage
```js
User = new Databound('/users')
User.where({ name: 'John' }).then(function(users) {
alert('Users called John');
});
User.find(15).then(function(user) {
alert('User no. 15: ' + user.name);
});
User.create({ name: 'Peter' }).then(function(user) {
alert('I am ' + user.name + ' from database');
});
```
[More API docs](http://nedomas.github.io/databound/src/databound.html)
## Version support and dependencies
Works with:
- Ruby on Rails **3+**
- Ruby **2.0+**
- It can work with **Angular** as a better **ngResource** alternative
- [Rails API](https://github.com/rails-api/rails-api)
- ActiveRecord or Mongoid
- [Active Model Serializers](https://github.com/rails-api/active_model_serializers)
- Chrome **any**, Firefox **any**, Opera **any**, IE **8+**
Depends on:
- Lodash (should work with any version)
- jQuery **1.5+**
jQuery is used for making requests and promises.
You can use your own library instead. Read [API docs](http://nedomas.github.io/databound/src/databound.html) on how to override those.
## Installation
**1 - Gemfile**
```ruby
gem 'databound', '3.1.3'
```
**2.1 - With asset pipeline (sprockets)**
Run generator to add Databound to application.js
```sh
rails g databound:install
```
**2.2 - Without asset pipeline**
Download the [databound-standalone.js](https://raw.githubusercontent.com/Nedomas/databound/master/dist/databound-standalone.js) and load it up
```html
```
**2.3 - With require.js**
Download Javascript part with [npm](http://npmjs.com) or [bower](bower.io)
```sh
npm install databound
```
OR
```sh
bower install databound
```
Require it Javascript with:
```javascript
var Databound = require('databound');
```
**3 - Add a route to config/routes.rb**
```ruby
Rails.application.routes.draw do
databound :users, columns: [:name, :city]
end
```
**4 - *(optional)* Controller is autogenerated from route**
But if you already have a controller, you can include Databound and specify the model yourself.
```ruby
class UsersController < ApplicationController
databound do
model :user
columns :name, :city
end
end
```
**5 - Install dependencies (skip if with ``require.js``)**
Easiest way is to use the official Ruby gems or include them from CDNs.
**Lo-Dash** - [lodash-rails gem](https://github.com/rh/lodash-rails) or [CDN](http://cdnjs.com/libraries/lodash.js).
**jQuery** *(already installed by default on Rails)* - [jquery-rails gem](https://github.com/rails/jquery-rails) or [CDN](https://code.jquery.com)
**6 - Use it in the Javascript**
```javascript
var User = new Databound('/users');
```
## Security
**Which parts can Javascript modify?**
Specify ``columns``.
By default - no columns are modifiable.
**How to secure the relation values?**
You can use ``dsl(:your_column, :expected_value)`` to only allow certain dsl values and convert them to relation ids in the backend.
**How to protect the scope of the records?**
If you need a reference to the record being modified, use ``permit``. It will give you a parsed record.
It also works with 3rd party libraries.
```ruby
class ProjectsController < ApplicationController
databound do
model :project
columns :name, :city
# CanCanCan gem
permit(:create) do
authorize! :create, current_user
end
# Pundit
permit(:update) do
authorize current_user
end
# Plain Ruby
permit(:destroy) do
current_user.god?
end
end
end
```
**Which parts can Javascript show?**
Use [Active Model Serializers](https://github.com/rails-api/active_model_serializers) to serialize the record.
If you don't want to use that, you can overwrite ``as_json`` method on the model.
## Contributing :heart:
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
6. Get ice cream :ice_cream:
## Changelog
**Next release**
* Associations.
* Your contribution here.
**3.1.3** - 2015-04-10
* Fix Postgresql bug introduced with ``3.1.2``. Do it [@remigijusj](https://github.com/remigijusj) ``bind_values`` way.
**3.1.2** - 2015-04-10
* Fix bug introduced with Rails 4.2 ``AdequateRecord`` update - AREL query API changed. Thanks to [@remigijusj](https://github.com/remigijusj) who patched it (https://github.com/Nedomas/databound-rails/issues/2).
**3.1.1** - 2015-02-10
* Fix ``where`` bug which did to take into account the ``extra_where_scopes``.
**3.1.0** - 2015-01-10
* Friendly error messages in development environment.
* ``.all`` method.
**3.0.3** - 2015-01-09
* Fix bootup of a default Rails stack in production with ``databound`` and ``eager_load``
**3.0.2** - 2015-01-08
* ``read`` action of ``permit`` returning ``false`` now returns empty scoped records
**3.0.1** - 2015-01-08
* Minor bugfix
**3.0.0** - 2015-01-08
* Simplify configuration setup and improve performance.
* Thanks to [@Austio](https://github.com/Austio) for docs on 3rd party authentication libraries.
```ruby
class ProjectsController < ApplicationController
databound do
model :project
columns :name, :city
end
end
```
**2.0.1** - 2015-01-03
* Add support for specifying ``permitted_columns`` in ``routes.rb``. No columns are modifiable by default.
**1.1.0** - 2015-01-03
* You can specify ``permit_update_destroy?`` on a controller to manage the scope of the records that can be modified from the Javascript.
**1.0.0** - 2015-01-03
* Destroy now accepts ``id`` instead of ``{ id: someid }``.
* ``extra_find_scopes`` renamed to ``extra_where_scopes``
## Used and sponsored by
[](http://closeheat.com)
[](http://samesystem.com) [](http://spacepicnic.net)