facebooker 1.0.18 → 1.0.29

data/{README.txt → README.rdoc}

@@ -1,4 +1,4 @@
-= facebooker
+= Facebooker
 
 * http://facebooker.rubyforge.org
 
@@ -22,6 +22,7 @@ Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[h
 == SYNOPSIS:
 
 View David Clements' {excellent tutorial}[http://apps.facebook.com/facebooker_tutorial] at {http://apps.facebook.com/facebooker_tutorial/}[http://apps.facebook.com/facebooker_tutorial] or check out {Developing Facebook Platform Applications with Rails}[http://www.pragprog.com/titles/mmfacer].
+{Join the Mailing List}:[groups.google.com/group/facebooker]
 
 == REQUIREMENTS:
 
@@ -29,7 +30,7 @@ None
 
 == INSTALL:
 
- * Non Rails
+=== Non Rails
 
 The best way is:
 
@@ -39,7 +40,7 @@ If, for some reason, you can't/won't use RubyGems, you can do:
 
   (sudo) ruby setup.rb
 
-  * Rails
+=== Rails
 
 Facebooker can be installed as a Rails plugin by:
 
@@ -75,7 +76,13 @@ end
 
 (The MIT License)
 
-Copyright (c) 2008 FIX
+Copyright (c) 2008-2009:
+
+* Chad Fowler
+* Patrick Ewing
+* Mike Mangino
+* Shane Vitarana
+* Corey Innis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -9,20 +9,19 @@ rescue LoadError
   $stderr.puts "Install the multi_rails gem to run tests against multiple versions of Rails"
 end
 
- $: << File.dirname(__FILE__) + '/lib'
+$: << File.dirname(__FILE__) + '/lib'
 require './lib/facebooker.rb'
 
-Hoe.new('facebooker', Facebooker::VERSION::STRING) do |p|
+HOE = Hoe.new('facebooker', Facebooker::VERSION::STRING) do |p|
   p.rubyforge_name = 'facebooker'
   p.author = ['Chad Fowler', 'Patrick Ewing', 'Mike Mangino', 'Shane Vitarana', 'Corey Innis']
   p.email = 'mmangino@elevatedrails.com'
-  p.summary = 'Pure, idiomatic Ruby wrapper for the Facebook REST API.'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.readme_file   = 'README.rdoc'
+  p.history_file  = 'CHANGELOG.rdoc'
   p.remote_rdoc_dir = '' # Release to root
   p.test_globs = 'test/**/*_test.rb'
   p.extra_deps << ['json', '>= 1.0.0'] 
+  p.extra_rdoc_files  = FileList['*.rdoc']
 end
 
 require 'rcov/rcovtask'
@@ -42,16 +41,20 @@ namespace :test do
   end
 end
 
-gem_spec_file = 'facebooker.gemspec'
-
-gem_spec = eval(File.read(gem_spec_file)) rescue nil
-
-desc "Generate the gemspec file."
-task :gemspec do
-  require 'erb'
+namespace :gem do
+  task :spec do
+    File.open("#{HOE.name}.gemspec", 'w') do |f|
+      f.write(HOE.spec.to_ruby)
+    end
+  end
 
-  File.open(gem_spec_file, 'w') do |f|
-    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  namespace :spec do
+    task :dev do
+      File.open("#{HOE.name}.gemspec", 'w') do |f|
+        HOE.spec.version = "#{HOE.version}.#{Time.now.strftime("%Y%m%d%H%M%S")}"
+        f.write(HOE.spec.to_ruby)
+      end
+    end
   end
 end
 

data/generators/facebook/templates/config/facebooker.yml

@@ -20,6 +20,7 @@ development:
     public_host: 
     public_port: 4007
     local_port: 3000
+    server_alive_interval: 0
 
 test:
   api_key: 
@@ -32,6 +33,7 @@ test:
     public_host: 
     public_port: 4007
     local_port: 3000
+    server_alive_interval: 0
 
 production:
   api_key: 
@@ -44,3 +46,4 @@ production:
     public_host: 
     public_port: 4007
     local_port: 3000
+    server_alive_interval: 0

data/init.rb

@@ -9,64 +9,15 @@ FACEBOOKER = Facebooker.load_configuration(facebook_config)
 Facebooker.logger = RAILS_DEFAULT_LOGGER if Object.const_defined? :RAILS_DEFAULT_LOGGER
 
 require 'net/http_multipart_post'
-require 'facebooker/rails/controller'
-require 'facebooker/rails/facebook_url_rewriting'
-require 'facebooker/rails/facebook_session_handling'
-require 'facebooker/rails/facebook_request_fix'
-require 'facebooker/rails/routing'
-require 'facebooker/rails/facebook_pretty_errors' rescue nil
-require 'facebooker/rails/facebook_url_helper'
-module ::ActionController
-  class Base
-    def self.inherited_with_facebooker(subclass)
-      inherited_without_facebooker(subclass)
-      if subclass.to_s == "ApplicationController"
-        subclass.send(:include,Facebooker::Rails::Controller) 
-        subclass.helper Facebooker::Rails::Helpers
-      end
-    end
-    class << self
-      alias_method_chain :inherited, :facebooker
-    end
-  end
-end
-
-class ActionController::Routing::Route
-  def recognition_conditions_with_facebooker
-    defaults = recognition_conditions_without_facebooker 
-    defaults << " env[:canvas] == conditions[:canvas] " if conditions[:canvas]
-    defaults
-  end
-  alias_method_chain :recognition_conditions, :facebooker
-end
-
-# When making get requests, Facebook sends fb_sig parameters both in the query string
-# and also in the post body. We want to ignore the query string ones because they are one
-# request out of date
-# We only do thise when there are POST parameters so that IFrame linkage still works
-class ActionController::AbstractRequest
-  def query_parameters_with_facebooker
-    if request_parameters.blank?
-      query_parameters_without_facebooker
-    else
-      (query_parameters_without_facebooker||{}).reject {|key,value| key.to_s =~ /^fb_sig/}
-    end
-  end
-  
-  alias_method_chain :query_parameters, :facebooker
-end
-
-# We turn off route optimization to make named routes use our code for figuring out if they should go to the session
-# If this fails, it means we're on rails 1.2, we can ignore it
-begin
-  ActionController::Base::optimise_named_routes = false 
-rescue NoMethodError=>e
-  nil
-end
-
-# pull :canvas=> into env in routing to allow for conditions
-ActionController::Routing::RouteSet.send :include,  Facebooker::Rails::Routing::RouteSetExtensions
-ActionController::Routing::RouteSet::Mapper.send :include, Facebooker::Rails::Routing::MapperExtensions
-
-Mime::Type.register_alias "text/html", :fbml
-Mime::Type.register_alias "text/javascript", :fbjs
+if defined? Rails
+  require 'facebooker/rails/controller'
+  require 'facebooker/rails/facebook_url_rewriting'
+  require 'facebooker/rails/facebook_session_handling' if Rails.version < '2.3'
+  require 'facebooker/rails/facebook_request_fix' if Rails.version < '2.3'
+  require 'facebooker/rails/routing'
+  require 'facebooker/rails/facebook_pretty_errors' rescue nil
+  require 'facebooker/rails/facebook_url_helper'
+  require 'facebooker/rails/extensions/rack_setup' if Rails.version > '2.3'
+  require 'facebooker/rails/extensions/action_controller'
+  require 'facebooker/rails/extensions/routing'
+end

data/lib/facebooker.rb

@@ -28,27 +28,34 @@ module Facebooker
     def load_configuration(facebooker_yaml_file)
       if File.exist?(facebooker_yaml_file)
         if defined? RAILS_ENV
-          facebooker = YAML.load_file(facebooker_yaml_file)[RAILS_ENV] 
+          config = YAML.load_file(facebooker_yaml_file)[RAILS_ENV] 
         else
-          facebooker = YAML.load_file(facebooker_yaml_file)           
+          config = YAML.load_file(facebooker_yaml_file)           
         end
-        ENV['FACEBOOK_API_KEY'] = facebooker['api_key']
-        ENV['FACEBOOK_SECRET_KEY'] = facebooker['secret_key']
-        ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = facebooker['canvas_page_name']
-        ENV['FACEBOOKER_API'] = facebooker['api']
-        if facebooker.has_key?('set_asset_host_to_callback_url')
-          Facebooker.set_asset_host_to_callback_url = facebooker['set_asset_host_to_callback_url'] 
-        end
-        Facebooker.timeout = facebooker['timeout']
-        if Object.const_defined?("ActionController")
-          ActionController::Base.asset_host = facebooker['callback_url'] if(ActionController::Base.asset_host.blank?)  && Facebooker.set_asset_host_to_callback_url
-        end
-        @facebooker_configuration = facebooker
+        apply_configuration(config)
+      end
+    end
+    
+    # Sets the Facebook environment based on a hash of options. 
+    # By default the hash passed in is loaded from facebooker.yml, but it can also be passed in
+    # manually every request to run multiple Facebook apps off one Rails app. 
+    def apply_configuration(config)
+      ENV['FACEBOOK_API_KEY']             = config['api_key']
+      ENV['FACEBOOK_SECRET_KEY']          = config['secret_key']
+      ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = config['canvas_page_name']
+      ENV['FACEBOOKER_API']               = config['api']
+      if config.has_key?('set_asset_host_to_callback_url')
+        Facebooker.set_asset_host_to_callback_url = config['set_asset_host_to_callback_url'] 
+      end
+      if Object.const_defined?("ActionController") and Facebooker.set_asset_host_to_callback_url
+        ActionController::Base.asset_host = config['callback_url'] 
       end
+      Facebooker.timeout = config['timeout']
+      @facebooker_configuration = config
     end
     
     def facebooker_config
-      @facebooker_configuration 
+      @facebooker_configuration || {} # to prevent pretty_errors error if the config hasn't been set yet
     end
     
      def current_adapter=(adapter_class)

data/lib/facebooker/adapters/adapter_base.rb

@@ -68,6 +68,9 @@ module Facebooker
         end
         return adapter_class.new(adapter_config)
       end
+
+      return self.default_adapter(params)
+
     end
 
     def self.default_adapter(params = {})

data/lib/facebooker/logging.rb

@@ -44,7 +44,7 @@ module Facebooker
     def self.log_info(message, dump, seconds = 0)
       return unless Facebooker.logger
       log_message = "#{message} (#{seconds}) #{dump}"
-      Facebooker.logger.debug(log_message)
+      Facebooker.logger.info(log_message)
     end
     
   end  

data/lib/facebooker/model.rb

@@ -122,10 +122,12 @@ module Facebooker
       unless hash.nil? || hash.empty?
         hash.each do |key, value|
           set_attr_method = "#{key}="
-          if !value.nil? && respond_to?(set_attr_method)
-            self.__send__(set_attr_method, value) 
-          else
-            Facebooker::Logging.log_info("**Warning**, Attempt to set non-attribute: #{key}",hash)
+          unless value.nil?
+            if respond_to?(set_attr_method)
+              self.__send__(set_attr_method, value) 
+            else
+              Facebooker::Logging.log_info("**Warning**, Attempt to set non-attribute: #{key}",hash)
+            end
           end
         end
         @populated = true

data/lib/facebooker/models/user.rb

@@ -10,7 +10,7 @@ module Facebooker
       include Model
       attr_accessor :message, :time, :status_id
     end
-    FIELDS = [:status, :political, :pic_small, :name, :quotes, :is_app_user, :tv, :profile_update_time, :meeting_sex, :hs_info, :timezone, :relationship_status, :hometown_location, :about_me, :wall_count, :significant_other_id, :pic_big, :music, :uid, :work_history, :sex, :religion, :notes_count, :activities, :pic_square, :movies, :has_added_app, :education_history, :birthday, :first_name, :meeting_for, :last_name, :interests, :current_location, :pic, :books, :affiliations, :locale, :profile_url, :proxied_email, :email_hashes, :allowed_restrictions]
+    FIELDS = [:status, :political, :pic_small, :name, :quotes, :is_app_user, :tv, :profile_update_time, :meeting_sex, :hs_info, :timezone, :relationship_status, :hometown_location, :about_me, :wall_count, :significant_other_id, :pic_big, :music, :uid, :work_history, :sex, :religion, :notes_count, :activities, :pic_square, :movies, :has_added_app, :education_history, :birthday, :first_name, :meeting_for, :last_name, :interests, :current_location, :pic, :books, :affiliations, :locale, :profile_url, :proxied_email, :email_hashes, :allowed_restrictions, :pic_with_logo, :pic_big_with_logo, :pic_small_with_logo, :pic_square_with_logo]
     STANDARD_FIELDS = [:uid, :first_name, :last_name, :name, :timezone, :birthday, :sex, :affiliations, :locale, :profile_url, :pic_square]
     populating_attr_accessor *FIELDS
     attr_reader :affiliations
@@ -245,17 +245,17 @@ module Facebooker
     #
     # This does not set profile actions, that should be done with profile_action=
     def profile_fbml=(markup)
-      set_profile_fbml(markup, nil, nil)
+      set_profile_fbml(markup, nil, nil, nil)
     end
     
     ##
     # Set the mobile profile FBML
     def mobile_fbml=(markup)
-      set_profile_fbml(nil, markup, nil)
+      set_profile_fbml(nil, markup, nil,nil)
     end
     
     def profile_action=(markup)
-      set_profile_fbml(nil, nil, markup)
+      set_profile_fbml(nil, nil, markup,nil)
     end
     
     def profile_main=(markup)
@@ -377,6 +377,41 @@ module Facebooker
         ret
       end
     end
+
+    # Get a count of unconnected friends
+    def getUnconnectedFriendsCount
+      session.post("facebook.connect.getUnconnectedFriendsCount")
+    end
+
+
+    # Unregister an array of email hashes
+    def self.unregister(email_hashes)
+      Facebooker::Session.create.post("facebook.connect.unregisterUsers",:email_hashes=>email_hashes.to_json) do |ret|
+        ret.each do |hash|
+          email_hashes.delete(hash)
+        end
+        unless email_hashes.empty?
+          e=Facebooker::Session::UserUnRegistrationFailed.new
+          e.failed_users = email_hashes
+          raise e
+        end
+        ret
+      end      
+    end
+    
+    # unregister an array of email addresses
+    def self.unregister_emails(emails)
+      emails_hash  = {}
+      emails.each {|e| emails_hash[hash_email(e)] = e}
+      begin 
+        unregister(emails_hash.keys).collect {|r| emails_hash[r]}
+      rescue
+        # re-raise with emails instead of hashes.
+        e = Facebooker::Session::UserUnRegistrationFailed.new
+        e.failed_users = $!.failed_users.collect { |f| emails_hash[f] }
+        raise e
+      end
+    end
     
     def self.hash_email(email)
       email = email.downcase.strip

data/lib/facebooker/parser.rb

@@ -96,6 +96,18 @@ module Facebooker
       array_of_text_values(element("connect_registerUsers_response", data), "connect_registerUsers_response_elt")
     end
   end
+  
+  class UnregisterUsers < Parser
+    def self.process(data)
+      array_of_text_values(element("connect_unregisterUsers_response", data), "connect_unregisterUsers_response_elt")
+    end
+  end
+
+  class GetUnconnectedFriendsCount < Parser
+    def self.process(data)
+      hash_or_value_for(element("connect_getUnconnectedFriendsCount_response",data)).to_i 
+    end
+  end
 
   class GetSession < Parser#:nodoc:
     def self.process(data)      
@@ -530,6 +542,8 @@ module Facebooker
       'facebook.auth.createToken' => CreateToken,
       'facebook.auth.getSession' => GetSession,
       'facebook.connect.registerUsers' => RegisterUsers,
+      'facebook.connect.unregisterUsers' => UnregisterUsers,
+      'facebook.connect.getUnconnectedFriendsCount' => GetUnconnectedFriendsCount,
       'facebook.users.getInfo' => UserInfo,
       'facebook.users.getStandardInfo' => UserStandardInfo,
       'facebook.users.setStatus' => SetStatus,

data/lib/facebooker/rails/controller.rb

@@ -6,7 +6,7 @@ module Facebooker
       include Facebooker::Rails::ProfilePublisherExtensions
       def self.included(controller)
         controller.extend(ClassMethods)
-        #controller.before_filter :set_adapter <-- security hole noted by vchu
+        controller.before_filter :set_adapter 
         controller.before_filter :set_facebook_request_format
         controller.helper_attr :facebook_session_parameters
         controller.helper_method :request_comes_from_facebook?
@@ -45,6 +45,27 @@ module Facebooker
         @facebook_params ||= verified_facebook_params
       end      
       
+      # Redirects the top window to the given url if the content is in an iframe, otherwise performs
+      # a normal redirect_to call.
+      def top_redirect_to(*args)
+        if request_is_facebook_iframe?
+          @redirect_url = url_for(*args)
+          render :layout => false, :inline => <<-HTML
+            <html><head>
+              <script type="text/javascript">  
+                window.top.location.href = <%= @redirect_url.to_json -%>;
+              </script>
+              <noscript>
+                <meta http-equiv="refresh" content="0;url=<%=h @redirect_url %>" />
+                <meta http-equiv="window-target" content="_top" />
+              </noscript>                
+            </head></html>
+          HTML
+        else
+          redirect_to(*args)
+        end
+      end
+      
       def redirect_to(*args)
         if request_is_for_a_facebook_canvas? and !request_is_facebook_tab?
           render :text => fbml_redirect_tag(*args)
@@ -104,8 +125,7 @@ module Facebooker
  
           #returning gracefully if the cookies aren't set or have expired
           return unless parsed['session_key'] && parsed['user'] && parsed['expires'] && parsed['ss'] 
-          return unless Time.at(parsed['expires'].to_f) > Time.now || (parsed['expires'] == "0")
-          
+          return unless Time.at(parsed['expires'].to_s.to_f) > Time.now || (parsed['expires'] == "0")          
           #if we have the unexpired cookies, we'll throw an exception if the sig doesn't verify
           verify_signature(parsed,cookies[Facebooker.api_key])
           
@@ -141,7 +161,7 @@ module Facebooker
       def create_new_facebook_session_and_redirect!
         session[:facebook_session] = new_facebook_session
         url_params = after_facebook_login_url.nil? ? {} : {:next=>after_facebook_login_url}
-        redirect_to session[:facebook_session].login_url(url_params) unless @installation_required
+        top_redirect_to session[:facebook_session].login_url(url_params) unless @installation_required
         false
       end
       
@@ -219,8 +239,12 @@ module Facebooker
         !params["fb_sig_in_profile_tab"].blank?
       end
       
+      def request_is_facebook_iframe?
+        !params["fb_sig_in_iframe"].blank?
+      end
+      
       def request_is_facebook_ajax?
-        params["fb_sig_is_mockajax"]=="1" || params["fb_sig_is_ajax"]=="1"
+        params["fb_sig_is_mockajax"]=="1" || params["fb_sig_is_ajax"]=="1" || params["fb_sig_is_ajax"]==true || params["fb_sig_is_mockajax"]==true
       end
       def xml_http_request?
         request_is_facebook_ajax? || super
@@ -246,7 +270,7 @@ module Facebooker
       end
       
       def application_needs_permission(perm)
-        redirect_to(facebook_session.permission_url(perm))
+        top_redirect_to(facebook_session.permission_url(perm))
       end
       
       def has_extended_permission?(perm)
@@ -266,14 +290,14 @@ module Facebooker
       
       def application_is_not_installed_by_facebook_user
         url_params = after_facebook_login_url.nil? ? {} : { :next => after_facebook_login_url }
-        redirect_to session[:facebook_session].install_url(url_params)
+        top_redirect_to session[:facebook_session].install_url(url_params)
       end
       
       def set_facebook_request_format
         if request_is_facebook_ajax?
-          params[:format] = 'fbjs'
-        elsif request_comes_from_facebook?
-          params[:format] = 'fbml'
+          request.format = :fbjs
+        elsif request_comes_from_facebook? && !request_is_facebook_iframe?
+          request.format = :fbml
         end
       end