authlogic_facebook_koala 0.0.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,18 @@
+= authlogic_facebook_koala
+
+This is a plugin for integrating facebook sessions into authlogic.
+
+== 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,12 @@
+require 'rubygems'
+require 'rake'
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "authlogic_facebook_koala #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/authlogic_facebook_koala.gemspec

@@ -0,0 +1,64 @@
+Gem::Specification.new do |s|
+  s.name = %q{authlogic_facebook_koala}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 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.}
+  s.email = %q{james2mccarthy@gmail.com}
+  s.extra_rdoc_files = [
+    "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.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
+
+    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
+end
+

data/init.rb

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

data/lib/authlogic_facebook_koala/acts_as_authentic.rb

@@ -0,0 +1,20 @@
+module AuthlogicFacebookKoala
+  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_koala/config.rb

@@ -0,0 +1,6 @@
+require 'yaml'
+require 'ostruct'
+
+module AuthlogicFacebookKoala
+  CONFIG = OpenStruct.new( YAML.load_file("#{Rails.root}/config/facebook.yml")[Rails.env] )
+end

data/lib/authlogic_facebook_koala/controller.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+module AuthlogicFacebookKoala
+  module Controller
+    
+    def self.included(controller)
+      controller.send(:helper_method, :facebook_user?, :facebook_user, :facebook_session?, :facebook_session)
+    end
+  
+    # TODO update to use the new facebook_user stuff we are going to create
+    # can probably kill this now.
+    def set_current_account_session_from_facebook_session
+      unless current_account_session
+        @current_account_session = AccountSession.new
+        @current_account_session.account = Account.find_by_facebook_uid(facebook_session.user.uid)
+      end
+    end
+  
+    def facebook_user?
+      !!facebook_user
+    end
+  
+    def facebook_user
+      if @facebook_user
+        return @facebook_user 
+      elsif facebook_session?
+        facebook_graph = Koala::Facebook::GraphAPI.new(facebook_session.access_token)
+        user = facebook_graph.get_object('me')
+        user[:uid] = user.delete('id')
+        return @facebook_user = OpenStruct.new( user )
+      end
+    end
+  
+    def facebook_session?
+      !!facebook_session
+    end
+    
+    protected
+    
+    def facebook_session
+      @facebook_session
+    end
+    
+    def set_facebook_session
+      if @facebook_session
+        return(@facebook_session) 
+      elsif cookies.has_key?("fbs_#{facebook_params.app_id}")
+        oauth = Koala::Facebook::OAuth.new(facebook_params.app_id, facebook_params.secret_key)
+        @facebook_session = OpenStruct.new( oauth.get_user_from_cookie(cookies) )
+      end
+    end
+      
+    private
+    
+    def facebook_params
+      AuthlogicFacebookKoala::CONFIG
+    end
+    
+  end
+end

data/lib/authlogic_facebook_koala/helper.rb

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

data/lib/authlogic_facebook_koala/session.rb

@@ -0,0 +1,134 @@
+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
+      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
+      
+      def validate_by_facebook
+        puts "validating with 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_user
+        controller.facebook_user
+      end
+
+      def facebook_session
+        controller.facebook_session
+      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_koala.rb

@@ -0,0 +1,11 @@
+require 'authlogic_facebook_koala/config'
+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)
+end

data/rails/init.rb

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

data/test/libs/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  acts_as_authentic
+end

