rfacebook 0.7.1 → 0.8.0

data/lib/facebook_rails_controller_extensions.rb

@@ -1,188 +1,7 @@
-# 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.
-#
-
-require "facebook_web_session"
-
+# This file is deprecated, but remains here for backward compatibility
+require "rfacebook_on_rails/controller_extensions"
 module RFacebook
-  
   module RailsControllerExtensions
-            
-    # SECTION: StandardErrors
-    
-    class APIKeyNeededStandardError < StandardError; end
-    class APISecretNeededStandardError < StandardError; end
-    class APIFinisherNeededStandardError < StandardError; end
-    
-    # SECTION: Template Methods (must be implemented by concrete subclass)
-    
-    def facebook_api_key
-      raise APIKeyNeededStandardError
-    end
-    
-    def facebook_api_secret
-      raise APISecretNeededStandardError
-    end
-    
-    def finish_facebook_login
-      raise APIFinisherNeededStandardError
-    end
-    
-    
-    
-    # SECTION: Required Methods
-    
-    def fbparams
-      
-      dup_params = (self.params || {}).dup
-      
-      # try to get fbparams from the params hash
-      if (!@fbparams || @fbparams.length <= 0)
-        @fbparams = fbsession.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)
-      end
-      
-      return @fbparams
-      
-    end
-
-    def fbsession
-      
-      if !@fbsession
-        
-        # create a session no matter what
-        @fbsession = FacebookWebSession.new(facebook_api_key, facebook_api_secret)
-        
-        # 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)
-          
-        elsif (!in_facebook_canvas? and session[:rfacebook_fbsession])
-          # Method 2: we've logged in the user already
-          @fbsession = session[:rfacebook_fbsession]
-          
-        end  
-        
-      end
-      
-      return @fbsession
-      
-    end
-    
-    # SECTION: Helpful Methods
-    
-    def facebook_redirect_to(url)
-      if in_facebook_canvas?
-        render :text => "<fb:redirect url=\"#{url}\" />"     
-      elsif url =~ /^https?:\/\/([^\/]*\.)?facebook\.com(:\d+)?/i
-        render :text => "<script type=\"text/javascript\">\ntop.location.href = \"#{url}\";\n</script>";
-      else
-        redirect_to url
-      end
-    end
-    
-    def in_facebook_canvas?
-      return (fbparams["in_canvas"] != nil)
-    end
-        
-    def in_facebook_frame?
-      return (fbparams["in_iframe"] != nil || fbparams["in_canvas"] != nil)
-    end
-    
-    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
-        end
-        
-      else
-        RAILS_DEFAULT_LOGGER.debug "** rfacebook: Didn't activate session from handle_facebook_login"
-      end
-      
-    end
-    
-    def require_facebook_login
-      
-      # handle a facebook login if given (external sites and iframe only)
-      handle_facebook_login
-      
-      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"
-          
-          if in_facebook_canvas?
-            RAILS_DEFAULT_LOGGER.debug "** rfacebook: Rendering canvas redirect"
-            render :text => "<fb:redirect url=\"#{sess.get_login_url(:canvas=>true)}\" />"
-            return false
-          else
-            RAILS_DEFAULT_LOGGER.debug "** rfacebook: Redirecting to login"
-            redirect_to sess.get_login_url
-            return false
-          end
-        end
-      end
-      
-    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}\" />"
-      end
-    end
-    
+    include RFacebook::Rails::ControllerExtensions
   end
-  
 end

data/lib/facebook_session.rb

@@ -89,6 +89,9 @@ class FacebookSession
     # cache object for API calls
     @callcache = {}
     
+    # default to XML formatted responses
+    # @response_format = "XML"
+    
   end
   
   def session_expired?
@@ -125,6 +128,14 @@ class FacebookSession
     return session_user_id
   end
   
+  # def use_json
+  #   @response_format = "JSON"
+  # end
+  # 
+  # def use_xml
+  #   @response_format = "XML"
+  # end
+  
   # SECTION: Protected Abstract Interface
   protected
   
@@ -192,6 +203,8 @@ class FacebookSession
       params = {}
     end
     params = params.dup # patch courtesy of Project Agape
+    
+    # params[:format] ||= @response_format
     params[:method] = "facebook.#{method}"
     params[:api_key] = @api_key
     params[:v] = "1.0"

data/lib/facepricot.rb

@@ -94,11 +94,7 @@ module RFacebook
     def hpricot
       return @doc
     end
-    
-    # def to_hash
-    #   return HpricotHashWrapper.new(@doc.containers[0]).to_hash
-    # end
-    
+        
   end
   
   class FacepricotChain < String
