rplatform-rails 0.0.2

data/test/initialization_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "test/unit"
+require "rubygems"
+require "mocha"
+require 'application_controller'
+
+class InitializationTest < Test::Unit::TestCase
+  
+  def setup
+    @controller = DummyController.new
+  end
+  
+  def test_yml_loaded_properly
+    assert FACEBOOK["key"]
+    assert FACEBOOK["secret"]
+  end
+  
+  def test_controller_paths_for_canvas_apps_are_relative
+    if FACEBOOK["canvas_path"]
+      assert(/^\/(.*)\/$/.match(@controller.facebook_canvas_path), "canvas_path should be relative (check your facebook.yml)")
+    end
+    
+    if FACEBOOK["callback_path"]
+      assert(/^\/(.*)\/$/.match(@controller.facebook_callback_path), "callback_path should be relative (check your facebook.yml)")
+    end
+  end
+    
+end
+

data/test/model_test.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "test/unit"
+require "rubygems"
+require "mocha"
+
+class ModelTest < Test::Unit::TestCase
+    
+  def test_acts_as_facebook_user_is_present
+    assert @model.class.respond_to?(:acts_as_facebook_user)
+  end
+  
+  def test_facebook_extensions_are_present
+    assert @model.respond_to?(:facebook_api_key)
+    assert @model.respond_to?(:facebook_api_secret)
+    assert @model.respond_to?(:facebook_session)
+    assert @model.respond_to?(:facebook_session=)
+    
+    RFacebook::Rails::ModelExtensions::ActsAsFacebookUser::FIELDS.each do |field|
+      assert @model.respond_to?(field), "Any model that acts_as_facebook_user should respond to '#{field}'"
+    end
+    
+    assert @model.class.respond_to?(:find_or_create_by_facebook_session)
+  end
+  
+  def test_facebook_properties_dispatched_to_internal_session
+    
+    # allow session to be used
+    @model.facebook_session.expects(:ready?).at_least_once.returns(true)
+    @model.facebook_session.expects(:post_request).at_least_once.returns @dummy_users_getInfo_response
+    
+    # try a bunch of fields
+    assert_equal "http://photos-055.facebook.com/ip007/profile3/1271/65/s8055_39735.jpg", @model.pic, "Pic URL should be consistent with the facebook.users.getInfo response XML"
+    assert_equal "November 3", @model.birthday, "Birthday should be consistent with the facebook.users.getInfo response XML"
+    assert_equal "The Brothers K, GEB, Ken Wilber, Zen and the Art, Fitzgerald, The Emporer's New Mind, The Wonderful Story of Henry Sugar", @model.books, "Books should be consistent with the facebook.users.getInfo response XML"
+    assert_equal "Dave", @model.first_name, "First name should be consistent with the facebook.users.getInfo response XML"
+  end
+  
+  
+  def setup
+    @model = DummyModel.allocate # TODO: how do we properly test model instances that don't have database backing?
+    
+    @dummy_users_getInfo_response = <<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <users_getInfo_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true">
+        <user>
+          <uid>8055</uid>
+          <about_me>This field perpetuates the glorification of the ego.  Also, it has a character limit.</about_me>
+          <activities>Here: facebook, etc. There: Glee Club, a capella, teaching.</activities>
+          <affiliations list="true">
+            <affiliation>
+              <nid>50453093</nid>
+              <name>Facebook Developers</name>
+              <type>work</type>
+              <status/>
+              <year/>
+            </affiliation>
+          </affiliations> 
+          <birthday>November 3</birthday>
+          <books>The Brothers K, GEB, Ken Wilber, Zen and the Art, Fitzgerald, The Emporer's New Mind, The Wonderful Story of Henry Sugar</books>
+          <current_location>
+            <city>Palo Alto</city>
+            <state>CA</state>
+            <country>United States</country>
+            <zip>94303</zip>
+          </current_location>
+          <education_history list="true">
+            <education_info>
+              <name>Harvard</name>
+              <year>2003</year>
+              <concentrations list="true">
+                <concentration>Applied Mathematics</concentration>
+                <concentration>Computer Science</concentration>
+              </concentrations>
+            </education_info>
+          </education_history>
+          <first_name>Dave</first_name>
+           <hometown_location>
+             <city>York</city>
+             <state>PA</state>
+             <country>United States</country>
+             <zip>0</zip>
+           </hometown_location>
+           <hs_info>
+             <hs1_name>Central York High School</hs1_name>
+             <hs2_name/>
+             <grad_year>1999</grad_year>
+             <hs1_id>21846</hs1_id>
+             <hs2_id>0</hs2_id>
+           </hs_info>
+           <is_app_user>1</is_app_user>
+           <has_added_app>1</has_added_app>
+           <interests>coffee, computers, the funny, architecture, code breaking,snowboarding, philosophy, soccer, talking to strangers</interests>
+           <last_name>Fetterman</last_name>
+           <meeting_for list="true">
+             <seeking>Friendship</seeking>
+           </meeting_for>
+           <meeting_sex list="true">
+             <sex>female</sex>
+           </meeting_sex>
+           <movies>Tommy Boy, Billy Madison, Fight Club, Dirty Work, Meet the Parents, My Blue Heaven, Office Space </movies>
+           <music>New Found Glory, Daft Punk, Weezer, The Crystal Method, Rage, the KLF, Green Day, Live, Coldplay, Panic at the Disco, Family Force 5</music>
+           <name>Dave Fetterman</name>
+           <notes_count>0</notes_count>
+           <pic>http://photos-055.facebook.com/ip007/profile3/1271/65/s8055_39735.jpg</pic>
+           <pic_big>http://photos-055.facebook.com/ip007/profile3/1271/65/n8055_39735.jpg</pic>
+           <pic_small>http://photos-055.facebook.com/ip007/profile3/1271/65/t8055_39735.jpg</pic>
+           <pic_square>http://photos-055.facebook.com/ip007/profile3/1271/65/q8055_39735.jpg</pic>
+           <political>Moderate</political>
+           <profile_update_time>1170414620</profile_update_time>
+           <quotes/>
+           <relationship_status>In a Relationship</relationship_status>
+           <religion/>
+           <sex>male</sex>
+           <significant_other_id xsi:nil="true"/>
+           <status>
+             <message/>
+             <time>0</time>
+           </status>
+           <timezone>-8</timezone>
+           <tv>cf. Bob Trahan</tv>
+           <wall_count>121</wall_count>
+           <work_history list="true">
+             <work_info>
+               <location>
+                 <city>Palo Alto</city>
+                 <state>CA</state>
+                 <country>United States</country>
+               </location>
+               <company_name>Facebook</company_name>
+               <position>Software Engineer</position>
+               <description>Tech Lead, Facebook Platform</description>
+               <start_date>2006-01</start_date>
+               <end_date/>
+              </work_info>
+           </work_history>
+         </user>
+      </users_getInfo_response>
+    EOF
+  end
+    
+end
+

