facebooker-lite 1.0.67

data/lib/facebooker/adapters/facebook_adapter.rb

@@ -0,0 +1,60 @@
+module Facebooker
+  
+   
+  class FacebookAdapter < AdapterBase
+      
+    def canvas_server_base
+      "apps.facebook.com"
+    end
+      
+    def api_server_base
+       "api.facebook.com"
+    end
+    
+    def video_server_base
+      "api-video.facebook.com"
+    end
+    
+    def www_server_base_url
+      "www.facebook.com"
+    end
+    
+    def api_rest_path
+      "/restserver.php"
+    end
+    
+    def api_key
+      ENV['FACEBOOK_API_KEY'] || super      
+    end
+    
+    def secret_key
+      ENV['FACEBOOK_SECRET_KEY'] || super
+    end
+      
+    def is_for?(application_context)
+      application_context == :facebook
+    end
+       
+  
+       
+    def login_url_base
+      "http://#{www_server_base_url}/login.php?api_key=#{api_key}&v=1.0"
+    end
+       
+    def install_url_base
+      "http://#{www_server_base_url}/install.php?api_key=#{api_key}&v=1.0"
+    end
+
+    def connect_permission_url_base
+      "http://#{www_server_base_url}/connect/prompt_permissions.php?api_key=#{api_key}&v=1.0"      
+    end
+
+    def permission_url_base
+      "http://#{www_server_base_url}/authorize.php?api_key=#{api_key}&v=1.0"
+    end
+    
+  end
+  
+end
+
+

data/lib/facebooker/admin.rb

@@ -0,0 +1,42 @@
+module Facebooker
+  class Admin
+    def initialize(session)
+      @session = session
+    end
+    
+    # ** BETA ***
+    # +properties+: Hash of properties you want to set
+    def set_app_properties(properties)
+      properties = properties.respond_to?(:to_json) ? properties.to_json : properties
+      (@session.post 'facebook.admin.setAppProperties', :properties => properties) == '1'
+    end
+    
+    # ** BETA ***
+    # +properties+: Hash of properties you want to view.
+    def get_app_properties(*properties)
+      json = @session.post('facebook.admin.getAppProperties', :properties => properties.to_json)
+      hash = Facebooker.json_decode(CGI.unescapeHTML(json))
+      @properties = ApplicationProperties.from_hash(hash)
+    end
+    
+    # ** BETA ***
+    # +restrictions+: Hash of restrictions you want to set.
+    def set_restriction_info(restrictions)
+      restrictions = restrictions.respond_to?(:to_json) ? restrictions.to_json : restrictions
+      (@session.post 'facebook.admin.setRestrictionInfo', :restriction_str => restrictions) == '1'
+    end
+    
+    # ** BETA ***
+    def get_restriction_info(*restrictions)
+      json = @session.post('facebook.admin.getRestrictionInfo')
+      hash = Facebooker.json_decode(CGI.unescapeHTML(json))
+      @restrictions = ApplicationRestrictions.from_hash(hash)
+    end
+  
+    # Integration points include..
+    #   :notifications_per_day, :requests_per_day, :emails_per_day, :email_disable_message_location
+    def get_allocation(integration_point)
+      @session.post('facebook.admin.getAllocation', :integration_point_name => integration_point.to_s).to_i
+    end    
+  end
+end

data/lib/facebooker/application.rb