@@ -114,10 +110,6 @@ module RFacebook
       return make_facepricot_chain(methodSymbol.to_s, @doc)
     end
     
-    # def to_hash
-    #   return HpricotHashWrapper.new(@doc).to_hash
-    # end
-    
   end
 
   

data/lib/rfacebook_on_rails/controller_extensions.rb

@@ -0,0 +1,272 @@
+# 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.
+#
+
+require "facebook_web_session"
+require "rfacebook_on_rails/status_manager"
+require "rfacebook_on_rails/templates/debug_panel"
+
+module RFacebook
+  module Rails
+    module ControllerExtensions
+      
+      # SECTION: StandardErrors
+    
+      class APIKeyNeededStandardError < StandardError; end
+      class APISecretNeededStandardError < StandardError; end
+      class APICanvasPathNeededStandardError < StandardError; end
+      class APICallbackNeededStandardError < StandardError; end
+      class APIFinisherNeededStandardError < StandardError; end
+    
+      # SECTION: Template Methods (must be implemented by concrete subclass)
+    
+      def facebook_api_key
+        raise APIKeyNeededStandardError
+      end
+    
+      def facebook_api_secret
+        raise APISecretNeededStandardError
+      end
+      
+      def facebook_canvas_path
+        raise APICanvasPathNeededStandardError
+      end
+      
+      def facebook_callback_path
+        raise APICallbackNeededStandardError
+      end
+    
+      def finish_facebook_login
+        raise APIFinisherNeededStandardError
+      end
+    
+    
+    
+      # SECTION: Required Methods
+    
+      def fbparams
+      
+        dup_params = (self.params || {}).dup
+      
+        # try to get fbparams from the params hash
+        if (!@fbparams || @fbparams.length <= 0)
+          @fbparams = fbsession.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)
+        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
+
+      def fbsession
+      
+        if !@fbsession
+        
+          # create a session no matter what
+          @fbsession = FacebookWebSession.new(facebook_api_key, facebook_api_secret)
+        
+          # 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)
+          
+          elsif (!in_facebook_canvas? and session[:rfacebook_fbsession])
+            # Method 2: we've logged in the user already
+            @fbsession = session[:rfacebook_fbsession]
+          
+          end  
+        
+        end
+      
+        return @fbsession
+      
+      end
+    
+      # SECTION: Helpful Methods
+    
+      def facebook_redirect_to(url)
+        if in_facebook_canvas?
+          render :text => "<fb:redirect url=\"#{url}\" />"     
+        elsif url =~ /^https?:\/\/([^\/]*\.)?facebook\.com(:\d+)?/i
+          render :text => "<script type=\"text/javascript\">\ntop.location.href = \"#{url}\";\n</script>";
+        else
+          redirect_to url
+        end
+      end
+    
+      def in_facebook_canvas?
+        return (params["fb_sig_in_canvas"] != nil)
+      end
+        
+      def in_facebook_frame?
+        return (params["fb_sig_in_iframe"] != nil || params["fb_sig_in_canvas"] != nil)
+      end
+      
+      def in_external_app?
+        return (!params[:fb_sig] and !in_facebook_frame?)
+      end
+          
+      def handle_facebook_login
+        
+        puts params.inspect
+
+        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
+          end
+        
+        else
+          RAILS_DEFAULT_LOGGER.debug "** rfacebook: Didn't activate session from handle_facebook_login"
+        end
+      
+      end
+    
+      def require_facebook_login
+      
+        # handle a facebook login if given (external sites and iframe only)
+        handle_facebook_login
+      
+        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"
+          
+            if in_external_app?
+              RAILS_DEFAULT_LOGGER.debug "** rfacebook: Redirecting to login"
+              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"
+              render_text facebook_debug_panel
+              return false
+            else
+              RAILS_DEFAULT_LOGGER.debug "** rfacebook: Rendering canvas redirect"
+              render :text => "<fb:redirect url=\"#{sess.get_login_url(:canvas=>true)}\" />"
+              return false
+            end
+          end
+        end
+      
+      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}\" />"
+        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={}, *params)
+            # check options
+            path = url_for__ALIASED(options, *params)
+            if in_facebook_canvas? #TODO: or in_facebook_frame?)
+              path = "#{path}/"
+              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
+            end
+  
+            return path
+          end
+        
+        '
+      end
+      
+      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."
+        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{})
+      end
+      
+      def facebook_status_manager
+        checks = [
+          SessionStatusCheck.new(self),
+          (FacebookParamsStatusCheck.new(self) unless (!in_facebook_canvas? and !in_facebook_frame?)),
+          InCanvasStatusCheck.new(self),
+          InFrameStatusCheck.new(self),
+          (CanvasPathStatusCheck.new(self) unless (!in_facebook_canvas? or !in_facebook_frame?)),
+          (CallbackPathStatusCheck.new(self) unless (!in_facebook_canvas? or !in_facebook_frame?)),
+          (FinishFacebookLoginStatusCheck.new(self) unless (in_facebook_canvas? or in_facebook_frame?)),
+          APIKeyStatusCheck.new(self),
+          APISecretStatusCheck.new(self)
+          ].compact
+        return StatusManager.new(checks)
+      end
+
+    end
+  end
+end

