faceb 0.1.0

data/lib/faceb/base.rb

@@ -0,0 +1,51 @@
+module FaceB
+  class << self
+    ##
+    # Return the current Facebook session
+    # 
+    # @return [FaceB::Session] The current facebook session
+    def current_session
+      Session.current
+    end
+    
+    ##
+    # Create a new Facebook session
+    # 
+    # @param [String] api_key The Facebook application api key
+    # @param [String] secret_key The Facebook application secret key
+    # @param [String] session_key The session key of a Facebook user
+    # 
+    # @return [FaceB::Session] The new current facebook session
+    # 
+    # @example Create a new session
+    #   FaceB.new('api-key', 'secret-key')
+    # @example Create a new session with a specific session key
+    #   FaceB.new('api-key', 'secret-key', 'session-key')
+    # 
+    # @see FaceB::Session.create
+    def new(api_key = nil, secret_key = nil, session_key = nil)
+      Session.create(api_key, secret_key, session_key)
+    end
+    
+    ##
+    # Call a Facebook API method
+    # 
+    # @param [String] api_key The Facebook application api key
+    # @param [String] secret_key The Facebook application secret key
+    # @param [String] method The API method to call
+    # @param [Hash] params Params to pass to API method call (see FaceB::Api#call)
+    # 
+    # @return [FaceB::Api::Response] The API method response
+    # 
+    # @example Call a method
+    #   FaceB.call('api-key', 'secret-key', 'method.name', :key1 => 'value1')
+    # @example Call a method with a specific
+    #   FaceB.call('api-key', 'secret-key', 'method.name', :key1 => 'value1', :secret_key => 'session-key')
+    # 
+    # @see FaceB::Api#call
+    # @see FaceB::Session#call
+    def call(api_key, secret_key, method, params = {})
+      Session.new(api_key, secret_key).call(method, params)
+    end
+  end
+end

data/lib/faceb/rails.rb

@@ -0,0 +1,12 @@
+if Rails.version >= "3.0"
+  require 'faceb/rails/railtie'
+  require 'faceb/rails/generators'
+elsif Rails.version >= "2.3"
+  require 'faceb/rails/rails_23_init'
+else
+  raise "Sorry, but FaceB needs Rails 2.3 or later"
+end
+
+require 'faceb/rails/base'
+require 'faceb/rails/api'
+require 'faceb/rails/controller'

data/lib/faceb/rails/api.rb

@@ -0,0 +1,21 @@
+module FaceB
+  Api.class_eval do
+    def call_with_rails(method, params = {})
+      ActiveSupport::Notifications.instrument("faceb.api", :method => method, :params => params) do
+        call_without_rails(method, params)
+      end
+    end
+
+    alias_method :call_without_rails, :call
+    alias_method :call, :call_with_rails
+  end
+  
+  class LogSubscriber < Rails::LogSubscriber
+    def api(event)
+      debug color("FaceB call method '#{event.payload[:method]}' with #{event.payload[:params].inspect} in (#{event.duration})", :blue, true)
+    end
+  end
+end
+
+# Add log for API method call
+Rails::LogSubscriber.add :faceb, FaceB::LogSubscriber.new

data/lib/faceb/rails/base.rb

@@ -0,0 +1,30 @@
+require 'faceb/rails/configuration'
+
+module FaceB
+  class << self
+    
+    ##
+    # Return FaceB config file path
+    # 
+    # @return [String] config file path
+    def config_file_path
+      File.join(::Rails.root, 'config', 'faceb.yml')
+    end
+    
+    ##
+    # Return the current Facebook Rails configuration
+    # 
+    # @return [FaceB::Configuration] the current Facebook Rails configuration
+    def config
+      FaceB::Configuration.config
+    end    
+    
+    # Change method signature with default api_key and secret_key
+    def new_with_rails(api_key = FaceB.config.api_key, secret_key = FaceB.config.secret_key, session_key = nil)
+      new_without_rails(api_key, secret_key, session_key)
+    end
+    
+    alias_method :new_without_rails, :new
+    alias_method :new, :new_with_rails
+  end
+end

data/lib/faceb/rails/configuration.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module FaceB
+  class Configuration
+    def initialize(config)
+      @config = config
+    end
+    
+    def method_missing(name, *args)
+      @config[name.to_s]
+    end
+    
+    
+    ##
+    # Load a config file to create a new instance of Configuration
+    # 
+    # @param [String] file File path
+    # @param [String] environment The Rails environment
+    def self.load_config_file(file, environment)
+      @config = self.new(YAML.load_file(file)[environment])
+    end
+    
+    ##
+    # Return the current configuration instance
+    # 
+    # @return [FaceB::Configuration] The current configuration instance
+    def self.config
+      @config
+    end
+  end
+end

data/lib/faceb/rails/controller.rb

