rfacebook 0.9.0 → 0.9.1

data/README

@@ -1,117 +1,8 @@
-============================== FACEBOOK RAILS CONTROLLER EXTENSIONS NOTES ==============================
+============================== DOCUMENTATION ==============================
 
-Rails Applications:
-
-First, set up your Facebook Developer account properly.  By properly,
-I mean that you need to set your callback URL to be the root of your
-Rails application.  For example:
-
-	Callback URL >>> http://www.mycrazywebsite.com/     ***NOTE: trailing slash is necessary
-	Canvas Page URL >>> http://apps.facebook.com/mycrazywebsite
-	
-Then, whenever a user visits
-	
-	http://apps.facebook.com/mycrazywebsite/someRailsController/someAction
-
-...the Facebook API will call:
-	
-	http://www.mycrazywebsite.com/someRailsController/someAction
-
-
-You can get this behavior by installing the new RFacebook gem. After
-installing the gem, make your ApplicationController look like this:
-
- require "facebook_rails_controller_extensions"
-
- class ApplicationController < ActionController::Base
-
-   # additions to integrate Facebook into controllers
-   include RFacebook::RailsControllerExtensions
-
-   def facebook_api_key
-     return "YOUR API KEY HERE"
-   end
-
-   def facebook_api_secret
-     return "YOUR API SECRET HERE"
-   end
-
- end
-
-You will have access to 2 new items in your controllers:
-
-(1) "fbsession"
-Contains a FacebookWebSession.  Will return false for "is_valid?" if you haven't forced the user to log in.
-
-
-(2) "fbparams"
-Contains all the params that are prefixed with "fb_sig_".  You shouldn't ever *really* need this, but its there just in case.
-
-
-And, you have a few new filters to try out:
-
-(1) require_facebook_login
-(2) require_facebook_install
-
-For example, one of my Rails controllers looks like this:
-
- class FacebookController < ApplicationController
-   
-   before_filter :require_facebook_install # require users to install the application (less intrusive is to require_facebook_login)
-   
-   def index
-     xml = fbsession.users_getInfo(:uids => [fbsession.session_user_id], :fields => ["first_name", "last_name"])
-     @firstName = xml.at("first_name").inner_html
-     @lastName = xml.at("last_name").inner_html
-   end
-   
-   
- end
-
-
-
-============================== FACEBOOK PLATFORM NOTES ==============================
-
-
-============================== IMPORTANT NOTES ==============================
-
-
-** THIS IS ESPECIALLY IMPORTANT FOR PEOPLE WHO USED THE OLD CLIENT WHEN IT WAS CALLED "RBook" **
-
-[1] The RBook name was already taken, so now you need to change any "RBook" references to "RFacebook"
-
-[2] The desktop app login process is much simpler now:
-
-	fbsession = RFacebook::FacebookDesktopSession.new(APIKEY, APISECRET)
-	puts fbsession.get_login_url # tell the user to login at this url
-	# ...after the user logs in...
-	fbsession.activate
-
-[3] The "init_with_token" method is now "activate_with_token" (it is a little less confusing with this naming)
-
-[4] A helpful "NotActivatedException" will be raised if you forget to activate your session in one of the following ways:
-
-		Web: you must call either "activate_with_token" or "activate_with_previous_session"
-		Desktop: you must call either "activate" or "activate_with_previous_session"
-
-[5] Infinite sessions are now supported (web and desktop)...
-
-		Web:
-		
-			(a) Save the session key to a file or something
-				(i.e. "keyToSave = fbsession.session_key")
-				
-			(b) Normally, you would redirect the user to "get_login_url" and then call "activate_with_token" after the callback.
-				With an infinite session, skip these two steps and call "fbsession.activate_with_previous_session(keyToSave)" instead.
-		
-		Desktop:
-		
-			(a) Save the session key and session secret to a file or something
-				(i.e. "keyToSave = fbsession.session_key" and "secretToSave = fbsession.session_secret")
-			
-			(b) Normally, you would redirect the user to "get_login_url" and then call "activate".
-				With an infinite session, skip these two steps and call "fbsession.activate_with_previous_session(keyToSave, secretToSave)" instead.
+Please see the RFacebook homepage for usage information and other help.
 
+	http://rfacebook.rubyforge.org
 
 
 ============================== LICENSE ==============================

data/lib/facebook_web_session.rb

@@ -153,8 +153,8 @@ class FacebookWebSession < FacebookSession
     #   key    - the session key to use
     def activate_with_previous_session(key, uid=nil, expires=nil)
       
-      # TODO: what is a good way to handle expiration?
-      #       low priority since the API will give an error code for me...
+      # set the expiration
+      @session_expires = expires
       
       # set the session key
       @session_key = key

data/lib/facepricot.rb

@@ -81,6 +81,7 @@ module RFacebook
     
     def initialize(xml)
       @doc = Hpricot.XML(xml)
+      @raw_xml = xml
     end
     
     def method_missing(methodSymbol, *params)
@@ -99,6 +100,10 @@ module RFacebook
       return FacepricotChain.new(@doc.containers[0])
     end
     
