rplatform-rails 0.0.2

data/lib/rplatform_rails/model_extensions.rb

@@ -0,0 +1,218 @@
+# AUTHORS:
+# - Curtis Edmond (www.okwithfailure.com)
+# thanks to matt for rfacebook
+# - Matt Pizzimenti (www.livelearncode.com)
+
+# LICENSE:
+# 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 RPlatform
+  module Rails
+    module ModelExtensions
+
+      ################################################################################################
+      ################################################################################################
+      # :section: Core API variables
+      ################################################################################################
+
+      def facebook_api_key(network)
+        NETWORKS[network]["key"] || super
+      end
+      
+      def facebook_api_secret(network)
+        NETWORKS[network]["secret"] || super
+      end
+      
+      ################################################################################################
+      ################################################################################################
+      # :section: Method mixing
+      ################################################################################################
+      
+      def self.included(base) # :nodoc:
+        base.extend ActsAsMethods
+      end
+
+      module ActsAsMethods # :nodoc:all
+        def acts_as_facebook_user
+          RAILS_DEFAULT_LOGGER.info "** RFACEBOOK DEPRECATION WARNING: acts_as_facebook_user will probably be deprecated in a future version of the RFacebook plugin"
+          # TODO: remove the acts_as_facebook_user or at least update it
+          include RPlatform::Rails::ModelExtensions::ActsAsFacebookUser::InstanceMethods
+          extend RPlatform::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",
+          "pic",
+          "pic_big",
+          "pic_small",
+          "pic_square"
+        ]
+
+        
+        ######################
+        module ClassMethods
+                    
+          def find_or_create_by_facebook_session(options={})
+            RAILS_DEFAULT_LOGGER.info "** RFACEBOOK DEPRECATION WARNING: acts_as_facebook_user will probably be deprecated in a future version of the RFacebook plugin"
+            
+            # parse the options (for backwards compatibility, options MIGHT be a FacebookWebSession)
+            if options.is_a?(RPlatform::FacebookWebSession)
+              fbsession = options
+              options = {}
+            else
+              fbsession = options[:facebook_session]
+            end
+            
+            # check that we have an fbsession
+            unless fbsession.is_a?(Rplatform::FacebookWebSession)
+              RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: find_or_create_by_facebook_session needs a :facebook_session specified"
+              return nil
+            end
+            
+            # if the session is ready to use...
+            if fbsession.ready?
+              
+              # find or create a user
+              instance = find_by_facebook_uid(fbsession.session_user_id) || self.new(options)
+              
+              # update session info
+              instance.facebook_session = fbsession
+              
+              # update (or create) the object and return it
+              if !instance.save
+                RAILS_DEFAULT_LOGGER.debug "** RFACEBOOK INFO: failed to update or create the Facebook user object in the database"
+                return nil
+              end
+              return instance
+
+            # session was not ready
+            else
+              RAILS_DEFAULT_LOGGER.info "** RFACEBOOK WARNING: tried to use an inactive session for acts_as_facebook_user (in find_or_create_by_facebook_session)"
+              return nil
+            end
+              
+          end
+                            
+        end
+      
+        ######################
+        module InstanceMethods
+          
+          # TODO: to help developers stay within the TOS, we should have a method in here like "with_facebook_scope(fbsession){...}"
+          
+          def facebook_session(network='facebook')
+            if !@facebook_session
+              @facebook_session = FacebookWebSession.new(self.facebook_api_key(network), self.facebook_api_secret(network))
+              begin
+                @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?
+            # TODO: this check should really look at expires
+            return self.facebook_session_key != nil
+          end
+          
+          def self.included(base) # :nodoc:
+            ActsAsFacebookUser::ACTORS << base
+            ActsAsFacebookUser::FIELDS.each do |fieldname|
+              # TODO: do getInfo caching
+              base.class_eval <<-EOF
+                
+                def #{fieldname}
+                  if facebook_session.ready?
+                    return facebook_session.users_getInfo(
+                      :uids => [facebook_uid],
+                      :fields => ActsAsFacebookUser::FIELDS).user.send(:#{fieldname})
+                  else
+                    return nil
+                  end
+                end
+              
+              EOF
+            end
+          end
+                
+        end
+        
+      end
+      ##################################################################
+      ##################################################################
+
+      
+    end    
+  end
+end

data/lib/rplatform_rails/session_extensions.rb

@@ -0,0 +1,198 @@
+# AUTHORS:
+# - Curtis Edmond (www.okwithfailure.com)
+# thanks to matt for rfacebook
+# - Matt Pizzimenti (www.livelearncode.com)
+
+# LICENSE:
+# 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 "digest/md5"
+require "cgi"
+
+module RPlatform::Rails::SessionExtensions # :nodoc:
+  
+  # :section: New Methods
+  def force_to_be_new! # :nodoc:
+    @force_to_be_new = true
+  end
+  
+  def using_facebook_session_id? # :nodoc:
+    return (@fb_sig_session_id != nil)
+  end
+    
+  # :section: Base Overrides
+  
+  def new_session_with_rplatform # :nodoc:
+    if @force_to_be_new
+      return true
+    else
+      return new_session_without_rplatform
+    end
+  end
+
+  def initialize_with_rplatform(request, options = {}) # :nodoc:
+    
+    # only try to use the sig when we don't have a cookie (i.e., in the canvas)
+    if session_id_available?(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
+    end
+    
+    # now call the default Rails session initialization
+    initialize_without_rplatform(request, options)
+  end
+  
+  # :section: Extension Helpers
+  
+  def self.included(base) # :nodoc:
+    base.class_eval do
+      alias_method_chain :initialize,   :rplatform
+      alias_method_chain :new_session,  :rplatform
+    end
+  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) # :nodoc:
+    
+    # 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[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 session_id_available?(request) # :nodoc:
+    # 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").blank? or !lookup_request_parameter(request, "fb_sig_is_ajax").blank?)
+  end
+    
+end
+
+#   Special initialize method that attempts to force any session store to use the Facebook session
+module RPlatform::Rails::SessionStoreExtensions # :nodoc:all
+  
+  # :section: Base Overrides
+  
+  def initialize_with_rplatform(session, options, *extraParams) # :nodoc:
+    
+    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: using fb_sig_session_key for the #{self.class.to_s} session (session_id=#{session.session_id})"
+        initialize_without_rplatform(session, options, *extraParams)
+      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_without_rplatform(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_without_rplatform(session, options, *extraParams)
+      
+    end
+  end
+  
+  # :section: Extension Helpers
+  
+  def self.included(base) # :nodoc:
+    base.class_eval do
+      alias_method_chain :initialize, :rplatform
+    end
+  end
+  
+end

data/lib/rplatform_rails/status_manager.rb

@@ -0,0 +1,312 @@
+# AUTHORS:
+# - Curtis Edmond (www.okwithfailure.com)
+# thanks to matt for rfacebook
+# - Matt Pizzimenti (www.livelearncode.com)
+
+# LICENSE:
+# 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 RPlatform
+  module Rails
+    
+    class StatusManager
+      
+      def initialize(checks)
+        @checks = checks
+      end
+      
+      def all_valid?
+        allValid = true
+        @checks.each do |check|
+          allValid = false if !check.valid?
+        end
+        return allValid
+      end
+      
+      def each_status_check
+        @checks.each do |check|
+          yield(check)
+        end
+      end
+      
+    end
+    
+    ###########################################
+    class StatusCheck
+      def valid?
+        return @valid
+      end
+      def message
+        if valid?
+          return valid_message
+        else
+          return invalid_message
+        end
+      end
+    end
+    
+    ###########################################
+    class SessionStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          if controller.fbsession.ready?
+            @valid = true
+          end
+        rescue
+        end
+      end
+      
+      def title
+        "fbsession"
+      end
+      
+      def valid_message
+        "session is ready to make API calls"
+      end
+      
+      def invalid_message
+        "session is invalid, you will not be able to make API calls (possibly due to a bad API key or secret)"
+      end
+      
+    end
+    ###########################################
+    class FacebookParamsStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          if @controller.fbparams.size > 0
+            @valid = true
+          end
+        rescue
+        end
+      end
+      
+      def title
+        "fbparams"
+      end
+      
+      def valid_message
+        @controller.fbparams
+      end
+      
+      def invalid_message
+        "fbparams is not populated since we weren't able to validate the signature (possibly due to a bad API key or secret)"
+      end
+      
+    end
+    ###########################################
+    class InCanvasStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = true
+      end
+      
+      def title
+        "in_facebook_canvas?"
+      end
+      
+      def valid_message
+        @controller.in_facebook_canvas? ? "yes" : "no"
+      end
+      
+      def invalid_message
+        "this should never be invalid"
+      end
+      
+    end
+    ###########################################
+    class InFrameStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = true
+      end
+      
+      def title
+        "in_facebook_frame?"
+      end
+      
+      def valid_message
+        @controller.in_facebook_frame? ? "yes" : "no"
+      end
+      
+      def invalid_message
+        "this should never be invalid"
+      end
+      
+    end
+    ###########################################
+    class CanvasPathStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          @valid = @controller.facebook_canvas_path.size > 0
+        rescue
+        end
+      end
+      
+      def title
+        "facebook_canvas_path"
+      end
+      
+      def valid_message
+        @controller.facebook_canvas_path
+      end
+      
+      def invalid_message
+        begin
+          FACEBOOK[:test]
+          return "you need to define <strong>canvas_path</strong> in facebook.yml"
+        rescue
+          return "you need to define s<strong>facebook_canvas_path</strong> in your controller"
+        end
+      end
+      
+    end
+    ###########################################
+    class CallbackPathStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          @valid = @controller.facebook_callback_path.size > 0
+        rescue
+        end
+      end
+      
+      def title
+        "facebook_callback_path"
+      end
+      
+      def valid_message
+        @controller.facebook_callback_path
+      end
+      
+      def invalid_message
+        begin
+          FACEBOOK[:test]
+          return "you need to define <strong>callback_path</strong> in facebook.yml"
+        rescue
+          return "you need to define s<strong>facebook_callback_path</strong> in your controller"
+        end
+      end
+      
+    end
+    ###########################################
+    class APIKeyStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          if @controller.facebook_api_key.size > 0
+            @valid = true
+          end
+        rescue
+        end
+      end
+      
+      def title
+        "facebook_api_key"
+      end
+      
+      def valid_message
+        "XXXXXXXXXXXXXXXXXX#{@controller.facebook_api_key[-4,4]}"
+      end
+      
+      def invalid_message
+        begin
+          FACEBOOK[:test]
+          return "you need to put your API <strong>key</strong> in facebook.yml"
+        rescue
+          return "you need to define s<strong>facebook_api_key</strong> in your controller"
+        end
+      end
+      
+    end
+    ###########################################
+    class APISecretStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          if @controller.facebook_api_secret.size > 0
+            @valid = true
+          end
+        rescue
+        end
+      end
+      
+      def title
+        "facebook_api_secret"
+      end
+      
+      def valid_message
+        "XXXXXXXXXXXXXXXXXX#{@controller.facebook_api_secret[-4,4]}"
+      end
+      
+      def invalid_message
+        begin
+          FACEBOOK[:test]
+          return "you need to put your API <strong>secret</strong> in facebook.yml"
+        rescue
+          return "you need to define s<strong>facebook_api_secret</strong> in your controller"
+        end
+      end
+      
+    end
+    
+    ###########################################
+    class FinishFacebookLoginStatusCheck < StatusCheck
+      def initialize(controller)
+        @controller = controller
+        @valid = false
+        begin
+          @controller.finish_facebook_login
+          @valid = true
+        rescue
+        end
+      end
+      
+      def title
+        "finish_facebook_login"
+      end
+      
+      def valid_message
+        "finisher method is defined (this is only for external web apps)"
+      end
+      
+      def invalid_message
+        "you need to define <strong>finish_facebook_login</strong> in your controller (this is only for external web apps)"
+      end
+      
+    end
+
+    
+  end
+end