rfacebook 0.9.7 → 0.9.8

data/lib/facebook_web_session.rb

@@ -32,22 +32,14 @@ require "facebook_session"
 module RFacebook
 
   class FacebookWebSession < FacebookSession
-    
-    ################################################################################################
-    ################################################################################################
-    # :section: URL Accessors
-    ################################################################################################
-    
-    # Function: get_login_url
-    #   Gets the authentication URL
+        
+    # Gets the authentication URL for this application
     #
-    # Parameters:
-    #   options.next          - the page to redirect to after login
-    #   options.popup         - boolean, whether or not to use the popup style (defaults to false)
-    #   options.skipcookie    - boolean, whether to force new Facebook login (defaults to false)
-    #   options.hidecheckbox  - boolean, whether to show the "infinite session" option checkbox
+    # options.next::          the page to redirect to after login
+    # options.popup::         boolean, whether or not to use the popup style (defaults to false)
+    # options.skipcookie::    boolean, whether to force new Facebook login (defaults to false)
+    # options.hidecheckbox::  boolean, whether to show the "infinite session" option checkbox
     def get_login_url(options={})
-
       # handle options
       nextPage = options[:next] ||= nil
       popup = (options[:popup] == nil) ? false : true
@@ -65,17 +57,13 @@ module RFacebook
       optionalCanvas = (canvas == true) ? "&canvas=true" : ""
     
       # build and return URL
-      return "http://#{WWW_SERVER_BASE_URL}#{WWW_PATH_LOGIN}?v=1.0&api_key=#{@api_key}#{optionalPopup}#{optionalNext}#{optionalSkipCookie}#{optionalHideCheckbox}#{optionalFrame}#{optionalCanvas}"
-    
+      return "http://#{WWW_HOST}#{WWW_PATH_LOGIN}?v=1.0&api_key=#{@api_key}#{optionalPopup}#{optionalNext}#{optionalSkipCookie}#{optionalHideCheckbox}#{optionalFrame}#{optionalCanvas}"
     end
     
-    # Function: get_install_url
-    #   Gets the installation URL for this application
+    # Gets the installation URL for this application
     #
-    # Parameters:
-    #   options.next          - the page to redirect to after installation
+    # options.next::  the page to redirect to after installation
     def get_install_url(options={})
-    
       # handle options
       nextPage = options[:next] ||= nil
     
@@ -83,36 +71,25 @@ module RFacebook
       optionalNext = (nextPage == nil) ? "" : "&next=#{CGI.escape(nextPage.to_s)}"
     
       # build and return URL
-      return "http://#{WWW_SERVER_BASE_URL}#{WWW_PATH_INSTALL}?api_key=#{@api_key}#{optionalNext}"
-    
+      return "http://#{WWW_HOST}#{WWW_PATH_INSTALL}?api_key=#{@api_key}#{optionalNext}"
     end
-  
-    ################################################################################################
-    ################################################################################################
-    # :section: Session Activation
-    ################################################################################################
-  
-    # Function: activate_with_token
-    #   Gets the session information available after current user logs in.
+    
+    # Gets the session information available after current user logs in.
     # 
-    # Parameters:
-    #   auth_token    - string token passed back by the callback URL
+    # auth_token:: string token passed back by the callback URL
     def activate_with_token(auth_token)
-      result = call_method("auth.getSession", {:auth_token => auth_token})
-      if result != nil
+      result = remote_call("auth.getSession", {:auth_token => auth_token})
+      unless result.nil?
         @session_user_id = result.at("uid").inner_html
         @session_key = result.at("session_key").inner_html
         @session_expires = result.at("expires").inner_html
       end
     end
   
-    # Function: activate_with_previous_session
-    #   Sets the session key directly (for example, if you have an infinite session key)
+    # Sets the session key directly (for example, if you have an infinite session)
     # 
-    # Parameters:
-    #   key    - the session key to use
+    # key::  the session key to use
     def activate_with_previous_session(key, uid=nil, expires=nil)
-      
       # set the expiration
       @session_expires = expires
       
@@ -123,75 +100,23 @@ module RFacebook
       if uid
         @session_user_id = uid
       else
-        result = call_method("users.getLoggedInUser")
+        result = remote_call("users.getLoggedInUser")
         @session_user_id = result.at("users_getLoggedInUser_response").inner_html
       end
