koala 1.2.1 → 1.3.0

data/spec/cases/realtime_updates_spec.rb

@@ -24,33 +24,37 @@ describe "Koala::Facebook::RealtimeUpdates" do
     end
   end
 
-  describe "when initializing" do
+  before :each do 
+    @updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
+  end
+
+  describe ".new" do
     # basic initialization
-    it "should initialize properly with an app_id and an app_access_token" do
+    it "initializes properly with an app_id and an app_access_token" do
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
       updates.should be_a(Koala::Facebook::RealtimeUpdates)
     end
     
     # attributes
-    it "should allow read access to app_id" do
+    it "allows read access to app_id" do
       # in Ruby 1.9, .method returns symbols 
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should include(:app_id)
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should_not include(:app_id=)
     end
 
-    it "should allow read access to app_access_token" do
+    it "allows read access to app_access_token" do
       # in Ruby 1.9, .method returns symbols 
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should include(:app_access_token)
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should_not include(:app_access_token=)
     end
 
-    it "should allow read access to secret" do
+    it "allows read access to secret" do
       # in Ruby 1.9, .method returns symbols 
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should include(:secret)
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should_not include(:secret=)
     end
 
-    it "should allow read access to api" do
+    it "allows read access to api" do
       # in Ruby 1.9, .method returns symbols 
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should include(:api)
       Koala::Facebook::RealtimeUpdates.instance_methods.map(&:to_sym).should_not include(:api=)
@@ -69,72 +73,178 @@ describe "Koala::Facebook::RealtimeUpdates" do
     end
     
     # init with secret / fetching the token
-    it "should initialize properly with an app_id and a secret" do 
+    it "initializes properly with an app_id and a secret" do 
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
       updates.should be_a(Koala::Facebook::RealtimeUpdates)      
     end
 
-    it "should fetch an app_token from Facebook when provided an app_id and a secret" do 
+    it "fetches an app_token from Facebook when provided an app_id and a secret" do 
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
       updates.app_access_token.should_not be_nil
     end
-    
-    it "should use the OAuth class to fetch a token when provided an app_id and a secret" do
+        
+    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) 
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
     end
+    
+    it "sets up the with the app acces token" do 
+      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
+      updates.api.should be_a(Koala::Facebook::API)
+      updates.api.access_token.should == @app_access_token
+    end    
+    
   end
 
-  describe "when used" do
-    before :each do 
-      @updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
+  describe "#subscribe" do   
+    it "makes a POST to the subscription path" do
+      @updates.api.should_receive(:graph_call).with(@updates.subscription_path, anything, "post", anything)
+      @updates.subscribe("user", "name", @subscription_path, @verify_token)
+    end
+
+    it "properly formats the subscription request" do
+      obj = "user"
+      fields = "name"
+      @updates.api.should_receive(:graph_call).with(anything, hash_including(
+        :object => obj,
+        :fields => fields,
+        :callback_url => @subscription_path,
+        :verify_token => @verify_token 
+      ), anything, anything)
+      @updates.subscribe("user", "name", @subscription_path, @verify_token)
+    end
+    
+    pending "doesn't require a verify_token" do
+      # see https://github.com/arsduo/koala/issues/150
+      obj = "user"
+      fields = "name"
+      @updates.api.should_not_receive(:graph_call).with(anything, hash_including(:verify_token => anything), anything, anything)
+      @updates.subscribe("user", "name", @subscription_path)
+    end
+    
+    it "requires verify_token" do
+      expect { @updates.subscribe("user", "name", @subscription_path) }.to raise_exception
     end
     
-    it "should send a subscription request to a valid server" do
-      result = @updates.subscribe("user", "name", @subscription_path, @verify_token)
-      result.should be_true
+    it "requests the status component" do
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(:http_component => :status))
+      @updates.subscribe("user", "name", @subscription_path, @verify_token)
     end
     
-    it "should send a subscription request to a valid server" do
-      result = @updates.subscribe("user", "name", @subscription_path, @verify_token)
-      result.should be_true
+    it "accepts an options hash" do
+      options = {:a => 2, :b => "c"}
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(options))
+      @updates.subscribe("user", "name", @subscription_path, @verify_token, options)
     end
     
-    it "should send a subscription request to an invalid path on a valid server" do
-      lambda { result = @updates.subscribe("user", "name", @subscription_path + "foo", @verify_token) }.should raise_exception(Koala::Facebook::APIError)
+    it "overrides any provided http_component" do
+      # since we test against status, we need to ensure that we get that
+      options = {:http_component => :body}
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(:http_component => :status))
+      @updates.subscribe("user", "name", @subscription_path, @verify_token, options)
     end
+
+    describe "in practice" do
+      it "sends a subscription request" do
+        result = @updates.subscribe("user", "name", @subscription_path, @verify_token)
+        result.should be_true
+      end
     
-    it "should fail to send a subscription request to an invalid server" do
-      lambda { @updates.subscribe("user", "name", "foo", @verify_token) }.should raise_exception(Koala::Facebook::APIError)
+      pending "sends a subscription request without a verify token" do
+        result = @updates.subscribe("user", "name", @subscription_path)
+        result.should be_true
+      end
+  
+      it "fails if you try to hit an invalid path on your valid server" do
+        expect { result = @updates.subscribe("user", "name", @subscription_path + "foo", @verify_token) }.to raise_exception(Koala::Facebook::APIError)
+      end
+  
+      it "fails to send a subscription request to an invalid server" do
+        expect { @updates.subscribe("user", "name", "foo", @verify_token) }.to raise_exception(Koala::Facebook::APIError)
+      end
     end
