netshade-facebooker 1.0.6

data/lib/facebooker/adapters/adapter_base.rb

@@ -0,0 +1,87 @@
+module Facebooker
+
+  class AdapterBase
+    class UnableToLoadAdapter < Exception; end
+    require 'active_support/inflector'
+    include  ActiveSupport::CoreExtensions::String::Inflections
+    def facebook_path_prefix
+      "/" + (@facebook_path_prefix || canvas_page_name || ENV['FACEBOOK_CANVAS_PATH'] || ENV['FACEBOOKER_RELATIVE_URL_ROOT'])
+    end
+
+    def facebook_path_prefix=(prefix)
+      @facebook_path_prefix = prefix
+    end
+
+    def  facebooker_config
+      @config
+    end
+
+    def api_server_base_url
+      "http://" + api_server_base
+    end
+
+    def is_for?(application_context)
+      raise "SubClassShouldDefine"
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def  self.facebooker_config
+      Facebooker.facebooker_config
+    end
+
+
+    def self.load_adapter(params)
+
+      config_key_base = params[:config_key_base] # This allows for loading of a aspecific adapter
+      config_key_base += "_" unless config_key_base.blank?
+
+      unless api_key = (params[:fb_sig_api_key] || facebooker_config["#{config_key_base}api_key"])
+        raise Facebooker::AdapterBase::UnableToLoadAdapter
+      end
+
+      unless facebooker_config
+        return self.default_adapter(params)
+      end
+
+      facebooker_config.each do |key,value|
+        next unless value == api_key
+
+        key_base = key.match(/(.*)[_]?api_key/)[1]
+
+        adapter_class_name = if key_base.blank?
+           "FacebookAdapter"
+        else
+          facebooker_config[key_base + "adapter"]
+        end
+
+        adapter_class = "Facebooker::#{adapter_class_name}".constantize
+
+        # Collect the rest of the configuration
+        adapter_config = {}
+        facebooker_config.each do |key,value|
+          if (match = key.match(/#{key_base}[_]?(.*)/))
+            adapter_config[match[1]] = value
+          end
+        end
+        return adapter_class.new(adapter_config)
+      end
+    end
+
+    def self.default_adapter(params = {})
+      if facebooker_config.nil? || (facebooker_config.blank? rescue nil)
+        config = { "api_key" => ENV['FACEBOOK_API_KEY'], "secret_key" =>  ENV['FACEBOOK_SECRET_KEY']}
+      else
+        config = facebooker_config
+      end
+     FacebookAdapter.new(config)
+    end
+
+    [:canvas_page_name, :api_key,:secret_key].each do |key_method|
+      define_method(key_method){ return facebooker_config[key_method.to_s]}
+    end
+
+  end
+end

data/lib/facebooker/adapters/bebo_adapter.rb

@@ -0,0 +1,75 @@
+module Facebooker
+  class BeboAdapter < AdapterBase
+      
+    def canvas_server_base
+      "apps.bebo.com"
+    end
+      
+    def api_server_base
+      'apps.bebo.com'
+    end
+    
+    def api_rest_path
+      "/restserver.php"
+    end
+      
+    def is_for?(application_context)
+      application_context == :bebo
+    end
+       
+    def www_server_base_url
+      "www.bebo.com"
+    end
+
+       
+    def login_url_base
+      "http://#{www_server_base_url}/SignIn.jsp?ApiKey=#{api_key}&v=1.0"
+    end
+
+    def install_url_base
+      "http://#{www_server_base_url}/c/apps/add?ApiKey=#{api_key}&v=1.0"
+    end
+  end
+end
+
+# Things that don't actually work as expected in BEBO
+Facebooker::PublishTemplatizedAction
+module Facebooker
+   class User
+    def set_profile_fbml_with_bebo_adapter(profile_fbml, mobile_fbml, profile_action_fbml, profile_main = nil)
+      if(Facebooker.is_for?(:bebo))
+        self.session.post('facebook.profile.setFBML', :uid => @id, :markup => profile_fbml)
+      else
+        set_profile_fbml_without_bebo_adapter(profile_fbml,mobile_fbml, profile_action_fbml, profile_main)
+      end
+    end
+    alias_method :set_profile_fbml_without_bebo_adapter, :set_profile_fbml
+    alias_method :set_profile_fbml, :set_profile_fbml_with_bebo_adapter
+    
+    private
+    
+    BEBO_FIELDS = FIELDS - [:meeting_sex, :wall_count, :meeting_for]
+    def collect(fields)
+      if(Facebooker.is_for?(:bebo) )
+         BEBO_FIELDS.reject{|field_name| !fields.empty? && !fields.include?(field_name)}.join(',')
+      else
+         FIELDS.reject{|field_name| !fields.empty? && !fields.include?(field_name)}.join(',')
+      end
+    end   
+  end
+  
+  
+   class PublishTemplatizedAction < Parser#:nodoc:
+    class <<self
+     def process_with_bebo_adapter(data)
+       if(Facebooker.is_for?(:bebo))
+       element('feed_publishTemplatizedAction_response', data).text_value
+       else
+         process_without_bebo_adapter(data)
+       end
+      end
+      alias_method :process_without_bebo_adapter, :process
+      alias_method :process, :process_with_bebo_adapter
+    end
+  end
+end

data/lib/facebooker/adapters/facebook_adapter.rb

@@ -0,0 +1,48 @@
+module Facebooker
+  
+   
+  class FacebookAdapter < AdapterBase
+      
+    def canvas_server_base
+      "apps.facebook.com"
+    end
+      
+    def api_server_base
+       "api.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
+    
+  end
+  
+end
+
+

data/lib/facebooker/admin.rb

@@ -0,0 +1,28 @@
+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 = JSON.parse(CGI.unescapeHTML(json))
+      @properties = ApplicationProperties.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/batch_request.rb

@@ -0,0 +1,44 @@
+module Facebooker
+  class BatchRequest
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^respond_to\?$|^new$)/ }
+    attr_reader :uri
+    attr_reader :method
+    class UnexecutedRequest < StandardError; end
+    def initialize(params,proc)
+      @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,51 @@
+require 'benchmark'
+module Facebooker
+  @@logger = nil
+  def self.logger=(logger)
+    @@logger = logger
+  end
+  def self.logger
+    @@logger
+  end
+
+  module Logging
+    
+    def self.skip_api_logging=(val)
+      @skip_api_logging=val
+    end
+    
+    def self.skip_api_logging
+      @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.debug(log_message)
+    end
+    
+  end  
+end