challah-facebook 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## challah-facebook 0.1.0
+
+* Basic Facebook authentication compatibility with Challah

data/README.md

@@ -0,0 +1,26 @@
+# challah-facebook
+
+`challah-facebook` is an extension to the [Challah](http://github.com/jdtornow/challah) gem that allows users to register and authenticate with the Facebook graph API (Facebook Connect.)
+
+## Requirements
+
+* Ruby 1.9.2+
+* Bundler
+* Rails 3.1+
+* Challah Gem 0.9+
+
+## Installation
+
+    gem install challah
+    gem install challah-facebook
+
+Or, in your `Gemfile`
+
+    gem 'challah', '>= 0.9'
+    gem 'challah-facebook'
+
+## License
+
+`challah-facebook` is released under the [MIT license](http://www.opensource.org/licenses/MIT)
+
+Contributions and pull-requests are more than welcome.

data/lib/challah/facebook/interface.rb

@@ -0,0 +1,36 @@
+require 'challah/facebook/interfaces/base'
+
+# Set up the proper interface depending on installed gems
+if defined?(FbGraph)
+  require 'challah/facebook/interfaces/fb_graph'
+
+  module Challah
+    module Facebook
+      class Interface < Challah::Facebook::Interfaces::FbGraph
+      end
+    end
+  end
+elsif defined?(Koala)
+  require 'challah/facebook/interfaces/koala'
+
+  module Challah
+    module Facebook
+      class Interface < Challah::Facebook::Interfaces::Koala
+      end
+    end
+  end
+else
+  module Challah
+    module Facebook
+      class Interface
+        def self.mode
+          "none"
+        end
+
+        def method_missing
+          raise "No Facebook adapter found. Please install fb_graph or koala gem to use Facebook"
+        end
+      end
+    end
+  end
+end

data/lib/challah/facebook/interfaces/base.rb

@@ -0,0 +1,46 @@
+module Challah
+  module Facebook
+    module Interfaces
+      class Base
+        attr_reader :app_id, :app_secret
+
+        def self.app_id
+          ENV['FACEBOOK_APP_ID']
+        end
+
+        def self.app_secret
+          ENV['FACEBOOK_SECRET']
+        end
+
+        def self.permissions
+          ENV['FACEBOOK_PERMISSIONS'].to_s.split(',')
+        end
+
+        def self.user_fields
+          %w( first_name last_name email )
+        end
+
+        def initialize(app_id, app_secret)
+          @app_id = app_id
+          @app_secret = app_secret
+        end
+
+        def self.get_access_token_for_oauth_code(code, callback_uri)
+          raise 'Not implemented: get_access_token_for_oauth_code'
+        end
+
+        def self.get_access_token_from_cookies(cookies_hash)
+          raise 'Not implemented: get_access_token_from_cookies'
+        end
+
+        def self.get_facebook_uid_from_access_token(access_token)
+          raise 'Not implemented: get_facebook_uid_from_access_token'
+        end
+
+        def self.get_authorization_url(callback_uri, permissions = nil)
+          raise 'Not implemented: get_authorization_url'
+        end
+      end
+    end
+  end
+end

data/lib/challah/facebook/interfaces/fb_graph.rb

@@ -0,0 +1,65 @@
+module Challah
+  module Facebook
+    module Interfaces
+      class FbGraph < Base
+        def self.mode
+          "fb_graph"
+        end
+
+        def self.get_access_token_for_oauth_code(code, callback_uri)
+          client = new(app_id, app_secret).auth(callback_uri).client
+          client.authorization_code = code
+          client.access_token!(:client_auth_body).to_s
+        end
+
+        def self.get_access_token_from_cookies(cookies_hash)
+          fb_auth = new(app_id, app_secret).auth
+          fb_auth.from_cookie(cookies_hash)
+          fb_auth.access_token.to_s
+        rescue
+          nil
+        end
+
+        def self.get_extended_token(access_token)
+          fb_auth = new(app_id, app_secret).auth
+          fb_auth.exchange_token!(access_token)
+          fb_auth.access_token.to_s
+        end
+
+        def self.get_facebook_uid_from_access_token(access_token)
+          fb_user = ::FbGraph::User.me(access_token).fetch
+
+          if fb_user
+            return fb_user.identifier.to_s
+          end
+
+          nil
+        rescue
+          nil
+        end
+
+        def self.get_user_info_from_access_token(access_token)
+          result = {}
+
+          fb_user = ::FbGraph::User.me(access_token).fetch
+
+          self.user_fields.each do |field|
+            result[field] = fb_user.send(field)
+          end
+
+          result
+        end
+
+        def self.get_authorization_url(callback_uri, permissions = nil)
+          scope = self.permissions if scope.nil?
+          client = new(app_id, app_secret).auth(callback_uri).client
+          client.authorization_uri(scope: scope)
+        end
+
+        def auth(callback_uri = nil)
+          ::FbGraph::Auth.new(app_id, app_secret, redirect_uri: callback_uri)
+        end
+      end
+    end
+  end
+end

data/lib/challah/facebook/interfaces/koala.rb

@@ -0,0 +1,11 @@
+module Challah
+  module Facebook
+    module Interfaces
+      class Koala < Base
+        def self.mode
+          "koala"
+        end
+      end
+    end
+  end
+end

data/lib/challah/facebook/provider.rb

@@ -0,0 +1,59 @@
+module Challah
+  module Facebook
+    class Provider
+      def self.save(record)
+        set({
+          user_id:  record.id,
+          token:    record.facebook_provider.fetch(:token),
+          uid:      record.facebook_provider.fetch(:uid)
+        })
+      end
+
+      def self.set(options = {})
+        user_id     = options.fetch(:user_id)
+        uid         = options.fetch(:uid, '')
+        token       = options.fetch(:token, '')
+
+        ::Authorization.set({
+          provider:   :facebook,
+          user_id:    user_id,
+          uid:        uid,
+          token:      token
+        })
+      end
+
+      def self.valid?(user)
+        return false unless user.facebook_provider?
+
+        uid = user.facebook_provider.fetch(:uid).to_s.strip
+        token = user.facebook_provider.fetch(:token)
+
+        # Both a fb_uid and access token are required
+        if uid.present? and token.present?
+          if ::Authorization.where(provider: 'facebook', uid: uid).count > 0
+            user.errors.add :facebook, 'account has already been used'
+            return false
+          end
+
+          begin
+            # Get extended token
+            extended_token = Interface.get_extended_token(token)
+            user.facebook_provider[:token] = extended_token
+
+            # Verify UID
+            test_uid = Interface.get_facebook_uid_from_access_token(extended_token)
+
+            # If the uid's match up, this is a valid token
+            return test_uid == uid
+          rescue
+            return false
+          end
+
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/challah/facebook/technique.rb

@@ -0,0 +1,29 @@
+module Challah
+  module Facebook
+    class Technique
+      def initialize(session)
+        @provider = session.provider? ? session.provider : nil
+        @token = session.token? ? session.token : nil
+        @uid = session.uid? ? session.uid : nil
+      end
+
+      def authenticate
+        return nil unless @provider == 'facebook'
+        return nil unless @token
+
+        token = Interface.get_extended_token(@token)
+        auth = ::Authorization.where(provider: 'facebook', token: token, uid: @uid).first
+
+        if auth
+          return auth.user
+        end
+
+        nil
+      end
+
+      def persist?
+        true
+      end
+    end
+  end
+end

data/lib/challah/facebook/version.rb

@@ -0,0 +1,5 @@
+module Challah
+  module Facebook
+    VERSION = "0.1.0" unless defined?(::Challah::Facebook::VERSION)
+  end
+end

data/lib/challah/facebook.rb

@@ -0,0 +1,9 @@
+require 'challah/facebook/version'
+
+module Challah
+  module Facebook
+    autoload :Interface,        'challah/facebook/interface'
+    autoload :Provider,         'challah/facebook/provider'
+    autoload :Technique,        'challah/facebook/technique'
+  end
+end

data/lib/challah-facebook.rb

@@ -0,0 +1,7 @@
+require 'challah'
+require 'challah/facebook'
+
+if Challah.respond_to?(:register_technique)
+  Challah.register_technique :facebook, Challah::Facebook::Technique
+  Challah.register_provider :facebook,  Challah::Facebook::Provider
+end

data/test/helper.rb

@@ -0,0 +1,121 @@
+# Coverage reporting, needs to be loaded first to capture all code coverage stats
+require 'simplecov'
+
+# Setup a sample rails app for testing rails modules
+sample_root = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'sampleapp'))
+FileUtils.rm_rf(sample_root) if File.exists?(sample_root)
+`rails new #{sample_root} --skip-bundle --skip-sprockets`
+
+# Setup environment variables for the Rails instance
+ENV['RAILS_ENV'] = 'test'
+ENV['BUNDLE_GEMFILE'] ||= File.join(sample_root, 'Gemfile')
+
+# Load the newly created rails instance environment
+require "#{sample_root}/config/environment"
+
+# Some other dependencies for testing w/ shoulda and factory girl
+require 'shoulda'
+require 'mocha/setup'
+require 'factory_girl'
+require 'factories'
+require 'rails/test_help'
+
+# Load the challah libraries
+require 'challah'
+require 'challah/facebook'
+require 'challah/test'
+
+# Setup the challah app, including running migrations within the rails app
+# TODO - this causes some annoying output in 1.9.3, still works, but would like to suppress
+`rake --rakefile #{File.join(sample_root, 'Rakefile')} challah:setup:migrations`
+
+# Run migrations for the sample app, hiding output
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+# Use ActiveSupport::TestCase for any tests using factories and database saving,
+# so we can have a transactional rollback after each test.
+class ActiveSupport::TestCase
+  include FactoryGirl::Syntax::Methods
+
+  self.use_transactional_fixtures = true
+end
+
+class MockController
+  include Challah::Controller
+  include Challah::Rolls::Controller
+
+  attr_accessor :request, :session, :params
+
+  def initialize()
+    @request = MockRequest.new
+    @session ||= {}
+    @params ||= {}
+  end
+
+  def redirect_to(*args)
+    # do nothing
+  end
+
+  def login_path
+    "/login"
+  end
+
+  def logout_path
+    "/logout"
+  end
+
+  def signin_path
+    "/sign-in"
+  end
+
+  def signout_path
+    "/sign-out"
+  end
+end
+
+class MockRequest
+  attr_accessor :cookie_jar, :session_options, :url
+
+  class MockCookieJar < Hash
+    def delete(key, options = {})
+      super(key)
+    end
+  end
+
+  def initialize
+    @cookie_jar = MockCookieJar.new
+    @session_options = { :domain => 'test.dev' }
+    @url = "http://example.com/"
+  end
+
+  def cookies
+    @cookie_jar
+  end
+
+  def cookies=(value)
+    @cookie_jar = value
+  end
+
+  def remote_ip
+    "8.8.8.8"
+  end
+
+  def user_agent
+    "Some Cool Browser"
+  end
+end
+
+# Monkey patch fix for shoulda and Rails 3.1+.
+module Shoulda
+  module ActiveRecord
+    module Matchers
+      class AssociationMatcher
+        protected
+          def foreign_key
+            reflection.foreign_key
+          end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: challah-facebook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John Tornow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: challah
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0.pre
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: A Challah plugin to allow authentication and registration with Facebook
+  API.
+email:
+- john@johntornow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- test/helper.rb
+- lib/challah/facebook/interface.rb
+- lib/challah/facebook/interfaces/base.rb
+- lib/challah/facebook/interfaces/fb_graph.rb
+- lib/challah/facebook/interfaces/koala.rb
+- lib/challah/facebook/provider.rb
+- lib/challah/facebook/technique.rb
+- lib/challah/facebook/version.rb
+- lib/challah/facebook.rb
+- lib/challah-facebook.rb
+- README.md
+- CHANGELOG.md
+homepage: http://github.com/jdtornow/challah-facebook
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Facebook authentication interface for Challah.
+test_files: []