fb_rails 1.1.0 → 1.1.1

data/README.rdoc

@@ -18,8 +18,7 @@ or
   config.facebook.app_id = 'my_app_id'
   config.facebook.secret = 'my_app_secret'
 
-Getting the user logged in is out of the scope of this gem. That's what
-FBML and the Facebook Javascript API are for. Here's an example:
+Include facebook Javascript and a login button:
 
   <%= include_facebook_javascript %>
   <%= fbml 'login-button' %>
@@ -82,6 +81,22 @@ One thing I like to do for new Facebook users is store them in a before filter:
   end
 
 
+== Timeouts
+
+Calls to the Graph API can timeout. If this occurs, an FbRails::TimeoutError occurs.
+Your application can rescue from these:
+
+  begin
+    fb.get 'me'
+  rescue FbRails::TimeoutError => e
+    ...
+  end
+
+The timeout defaults to 60 seconds. This can be configured:
+
+  config.timeout = 10
+
+
 == Testing
 
 Facebook requests can be mocked, so that your tests do not require real HTTP

data/lib/fb_rails/config.rb

@@ -1,6 +1,7 @@
 module FbRails
   class Config
-    class_attribute :app_id, :secret, :user_class_name
+    class_attribute :app_id, :secret, :user_class_name, :timeout
+    self.timeout = 60
 
     class << self
       def user_class

data/lib/fb_rails/graph.rb

@@ -4,6 +4,13 @@ require 'uri'
 require 'fb_rails/log_subscriber'
 
 module FbRails
+  class TimeoutError < StandardError
+    def initialize(message)
+      @message = message
+    end
+    def to_s; @message ;end
+  end
+
   class Graph
     class << self
       def facebook_uri
@@ -11,27 +18,33 @@ module FbRails
       end
 
       def get(path, params = {})
-        request(:get, "#{path}?#{params.to_param}")
+        json_request(:get, "#{path}?#{params.to_param}")
       end
 
       def post(path, params = {})
-        request(:post, path, params.to_param)
+        json_request(:post, path, params.to_param)
       end
 
       private
         def request(http_verb, path, *arguments)
-          response = ActiveSupport::Notifications.instrument('request.fb_rails') do |payload|
+          ActiveSupport::Notifications.instrument('request.fb_rails') do |payload|
             payload[:http_verb]   = http_verb
             payload[:request_uri] = path
             http.send(http_verb, path, *arguments)
           end
+        rescue Timeout::Error => e
+          raise TimeoutError.new(e.message)
+        end
 
+        def json_request(http_verb, path, *arguments)
+          response = request(http_verb, path, *arguments)
           ActiveSupport::JSON.decode(response.body)
         end
 
         def http
           result = Net::HTTP.new(facebook_uri.host, facebook_uri.port)
           configure_https(result)
+          result.timeout = FbRails::Config.timeout
           result
         end
 

data/lib/fb_rails/test_helper.rb

@@ -1,5 +1,15 @@
 module FbRails
   module TestHelper
+    # Creates a hash representation of the facebook cookie.
+    # To use this in tests, you might do the following:
+    # 
+    #   class MyControllerTest < ActionController::TestCase
+    #     test 'request that requires authentication' do
+    #       @request.cookies.merge! fb_cookie
+    #       get :protected_action
+    #     end
+    #   end
+    # 
     def fb_cookie(uid = 42, access_token = 'abc')
       value = FbRails::Cookie.encode({uid: uid, access_token: access_token}, FbRails::Config.secret)
       {FbRails::Connect.cookie_name => value}

data/test/config_test.rb

@@ -5,4 +5,8 @@ class FbRails::ConfigTest < ActiveSupport::TestCase
     assert_equal User, FbRails::Config.user_class
     assert User.new.respond_to?(:access_token)
   end
+  
+  test 'default timeout' do
+    assert_equal 60, FbRails::Config.timeout
+  end
 end

data/test/graph_test.rb

@@ -4,4 +4,14 @@ class FbRails::GraphTest < ActiveSupport::TestCase
   test 'facebook_uri' do
     assert_equal 'https', FbRails::Graph.facebook_uri.scheme
   end
+
+  test 'rescue timout error' do
+    http = mock
+    http.stubs(:get).raises(Timeout::Error)
+    FbRails::Graph.expects(:http).returns(http)
+
+    assert_raise FbRails::TimeoutError do
+      FbRails::Graph.get 'foo'
+    end
+  end
 end

data/test/log_subscriber_test.rb

@@ -14,7 +14,7 @@ class FbRails::LogSubscriberTest < ActiveSupport::TestCase
 
     FbRails::LogSubscriber.attach_to :fb_rails
   end
-  
+
   test 'request notification' do
     graph = FbRails::Graph.new('my_access_token')
     graph.get 'test'

data/test/test_helper.rb

@@ -1,8 +1,10 @@
 require 'rubygems'
+require 'bundler/setup'
+
 require 'test/unit'
 require 'rails/all'
-
 require 'fb_rails'
+require 'mocha'
 
 require 'sample/user'
 require 'sample/test_controller'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-20 00:00:00.000000000 -07:00
-default_executable: 
+date: 2011-09-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2153045200 !ruby/object:Gem::Requirement
+  requirement: &70219700445320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +21,7 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153045200
+  version_requirements: *70219700445320
 description: A Rails 3 gem for the latest facebook API
 email: developer@matthewhiggins.com
 executables: []
@@ -58,7 +57,6 @@ files:
 - test/sample/test_controller.rb
 - test/sample/user.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/matthuhiggins/fb_rails
 licenses: []
 post_install_message: 
@@ -79,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Facebook on Rails