facebook-rails-starterkit 0.2.0 → 0.2.1

data/Gemfile

@@ -3,13 +3,13 @@ source :rubygems
 # Facebook
 gem 'koala', 	'>= 1.4.0'
 gem 'hashie', '~> 1.2.0'
-gem 'fb_joy', '~> 0.1.2' # Joey with some fixes
+# gem 'fb_joy', '~> 0.1.2' # Joey with some fixes
+gem 'rails_config_loader', '~> 0.1.1'
 
 group :development, :Test do
   gem "rspec", 		">= 2.8.0"
 end
 
-
 group :development do
   gem "rdoc", 		">= 3.12"
   gem "bundler", 	">= 1.1.0"

data/Gemfile.lock

@@ -7,8 +7,6 @@ GEM
       addressable (~> 2.2)
       multipart-post (~> 1.1)
       rack (~> 1.1)
-    fb_joy (0.1.2)
-      hashie
     git (1.2.5)
     hashie (1.2.0)
     jeweler (1.8.3)
@@ -17,12 +15,16 @@ GEM
       rake
       rdoc
     json (1.6.6)
+    json_pure (1.7.1)
     koala (1.4.1)
       faraday (~> 0.7.0)
       multi_json (~> 1.3.0)
     multi_json (1.3.2)
     multipart-post (1.1.5)
     rack (1.4.1)
+    rails_config_loader (0.1.1)
+      hashie
+      json_pure
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -44,10 +46,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.1.0)
-  fb_joy (~> 0.1.2)
   hashie (~> 1.2.0)
   jeweler (>= 1.8.3)
   koala (>= 1.4.0)
+  rails_config_loader (~> 0.1.1)
   rdoc (>= 3.12)
   rspec (>= 2.8.0)
   simplecov (>= 0.5)

data/README.md

@@ -1,6 +1,6 @@
 ## Facebook Rails starter kit
 
-This gem leverages the gem: 'joey'. Joey in turn sits on top of 'koala' and uses the 'hashie' gem for easy hash access (as returned by the Facebook graph API via Koala).
+This gem uses the 'hashie' gem for easy hash access (as returned by the Facebook graph API via Koala).
 
 In an initializer or similar "boot location" for your app facebook integration:
 
@@ -18,7 +18,7 @@ class MyCool
 		include Singleton
 
 		# please change!
-		def id
+		def identifier
 			'219868431409649' 
 		end
 
@@ -28,7 +28,7 @@ class MyCool
 		end
 
 		# please change for staging/production
-		def url
+		def site_url
 			'http://localhost:3000'
 		end
 
@@ -44,47 +44,18 @@ end
 The `facebook.yml` file in `config/apis`:
 
 ```yaml
-id: 219868431409649
+identifier: 219868431409649
 secret: 7e5699f155df01d8e52b35c01dccd627
-url: http://localhost:3000
+site_url: http://localhost:3000
 default_permissions: ["publish_stream", "read_stream", "email"]
+callback_path: '/home/callback'
 ```
 
-And here how to load it into the AppConfig singleton.
+Note that the `site_url` is the url of your site hosting the external Facebook app integration, fx: `www.mycoolapp.com`.
 
-```ruby
-class MyCool
-	class FacebookAppConfig
-		include Singleton
-
-		def loader
-			@loader ||= ConfigLoader::Yaml.new 'apis', 'facebook.yml'
-		end
-
-		def secret
-			loader.load.secret
-		end
-	end
-end
-```
-
-Or using the special Delegator module included. This module requires a #config method to be defined like so:
-
-```ruby
-class MyCool
-	class FacebookAppConfig
-		include Singleton
-		include ConfigLoader::Delegator
-
-		def config
-			@config ||= ConfigLoader::Yaml.new 'apis', 'facebook.yml'
-		end
-	end
-end
-```
+See the `config_loader` or 'config-file-loader' gem for a nice way to load these yaml config values into a global `App` object of some kind.
 
-Here a call to any method not defined on this app config, will be delegated to the loader, which returns the yaml as a Hashie for direct method access.
-This would allow you to:
+Configuring this would allow you to do something like:
 
 `Facebook.app.secret` # => value loaded from 'secret' entry in facebook.yml
 
@@ -97,7 +68,7 @@ class CampaignController < ApplicationController
 	include Facebook::Access::Helper
 
   def signup
