koala 1.3.0 → 1.4.0

data/lib/koala/oauth.rb

@@ -4,12 +4,12 @@ require 'base64'
 
 module Koala
   module Facebook
-    
+
     DIALOG_HOST = "www.facebook.com"
-    
+
     class OAuth
       attr_reader :app_id, :app_secret, :oauth_callback_url
-      
+
       # Creates a new OAuth client.
       #
       # @param app_id [String, Integer] a Facebook application ID
@@ -20,14 +20,14 @@ module Koala
         @app_secret = app_secret
         @oauth_callback_url = oauth_callback_url
       end
-      
+
       # Parses the cookie set Facebook's JavaScript SDK.
       #
       # @note in parsing Facebook's new signed cookie format this method has to make a request to Facebook.
       #       We recommend storing authenticated user info in your Rails session (or equivalent) and only
       #       calling this when needed.
       #
-      # @param cookie_hash a set of cookies that includes the Facebook cookie.  
+      # @param cookie_hash a set of cookies that includes the Facebook cookie.
       #                     You can pass Rack/Rails/Sinatra's cookie hash directly to this method.
       #
       # @return the authenticated user's information as a hash, or nil.
@@ -60,21 +60,21 @@ module Koala
       alias_method :get_user_from_cookie, :get_user_from_cookies
 
       # URLs
-      
+
       # Builds an OAuth URL, where users will be prompted to log in and for any desired permissions.
-      # When the users log in, you receive a callback with their   
+      # When the users log in, you receive a callback with their
       # See http://developers.facebook.com/docs/authentication/.
       #
       # @see #url_for_access_token
       #
-      # @note The server-side authentication and dialog methods should only be used 
+      # @note The server-side authentication and dialog methods should only be used
       #       if your application can't use the Facebook Javascript SDK,
       #       which provides a much better user experience.
       #       See http://developers.facebook.com/docs/reference/javascript/.
       #
       # @param options any query values to add to the URL, as well as any special/required values listed below.
       # @option options permissions an array or comma-separated string of desired permissions
-      # 
+      #
       # @raise ArgumentError if no OAuth callback was specified in OAuth#new or in options as :redirect_uri
       #
       # @return an OAuth URL you can send your users to
@@ -84,7 +84,7 @@ module Koala
           options[:scope] = permissions.is_a?(Array) ? permissions.join(",") : permissions
         end
         url_options = {:client_id => @app_id}.merge(options)
-        
+
         # Creates the URL for oauth authorization for a given callback and optional set of permissions
         build_url("https://#{GRAPH_SERVER}/oauth/authorize", true, url_options)
       end
@@ -92,9 +92,9 @@ module Koala
       # Once you receive an OAuth code, you need to redeem it from Facebook using an appropriate URL.
       # (This is done by your server behind the scenes.)
       # See http://developers.facebook.com/docs/authentication/.
-      # 
+      #
       # @see #url_for_oauth_code
-      # 
+      #
       # @note (see #url_for_oauth_code)
       #
       # @param code an OAuth code received from Facebook
@@ -106,7 +106,7 @@ module Koala
       def url_for_access_token(code, options = {})
         # Creates the URL for the token corresponding to a given code generated by Facebook
         url_options = {
-          :client_id => @app_id, 
+          :client_id => @app_id,
           :code => code,
           :client_secret => @app_secret
         }.merge(options)
@@ -115,7 +115,7 @@ module Koala
 
       # Builds a URL for a given dialog (feed, friends, OAuth, pay, send, etc.)
       # See http://developers.facebook.com/docs/reference/dialogs/.
-      # 
+      #
       # @note (see #url_for_oauth_code)
       #
       # @param dialog_type the kind of Facebook dialog you want to show
@@ -124,37 +124,37 @@ module Koala
       # @return an URL your server can query for the user's access token
       def url_for_dialog(dialog_type, options = {})
         # some endpoints require app_id, some client_id, supply both doesn't seem to hurt
-        url_options = {:app_id => @app_id, :client_id => @app_id}.merge(options)        
+        url_options = {:app_id => @app_id, :client_id => @app_id}.merge(options)
         build_url("http://#{DIALOG_HOST}/dialog/#{dialog_type}", true, url_options)
       end
-      
+
       # access tokens
-      
+
       # Fetches an access token, token expiration, and other info from Facebook.
       # Useful when you've received an OAuth code using the server-side authentication process.
       # @see url_for_oauth_code
       #
       # @note (see #url_for_oauth_code)
-      # 
+      #
       # @param code (see #url_for_access_token)
       # @param options any additional parameters to send to Facebook when redeeming the token
-      # 
-      # @raise Koala::Facebook::APIError if Facebook returns an error response 
-      # 
-      # @return a hash of the access token info returned by Facebook (token, expiration, etc.) 
+      #
+      # @raise Koala::Facebook::APIError if Facebook returns an error response
+      #
+      # @return a hash of the access token info returned by Facebook (token, expiration, etc.)
       def get_access_token_info(code, options = {})
         # convenience method to get a parsed token from Facebook for a given code
         # should this require an OAuth callback URL?
         get_token_from_server({:code => code, :redirect_uri => options[:redirect_uri] || @oauth_callback_url}, false, options)
       end
 