data/test/session_test.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "test/unit"
+require "rubygems"
+require "mocha"
+
+class SessionTest < Test::Unit::TestCase
+  
+  def setup
+    @controller = DummyController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    
+    @cgi_session_placeholder = CGI::Session.allocate
+    
+    # RFacebook extends a certain subset of Rails session stores,
+    # so we must test them each individually
+    @sessionStoresToTest = [
+      CGI::Session::PStore,
+      CGI::Session::ActiveRecordStore,
+      CGI::Session::DRbStore,
+      CGI::Session::FileStore,
+      CGI::Session::MemoryStore
+    ]
+    
+    begin
+      # optionally check MemCacheStore (only if memcache-client is installed)
+      @sessionStoresToTest << CGI::Session::MemCacheStore
+    rescue Exception => e
+    end
+    
+  end
+  
+  def test_cgi_session_helpers_are_present
+    @cgi_session_placeholder.respond_to?(:force_to_be_new!, true)
+    @cgi_session_placeholder.respond_to?(:using_facebook_session_id?, true)
+  end
+  
+  def test_cgi_session_overrides_are_present    
+    assert_rfacebook_overrides_method(@cgi_session_placeholder, :initialize)
+    assert_rfacebook_overrides_method(@cgi_session_placeholder, :new_session)    
+  end
+  
+  def test_session_store_overrides_are_present
+    # assert that each of the extended stores has the special RFacebook overrides
+    # that enable session storage when inside the canvas
+    @sessionStoresToTest.each do |storeKlass|
+      assert_rfacebook_overrides_method(storeKlass.allocate, :initialize)
+    end
+  end
+  
+  def test_cgi_session_grabs_fb_sig_session_key
+    # TODO: implement test
+  end
+  
+  def test_session_store_uses_overridden_init_method_when_in_canvas
+    # TODO: implement test
+  end
+  
+  def test_session_store_uses_original_init_method_when_not_in_canvas
+    # TODO: implement test
+  end
+  
+end
+

