koala 1.2.1 → 1.3.0

data/spec/cases/test_users_spec.rb

@@ -1,271 +1,328 @@
 require 'spec_helper'
 
 describe "Koala::Facebook::TestUsers" do
-  context "with access token" do
-    before :all do
-      # get oauth data
-      @app_id = KoalaTest.app_id
-      @secret = KoalaTest.secret
-      @app_access_token = KoalaTest.app_access_token
-
-      # check OAuth data
-      unless @app_id && @secret && @app_access_token
-        raise Exception, "Must supply OAuth app id, secret, app_access_token, and callback to run live subscription tests!"
-      end
+  before :all do
+    # get oauth data
+    @app_id = KoalaTest.app_id
+    @secret = KoalaTest.secret
+    @app_access_token = KoalaTest.app_access_token
+
+    @test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
+
+    # check OAuth data
+    unless @app_id && @secret && @app_access_token
+      raise Exception, "Must supply OAuth app id, secret, app_access_token, and callback to run live subscription tests!"
     end
-    
-    after :each do
-      # clean up any test users
-      ((@network || []) + [@user1, @user2]).each do |u|
-        puts "Unable to delete test user #{u.inspect}" if u && !(@test_users.delete(u) rescue false)
-      end
+  end
+  
+  after :each do
+    # clean up any test users
+    ((@network || []) + [@user1, @user2]).each do |u|
+      puts "Unable to delete test user #{u.inspect}" if u && !(@test_users.delete(u) rescue false)
     end
+  end
 
-    describe "when initializing" do
-      # basic initialization
-      it "should initialize properly with an app_id and an app_access_token" do
-        test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :app_access_token => @app_access_token)
-        test_users.should be_a(Koala::Facebook::TestUsers)
-      end
+  describe "when initializing" do
+    # basic initialization
+    it "initializes properly with an app_id and an app_access_token" do
+      test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :app_access_token => @app_access_token)
+      test_users.should be_a(Koala::Facebook::TestUsers)
+    end
 
-      # init with secret / fetching the token
-      it "should initialize properly with an app_id and a secret" do
-        test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
-        test_users.should be_a(Koala::Facebook::TestUsers)
-      end
+    # init with secret / fetching the token
+    it "initializes properly with an app_id and a secret" do
+      test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
+      test_users.should be_a(Koala::Facebook::TestUsers)
+    end
+
+    it "uses the OAuth class to fetch a token when provided an app_id and a secret" do
+      oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
+      token = oauth.get_app_access_token
+      oauth.should_receive(:get_app_access_token).and_return(token)
+      Koala::Facebook::OAuth.should_receive(:new).with(@app_id, @secret).and_return(oauth)
+      test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
+    end
+
+    # attributes
+    it "allows read access to app_id, app_access_token, and secret" do
+      # in Ruby 1.9, .method returns symbols
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:app_id)
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:app_id=)
+    end
+
+    it "allows read access to app_access_token" do
+      # in Ruby 1.9, .method returns symbols
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:app_access_token)
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:app_access_token=)
+    end
+
+    it "allows read access to secret" do
+      # in Ruby 1.9, .method returns symbols
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:secret)
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:secret=)
+    end
+
+    it "allows read access to api" do
+      # in Ruby 1.9, .method returns symbols
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:api)
+      Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:api=)
+    end
+
+    # old graph_api accessor
+    it "returns the api object when graph_api is called" do
+      test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
+      test_users.graph_api.should == test_users.api
+    end
 
-      it "should use the OAuth class to fetch a token when provided an app_id and a secret" do
-        oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-        token = oauth.get_app_access_token
-        oauth.should_receive(:get_app_access_token).and_return(token)
-        Koala::Facebook::OAuth.should_receive(:new).with(@app_id, @secret).and_return(oauth)
-        test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
+    it "fire a deprecation warning when graph_api is called" do
+      test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
+      Koala::Utils.should_receive(:deprecate)
+      test_users.graph_api
+    end
+  end
+
+  describe "when used without network" do
+    # TEST USER MANAGEMENT
+
+    describe "#create" do
+      it "creates a test user when not given installed" do
+        result = @test_users.create(false)
+        @user1 = result["id"]
+        result.should be_a(Hash)
+        (result["id"] && result["access_token"] && result["login_url"]).should
       end
 
-      # attributes
-      it "should allow read access to app_id, app_access_token, and secret" do
-        # in Ruby 1.9, .method returns symbols
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:app_id)
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:app_id=)
+      it "creates a test user when not given installed, ignoring permissions" do
+        result = @test_users.create(false, "read_stream")
+        @user1 = result["id"]
+        result.should be_a(Hash)
+        (result["id"] && result["access_token"] && result["login_url"]).should
       end
 
