koala 1.2.1 → 1.3.0rc1

data/spec/cases/http_service_spec.rb

@@ -90,7 +90,7 @@ describe "Koala::HTTPService" do
     end
   end
 
-  describe "#encode_params" do
+  describe ".encode_params" do
     it "returns an empty string if param_hash evaluates to false" do
       Koala::HTTPService.encode_params(nil).should == ''
     end
@@ -135,7 +135,7 @@ describe "Koala::HTTPService" do
     end
   end
 
-  describe "#make_request" do
+  describe ".make_request" do
     before :each do
       # Setup stubs for make_request to execute without exceptions
       @mock_body = stub('Typhoeus response body')
@@ -273,7 +273,7 @@ describe "Koala::HTTPService" do
       :always_use_ssl => :use_ssl,
       :proxy => :proxy 
     }.each_pair do |deprecated_method, parameter|
-      describe "##{deprecated_method}" do
+      describe ".#{deprecated_method}" do
         context "read" do
           it "reads http_options[:#{parameter}]" do
             value = "foo"
@@ -305,7 +305,7 @@ describe "Koala::HTTPService" do
     
     # ssl options
     [:ca_path, :ca_file, :verify_mode].each do |deprecated_method|
-      describe "##{deprecated_method}" do
+      describe ".#{deprecated_method}" do
         context "read" do
           it "reads http_options[:ssl][:#{deprecated_method}] if http_options[:ssl]" do
             value = "foo"

data/spec/cases/koala_spec.rb

@@ -1,15 +1,33 @@
 require 'spec_helper'
 
-describe "Koala" do
-  it "has a version" do
-    Koala.const_defined?("VERSION").should be_true
-  end
+describe Koala do
+
   
   it "has an http_service accessor" do
     Koala.should respond_to(:http_service)
     Koala.should respond_to(:http_service=)
   end
   
+  describe "constants" do
+    it "has a version" do
+      Koala.const_defined?("VERSION").should be_true
+    end
+
+    describe Koala::Facebook do      
+      it "defines GRAPH_SERVER" do
+        Koala::Facebook::GRAPH_SERVER.should == "graph.facebook.com"
+      end
+
+      it "defines REST_SERVER" do
+        Koala::Facebook::REST_SERVER.should == "api.facebook.com"
+      end
+      
+      it "defines DIALOG_HOST" do
+        Koala::Facebook::DIALOG_HOST.should == "www.facebook.com"
+      end
+    end
+  end
+  
   context "for deprecated services" do
     before :each do
       @service = Koala.http_service

data/spec/cases/multipart_request_spec.rb

@@ -9,7 +9,7 @@ describe Koala::MultipartRequest do
     Koala::MultipartRequest.mime_type.should == 'multipart/form-data'
   end
   
-  describe ".process_request?" do
+  describe "#process_request?" do
     before :each do
       @env = {}
       @multipart = Koala::MultipartRequest.new
@@ -43,7 +43,7 @@ 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 

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
@@ -209,75 +210,144 @@ 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, "", {}))
@@ -311,7 +381,7 @@ 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}

data/spec/cases/test_users_spec.rb

@@ -87,7 +87,7 @@ describe "Koala::Facebook::TestUsers" do
 
       # TEST USER MANAGEMENT
 
-      describe ".create" do
+      describe "#create" do
         it "should create a test user when not given installed" do
           result = @test_users.create(false)
           @user1 = result["id"]
@@ -132,7 +132,7 @@ describe "Koala::Facebook::TestUsers" do
         end
       end
 
-      describe ".delete" do
+      describe "#delete" do
         before :each do
           @user1 = @test_users.create(true, "read_stream")
           @user2 = @test_users.create(true, "read_stream,user_interests")
@@ -153,7 +153,7 @@ describe "Koala::Facebook::TestUsers" do
         end
       end
 
