mmangino-facebooker 1.0.29 → 1.0.30

data/lib/facebooker/session.rb

@@ -6,7 +6,7 @@ module Facebooker
   # other than the logged in user (if that's unallowed)
   class NonSessionUser < StandardError;  end
   class Session
-    
+
     #
     # Raised when a facebook session has expired.  This 
     # happens when the timeout is reached, or when the
@@ -62,49 +62,49 @@ module Facebooker
     class UserRegistrationFailed < StandardError
       attr_accessor :failed_users
     end
-    
+
     API_SERVER_BASE_URL       = ENV["FACEBOOKER_API"] == "new" ? "api.new.facebook.com" : "api.facebook.com"
     API_PATH_REST             = "/restserver.php"
     WWW_SERVER_BASE_URL       = ENV["FACEBOOKER_API"] == "new" ? "www.new.facebook.com" : "www.facebook.com"
     WWW_PATH_LOGIN            = "/login.php"
     WWW_PATH_ADD              = "/add.php"
     WWW_PATH_INSTALL          = "/install.php"
-    
+
     attr_writer :auth_token
     attr_reader :session_key
-    
+
     def self.create(api_key=nil, secret_key=nil)
       api_key ||= self.api_key
       secret_key ||= self.secret_key
       raise ArgumentError unless !api_key.nil? && !secret_key.nil?
       new(api_key, secret_key)
     end
-    
+
     def self.api_key
       extract_key_from_environment(:api) || extract_key_from_configuration_file(:api) rescue report_inability_to_find_key(:api)
     end
-    
+
     def self.secret_key
       extract_key_from_environment(:secret) || extract_key_from_configuration_file(:secret) rescue report_inability_to_find_key(:secret)
     end
-    
+
     def self.current
       Thread.current['facebook_session']
     end
-    
+
     def self.current=(session)
       Thread.current['facebook_session'] = session
     end
-    
+
     def login_url(options={})
       options = default_login_url_options.merge(options)
       "#{Facebooker.login_url_base(@api_key)}#{login_url_optional_parameters(options)}"
     end
-    
+
     def install_url(options={})
       "#{Facebooker.install_url_base(@api_key)}#{install_url_optional_parameters(options)}"
     end
-    
+
     # The url to get user to approve extended permissions
     # http://wiki.developers.facebook.com/index.php/Extended_permission
     #
@@ -122,20 +122,20 @@ module Facebooker
       options = default_login_url_options.merge(options)
       "http://#{Facebooker.www_server_base_url}/authorize.php?api_key=#{@api_key}&v=1.0&ext_perm=#{permission}#{install_url_optional_parameters(options)}"
     end
-    
+
     def install_url_optional_parameters(options)
       optional_parameters = []      
       optional_parameters += add_next_parameters(options)
       optional_parameters.join
     end
-    
+
     def add_next_parameters(options)
       opts = []
       opts << "&next=#{CGI.escape(options[:next])}" if options[:next]
       opts << "&next_cancel=#{CGI.escape(options[:next_cancel])}" if options[:next_cancel]
       opts
     end
-    
+
     def login_url_optional_parameters(options)
       # It is important that unused options are omitted as stuff like &canvas=false will still display the canvas. 
       optional_parameters = []
@@ -145,48 +145,54 @@ module Facebooker
       optional_parameters << "&canvas=true" if options[:canvas]
       optional_parameters.join
     end
-    
+
     def default_login_url_options
       {}
     end
-    
+
     def initialize(api_key, secret_key)
-      @api_key = api_key
-      @secret_key = secret_key
+      @api_key        = api_key
+      @secret_key     = secret_key
+      @batch_request  = nil
+      @session_key    = nil
+      @uid            = nil
+      @auth_token     = nil
+      @secret_from_session = nil
+      @expires        = nil
     end
-    
+
     def secret_for_method(method_name)
       @secret_key
     end
-      
+
     def auth_token
       @auth_token ||= post 'facebook.auth.createToken'
     end
-    
+
     def infinite?
       @expires == 0
     end
-    
+
     def expired?
       @expires.nil? || (!infinite? && Time.at(@expires) <= Time.now)
     end
-    
+
     def secured?
       !@session_key.nil? && !expired?
     end
-    
+
     def secure!
       response = post 'facebook.auth.getSession', :auth_token => auth_token
       secure_with!(response['session_key'], response['uid'], response['expires'], response['secret'])
     end    