-      it "should allow read access to app_access_token" do
-        # in Ruby 1.9, .method returns symbols
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:app_access_token)
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:app_access_token=)
+      it "accepts permissions as a string" do
+        @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
+        result = @test_users.create(true, "read_stream,publish_stream")
       end
 
-      it "should allow read access to secret" do
-        # in Ruby 1.9, .method returns symbols
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:secret)
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:secret=)
+      it "accepts permissions as an array" do
+        @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
+        result = @test_users.create(true, ["read_stream", "publish_stream"])
       end
 
-      it "should allow read access to api" do
-        # in Ruby 1.9, .method returns symbols
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should include(:api)
-        Koala::Facebook::TestUsers.instance_methods.map(&:to_sym).should_not include(:api=)
+      it "creates a test user when given installed and a permission" do
+        result = @test_users.create(true, "read_stream")
+        @user1 = result["id"]
+        result.should be_a(Hash)
+        (result["id"] && result["access_token"] && result["login_url"]).should
       end
 
-      # old graph_api accessor
-      it "returns the api object when graph_api is called" do
-        test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
-        test_users.graph_api.should == test_users.api
+      it "lets you specify other graph arguments, like uid and access token" do
+        args = {:uid => "some test user ID", :owner_access_token => "some owner access token"}
+        @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including(args), anything, anything)
+        @test_users.create(true, nil, args)
       end
 
-      it "fire a deprecation warning when graph_api is called" do
-        test_users = Koala::Facebook::TestUsers.new(:app_id => @app_id, :secret => @secret)
-        Koala::Utils.should_receive(:deprecate)
-        test_users.graph_api
+      it "lets you specify http options that get passed through to the graph call" do
+        options = {:some_http_option => true}
+        @test_users.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
+        @test_users.create(true, nil, {}, options)
       end
     end
-
-    describe "when used without network" do
+    
+    describe "#list" do
       before :each do
-        @test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
+        @user1 = @test_users.create(true, "read_stream")
+        @user2 = @test_users.create(true, "read_stream,user_interests")
       end
 
-      # TEST USER MANAGEMENT
-
-      describe ".create" do
-        it "should create a test user when not given installed" do
-          result = @test_users.create(false)
-          @user1 = result["id"]
-          result.should be_a(Hash)
-          (result["id"] && result["access_token"] && result["login_url"]).should
-        end
-
-        it "should create a test user when not given installed, ignoring permissions" do
-          result = @test_users.create(false, "read_stream")
-          @user1 = result["id"]
-          result.should be_a(Hash)
-          (result["id"] && result["access_token"] && result["login_url"]).should
-        end
-
-        it "should accept permissions as a string" do
-          @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
-          result = @test_users.create(true, "read_stream,publish_stream")
-        end
-
-        it "should accept permissions as an array" do
-          @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including("permissions" => "read_stream,publish_stream"), anything, anything)
-          result = @test_users.create(true, ["read_stream", "publish_stream"])
-        end
-
-        it "should create a test user when given installed and a permission" do
-          result = @test_users.create(true, "read_stream")
-          @user1 = result["id"]
-          result.should be_a(Hash)
-          (result["id"] && result["access_token"] && result["login_url"]).should
-        end
-
-        it "lets you specify other graph arguments, like uid and access token" do
-          args = {:uid => "some test user ID", :owner_access_token => "some owner access token"}
-          @test_users.graph_api.should_receive(:graph_call).with(anything, hash_including(args), anything, anything)
-          @test_users.create(true, nil, args)
-        end
-
-        it "lets you specify http options that get passed through to the graph call" do
-          options = {:some_http_option => true}
-          @test_users.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
-          @test_users.create(true, nil, {}, options)
-        end
+      it "lists test users" do
+        result = @test_users.list
+        result.should be_an(Array)
+        first_user, second_user = result[0], result[1]
+        (first_user["id"] && first_user["access_token"] && first_user["login_url"]).should
+        (second_user["id"] && second_user["access_token"] && second_user["login_url"]).should
       end
+      
+      it "accepts http options" do
+        options = {:some_http_option => true}          
+        @test_users.api.should_receive(:graph_call).with(anything, anything, anything, options)
+        @test_users.list(options)
+      end
+    end
 
-      describe ".delete" do
-        before :each do
-          @user1 = @test_users.create(true, "read_stream")
-          @user2 = @test_users.create(true, "read_stream,user_interests")
-        end
-
-        it "should delete a user by id" do
-          @test_users.delete(@user1['id']).should be_true
-          @user1 = nil
-        end
-
-        it "should delete a user by hash" do
-          @test_users.delete(@user2).should be_true
-          @user2 = nil
-        end
+    describe "#delete" do
+      before :each do
+        @user1 = @test_users.create(true, "read_stream")
+        @user2 = @test_users.create(true, "read_stream,user_interests")
+      end
 