-  	fb_login
+  	fb_login!
   end
 end
 ```
@@ -111,17 +82,24 @@ Some of the key methods made available are:
 * signed_request
 * registration
 
-You can now access the Facebook graph API for the current (session) user.
+You can access the Facebook graph API for the current (session) user.
+
+For this to work, it requires a previous Facebook login which can be done fx via the Facebook login button (see fx 'facebook-social_plugins' gem). Alternatively use OAuth directly, fx by using the `fb_login!` method.
 
-For this to work, it requires a previous Facebook login which can be done fx via the Facebook login button (see fx 'facebook-social_plugins' gem). Alternatively use OAuth directly.
+Note: You can use the `after_authenticate_new_user(user)` hook method to fx add the authenticated user to the session for the `current_user` or similar method.
+
+## Debugging and logging
+
+You can set the `Facebook::Starterkit.logging_on!` in order to get some logging/debugging output while using the Starterkit. By default, logging is turned off. You can also turn it off using ``Facebook::Starterkit.logging_off!`
 
 ## Facebook Graph API
 
-The `fb_graph` method returns a class with some nice convenience methods. The 
-graph api used is `Koala::Facebook::GraphAndRestAPI` from the `joey` gem, which uses Hashie (see `hashie gem) under the covers for easy access into the hashes returned.
+The `fb_graph` method returns a class with some nice convenience methods. The graph api used is `Koala::Facebook::API` from the `koala` gem.
 
 * me
 
+The me method call get_object('me') on the GraphAPI and converts the returned `Hash` into a `Hashie` for easy method access (using `method_missing`). 
+
 The following methods are all prefixed with 'my_'
 
 * name
@@ -245,12 +223,26 @@ rake db:migrate
 In your `routes.rb file
 
 ```ruby
-match 'facebook/registration' => 'registrations#create', :as => :new_user_registration
+match 'auth/:provider/registration' => 'registrations#create', :as => :registration
 
 # See http://railscasts.com/episodes/235-omniauth-part-1
 match 'auth/:provider/callback' => 'authentications#create'
 ```
 
+The `:provider` param can be accessed in the controller via `params[:provider]`.
+Note that the method `auth_provider` is already defined to return this value or default to `'facebook'`.
+
+You can then use the route like this:
+
+```haml
+= link_to "Register with Facebook", registration_path('facebook')
+```
+
+Or perhaps like this:
+
+```haml
+= button_to "", registration_path('facebook'), :class => "facebook_button"
+``
 ## Contributing to facebook-rails-starterkit
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/config/locales/omniauth/en.yml

@@ -0,0 +1,6 @@
+en:
+  facebook:
+    auth:
+      signed_in: Signed in with Facebook
+      success: Facebook login success
+      destroyed: Logged out from Facebook

data/facebook-rails-starterkit.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "facebook-rails-starterkit"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -25,10 +25,11 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "config/locales/omniauth/en.yml",
     "facebook-rails-starterkit.gemspec",
-    "lib/config_loader/yaml.rb",
     "lib/facebook-rails-starterkit.rb",
     "lib/facebook/access/helper.rb",
+    "lib/facebook/access/omniauth.rb",
     "lib/facebook/app.rb",
     "lib/facebook/auth/devise.rb",
     "lib/facebook/graph_api.rb",
@@ -50,7 +51,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<koala>, [">= 1.4.0"])
       s.add_runtime_dependency(%q<hashie>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<fb_joy>, ["~> 0.1.2"])
+      s.add_runtime_dependency(%q<rails_config_loader>, ["~> 0.1.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
@@ -59,7 +60,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<koala>, [">= 1.4.0"])
       s.add_dependency(%q<hashie>, ["~> 1.2.0"])
-      s.add_dependency(%q<fb_joy>, ["~> 0.1.2"])
+      s.add_dependency(%q<rails_config_loader>, ["~> 0.1.1"])
       s.add_dependency(%q<rspec>, [">= 2.8.0"])
       s.add_dependency(%q<rdoc>, [">= 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.1.0"])
@@ -69,7 +70,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<koala>, [">= 1.4.0"])
     s.add_dependency(%q<hashie>, ["~> 1.2.0"])
-    s.add_dependency(%q<fb_joy>, ["~> 0.1.2"])
+    s.add_dependency(%q<rails_config_loader>, ["~> 0.1.1"])
     s.add_dependency(%q<rspec>, [">= 2.8.0"])
     s.add_dependency(%q<rdoc>, [">= 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.1.0"])

data/lib/facebook-rails-starterkit.rb

@@ -1,6 +1,26 @@
-require 'config_loader/yaml'
 require 'facebook/app'
 require 'facebook/graph_api'
 require 'facebook/access/helper'
+require 'facebook/access/omniauth'
 
-require 'facebook/auth/devise' if defined?(Devise)
+require 'facebook/auth/devise' if defined?(Devise)
+
+module Facebook
+  module Starterkit
+    class << self
+      attr_accessor :logging
+
+      def logging_on!
+        @logging = true
+      end
+
+      def logging_off!
+        @logging = false
+      end
+
+      def logging?
+        @logging
+      end
+    end
+  end
+end

data/lib/facebook/access/helper.rb

@@ -2,12 +2,38 @@ module Facebook
   module Access
     module Helper
       def fb_retrieve_access_token
-        session[:access_token] = session[:oauth].get_access_token(params[:code]) if params[:code]
+        session[:access_token] = has_code? ? access_token_from_code : cookies_access_token
+        log! 'session-access_token', session[:access_token]
       end    
 
-      def fb_login permissions
-        session[:oauth] = Koala::Facebook::OAuth.new(fb_app.id, fb_app.secret, fb_app.url + '/home/callback')
+      def access_token_from_code
+        session[:oauth].get_access_token(code) 
+      end        
+
+      def fb_login permissions = nil
+        session[:oauth] = oauth_api.new(fb_app.identifier, fb_app.secret, fb_app.site_url + fb_app.callback_path)                
+        log! 'session-oath', session[:oauth]
         @auth_url =  session[:oauth].url_for_oauth_code(:permissions=> permissions || fb_app.default_permissions)
+        log! 'auth_url', @auth_url
+      end
+
+      def fb_login! permissions = nil
+        fb_login permissions
+        redirect_to auth_url        
+      end
+
+      def cookies_access_token
+        @cookies_access_token ||= session[:oauth].get_user_info_from_cookies(cookies)
+      end
+
+      def user_access_token
+        @user_access_token ||= user_cookie_info["access_token"]
+        log! 'user cookie access_token', @user_access_token
+        @user_access_token
+      end
+
+      def real_time_updates
+        @updates = Facebook.updates_api.new(:app_id => fb_app.identifier, :secret => fb_app.secret)
       end
 
       def auth_url
@@ -19,11 +45,17 @@ module Facebook
       end
 
       def fb_graph
-        Facebook::GraphApi.new session
+        @fb_graph ||= graph_api.new session
+        log! 'fb_graph', @fb_graph
+        @fb_graph
       end
 
       def fb_my_id
-        fb_graph.my_id
+        @fb_my_id ||= fb_graph.my_id
+      end
+
+      def auth_provider
+        params[:provider] || 'facebook'
       end
 
       # for FB Registration plugin
@@ -38,9 +70,41 @@ module Facebook
 
       protected
 
+      def has_code?
+        params[:code]
+      end
+
+      def code
+        params[:code]
+      end
+
+      def auth_sessions?
+        session[:access_token] && session[:oauth]
+      end
+
+      def log! title, msg
+        msg = msg.kind_of?(String) ? msg : msg.inspect
+        puts "#{title}: #{msg}" if auth_logging?
+      end
+
+      def auth_logging?
+        Facebook::Starterkit.logging?
+      end
+
+      def oauth_api
+        Koala::Facebook::OAuth
+      end
+
+      # Custom GraphAPI wrapper
+      def graph_api
+        Facebook::GraphApi
+      end
+
       # http://acknowledgement.co.uk/post/Decoding-and-Accessing-The-signed_request-Parameter-in-Rails/247
       def decoded_signed_request
-        decoder.decode params['signed_request']
+        @decoded_signed_request ||= decoder.decode params['signed_request']
+        log! 'decoded_signed_request', @decoded_signed_request
+        @decoded_signed_request
       end
 
       def decoder

data/lib/facebook/access/omniauth.rb

@@ -0,0 +1,17 @@
+module Facebook
+  module Access
+    module Omniauth
+      def omniauth
+        request.env["omniauth.auth"]
+      end
+
+      def auth_provider
+        omniauth['provider']
+      end
+
+      def user_id
+        omniauth['uid']
+      end
+    end
+  end
+end

data/lib/facebook/app.rb

@@ -14,20 +14,7 @@ module Facebook
 
 		attr_accessor :fb_app
 
-		def id
-			fb_app.id
-		end
-
-		def secret_key
-			fb_app.secret
-		end
-
-		def site_url
-			fb_app.url
-		end		
-
-	  def fb_default_permissions
-	    fb_app.default_permissions
-	  end
+		delegate :identifier, :secret, :site_url, :default_permissions, 
+						 :callback_path, :to => :fb_app #, :allow_nil => true
 	end
 end

data/lib/facebook/auth/devise.rb

@@ -2,16 +2,16 @@ require 'facebook/access/helper'
 
 module Facebook
 	module Auth
-		include Facebook::Access::Helper
-
 		module Devise
+			include Facebook::Access::Helper
+
 			def index
 			  @authentications = current_user.authentications if current_user
 			end
 
 			# based on OmniAuth 2 railscast
 			def create
-			  authentication ? authenticated : try_authenticate_user
+			  authenticated? ? authenticated : try_authenticate_user
 			end
 
 			def destroy
@@ -40,14 +40,20 @@ module Facebook
 			end
 
 			def authenticate_user
+				# fb_login!
 		    current_user.authentications.create(:provider => auth_provider, :uid => fb_my_id)
 		    flash[:notice] = t "#{auth_provider}.auth.success"
 		    redirect_to authentications_url
 		  end
 
 			def authenticate_new_user
-		    new_user.authentications.build(:provider => auth_provider, :uid => fb_my_id)
+				fb_login!
+		    user = new_user.authentications.build(:provider => auth_provider, :uid => fb_my_id)
 		    user.save ? authenticated_user_saved : authenticated_user_not_saved
+		    after_authenticate_new_user(user)
+			end
+
+			def after_authenticate_new_user user
 			end
 
 			def authenticated_user_saved
@@ -59,6 +65,10 @@ module Facebook
 	    	redirect_to new_user_registration_url
 	    end
 
+	    def authenticated?
+				auth_sessions? && authentication
+			end
+
 			def authentication
 				@authentication ||= Authentication.find_by_provider_and_uid(auth_provider, fb_my_id)
 			end

data/lib/facebook/graph_api.rb

@@ -1,18 +1,35 @@
 module Facebook
+	def self.api
+		::Koala::Facebook::API
+	end
+
+	def self.updates_api
+		::Koala::Facebook::RealtimeUpdates
+	end
+
 	class GraphApi
-		attr_reader :api, :access_token
+		attr_reader :fb_api, :access_token
 
 		def initialize session
 			@access_token = session[:access_token]
-			@api = Koala::Facebook::GraphAndRestAPI.new(access_token)			
+			log! 'GraphApi access_token', @access_token
+			@fb_api =  ::Facebook.api.new(access_token)			
+		end
+
+		def api
+			@api ||= fb_api
 		end
 
+		def self.clazz
+    	::Facebook.api
+    end
+
 		# also see https://developers.facebook.com/docs/reference/fql/
 		# The Facebook Query Language for more efficient complex queries
 		# Also enables Multi-query
 
 	  def me
-	    @me ||= api.me
+	    @me ||= ::Hashie::Mash.new api.get_object('me')
 	  end
 
 	  # my_id, my_email ...
@@ -39,6 +56,17 @@ module Facebook
 
 	  def post_on_wall message
 	    api.put_wall_post message
-	  end		
+	  end
+
+	  protected
+
+  	def log! title, msg
+      msg = msg.kind_of?(String) ? msg : msg.inspect
+      puts "#{title}: #{msg}" if logging?
+    end
+
+    def logging?
+      Facebook::Starterkit.logging?
+    end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook-rails-starterkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -44,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: fb_joy
+  name: rails_config_loader
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -155,10 +155,11 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- config/locales/omniauth/en.yml
 - facebook-rails-starterkit.gemspec
-- lib/config_loader/yaml.rb
 - lib/facebook-rails-starterkit.rb
 - lib/facebook/access/helper.rb
+- lib/facebook/access/omniauth.rb
 - lib/facebook/app.rb
 - lib/facebook/auth/devise.rb
 - lib/facebook/graph_api.rb
@@ -182,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1771464293568223461
+      hash: -3307906802591948014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/config_loader/yaml.rb

@@ -1,43 +0,0 @@
-require 'hashie'
-
-module ConfigLoader
-  class Yaml
-  	attr_reader :path, :file_name, :ext, :file_path, :root
-
-  	# will try root element if such exists
-		def initialize file_path, root = nil
-			@file_path = file_path
-			@path 		 = File.dirname file_path
-			@file_name = File.basename file_path
-			@ext 			 = file_name.split(/(ya?ml$)/).last
-			@root 		 = (root || file_name.split('.').first).to_s
-			@root 		 = nil unless mashie.send(@root)
-			@mashie 	 = mashie.send(@root) if @root
-		end
-
-		def as_hash
-			@as_hash ||= mashie
-		end
-
-		def as_yaml
-			@as_yaml ||= ::YAML::load File.open(config_file_path)
-		end
-  	
-		protected
-
-		def mashie
-			@mashie ||= ::Hashie::Mash.new as_yaml
-		end
-
-    def config_file_path
-    	@config_file_path ||= File.join(Rails.root.to_s, 'config', file_path)
-    end
-	end
-
-	module Delegator				
-	  def method_missing(m, *args, &block)
-	  	raise "A #config method must be defined in the container for ConfigLoader::Delegator, for it to delegate to #config: delegation attempted with #{m}" unless self.respond_to?(:config)
-	    config.send(m)
-	  end
-	end
-end