This project is intended to provide the base of a web app that can authenticate via Devise using Facebook, while using a role authorization mechanism with cancan.
The purpose is to reuse and save time for developing backends. Great for a quick hackaton setup to integrate with Heroku.
It was developed over Ruby 2.1.1p76 and Rails 4.1.2rc1 with the next gems:
devise 3.2.4 omniauth-facebook 1.6.0 cancan 1.6.10
Introduce your FACEBOOK app credentials in config/environments/development.rb and modify your preferences in config/initializers/devise.rb
The User model contains the next fields:
first_name, string last_name, string uid, string (to store the external id) created_at, datetime updated_at, datetime
The current Devise config adds the next ones:
email, string encrypted_password, string reset_password_token, string reset_password_sent_at, datetime remember_created_at, datetime sign_in_count, integer current_sign_in_at, datetime last_sign_in_at, datetime current_sing_in_ip, string last_sign_in_ip, string
Normally, your user table will need other fields so just add migrations on top of it as needed.
Custom routes for signin, signup and logout are specified in config/routes.rb
The cancan configuration is built on top of a Roles table, which has a ‘has_and_belongs_to_many’ relationship with the Users table.
As an example and to get the app functional right away an ‘admin’ role and a dummy admin user was created in db/seeds.rb. Please modify this to set your default admin user.
The app/models/ability.rb file considers only an admin and a guest user. The admin one has management access to all resources, while the guest user gets read access to all resources. You can define more complex rules as you scale your app in here :)
-
Clone this repository
-
Create and configure your facebook app in developers.facebook.com/apps . Make sure you check the ‘website with facebook login’ option and type your local server address with something like ‘localhost:3000’ so you can test.
-
Edit the config/environments/development.rb file with your Facebook app key and secret.
-
Configure your database and run the migrations.
-
Test your Facebook signup by launching your server and entering the /signup path. Eg. localhost:3000/signup -> Signin with Facebook
To get more custom fucntionality, please check the valuable documentation that is provided in the gems’ repositories:
-
devise - github.com/plataformatec/devise
-
cancan - github.com/ryanb/cancan