-        it "should not delete users when provided a false ID" do
-          lambda { @test_users.delete("#{@user1['id']}1") }.should raise_exception(Koala::Facebook::APIError)
-        end
+      it "deletes a user by id" do
+        @test_users.delete(@user1['id']).should be_true
+        @user1 = nil
       end
 
-      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)
-          array.each {|i| @test_users.should_receive(:delete).with(i) }
-          @test_users.delete_all
-        end
+      it "deletes a user by hash" do
+        @test_users.delete(@user2).should be_true
+        @user2 = nil
       end
 
-      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
-          @test_users2 = Koala::Facebook::TestUsers.new(:app_id => @test_users.app_id, :app_access_token => @test_users.app_access_token)
-        end
+      it "does not delete users when provided a false ID" do
+        lambda { @test_users.delete("#{@user1['id']}1") }.should raise_exception(Koala::Facebook::APIError)
+      end
+      
+      it "lets you specify http options that get passed through to the graph call" do
+        options = {:some_http_option => true}
+        # technically this goes through delete_object, but this makes it less brittle
+        @test_users.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
+        @test_users.delete("user", options)
+      end        
+    end
 
-        it "makes a POST with the test user Graph API " do
-          @user1 = @test_users2.create(true)
-          @test_users2.graph_api.should_receive(:graph_call).with(anything, anything, "post", anything)
-          @test_users2.update(@user1, @updates)
-        end
+    describe "#delete_all" do
+      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 the batch call" do
+        options = {:some_http_option => true}
+        @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
 
-        it "makes a request to the test user with the update params " do
-          @user1 = @test_users2.create(true)
-          @test_users2.graph_api.should_receive(:graph_call).with(@user1["id"], @updates, anything, anything)
-          @test_users2.update(@user1, @updates)
-        end
+    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
+        @test_users2 = Koala::Facebook::TestUsers.new(:app_id => @test_users.app_id, :app_access_token => @test_users.app_access_token)
+      end
 
-        it "works" do
-          @user1 = @test_users.create(true)
-          @test_users.update(@user1, @updates)
-          user_info = Koala::Facebook::API.new(@user1["access_token"]).get_object(@user1["id"])
-          user_info["name"].should == @updates[:name]
-        end
+      it "makes a POST with the test user Graph API " do
+        @user1 = @test_users2.create(true)
+        @test_users2.graph_api.should_receive(:graph_call).with(anything, anything, "post", anything)
+        @test_users2.update(@user1, @updates)
       end
 
-      describe "with existing users" do
-        before :each do
-          @user1 = @test_users.create(true, "read_stream")
-          @user2 = @test_users.create(true, "read_stream,user_interests")
-        end
+      it "makes a request to the test user with the update params " do
+        @user1 = @test_users2.create(true)
+        @test_users2.graph_api.should_receive(:graph_call).with(@user1["id"], @updates, anything, anything)
+        @test_users2.update(@user1, @updates)
+      end
+      
+      it "accepts an options hash" do
+        options = {:some_http_option => true}          
+        @test_users2.graph_api.should_receive(:graph_call).with(anything, anything, anything, options)
+        @test_users2.update("foo", @updates, options)
+      end
 
-        it "should list test users" do
-          result = @test_users.list
-          result.should be_an(Array)
-          first_user, second_user = result[0], result[1]
-          (first_user["id"] && first_user["access_token"] && first_user["login_url"]).should
-          (second_user["id"] && second_user["access_token"] && second_user["login_url"]).should
-        end
+      it "works" do
+        @user1 = @test_users.create(true)
+        @test_users.update(@user1, @updates)
+        user_info = Koala::Facebook::API.new(@user1["access_token"]).get_object(@user1["id"])
+        user_info["name"].should == @updates[:name]
+      end
+    end
+    
+    describe "#befriend" do
+      before :each do
+        @user1 = @test_users.create(true, "read_stream")
+        @user2 = @test_users.create(true, "read_stream,user_interests")
+      end
+      
+      it "makes two users into friends with string hashes" do
+        result = @test_users.befriend(@user1, @user2)
+        result.should be_true
+      end
 
-        it "should make two users into friends with string hashes" do
-          result = @test_users.befriend(@user1, @user2)
-          result.should be_true
-        end
+      it "makes two users into friends with symbol hashes" do
+        new_user_1 = {}
+        @user1.each_pair {|k, v| new_user_1[k.to_sym] = v}
+        new_user_2 = {}
+        @user2.each_pair {|k, v| new_user_2[k.to_sym] = v}
 