-      describe ".delete_all" do
+      describe "#delete_all" do
         it "should delete all users found by the list commnand" do
           array = [1, 2, 3]
           @test_users.should_receive(:list).and_return(array)
@@ -162,7 +162,7 @@ describe "Koala::Facebook::TestUsers" do
         end
       end
 
-      describe ".update" do
+      describe "#update" do
         before :each do
           @updates = {:name => "Foo Baz"}
           # we stub out :graph_call, but still need to be able to delete the users

data/spec/cases/uploadable_io_spec.rb

@@ -212,7 +212,7 @@ describe "Koala::UploadableIO" do
     end
   end
 
-  describe "#binary_content?" do
+  describe ".binary_content?" do
     it "returns true for Rails 3 file uploads" do
       Koala::UploadableIO.binary_content?(rails_3_mocks.last).should be_true
     end

data/spec/cases/utils_spec.rb

@@ -1,10 +1,34 @@
 require 'spec_helper'
 
 describe Koala::Utils do
-  it "has a deprecate method" do
-    Koala::Utils.should respond_to(:deprecate)
-  end
+  describe ".deprecate" do    
+    before :each do
+      # unstub deprecate so we can test it
+      Koala::Utils.unstub(:deprecate)
+    end
+    
+    it "has a deprecation prefix that includes the words Koala and deprecation" do
+      Koala::Utils::DEPRECATION_PREFIX.should =~ /koala/i
+      Koala::Utils::DEPRECATION_PREFIX.should =~ /deprecation/i      
+    end
+    
+    it "prints a warning with Kernel.warn" do
+      message = Time.now.to_s + rand.to_s
+      Kernel.should_receive(:warn)
+      Koala::Utils.deprecate(message)
+    end
 
-  # AFAIK there's no way to test that (Kernel.)warn receives the text
-  # Kernel.should_receive(:warn) doesn't seem to work, even though the text gets printed
+    it "prints the deprecation prefix and the warning" do
+      message = Time.now.to_s + rand.to_s
+      Kernel.should_receive(:warn).with(Koala::Utils::DEPRECATION_PREFIX + message)
+      Koala::Utils.deprecate(message)
+    end
+    
+    it "only prints each unique message once" do
+      message = Time.now.to_s + rand.to_s
+      Kernel.should_receive(:warn).once
+      Koala::Utils.deprecate(message)
+      Koala::Utils.deprecate(message)
+    end
+  end
 end

data/spec/fixtures/mock_facebook_responses.yml

@@ -14,30 +14,15 @@
 rest_api:
 
 # -- Stubbed Responses --
-  /method/fql.query:
-    query=select first_name from user where uid = 2901279:
-      get:
-        no_token: '[{"first_name":"Luke"}]'
-        with_token: '[{"first_name":"Luke"}]'
-    query=select read_stream from permissions where uid = 2901279:
-      get:
-        with_token: '[{"read_stream":1}]'
-        no_token: '{"error_code":104,"error_msg":"Requires valid signature","request_args":[{"key":"method","value":"fql.query"},{"key":"format","value":"json"},{"key":"query","value":"select read_stream from permissions where uid = 2901279"}]}'
-
-  /method/fql.multiquery:
-    'queries=<%= MultiJson.encode({"query1" => "select post_id from stream where source_id = me()", "query2" => "select fromid from comment where post_id in (select post_id from #query1)", "query3" => "select uid, name from user where uid in (select fromid from #query2)"}) %>':
-      get:
-        with_token: '[{"name":"query1", "fql_result_set":[]},{"name":"query2", "fql_result_set":[]},{"name":"query3", "fql_result_set":[]}]'
-        no_token: '{"error_code":104,"error_msg":"Requires valid signature","request_args":[{"key":"method","value":"fql.query"},{"key":"format","value":"json"},{"key":"query","value":"select read_stream from permissions where uid = 2901279"}]}'
-    'queries=<%= MultiJson.encode({"query1" => "select first_name from user where uid = 2901279", "query2" => "select first_name from user where uid = 2905623"}) %>':
-      get:
-        with_token: '[{"name":"query1", "fql_result_set":[{"first_name":"Luke"}]},{"name":"query2", "fql_result_set":[{"first_name":"Alex"}]}]'
-        no_token: '[{"name":"query1", "fql_result_set":[{"first_name":"Luke"}]},{"name":"query2", "fql_result_set":[{"first_name":"Alex"}]}]'
   /method/admin.setAppProperties:
     'properties={"desktop":0}':
       post:
         with_token: 'true'
