fb_rails 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Matthew Higgins]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,70 @@
+= FbRails
+
+FbRails makes it easy to integrate your website with Facebook.
+
+
+== Setting up
+
+Add the following to your configuration. This can go in config/application.rb, or
+customized in each environment in config/environments/[name].rb:
+
+  config.facebook = {
+    :app_id     => 'my_app_id',
+    :secret     => 'my_app_secret'
+  }
+
+or
+
+  config.facebook.app_id = 'my_app_id'
+  config.facebook.secret = 'my_app_secret'
+
+
+== API
+
+FbRails adds an object called 'fb', which is available to all controllers and views:
+
+Determine if the current user is connected through Facebook:
+
+  fb.connected?
+
+Get the Facebook user id for the current user:
+
+  fb.uid
+
+Make a request to the Facebook Graph:
+
+  <% result = fb.graph.get '/me' %>
+  my name is <%= result['first_name'] %>
+
+
+== Persisting the Facebook User:
+
+Websites that interact with Facebook usually have a user model in a local database.
+This user is accessed with 'fb.user':
+
+  The current user is <%= fb.user.inspect %>
+
+For this to work, FbRails assumes there is a model called 'User' with a column 'fb_uid'.
+If your user model name is different than 'User', it can be configured:
+  config.facebook.user_class_name = 'Author'
+
+If the fb_uid for the current user is not in the database, fb.user is an unsaved instance.
+One thing I like to do for new Facebook users is store them in a before filter:
+
+  if fb.connected? && fb.user.new_record?
+    data = fb.graph.get('me')
+    fb.user.first_name = data['first_name']
+    fb.user.last_name = data['last_name']
+    fb.user.save
+  end
+
+
+== Testing
+
+Facebook requests can be mocked, so that your requests do not require real HTTP
+connections. This is done with FbRails::Mock:
+
+  FbRails::Mock.respond_to do |mock|
+    mock.add 'me', 'first_name' => 'Matt', 'last_name' => 'Higgins'
+  end
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test fb_rails.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for fb_rails.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FbRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/fb_rails/config.rb

@@ -0,0 +1,11 @@
+module FbRails
+  class Config
+    class_attribute :app_id, :secret, :user_class_name
+
+    class << self
+      def user_class
+        (user_class_name || 'User').constantize
+      end
+    end
+  end
+end

data/lib/fb_rails/connect.rb