-    
+
     def secure_with!(session_key, uid = nil, expires = nil, secret_from_session = nil)
       @session_key = session_key
       @uid = uid ? Integer(uid) : post('facebook.users.getLoggedInUser', :session_key => session_key)
       @expires = Integer(expires)
       @secret_from_session = secret_from_session
     end
-    
+
     def fql_query(query, format = 'XML')
       post('facebook.fql.query', :query => query, :format => format) do |response|
         type = response.shift
@@ -212,11 +218,11 @@ module Facebooker
         end
       end
     end
-    
+
     def user
       @user ||= User.new(uid, self)
     end
-    
+
     #
     # This one has so many parameters, a Hash seemed cleaner than a long param list.  Options can be:
     # :uid => Filter by events associated with a user with this uid
@@ -231,7 +237,7 @@ module Facebooker
         end
       end
     end
-    
+
     def event_members(eid)
       @members ||= post('facebook.events.getMembers', :eid => eid) do |response|
         response.map do |attendee_hash|
@@ -273,21 +279,21 @@ module Facebooker
     def server_cache
       Facebooker::ServerCache.new(self)
     end
-    
+
     #
     # Returns a proxy object for handling calls to the Facebook Data API
     def data
       Facebooker::Data.new(self)
     end
-    
+
     def admin
       Facebooker::Admin.new(self)
     end
-    
+
     def mobile
       Facebooker::Mobile.new(self)
     end
-    
+
     #
     # Given an array like:
     # [[userid, otheruserid], [yetanotherid, andanotherid]]
@@ -303,7 +309,7 @@ module Facebooker
       end
       post('facebook.friends.areFriends', :uids1 => uids1.join(','), :uids2 => uids2.join(','))
     end
-    
+
     def get_photos(pids = nil, subj_id = nil,  aid = nil)
       if [subj_id, pids, aid].all? {|arg| arg.nil?}
         raise ArgumentError, "Can't get a photo without a picture, album or subject ID" 
@@ -314,7 +320,7 @@ module Facebooker
         end
       end
     end
-    
+
     def get_albums(aids)
       @albums = post('facebook.photos.getAlbums', :aids => aids) do |response|
         response.map do |hash|        
@@ -322,7 +328,7 @@ module Facebooker
         end
       end
     end
-    
+
     def get_tags(pids)
       @tags = post('facebook.photos.getTags', :pids => pids)  do |response|
         response.map do |hash|
@@ -330,14 +336,14 @@ module Facebooker
         end
       end
     end
-    
+
     def add_tags(pid, x, y, tag_uid = nil, tag_text = nil )
       if [tag_uid, tag_text].all? {|arg| arg.nil?}
         raise ArgumentError, "Must enter a name or string for this tag"        
       end
       @tags = post('facebook.photos.addTag', :pid => pid, :tag_uid => tag_uid, :tag_text => tag_text, :x => x, :y => y )
     end
-    
+
     def send_notification(user_ids, fbml, email_fbml = nil)
       params = {:notification => fbml, :to_ids => user_ids.map{ |id| User.cast_to_facebook_id(id)}.join(',')}
       if email_fbml
@@ -348,25 +354,25 @@ module Facebooker
       unless uid?
         params[:type]="app_to_user"
       end
-      
+
       post 'facebook.notifications.send', params,uid?
     end 
-    
+
     ##
     # Register a template bundle with Facebook.
     # returns the template id to use to send using this template
     def register_template_bundle(one_line_story_templates,short_story_templates=nil,full_story_template=nil, action_links=nil)
       parameters = {:one_line_story_templates => Array(one_line_story_templates).to_json}
-      
+
       parameters[:action_links] = action_links.to_json unless action_links.blank?
-      
+
       parameters[:short_story_templates] = Array(short_story_templates).to_json unless short_story_templates.blank?
 
       parameters[:full_story_template] = full_story_template.to_json unless full_story_template.blank?
 
       post("facebook.feed.registerTemplateBundle", parameters, false)
     end
-    
+
     ##
     # publish a previously rendered template bundle
     # see http://wiki.developers.facebook.com/index.php/Feed.publishUserAction
@@ -378,8 +384,8 @@ module Facebooker
       parameters[:story_size] = story_size unless story_size.nil?
       post("facebook.feed.publishUserAction", parameters)
     end
-    
-    
+
+
     ##
     # Send email to as many as 100 users at a time
     def send_email(user_ids, subject, text, fbml = nil) 			