+    def raw_xml
+      return @raw_xml
+    end
+    
     def to_s
       return @doc.containers[0].inner_html
     end
@@ -110,7 +115,6 @@ module RFacebook
     include FacepricotChaining
 
     def initialize(hpricotDoc)
-      # TODO: does this fix the Hpricot HTML entity escaping problem?
       super(hpricotDoc.inner_html.gsub("&", "&"))
       @doc = hpricotDoc
     end

data/lib/rfacebook_on_rails/controller_extensions.rb

@@ -29,7 +29,6 @@
 
 require "facebook_web_session"
 require "rfacebook_on_rails/status_manager"
-require "rfacebook_on_rails/templates/debug_panel"
 
 module RFacebook
   module Rails
@@ -46,51 +45,58 @@ module RFacebook
       # SECTION: Template Methods (must be implemented by concrete subclass)
     
       def facebook_api_key
-        raise APIKeyNeededStandardError
+        raise APIKeyNeededStandardError, "RFACEBOOK ERROR: when using the RFacebook on Rails plugin, please be sure that you have a facebook.yml file with 'key' defined"
       end
     
       def facebook_api_secret
-        raise APISecretNeededStandardError
+        raise APISecretNeededStandardError, "RFACEBOOK ERROR: when using the RFacebook on Rails plugin, please be sure that you have a facebook.yml file with 'secret' defined"
       end
       
       def facebook_canvas_path
-        raise APICanvasPathNeededStandardError
+        raise APICanvasPathNeededStandardError, "RFACEBOOK ERROR: when using the RFacebook on Rails plugin, please be sure that you have a facebook.yml file with 'canvas_path' defined"
       end
       
       def facebook_callback_path
-        raise APICallbackNeededStandardError
+        raise APICallbackNeededStandardError, "RFACEBOOK ERROR: when using the RFacebook on Rails plugin, please be sure that you have a facebook.yml file with 'callback_path' defined"
       end
     
       def finish_facebook_login
-        raise APIFinisherNeededStandardError
+        raise APIFinisherNeededStandardError, "RFACEBOOK ERROR: in an external Facebook application, you should define finish_facebook_login in your controller (often this is used to redirect to a 'login success' page, but it can also simply do nothing)"
       end
     
     
     
       # SECTION: Special Variables
     
+      # Function: fbparams
+      #   Accessor for all params beginning with "fb_sig_"
+      #
+      # Returns:
+      #   A Hash of those parameters, with the fb_sig_ stripped from the keys
       def fbparams
       
-        dup_params = (self.params || {}).dup
-      
         # try to get fbparams from the params hash
         if (!@fbparams || @fbparams.length <= 0)
+          dup_params = (self.params || {}).dup
           @fbparams = rfacebook_session_holder.get_fb_sig_params(dup_params)
         end
       
         # else, try to get fbparams from the cookies hash
-        # TODO: we don't write anything into the cookie, so this is kind of pointless right now
-        if (@fbparams.length <= 0)
-          @fbparams = rfacebook_session_holder.get_fb_sig_params(cookies)
+        if (!@fbparams || @fbparams.length <= 0)
+          dup_cookies = (self.cookies || {}).dup
+          @fbparams = rfacebook_session_holder.get_fb_sig_params(dup_cookies)
         end
-        
-        # TODO: fb_sig_params now includes all friend ids by default, so we can avoid an API call to friends.get
-        #       we should extend FacebookWebSession for Rails to make this optimization
-      
+              
         return @fbparams
       
       end
       
+      # Function: fbsession
+      #   Accessor for a FacebookWebSession that has been activated, either in the Canvas
+      #   (via fb_sig parameters) or in an external app (via an auth_token).
+      #
+      # Returns:
+      #   A FacebookWebSession.  You may want to check is_valid? before using it.
       def fbsession
         
         # if we are in the canvas, iframe, or mock ajax, we should be able to activate the session here
@@ -132,11 +138,11 @@ module RFacebook
       end
     
       def in_facebook_canvas?
-        return (params["fb_sig_in_canvas"] != nil)
+        return (params["fb_sig_in_canvas"] != nil)# and params["fb_sig_in_canvas"] == "1")
       end
         
       def in_facebook_frame?
-        return (params["fb_sig_in_iframe"] != nil or params["fb_sig_in_canvas"] != nil)
+        return (params["fb_sig_in_iframe"] != nil)# and params["fb_sig_in_iframe"] == "1")
       end
       
       def in_mock_ajax?
@@ -144,23 +150,38 @@ module RFacebook
       end
       
       def in_external_app?
+        # FIXME: once you click away in an iframe app, you are considered to be an external app
+        # TODO: read up on the RFacebook hacks for avoiding nested iframes
         return (!params[:fb_sig] and !in_facebook_frame?)
       end
       
+      def added_facebook_application?
+        return fbparams["added"].to_i == 1
+      end
+      
       # SECTION: before_filters
           
       def handle_facebook_login
-                
-        if (!in_facebook_canvas? and !rfacebook_session_holder.is_valid?)            
+                        
+        if !in_facebook_canvas?
             
           if params["auth_token"]
             
             # activate with the auth token