@@ -0,0 +1,56 @@
+require 'digest/md5'
+
+module FbRails
+  class Connect
+    class << self
+      def cookie_name
+        "fbs_#{FbRails::Config.app_id}"
+      end
+    end
+
+    extend ActiveSupport::Memoizable
+
+    attr_reader :cookies
+    def initialize(cookies)
+      @cookies = cookies
+    end
+
+    def cookie
+      return if (cookie_string = cookies[self.class.cookie_name]).blank?
+
+      hash = Rack::Utils::parse_query(cookie_string.gsub(/^\"|\"$/, ''))
+      sorted_pairs = hash.sort
+  
+      payload = ''
+      sorted_pairs.each do |key, value|
+        payload += "#{key}=#{value}" if key != 'sig'
+      end
+  
+      md5 = Digest::MD5.hexdigest("#{payload}#{FbRails::Config.secret}")
+      if md5 == hash['sig']
+        hash
+      end
+    end
+    memoize :cookie
+
+    def connected?
+      cookie.present?
+    end
+
+    def uid
+      connected? ? cookie['uid'].to_i : nil
+    end
+
+    def access_token
+      connected? ? cookie['access_token'] : nil
+    end
+
+    def user
+      if connected?
+        FbRails::Config.user_class.find_or_initialize_by_fb_uid(uid)
+      end
+    end
+    memoize :user
+  end
+end
+  

data/lib/fb_rails/fb.rb

@@ -0,0 +1,20 @@
+module FbRails
+  class Fb
+    delegate :app_id, :secret, :to => 'FbRails::Config'
+    delegate :connected?, :uid, :access_token, :user, :to => :connect
+
+    attr_reader :cookies
+    def initialize(cookies)
+      @cookies = cookies
+    end
+
+    def graph
+      @graph ||= FbRails::Graph.new(connect)
+    end
+
+    private
+      def connect
+        @connect ||= FbRails::Connect.new(cookies)
+      end
+  end
+end

data/lib/fb_rails/graph.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'fb_rails/log_subscriber'
+
+module FbRails
+  class Graph
+    class << self
+      def facebook_uri
+        @facebook_uri ||= URI.parse('https://graph.facebook.com')
+      end
+    end
+
+    attr_reader :connect
+    def initialize(connect)
+      @connect = connect
+    end
+
+    def post(url, params = {})
+      request(:post, url, params)
+    end
+
+    def get(url, params = {})
+      request(:get, url, params)
+    end
+
+    private
+      def request(http_verb, url, params = {})
+        path = build_path(url, params)
+
+        response = ActiveSupport::Notifications.instrument('request.fb_rails') do |payload|
+          payload[:http_verb]   = http_verb
+          payload[:request_uri] = path
+          http.send(http_verb, path)
+        end
+      
+        ActiveSupport::JSON.decode(response.body)
+      end
+
+      def build_path(url, params)
+        params = params.merge(:access_token => connect.access_token)
+        param_string = params.map { |key, value| "#{key}=#{CGI.escape(value)}" }.join('&')
+        url = "#{url}?#{param_string}"
+      end
+
+      def http
+        Net::HTTP.new(self.class.facebook_uri.host, self.class.facebook_uri.port).tap do |result|
+          result.use_ssl = true
+          result.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+  end
+end

data/lib/fb_rails/integration/action_controller.rb

@@ -0,0 +1,16 @@
+module FbRails
+  module Integration
+    module ActionController
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :fb
+      end
+
+      private
+        def fb
+          @fb ||= ::FbRails::Fb.new(cookies)
+        end
+    end
+  end
+end

data/lib/fb_rails/integration/action_view.rb

@@ -0,0 +1,9 @@
+module FbRails
+  module Integration
+    module ActionView
+      def fbml(tag, options = nil)
+        content_tag("fb:#{tag}", '', options)
+      end
+    end
+  end
+end

data/lib/fb_rails/integration.rb

@@ -0,0 +1,8 @@
+module FbRails
+  module Integration
+    extend ActiveSupport::Autoload
+
+    autoload :ActionController
+    autoload :ActionView
+  end
+end

data/lib/fb_rails/log_subscriber.rb

@@ -0,0 +1,14 @@
+module FbRails
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def request(event)
+      name = color('FbRails (%.1fms)' % event.duration, CYAN, true)
+      info "  #{name}  #{event.payload[:http_verb].to_s.upcase} #{event.payload[:request_uri]}"
+    end
+
+    def logger
+      Rails.logger
+    end
+  end
+end
+
+FbRails::LogSubscriber.attach_to :fb_rails

data/lib/fb_rails/mock.rb

@@ -0,0 +1,55 @@
+module FbRails
+  class Mock
+    class Response
+      attr_reader :body
+      def initialize(data)
+        @body = data.to_json
+      end
+    end
+
+    class Responder
+      attr_reader :responses
+      def initialize(responses)
+        @responses = responses
+      end
+
+      def add(path, data)
+        responses[path] = Response.new(data)
+      end
+    end
+
+    class << self
+      def responses
+        @@responses ||= {}
+      end
+
+      def respond_to
+        yield Responder.new(responses)
+      end
+
+      def reset!
+        responses.clear
+      end
+
+      def find_response(path)
+        path = path.gsub(/\?.*$/, '')
+        responses[path]
+      end
+    end
+
+    %w(get post).each do |method|
+      module_eval <<-EOE, __FILE__, __LINE__ + 1
+        def #{method}(path)
+          self.class.find_response(path)
+        end
+      EOE
+    end
+  end
+
+  class Graph
+    private
+      def http
+        @http ||= Mock.new
+      end
+  end
+end

data/lib/fb_rails/railtie.rb

@@ -0,0 +1,23 @@
+module FbRails
+  class Railtie < Rails::Railtie
+    config.facebook = ActiveSupport::OrderedOptions.new
+
+    initializer "fb_rails.set_configs" do |app|
+      ActiveSupport.on_load :action_controller do
+        app.config.facebook.each do |k,v|
+          ::FbRails::Config.send "#{k}=", v
+        end
+      end
+    end
+
+    initializer "fb_rails.integration" do
+      ActiveSupport.on_load :action_controller do
+        include ::FbRails::Integration::ActionController
+      end
+
+      ActiveSupport.on_load :action_view do
+        include ::FbRails::Integration::ActionView
+      end
+    end
+  end
+end

data/lib/fb_rails.rb

@@ -0,0 +1,19 @@
+module FbRails
+  extend ActiveSupport::Autoload
+
+  autoload :Config
+  autoload :Connect
+  autoload :Graph
+  autoload :Fb
+  autoload :Mock
+  autoload :Integration
+
+  def self.cookie(uid = 42, access_token = 'abc')
+    param_string = "uid=#{uid}&access_token=#{access_token}"
+    payload = "access_token=#{access_token}uid=#{uid}"
+    sig = Digest::MD5.hexdigest("#{payload}#{FbRails::Config.secret}")
+    {FbRails::Connect.cookie_name => "\"#{param_string}&sig=#{sig}\""}
+  end
+end
+
+require 'fb_rails/railtie'

data/test/config_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FbRails::ConfigTest < ActiveSupport::TestCase
+  test 'user_class' do
+    assert_equal User, FbRails::Config.user_class
+  end
+end

data/test/connect_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class FbRails::ConnectTest < ActiveSupport::TestCase
+  test 'empty cookie' do
+    fb_connect = FbRails::Connect.new({})
+
+    assert !fb_connect.connected?
+    assert_nil fb_connect.user
+    assert_nil fb_connect.uid
+    assert_nil fb_connect.access_token
+  end
+
+  test 'invalid signature' do
+    cookies = {FbRails::Connect.cookie_name => "\"uid=42&sig=invalid\""}
+    fb_connect = FbRails::Connect.new(cookies)
+
+    assert !fb_connect.connected?
+    assert_nil fb_connect.user
+  end
+
+  test 'valid cookie' do
+    fb_connect = FbRails::Connect.new(FbRails.cookie)
+
+    assert fb_connect.connected?
+    assert_equal 42, fb_connect.uid
+    assert_equal 'abc', fb_connect.access_token.to_s
+    assert_not_nil fb_connect.user
+    assert_equal 42, fb_connect.user.fb_uid
+  end
+end

data/test/fb_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class FbRails::FbTest < ActiveSupport::TestCase
+  test 'configuration' do
+    fb = FbRails::Fb.new({})
+
+    assert_equal FbRails::Config.app_id, fb.app_id
+    assert_equal FbRails::Config.secret, fb.secret
+  end
+
+  test 'connect delegation' do
+    fb = FbRails::Fb.new(FbRails.cookie)
+
+    assert fb.respond_to?(:connected?)
+    assert fb.respond_to?(:uid)
+    assert fb.respond_to?(:access_token)
+    assert fb.respond_to?(:user)
+  end
+
+  test 'graph' do
+    fb = FbRails::Fb.new({})
+
+    assert_kind_of FbRails::Graph, fb.graph
+    assert_equal fb.graph.object_id, fb.graph.object_id    
+  end
+end

data/test/graph_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class FbRails::GraphTest < ActiveSupport::TestCase
+end

data/test/helpers/action_controller_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+# 
+class FbRails::ActionControllerTest < ActionController::TestCase
+end

data/test/log_subscriber_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'active_support/log_subscriber/test_helper'
+require 'fb_rails/log_subscriber'
+
+class FbRails::LogSubscriberTest < ActiveSupport::TestCase
+  include ActiveSupport::LogSubscriber::TestHelper
+
+  setup do
+    FbRails::Mock.respond_to do |mock|
+      mock.add 'test', 'foo' => 'bar'
+    end
+  end
+  
+  def set_logger(logger)
+    # raise 'set logger'
+    Rails.logger = logger
+  end
+
+  test 'request notification' do
+    graph = FbRails::Graph.new(FbRails::Connect.new(FbRails.cookie))
+    graph.get 'test'
+
+    wait
+    assert_equal 1, @logger.logged(:info).size
+  end
+end

data/test/mock_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class FbRails::MockTest < ActiveSupport::TestCase
+  setup do
+    FbRails::Mock.respond_to do |mock|
+      mock.add 'test', 'foo' => 'bar'
+    end
+  end
+
+  test 'mock' do
+    graph = FbRails::Graph.new(FbRails::Connect.new(FbRails.cookie))
+
+    result = graph.get 'test'
+
+    assert_equal({'foo' => 'bar'}, result)
+  end
+end

data/test/sample/test_controller.rb

@@ -0,0 +1,4 @@
+module Sample
+  class TestController < ActionController::Base
+  end
+end

data/test/sample/user.rb

@@ -0,0 +1,10 @@
+class User
+  def self.find_or_initialize_by_fb_uid(fb_uid)
+    new(fb_uid)
+  end
+
+  attr_accessor :fb_uid
+  def initialize(fb_uid = 42)
+    @fb_uid = fb_uid
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'rails/all'
+
+require 'fb_rails'
+
+require 'sample/user'
+require 'sample/test_controller'
+
+FbRails::Config.app_id = 'foo'
+FbRails::Config.secret = 'bar'
+
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: fb_rails
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Higgins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id001
+description: A Rails 3 gem for the latest facebook API
+email: developer@matthewhiggins.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- lib/fb_rails/config.rb
+- lib/fb_rails/connect.rb
+- lib/fb_rails/fb.rb
+- lib/fb_rails/graph.rb
+- lib/fb_rails/integration/action_controller.rb
+- lib/fb_rails/integration/action_view.rb
+- lib/fb_rails/integration.rb
+- lib/fb_rails/log_subscriber.rb
+- lib/fb_rails/mock.rb
+- lib/fb_rails/railtie.rb
+- lib/fb_rails.rb
+- test/config_test.rb
+- test/connect_test.rb
+- test/fb_test.rb
+- test/graph_test.rb
+- test/helpers/action_controller_test.rb
+- test/log_subscriber_test.rb
+- test/mock_test.rb
+- test/sample/test_controller.rb
+- test/sample/user.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://gotime.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Facebook on Rails
+test_files: []
+