-      
+
       # Fetches the access token (ignoring expiration and other info) from Facebook.
       # Useful when you've received an OAuth code using the server-side authentication process.
       # @see get_access_token_info
-      # 
+      #
       # @note (see #url_for_oauth_code)
-      # 
+      #
       # @param (see #get_access_token_info)
       #
       # @raise (see #get_access_token_info)
@@ -169,7 +169,7 @@ module Koala
 
       # Fetches the application's access token, along with any other information provided by Facebook.
       # See http://developers.facebook.com/docs/authentication/ (search for App Login).
-      # 
+      #
       # @param options any additional parameters to send to Facebook when redeeming the token
       #
       # @return the application access token and other information (expiration, etc.)
@@ -180,7 +180,7 @@ module Koala
 
       # Fetches the application's access token (ignoring expiration and other info).
       # @see get_app_access_token_info
-      # 
+      #
       # @param (see #get_app_access_token_info)
       #
       # @return the application access token
@@ -190,13 +190,40 @@ module Koala
         end
       end
 
+      # Fetches an access_token with extended expiration time, along with any other information provided by Facebook.
+      # See https://developers.facebook.com/docs/offline-access-deprecation/#extend_token (search for fb_exchange_token).
+      #
+      # @param access_token the access token to exchange
+      # @param options any additional parameters to send to Facebook when exchanging tokens.
+      #
+      # @return the access token with extended expiration time and other information (expiration, etc.)
+      def exchange_access_token_info(access_token, options = {})
+        get_token_from_server({
+          :grant_type => 'fb_exchange_token',
+          :fb_exchange_token => access_token
+        }, true, options)
+      end
+
+      # Fetches an access token with extended expiration time (ignoring expiration and other info).
+
+      # @see exchange_access_token_info
+      #
+      # @param (see #exchange_access_token_info)
+      #
+      # @return A new access token or the existing one, set to expire in 60 days.
+      def exchange_access_token(access_token, options = {})
+        if info = exchange_access_token_info(access_token, options)
+          info["access_token"]
+        end
+      end
+
       # Parses a signed request string provided by Facebook to canvas apps or in a secure cookie.
       #
       # @param input the signed request from Facebook
-      # 
+      #
       # @raise RuntimeError if the signature is incomplete, invalid, or using an unsupported algorithm
-      # 
-      # @return a hash of the validated request information 
+      #
+      # @return a hash of the validated request information
       def parse_signed_request(input)
         encoded_sig, encoded_envelope = input.split('.', 2)
         raise 'SignedRequest: Invalid (incomplete) signature data' unless encoded_sig && encoded_envelope
@@ -214,7 +241,7 @@ module Koala
       end
 
       # Old session key code
-      
+
       # @deprecated Facebook no longer provides session keys.
       def get_token_info_from_session_keys(sessions, options = {})
         Koala::Utils.deprecate("Facebook no longer provides session keys. The relevant OAuth methods will be removed in the next release.")
@@ -271,7 +298,7 @@ module Koala
         end
         components
       end
