devise_facebook_connectable
Advanced tools
h1. DEVISE / FACEBOOK CONNECTABLE
Devise << Facebook Connect
h2. What is Devise?
"http://github.com/plataformatec/devise":http://github.com/plataformatec/devise
h2. What is Devise Facebook Connect?
Simple:
A very straightforward "Facebook Connect":http://wiki.developers.facebook.com/index.php/Facebook_Connect authentication/linking with the ease of "Devise":http://github.com/plataformatec/devise and power of "Facebooker":http://github.com/mmangino/facebooker. If I may say it myself: The easiest way to get a Rails app authorized and connected with Facebook Connect. Authentication in Rails should be straightforward, right? Let's build awesome web-apps instead of re-inventing the authentication!
h2. Dependencies
You'll need:
For Ruby 1.9 support:
h2. Installation
Gem
$ sudo gem install devise_facebook_connectable
...and in @config/environment.rb@:
config.gem 'devise_facebook_connectable'
Dependencies
Note: Should be installed automatically with the gem.
$ sudo gem install devise facebooker
...and in @config/environment.rb@:
config.gem 'devise' config.gem 'facebooker'
h2. Setup
Devise: Setup
See "Devise":http://github.com/plataformatec/devise documentation for instructions on how to setup Devise.
Facebook Connectable + Facebooker: Setup
Installs the Facebooker stuff + required Facebook Connect javascript helpers...
$ ./script/generate devise_facebook_connectable --api API_KEY --secret SECRET_KEY
dependency xd_receiver
create public/xd_receiver.html
create public/xd_receiver_ssl.html
create config/facebooker.yml
create public/javascripts/devise.facebook_connectable.js
Note: The @--api@ and @--secret@ arguments only makes sense if you already got Facebook application details ready; can be configured later (see Configuration).
Facebook Connectable: Migration
create_table :users do |t|
t.facebook_connectable
...
end
...and indexes (optional):
add_index :users, :facebook_uid, :unique => true
...and then don't forget: @$ rake db:migrate@.
Facebook Connectable: Model
class User < ActiveRecord::Base
devise :facebook_connectable, ...
end
Note: All modules must be specified on the same line since Devise 1.0.0, otherwise Devise will only load the last call @devise [MODULES]@ - which will cause FacebookConnectable to fail to initialize.
h2. Configuration
Create a Facebook app
..if you haven't already:
"Create Facebook Application":http://facebook.com/developers/createapp.php
...with settings:
Application settings > Connect > Facebook Connect Settings > Connect URL: @http://localhost:3000@ (for testing purposes) Application settings > Advanced > Advanced Settings > Sandbox Mode: @Enabled@
...and for next step, copy-paste: @API Key@ and @Application Secret@
@config/facebooker.yml@
...should look something like this:
# ...
defaults: &defaults
api_key: YOUR_APP_API_KEY
secret_key: YOUR_APP_SECRET_KEY
# ...
Note: For Facebook Connect only @api_key@, @secret_key@, and @Connect URL@ (configured in Facebook Application settings manager) are required.
I18n
Sign in/out link labels, and Flash error messages can be set using I18n:
en:
devise:
sessions:
facebook_invalid: "Could not sign in. Invalid account."
facebook_timeout: "Facebook session expired., please sign in again to continue."
facebook_authenticity_token: "Something went wrong. For security reasons, please sign in again."
facebook_actions:
sign_in: "Sign in"
sign_out: "Sign out"
Note: The usage of @:sign_in@/@:sign_out@ depends on configration, e.g. not used for the traditional and default Facebook Connect button.
h2. Usage
In @app/views/layouts/application.html.*@, something like (showing only the relevant parts):
...
<%= fb_connect_javascript_tag(:lang => ::I18n.locale) %>
<%= javascript_include_tag :defaults, 'devise.facebook_connectable' %>
...
<%= init_fb_connect :XFBML, :js => :jquery %>
...
<%= yield %>
...
View:
...add the sign in/out (connect) link somewhere - auto-detects scope:
<%= facebook_link %>
...or with explicit scope:
<%= facebook_link :customer %>
...or even more explicit, something like:
<% unless signed_in?(:user) %>
<%= facebook_sign_in_link :user %>
<% else %>
<%= facebook_sign_out_link :user %>
<% end %>
etc.
Model:
...if you want to fetch and populate any data from Facebook before connect (account creation), and/or after connect (not saved automatically):
class User < ActiveRecord::Base
devise :facebook_connectable
def before_facebook_connect(fb_session)
fb_session.user.populate(:locale, :current_location, :username, :name, :first_name, :last_name,
:birthday_date, :sex, :city, :state, :country)
self.locale = my_fancy_locale_parser(fb_session.user.locale)
self.time_zone = fb_session.user.current_location.try(:city)
self.country = fb_session.user.current_location.try(:country)
self.username = fb_session.user.username
self.profile.real_name = fb_session.user.name
self.profile.first_name = fb_session.user.first_name
self.profile.last_name = fb_session.user.last_name
self.profile.birthdate = fb_session.user.birthday_date.try(:to_date)
self.profile.gender = my_fancy_gender_parser(fb_session.user.sex)
self.profile.city = fb_session.user.hometown_location.try(:city)
self.profile.zip_code = fb_session.user.hometown_location.try(:state)
self.profile.country = fb_session.user.hometown_location.try(:country)
...
end
def after_facebook_connect(fb_session)
...
end
end
DONE!
$ ./script/server
Note: If you experience any issues with connecting and/or signing in/out now, then I simply must have forgot something in these instructions. Please file a GitHub-issue in such case! =)
h2. Example:
Checkout my little "live example":http://devise-facebook-connectable.heroku.com.
h2. Advanced Configuration
In initializer @config/initializers/devise.rb@:
Devise.setup do |config|
# ...
config.facebook_uid_field = :facebook_uid
config.facebook_session_key_field = :facebook_session_key
config.facebook_auto_create_account = false
# ...
end
h2. Documentation (RDoc)
"Rdoc.info/devise_facebook_connectable":http://rdoc.info/projects/grimen/devise_facebook_connectable
h2. Important
Stuff that you need to be aware of:
h2. References
Examples:
Documentation:
Repos:
Similar projects:
h2. TODO / Known Issues
Priority:
Maybe:
h2. License
Released under the MIT license.
Copyright (c) 2009-2010 "Jonas Grimfelt":http://github.com/grimen
FAQs
Unknown package
We found that devise_facebook_connectable demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.