devise_oauth2_fb_canvas 0.0.1

data/README

@@ -0,0 +1,52 @@
+Only Rails 3 is supported.
+
+Uses fbgraph (http://github.com/nsanta/fbgraph)
+Could use the Oauth2 gem directly, but it is more than likely that you
+would want to use other features of facebook (ie post feed updates).
+
+
+How to use, web applications
+----------
+Setup devise (http://github.com/plataformatec/devise), use Rails 3
+
+Include the gem in Gemfile after devise:
+  gem 'devise'
+  gem 'devise_oauth2_fb_canvas'
+
+Include the ':devise_oauth2_fb_canvas' in your model:
+
+  devise :database_authenticatable, :registerable, :confirmable,
+         :recoverable, :rememberable, :trackable, :validatable, :devise_oauth2_fb_canvas
+
+
+Add the following config options:
+
+$ config/initializers/devise.rb
+
+  config.facebook_api_key = "KEY"
+  config.facebook_api_secret = "SECRET"
+  config.facebook_permissions = 'offline_access,email,publish_stream'
+
+Good minimum to have is "offline_access,email"
+
+Create a migration file to add the columns:
+
+  add_column :users, :facebook_uid, :string
+  add_column :users, :facebook_token, :string
+
+Finally, update your view to include "Login with facebook" link:
+  <%= link_to "Login with facebook", user_fb_auth_path %>
+  
+How to use, facebook canvas applications
+
+------
+
+As above, except with this configuration:
+
+$ config/initializers/devise.rb
+
+  config.facebook_api_key = "KEY"
+  config.facebook_api_secret = "SECRET"
+  config.facebook_permissions = 'offline_access,email,publish_stream'
+  config.facebook_canvas_app = true
+  config.facebook_canvas_url = 'your_facebook_canvas_app_url'

data/app/controllers/devise/facebook_consumer_controller.rb

@@ -0,0 +1,46 @@
+class Devise::FacebookConsumerController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+  include DeviseOauth2FbCanvas::FacebookConsumerHelper
+  
+  def auth
+    url = send("#{resource_name}_fb_callback_url".to_sym)
+    uri = facebook_client.authorization.authorize_url(:redirect_uri => url , :scope => Devise.facebook_permissions)
+    if Devise.facebook_canvas_app
+      render :layout => false, :inline => "<script type='text/javascript' charset='utf-8'>top.location.href='#{uri}';</script>"
+    else
+      redirect_to uri
+    end
+  end
+  
+  def callback
+    url = send("#{resource_name}_fb_callback_url".to_sym)
+
+    client = facebook_client
+    client.authorization.process_callback(params[:code], :redirect_uri => url)
+
+    token = client.access_token
+    fb_user = client.selection.me.info!
+
+    resource = resource_class.find_with_facebook_user(fb_user, token)
+    unless resource
+      resource = resource_class.create_with_facebook_user(fb_user, token)
+    end
+    if resource_class.respond_to?(:serialize_into_cookie)
+      resource.remember_me!
+      cookies.signed["remember_#{resource_name}_token"] = {
+        :value => resource.class.serialize_into_cookie(resource),
+        :expires => resource.remember_expires_at,
+        :path => "/"
+      }
+    end
+    set_flash_message :notice, :signed_in
+    
+    if Devise.facebook_canvas_app
+      sign_in(resource_name, resource)
+      redirect_to Devise.facebook_canvas_url
+    else
+      sign_in_and_redirect(resource_name, resource)
+    end
+  end
+
+end

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    facebook_consumer:
+      signed_in: 'Signed in successfully.'

data/lib/devise_oauth2_fb_canvas.rb

@@ -0,0 +1,40 @@
+require 'devise'
+require 'fbgraph'
+
+require 'devise_oauth2_fb_canvas/engine'
+
+module Devise
+  mattr_accessor :facebook_uid_field
+  @@facebook_uid_field = :facebook_uid
+
+  mattr_accessor :facebook_token_field
+  @@facebook_token_field = :facebook_token
+
+  mattr_accessor :facebook_api_key
+  @@facebook_api_key = nil
+
+  mattr_accessor :facebook_api_secret
+  @@facebook_api_secret = nil
+  
+  mattr_accessor :facebook_permissions
+  @@facebook_permissions = 'offline_access,email'
+  
+  mattr_accessor :facebook_callback_url
+  @@facebook_callback_url = nil
+  
+  mattr_accessor :facebook_canvas_app
+  @@facebook_canvas_app = false
+  
+  mattr_accessor :facebook_canvas_url
+  @@facebook_canvas_url = nil
+  
+
+  
+end
+
+Devise.add_module(:devise_oauth2_fb_canvas,
+  :strategy => false,
+  :controller => :facebook_consumer,
+  :route => :facebook_consumer,
+  :model => 'devise_oauth2_fb_canvas/model'
+)

data/lib/devise_oauth2_fb_canvas/engine.rb

@@ -0,0 +1,10 @@
+require "devise_oauth2_fb_canvas/routes"
+
+module DeviseOauth2FbCanvas
+  class Engine < ::Rails::Engine
+    config.devise_oauth2_fb_canvas = DeviseOauth2FbCanvas
+    
+    config.autoload_paths << File.expand_path(File.join(File.dirname(__FILE__), "..")) if config.respond_to? :autoload_paths
+    
+  end
+end

data/lib/devise_oauth2_fb_canvas/facebook_consumer_helper.rb

@@ -0,0 +1,10 @@
+module DeviseOauth2FbCanvas::FacebookConsumerHelper
+  
+  def facebook_client(token = nil)
+    if token.present?
+      FBGraph::Client.new(:client_id => Devise.facebook_api_key, :secret_id => Devise.facebook_api_secret)
+    else
+      FBGraph::Client.new(:client_id => Devise.facebook_api_key, :secret_id => Devise.facebook_api_secret, :token => token)
+    end
+  end
+end

data/lib/devise_oauth2_fb_canvas/model.rb

@@ -0,0 +1,46 @@
+module Devise
+  module Models
+
+    module DeviseOauth2FbCanvas
+      extend ActiveSupport::Concern
+
+      def do_update_facebook_user(fb_user, token)
+        self.send("#{self.class.facebook_uid_field}=".to_sym, fb_user.id)
+        self.send("#{self.class.facebook_token_field}=".to_sym, token)
+        self.email = fb_user.email.to_s.downcase if fb_user.email.present?
+        update_facebook_user(fb_user)
+        self.save(:validate => false)
+      end
+      
+      def update_facebook_user(fb_user)
+        # override me
+      end
+
+      def active?
+        true
+      end
+
+      protected
+
+      module ClassMethods
+        Devise::Models.config(self, :facebook_uid_field, :facebook_token_field)
+
+        def find_with_facebook_user(fb_user, token)
+          user = where(facebook_uid_field.to_sym => fb_user.id).first || where(:email => fb_user.email.downcase).first
+          if user
+            user.do_update_facebook_user(fb_user, token)
+          end
+          user
+        end
+        
+        def create_with_facebook_user(fb_user, token)
+          user = new(facebook_uid_field.to_sym => fb_user.id, :password => "fakepass", :password_confirmation => "fakepass")
+          user.skip_confirmation! if user.respond_to?(:skip_confirmation!)
+          user.do_update_facebook_user(fb_user, token)
+          user
+        end
+      end
+      
+    end
+  end
+end

data/lib/devise_oauth2_fb_canvas/routes.rb

@@ -0,0 +1,11 @@
+ActionDispatch::Routing::Mapper.class_eval do
+
+    protected
+
+    def devise_facebook_consumer(mapping, controllers)
+      scope mapping.fullpath do
+        get mapping.path_names[:fb_auth], :to => "#{controllers[:facebook_consumer]}#auth", :as => :fb_auth
+        get mapping.path_names[:fb_callback], :to => "#{controllers[:facebook_consumer]}#callback", :as => :fb_callback
+      end
+    end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: devise_oauth2_fb_canvas
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nina Jansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fbgraph
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: info@ninajansen.dk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- app/controllers/devise/facebook_consumer_controller.rb
+- config/locales/en.yml
+- lib/devise_oauth2_fb_canvas.rb
+- lib/devise_oauth2_fb_canvas/engine.rb
+- lib/devise_oauth2_fb_canvas/facebook_consumer_helper.rb
+- lib/devise_oauth2_fb_canvas/model.rb
+- lib/devise_oauth2_fb_canvas/routes.rb
+has_rdoc: true
+homepage: http://github.com/ninajansen/devise_oauth2_fb_canvas
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Devise OAuth2 Facebook extension
+test_files: []
+