rfacebook 0.8.5 → 0.8.6

data/lib/facebook_rails_controller_extensions.rb

@@ -3,6 +3,7 @@ require "rfacebook_on_rails/controller_extensions"
 module RFacebook
   module RailsControllerExtensions
     def self.included(base)
+      RAILS_DEFAULT_LOGGER.info "** RFACEBOOK DEPRECATION NOTICE: direct use of RFacebook::RailsControllerExtensions (from facebook_rails_controller_extensions.rb) is deprecated, use the RFacebook on Rails plugin instead (http://rfacebook.rubyforge.org)"
       base.send(:include, RFacebook::Rails::ControllerExtensions)
     end
   end

data/lib/facebook_session.rb

@@ -166,7 +166,7 @@ class FacebookSession
   
   def cached_call_method(method,params)
     key = cache_key_for(method,params)
-    @logger.debug "** RFacebook::FacebookSession\#cached_call_method - #{method}(#{params.inspect}) - attempting to hit cache" if @logger
+    @logger.debug "** RFACEBOOK(GEM) - RFacebook::FacebookSession\#cached_call_method - #{method}(#{params.inspect}) - attempting to hit cache" if @logger
     return @callcache[key] ||= call_method(method,params)
   end
   
@@ -191,7 +191,7 @@ class FacebookSession
   #   use_ssl             - set to true if the call will be made over SSL
   def call_method(method, params={}, use_ssl=false)
 
-    @logger.debug "** RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - making remote call" if @logger
+    @logger.debug "** RFACEBOOK(GEM) - RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - making remote call" if @logger
 
     # ensure that this object has been activated somehow
     if (!method.include?("auth") and !is_activated?)
@@ -225,13 +225,13 @@ class FacebookSession
     
     # do the request
     xmlstring = post_request(@api_server_base_url, @api_server_path, method, params, use_ssl)
-    # @logger.debug "** RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - raw XML response: #{xmlstring}" if @logger
+    # @logger.debug "** RFACEBOOK(GEM) - RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - raw XML response: #{xmlstring}" if @logger
     xml = Facepricot.new(xmlstring)
 
     # error checking    
     if xml.at("error_response")
       
-      @logger.debug "** RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - remote call failed" if @logger
+      @logger.debug "** RFACEBOOK(GEM) - RFacebook::FacebookSession\#call_method - #{method}(#{params.inspect}) - remote call failed" if @logger
       
       @last_call_was_successful = false
       code = xml.at("error_code").inner_html

data/lib/rfacebook_on_rails/controller_extensions.rb

@@ -67,7 +67,7 @@ module RFacebook
     
     
     
-      # SECTION: Required Methods
+      # SECTION: Special Variables
     
       def fbparams
       
@@ -75,13 +75,13 @@ module RFacebook
       
         # try to get fbparams from the params hash
         if (!@fbparams || @fbparams.length <= 0)
-          @fbparams = fbsession.get_fb_sig_params(dup_params)
+          @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 = fbsession.get_fb_sig_params(cookies)
+          @fbparams = rfacebook_session_holder.get_fb_sig_params(cookies)
         end
         
         # TODO: fb_sig_params now includes all friend ids by default, so we can avoid an API call to friends.get
@@ -90,38 +90,30 @@ module RFacebook
         return @fbparams
       
       end
-
-      def fbsession
       
-        if !@fbsession
-        
-          # create a session no matter what
-          @fbsession = FacebookWebSession.new(facebook_api_key, facebook_api_secret)
+      def fbsession
         
+        # if we are in the canvas or iframe, we should be able to activate the session here
+        if (!rfacebook_session_holder.is_valid? and (in_facebook_canvas? or in_facebook_frame?))
+                  
           # then try to activate it somehow (or retrieve from previous state)
           # these might be nil
           facebookUid = fbparams["user"]
           facebookSessionKey = fbparams["session_key"]
           expirationTime = fbparams["expires"]
-        
+      
           if (facebookUid and facebookSessionKey and expirationTime)
-            # Method 1: we have the user id and key from the fb_sig_ params
-            @fbsession.activate_with_previous_session(facebookSessionKey, facebookUid, expirationTime)
-            RAILS_DEFAULT_LOGGER.debug "** rfacebook: Activated session from inside the canvas"
-          
-          elsif (!in_facebook_canvas? and session[:rfacebook_fbsession])
-            # Method 2: we've logged in the user already
-            @fbsession = session[:rfacebook_fbsession]
-          
-          end  
-        
+            # we have the user id and key from the fb_sig_ params, activate the session
+            rfacebook_session_holder.activate_with_previous_session(facebookSessionKey, facebookUid, expirationTime)
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Activated session from inside the canvas"
+          else
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK WARNING: Tried to activate session from inside the canvas, but failed"
+          end
+                      
         end
         