@@ -0,0 +1,37 @@
+module Facebooker
+  class Application
+    def initialize(session)
+      @session = session
+    end
+    
+    # +properties+: Hash of properties of the desired application. Specify exactly one of: application_id, application_api_key or application_canvas_name 
+    # eg: application.get_public_info(:application_canvas_name => ENV['FACEBOOKER_RELATIVE_URL_ROOT'])
+    def get_public_info(properties)
+      (@session.post 'facebook.application.getPublicInfo', properties)
+    end
+    
+    # facebook_session.application.add_global_news [{ :message => 'Hi all users', :action_link => { :text => "Hi application", :href => 'http://facebook.er/' }}], 'http://facebook.er/icon.png'
+    def add_global_news(news, image=nil)
+      params = {}
+      params[:news] = news
+      params[:image] = image if image
+      @session.post('facebook.dashboard.addGlobalNews', params)
+    end
+    
+    # currently bugged on Facebook; returns all
+    # facebook_session.application.get_global_news '310354202543'
+    def get_global_news(*news_ids)
+      params = {}
+      params[:news_ids] = news_ids.flatten if news_ids
+      @session.post('facebook.dashboard.getGlobalNews', params)
+    end
+    
+    # facebook_session.application.clear_global_news '310354202543'
+    def clear_global_news(*news_ids)
+      params = {}
+      params[:news_ids] = news_ids.flatten if news_ids
+      @session.post('facebook.dashboard.clearGlobalNews', params)
+    end
+    
+  end
+end

data/lib/facebooker/attachment.rb

@@ -0,0 +1,51 @@
+class Facebooker::Attachment
+  
+  def initialize
+    @storage = {}
+  end
+  
+  def self.hash_populating_accessor(*names)
+    names.each do |name|
+      define_method(name) do
+        @storage[name]
+      end
+      define_method("#{name}=") do |val|
+        @storage[name]=val
+      end
+    end
+  end
+  
+  hash_populating_accessor :name,:href, :comments_xid, :description, :caption
+  
+  def add_media(hash)
+    @storage[:media]||=[]
+    @storage[:media] << hash
+  end
+  
+  def add_image(source,href)
+    add_media({:type=>"image",:src=>source,:href=>href})
+  end
+  
+  def add_mp3(source,title=nil,artist=nil,album=nil)
+    params = {:src=>source,:type=>"mp3"}
+    params[:title] =  title unless title.nil?
+    params[:artist] =  artist unless artist.nil?
+    params[:album] =  album unless album.nil?
+    add_media(params)
+  end
+  
+  def add_flash(swfsource, imgsource, width=nil, height=nil, expanded_width=nil, expanded_height=nil)
+    params={:type=>"flash",:swfsrc=>swfsource,:imgsrc=>imgsource}
+    params[:width] = width unless width.nil?
+    params[:height] = height unless height.nil?
+    params[:expanded_width] = expanded_width unless expanded_width.nil?
+    params[:expanded_height] = expanded_height unless expanded_height.nil?
+    add_media(params)
+  end
+  
+  def to_hash
+    @storage
+  end
+  
+  
+end

data/lib/facebooker/batch_request.rb

@@ -0,0 +1,45 @@
+module Facebooker
+  class BatchRequest
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^respond_to\?$|^new|object_id$)/ }
+    attr_reader :uri
+    attr_reader :method
+    class UnexecutedRequest < StandardError; end
+    def initialize(params,proc)
+      @exception  = nil
+      @result     = nil
+      @method     = params[:method]
+      @uri        = params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join("&")
+      @proc       = proc
+    end
+
+    def result=(result_object)
+      @result = @proc.nil? ? result_object : @proc.call(result_object)
+    end
+
+    def exception_raised=(ex)
+      @exception=ex
+    end
+
+    def exception_raised?
+      @exception.nil? ? false : raise(@exception)
+    end
+
+    def respond_to?(name)
+      super || @result.respond_to?(name)
+    end
+
+    def ===(other)
+      other === @result
+    end
+
+    def method_missing(name,*args,&proc)
+      if @exception
+        raise @exception
+      elsif @result.nil?
+        raise UnexecutedRequest.new("You must execute the batch before accessing the result: #{@uri}")
+      else
+        @result.send(name,*args,&proc)
+      end
+    end
+  end
+end

data/lib/facebooker/data.rb