data/test/libs/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/session_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class SessionTest < ActiveSupport::TestCase
+  def test_logged_in_with_facebook
+    session = UserSession.new
+    assert session.respond_to?(:logged_in_with_facebook?)
+  end
+  
+  def test_validate_openid_error
+    session = UserSession.new
+    session.openid_identifier = "yes"
+    session.openid_identifier = "%"
+    assert_nil session.openid_identifier
+    assert !session.save
+    assert session.errors.on(:openid_identifier)
+  end
+  
+  def test_validate_by_nil_openid_identifier
+    session = UserSession.new
+    assert !session.save
+    assert !redirecting_to_yahoo?
+  end
+  
+  def test_validate_by_correct_openid_identifier
+    session = UserSession.new
+    session.openid_identifier = "https://me.yahoo.com/a/9W0FJjRj0o981TMSs0vqVxPdmMUVOQ--"
+    assert !session.save
+    assert redirecting_to_yahoo?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,82 @@
+require "test/unit"
+require "rubygems"
+require "ruby-debug"
+require "active_record"
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.datetime  :created_at
+    t.datetime  :updated_at
+    t.integer   :lock_version, :default => 0
+    t.string    :login
+    t.string    :crypted_password
+    t.string    :password_salt
+    t.string    :persistence_token
+    t.string    :single_access_token
+    t.string    :perishable_token
+    t.string    :openid_identifier
+    t.string    :email
+    t.string    :first_name
+    t.string    :last_name
+    t.integer   :login_count, :default => 0, :null => false
+    t.integer   :failed_login_count, :default => 0, :null => false
+    t.datetime  :last_request_at
+    t.datetime  :current_login_at
+    t.datetime  :last_login_at
+    t.string    :current_login_ip
+    t.string    :last_login_ip
+    t.string    :facebook_uid
+    t.string    :facebook_session_key
+    t.string    :facebook_access_token
+    t.string    :facebook_expires
+    t.string    :facebook_secret
+    t.string    :facebook_sig
+    
+  end
+end
+
+require "active_record/fixtures"
+require 'action_controller'
+Rails = true # to trick authlogic into loading the rails adapter
+require  "authlogic"
+require  "authlogic/test_case"
+require File.dirname(__FILE__) + '/../lib/authlogic_facebook_koala'  unless defined?(AuthlogicFacebookKoala)
+require File.dirname(__FILE__) + '/libs/user'
+require File.dirname(__FILE__) + '/libs/user_session'
+
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+  self.fixture_path = File.dirname(__FILE__) + "/fixtures"
+  self.use_transactional_fixtures = false
+  self.use_instantiated_fixtures  = false
+  self.pre_loaded_fixtures = false
+  fixtures :all
+  setup :activate_authlogic
+  
+  private
+    def activate_authlogic
+      Authlogic::Session::Base.controller = controller
+    end
+    
+    def controller
+      @controller ||= Authlogic::ControllerAdapters::RailsAdapter.new(ActionController.new)
+    end
+end
+
+# --- Sample valid cookie hash generated with the code below
+# cookie_hash = {'fbs_233423200151' => 'access_token=233423200151|6892d62675cd952ade8b3f9b-6184456410|xrNaOlTCUF0QFZrJCHmVWzTb5Mk.&expires=0&secret=339a00cdafe6959c3caa1b8004e5f8db&session_key=6892d62675cd952ade8b3f9b-6184456410&sig=19d3c9ccb5b5a55d680ed1cf18698f57&uid=6184456410'}
+
+# --- Generates user params from cookie for this app_id & secret
+# oauth = Koala::Facebook::OAuth.new('233423200151', '8371c9fc95a7d0a3d9cdb6bbacfea306')
+# params = oauth.get_user_from_cookie(cookie_hash)
+
+# --- Generates a signature for a cookie hash
+# fb_cookie = cookie_hash["fbs_233423200151"]
+# components = {}
+# fb_cookie.split("&").map {|param| param = param.split("="); components[param[0]] = param[1]}
+# auth_string = components.keys.sort.collect {|a| a == "sig" ? nil : "#{a}=#{components[a]}"}.reject {|a| a.nil?}.join("")
+# sig = Digest::MD5.hexdigest(auth_string + '8371c9fc95a7d0a3d9cdb6bbacfea306')
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: authlogic_facebook_koala
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- James McCarthy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: koala
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: authlogic
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 1
+        - 3
+        version: 2.1.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        - 6
+        version: 2.0.6
+  type: :development
+  version_requirements: *id003
+description: Authlogic plugin to support Facebook Javascript OAuth2 Sessions, using the koala gem for facebook graph access.
+email: james2mccarthy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/james2m/authlogic_facebook_koala
+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: Authlogic plugin to support Facebook OAuth2 javascript sessions using koala gem
+test_files: 
+- test/libs/user.rb
+- test/libs/user_session.rb
+- test/test_helper.rb
+- test/session_test.rb