authlogic_facebook_koala 0.0.2 → 0.3.0

data/README.rdoc

@@ -2,12 +2,70 @@
 
 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.
+* 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)

data/Rakefile

@@ -1,7 +1,10 @@
 require 'rubygems'
 require 'rake'
-
+require 'jeweler'
 require 'rake/rdoctask'
+
+Jeweler::Tasks.new
+
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
@@ -10,3 +13,27 @@ Rake::RDocTask.new do |rdoc|
   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

@@ -1 +1 @@
-0.0.1
+0.3.0

data/authlogic_facebook_koala.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = %q{authlogic_facebook_koala}
-  s.version = "0.0.2"
+  s.version = "0.3.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  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 Javascript OAuth2 Sessions, using the koala gem for facebook graph access.}
@@ -11,54 +11,21 @@ Gem::Specification.new do |s|
     "LICENSE",
      "README.rdoc"
   ]
-  s.files = [
-     "authlogic_facebook_koala.gemspec",
-     "init.rb",
-     "lib/authlogic_facebook_koala/acts_as_authentic.rb",
-     "lib/authlogic_facebook_koala/config.rb",
-     "lib/authlogic_facebook_koala/controller.rb",
-     "lib/authlogic_facebook_koala/helper.rb",
-     "lib/authlogic_facebook_koala/session.rb",
-     "lib/authlogic_facebook_koala.rb",
-     "LICENSE",
-     "rails/init.rb",
-     "Rakefile",
-     "README.rdoc",
-     "test/test_helper.rb",
-     "test/session_test.rb",
-     'test/libs/user.rb',
-     'test/libs/user_session.rb',
-     "VERSION"
-  ]
+  s.files = Dir.glob('**/*') - Dir.glob('authlogic_facebook_koala*.gem')
   s.homepage = %q{http://github.com/james2m/authlogic_facebook_koala}
   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 OAuth2 javascript sessions using koala gem}
-  s.test_files = [
-    'test/libs/user.rb',
-    'test/libs/user_session.rb',
-    "test/test_helper.rb",
-    "test/session_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.test_files = Dir.glob('test/**/*')
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<koala>, [">= 0.7.1"])
-      s.add_runtime_dependency(%q<authlogic>, [">= 2.1.3"])
-      s.add_development_dependency(%q<test-unit>, [">= 2.0.6"])
-    else
-      s.add_dependency(%q<koala>, [">= 0.7.1"])
-      s.add_dependency(%q<authlogic>, [">= 2.1.3"])
-      s.add_dependency(%q<test-unit>, [">= 2.0.6"])
-    end
-  else
-    s.add_dependency(%q<mini_fb>, [">= 0.2.2"])
-    s.add_dependency(%q<authlogic>, [">= 2.1.3"])
-    s.add_dependency(%q<test-unit>, [">= 2.0.6"])
-  end
+  s.add_runtime_dependency('authlogic', ">= 2.1.3")
+  s.add_runtime_dependency('koala', ">= 0.7.1")
+  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/lib/authlogic_facebook_koala.rb

@@ -1,11 +1,17 @@
+require 'yaml'
+require 'ostruct'
+require 'singleton'
+
 require 'authlogic_facebook_koala/config'
+require 'authlogic_facebook_koala/adapter'
 require 'authlogic_facebook_koala/acts_as_authentic'
 require 'authlogic_facebook_koala/session'
 require 'authlogic_facebook_koala/helper'
-require 'authlogic_facebook_koala/controller'
 
 if ActiveRecord::Base.respond_to?(:add_acts_as_authentic_module)
-  ActiveRecord::Base.send(:include, AuthlogicFacebookKoala::ActsAsAuthentic)
-  Authlogic::Session::Base.send(:include, AuthlogicFacebookKoala::Session)
-  ActionController::Base.send(:include, AuthlogicFacebookKoala::Controller)
+  ActiveRecord::Base.send       :include, AuthlogicFacebookKoala::ActsAsAuthentic
+  
+  Authlogic::Session::Base.send :extend,  AuthlogicFacebookKoala::Config
+  Authlogic::Session::Base.send :include, AuthlogicFacebookKoala::Session
+  Authlogic::Session::Base.send :include, AuthlogicFacebookKoala::Adapter
 end

data/lib/authlogic_facebook_koala/adapter.rb

@@ -0,0 +1,35 @@
+module AuthlogicFacebookKoala
+  
+  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
+    

data/lib/authlogic_facebook_koala/config.rb

@@ -1,6 +1,80 @@
-require 'yaml'
-require 'ostruct'
-
 module AuthlogicFacebookKoala
-  CONFIG = OpenStruct.new( YAML.load_file("#{Rails.root}/config/facebook.yml")[Rails.env] )
+  
+  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

data/lib/authlogic_facebook_koala/session.rb

@@ -1,134 +1,68 @@
 module AuthlogicFacebookKoala
   module Session
+    
     def self.included(klass)
+      
       klass.class_eval do
-        extend Config
-        include Methods
-      end
-    end
-
-    module Config
-      # REQUIRED
-      #
-      # Specify your app_id.
-      #
-      # * <tt>Default:</tt> nil
-      # * <tt>Accepts:</tt> String
-      def facebook_app_id(value=nil)
-        rw_config(:facebook_app_id, value, nil)
-      end
-      alias_method :facebook_app_id=, :facebook_app_id
-
-      # REQUIRED
-      #
-      # Specify your secret_key.
-      #
-      # * <tt>Default:</tt> nil
-      # * <tt>Accepts:</tt> String
-      def facebook_secret_key(value=nil)
-        rw_config(:facebook_secret_key, value, nil)
-      end
-      alias_method :facebook_secret_key=, :facebook_secret_key
-
-      # Specify your api_key.
-      #
-      # * <tt>Default:</tt> nil
-      # * <tt>Accepts:</tt> String
-      def facebook_api_key(value=nil)
-        rw_config(:facebook_api_key, value, nil)
-      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
-
-    module Methods
-      def self.included(klass)
-        klass.class_eval do
-          validate :validate_by_facebook, :if => :authenticating_with_facebook?
-        end
+        attr_accessor :skip_facebook_authentication
+        validate :validate_by_facebook, :if => :authenticating_with_facebook?
       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?
-        if controller.respond_to?(:controller) && controller.controller.respond_to?(:set_facebook_session)
-          controller.set_facebook_session
-          !authenticating_with_unauthorized_record? && controller.facebook_session?
-        end
-      end
-
-      private
+    end
       
-      def validate_by_facebook
-        puts "validating with facebook"
-        facebook_uid = facebook_session.uid
-        self.attempted_record = klass.send(facebook_finder, facebook_uid)
+    def logged_in_with_facebook?
+      @logged_in_with_facebook
+    end
 
-        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
+    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
 
-          @logged_in_with_facebook = true
-          return self.attempted_record.save(false)
+    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
-      end
-
-      def facebook_user
-        controller.facebook_user
-      end
-
-      def facebook_session
-        controller.facebook_session
-      end
 
-      def facebook_auto_register?
-        self.class.facebook_auto_register
+        @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_uid_field
-        self.class.facebook_uid_field
-      end
+    def facebook_auto_register?
+      self.class.facebook_auto_register
+    end
 
-      def facebook_finder
-        self.class.facebook_finder || "find_by_#{facebook_uid_field}"
-      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