-        if @fbsession
-          @fbsession.logger = RAILS_DEFAULT_LOGGER
-        end
-      
-        return @fbsession
+        # if all went well, we should definitely have a valid Facebook session object
+        return rfacebook_session_holder
       
       end
     
@@ -129,7 +121,7 @@ module RFacebook
     
       # DEPRECATED
       def facebook_redirect_to(url)
-        RAILS_DEFAULT_LOGGER.info "DEPRECATION NOTICE: facebook_redirect_to is deprecated in RFacebook. Instead, you can use redirect_to like any Rails app."
+        RAILS_DEFAULT_LOGGER.info "** RFACEBOOK DEPRECATION NOTICE: facebook_redirect_to is deprecated in RFacebook. Instead, you can use redirect_to like any Rails app."
         if in_facebook_canvas?
           render :text => "<fb:redirect url=\"#{url}\" />"     
         elsif url =~ /^https?:\/\/([^\/]*\.)?facebook\.com(:\d+)?/i
@@ -144,31 +136,50 @@ module RFacebook
       end
         
       def in_facebook_frame?
-        return (params["fb_sig_in_iframe"] != nil || params["fb_sig_in_canvas"] != nil)
+        return (params["fb_sig_in_iframe"] != nil or params["fb_sig_in_canvas"] != nil)
       end
       
       def in_external_app?
         return (!params[:fb_sig] and !in_facebook_frame?)
       end
+      
+      # SECTION: before_filters
           
       def handle_facebook_login
-        
-        if (params["auth_token"] and !in_facebook_canvas?)
-        
-          # create a session
-          session[:rfacebook_fbsession] = FacebookWebSession.new(facebook_api_key, facebook_api_secret)
-          session[:rfacebook_fbsession].activate_with_token(params["auth_token"])
-        
-          # template method call upon success
-          if session[:rfacebook_fbsession].is_valid?
-            RAILS_DEFAULT_LOGGER.debug "** rfacebook: Login was successful, calling finish_facebook_login"
-            finish_facebook_login
+                
+        if (!in_facebook_canvas? and !rfacebook_session_holder.is_valid?)            
+            
+          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"])
+              
+            # template method call upon success
+            if rfacebook_session_holder.is_valid?
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Login was successful, calling finish_facebook_login"
+              if in_external_app?
+                finish_facebook_login
+              end
+            end
+            
+          elsif (session[:rfacebook_session] and session[:rfacebook_session].is_valid?)
+            
+            # grab saved Facebook session from Rails session
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: grabbing Facebook session from Rails session"
+            @rfacebook_session_holder = session[:rfacebook_session]
+          
           end
         
-        else
-          RAILS_DEFAULT_LOGGER.debug "** rfacebook: Didn't activate session from handle_facebook_login"
+          # 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"]
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: received a new auth_token, but we already have a valid session (ignored new auth_token)"
+          end
+            
         end
-      
+        
       end
     
       def require_facebook_login
@@ -176,30 +187,35 @@ module RFacebook
         # handle a facebook login if given (external sites and iframe only)
         handle_facebook_login
       
+        # now finish it off depending on whether we are in canvas, iframe, or external app
         if !performed?
-        
-          RAILS_DEFAULT_LOGGER.debug "** rfacebook: Rendering has not been performed"
-        
+                
           # try to get the session
           sess = fbsession
       
           # handle invalid sessions by forcing the user to log in      
           if !sess.is_valid?
           
-            RAILS_DEFAULT_LOGGER.debug "** rfacebook: Session is not valid"
+            RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Session is not valid"
           
             if in_external_app?
-              RAILS_DEFAULT_LOGGER.debug "** rfacebook: Redirecting to login"
+              
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Redirecting to login for external app"
               redirect_to sess.get_login_url
               return false
+              
             elsif (!fbparams or fbparams.size == 0)
-              RAILS_DEFAULT_LOGGER.debug "** rfacebook: Failed to activate due to a bad API key or API secret"
+              
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK WARNING: Failed to activate due to a bad API key or API secret"
               render_text facebook_debug_panel
               return false
+              
             else
-              RAILS_DEFAULT_LOGGER.debug "** rfacebook: Rendering canvas redirect"
+              
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Redirecting to login for canvas app"
               render :text => "<fb:redirect url=\"#{sess.get_login_url(:canvas=>true)}\" />"
               return false
+              
             end
           end
         end
@@ -212,52 +228,8 @@ module RFacebook
           render :text => "<fb:redirect url=\"#{sess.get_install_url}\" />"
         end
       end
-            
-      def self.included(base)
-
-        # FIXME: figure out why this is necessary...for some reason, we
-        #        can't just define url_for in the module itself (it never gets called)
-        base.class_eval '
       
