authlogic_facebook_shim 0.3.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 James McCarthy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,76 @@
+= authlogic_facebook_shim
+
+This is a plugin for integrating facebook sessions into authlogic.
+
+This requires a config/facebook.yml file that looks like this:
+
+    development:
+      app_id: appid
+      api_key: apikey
+      secret_key: secretkey
+
+    production:
+      app_id: appid
+      api_key: apikey
+      secret_key: secretkey
+    
+If you don't have different facebook credentials for different environments you can set these in UserSession
+
+    facebook_app_id     'appid'
+    facebook_api_key    'apikey'
+    facebook_secret_key 'secretkey'
+  
+In your controller you probably have something like this;
+
+    def current_user_session
+      @current_user_session ||= AccountSession.find
+    end
+
+    def current_user
+      @current_user ||= current_user_session.try(:user)
+    end
+
+    def logged_in?
+      current_user && !current_user_session.stale?
+    end
+
+To get hold of the facebook particulars you will need to add something like this;
+
+    def facebook_user
+      current_user_session.try(:facebook_user)
+    end
+
+    def facebook_user?
+      !facebook_user.nil?
+    end
+
+    def facebook_session?
+      current_user_session.try(:facebook_session?)
+    end
+
+If you have conventional signin and want to ignore facebook for it you will need to do this in your user_sessions_controller;
+
+    def create
+      @account_session = AccountSession.new(params[:account_session])
+      @account_session.skip_facebook_authentication = true
+      if @account_session.save
+        redirect_to member_home_path
+      else
+        render :action => :new
+      end
+    end
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it.  This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have
+  your own version, that is fine but bump version in a commit by itself I can
+  ignore when I pull)
+* Send me a pull request.  Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 James McCarthy. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+require 'rake/rdoctask'
+
+Jeweler::Tasks.new
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "authlogic_facebook_shim #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: gem install rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/authlogic_facebook_shim.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{authlogic_facebook_shim}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">=1.2.0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James McCarthy"]
+  s.date = %q{2010-05-27}
+  s.description = %q{Authlogic plugin to support Facebook OAuth2 javascript sessions. Currently requires koala but is easily extended for other facebook gems}
+  s.email = %q{james2mccarthy@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = Dir.glob('**/*') - Dir.glob('authlogic_facebook_shim*.gem')
+  s.homepage = %q{http://github.com/james2m/authlogic_facebook_shim}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Authlogic plugin to support Facebook Javascript OAuth2 Sessions.}
+  s.test_files = Dir.glob('test/**/*')
+
+  s.add_runtime_dependency('authlogic', "~>2.1.3")
+  s.add_development_dependency('rails', '~>2.3.5')
+  s.add_development_dependency('flexmock')
+  s.add_development_dependency('jeweler')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('sqlite3-ruby')
+  s.add_development_dependency('test-unit')
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/authlogic_facebook_shim/acts_as_authentic.rb

@@ -0,0 +1,20 @@
+module AuthlogicFacebookShim
+  module ActsAsAuthentic
+    def self.included(klass)
+      klass.class_eval do
+        extend Config
+        add_acts_as_authentic_module(Methods, :prepend)
+      end
+    end
+
+    module Config
+    end
+
+    module Methods
+      def self.included(klass)
+        klass.class_eval do
+        end
+      end
+    end
+  end
+end

data/lib/authlogic_facebook_shim/helper.rb

@@ -0,0 +1,4 @@
+module AuthlogicFacebookShim
+  module Helper
+  end
+end

data/lib/authlogic_facebook_shim/session/adapter.rb

@@ -0,0 +1 @@
+require File.expand_path('adapters/koala_adapter', File.dirname(__FILE__)) if defined?(Koala)

data/lib/authlogic_facebook_shim/session/adapters/koala_adapter.rb

@@ -0,0 +1,35 @@
+module AuthlogicFacebookShim
+  module Session  
+    module Adapter
+    
+      def facebook_session
+        @facebook_session ||= begin
+          if controller.cookies.has_key?("fbs_#{facebook_app_id}")
+            oauth = Koala::Facebook::OAuth.new(facebook_app_id, facebook_secret_key)
+            if oauth.respond_to?(:get_user_info_from_cookie)
+              user_info = oauth.get_user_info_from_cookie(controller.cookies)
+            else
+              user_info = oauth.get_user_from_cookie(controller.cookies)
+            end
+            OpenStruct.new( user_info )
+          end
+        end
+      end
+
+      def facebook_session?
+        !facebook_session.nil?
+      end
+   
+      def facebook_user
+        @facebook_user ||= begin
+          facebook_graph = Koala::Facebook::GraphAPI.new(facebook_session.access_token)
+          user = facebook_graph.get_object('me')
+          user[:uid] = user.delete('id')
+          OpenStruct.new( user )
+        end if facebook_session?
+      end
+
+    end
+  end 
+end
+    

data/lib/authlogic_facebook_shim/session/config.rb

@@ -0,0 +1,82 @@
+module AuthlogicFacebookShim
+  module Session
+    
+    module Config
+
+      def self.extended(klass)
+        (class << klass; self end).send(:define_method, :default_config) do
+          @default_config ||= begin
+            config_file = File.join(Rails.root, 'config', facebook_config_file)
+            OpenStruct.new(File.exist?(config_file) ? YAML.load_file(config_file)[Rails.env] : {})
+          end
+        end
+      end
+    
+      # Specify your config file if using one. If not then you need to specify
+      # facebook_app_id, facebook_secret_key & facebook_api_key
+      #
+      # * <tt>Default:</tt> facebook.yml
+      # * <tt>Accepts:</tt> String
+      def facebook_config_file(value=nil)
+        rw_config(:facebook_config_file, value, 'facebook.yml')
+      end
+      alias_method :facebook_config_file=, :facebook_config_file
+
+      # Specify your app_id.
+      #
+      # * <tt>Default:</tt> app_id in config/facebook.yml
+      # * <tt>Accepts:</tt> String
+      def facebook_app_id(value=nil)
+        rw_config(:facebook_app_id, value, default_config.app_id)
+      end
+      alias_method :facebook_app_id=, :facebook_app_id
+
+      # Specify your secret_key.
+      #
+      # * <tt>Default:</tt> secret_key in config/facebook.yml
+      # * <tt>Accepts:</tt> String
+      def facebook_secret_key(value=nil)
+        rw_config(:facebook_secret_key, value, default_config.secret_key)
+      end
+      alias_method :facebook_secret_key=, :facebook_secret_key
+
+      # Specify your api_key.
+      #
+      # * <tt>Default:</tt> api_key in config/facebook.yml
+      # * <tt>Accepts:</tt> String
+      def facebook_api_key(value=nil)
+        rw_config(:facebook_api_key, value, default_config.api_key)
+      end
+      alias_method :facebook_api_key=, :facebook_api_key
+
+      # What user field should be used for the facebook UID?
+      #
+      # * <tt>Default:</tt> :facebook_uid
+      # * <tt>Accepts:</tt> Symbol
+      def facebook_uid_field(value=nil)
+        rw_config(:facebook_uid_field, value, :facebook_uid)
+      end
+      alias_method :facebook_uid_field=, :facebook_uid_field
+
+      # What method should be used to find the facebook account?
+      #
+      # * <tt>Default:</tt> :find_by_#{facebook_uid_field}
+      # * <tt>Accepts:</tt> Symbol or String
+      def facebook_finder(value=nil)
+        rw_config(:facebook_finder, value, nil)
+      end
+      alias_method :facebook_finder=, :facebook_finder
+
+      # Should a new user be automatically created if there is no user with
+      # given facebook uid?
+      #
+      # * <tt>Default:</tt> false
+      # * <tt>Accepts:</tt> Boolean
+      def facebook_auto_register(value=nil)
+        rw_config(:facebook_auto_register, value, false)
+      end
+      alias_method :facebook_auto_register=, :facebook_auto_register
+    end
+
+  end
+end

data/lib/authlogic_facebook_shim/session/facebook.rb

@@ -0,0 +1,72 @@
+module AuthlogicFacebookShim
+  module Session
+    
+    module Facebook
+      
+      def self.included(klass)
+      
+        klass.class_eval do
+          attr_accessor :skip_facebook_authentication
+          validate :validate_by_facebook, :if => :authenticating_with_facebook?
+        end
+      
+      end
+      
+      def logged_in_with_facebook?
+        @logged_in_with_facebook
+      end
+
+      protected
+      # Override this if you want only some requests to use facebook
+      def authenticating_with_facebook?
+        !skip_facebook_authentication && !authenticating_with_unauthorized_record? && facebook_session?
+      end
+
+      private
+    
+      def validate_by_facebook
+        facebook_uid = facebook_session.uid
+        self.attempted_record = klass.send(facebook_finder, facebook_uid)
+
+        if self.attempted_record || !facebook_auto_register?
+          return @logged_in_with_facebook = !!self.attempted_record
+        else
+          self.attempted_record = klass.new
+          self.attempted_record.send(:"#{facebook_uid_field}=", facebook_uid)
+          if self.attempted_record.respond_to?(:before_connect)
+            self.attempted_record.send(:before_connect, facebook_session)
+          end
+
+          @logged_in_with_facebook = true
+          return self.attempted_record.save(false)
+        end
+      end
+    
+      def facebook_app_id
+        self.class.facebook_app_id
+      end
+    
+      def facebook_api_key
+        self.class.facebook_api_key
+      end
+    
+      def facebook_secret_key
+        self.class.facebook_secret_key
+      end
+
+      def facebook_auto_register?
+        self.class.facebook_auto_register
+      end
+
+      def facebook_uid_field
+        self.class.facebook_uid_field
+      end
+
+      def facebook_finder
+        self.class.facebook_finder || "find_by_#{facebook_uid_field}"
+      end
+      
+    end
+      
+  end
+end

data/lib/authlogic_facebook_shim/session.rb

@@ -0,0 +1,12 @@
+module AuthlogicFacebookShim
+  module Session
+    
+    def self.included(klass)
+      klass.extend Session::Config      
+      klass.send(:include, Session::Adapter)
+      klass.send(:include, Session::Facebook)
+    end
+    
+  end
+end
+      

data/lib/authlogic_facebook_shim.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+require 'ostruct'
+require 'singleton'
+
+
+if ActiveRecord::Base.respond_to?(:add_acts_as_authentic_module)
+  require 'authlogic_facebook_shim/acts_as_authentic'
+  require 'authlogic_facebook_shim/session/config'
+  require 'authlogic_facebook_shim/session/adapter'
+  require 'authlogic_facebook_shim/session/facebook'
+  require 'authlogic_facebook_shim/session'
+  require 'authlogic_facebook_shim/helper'
+  Authlogic::Session::Base.send :include, AuthlogicFacebookShim::Session
+  ActiveRecord::Base.send       :include, AuthlogicFacebookShim::ActsAsAuthentic
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'authlogic_facebook_shim'

data/test/rails_root/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test/rails_root/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/rails_root/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base
+  acts_as_authentic
+  
+  def before_connect(facebook_session)
+    true
+  end
+end

data/test/rails_root/app/models/user_session.rb

@@ -0,0 +1,7 @@
+class UserSession < Authlogic::Session::Base
+  
+  facebook_app_id     '233423200151'
+  facebook_api_key    'f4fdb590052b81c3d73c5d2aa5908308'
+  facebook_secret_key '8371c9fc95a7d0a3d9cdb6bbacfea306'
+  
+end

data/test/rails_root/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails_root/config/database.yml

@@ -0,0 +1,10 @@
+development:
+  :adapter: sqlite3
+  :database: ":memory:"
+  pool: 5
+  timeout: 5000
+test:
+  :adapter: sqlite3
+  :database: ":memory:"
+  pool: 5
+  timeout: 5000

data/test/rails_root/config/environment.rb

@@ -0,0 +1,31 @@
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+  # config.active_record.schema_format = :sql
+  
+  config.gem "authlogic"
+  config.gem 'flexmock'
+  config.gem "koala"
+  config.gem "shoulda"
+  config.gem "test-unit", :lib => "test/unit"
+  
+  config.frameworks -= [ :active_resource, :action_mailer ]
+  config.log_level = :debug
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.action_controller.consider_all_requests_local = true
+  config.action_controller.perform_caching             = false
+  config.action_view.cache_template_loading            = true
+  config.action_controller.allow_forgery_protection    = false
+  config.action_mailer.delivery_method = :test
+  config.time_zone = 'UTC'
+
+end

data/test/rails_root/config/facebook.yml

@@ -0,0 +1,7 @@
+test:
+  app_id: appidfromfile
+  api_key: apikeyfromfile
+  secret_key: secretkeyfromfile
+  canvas_page_name: facebook_koala
+  callback_url: http://example.com/
+

data/test/rails_root/config/initializers/authlogic_facebook_koala.rb

@@ -0,0 +1,5 @@
+afk_path = File.join(File.dirname(__FILE__), *%w(.. .. .. ..))
+afk_lib_path = File.join(afk_path, "lib")
+
+$LOAD_PATH.unshift(afk_lib_path)
+load File.join(afk_path, "init.rb")

data/test/rails_root/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/test/rails_root/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_rails_root_session',
+  :secret      => '4deb5b6e05377d982fa6ef37582c0be6de39e1473cc99a4a0f32fd61ec735cd9e86276b2c25fc781e7df8cd6afdc819208f7f497a755e217bff75728d05f543b'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store