data/lib/rfacebook_on_rails/model_extensions.rb

@@ -0,0 +1,173 @@
+# 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
+    module ModelExtensions
+      
+      # SECTION: StandardErrors
+    
+      class APIKeyNeededStandardError < StandardError; end
+      class APISecretNeededStandardError < StandardError; end
+      
+      # SECTION: Template Methods (must be implemented by concrete subclass)
+    
+      def facebook_api_key
+        raise APIKeyNeededStandardError
+      end
+    
+      def facebook_api_secret
+        raise APISecretNeededStandardError
+      end
+      
+      # SECTION: ActsAs method mixing
+      
+      def self.included(base)
+        base.extend ActsAsMethods
+      end
+
+      module ActsAsMethods
+        def acts_as_facebook_user
+          include RFacebook::Rails::ModelExtensions::ActsAsFacebookUser::InstanceMethods
+          extend RFacebook::Rails::ModelExtensions::ActsAsFacebookUser::ClassMethods
+        end
+      end
+      
+      
+      ##################################################################
+      ##################################################################
+      # SECTION: Acts As Facebook User
+      module ActsAsFacebookUser
+        
+        ACTORS = [] # holds a reference to all classes that have ActsAsFacebookUser injected
+        
+        FIELDS = [
+          "about_me",
+          "activities",
+          "affiliations",
+          "birthday",
+          "books",
+          "current_location",
+          "education_history",
+          "name",
+          "first_name",
+          "last_name",
+          "hometown_location",
+          "hs_info",
+          "interests",
+          "relationship_status",
+          "meeting_for",
+          "meeting_sex",
+          "movies",
+          "music",
+          "notes_count",
+          "political",
+          "profile_update_time",
+          "quotes",
+          "religion",
+          "sex",
+          "significant_other_id",
+          "status",
+          "timezone",
+          "tv",
+          "wall_count",
+          "work_history",
+        ]
+
+        
+        ######################
+        module ClassMethods
+                    
+          def find_or_create_by_facebook_session(sess)
+            instance = find_by_facebook_uid(sess.session_user_id)
+            if !instance
+              instance = self.new
+            end
+            instance.facebook_session = sess
+            instance.save
+            return instance
+          end
+                            
+        end
+      
+        ######################
+        module InstanceMethods
+          
+          def facebook_session
+            if !@facebook_session
+              self.facebook_session = FacebookWebSession.new(self.facebook_api_key, self.facebook_api_secret)
+              begin
+                self.facebook_session.activate_with_previous_session(self.facebook_session_key, self.facebook_uid)
+              rescue
+                # not a valid facebook session, should we nil it out?
+              end
+            end
+            return @facebook_session
+          end
+          
+          def facebook_session=(sess)
+            @facebook_session = sess
+            self.facebook_session_key = @facebook_session.session_key
+            self.facebook_uid = @facebook_session.session_user_id
+          end
+
+          def has_infinite_session_key?
+            return self.facebook_session_key != nil
+          end
+          
+          def self.included(base)
+            ActsAsFacebookUser::ACTORS << base
+            ActsAsFacebookUser::FIELDS.each do |fieldname|
+              base.class_eval <<-end_eval
+                
+                def #{fieldname}
+                  if facebook_session.is_valid?
+                    return facebook_session.cached_users_getInfo(
+                      :uids => [facebook_uid],
+                      :fields => ActsAsFacebookUser::FIELDS).user.send(:#{fieldname})
+                  else
+                    return nil
+                  end
+                end
+              
+              end_eval
+            end
+          end
+                
+        end
+        
+      end
+      ##################################################################
+      ##################################################################
+
+      
+    end    
+  end
+end

data/lib/rfacebook_on_rails/plugin/Rakefile.rb

@@ -0,0 +1 @@
+# no rakefile yet