databasedotcom-rails's Introduction

databasedotcom-rails

Convenience classes to make using the databasedotcom gem with Rails apps even easier

#Installation gem install databasedotcom-rails or, if you use Bundler

gem 'databasedotcom-rails'

Usage

Include Databasedotcom::Rails::Controller into your RESTful controller
Create a YAML file at RAILS_ROOT/config/databasedotcom.yml file, like so
```
  ---
  client_id: put-your-client-id-here
  client_secret: put-your-client-secret-here
  username: put-your-username-here
  password: put-your-password-here
  debugging: true
```
Alternatively, include environment-specific settings: development: client_id: ... test: client_id: ... production: client_id: ...
Call YourModel.coerce_params before you pass parameters submitted from an HTML form to your materialized Sobject

Example

class UsersController < ApplicationController
  include Databasedotcom::Rails::Controller
  before_filter :load_user, :except => [:index, :new]

  def index
    @users = User.all
  end

  def show
  end

  def new
    @user = User.new
  end

  def create
    User.create User.coerce_params(params[:user])
    flash[:info] = "The user was created!"
    redirect_to users_path
  end

  def edit
  end

  def update
    @user.update_attributes User.coerce_params(params[:user])
    flash[:info] = "The user was updated!"
    redirect_to user_path(@user)
  end

  def destroy
    @user.delete
    flash[:info] = "The user was deleted!"
    redirect_to users_path
  end

  private

  def load_user
    @user = User.find(params[:id])
  end
end

Note that there is no need to declare the User model anywhere- Databasedotcom::Rails::Controller recognizes it as a known Sobject type from your database.com instance, and materializes it automatically.