-      
+
       def parse_unsigned_cookie(fb_cookie)
         # remove the opening/closing quote
         fb_cookie = fb_cookie.gsub(/\"/, "")
@@ -285,7 +312,7 @@ module Koala
         sig = Digest::MD5.hexdigest(auth_string + @app_secret)
         sig == components["sig"] && (components["expires"] == "0" || Time.now.to_i < components["expires"].to_i) ? components : nil
       end
-      
+
       def parse_signed_cookie(fb_cookie)
         components = parse_signed_request(fb_cookie)
         if code = components["code"]
@@ -315,12 +342,12 @@ module Koala
         str += '=' * (4 - str.length.modulo(4))
         Base64.decode64(str.tr('-_', '+/'))
       end
-      
+
       def build_url(base, require_redirect_uri = false, url_options = {})
-        if require_redirect_uri && !(url_options[:redirect_uri] ||= url_options.delete(:callback) || @oauth_callback_url)          
+        if require_redirect_uri && !(url_options[:redirect_uri] ||= url_options.delete(:callback) || @oauth_callback_url)
           raise ArgumentError, "url_for_dialog must get a callback either from the OAuth object or in the parameters!"
         end
-        
+
         "#{base}?#{Koala::HTTPService.encode_params(url_options)}"
       end
     end

data/lib/koala/realtime_updates.rb

@@ -101,11 +101,11 @@ module Koala
             # you can make sure this is legitimate through two ways
             # if your store the token across the calls, you can pass in the token value
             # and we'll make sure it matches
-            (verify_token && params["hub.verify_token"] == verify_token) ||
+            ((verify_token && params["hub.verify_token"] == verify_token) ||
             # alternately, if you sent a specially-constructed value (such as a hash of various secret values)
             # you can pass in a block, which we'll call with the verify_token sent by Facebook
             # if it's legit, return anything that evaluates to true; otherwise, return nil or false
-            (verification_block && yield(params["hub.verify_token"]))
+            (verification_block && yield(params["hub.verify_token"])))
           params["hub.challenge"]
         else
           false

data/lib/koala/version.rb

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

data/readme.md

@@ -32,7 +32,7 @@ The Graph API is the simple, slick new interface to Facebook's data.  Using it w
     @graph.put_object("me", "feed", :message => "I am writing on my wall!")
    
     # three-part queries are easy too!
-    @graph.get_connection("me", "mutualfriends/#{friend_id}")
+    @graph.get_connections("me", "mutualfriends/#{friend_id}")
     
     # you can even use the new Timeline API
     # see https://developers.facebook.com/docs/beta/opengraph/tutorial/

data/spec/cases/graph_api_batch_spec.rb

@@ -372,11 +372,11 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
           end
           result[0].should == {"Content-Type" => "text/javascript; charset=UTF-8"}
         end
-        
+
         describe "if it errors" do
           it "raises an APIError if the response is not 200" do
             Koala.stub(:make_request).and_return(Koala::HTTPService::Response.new(500, "[]", {}))
-            expect { 
+            expect {
               Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
             }.to raise_exception(Koala::Facebook::APIError)
           end
@@ -385,21 +385,21 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
             before :each do
               Koala.stub(:make_request).and_return(Koala::HTTPService::Response.new(200, '{"error":190,"error_description":"Error validating access token."}', {}))
             end
-            
+
             it "throws an error if the response is an old Batch API-style error" do
-              expect { 
+              expect {
                 Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
               }.to raise_exception(Koala::Facebook::APIError)
-            end   
-            
+            end
+
             it "provides a type for the error if the response is an old Batch API-style error" do
               begin
                 Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
               rescue Koala::Facebook::APIError => err
               end
               err.fb_error_type.should
-            end         
-            
+            end
+
             it "passes all the error details if an old Batch API-style error is raised" do
               begin
                 Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
@@ -408,18 +408,18 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
               err.raw_response["error"].should == 190
             end
           end
-          
-          context "with the new style" do          
+
+          context "with the new style" do
             before :each do
               Koala.stub(:make_request).and_return(Koala::HTTPService::Response.new(200, '{"error":{"message":"Request 0 cannot depend on an  unresolved request with  name f. Requests can only depend on preceding requests","type":"GraphBatchException"}}', {}))
             end
 
             it "throws an error if the response is a new Graph API-style error" do
-              expect { 
+              expect {
                 Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
               }.to raise_exception(Koala::Facebook::APIError)
             end
-            
+
             it "passes all the error details if an old Batch API-style error is raised" do
               begin
                 Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
@@ -488,7 +488,7 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       end
       friends.should be_a(Koala::Facebook::GraphCollection)
     end
-    
+
     it 'turns pageable results into GraphCollections' do
       me, friends = @api.batch do |batch_api|
         batch_api.get_object('me')
@@ -515,11 +515,11 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
     end
 
     it "inserts errors in the appropriate place, without breaking other results" do
-      failed_insights, koppel = @api.batch do |batch_api|
-        batch_api.get_connections(@app_id, 'insights')
+      failed_call, koppel = @api.batch do |batch_api|
+        batch_api.get_connection("2", "invalidconnection")
         batch_api.get_object(KoalaTest.user1, {}, {"access_token" => @app_api.access_token})
       end
-      failed_insights.should be_a(Koala::Facebook::APIError)
+      failed_call.should be_a(Koala::Facebook::APIError)
       koppel["id"].should_not be_nil
     end
 
@@ -602,12 +602,12 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
       end
 
       it "properly handles dependencies that fail" do
-        data, koppel = @api.batch do |batch_api|
-          batch_api.get_connections(@app_id, 'insights', {}, :batch_args => {:name => "getdata"})
+        failed_call, koppel = @api.batch do |batch_api|
+          batch_api.get_connections("2", "invalidconnection", {}, :batch_args => {:name => "getdata"})
           batch_api.get_object(KoalaTest.user1, {}, :batch_args => {:depends_on => "getdata"})
         end
 
-        data.should be_a(Koala::Facebook::APIError)
+        failed_call.should be_a(Koala::Facebook::APIError)
         koppel.should be_nil
       end
 

data/spec/cases/http_service_spec.rb

@@ -123,6 +123,13 @@ describe "Koala::HTTPService" do
         val.should == CGI.escape(args[key])
       end
     end
+    
+    it "encodes parameters in alphabetical order" do
+      args = {:b => '2', 'a' => '1'}
+      
+      result = Koala::HTTPService.encode_params(args)
+      result.split('&').map{|key_val| key_val.split('=')[0]}.should == ['a', 'b']
+    end
 
     it "converts all keys to Strings" do
       args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]

data/spec/cases/koala_test_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe KoalaTest do
+  pending "should have tests, because the test suite depends on it"
+end