rfacebook 0.9.7 → 0.9.8

data/lib/rfacebook_on_rails/model_extensions.rb

@@ -1,203 +0,0 @@
-# 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: Errors
-      ##################################################################
-    
-      class APIKeyNeededStandardError < StandardError; end # :nodoc:
-      class APISecretNeededStandardError < StandardError; end # :nodoc:
-      
-      ##################################################################
-      ##################################################################
-      # :section: Template Methods (must be implemented by concrete subclass)
-      ##################################################################
-
-      def facebook_api_key
-        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, "RFACEBOOK ERROR: when using the RFacebook on Rails plugin, please be sure that you have a facebook.yml file with 'secret' defined"
-      end
-      
-      # :section: ActsAs method mixing
-      
-      def self.included(base) # :nodoc:
-        base.extend ActsAsMethods
-      end
-
-      module ActsAsMethods # :nodoc:all
-        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",
-          "pic",
-          "pic_big",
-          "pic_small",
-          "pic_square"
-        ]
-
-        
-        ######################
-        module ClassMethods
-                    
-          def find_or_create_by_facebook_session(sess)
-            if sess.is_ready?
-              
-              # try to find, else create
-              instance = find_by_facebook_uid(sess.session_user_id)
-              if !instance
-                instance = self.new
-              end
-              
-              # update session info
-              instance.facebook_session = sess
-              
-              # 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
-
-            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
-            if !@facebook_session
-              @facebook_session = FacebookWebSession.new(self.facebook_api_key, self.facebook_api_secret)
-              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|
-              base.class_eval <<-EOF
-                
-                def #{fieldname}
-                  if facebook_session.is_ready?
-                    return facebook_session.cached_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/rfacebook_on_rails/plugin/Rakefile.rb

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

data/lib/rfacebook_on_rails/plugin/init.rb

@@ -1,139 +0,0 @@
-# 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 "rfacebook_on_rails/view_extensions"
-require "rfacebook_on_rails/controller_extensions"
-require "rfacebook_on_rails/model_extensions"
-require "rfacebook_on_rails/session_extensions"
-
-module RFacebook::Rails::Plugin
-  
-  module ControllerExtensions
-    def facebook_api_key
-      # TODO: pull these overrides up into the original module, and make a FACEBOOK global in the backwards-compatibility file
-      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 (credit: Evan Weaver)
-begin
-  yamlFile = YAML.load_file("#{RAILS_ROOT}/config/facebook.yml")
-rescue Exception => e
-  raise StandardError, "config/facebook.yml could not be loaded."
-end
-
-if yamlFile
-  if yamlFile[RAILS_ENV]
-    FACEBOOK =  yamlFile[RAILS_ENV]
-  else
-    raise StandardError, "config/facebook.yml exists, but doesn't have a configuration for RAILS_ENV=#{RAILS_ENV}."
-  end
-else
-  raise StandardError, "config/facebook.yml does not exist."
-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
-def ensureLeadingAndTrailingSlashesForPath(path)
-  if (path and path.size>0)
-    if !path.starts_with?("/")
-      path = "/#{path}"
-    end
-    if !path.reverse.starts_with?("/")
-      path = "#{path}/"
-    end
-    return path.strip
-  else
-    return nil
-  end
-end
-
-FACEBOOK["canvas_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["canvas_path"])
-FACEBOOK["callback_path"] = ensureLeadingAndTrailingSlashesForPath(FACEBOOK["callback_path"])

data/lib/rfacebook_on_rails/plugin/install.rb

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

data/lib/rfacebook_on_rails/plugin/rake.rb

@@ -1,141 +0,0 @@
-# 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.
-#
-
-# Rake tasks modified from Evan Weaver's article
-# http://blog.evanweaver.com/articles/2007/07/13/developing-a-facebook-app-locally
-
-namespace "facebook" do
-
-  ######################################################################################
-  ######################################################################################
-  desc "Sets up the RFacebook Rails Plugin.  Right now, this simply copies facebook.yml into your config directory."
-  task "setup" do
-    
-    filename = "#{RAILS_ROOT}/config/facebook.yml"
-    puts "======================================================"
-    puts "Setting up RFacebook on Rails Plugin"
-    
-    ###### Install sample facebook.yml
-    file = File.new(filename, "w")
-    file <<
-"
-development:
-    key: YOUR_API_KEY_HERE
-    secret: YOUR_API_SECRET_HERE
-    canvas_path: /yourAppName/
-    callback_path: /path/to/your/callback/
-    tunnel:
-      username: yourLoginName
-      host: www.yourexternaldomain.com
-      port: 1234
-      local_port: 5678
-
-test:
-    key: YOUR_API_KEY_HERE
-    secret: YOUR_API_SECRET_HERE
-    canvas_path: /yourAppName/
-    callback_path: /path/to/your/callback/
-    tunnel:
-      username: yourLoginName
-      host: www.yourexternaldomain.com
-      port: 1234
-      local_port: 5678
-
-production:
-    key: YOUR_API_KEY_HERE
-    secret: YOUR_API_SECRET_HERE
-    canvas_path: /yourAppName/
-    callback_path: /path/to/your/callback/
-    tunnel:
-      username: yourLoginName
-      host: www.yourexternaldomain.com
-      port: 1234
-      local_port: 5678
-"
-    file.close_write
-    puts "  [1] Created config/facebook.yml <-- BE SURE TO CHANGE THE API KEY AND SECRET"
-    
-    ###### Finished
-    puts "Done."
-    puts "======================================================"
-  end
-  
-  
-  namespace "tunnel" do
-
-    ######################################################################################
-    ######################################################################################
-    desc "Start a reverse tunnel to develop from localhost. Please ensure that you have a properly configured config/facebook.yml file."
-    task "start" => "environment" do
-      
-      remoteUsername = FACEBOOK['tunnel']['username']
-      remoteHost = FACEBOOK['tunnel']['host']
-      remotePort = FACEBOOK['tunnel']['port']
-      localPort = FACEBOOK['tunnel']['local_port']
-      
-      puts "======================================================"
-      puts "Tunneling #{remoteHost}:#{remotePort} to 0.0.0.0:#{localPort}"
-            
-      puts
-      puts "NOTES:"
-      puts "* ensure that you have Rails running on your local machine at port #{localPort}"
-      puts "* once logged in to the tunnel, you can visit http://#{remoteHost}:#{remotePort} to view your site"
-      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 "ssh -nNT -g -R *:#{remotePort}:0.0.0.0:#{localPort} #{remoteUsername}@#{remoteHost}"
-      
-      
-    end
-    
-    ######################################################################################
-    ######################################################################################
-    desc "Check if reverse tunnel is running"
-    task "status" => "environment" do
-      if `ssh #{FACEBOOK['tunnel']['username']}@#{FACEBOOK['tunnel']['host']} netstat -an | 
-          egrep "tcp.*:#{FACEBOOK['tunnel']['port']}.*LISTEN" | wc`.to_i > 0
-        puts "Tunnel still running"
-      else
-        puts "Tunnel is down"
-      end
-    end
-  end
-
-
-end