-            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: creating a new Facebook session from auth_token"
-            rfacebook_session_holder.activate_with_token(params["auth_token"])
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: attempting to create a new Facebook session from auth_token"
+            staleToken = false
+            begin
+              
+              # try to use the auth_token
+              rfacebook_session_holder.activate_with_token(params["auth_token"])
+              
+            rescue StandardError => e
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Tried to use a stale auth_token"
+              staleToken = true
+            end
               
             # template method call upon success
-            if rfacebook_session_holder.is_valid?
+            if (rfacebook_session_holder.is_valid? and !staleToken)
               RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Login was successful, calling finish_facebook_login"
               if in_external_app?
                 finish_facebook_login
@@ -178,15 +199,13 @@ module RFacebook
         
           # warning logs
           if !rfacebook_session_holder.is_valid?
-            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK WARNING: Facebook session could not be activated (from handle_facebook_login)"
-          elsif params["auth_token"]
-            # TODO: ignoring is proper when we have already used the auth_token (we could try to reauth and swallow the exception)
-            #         however, we probably want to re-auth if the new auth_token is valid (new user, old user probably logged out)
-            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: received a new auth_token, but we already have a valid session (ignored new auth_token)"
+            RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: Facebook session could not be activated (from handle_facebook_login)"
           end
             
         end
         
+        return true
+        
       end
     
       def require_facebook_login
@@ -214,45 +233,80 @@ module RFacebook
             elsif (!fbparams or fbparams.size == 0)
               
               RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK WARNING: Failed to activate due to a bad API key or API secret"
-              render_text facebook_debug_panel
+              render :text => facebook_debug_panel
               return false
               
             else
               
               RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Redirecting to login for canvas app"
-              render :text => "<fb:redirect url=\"#{sess.get_login_url(:canvas=>true)}\" />"
+              redirect_to sess.get_login_url(:canvas=>true)
               return false
               
             end
           end
         end
-      
+        
+        return true
       end
     
       def require_facebook_install
-        sess = fbsession
-        if (in_facebook_canvas? and (!sess.is_valid? or (fbparams["added"].to_i != 1)))
-          render :text => "<fb:redirect url=\"#{sess.get_install_url}\" />"
+        if (in_facebook_canvas? or in_facebook_frame?)
+          if (!fbsession.is_valid? or !added_facebook_application?)
+            redirect_to fbsession.get_install_url
+            return false
+          end
+        else
+          RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: require_facebook_install is not intended for external applications, using require_facebook_login instead"
+          return require_facebook_login
         end
+        return true
       end
       
       # SECTION: Facebook Debug Panel
       
       def render_with_facebook_debug_panel(options={})
-        # oldLayout = options[:layout]
-        # options[:layout] = false
         begin
           renderedOutput = render_to_string(options)