-
+  /method/fql.query: # for testing the beta tier
+    query=select first_name from user where uid = 2901279:
+      get:
+        no_token: '[{"first_name":"Luke"}]'
+        with_token: '[{"first_name":"Luke"}]'
 
 
 
@@ -227,29 +212,26 @@ graph_api:
         with_token: '{"data": [{}], "paging": {}}'
 
   /lukeshepard/picture:
-    type=large:
+    no_args:
       get:
         no_token:
           code: 302
           headers:
-            Location: https://facebook.com/large
+            Location: http://facebook.com/
         with_token:
           code: 302
           headers:
-            Location: https://facebook.com/large
-
-
-  /chris.baclig/picture:
-    no_args:
+            Location: http://facebook.com/
+    type=large:
       get:
         no_token:
           code: 302
           headers:
-            Location: http://facebook.com/
+            Location: https://facebook.com/large
         with_token:
           code: 302
           headers:
-            Location: http://facebook.com/
+            Location: https://facebook.com/large
 
   /comments:
     ids=http://developers.facebook.com/blog/post/472:
@@ -279,6 +261,25 @@ graph_api:
         with_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
         no_token: '{"data": [{"id": "507731521_100412693339488"}], "paging": {"previous": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000", "next": "https:\/\/graph.facebook.com\/7204941866\/photos?limit=25&until=2008-09-15T18%3A30%3A25%2B0000"}}'
 
+  /fql:
+    q=select first_name from user where uid = 2901279:
+      get:
+        no_token: '[{"first_name":"Luke"}]'
+        with_token: '[{"first_name":"Luke"}]'
+    q=select read_stream from permissions where uid = 2901279:
+      get:
+        <<: *token_required
+        with_token: '[{"read_stream":1}]'
+    'q=<%= MultiJson.encode({"query1" => "select post_id from stream where source_id = me()", "query2" => "select fromid from comment where post_id in (select post_id from #query1)", "query3" => "select uid, name from user where uid in (select fromid from #query2)"}) %>':
+      get:
+        <<: *token_required
+        with_token: '[{"name":"query1", "fql_result_set":[]},{"name":"query2", "fql_result_set":[]},{"name":"query3", "fql_result_set":[]}]'
+    'q=<%= MultiJson.encode({"query1" => "select first_name from user where uid = 2901279", "query2" => "select first_name from user where uid = 2905623"}) %>':
+      get:
+        with_token: '[{"name":"query1", "fql_result_set":[{"first_name":"Luke"}]},{"name":"query2", "fql_result_set":[{"first_name":"Alex"}]}]'
+        no_token: '[{"name":"query1", "fql_result_set":[{"first_name":"Luke"}]},{"name":"query2", "fql_result_set":[{"first_name":"Alex"}]}]'
+
+
   '/115349521819193_113815981982767':
     no_args:
       delete:
@@ -290,6 +291,12 @@ graph_api:
         <<: *token_required
         with_token: '{"access_token": "<%= APP_ACCESS_TOKEN %>"}'
 
+
+  '/<%= APP_ID %>':
+    restrictions=<%= MultiJson.encode({"age_distr" => "13+"}) %>:
+      post:
+        with_token: "true"
+
   # -- OAuth responses --
   /oauth/access_token:
     client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&code=<%= OAUTH_CODE %>&redirect_uri=<%= OAUTH_DATA["callback_url"] %>: