koala 1.2.1 → 1.3.0

data/spec/cases/legacy_spec.rb

@@ -0,0 +1,115 @@
+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
+        Koala::Utils.stub(:deprecate) # avoid actual messages to stderr
+      end
+
+      it "still allows you to instantiate a GraphAndRestAPI object" do
+        api = Koala::Facebook::GraphAPI.new("token").should be_a(Koala::Facebook::GraphAPI)
+      end
+
+      it "ultimately creates an API object" do
+        api = Koala::Facebook::GraphAPI.new("token").should be_a(Koala::Facebook::API)
+      end
+
+      it "fires a depreciation warning" do
+        Koala::Utils.should_receive(:deprecate)
+        api = Koala::Facebook::GraphAPI.new("token")
+      end
+    end
+  end
+
+  describe Koala::Facebook::RestAPI do
+    describe "class consolidation" do
+      before :each do
+        Koala::Utils.stub(:deprecate) # avoid actual messages to stderr
+      end
+
+      it "still allows you to instantiate a GraphAndRestAPI object" do
+        api = Koala::Facebook::RestAPI.new("token").should be_a(Koala::Facebook::RestAPI)
+      end
+
+      it "ultimately creates an API object" do
+        api = Koala::Facebook::RestAPI.new("token").should be_a(Koala::Facebook::API)
+      end
+
+      it "fires a depreciation warning" do
+        Koala::Utils.should_receive(:deprecate)
+        api = Koala::Facebook::RestAPI.new("token")
+      end
+    end
+  end
+
+  describe Koala::Facebook::GraphAndRestAPI do
+    describe "class consolidation" do
+      before :each do
+        Koala::Utils.stub(:deprecate) # avoid actual messages to stderr
+      end
+
+      it "still allows you to instantiate a GraphAndRestAPI object" do
+        api = Koala::Facebook::GraphAndRestAPI.new("token").should be_a(Koala::Facebook::GraphAndRestAPI)
+      end
+
+      it "ultimately creates an API object" do
+        api = Koala::Facebook::GraphAndRestAPI.new("token").should be_a(Koala::Facebook::API)
+      end
+
+      it "fires a depreciation warning" do
+        Koala::Utils.should_receive(:deprecate)
+        api = Koala::Facebook::GraphAndRestAPI.new("token")
+      end
+    end
+  end
+
+  {:typhoeus => Koala::TyphoeusService, :net_http => Koala::NetHTTPService}.each_pair do |adapter, module_class|
+    describe module_class.to_s do
+      it "responds to deprecated_interface" do
+        module_class.should respond_to(:deprecated_interface)
+      end
+
+      it "issues a deprecation warning" do
+        Koala::Utils.should_receive(:deprecate)
+        module_class.deprecated_interface
+      end
+
+      it "sets the default adapter to #{adapter}" do
+        module_class.deprecated_interface
+        Faraday.default_adapter.should == adapter
+      end
+    end
+  end
+
+  describe "moved classes" do
+    it "allows you to access Koala::HTTPService::MultipartRequest through the Koala module" do
+      Koala::MultipartRequest.should == Koala::HTTPService::MultipartRequest
+    end
+    
+    it "allows you to access Koala::Response through the Koala module" do
+      Koala::Response.should == Koala::HTTPService::Response
+    end
+    
+    it "allows you to access Koala::Response through the Koala module" do
+      Koala::UploadableIO.should == Koala::HTTPService::UploadableIO
+    end
+    
+    it "allows you to access Koala::Facebook::GraphBatchAPI::BatchOperation through the Koala::Facebook module" do
+      Koala::Facebook::BatchOperation.should == Koala::Facebook::GraphBatchAPI::BatchOperation
+    end 
+    
+    it "allows you to access Koala::Facebook::API::GraphCollection through the Koala::Facebook module" do
+      Koala::Facebook::GraphCollection.should == Koala::Facebook::API::GraphCollection
+    end   
+  end
+end