-          alias_method(:url_for__ALIASED, :url_for)
-      
-          def url_for(options={}, *parameters)
-            if !options
-              RAILS_DEFAULT_LOGGER.info "** options cannot be nil in call to url_for"
-            end
-            if in_facebook_canvas? #TODO: or in_facebook_frame?)
-              if options.is_a? Hash
-                options[:only_path] = true
-              end
-              path = url_for__ALIASED(options, *parameters)
-              if path.starts_with?(self.facebook_callback_path)
-                path.gsub!(self.facebook_callback_path, self.facebook_canvas_path)
-                if !options.has_key?(:only_path)
-                  path = "http://apps.facebook.com#{path}"
-                end
-              end
-            else
-              path = url_for__ALIASED(options, *parameters)
-            end
-  
-            return path
-          end
-      
-          
-          alias_method(:redirect_to__ALIASED, :redirect_to)
-          
-          def redirect_to(options = {}, *parameters)
-            if in_facebook_canvas?
-              RAILS_DEFAULT_LOGGER.debug "** Canvas redirect to #{url_for(options)}"
-              render :text => "<fb:redirect url=\"#{url_for(options)}\" />"     
-            else
-              RAILS_DEFAULT_LOGGER.debug "** Regular redirect_to"
-              redirect_to__ALIASED(options, *parameters)
-            end
-          end
-        
-        '
-      end
+      # SECTION: Facebook Debug Panel
       
       def render_with_facebook_debug_panel(options={})
         # oldLayout = options[:layout]
@@ -290,6 +262,100 @@ module RFacebook
           ].compact
         return StatusManager.new(checks)
       end
+      
+      # SECTION: Private Methods
+      
+      def rfacebook_session_holder
+        
+        if (@rfacebook_session_holder == nil)
+          @rfacebook_session_holder = FacebookWebSession.new(facebook_api_key, facebook_api_secret)
+          @rfacebook_session_holder.logger = RAILS_DEFAULT_LOGGER
+        end
+        
+        return @rfacebook_session_holder
+        
+      end
+            
+      def rfacebook_persist_session_to_rails
+        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
+        end
+      end
+      
+      
+      # SECTION: URL Management 
+      
+      CLASSES_EXTENDED = []
+            
+      def self.included(base)
+        
+        # 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?
+            doubleInclude = true
+          end
+        end
+        
+        if doubleInclude
+          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
+          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)
+              if !options
+                RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: options cannot be nil in call to url_for"
+              end
+              if in_facebook_canvas? #TODO: or in_facebook_frame?)
+                if options.is_a? Hash
+                  options[:only_path] = true
+                end
+                path = url_for__ALIASED(options, *parameters)
+                if path.starts_with?(self.facebook_callback_path)
+                  path.gsub!(self.facebook_callback_path, self.facebook_canvas_path)
+                  if !options.has_key?(:only_path)
+                    path = "http://apps.facebook.com#{path}"
+                  end
+                end
+              else
+                path = url_for__ALIASED(options, *parameters)
+              end
+  
+              return path
+            end
+      
+          
+            alias_method(:redirect_to__ALIASED, :redirect_to)
+          
+            def redirect_to(options = {}, *parameters)
+              if in_facebook_canvas?
+                RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Canvas redirect to #{url_for(options)}"
+                render :text => "<fb:redirect url=\"#{url_for(options)}\" />"     
+              else
+                RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: Regular redirect_to"
+                redirect_to__ALIASED(options, *parameters)
+              end
+            end
+          '
+          
+          # ensure that we persist the Facebook session in the Rails session (if possible)
+          base.after_filter(:rfacebook_persist_session_to_rails)
+          
+          # fix third party cookies in IE
+          base.before_filter{ |c| c.headers['P3P'] = %|CP="NOI DSP COR NID ADMa OPTa OUR NOR"| }
+          
+        end
+      end
+
 
     end
   end

data/lib/rfacebook_on_rails/plugin/init.rb

@@ -74,13 +74,17 @@ end
 
 # make sure the paths have leading and trailing slashes
 def ensureLeadingAndTrailingSlashesForPath(path)
-  if !path.starts_with?("/")
-    path = "/#{path}"
-  end
-  if !path.reverse.starts_with?("/")
-    path = "#{path}/"
+  if (path and path.size>0)
+    if !path.starts_with?("/")
+      path = "/#{path}"
+    end
+    if !path.reverse.starts_with?("/")
+      path = "#{path}/"
+    end
+    return path
+  else
+    return nil
   end
-  return path
 end
 
 FACEBOOK["canvas_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["canvas_path"])

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rfacebook
 version: !ruby/object:Gem::Version 
-  version: 0.8.5
-date: 2007-08-10 00:00:00 -07:00
+  version: 0.8.6
+date: 2007-08-11 00:00:00 -07: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