data/test/test_helper.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+require "action_controller/test_process"
+require "action_controller/integration"
+
+# helpers for all RFacebook unit tests
+class Test::Unit::TestCase
+  
+  def assert_rfacebook_overrides_method(object, methodSymbol)
+    # by convention, RFacebook uses the alias_method_chain on certain methods
+    rfacebookMethodSymbol = "#{methodSymbol}_with_rfacebook".to_sym
+    aliasedMethodSymbol = "#{methodSymbol}_without_rfacebook".to_sym
+    
+    # string description of this object
+    objectDescription = object.is_a?(Class) ? object.to_s : object.class.to_s
+    
+    # ensure that the original method is still available
+    assert object.respond_to?(aliasedMethodSymbol, true), "Could not find original #{objectDescription}::#{methodSymbol}"
+    
+    # ensure that the object has the RFacebook override
+    assert object.respond_to?(rfacebookMethodSymbol, true), "Could not find RFacebook override of #{objectDescription}::#{methodSymbol}"
+    
+    # ensure that the override is actually overriding the given method
+    assert object.method(methodSymbol) == object.method(rfacebookMethodSymbol), "#{objectDescription}::#{methodSymbol} does not appear to be overridden by RFacebook"
+  end
+  
+end
+
+# dummy controller used in many test cases
+class DummyController < ActionController::Base
+  
+  before_filter :require_facebook_login, :only => [:index]
+  
+  # actions
+  def index
+    render :text => "viewing index"
+  end
+    
+  def nofilter
+    render :text => "no filter needed"
+  end
+  
+  def shouldbeinstalled
+    if require_facebook_install
+      render :text => "app is installed"
+    end
+  end
+  
+  def doredirect
+    redirect_to params[:redirect_url]
+  end
+  
+  def render_foobar_action_on_callback
+    render :text => url_for("#{facebook_callback_path}foobar")
+  end
+  
+  
+  # utility methods
+  
+  def rescue_action(e) 
+    raise e 
+  end
+  
+  
+  def stub_fbparams(overriddenOptions={})
+    self.stubs(:fbparams).returns({
+      "session_key" => "12345",
+      "user" => "9876",
+      "expires" => Time.now.to_i*2, # timeout long in the future
+      "time" => Time.now.to_i*2, # timeout long in the future
+    }.merge(overriddenOptions))
+  end
+    
+  def simulate_inside_canvas(moreParams={})
+    self.stub_fbparams({"in_canvas"=>"1"})
+    @extra_params = {"fb_sig_in_canvas"=>"1"}.merge(moreParams)
+  end
+  
+  def params
+    if @extra_params
+      (super || {}).merge(@extra_params)
+    else
+      super
+    end
+  end
+  
+  # for external apps
+  def finish_facebook_login
+    render :text => "finished facebook login"
+  end
+  
+end
+
+# dummy model used in a few test cases
+class DummyModel < ActiveRecord::Base
+  acts_as_facebook_user
+  
+  def facebook_uid
+    "dummyuid"
+  end
+  
+  def facebook_session_key
+    "dummysessionkey"
+  end
+end
+

data/test/view_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + "/test_helper"
+require "test/unit"
+require "rubygems"
+require "mocha"
+
+class ViewTest < Test::Unit::TestCase
+  
+  def test_extensions_are_present
+    assert @view.respond_to?(:in_facebook_canvas?)
+    assert @view.respond_to?(:in_facebook_frame?)
+    assert @view.respond_to?(:in_mock_ajax?)
+    assert @view.respond_to?(:fbparams)
+    assert @view.respond_to?(:fbsession)
+    assert @view.respond_to?(:image_path)
+    assert @view.respond_to?(:facebook_debug_panel)
+  end
+
+  def test_image_path_should_not_rewrite_absolute_urls
+    # TODO: implement test
+  end
+  
+  def setup
+    @controller = DummyController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @view = ActionView::Base.allocate # TODO: how do we unit test views in Rails?
+  end
+    
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: rplatform-rails
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Curtis Edmond
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+    version: 
+description: ""
+email: curtis.edmond@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- CHANGELOG
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- init.rb
+- lib/rplatform-rails.rb
+- lib/rplatform_rails/controller_extensions.rb
+- lib/rplatform_rails/model_extensions.rb
+- lib/rplatform_rails/session_extensions.rb
+- lib/rplatform_rails/status_manager.rb
+- lib/rplatform_rails/view_extensions.rb
+- tasks/all.rake
+- templates/debug_panel.rhtml
+- templates/exception_backtrace.rhtml
+- test/api_test.rb
+- test/controller_test.rb
+- test/initialization_test.rb
+- test/model_test.rb
+- test/session_test.rb
+- test/test_helper.rb
+- test/view_test.rb
+has_rdoc: true
+homepage: http://rplatform.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rplatform
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A rails interface for Facebook's Platform API
+test_files: 
+- test/api_test.rb
+- test/controller_test.rb
+- test/initialization_test.rb
+- test/model_test.rb
+- test/session_test.rb
+- test/test_helper.rb
+- test/view_test.rb