data/spec/cases/multipart_request_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
-describe Koala::MultipartRequest do
+describe Koala::HTTPService::MultipartRequest do
   it "is a subclass of Faraday::Request::Multipart" do
-    Koala::MultipartRequest.superclass.should == Faraday::Request::Multipart
+    Koala::HTTPService::MultipartRequest.superclass.should == Faraday::Request::Multipart
   end
   
   it "defines mime_type as multipart/form-data" do
-    Koala::MultipartRequest.mime_type.should == 'multipart/form-data'
+    Koala::HTTPService::MultipartRequest.mime_type.should == 'multipart/form-data'
   end
   
-  describe ".process_request?" do
+  describe "#process_request?" do
     before :each do
       @env = {}
-      @multipart = Koala::MultipartRequest.new
+      @multipart = Koala::HTTPService::MultipartRequest.new
       @multipart.stub(:request_type).and_return("")
     end
     
@@ -43,10 +43,10 @@ describe Koala::MultipartRequest do
     end    
   end
   
-  describe ".process_params" do
+  describe "#process_params" do
     before :each do
       @parent = Faraday::Request::Multipart.new
-      @multipart = Koala::MultipartRequest.new 
+      @multipart = Koala::HTTPService::MultipartRequest.new 
       @block = lambda {|k, v| "#{k}=#{v}"}     
     end
     

data/spec/cases/oauth_spec.rb

@@ -29,26 +29,27 @@ describe "Koala::Facebook::OAuth" do
     @time.stub!(:to_i).and_return(1273363199)
   end
 
-  # initialization
-  it "properly initializes" do
-    @oauth.should
-  end
+  describe ".new" do
+    it "properly initializes" do
+      @oauth.should
+    end
 
-  it "properly sets attributes" do
-    (@oauth.app_id == @app_id &&
-      @oauth.app_secret == @secret &&
-      @oauth.oauth_callback_url == @callback_url).should be_true
-  end
+    it "properly sets attributes" do
+      (@oauth.app_id == @app_id &&
+        @oauth.app_secret == @secret &&
+        @oauth.oauth_callback_url == @callback_url).should be_true
+    end
 
-  it "properly initializes without a callback_url" do
-    @oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-  end
+    it "properly initializes without a callback_url" do
+      @oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
+    end
 
-  it "properly sets attributes without a callback URL" do
-    @oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-    (@oauth.app_id == @app_id &&
-      @oauth.app_secret == @secret &&
-      @oauth.oauth_callback_url == nil).should be_true
+    it "properly sets attributes without a callback URL" do
+      @oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
+      (@oauth.app_id == @app_id &&
+        @oauth.app_secret == @secret &&
+        @oauth.oauth_callback_url == nil).should be_true
+    end
   end
 
   describe "for cookie parsing" do
@@ -103,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
@@ -165,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
@@ -209,88 +226,157 @@ describe "Koala::Facebook::OAuth" do
     end
   end
 
-  # OAuth URLs
-
   describe "for URL generation" do
-
-    describe "for OAuth codes" do
-      # url_for_oauth_code
+    describe "#url_for_oauth_code" do
       it "generates a properly formatted OAuth code URL with the default values" do
         url = @oauth.url_for_oauth_code
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{@callback_url}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when a callback is given" do
         callback = "foo.com"
         url = @oauth.url_for_oauth_code(:callback => callback)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}")
       end
 
       it "generates a properly formatted OAuth code URL when permissions are requested as a string" do
         permissions = "publish_stream,read_stream"
         url = @oauth.url_for_oauth_code(:permissions => permissions)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{@callback_url}&scope=#{permissions}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when permissions are requested as a string" do
         permissions = ["publish_stream", "read_stream"]
         url = @oauth.url_for_oauth_code(:permissions => permissions)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{@callback_url}&scope=#{permissions.join(",")}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions.join(",")}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "generates a properly formatted OAuth code URL when both permissions and callback are provided" do
         permissions = "publish_stream,read_stream"
         callback = "foo.com"
         url = @oauth.url_for_oauth_code(:callback => callback, :permissions => permissions)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}&scope=#{permissions}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&scope=#{CGI.escape permissions}&redirect_uri=#{CGI.escape callback}")
       end
 
       it "generates a properly formatted OAuth code URL when a display is given as a string" do
         url = @oauth.url_for_oauth_code(:display => "page")
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{@callback_url}&display=page"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&display=page&redirect_uri=#{CGI.escape @callback_url}")
       end
 
       it "raises an exception if no callback is given in initialization or the call" do
         oauth2 = Koala::Facebook::OAuth.new(@app_id, @secret)
         lambda { oauth2.url_for_oauth_code }.should raise_error(ArgumentError)
       end