@@ -387,17 +393,17 @@ module Facebooker
       params = {:fbml => fbml, :recipients => user_ids.map{ |id| User.cast_to_facebook_id(id)}.join(','), :text => text, :subject => subject} 
       post 'facebook.notifications.sendEmail', params
     end
-    
+
     # Only serialize the bare minimum to recreate the session.
     def marshal_load(variables)#:nodoc:
       fields_to_serialize.each_with_index{|field, index| instance_variable_set_value(field, variables[index])}
     end
-    
+
     # Only serialize the bare minimum to recreate the session.    
     def marshal_dump#:nodoc:
       fields_to_serialize.map{|field| instance_variable_value(field)}
     end
-    
+
     # Only serialize the bare minimum to recreate the session. 
     def to_yaml( opts = {} )
       YAML::quick_emit(self.object_id, opts) do |out|
@@ -408,29 +414,29 @@ module Facebooker
         end
       end
     end
-    
+
     def instance_variable_set_value(field, value)
       self.instance_variable_set("@#{field}", value)
     end
-    
+
     def instance_variable_value(field)
       self.instance_variable_get("@#{field}")
     end
-    
+
     def fields_to_serialize
       %w(session_key uid expires secret_from_session auth_token api_key secret_key)
     end
-    
+
     class Desktop < Session
       def login_url
         super + "&auth_token=#{auth_token}"
       end
-      
+
       def secret_for_method(method_name)
         secret = auth_request_methods.include?(method_name) ? super : @secret_from_session
         secret
       end
-      
+
       def post(method, params = {},use_session=false)
         if method == 'facebook.profile.getFBML' || method == 'facebook.profile.setFBML'
           raise NonSessionUser.new("User #{@uid} is not the logged in user.") unless @uid == params[:uid]
@@ -442,17 +448,17 @@ module Facebooker
           ['facebook.auth.getSession', 'facebook.auth.createToken']
         end
     end
-    
+
     def batch_request?
       @batch_request
     end
-    
+
     def add_to_batch(req,&proc)
       batch_request = BatchRequest.new(req,proc)
       Thread.current[:facebooker_current_batch_queue]<<batch_request
       batch_request
     end
-    
+
     # Submit the enclosed requests for this session inside a batch
     # 
     # All requests will be sent to Facebook at the end of the block
@@ -500,7 +506,7 @@ module Facebooker
       @batch_request=false
       BatchRun.current_batch=nil
     end
-    
+
     def post_without_logging(method, params = {}, use_session_key = true, &proc)
       add_facebook_params(params, method)
       use_session_key && @session_key && params[:session_key] ||= @session_key
@@ -513,7 +519,7 @@ module Facebooker
         result
       end
     end
-    
+
     def post(method, params = {}, use_session_key = true, &proc)
       if batch_request?
         post_without_logging(method, params, use_session_key, &proc)
@@ -523,7 +529,7 @@ module Facebooker
         end
       end
     end
-    
+
     def post_file(method, params = {})
       base = params.delete(:base)
       Logging.log_fb_api(method, params) do
@@ -532,16 +538,18 @@ module Facebooker
         service.post_file(params.merge(:base => base, :sig => signature_for(params.reject{|key, value| key.nil?})))
       end
     end
-    
-    
+
+
+    @configuration_file_path = nil
+
     def self.configuration_file_path
       @configuration_file_path || File.expand_path("~/.facebookerrc")
     end
-    
+
     def self.configuration_file_path=(path)
       @configuration_file_path = path
     end
-    
+
     private
       def add_facebook_params(hash, method)
         hash[:method] = method
@@ -549,36 +557,36 @@ module Facebooker
         hash[:call_id] = Time.now.to_f.to_s unless method == 'facebook.auth.getSession'
         hash[:v] = "1.0"
       end
-      
+
       # This ultimately delgates to the adapter
       def self.extract_key_from_environment(key_name)
              Facebooker.send(key_name.to_s + "_key") rescue nil
       end
-      
+
       def self.extract_key_from_configuration_file(key_name)
         read_configuration_file[key_name]
       end
-      
+
       def self.report_inability_to_find_key(key_name)
         raise ConfigurationMissing, "Could not find configuration information for #{key_name}"
       end
-      
+
       def self.read_configuration_file
         eval(File.read(configuration_file_path))
       end
-      
+
       def service
         @service ||= Service.new(Facebooker.api_server_base, Facebooker.api_rest_path, @api_key)      
       end