-      
-    end
-    
-    ################################################################################################
-    ################################################################################################
-    # :section: Canvas Signature Validation
-    ################################################################################################
-    
-    # Function: get_fb_sig_params
-    #   Returns the fb_sig params from Hash that has all request params.  Hash is empty if the
-    #   signature was invalid.
-    #
-    # Parameters:
-    #   originalParams - a Hash that contains the fb_sig_* params (i.e. Rails params)
-    #
-    def get_fb_sig_params(originalParams)
-            
-      # setup
-      timeout = 48*3600
-      prefix = "fb_sig_"
-      
-      # get the params prefixed by "fb_sig_" (and remove the prefix)
-      sigParams = {}
-      originalParams.each do |k,v|
-        oldLen = k.length
-        newK = k.sub(prefix, "")
-        if oldLen != newK.length
-          sigParams[newK] = v
-        end
-      end
-      
-      # handle invalidation
-      if (timeout and (sigParams["time"].nil? or (Time.now.to_i - sigParams["time"].to_i > timeout.to_i)))
-        # invalidate if the timeout has been reached
-        #log_debug "** RFACEBOOK(GEM) - fbparams is empty because the signature was timed out"
-        sigParams = {}
-      end
-      
-      # check that the signatures match
-      expectedSig = originalParams["fb_sig"]
-      if !(sigParams and expectedSig and generate_signature(sigParams, @api_secret) == expectedSig)
-        # didn't match, empty out the params
-        #log_debug "** RFACEBOOK(GEM) - fbparams is empty because the signature did not match"
-        sigParams = {}
-      end
-            
-      return sigParams
-      
     end
   
-    ################################################################################################
-    ################################################################################################
-    # :section: Template Methods
-    ################################################################################################
-    
-    # Function: is_activated?
-    #   Returns true when we have activated ourselves somehow
-    def is_activated?
-      return (@session_key != nil)
+    # returns true if this session is completely ready to be used and make API calls
+    def ready?
+      return (@session_key != nil and !expired?)
     end
   
-    # Function: get_secret
-    #   Used by super::signature to generate a signature
-    #   Web sessions simply use their API secret.
-    def get_secret(params) # :nodoc:
-      return @api_secret
+    # Used for signing a set of parameters in the way that Facebook
+    # specifies: <http://developers.facebook.com/documentation.php?v=1.0&doc=auth>
+    #
+    # params:: a Hash containing the parameters to sign
+    def signature(params)
+      # always sign the parameters with the API secret
+      return signature_helper(params, @api_secret)
     end
   
   end

data/lib/facepricot.rb

@@ -27,40 +27,38 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+
+# FIXME: work out the kinks of Facepricot, including moving to JSON support rather than XML, and renaming to something less inane (like FacebookResponse)
+# NOTE: Facepricot will likely be deprecated in version 1.0
+
 require "hpricot"
 
 module RFacebook
 
   module FacepricotChaining
-  
-    def make_facepricot_chain(key, doc)
     
+    private
+    
+    def make_facepricot_chain(key, doc) # :nodoc:
+      
       if matches = /(.*)_list/.match(key)
         listKey = matches[1]
       end
-    
-      result = nil
       
-      if !result
-        if listKey
-          result = doc.search("/#{listKey}")
-        end
-      end
-    
-      if !result
-        result = doc.at("/#{key}")
-      end
+      results = nil
     
-      if !result
-        if listKey
+      if listKey
+        result = doc.search("/#{listKey}")
+        if result.empty? 
           result = doc.search("//#{listKey}")
+        end 
+      else 
+        result = doc.at("/#{key}")
+        if !result 
+          result = doc.at("//#{key}")
         end
       end
-    
-      if !result
-        result = doc.at("//#{key}")
-      end
-    
+
       if result
         if result.is_a?(Array)
           return result.map{|r| FacepricotChain.new(r)}
@@ -113,11 +111,11 @@ module RFacebook
     end
         
   end
-  
+
   class FacepricotChain < String
 
     include FacepricotChaining
-
+    
     def initialize(hpricotDoc)
       super(hpricotDoc.inner_html.gsub("&amp;", "&"))
       @doc = hpricotDoc

data/lib/rfacebook.rb

@@ -0,0 +1,2 @@
+require 'facebook_web_session'
+require 'facebook_desktop_session'

data/{lib/rfacebook_on_rails/view_extensions.rb → test/facebook_desktop_session_test.rb}

@@ -27,44 +27,28 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-module RFacebook
-  module Rails
-    module ViewExtensions
-      
-      def in_facebook_canvas?
-        @controller.in_facebook_canvas?
-      end
-      
-      def in_facebook_frame?
-        @controller.in_facebook_frame?
-      end
-      
-      def in_mock_ajax?
-        @controller.in_mock_ajax?
-      end
-      
-      def fbparams
-        @controller.fbparams
-      end
-      
-      def fbsession
-        @controller.fbsession
-      end
-      
-      def image_path(*params)
-        path = super(*params)
-        if ((in_facebook_canvas? or in_mock_ajax?) and !(/(\w+)(\:\/\/)([\w0-9\.]+)([\:0-9]*)(.*)/.match(path)))
-          path = "#{request.protocol}#{request.host_with_port}#{path}"
-        end
-        return path
-      end
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/facebook_session_test_methods'
 