-        rescue # TODO: don't catch-all here, just the exceptions that we originate
-          renderedOutput = "Errors prevented this page from rendering properly."
+        rescue Exception => e
+          # TODO: make the backtrace rendering better (Evan Weaver's solution seems good, hopefully he'll allow usage of facebook_exceptions)
+          prettyBacktrace = e.backtrace.map do |line|
+            cleanLine = line.gsub(RAILS_ROOT, "").gsub("<", "&lt;").gsub(">", "&gt;")
+            pieces = cleanLine.split("\n")
+            if (pieces and pieces.size> 0)
+              cleanLine = "<ul>"              
+              pieces.each do |piece|
+                if matches = /.*[\/\\]+((.*)\:([0-9]+)\:\s*in\s*\`(.*)\')/.match(piece)
+                  oldPiece = piece
+                  filename = matches[2]
+                  line = matches[3]
+                  method = matches[4]
+                  piece = "<div class='summary'><strong>#{filename}</strong>:<em>#{line}</em> in <strong>#{method}</strong></div>"
+                  piece += "<div class='rawsummary'>#{oldPiece}</div>"
+                end
+                cleanLine += "<li>#{piece}</li>"
+              end
+              cleanLine += "</ul>"
+            end
+            "<tr><td>#{cleanLine}</td></tr>"
+          end
+          renderedOutput = "
+          <div class='RFacebook'>
+            <div class='backtrace'>
+              <table>
+                <tr><td>
+                  <h1>RFacebook <span style='font-weight: normal; color: #6D84B4'>exception backtrace</span></h1>
+                </td></tr>
+                #{prettyBacktrace}
+              </table>
+            </div>
+          </div>"
         end
-        # options[:text] = "#{facebook_debug_panel}#{renderedOutput}"
-        # options[:layout] = oldLayout
         render_text "#{facebook_debug_panel}#{renderedOutput}"
       end
       
       def facebook_debug_panel(options={})
-        return ERB.new(RFacebook::Rails::DEBUG_PANEL_ERB_TEMPLATE).result(Proc.new{}) # TODO: should use File.dirname(__FILE__) + 'templates/debug_panel.rhtml' instead
+        template = File.read(File.dirname(__FILE__) + "/templates/debug_panel.rhtml")
+        return ERB.new(template).result(Proc.new{})
       end
       
       def facebook_status_manager
@@ -287,12 +341,79 @@ module RFacebook
         if (!in_facebook_canvas? and rfacebook_session_holder.is_valid?)
           RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: persisting Facebook session information into Rails session"
           session[:rfacebook_session] = @rfacebook_session_holder.dup
-          session[:rfacebook_session].logger = nil # pstore can't serialize the Rails logger
+          session[:rfacebook_session].logger = nil # some session stores can't serialize the Rails logger
         end
       end
       
       
-      # SECTION: URL Management 
+      # SECTION: URL Management
+      
+      def url_for__RFACEBOOK(options={}, *parameters)
+        
+        # error check
+        if !options
+          RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: options cannot be nil in call to url_for"
+        end
+        
+        # use special URL rewriting when inside the canvas
+        # setting the mock_ajax option to true will override this
+        # and force usage of regular Rails rewriting
+        if (in_facebook_canvas? and !options[:mock_ajax]) #TODO: do something separate for in_facebook_frame?
+          
+          if options.is_a? Hash
+            options[:only_path] = true
+          end
+          
+          # try to get a regular URL
+          path = url_for__ALIASED(options, *parameters)
+                          
+          # replace anything that references the callback with the
+          # Facebook canvas equivalent (apps.facebook.com/*)
+          if (path.starts_with?(self.facebook_callback_path) or "#{path}/".starts_with?(self.facebook_callback_path))
+            path.sub!(self.facebook_callback_path, self.facebook_canvas_path)
+            path = "http://apps.facebook.com#{path}"
+          elsif (path.starts_with?("http://www.facebook.com") or path.starts_with?("https://www.facebook.com"))
+            # be sure that URLs that go to some other Facebook service redirect back to the canvas
+            if path.include?("?")
+              path = "#{path}&canvas=true"
+            else
+              path = "#{path}?canvas=true"
+            end
+          elsif (!path.starts_with?("http://") and !path.starts_with?("https://"))
+            # default to a full URL (will link externally)
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to get canvas-friendly URL ("+path+") for ["+options.inspect+"], creating an external URL instead"
+            path = "#{request.protocol}#{request.host}:#{request.port}#{path}"
+          end
+        
+        # mock-ajax rewriting
+        elsif options[:mock_ajax]
+          options.delete(:mock_ajax) # clear it so it doesnt show up in the url
+          options[:only_path] = true
+          path = "#{request.protocol}#{request.host}:#{request.port}#{url_for__ALIASED(options, *parameters)}"
+        
+        # regular Rails rewriting
+        else
+          path = url_for__ALIASED(options, *parameters)
+        end
+
+        return path
+      end
+      
+      def redirect_to__RFACEBOOK(options = {}, *parameters)
+        if in_facebook_canvas?
+          
+          canvasRedirUrl = url_for(options, *parameters)          
+          RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Canvas redirect to #{canvasRedirUrl}"
+          render :text => "<fb:redirect url=\"#{canvasRedirUrl}\" />"
+          
+        else
+          RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Regular redirect_to"
+          redirect_to__ALIASED(options, *parameters)
+        end
+      end
+   
+      
+      # SECTION: Extension Helpers
       
       CLASSES_EXTENDED = []
             
@@ -301,7 +422,7 @@ module RFacebook
         # check for a double include
         doubleInclude = false
         CLASSES_EXTENDED.each do |klass|
-          if base.allocate.is_a?(klass) # TODO: is there a more direct way than allocating an instance and checking is_a?
+          if base.allocate.is_a?(klass)
             doubleInclude = true
           end
         end
@@ -310,83 +431,21 @@ module RFacebook
           RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: detected double-include of RFacebook controller extensions.  Please see instructions for RFacebook on Rails plugin usage (http://rfacebook.rubyforge.org).  You may be including the deprecated RFacebook::RailsControllerExtensions in addition to the plugin."
           
         else
+          
+          # keep track that we have already extended this class
           CLASSES_EXTENDED << base
           
           # we need to use an eval since we will be overriding ActionController::Base methods
           # and we need to be able to call the originals
           base.class_eval '
-      
             alias_method(:url_for__ALIASED, :url_for)
-      
-            def url_for(options={}, *parameters)
-              
-              # error check
-              if !options
-                RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: options cannot be nil in call to url_for"
-              end
-              
-              # use special URL rewriting when inside the canvas
-              # setting the mock_ajax option to true will override this
-              # and force usage of regular Rails rewriting
-              if (in_facebook_canvas? and !options[:mock_ajax]) #TODO: or in_facebook_frame?
-                
-                if options.is_a? Hash
-                  options[:only_path] = true
-                end
-                
-                # try to get a regular URL
-                path = url_for__ALIASED(options, *parameters)
-                                
-                # replace anything that references the callback with the
-                # Facebook canvas equivalent (apps.facebook.com/*)
-                if (path.starts_with?(self.facebook_callback_path) or "#{path}/".starts_with?(self.facebook_callback_path))
-                  path.sub!(self.facebook_callback_path, self.facebook_canvas_path)
-                  path = "http://apps.facebook.com#{path}"
-                else
-                  # default to a full URL (will link externally)
-                  RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to get canvas-friendly URL ("+path+") for ["+options.inspect+"], creating an external URL instead"
-                  path = "#{request.protocol}#{request.host}:#{request.port}#{path}"
-                end
-              
-              # mock-ajax rewriting
-              elsif options[:mock_ajax]
-                options.delete(:mock_ajax) # clear it so it doesnt show up in the url
-                options[:only_path] = true
-                path = "#{request.protocol}#{request.host}:#{request.port}#{url_for__ALIASED(options, *parameters)}"
-              
-              # regular Rails rewriting
-              else
-                path = url_for__ALIASED(options, *parameters)
-              end
-  
-              return path
-            end
-      
+            alias_method(:url_for, :url_for__RFACEBOOK)      
           
             alias_method(:redirect_to__ALIASED, :redirect_to)
-          
-            def redirect_to(options = {}, *parameters)
-              if in_facebook_canvas?
-                
-                canvasRedirUrl = url_for(options, *parameters)
-                
-                # ensure that we come back to the canvas if we redirect
-                # to somewhere else on Facebook
-                if canvasRedirUrl.starts_with?("http://www.facebook.com")
-                  canvasRedirUrl = "#{canvasRedirUrl}&canvas"
-                end
-                
-                RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Canvas redirect to #{canvasRedirUrl}"
-                render :text => "<fb:redirect url=\"#{canvasRedirUrl}\" />"
-                
-              else
-                RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Regular redirect_to"
-                redirect_to__ALIASED(options, *parameters)
-              end
-            end
+            alias_method(:redirect_to, :redirect_to__RFACEBOOK)
           '
           
-          # ensure that we persist the Facebook session in the Rails session (if possible)
+          # ensure that we persist the Facebook session into the Rails session (if possible)
           base.after_filter(:rfacebook_persist_session_to_rails)
           
           # fix third party cookies in IE

data/lib/rfacebook_on_rails/plugin/init.rb

@@ -32,49 +32,84 @@ require "rfacebook_on_rails/controller_extensions"
 require "rfacebook_on_rails/model_extensions"
 require "rfacebook_on_rails/session_extensions"
 
-module RFacebook
-  module Rails
-    module Plugin
-      #####
-      module ControllerExtensions
-        def facebook_api_key
-          FACEBOOK["key"] || super
-        end
-        def facebook_api_secret
-          FACEBOOK["secret"] || super
-        end
-        def facebook_canvas_path
-          FACEBOOK["canvas_path"] || super
-        end
-        def facebook_callback_path
-          FACEBOOK["callback_path"] || super
-        end
-      end  
-      #####
-      module ModelExtensions
-        def facebook_api_key
-          FACEBOOK["key"] || super
-        end
-        def facebook_api_secret
-          FACEBOOK["secret"] || super
-        end
-      end
-      #####
-      module ViewExtensions
-      end
+module RFacebook::Rails::Plugin
+  
+  module ControllerExtensions
+    def facebook_api_key
+      FACEBOOK["key"] || super
+    end
+    def facebook_api_secret
+      FACEBOOK["secret"] || super
+    end
+    def facebook_canvas_path
+      FACEBOOK["canvas_path"] || super
+    end
+    def facebook_callback_path
+      FACEBOOK["callback_path"] || super
+    end
+  end  
+
+  module ModelExtensions
+    def facebook_api_key
+      FACEBOOK["key"] || super
+    end
+    def facebook_api_secret
+      FACEBOOK["secret"] || super
     end
   end
+
+  module ViewExtensions
+  end
+  
+end
+
+# inject methods to Rails MVC classes
+ActionView::Base.send(:include, RFacebook::Rails::ViewExtensions)
+ActionView::Base.send(:include, RFacebook::Rails::Plugin::ViewExtensions)
+
+ActionController::Base.send(:include, RFacebook::Rails::ControllerExtensions)
+ActionController::Base.send(:include, RFacebook::Rails::Plugin::ControllerExtensions)
+
+ActiveRecord::Base.send(:include, RFacebook::Rails::ModelExtensions)
+ActiveRecord::Base.send(:include, RFacebook::Rails::Plugin::ModelExtensions)
+
+# inject methods to Rails session management classes
+CGI::Session.send(:include, RFacebook::Rails::SessionExtensions)
+
+# TODO: document SessionStoreExtensions as API so that anyone can patch their own custom session container in addition to these
+CGI::Session::PStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+CGI::Session::ActiveRecordStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+CGI::Session::DRbStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+CGI::Session::FileStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+CGI::Session::MemoryStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+begin
+  CGI::Session::MemCacheStore.send(:include, RFacebook::Rails::SessionStoreExtensions)
+rescue
+  RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: It looks like you don't have memcache-client, so MemCacheStore was not extended"
 end
 
-# load Facebook configuration file
+# load Facebook configuration file (credit: Evan Weaver)
 begin
   FACEBOOK = YAML.load_file("#{RAILS_ROOT}/config/facebook.yml")[RAILS_ENV]
 rescue
   FACEBOOK = {}
 end
 
+# parse for full URLs in facebook.yml (multiple people have made this mistake)
+def ensureRelativePath(path)
+  if matchData = /(\w+)(\:\/\/)([\w0-9\.]+)([\:0-9]*)(.*)/.match(path)
+    relativePath = matchData.captures[4]
+    RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: It looks like you used a full URL (#{path}) in facebook.yml.  RFacebook expected a relative path and has automatically converted this URL to #{relativePath}."
+    return relativePath
+  else
+    return path
+  end
+end
+
+FACEBOOK["canvas_path"] = ensureRelativePath(FACEBOOK["canvas_path"])
+FACEBOOK["callback_path"] = ensureRelativePath(FACEBOOK["callback_path"])
+
 # make sure the paths have leading and trailing slashes
-# TODO: also parse for full URLs beginning with HTTP (see: http://rubyforge.org/tracker/index.php?func=detail&aid=13096&group_id=3607&atid=13796)
 def ensureLeadingAndTrailingSlashesForPath(path)
   if (path and path.size>0)
     if !path.starts_with?("/")
@@ -90,38 +125,4 @@ def ensureLeadingAndTrailingSlashesForPath(path)
 end
 
 FACEBOOK["canvas_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["canvas_path"])
-FACEBOOK["callback_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["callback_path"])
-
-# inject methods to Rails MVC classes
-ActionView::Base.send(:include, RFacebook::Rails::ViewExtensions)
-ActionView::Base.send(:include, RFacebook::Rails::Plugin::ViewExtensions)
-
-ActionController::Base.send(:include, RFacebook::Rails::ControllerExtensions)
-ActionController::Base.send(:include, RFacebook::Rails::Plugin::ControllerExtensions)
-
-ActiveRecord::Base.send(:include, RFacebook::Rails::ModelExtensions)
-ActiveRecord::Base.send(:include, RFacebook::Rails::Plugin::ModelExtensions)
-
-# inject methods to patch Rails session containers
-# TODO: document this as API so that everyone knows how to patch their own custom session container
-module RFacebook::Rails::Toolbox
-  def self.patch_session_store_class(sessionStoreKlass)
-    sessionStoreKlass.send(:include, RFacebook::Rails::SessionStoreExtensions)
-    sessionStoreKlass.class_eval'
-      alias :initialize__ALIASED :initialize
-      alias :initialize :initialize__RFACEBOOK
-    '
-  end
-end
-
-# patch as many session stores as possible
-RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::PStore)
-RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::ActiveRecordStore)
-RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::DRbStore)
-RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::FileStore)
-RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::MemoryStore)
-begin
-  RFacebook::Rails::Toolbox::patch_session_store_class(CGI::Session::MemCacheStore)
-rescue
-  # TODO: this needs to be handled better
-end
+FACEBOOK["callback_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["callback_path"])

data/lib/rfacebook_on_rails/plugin/rake.rb

@@ -101,17 +101,7 @@ production:
       
       puts "======================================================"
       puts "Tunneling #{remoteHost}:#{remotePort} to 0.0.0.0:#{localPort}"
-      
-      # TODO: learn more about autossh
-      # if system("autossh -V")
-      #   cmd = "autossh -M 8888"
-      #   puts "(autossh found, using port 8888 to monitor it)"
-      # else
-      #   cmd = "ssh"
-      #   puts "(autossh not found, using ssh instead)"
-      # end
-      cmd = "ssh"
-      
+            
       puts
       puts "NOTES:"
       puts "* ensure that you have Rails running on your local machine at port #{localPort}"
@@ -119,19 +109,17 @@ production:
       puts "* use ctrl-c to quit the tunnel"
       puts "* if you have problems creating the tunnel, you may need to add the following to /etc/ssh/sshd_config on your server:"
       puts "
-
 GatewayPorts clientspecified
 
 "
       puts "* if you have problems with #{remoteHost} timing out your ssh connection, add the following lines to your '~/.ssh/config' file:"
       puts "
-
 Host #{remoteHost}
   ServerAliveInterval 120
 
 "
       puts "======================================================"
-      exec "#{cmd} -nNT -g -R *:#{remotePort}:0.0.0.0:#{localPort} #{remoteUsername}@#{remoteHost}"
+      exec "ssh -nNT -g -R *:#{remotePort}:0.0.0.0:#{localPort} #{remoteUsername}@#{remoteHost}"
       
       
     end

data/lib/rfacebook_on_rails/session_extensions.rb

@@ -30,21 +30,20 @@
 require "digest/md5"
 require "cgi"
 
-# patch up the CGI session module to use Facebook session keys when cookies aren't available
-class CGI::Session
-
-  alias :initialize__ALIASED :initialize
-  alias :new_session__ALIASED :new_session
-  
-  def using_facebook_session_id?
-    return @using_fb_session_id
-  end
+module RFacebook::Rails::SessionExtensions
   
+  # SECTION: New Methods
   def force_to_be_new!
     @force_to_be_new = true
   end
   
-  def new_session
+  def using_facebook_session_id?
+    return (@fb_sig_session_id != nil)
+  end
+    
+  # SECTION: Base Overrides
+  
+  def new_session__RFACEBOOK
     if @force_to_be_new
       return true
     else
@@ -52,50 +51,152 @@ class CGI::Session
     end
   end
 
-  def initialize(request, options = {})
+  def initialize__RFACEBOOK(request, options = {})
     
-    # check the environment to find a Facebook sig_session_key (credit: Blake Carlson and David Troy)
-    fbsessionId = nil
-    ["RAW_POST_DATA", "QUERY_STRING", "HTTP_REFERER"].each do |tableSource|
-      if request.env_table[tableSource]
-        fbsessionId = CGI::parse(request.env_table[tableSource]).fetch('fb_sig_session_key'){[]}.first
-        RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: checked #{tableSource} for Facebook session id and got [#{fbsessionId}]"
+    # only try to use the sig when we don't have a cookie (i.e., in the canvas)
+    if in_facebook_canvas?(request)
+      
+      # try a few different ways
+      RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Attempting to use fb_sig_session_key as a session key, since we are inside the canvas"
+      @fb_sig_session_id = lookup_request_parameter(request, "fb_sig_session_key")
+      
+      # we only want to change the session_id if we got one from the fb_sig
+      if @fb_sig_session_id
+        options["session_id"] = Digest::MD5.hexdigest(@fb_sig_session_id)
+        RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: using MD5 of fb_sig_session_key [#{options['session_id']}] for the Rails session id"
       end
-      break if fbsessionId
-    end
-
-    # we only want to change the session_id if we got one from the fb_sig
-    if fbsessionId
-      options['session_id'] = Digest::MD5.hexdigest(fbsessionId)
-      @using_facebook_session_id = true
-      RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: using MD5 of Facebook session id [#{options['session_id']}] for the Rails session id}"
     end
     
     # now call the default Rails session initialization
     initialize__ALIASED(request, options)
   end
+  
+  # SECTION: Extension Helpers
+  
+  def self.included(base)
+    base.class_eval'
+      alias :initialize__ALIASED :initialize
+      alias :initialize :initialize__RFACEBOOK
+      
+      alias :new_session__ALIASED :new_session
+      alias :new_session :new_session__RFACEBOOK
+    '
+  end
+  
+  # SECTION: Private Helpers
+  
+  private
+  
+  # TODO: it seems that there should be a better way to just get raw parameters
+  #       (not sure why the nil key bug doesn't seem to be fixed in my installation)
+  #       ...also, there seems to be some interaction with Mongrel as well that can
+  #       cause the parameters to fail
+  def lookup_request_parameter(request, key)
+    
+    # Depending on the user's version of Rails, this may fail due to a bug in Rails parsing of
+    # nil keys: http://dev.rubyonrails.org/ticket/5137, so we have a backup plan
+    begin
+      
+      # this should work on most Rails installations
+      return request.parameters[key]
+      
+    rescue
+      
+      # this saves most other Rails installations
+      begin
+        
+        retval = nil
+        
+        # try accessing raw_post (doesn't work in some mongrel installations)
+        if request.respond_to?(:raw_post)
+          return CGI::parse(request.send(:raw_post)).fetch(key){[]}.first
+        end
+        
+        # try accessing the raw environment table
+        if !retval
+          envTable = nil
+      
+          envTable = request.send(:env_table) if request.respond_to?(:env_table)
+          if !envTable
+            envTable = request.send(:env) if request.respond_to?(:env)
+          end
+      
+          if envTable
+            # credit: Blake Carlson and David Troy
+            ["RAW_POST_DATA", "QUERY_STRING"].each do |tableSource|
+              if envTable[tableSource]
+                retval = CGI::parse(envTable[tableSource]).fetch(key){[]}.first
+              end
+              break if retval
+            end
+          end
+        end
+        
+        # hopefully we got a parameter
+        return retval
+        
+      rescue
+        
+        # for some reason, we just can't get the parameters
+        RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: failed to access request.parameters"
+        return nil
+
+      end
+    end
+  end
+  
+  def in_facebook_canvas?(request)
+    # TODO: we should probably be checking the fb_sig for validity here (template method needed)
+    #       ...we can only do this if we can grab the equivalent of a params hash
+    return lookup_request_parameter(request, "fb_sig_in_canvas")
+  end
+    
 end
 
 # Module: SessionStoreExtensions
 #
-#   Special initialize method that forces any session store to use the Facebook session
+#   Special initialize method that attempts to force any session store to use the Facebook session
 module RFacebook::Rails::SessionStoreExtensions
+  
+  # SECTION: Base Overrides
+  
   def initialize__RFACEBOOK(session, options, *extraParams)
-    begin
-      RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: inside #{self.class.to_s}, with session_id: #{session.session_id}, new_session = #{session.new_session ? 'yes' : 'no'}"
-      initialize__ALIASED(session, options, *extraParams)
-    rescue Exception => e 
+    
+    if session.using_facebook_session_id?
+      
+      # we got the fb_sig_session_key, so alter Rails' behavior to use that key to make a session
       begin
-        RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to init #{self.class.to_s} session, trying to make a new session"
-        # FIXME: technically this might be a security problem, since an external browser can grab any unused session id they want
-        if session.session_id
-          session.force_to_be_new!
-        end
+        RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: using fb_sig_session_key for the #{self.class.to_s} session (session_id=#{session.session_id})"
         initialize__ALIASED(session, options, *extraParams)
-      rescue Exception => e
-        RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to create a new #{self.class.to_s} session falling back to default Rails behavior"
-        raise e
+      rescue Exception => e 
+        begin
+          RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to initialize session (session_id=#{session.session_id}), trying to force a new session"
+          if session.session_id
+            session.force_to_be_new!
+          end
+          initialize__ALIASED(session, options, *extraParams)
+        rescue Exception => e
+          RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to force a new session, falling back to default Rails behavior"
+          raise e
+        end
       end
+      
+    else
+      
+      # we didn't get the fb_sig_session_key, do not alter Rails' behavior
+      RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: using default Rails sessions (since we didn't find an fb_sig_session_key in the environment)"
+      initialize__ALIASED(session, options, *extraParams)
+      
     end
   end
+  
+  # SECTION: Extension Helpers
+  
+  def self.included(base)
+    base.class_eval'
+      alias :initialize__ALIASED :initialize
+      alias :initialize :initialize__RFACEBOOK
+    '
+  end
+  
 end

data/lib/rfacebook_on_rails/templates/{debug_panel.rb → debug_panel.rhtml}

@@ -1,36 +1,3 @@
-# Copyright (c) 2007, Matt Pizzimenti (www.livelearncode.com)
-# All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-# 
-# Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-# 
-# Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-# 
-# Neither the name of the original author nor the names of contributors
-# may be used to endorse or promote products derived from this software
-# without specific prior written permission.
-# 
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-
-module RFacebook
-  module Rails
-    DEBUG_PANEL_ERB_TEMPLATE = <<-end_info
-                
 <style type="text/css">
 
 .RFacebook .environment
@@ -136,6 +103,66 @@ module RFacebook
 		color: black;
 	}
 
+.RFacebook .backtrace
+	{
+		border-collapse: collapse;
+		background-color: #3B5998;
+		color: white;
+	}
+
+.RFacebook .backtrace
+	{
+		padding: 30px;
+		background: #3B5998;
+	}
+
+.RFacebook .backtrace h1
+	{
+		margin: 0px 0px 5px 0px;
+		padding: 0px;
+    
+		color: white;
+		font-size: 1.6em;
+	}
+
+/*
+.RFacebook table.backtrace td
+	{
+		padding: 10px 2px 10px 2px;
+		border-width: 1px 0px 1px 0px;
+		
+		border-style: solid;
+		border-color: #ccc;
+	}
+*/
+
+.RFacebook .backtrace div.summary
+	{
+		font-size: 1.2em;
+		padding: 2px;
+		color: white;
+	}
+	
+.RFacebook .backtrace div.rawsummary
+	{
+		font-size: 0.7em;
+		color: #6D84B4;
+		padding-left: 5px;
+	}
+
+.RFacebook ul
+	{
+		margin: 0px;
+		padding: 0px;
+		list-style-type: none;
+	}
+
+.RFacebook ul li
+	{
+		list-style-type: none;
+		padding: 5px;
+	}
+
 </style>
 
 <div class="RFacebook">
@@ -170,9 +197,9 @@ module RFacebook
 						<% end %>
 					</td>
 					<td class="value">
-						<% if statusCheck.message.class == String %>
+						<% if statusCheck.message.is_a? String %>
 							<%= statusCheck.message %>
-						<% elsif statusCheck.message.class == Hash %>
+						<% elsif statusCheck.message.is_a? Hash %>
 							<table class="details">
 								<% statusCheck.message.each do |k,v| %>
 									<tr>
@@ -191,20 +218,3 @@ module RFacebook
   
 	</div>
 </div>        
-
-
-
-
-
-
-
-
-
-
-
-
-
-end_info
-
-  end
-end

data/lib/rfacebook_on_rails/view_extensions.rb

@@ -53,14 +53,14 @@ module RFacebook
       
       def image_path(*params)
         path = super(*params)
-        if (in_facebook_canvas? or in_mock_ajax?) # TODO: or in_facebook_frame?)
+        if (in_facebook_canvas? or in_mock_ajax?)
           path = "#{request.protocol}#{request.host_with_port}#{path}"
         end
         return path
       end
 
-      def rfacebook_debug_panel(options={})
-        return @controller.rfacebook_debug_panel(options)
+      def facebook_debug_panel(options={})
+        return @controller.facebook_debug_panel(options)
       end
       
     end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: rfacebook
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
-date: 2007-08-18 00:00:00 -05:00
+  version: 0.9.1
+date: 2007-08-20 00:00:00 -04:00
 summary: A Ruby interface to the Facebook API v1.0+ (F8 and beyond).  Works with RFacebook on Rails plugin (see rfacebook.rubyforge.org).
 require_paths: 
 - lib
@@ -47,7 +47,7 @@ files:
 - lib/rfacebook_on_rails/plugin/rake.rb
 - lib/rfacebook_on_rails/plugin/Rakefile.rb
 - lib/rfacebook_on_rails/plugin/uninstall.rb
-- lib/rfacebook_on_rails/templates/debug_panel.rb
+- lib/rfacebook_on_rails/templates/debug_panel.rhtml
 - README
 test_files: []