+      
+      it "includes any additional options as URL parameters, appropriately escaped" do
+        params = {
+          :url => "http://foo.bar?c=2",
+          :email => "cdc@b.com"
+        }
+        url = @oauth.url_for_oauth_code(params)
+        params.each_pair do |key, value| 
+          url.should =~ /[\&\?]#{key}=#{CGI.escape value}/
+        end
+      end
     end
 
-    describe "for access token URLs" do
+    describe "#url_for_access_token" do
       before :each do
         # since we're just composing a URL here, we don't need to have a real code
         @code ||= "test_code"
       end
-
-      # url_for_access_token
+      
       it "generates a properly formatted OAuth token URL when provided a code" do
         url = @oauth.url_for_access_token(@code)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{@callback_url}&client_secret=#{@secret}&code=#{@code}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape @callback_url}").should be_true
       end
 
       it "generates a properly formatted OAuth token URL when provided a callback" do
         callback = "foo.com"
         url = @oauth.url_for_access_token(@code, :callback => callback)
-        url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@secret}&code=#{@code}"
+        url.should match_url("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape callback}").should be_true
+      end
+
+      it "includes any additional options as URL parameters, appropriately escaped" do
+        params = {
+          :url => "http://foo.bar?c=2",
+          :email => "cdc@b.com"
+        }
+        url = @oauth.url_for_access_token(@code, params)
+        params.each_pair do |key, value| 
+          url.should =~ /[\&\?]#{key}=#{CGI.escape value}/
+        end
+      end
+    end
+    
+    describe "#url_for_dialog" do
+      it "builds the base properly" do
+        dialog_type = "my_dialog_type"
+        @oauth.url_for_dialog(dialog_type).should =~ /^http:\/\/#{Koala::Facebook::DIALOG_HOST}\/dialog\/#{dialog_type}/
+      end
+      
+      it "adds the app_id/client_id to the url" do
+        automatic_params = {:app_id => @app_id, :client_id => @client_id}
+        url = @oauth.url_for_dialog("foo", automatic_params)
+        automatic_params.each_pair do |key, value|
+          # we're slightly simplifying how encode_params works, but for strings/ints, it's okay
+          url.should =~ /[\&\?]#{key}=#{CGI.escape value.to_s}/
+        end
+      end
+            
+      it "includes any additional options as URL parameters, appropriately escaped" do
+        params = {
+          :url => "http://foo.bar?c=2",
+          :email => "cdc@b.com"
+        }
+        url = @oauth.url_for_dialog("friends", params)
+        params.each_pair do |key, value| 
+          # we're slightly simplifying how encode_params works, but strings/ints, it's okay
+          url.should =~ /[\&\?]#{key}=#{CGI.escape value.to_s}/
+        end
+      end
+      
+      describe "real examples from FB documentation" do
+        # see http://developers.facebook.com/docs/reference/dialogs/
+        # slightly brittle (e.g. if parameter order changes), but still useful
+        it "can generate a send dialog" do
+          url = @oauth.url_for_dialog("send", :name => "People Argue Just to Win", :link => "http://www.nytimes.com/2011/06/15/arts/people-argue-just-to-win-scholars-assert.html")
+          url.should match_url("http://www.facebook.com/dialog/send?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
+        end
+      
+        it "can generate a feed dialog" do
+          url = @oauth.url_for_dialog("feed", :name => "People Argue Just to Win", :link => "http://www.nytimes.com/2011/06/15/arts/people-argue-just-to-win-scholars-assert.html")
+          url.should match_url("http://www.facebook.com/dialog/feed?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
+        end
+      
+        it "can generate a oauth dialog" do
+          url = @oauth.url_for_dialog("oauth", :scope => "email", :response_type => "token")
+          url.should match_url("http://www.facebook.com/dialog/oauth?app_id=#{@app_id}&client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}&response_type=token&scope=email")
+        end
+      
+        it "can generate a pay dialog" do
+          url = @oauth.url_for_dialog("pay", :order_id => "foo", :credits_purchase => false)
+          url.should match_url("http://www.facebook.com/dialog/pay?app_id=#{@app_id}&client_id=#{@app_id}&order_id=foo&credits_purchase=false&redirect_uri=#{CGI.escape @callback_url}")
+        end
       end
     end
   end
 
   describe "for fetching access tokens" do
-    describe ".get_access_token_info" do
+    describe "#get_access_token_info" do
       it "uses options[:redirect_uri] if provided" do
         uri = "foo"
-        Koala.should_receive(:make_request).with(anything, hash_including(:redirect_uri => uri), anything, anything).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, hash_including(:redirect_uri => uri), anything, anything).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_access_token_info(@code, :redirect_uri => uri)
       end
       
       it "uses the redirect_uri used to create the @oauth if no :redirect_uri option is provided" do
-        Koala.should_receive(:make_request).with(anything, hash_including(:redirect_uri => @callback_url), anything, anything).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, hash_including(:redirect_uri => @callback_url), anything, anything).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_access_token_info(@code)        
       end
       
       it "makes a GET request" do