-      
+
       def uid
         @uid || (secure!; @uid)
       end
-      
+
       def uid?
         !! @uid
       end
-      
+
       def signature_for(params)
         raw_string = params.inject([]) do |collection, pair|
           collection << pair.join("=")
@@ -587,7 +595,7 @@ module Facebooker
         Digest::MD5.hexdigest([raw_string, secret_for_method(params[:method])].join)
       end
   end
-  
+
   class CanvasSession < Session
     def default_login_url_options
       {:canvas => true}

data/lib/facebooker/version.rb

@@ -2,7 +2,7 @@ module Facebooker #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 29
+    TINY  = 30
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/facebooker.rb

@@ -1,6 +1,6 @@
 begin
   unless Object.const_defined?("ActiveSupport") and ActiveSupport.const_defined?("JSON")
-    require 'json' 
+    require 'json'
     module Facebooker
       def self.json_decode(str)
         JSON.parse(str)
@@ -12,9 +12,9 @@ begin
         ActiveSupport::JSON.decode(str)
       end
     end
-  end 
+  end
 rescue
-  require 'json' 
+  require 'json'
 end
 require 'zlib'
 require 'digest/md5'
@@ -22,9 +22,15 @@ require 'digest/md5'
 
 
 module Facebooker
-      
+
+    @facebooker_configuration = {}
+    @current_adapter = nil
+    @set_asset_host_to_callback_url = nil
+    @path_prefix = nil
+    @use_curl    = false
+
     class << self
-    
+
     def load_configuration(facebooker_yaml_file)
       if File.exist?(facebooker_yaml_file)
         if defined? RAILS_ENV
@@ -35,7 +41,7 @@ module 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. 
@@ -53,70 +59,66 @@ module Facebooker
       Facebooker.timeout = config['timeout']
       @facebooker_configuration = config
     end
-    
+
     def facebooker_config
-      @facebooker_configuration || {} # to prevent pretty_errors error if the config hasn't been set yet
-    end
-    
-     def current_adapter=(adapter_class)
-      @current_adapter = adapter_class
+      @facebooker_configuration
     end
-    
+
+    # TODO: This should be converted to attr_accessor, but we need to
+    # get all the require statements at the top of the file to work.
+
+    # Set the current adapter
+    attr_writer :current_adapter
+
+    # Get the current adapter
     def current_adapter
       @current_adapter || Facebooker::AdapterBase.default_adapter
     end
-    
+
     def load_adapter(params)
       self.current_adapter = Facebooker::AdapterBase.load_adapter(params)
     end
-      
+
     def facebook_path_prefix=(path)
       current_adapter.facebook_path_prefix = path
     end
-  
+
     # Default is canvas_page_name in yml file
     def facebook_path_prefix
       current_adapter.facebook_path_prefix
     end
-    
+
     def is_for?(application_container)
       current_adapter.is_for?(application_container)
     end
-    
+
     def set_asset_host_to_callback_url=(val)
       @set_asset_host_to_callback_url=val
     end
-    
+
     def set_asset_host_to_callback_url
-      @set_asset_host_to_callback_url.nil? ? true : @set_asset_host_to_callback_url
-    end
-    
-    def use_curl=(val)
-      @use_curl=val
-    end
-    
-    def use_curl?
-      @use_curl
+      @set_asset_host_to_callback_url || true
     end
-    
+
+    attr_accessor :use_curl
+    alias :use_curl? :use_curl
+
     def timeout=(val)
       @timeout = val.to_i
     end
-    
+
     def timeout
       @timeout
     end
-   
+
     [:api_key,:secret_key, :www_server_base_url,:login_url_base,:install_url_base,:api_rest_path,:api_server_base,:api_server_base_url,:canvas_server_base, :video_server_base].each do |delegated_method|
       define_method(delegated_method){ return current_adapter.send(delegated_method)}
     end
-    
-    
-       def path_prefix
-      @path_prefix
-      end
-    
-    
+
+
+    attr_reader :path_prefix
+
+
     # Set the asset path to the canvas path for just this one request
     # by definition, we will make this a canvas request
     def with_asset_path_for_canvas
@@ -130,7 +132,7 @@ module Facebooker
         ActionController::Base.asset_host = original_asset_host
       end
     end
-  
+
     # If this request is_canvas_request
     # then use the application name as the url root
     def request_for_canvas(is_canvas_request)