-        it "should make two users into friends with symbol hashes" do
-          new_user_1 = {}
-          @user1.each_pair {|k, v| new_user_1[k.to_sym] = v}
-          new_user_2 = {}
-          @user2.each_pair {|k, v| new_user_2[k.to_sym] = v}
+        result = @test_users.befriend(new_user_1, new_user_2)
+        result.should be_true
+      end
 
-          result = @test_users.befriend(new_user_1, new_user_2)
-          result.should be_true
-        end
+      it "does not accept user IDs anymore" do
+        lambda { @test_users.befriend(@user1["id"], @user2["id"]) }.should raise_exception
+      end
+      
+      it "accepts http options passed to both calls" do
+        options = {:some_http_option => true}  
+        # should come twice, once for each user
+        Koala.http_service.should_receive(:make_request).with(anything, anything, anything, options).twice.and_return(Koala::HTTPService::Response.new(200, "{}", {}))
+        @test_users.befriend(@user1, @user2, options)
+      end        
+    end
+  end # when used without network
 
-        it "should not accept user IDs anymore" do
-          lambda { @test_users.befriend(@user1["id"], @user2["id"]) }.should raise_exception
-        end
-      end # with existing users
+  describe "#test_user_accounts_path" do
+    it "returns the app_id/accounts/test-users" do
+      @test_users.test_user_accounts_path.should == "/#{@app_id}/accounts/test-users"
+    end
+  end
 
-    end # when used without network
+  describe "when creating a network of friends" do
+    before :each do
+      @network = []
 
-    describe "when creating a network of friends" do
-      before :each do
-        @test_users = Koala::Facebook::TestUsers.new({:app_access_token => @app_access_token, :app_id => @app_id})
-        @network = []
-
-        if KoalaTest.mock_interface?
-          id_counter = 999999900
-          @test_users.stub!(:create).and_return do
-            id_counter += 1
-            {"id" => id_counter, "access_token" => @token, "login_url" => "https://www.facebook.com/platform/test_account.."}
-          end
-          @test_users.stub!(:befriend).and_return(true)
-          @test_users.stub!(:delete).and_return(true)
+      if KoalaTest.mock_interface?
+        id_counter = 999999900
+        @test_users.stub!(:create).and_return do
+          id_counter += 1
+          {"id" => id_counter, "access_token" => @token, "login_url" => "https://www.facebook.com/platform/test_account.."}
         end
+        @test_users.stub!(:befriend).and_return(true)
+        @test_users.stub!(:delete).and_return(true)
       end
+    end
 
-      describe "tests that create users" do
-        it "should create a 5 person network" do
-          size = 5
-          @network = @test_users.create_network(size)
-          @network.should be_a(Array)
-          @network.size.should == size
-        end
+    describe "tests that create users" do
+      it "creates a 5 person network" do
+        size = 5
+        @network = @test_users.create_network(size)
+        @network.should be_a(Array)
+        @network.size.should == size
       end
+    end
 
-      it "has no built-in network size limit" do
-        times = 100
-        @test_users.should_receive(:create).exactly(times).times
-        @test_users.stub!(:befriend)
-        @network = @test_users.create_network(times)
-      end
+    it "has no built-in network size limit" do
+      times = 100
+      @test_users.should_receive(:create).exactly(times).times
+      @test_users.stub!(:befriend)
+      @test_users.create_network(times)
+    end
 
-      it "should pass on the installed and permissions parameters to create" do
-        perms = ["read_stream", "offline_access"]
-        installed = false
-        count = 25
-        @test_users.should_receive(:create).exactly(count).times.with(installed, perms)
-        @test_users.stub!(:befriend)
-        @network = @test_users.create_network(count, installed, perms)
-      end
+    it "passes on the installed and permissions parameters to create" do
+      perms = ["read_stream", "offline_access"]
+      installed = false
+      count = 25
+      @test_users.should_receive(:create).exactly(count).times.with(installed, perms, anything)
+      @test_users.stub!(:befriend)
+      @test_users.create_network(count, installed, perms)
+    end
 
-    end # when creating network
-  end
+    it "accepts http options that are passed to both the create and befriend calls" do
+      count = 25
+      options = {:some_http_option => true}  
+      @test_users.should_receive(:create).exactly(count).times.with(anything, anything, options).and_return({})
+      # there are more befriends than creates, but we don't need to do the extra work to calculate out the exact #
+      @test_users.should_receive(:befriend).at_least(count).times.with(anything, anything, options)
+      @test_users.create_network(count, true, "", options)
+    end
+  end # when creating network
 end  # describe Koala TestUsers

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