-        Koala.should_receive(:make_request).with(anything, anything, "get", anything).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, anything, "get", anything).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_access_token_info(@code)                
       end
 
@@ -311,11 +397,11 @@ describe "Koala::Facebook::OAuth" do
       end
     end
     
-    describe ".get_access_token" do
+    describe "#get_access_token" do
       # TODO refactor these to be proper tests with stubs and tests against real data
       it "passes on any options provided to make_request" do
         options = {:a => 2}
-        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_access_token(@code, options)
       end
 
@@ -354,7 +440,7 @@ describe "Koala::Facebook::OAuth" do
 
       it "passes on any options provided to make_request" do
         options = {:a => 2}
-        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_app_access_token_info(options)
       end
     end
@@ -373,7 +459,7 @@ describe "Koala::Facebook::OAuth" do
 
       it "passes on any options provided to make_request" do
         options = {:a => 2}
-        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "", {}))
+        Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "", {}))
         @oauth.get_app_access_token(options)
       end
     end
@@ -454,7 +540,7 @@ describe "Koala::Facebook::OAuth" do
 
         it "passes on any options provided to make_request" do
           options = {:a => 2}
-          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "[{}]", {}))
+          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "[{}]", {}))
           @oauth.get_token_info_from_session_keys([], options)
         end
       end
@@ -486,7 +572,7 @@ describe "Koala::Facebook::OAuth" do
 
         it "passes on any options provided to make_request" do
           options = {:a => 2}
-          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "[{}]", {}))
+          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "[{}]", {}))
           @oauth.get_tokens_from_session_keys([], options)
         end
       end
@@ -516,7 +602,7 @@ describe "Koala::Facebook::OAuth" do
 
         it "passes on any options provided to make_request" do
           options = {:a => 2}
-          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::Response.new(200, "[{}]", {}))
+          Koala.should_receive(:make_request).with(anything, anything, anything, hash_including(options)).and_return(Koala::HTTPService::Response.new(200, "[{}]", {}))
           @oauth.get_token_from_session_key("", options)
         end
       end