@@ -0,0 +1,57 @@
+module Facebooker
+  class Data
+    def initialize(session)
+      @session = session
+    end
+
+    ##
+    # ** BETA ***
+    # Sets a cookie on Facebook
+    # +user+ The user for whom this cookie needs to be set.
+    # +name+ Name of the cookie
+    # +value+ Value of the cookie
+    # Optional:
+    # +expires+ Time when the cookie should expire. If not specified, the cookie never expires.
+    # +path+ Path relative to the application's callback URL, with which the cookie should be associated. (default value is /?
+    def set_cookie(user, name, value, expires=nil, path=nil)
+      @session.post('facebook.data.setCookie',
+        :uid => User.cast_to_facebook_id(user),
+        :name => name,
+        :value => value,
+        :expires => expires,
+        :path => path) {|response| response == '1'}
+    end
+
+    ##
+    # ** BETA ***
+    # Gets a cookie stored on Facebook
+    # +user+	The user from whom to get the cookies.
+    # Optional:
+    # +name+ The name of the cookie. If not specified, all the cookies for the given user get returned.
+    def get_cookies(user, name=nil)
+      @cookies = @session.post(
+        'facebook.data.getCookies', :uid => User.cast_to_facebook_id(user), :name => name) do |response|
+          response.map do |hash|
+            Cookie.from_hash(hash)
+          end
+      end
+    end
+
+    ##
+    # ** BETA ***
+    # Gets a preference stored on Facebook
+    # +pref_id+	The id of the preference to get
+    def get_preference(pref_id)
+      @session.post('facebook.data.getUserPreference', :pref_id=>pref_id)
+    end
+
+    ##
+    # ** BETA ***
+    # Sets a preference on Facebook
+    # +pref_id+	The id of the preference to set
+    # +value+ The value to set for this preference
+    def set_preference(pref_id, value)
+      @session.post('facebook.data.setUserPreference', :pref_id=>pref_id, :value=>value)
+    end
+  end
+end

data/lib/facebooker/feed.rb

@@ -0,0 +1,78 @@
+module Facebooker
+  module Feed
+    METHODS = {'Action' => 'facebook.feed.publishActionOfUser', 'Story' => 'facebook.feed.publishStoryToUser',
+               'TemplatizedAction' => 'facebook.feed.publishTemplatizedAction' }
+
+    class ActionBase
+      1.upto(4) do |num|
+        attr_accessor "image_#{num}"
+        attr_accessor "image_#{num}_link"
+      end
+      
+      def add_image(image,link=nil)
+        1.upto(4) do |num|
+          if send("image_#{num}").blank?
+            send("image_#{num}=",image)
+            send("image_#{num}_link=",link) unless link.nil?
+            return num
+          end
+        end        
+      end
+      
+
+      protected
+      def image_params
+        image_hash = {}
+        1.upto(4) do |num|
+          image_attribute = "image_#{num}"
+          image_link_attribute = image_attribute + "_link"
+          self.__send__(image_attribute) ? image_hash[image_attribute] = self.__send__(image_attribute) : nil
+          self.__send__(image_link_attribute) ? image_hash[image_link_attribute] = self.__send__(image_link_attribute) : nil    
+        end
+        image_hash
+      end
+    end
+
+    ##
+    # Representation of a templatized action to be published into a user's news feed
+    class TemplatizedAction < ActionBase
+     attr_accessor :page_actor_id, :title_template, :title_data, :body_template, :body_data, :body_general, :target_ids
+
+      def to_params
+       raise "Must set title_template" if self.title_template.nil?
+       { :page_actor_id => page_actor_id, 
+         :title_template => title_template, 
+         :title_data => convert_json(title_data),
+         :body_template => body_template, 
+         :body_data => convert_json(body_data), 
+         :body_general => body_general,
+         :target_ids => target_ids }.merge image_params
+      end
+      
+      def convert_json(hash_or_string)    
+        (hash_or_string.is_a?(Hash) and hash_or_string.respond_to?(:to_json)) ? hash_or_string.to_json : hash_or_string
+      end
+    end
+
+    ##
+    # Representation of a story to be published into a user's news feed.
+    class Story < ActionBase
+      attr_accessor :title, :body
+
+      ##
+      # Converts Story to a Hash of its attributes for use as parameters to Facebook REST API calls
+      def to_params
+        raise "Must set title before converting" if self.title.nil?
+        { :title => title, :body => body }.merge image_params
+      end
+
+    end
+    Action = Story.dup
+    def Action.name
+      "Action"
+    end
+    ##
+    #  Representation of an action to be published into a user's news feed.  Alias for Story.
+    class Action; end
+  end
+end