@@ -0,0 +1,49 @@
+module FaceB
+  module Rails
+    module Controller
+      
+      def self.included(controller)
+        controller.extend(ClassMethods)
+        controller.before_filter :set_facebook_request_format
+        controller.helper_method :facebook_session
+      end
+      
+      def facebook_session
+        FaceB::Session.current
+      end
+      
+      def create_facebook_session
+        FaceB::Session.create(FaceB.config.api_key, FaceB.config.secret_key, env['facebook.session_key'])
+      end
+      
+      def ensure_authenticated_to_facebook
+        create_facebook_session
+      end
+      
+      # Return true if request comes from a Facebook canvas
+      def in_canvas?
+        !!env['facebook.in_canvas']
+      end
+      
+      # Return true if request comes from a Facebook iframe
+      def in_iframe?
+        !!env["facebook.in_iframe"]
+      end
+      
+      # Set the request format 
+      def set_facebook_request_format
+        if in_canvas? && !in_iframe?
+          request.format = :fbml
+        end
+      end
+      
+      # Class methods
+      module ClassMethods
+        def ensure_authenticated_to_facebook(options = {})
+          before_filter :ensure_authenticated_to_facebook, options
+        end
+      end
+    end
+  end
+end
+

data/lib/faceb/rails/generators.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + '/generators/**/*_generator.rb'].each { |generator| 
+  require generator
+}

data/lib/faceb/rails/generators/config/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create The FaceB config file.
+
+Example:
+    `rails generate face_b:config`
+    `rails generate face_b:config --api-key="my-api-key" --secret-key="my-secret-key"`
+    `rails generate face_b:config -a my-api-key -s my-secret-key`
+    

data/lib/faceb/rails/generators/config/config_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module FaceB
+  class ConfigGenerator < Rails::Generators::Base
+    class_option :api_key,    :type => :string, :aliases => '-a', :desc => "Facebook API key"
+    class_option :secret_key, :type => :string, :aliases => '-s', :desc => "Facebook secret key"
+    
+    def create_config_file
+      template "faceb.yml", "config/faceb.yml"
+    end
+    
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end

data/lib/faceb/rails/generators/config/templates/faceb.yml

@@ -0,0 +1,6 @@
+development: &DEVELOPMENT
+  api_key: <%= options.api_key %>
+  secret_key: <%= options.secret_key %>
+    
+test: 
+  <<: *DEVELOPMENT

data/lib/faceb/rails/generators/fb_connect/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Create xd_receiver file for Facebook connect.
+
+Example:
+    `rails generate face_b:fb_connect`
+    `rails generate face_b:fb_connect --ssl`
+    

data/lib/faceb/rails/generators/fb_connect/fb_connect_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module FaceB
+  class FbConnectGenerator < Rails::Generators::Base
+    class_option :ssl, :type => :boolean, :desc => "SSL support"
+    
+    def create_xd_receiver_file
+      file = options.ssl ? 'xd_receiver_ssl.html' : 'xd_receiver.html'
+      template file, "public/#{file}"
+    end
+    
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end

data/lib/faceb/rails/generators/fb_connect/templates/xd_receiver.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" >
+<head>
+    <title>Cross-Domain Receiver Page</title>
+</head>
+<body>
+    <script src="http://static.ak.connect.facebook.com/js/api_lib/v0.4/XdCommReceiver.js" type="text/javascript"></script>
+</body>
+</html>

data/lib/faceb/rails/generators/fb_connect/templates/xd_receiver_ssl.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" >
+<head>
+    <title>Cross-Domain Receiver Page</title>
+</head>
+<body>
+    <script src="https://ssl.connect.facebook.com/js/api_lib/v0.4/XdCommReceiver.js" type="text/javascript"></script>
+</body>
+</html>

data/lib/faceb/rails/rails_23_init.rb

@@ -0,0 +1,21 @@
+Rails.configuration.after_initialize do
+  require 'rack/facebook'
+
+  # Load the FaceB config file
+  begin
+    @facebook_config = FaceB::Configuration.load_config_file(FaceB.config_file_path, ::Rails.env)
+  rescue Errno::ENOENT
+    puts "Warning : config/faceb.yml is not present. Maybe you should called rake faceb:init"
+  rescue
+    puts "Error during load FaceB config file."
+  end
+
+  # Load Rack-Facebook as a middleware    
+  Rails.configuration.middleware.use Rack::Facebook, {
+    :application_secret => @facebook_config.secret_key, 
+    :api_key => @facebook_config.api_key
+  }
+  
+  # Registered FBML request type
+  Mime::Type.register "text/html", :fbml
+end

data/lib/faceb/rails/railtie.rb

@@ -0,0 +1,39 @@
+require 'rails'
+require 'faceb'
+require 'rack/facebook'
+
+module FaceB
+  class Railtie < ::Rails::Railtie
+    railtie_name :facebook
+
+    # Load the FaceB config file
+    initializer "faceb.load_config_file" do |app|
+      begin
+        @facebook_config = FaceB::Configuration.load_config_file(FaceB.config_file_path, ::Rails.env)
+      rescue Errno::ENOENT
+        puts "Warning : config/faceb.yml is not present. Maybe you should called ./script/rails generate face_b"
+      rescue
+        puts "Error during load FaceB config file."
+      end
+    end
+    
+    # Load Rack-Facebook as a middleware    
+    initializer "faceb.add_middleware" do |app|
+      app.config.middleware.use Rack::Facebook, {
+        :application_secret => @facebook_config.secret_key, 
+        :api_key => @facebook_config.api_key
+      } if @facebook_config
+    end
+    
+     # Registered FBML request type
+     initializer "faceb.add_fbml_request_type" do |app|
+       Mime::Type.register "text/html", :fbml
+     end
+    
+    # load Facebook Specific tasks
+    rake_tasks do
+      load "faceb/rails/tasks/faceb.tasks"
+      load "faceb/rails/tasks/tunnel.tasks"
+    end
+  end
+end

data/lib/faceb/rails/tasks.rb

@@ -0,0 +1,2 @@
+load 'faceb/rails/tasks/faceb.tasks'
+load 'faceb/rails/tasks/tunnel.tasks'

data/lib/faceb/rails/tasks/faceb.tasks

@@ -0,0 +1,6 @@
+namespace :faceb do
+  desc "Configure environment to use FaceB"
+  task :config => :environment do
+    # Todo config task for Rails 2.3.x
+  end
+end

data/lib/faceb/rails/tasks/tunnel.tasks

@@ -0,0 +1,46 @@
+namespace :faceb do
+  
+  tunnel_ns = namespace :tunnel do 
+    # Courtesy of Christopher Haupt
+    # http://www.BuildingWebApps.com
+    # http://www.LearningRails.com
+    desc "Create a reverse ssh tunnel from a public server to a private development server." 
+    task :start => [ :environment, :config ] do  
+      puts @notification 
+      system @ssh_command
+    end 
+
+    desc "Create a reverse ssh tunnel in the background. Requires ssh keys to be setup." 
+    task :background_start => [ :environment, :config ] do  
+      puts @notification 
+      system "#{@ssh_command} > /dev/null 2>&1 &" 
+    end 
+    
+    # Adapted from Evan Weaver: http://blog.evanweaver.com/articles/2007/07/13/developing-a-facebook-app-locally/ 
+    desc "Check if reverse tunnel is running"
+    task :status => [ :environment, :config ] do
+     if `ssh #{@public_host} -l #{@public_host_username} netstat -an | egrep "tcp.*:#{@public_port}.*LISTEN" | wc`.to_i > 0
+       puts "Seems ok"
+     else
+       puts "Down"
+     end
+    end
+
+    task :config => :environment do
+     facebook_config = File.join(Rails.root, 'config', 'faceb.yml')
+     FACEBOOKER = YAML.load(ERB.new(File.read(facebook_config)).result)[Rails.env]
+     @public_host_username = FACEBOOKER['tunnel']['public_host_username'] 
+     @public_host = FACEBOOKER['tunnel']['public_host'] 
+     @public_port = FACEBOOKER['tunnel']['public_port'] 
+     @local_port = FACEBOOKER['tunnel']['local_port'] 
+     @ssh_port = FACEBOOKER['tunnel']['ssh_port'] || 22
+     @server_alive_interval = FACEBOOKER['tunnel']['server_alive_interval'] || 0
+     @notification = "Starting tunnel #{@public_host}:#{@public_port} to 0.0.0.0:#{@local_port}"
+     @notification << " using SSH port #{@ssh_port}" unless @ssh_port == 22
+     # "GatewayPorts yes" needs to be enabled in the remote's sshd config
+     @ssh_command = %Q[ssh -v -p #{@ssh_port} -nNT4 -o "ServerAliveInterval #{@server_alive_interval}" -R *:#{@public_port}:localhost:#{@local_port} #{@public_host_username}@#{@public_host}]
+    end
+  end  
+  desc "Create a reverse ssh tunnel from a public server to a private development server."
+  task :tunnel => tunnel_ns[:start]
+end

data/lib/faceb/session.rb

@@ -0,0 +1,38 @@
+module FaceB
+  class Session
+    attr_reader :api_key, :secret_key, :session_key, :user_facebook_uid
+    
+    def self.create(api_key, secret_key, session_key = nil)
+      @current_session = self.new(api_key, secret_key, session_key) unless defined?(@current_session) && !!@current_session
+      @current_session
+    end
+    
+    def self.current
+      @current_session
+    end
+    
+    def self.reset!
+      @current_session = nil
+    end
+    
+    def initialize(api_key, secret_key, session_key = nil)
+      @api_key            = api_key
+      @secret_key         = secret_key
+      @session_key        = session_key
+      secure_with_session_key!(session_key) unless !session_key
+    end
+    
+    def call(method, params ={})
+      Api.new(self).call(method, params)
+    end
+    
+    def secure_with_session_key!(session_key)
+      @session_key = session_key
+      @user_facebook_uid = self.call('users.getLoggedInUser', :session_key => session_key).data
+    end
+    
+    def secured?
+      !!@user_facebook_uid
+    end
+  end
+end