+  end
   
-    it "should unsubscribe a valid individual object successfully" do 
-      @updates.unsubscribe("user").should be_true
+  describe "#unsubscribe" do
+    it "makes a DELETE to the subscription path" do
+      @updates.api.should_receive(:graph_call).with(@updates.subscription_path, anything, "delete", anything)
+      @updates.unsubscribe("user")
     end
 
-    it "should unsubscribe all subscriptions successfully" do 
-      @updates.unsubscribe.should be_true
+    it "includes the object if provided" do
+      obj = "user"
+      @updates.api.should_receive(:graph_call).with(anything, hash_including(:object => obj), anything, anything)
+      @updates.unsubscribe(obj)
     end
+    
+    it "requests the status component" do
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(:http_component => :status))
+      @updates.unsubscribe("user")
+    end
+        
+    it "accepts an options hash" do
+      options = {:a => 2, :b => "C"}
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(options))
+      @updates.unsubscribe("user", options)
+    end
+    
+    it "overrides any provided http_component" do
+      # since we test against status, we need to ensure that we get that
+      options = {:http_component => :body}
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(:http_component => :status))
+      @updates.unsubscribe("user", options)
+    end
+    
+    describe "in practice" do
+      it "unsubscribes a valid individual object successfully" do 
+        @updates.unsubscribe("user").should be_true
+      end
+
+      it "unsubscribes all subscriptions successfully" do 
+        @updates.unsubscribe.should be_true
+      end
 
-    it "should fail when an invalid object is provided to unsubscribe" do 
-      lambda { @updates.unsubscribe("kittens") }.should raise_error(Koala::Facebook::APIError)
+      it "fails when an invalid object is provided to unsubscribe" do 
+        expect { @updates.unsubscribe("kittens") }.to raise_error(Koala::Facebook::APIError)
+      end
+    end
+  end
+  
+  describe "#list_subscriptions" do
+    it "GETs the subscription path" do
+      @updates.api.should_receive(:graph_call).with(@updates.subscription_path, anything, "get", anything)
+      @updates.list_subscriptions
     end
     
-    it "should is subscriptions properly" do
-      @updates.list_subscriptions.should be_a(Array)
+    it "accepts options" do
+      options = {:a => 3, :b => "D"}      
+      @updates.api.should_receive(:graph_call).with(anything, anything, anything, hash_including(options))
+      @updates.list_subscriptions(options)
     end
-  end # describe "when used"
+    
+    describe "in practice" do
+      it "lists subscriptions properly" do
+        @updates.list_subscriptions.should be_a(Array)
+      end
+    end
+  end
+  
+  describe "#subscription_path" do
+    it "returns the app_id/subscriptions" do
+      @updates.subscription_path.should == "#{@app_id}/subscriptions"
+    end
+  end
   
-  describe "when meeting challenge" do
-    it "should return false if hub.mode isn't subscribe" do
+  describe ".meet_challenge" do
+    it "returns false if hub.mode isn't subscribe" do
       params = {'hub.mode' => 'not subscribe'}
       Koala::Facebook::RealtimeUpdates.meet_challenge(params).should be_false
     end
     
-    it "should return false if not given a verify_token or block" do
+    it "returns false if not given a verify_token or block" do
       params = {'hub.mode' => 'subscribe'}
       Koala::Facebook::RealtimeUpdates.meet_challenge(params).should be_false
     end
@@ -150,11 +260,11 @@ describe "Koala::Facebook::RealtimeUpdates" do
           @params['hub.verify_token'] = @token
         end
         
-        it "should return false if the given verify token doesn't match" do
+        it "returns false if the given verify token doesn't match" do
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params, @token + '1').should be_false
         end
         
-        it "should return the challenge if the given verify token matches" do
+        it "returns the challenge if the given verify token matches" do
           @params['hub.challenge'] = 'challenge val'
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params, @token).should == @params['hub.challenge']
         end
@@ -165,34 +275,31 @@ describe "Koala::Facebook::RealtimeUpdates" do
           @params['hub.verify_token'] = @token
         end
           
-        it "should give the block the token as a parameter" do
+        it "gives the block the token as a parameter" do
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params) do |token|
             token.should == @token
           end
         end
         
-        it "should return false if the given block return false" do
+        it "returns false if the given block return false" do
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params) do |token|
             false
           end.should be_false
         end
         
-        it "should return false if the given block returns nil" do
+        it "returns false if the given block returns nil" do
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params) do |token|
             nil
           end.should be_false
         end
         
-        it "should return the challenge if the given block returns true" do
+        it "returns the challenge if the given block returns true" do
           @params['hub.challenge'] = 'challenge val'
           Koala::Facebook::RealtimeUpdates.meet_challenge(@params) do |token|
             true
           end.should be_true
         end
       end
-    
-    end # describe "and mode is subscribe"
-    
-  end # describe "when meeting challenge"
-  
-end # describe
+    end
+  end
+end