data/lib/facebooker/logging.rb

@@ -0,0 +1,44 @@
+require 'benchmark'
+module Facebooker
+  @@logger = nil
+  def self.logger=(logger)
+    @@logger = logger
+  end
+  def self.logger
+    @@logger
+  end
+
+  module Logging
+    @skip_api_logging = nil
+    class << self; attr_accessor :skip_api_logging; end
+
+    def self.log_fb_api(method, params)
+      message = method # might customize later
+      dump = format_fb_params(params)
+      if block_given?
+        result = nil
+        seconds = Benchmark.realtime { result = yield }
+        log_info(message, dump, seconds) unless skip_api_logging
+        result
+      else
+        log_info(message, dump) unless skip_api_logging
+        nil
+      end
+    rescue Exception => e
+      exception = "#{e.class.name}: #{e.message}: #{dump}"
+      log_info(message, exception)
+      raise
+    end
+
+    def self.format_fb_params(params)
+      params.map { |key,value| "#{key} = #{value}" }.join(', ')
+    end
+
+    def self.log_info(message, dump, seconds = 0)
+      return unless Facebooker.logger
+      log_message = "#{message} (#{seconds}) #{dump}"
+      Facebooker.logger.info(log_message)
+    end
+    
+  end  
+end

data/lib/facebooker/mobile.rb

@@ -0,0 +1,20 @@
+module Facebooker
+  class Mobile
+    def initialize(session)
+      @session = session
+    end
+
+    # Used to determine whether the user identified by "uid" has enabled SMS for this application.
+    def can_send(user)
+      @session.post('facebook.sms.canSend', :uid => User.cast_to_facebook_id(user))
+    end
+
+    # Send the given message to the user.
+    # See http://wiki.developers.facebook.com/index.php/Mobile
+    def send(user, message)
+      @session.post('facebook.sms.send', 
+        {:uid => User.cast_to_facebook_id(user), 
+        :message => message}, false)
+    end
+  end
+end

data/lib/facebooker/mock/service.rb

@@ -0,0 +1,50 @@
+require 'digest/md5'
+require 'facebooker/service'
+
+module Facebooker
+  # A mock service that reads the Facebook response from fixtures
+  # Adapted from http://gist.github.com/44344
+  #
+  #   Facebooker::MockService.fixture_path = 'path/to/dir'
+  #   Facebooker::Session.current = Facebooker::MockSession.create
+  #
+  class MockService < Service
+    class << self
+      attr_accessor :fixture_path
+    end
+
+    def read_fixture(method, filename, original = nil)
+      path = fixture_path(method, filename)
+      File.read path
+    rescue Errno::ENAMETOOLONG
+      read_fixture(method, hash_fixture_name(filename), filename)
+    rescue Errno::ENOENT => e
+      if File.exists?(fixture_path(method, 'default'))
+        File.read fixture_path(method, 'default')
+      else
+        e.message << "\n(Non-hashed path is #{original})" if original
+        e.message << "\nFacebook API Reference: http://wiki.developers.facebook.com/index.php/#{method.sub(/^facebook\./, '')}#Example_Return_XML"
+        raise e
+      end
+    end
+
+    def post(params)
+      method = params.delete(:method)
+      params.delete_if {|k,_| [:v, :api_key, :call_id, :sig].include?(k) }
+      Parser.parse(method, read_fixture(method, fixture_name(params)))
+    end
+
+  private
+    def fixture_path(method, filename)
+      File.join(self.class.fixture_path, method, "#{filename}.xml")
+    end
+
+    def hash_fixture_name(filename)
+      Digest::MD5.hexdigest(filename)
+    end
+
+    def fixture_name(params)
+      params.map {|*args| args.join('=') }.sort.join('&')
+    end
+  end
+end