-      def facebook_debug_panel(options={})
-        return @controller.facebook_debug_panel(options)
-      end
-      
-      # TODO: override form_for to do <fb:editor> for Canvas pages, perhaps with an option to suppress such behavior
-      
-    end
+class RFacebook::FacebookDesktopSession
+  def test_initialize(*params)
+    initialize(*params)
   end
-end
+end
+
+class FacebookDesktopSessionTest < Test::Unit::TestCase
+  
+  include FacebookSessionTestMethods
+  
+  def setup
+    # setting up a desktop session means that we need to allow the initialize method to 'access' the API for a createToken request
+    @fbsession = RFacebook::FacebookDesktopSession.allocate
+    @fbsession.expects(:post_request).returns(RFacebook::Dummy::AUTH_CREATETOKEN_RESPONSE)
+    @fbsession.test_initialize(RFacebook::Dummy::API_KEY, RFacebook::Dummy::API_SECRET)
+  end
+  
+  def test_should_return_login_url
+    assert_equal "http://www.facebook.com/login.php?v=1.0&api_key=#{RFacebook::Dummy::API_KEY}&auth_token=3e4a22bb2f5ed75114b0fc9995ea85f1&popup=true", @fbsession.get_login_url
+  end
+  
+end

data/test/facebook_session_test_methods.rb

@@ -0,0 +1,106 @@
+# Copyright (c) 2007, Matt Pizzimenti (www.livelearncode.com)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+module FacebookSessionTestMethods
+  
+  def force_to_be_activated(fbsession)
+    fbsession.stubs(:ready?).returns(true)
+  end
+  
+  def test_method_missing_dispatches_to_facebook_api
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:remote_call).returns("mocked")
+    assert_equal "mocked", fbsession.friends_get
+  end
+    
+  def test_remote_error_causes_fbsession_to_raise_errors
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::ERROR_RESPONSE)
+    assert_raise(RFacebook::FacebookSession::RemoteStandardError){fbsession.friends_get}
+  end
+    
+  def test_nomethod_error_raises_ruby_equivalent
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::ERROR_RESPONSE_3)
+    assert_raise(NoMethodError){fbsession.friends_get}
+  end
+    
+  def test_badargument_error_raises_ruby_equivalent
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::ERROR_RESPONSE_100)
+    assert_raise(ArgumentError){fbsession.friends_get}
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::ERROR_RESPONSE_606)
+    assert_raise(ArgumentError){fbsession.friends_get}
+  end
+    
+  def test_expiration_error_raises_error_and_sets_expired_flag
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::ERROR_RESPONSE_102)
+    assert_raise(RFacebook::FacebookSession::ExpiredSessionStandardError){fbsession.friends_get}
+    assert fbsession.expired?
+  end
+  
+  def test_facepricot_response_to_group_getMembers
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::GROUP_GETMEMBERS_RESPONSE)
+    memberInfo = fbsession.group_getMembers
+    assert memberInfo
+    assert_equal 4, memberInfo.members.uid_list.size
+    assert_equal 1, memberInfo.admins.uid_list.size
+    assert memberInfo.officers
+    assert memberInfo.not_replied
+  end
+  
+  def test_api_call_to_users_getLoggedInUser
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::USERS_GETLOGGEDINUSER_RESPONSE)
+    assert_equal "1234567", fbsession.users_getLoggedInUser
+  end
+
+  def test_api_call_to_users_getInfo
+    fbsession = @fbsession.dup
+    force_to_be_activated(fbsession)
+    fbsession.expects(:post_request).returns(RFacebook::Dummy::USERS_GETINFO_RESPONSE)
+    userInfo = fbsession.users_getInfo    
+    assert userInfo
+    assert_equal "94303", userInfo.current_location.get(:zip)
+  end
+  
+  def test_should_raise_not_activated
+    assert_raise(RFacebook::FacebookSession::NotActivatedStandardError){@fbsession.friends_get}
+  end
+
+end

data/test/facebook_web_session_test.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2007, Matt Pizzimenti (www.livelearncode.com)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+require File.dirname(__FILE__) + '/facebook_session_test_methods'
+
+class FacebookWebSessionTest < Test::Unit::TestCase
+  
+  include FacebookSessionTestMethods
+  
+  def setup
+    @fbsession = RFacebook::FacebookWebSession.new(RFacebook::Dummy::API_KEY, RFacebook::Dummy::API_SECRET)
+  end
+  
+  def test_should_return_install_url
+    assert_equal "http://www.facebook.com/install.php?api_key=#{RFacebook::Dummy::API_KEY}", @fbsession.get_install_url
+  end
+  
+  def test_should_return_login_url
+    assert_equal "http://www.facebook.com/login.php?v=1.0&api_key=#{RFacebook::Dummy::API_KEY}", @fbsession.get_login_url
+  end
+  
+end