koala 1.3.0rc2 → 1.3.0

data/CHANGELOG

@@ -5,12 +5,15 @@ New methods:
 -- GraphCollection.parse_page_url now exposes useful functionality for non-Rails apps
 -- RealtimeUpdates#subscription_path and TestUsers#test_user_accounts_path are now public
 Updated methods:
+-- REST API methods are now deprecated (see http://developers.facebook.com/blog/post/616/)
 -- OAuth#url_for_access_token and #url_for_oauth_code now include any provided options as URL parameters
 -- APIError#raw_response allows access to the raw error response received from Facebook
 -- Utils.deprecate only prints each message once (no more spamming)
 -- API#get_page_access_token now accepts additional arguments and HTTP options (like other calls)
 -- TestUsers and RealtimeUpdates methods now take http_options arguments
 -- All methods with http_options can now take :http_component => :response for the complete response
+-- OAuth#get_user_info_from_cookies returns nil rather than an error if the cookies are expired (thanks, herzio)
+-- TestUsers#delete_all now uses the Batch API and is much faster
 Internal improvements:
 -- FQL queries now use the Graph API behind-the-scenes
 -- Cleaned up file and class organization, with aliases for backward compatibility

data/lib/koala/api/rest_api.rb

@@ -38,6 +38,8 @@ module Koala
       # 
       # @return the result from Facebook
       def rest_call(fb_method, args = {}, options = {}, verb = "get")
+        Koala::Utils.deprecate("The REST API is now deprecated; please use the equivalent Graph API methods instead.  See http://developers.facebook.com/blog/post/616/.")
+
         options = options.merge!(:rest_api => true, :read_only => READ_ONLY_METHODS.include?(fb_method.to_s))
 
         api("method/#{fb_method}", args.merge('format' => 'json'), verb, options) do |response|

data/lib/koala/oauth.rb

@@ -31,14 +31,14 @@ module Koala
       #                     You can pass Rack/Rails/Sinatra's cookie hash directly to this method.
       #
       # @return the authenticated user's information as a hash, or nil.
-      def get_user_info_from_cookie(cookie_hash)
+      def get_user_info_from_cookies(cookie_hash)
         if signed_cookie = cookie_hash["fbsr_#{@app_id}"]
           parse_signed_cookie(signed_cookie)
         elsif unsigned_cookie = cookie_hash["fbs_#{@app_id}"]
           parse_unsigned_cookie(unsigned_cookie)
         end
       end
-      alias_method :get_user_info_from_cookies, :get_user_info_from_cookie
+      alias_method :get_user_info_from_cookie, :get_user_info_from_cookies
 
       # Parses the cookie set Facebook's JavaScript SDK and returns only the user ID.
       #
@@ -47,13 +47,17 @@ module Koala
       # @param (see #get_user_info_from_cookie)
       #
       # @return the authenticated user's Facebook ID, or nil.
-      def get_user_from_cookie(cookies)
-        if info = get_user_info_from_cookies(cookies)
-          # signed cookie has user_id, unsigned cookie has uid
-          string = info["user_id"] || info["uid"]
+      def get_user_from_cookies(cookies)
+        if signed_cookie = cookies["fbsr_#{@app_id}"]
+          if components = parse_signed_request(signed_cookie)
+            components["user_id"]
+          end
+        elsif info = get_user_info_from_cookies(cookies)
+          # Parsing unsigned cookie
+          info["uid"]
         end
       end
-      alias_method :get_user_from_cookies, :get_user_from_cookie
+      alias_method :get_user_from_cookie, :get_user_from_cookies
 
       # URLs
       
@@ -284,8 +288,15 @@ module Koala
       
       def parse_signed_cookie(fb_cookie)
         components = parse_signed_request(fb_cookie)
-        if (code = components["code"]) && token_info = get_access_token_info(code, :redirect_uri => '')
-          components.merge(token_info)
+        if code = components["code"]
+          begin
+            token_info = get_access_token_info(code, :redirect_uri => '')
+          rescue Koala::Facebook::APIError => err
+            return nil if err.message =~ /Code was invalid or expired/
+            raise
+          end
+
+          components.merge(token_info) if token_info
         else
           nil
         end

data/lib/koala/test_users.rb

@@ -1,4 +1,5 @@
 require 'koala'
+
 module Koala
   module Facebook
     
@@ -81,7 +82,7 @@ module Koala
         @api.delete_object(test_user, options)
       end
 
-      # Deletes all test users.
+      # Deletes all test users in batches of 50.
       # 
       # @note if you have a lot of test users (> 20), this operation can take a long time.
       #
@@ -89,7 +90,20 @@ module Koala
       # 
       # @return a list of the test users that have been deleted
       def delete_all(options = {})
-        list(options).each {|u| delete(u, options)}
+        # ideally we'd save a call by checking next_page_params, but at the time of writing
+        # Facebook isn't consistently returning full pages after the first one
+        previous_list = nil
+        while (test_user_list = list(options)).length > 0
+          # avoid infinite loops if Facebook returns buggy users you can't delete
+          # see http://developers.facebook.com/bugs/223629371047398
+          break if test_user_list == previous_list
+
+          test_user_list.each_slice(50) do |users| 
+            self.api.batch(options) {|batch_api| users.each {|u| batch_api.delete_object(u["id"]) }}
+          end
+          
+          previous_list = test_user_list
+        end
       end
 
       # Updates a test user's attributes.

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "1.3.0rc2"
+  VERSION = "1.3.0"
 end

data/spec/cases/legacy_spec.rb

@@ -2,6 +2,14 @@ require 'spec_helper'
 
 # Support for legacy / deprecated interfaces
 describe "legacy APIs" do
+
+  it "deprecates the REST API" do
+    api = Koala::Facebook::API.new
+    api.stub(:api)
+    Koala::Utils.should_receive(:deprecate)
+    api.rest_call("stuff")
+  end
+
   describe Koala::Facebook::GraphAPI do
     describe "class consolidation" do
       before :each do

data/spec/cases/oauth_spec.rb

@@ -104,10 +104,26 @@ describe "Koala::Facebook::OAuth" do
             @oauth.get_user_info_from_cookies(@cookie)["access_token"].should == @token
           end
           
-          it "returns nil if the call to FB fails" do
+          it "returns nil if the call to FB returns no data" do
             @oauth.stub(:get_access_token_info).and_return(nil)
             @oauth.get_user_info_from_cookies(@cookie).should be_nil
           end
+
+          it "returns nil if the call to FB returns an expired code error" do
+            @oauth.stub(:get_access_token_info).and_raise(Koala::Facebook::APIError.new(
+              "type" => "OAuthException",
+              "message" => "Code was invalid or expired. Session has expired at unix time 1324044000. The current unix time is 1324300957."
+            ))
+            @oauth.get_user_info_from_cookies(@cookie).should be_nil
+          end
+
+          it "raises the error if the call to FB returns a different error" do
+            @oauth.stub(:get_access_token_info).and_raise(Koala::Facebook::APIError.new(
+              "type" => "OtherError",
+              "message" => "A Facebook Error"
+            ))
+            expect { @oauth.get_user_info_from_cookies(@cookie) }.to raise_exception(Koala::Facebook::APIError)
+          end
         end
         
         it "doesn't parse invalid cookies" do
@@ -166,12 +182,12 @@ describe "Koala::Facebook::OAuth" do
           @oauth.stub(:get_access_token_info).and_return("access_token" => "my token")          
         end
 
-        it "uses get_user_info_from_cookies to parse the cookies" do
-          @oauth.should_receive(:get_user_info_from_cookies).with(@cookie).and_return({})
+        it "does not uses get_user_info_from_cookies to parse the cookies" do
+          @oauth.should_not_receive(:get_user_info_from_cookies).with(@cookie).and_return({})
           @oauth.get_user_from_cookies(@cookie)
         end
 
-        it "uses return the token string if the cookies are valid" do
+        it "uses return the facebook user id string if the cookies are valid" do
           result = @oauth.get_user_from_cookies(@cookie)
           result.should == "2905623" # the user who generated the original test cookie
         end

data/spec/cases/test_users_spec.rb

@@ -179,19 +179,27 @@ describe "Koala::Facebook::TestUsers" do
     end
 
     describe "#delete_all" do
-      it "deletes all users found by the list commnand" do
-        array = [1, 2, 3]
-        @test_users.should_receive(:list).and_return(array)
-        array.each {|i| @test_users.should_receive(:delete).with(i, anything) }
+      it "deletes the batch API to deleten all users found by the list commnand" do
+        array = 200.times.collect { {"id" => rand}}
+        @test_users.should_receive(:list).and_return(array, [])
+        batch_api = stub("batch API")
+        @test_users.api.should_receive(:batch).and_yield(batch_api).any_number_of_times
+        array.each {|item| batch_api.should_receive(:delete_object).with(item["id"]) }
         @test_users.delete_all
       end
       
-      it "accepts http options that get passed to both list and delete" do
-        array = [1, 2, 3]
+      it "accepts http options that get passed to both list and the batch call" do
         options = {:some_http_option => true}
-        @test_users.should_receive(:list).with(options).and_return(array)
-        array.each {|i| @test_users.should_receive(:delete).with(anything, options) }
+        @test_users.should_receive(:list).with(options).and_return([{"id" => rand}], [])
+        @test_users.api.should_receive(:batch).with(options)
         @test_users.delete_all(options)
+      end  
+      
+      it "breaks if Facebook sends back the same list twice" do
+        list = [{"id" => rand}]
+        @test_users.should_receive(:list).any_number_of_times.and_return(list)
+        @test_users.api.should_receive(:batch).once
+        @test_users.delete_all
       end        
     end
 

data/spec/fixtures/mock_facebook_responses.yml

@@ -426,7 +426,7 @@ graph_api:
         with_token: '{"id": "888888888", "access_token":"<%= ACCESS_TOKEN %>", "login_url":"https://www.facebook.com/platform/test_account.."}'
     no_args:
       get:
-        with_token: '{"data":[{"id": "999999999", "access_token":"<%= ACCESS_TOKEN %>", "login_url":"https://www.facebook.com/platform/test_account.."}, {"id": "888888888", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}]}'
+        with_token: '{"data":[{"id": "999999999", "access_token":"<%= ACCESS_TOKEN %>", "login_url":"https://www.facebook.com/platform/test_account.."}, {"id": "888888888", "access_token":"119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.", "login_url":"https://www.facebook.com/platform/test_account.."}], "paging":{"next":"https://graph.facebook.com/119908831367602/accounts/test-users?access_token=119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw&limit=50&offset=50&__after_id=100003241848740"}}'
 
   /999999999:
     no_args:

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 1.3.0rc2
-  prerelease: 5
+  version: 1.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -13,7 +13,7 @@ date: 2011-10-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70189471321260 !ruby/object:Gem::Requirement
+  requirement: &70194747941160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70189471321260
+  version_requirements: *70194747941160
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70189471320500 !ruby/object:Gem::Requirement
+  requirement: &70194747940100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70189471320500
+  version_requirements: *70194747940100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70189471319840 !ruby/object:Gem::Requirement
+  requirement: &70194747938880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0rc1
   type: :development
   prerelease: false
-  version_requirements: *70189471319840
+  version_requirements: *70194747938880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70189471318960 !ruby/object:Gem::Requirement
+  requirement: &70194747937740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70189471318960
+  version_requirements: *70194747937740
 description: Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write
   access to the social graph via the Graph and REST APIs, as well as support for realtime
   updates and OAuth and Facebook Connect authentication.  Koala is fully tested and
@@ -142,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1629034737345566413
+      hash: 3741350754426721879
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: