devise_koala_connectable 0.1.1

data/Manifest

@@ -0,0 +1,13 @@
+README.rdoc
+Rakefile
+devise_koala_connectable.gemspec
+lib/devise_koala_connectable.rb
+lib/devise_koala_connectable/locales/de.yml
+lib/devise_koala_connectable/locales/en.yml
+lib/devise_koala_connectable/model.rb
+lib/devise_koala_connectable/schema.rb
+lib/devise_koala_connectable/strategy.rb
+lib/devise_koala_connectable/version.rb
+lib/devise_koala_connectable/view_helpers.rb
+rails/init.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,31 @@
+= devise_koala_connectable
+
+Rails gem for adding Facebook authentification capabillity to devise using koala
+
+= Install
+
+The gem is hosted on https://rubygems.org/gems/devise_koala_connectable and can be installed using
+
+- gem install devise_koala_connectable
+	
+= Licence
+
+Copyright (C) 2011 Mathias Karstädt
+
+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/Rakefile

@@ -0,0 +1,15 @@
+require "rubygems"
+require "rake"
+require "echoe"
+
+Echoe.new("devise_koala_connectable", "0.1.1") do |p|
+  p.description = "Facebook authentification with koala for devise"
+  p.url         = "http://github.com/webmatze/devise_koala_connectable"
+  p.author      = "Mathias Karstädt"
+  p.email       = "mathias.karstaedt@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ["devise <=1.0.9", "koala"]
+  p.development_dependencies = ["devise <=1.0.9", "koala"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/devise_koala_connectable.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{devise_koala_connectable}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mathias Karst\303\244dt"]
+  s.date = %q{2011-02-17}
+  s.description = %q{Facebook authentification with koala for devise}
+  s.email = %q{mathias.karstaedt@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/devise_koala_connectable.rb", "lib/devise_koala_connectable/locales/de.yml", "lib/devise_koala_connectable/locales/en.yml", "lib/devise_koala_connectable/model.rb", "lib/devise_koala_connectable/schema.rb", "lib/devise_koala_connectable/strategy.rb", "lib/devise_koala_connectable/version.rb", "lib/devise_koala_connectable/view_helpers.rb"]
+  s.files = ["README.rdoc", "Rakefile", "devise_koala_connectable.gemspec", "lib/devise_koala_connectable.rb", "lib/devise_koala_connectable/locales/de.yml", "lib/devise_koala_connectable/locales/en.yml", "lib/devise_koala_connectable/model.rb", "lib/devise_koala_connectable/schema.rb", "lib/devise_koala_connectable/strategy.rb", "lib/devise_koala_connectable/version.rb", "lib/devise_koala_connectable/view_helpers.rb", "rails/init.rb", "Manifest"]
+  s.homepage = %q{http://github.com/webmatze/devise_koala_connectable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Devise_koala_connectable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{devise_koala_connectable}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Facebook authentification with koala for devise}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<devise>, ["<= 1.0.9"])
+      s.add_runtime_dependency(%q<koala>, [">= 0"])
+      s.add_development_dependency(%q<devise>, ["<= 1.0.9"])
+      s.add_development_dependency(%q<koala>, [">= 0"])
+    else
+      s.add_dependency(%q<devise>, ["<= 1.0.9"])
+      s.add_dependency(%q<koala>, [">= 0"])
+      s.add_dependency(%q<devise>, ["<= 1.0.9"])
+      s.add_dependency(%q<koala>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<devise>, ["<= 1.0.9"])
+    s.add_dependency(%q<koala>, [">= 0"])
+    s.add_dependency(%q<devise>, ["<= 1.0.9"])
+    s.add_dependency(%q<koala>, [">= 0"])
+  end
+end

data/lib/devise_koala_connectable/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    sessions:
+      koala_invalid: "Could not login. Invalid account."

data/lib/devise_koala_connectable/model.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+
+module Devise #:nodoc:
+  # module KoalaConnectable #:nodoc:
+  module Models #:nodoc:
+
+    # Koala Connectable Module, responsible for validating authenticity of a
+    # user and storing credentials while signing in.
+    #
+    # == Configuration:
+    #
+    # You can overwrite configuration values by setting in globally in Devise (+Devise.setup+),
+    # using devise method, or overwriting the respective instance method.
+    #
+    # +koala_identifier_field+ - Defines the name of the Koala identifier database attribute/column.
+    #
+    # +koala_auto_create_account+ - Speifies if account should automatically be created upon connect
+    #                                 if not already exists.
+    #
+    # == Examples:
+    #
+    #    User.authenticate_with_koala(:identifier => 'john@doe.com')     # returns authenticated user or nil
+    #    User.find(1).koala_connected?                                  # returns true/false
+    #
+    module KoalaConnectable
+
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          extend ClassMethods
+        end
+      end
+
+      # Store Koala account/session credentials.
+      #
+      def store_koala_credentials!(attributes = {})
+        self.send(:"#{self.class.koala_identifier_field}=", attributes[:identifier])
+
+        # Confirm without e-mail - if confirmable module is loaded.
+        self.skip_confirmation! if self.respond_to?(:skip_confirmation!)
+
+        # Only populate +email+ field if it's available (e.g. if +authenticable+ module is used).
+        self.email = attributes[:email] || '' if self.respond_to?(:email)
+
+        # Lazy hack: These database fields are required if +authenticable+/+confirmable+
+        # module(s) is used. Could be avoided with :null => true for authenticatable
+        # migration, but keeping this to avoid unnecessary problems.
+        self.password_salt = '' if self.respond_to?(:password_salt)
+        self.encrypted_password = '' if self.respond_to?(:encrypted_password)
+      end
+
+      # Checks if Koala connected.
+      #
+      def koala_connected?
+        self.send(:"#{self.class.koala_identifier_field}").present?
+      end
+      alias :is_koala_connected? :koala_connected?
+
+      # Hook that gets called before a successful connection (each time).
+      # Useful for fetching additional user info (etc.) from Facebook.
+      #
+      # Default: Do nothing.
+      #
+      # == Example:
+      #
+      #   # Overridden in Koala connectable model, e.g. "User".
+      #   #
+      #   def before_koala_success(koala_user)
+      #
+      #      # Get email (if the provider supports it)
+      #      email = koala_user["email"]
+      #     # etc...
+      #
+      #   end
+      #
+      def on_before_koala_success(koala_user)
+        self.send(:before_koala_success, koala_user) if self.respond_to?(:before_koala_success)
+      end
+      
+      # Hook that gets called before the auto creation of the user.
+      # Therefore, this hook is only called when koala_auto_create_account config option is enabled.
+      # Useful for fetching additional user info (etc.) from Facebook.
+      #
+      # Default: Do nothing.
+      #
+      # == Example:
+      #
+      #   # Overridden in Koala connectable model, e.g. "User".
+      #   #
+      #   def before_koala_auto_create(koala_user)
+      #
+      #      # Get email (if the provider supports it)
+      #      email = koala_user["email"]
+      #     # etc...
+      #
+      #   end
+      #
+      def on_before_koala_auto_create(koala_user)
+        self.send(:before_koala_auto_create, koala_user) if self.respond_to?(:before_koala_auto_create)
+      end
+
+      module ClassMethods
+
+        # Configuration params accessible within +Devise.setup+ procedure (in initalizer).
+        #
+        # == Example:
+        #
+        #   Devise.setup do |config|
+        #     config.koala_identifier_field = :koala_identifier
+        #     config.koala_auto_create_account = true
+        #     config.koala_app_id = nil
+        #     config.koala_secret_key = nil
+        #     config.koala_callback_url = nil
+        #   end
+        #
+        ::Devise::Models.config(self,
+          :koala_identifier_field,
+          :koala_auto_create_account,
+          :koala_app_id,
+          :koala_secret_key,
+          :koala_callback_url
+        )
+
+        # Alias don't work for some reason, so...a more Ruby-ish alias
+        # for +koala_auto_create_account+.
+        #
+        def koala_auto_create_account?
+          self.koala_auto_create_account
+        end
+
+        # Authenticate a user based on Facebook Identifier.
+        #
+        def authenticate_with_koala(attributes = {})
+          if attributes[:identifier].present?
+            self.find_for_koala(attributes[:identifier])
+          end
+        end
+
+        protected
+
+        # Find first record based on conditions given (Facebook identifier).
+        # Overwrite to add customized conditions, create a join, or maybe use a
+        # namedscope to filter records while authenticating.
+        #
+        def find_for_koala(identifier)
+          self.first(:conditions =>  { koala_identifier_field => identifier })
+        end
+
+        # Contains the logic used in authentication. Overwritten by other devise modules.
+        # In the Koala connect case; nothing fancy required.
+        #
+        def valid_for_koala(resource, attributes)
+          true
+        end
+
+      end
+
+    end
+  end
+end

data/lib/devise_koala_connectable/schema.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'devise/schema'
+
+module Devise #:nodoc:
+  module KoalaConnectable #:nodoc:
+
+    module Schema
+
+      # Database migration schema for koala.
+      #
+      def koala_connectable
+        apply_devise_schema ::Devise.koala_identifier_field, Integer
+      end
+
+    end
+  end
+end
+
+Devise::Schema.module_eval do
+  include ::Devise::KoalaConnectable::Schema
+end

data/lib/devise_koala_connectable/strategy.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require 'devise/strategies/base'
+
+module Devise #:nodoc:
+
+    module Strategies #:nodoc:
+
+      # Default strategy for signing in a user using Koala.
+      # Redirects to sign_in page if it's not authenticated
+      #
+      class KoalaConnectable < Base
+
+        def valid?
+          valid_controller? && valid_params? && mapping.to.respond_to?('authenticate_with_koala')
+        end
+
+        # Authenticate user with Koala.
+        #
+        def authenticate!
+          
+          klass = mapping.to
+
+          raise StandardError, "No api_key or secret_key defined, please see the documentation of Koala gem to setup it." unless klass.koala_app_id.present? and klass.koala_secret_key.present?
+          begin
+            oauth = Koala::Facebook::OAuth.new(klass.koala_app_id, klass.koala_secret_key, klass.koala_callback_url)
+            
+            user_info = oauth.get_user_info_from_cookies(request.cookies)
+            Rails.logger.info user_info.to_yaml
+
+            graph = Koala::Facebook::GraphAPI.new(user_info["access_token"])
+            koala_user = graph.get_object(user_info["uid"])
+            
+            Rails.logger.info koala_user.to_yaml
+
+            fail!(:koala_invalid) and return unless koala_user
+            
+            if user = klass.authenticate_with_koala(koala_user)
+              user.on_before_koala_success(koala_user)
+              success!(user)
+              return
+            end
+            
+            fail!(:koala_invalid) and return unless klass.koala_auto_create_account?
+            
+            user = klass.new
+            user.store_koala_credentials!(koala_user)
+            user.on_before_koala_auto_create(koala_user)
+            
+            user.save(:validate => false)
+            user.on_before_koala_success(koala_user)
+            success!(user)
+            
+          rescue Exception => e
+            Rails.logger.error e.to_yaml
+            fail!(:koala_invalid)
+          end
+        end
+        
+        protected
+          def valid_controller?
+            params[:controller].to_s =~ /sessions/
+          end
+
+          def valid_params?
+            params[:code].present?
+          end
+
+      end
+    end
+
+end
+
+Warden::Strategies.add(:koala_connectable, Devise::Strategies::KoalaConnectable)

data/lib/devise_koala_connectable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module KoalaConnectable
+    VERSION = "0.1.0"
+  end
+end

data/lib/devise_koala_connectable/view_helpers.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module Devise #:nodoc:
+  module KoalaConnectable #:nodoc:
+
+    # Koala view helpers to easily add the link to the Facebook connection popup and also the necessary JS code.
+    #
+    module Helpers
+      
+      # Creates the link to the Facebook connection popup.
+      # If you create a link without putting the JS code, the popup will load in a new page.
+      # The second parameter is the return URL, it must be absolute (***_url).
+      #
+      # For example :
+      # <%= link_to_koala "Signin using Facebook!", user_session_url %>
+      #
+      def link_to_koala(link_text, link_url, options={})
+        options = { :unobtrusive => true }.merge(options)
+    		oauth = Koala::Facebook::OAuth.new(Devise::koala_app_id, Devise::koala_secret_key, Devise::koala_callback_url)
+    		link_to link_text, oauth.url_for_oauth_code(:callback => link_url), options
+      end
+
+      # Returns the necessary JS code for the Facebook popup.
+      # It is recommended to put this code just before the </body> tag of your layout.
+      # 
+      # For example :
+      # ...
+      # <%= javascript_include_koala %>
+      # </body>
+      # </html>
+      #
+      def javascript_include_koala
+    		"<div id=\"fb-root\"></div>
+        <script src=\"http://connect.facebook.net/en_US/all.js\"></script>
+        <script>
+           FB.init({ 
+              appId:'#{Devise::koala_app_id}', cookie:true, 
+              status:true, xfbml:true 
+           });
+        </script>"
+      end
+      
+
+      # Returns the Login To Facebook button.
+      # 
+      # For example :
+      # ...
+      # <%= koala_login_button("Login with Facebook") %>
+      #
+      def koala_login_button(button_text = "Login with Facebook")
+        "<fb:login-button>#{button_text}</fb:login-button>"
+      end
+      
+    end
+  end
+end
+
+::ActionView::Base.send :include, Devise::KoalaConnectable::Helpers

data/lib/devise_koala_connectable.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+unless defined?(Devise)
+  require 'devise'
+end
+unless defined?(Koala)
+  require 'koala'
+end
+
+require 'devise_koala_connectable/model'
+require 'devise_koala_connectable/strategy'
+require 'devise_koala_connectable/schema'
+require 'devise_koala_connectable/view_helpers'
+
+module Devise
+  mattr_accessor :koala_identifier_field
+  @@koala_identifier_field = :koala_identifier
+  
+  mattr_accessor :koala_auto_create_account
+  @@koala_auto_create_account = true
+
+  mattr_accessor :koala_app_id
+  @@koala_app_id = nil
+
+  mattr_accessor :koala_secret_key
+  @@koala_secret_key = nil
+
+  mattr_accessor :koala_callback_url
+  @@koala_callback_url = nil
+end
+
+I18n.load_path.unshift File.join(File.dirname(__FILE__), *%w[devise_koala_connectable locales en.yml])
+
+Devise.add_module(:koala_connectable,
+  :strategy => true,
+  :controller => :sessions,
+  :model => 'devise_koala_connectable/model')

data/rails/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'devise_koala_connectable'

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: devise_koala_connectable
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Mathias Karst\xC3\xA4dt"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 +01: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: 5
+        segments: 
+        - 1
+        - 0
+        - 9
+        version: 1.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: koala
+  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
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <=
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 0
+        - 9
+        version: 1.0.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: koala
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Facebook authentification with koala for devise
+email: mathias.karstaedt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/devise_koala_connectable.rb
+- lib/devise_koala_connectable/locales/de.yml
+- lib/devise_koala_connectable/locales/en.yml
+- lib/devise_koala_connectable/model.rb
+- lib/devise_koala_connectable/schema.rb
+- lib/devise_koala_connectable/strategy.rb
+- lib/devise_koala_connectable/version.rb
+- lib/devise_koala_connectable/view_helpers.rb
+files: 
+- README.rdoc
+- Rakefile
+- devise_koala_connectable.gemspec
+- lib/devise_koala_connectable.rb
+- lib/devise_koala_connectable/locales/de.yml
+- lib/devise_koala_connectable/locales/en.yml
+- lib/devise_koala_connectable/model.rb
+- lib/devise_koala_connectable/schema.rb
+- lib/devise_koala_connectable/strategy.rb
+- lib/devise_koala_connectable/version.rb
+- lib/devise_koala_connectable/view_helpers.rb
+- rails/init.rb
+- Manifest
+has_rdoc: true
+homepage: http://github.com/webmatze/devise_koala_connectable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Devise_koala_connectable
+- --main
+- README.rdoc
+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: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: devise_koala_connectable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Facebook authentification with koala for devise
+test_files: []
+