palidanx-koala 0.9.0

data/spec/facebook_data.yml

@@ -0,0 +1,56 @@
+# Check out http://oauth.twoalex.com/ to easily generate tokens, cookies, etc.
+# Those values will work with the default settings in this yaml.
+# Of course, you can change this to work with your own app.
+# Just remember to update all fields!
+ 
+# You must supply this value yourself to test the GraphAPI class.
+# Your OAuth token should have publish_stream and read_stream permissions.
+oauth_token: 
+
+# for testing the OAuth class    
+# baseline app
+oauth_test_data: 
+  # You must supply this value yourself, since they will expire.
+  code: 
+  # easiest way to get session keys: use multiple test accounts with the Javascript login at http://oauth.twoalex.com
+  session_key: 
+  multiple_session_keys:
+    - 
+    -
+  
+  # These values will work out of the box
+  app_id: 119908831367602
+  secret: e45e55a333eec232d4206d2703de1307
+  callback_url: http://oauth.twoalex.com/
+  app_access_token: 119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.
+  raw_token_string: "access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.&expires=6621"
+  raw_offline_access_token_string: access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.
+  valid_cookies: 
+    # note: the tests stub the time class so these default cookies are always valid (if you're using the default app)
+    # if not you may want to remove the stubbing to test expiration
+    fbs_119908831367602: '"access_token=119908831367602|2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623|CMpi0AYbn03Oukzv94AUha2qbO4.&expires=1273363200&secret=lT_9zm5r5IbJ6Aa5O54nFw__&session_key=2.LKE7ksSPOx0V_8mHPr2NHQ__.3600.1273363200-2905623&sig=9515e93113921f9476a4efbdd4a3c746&uid=2905623"'
+  expired_cookies:
+    fbs_119908831367602: '"access_token=119908831367602|2.xv9mi6QSOpr474s4n2X_pw__.3600.1273287600-2905623|yVt5WH_S6J5p3gFa5_5lBzckhws.&expires=1273287600&secret=V_E79ovQnXqxGctFuC_n5A__&session_key=2.xv9mi6QSOpr474s4n2X_pw__.3600.1273287600-2905623&sig=eeef60838c0c800258d89b7e6ddddddb&uid=2905623"'
+  offline_access_cookies: 
+    # note: I've revoked the offline access for security reasons, so you can't make calls against this :)
+    fbs_119908831367602: '"access_token=119908831367602|08170230801eb225068e7a70-2905623|Q3LDCYYF8CX9cstxnZLsxiR0nwg.&expires=0&secret=78abaee300b392e275072a9f2727d436&session_key=08170230801eb225068e7a70-2905623&sig=423b8aa4b6fa1f9a571955f8e929d567&uid=2905623"'
+
+  # These values will work out of the box
+  # They're from Facebook's example at http://developers.facebook.com/docs/authentication/canvas
+  # You can update this to live data if desired
+  # request_secret is optional and will fall back to the secret above if absent
+  request_secret: "secret"
+  signed_request: "vlXgu64BQGFSQrY0ZcJBZASMvYvTHu9GQ0YM9rjPSso.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsIjAiOiJwYXlsb2FkIn0"
+  signed_request_result:
+      "0": payload
+      algorithm: HMAC-SHA256
+    
+  
+
+subscription_test_data:
+  subscription_path: http://oauth.twoalex.com/subscriptions
+  verify_token: "myverificationtoken|1f54545d5f722733e17faae15377928f"
+  challenge_data: 
+    "hub.challenge": "1290024882"
+    "hub.verify_token": "myverificationtoken|1f54545d5f722733e17faae15377928f"
+    "hub.mode": "subscribe"

data/spec/koala/api_base_tests.rb

@@ -0,0 +1,95 @@
+class ApiBaseTests < Test::Unit::TestCase
+  describe "Koala API base class" do
+    before(:each) do
+      @service = Koala::Facebook::API.new  
+    end
+    
+    it "should not include an access token if none was given" do
+      Koala.should_receive(:make_request).with(
+        anything,
+        hash_not_including('access_token' => 1),
+        anything,
+        anything
+      ).and_return(Koala::Response.new(200, "", ""))
+      
+      @service.api('anything')
+    end
+    
+    it "should include an access token if given" do
+      token = 'adfadf'
+      service = Koala::Facebook::API.new token
+      
+      Koala.should_receive(:make_request).with(
+        anything,
+        hash_including('access_token' => token),
+        anything,
+        anything
+      ).and_return(Koala::Response.new(200, "", ""))
+      
+      service.api('anything')
+    end
+    
+    it "should get the attribute of a Koala::Response given by the http_component parameter" do
+      http_component = :method_name
+      
+      response = mock('Mock KoalaResponse', :body => '', :status => 200)
+      response.should_receive(http_component).and_return('')
+      
+      Koala.stub(:make_request).and_return(response)
+      
+      @service.api('anything', 'get', {}, :http_component => http_component)
+    end
+    
+    it "should return the body of the request as JSON if no http_component is given" do
+      response = stub('response', :body => 'body', :status => 200)
+      Koala.stub(:make_request).and_return(response)
+      
+      json_body = mock('JSON body')
+      JSON.stub(:parse).and_return([json_body])
+      
+      @service.api('anything').should == json_body
+    end
+    
+    it "should execute a block with the response body if passed one" do
+      body = '{}'
+      Koala.stub(:make_request).and_return(Koala::Response.new(200, body, {}))
+      
+      yield_test = mock('Yield Tester')
+      yield_test.should_receive(:pass)
+      
+      @service.api('anything') do |arg| 
+        yield_test.pass
+        arg.should == JSON.parse(body)
+      end
+    end
+    
+    it "should raise an API error if the HTTP response code is greater than or equal to 500" do
+      Koala.stub(:make_request).and_return(Koala::Response.new(500, 'response body', {}))
+      
+      lambda { @service.api('anything') }.should raise_exception(Koala::Facebook::APIError)
+    end
+    
+    it "should handle rogue true/false as responses" do
+      Koala.should_receive(:make_request).and_return(Koala::Response.new(200, 'true', {}))
+      @service.api('anything').should be_true
+      
+      Koala.should_receive(:make_request).and_return(Koala::Response.new(200, 'false', {}))
+      @service.api('anything').should be_false
+    end
+    
+    describe "with regard to leading slashes" do 
+      it "should add a leading / to the path if not present" do
+        path = "anything"
+        Koala.should_receive(:make_request).with("/#{path}", anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
+        @service.api(path)      
+      end
+    
+      it "shouldn't change the path if a leading / is present" do
+        path = "/anything"
+        Koala.should_receive(:make_request).with(path, anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
+        @service.api(path)              
+      end
+    end
+    
+  end
+end

data/spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb

@@ -0,0 +1,10 @@
+class GraphAndRestAPINoTokenTests < Test::Unit::TestCase
+  describe "Koala GraphAndRestAPI without an access token" do
+    before(:each) do
+      @api = Koala::Facebook::GraphAndRestAPI.new
+    end
+    
+    it_should_behave_like "Koala RestAPI without an access token"
+    it_should_behave_like "Koala GraphAPI without an access token"
+  end
+end

data/spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb

@@ -0,0 +1,11 @@
+class GraphAndRestAPIWithTokenTests < Test::Unit::TestCase
+  describe "Koala GraphAndRestAPI without an access token" do
+    it_should_behave_like "live testing examples"
+    it_should_behave_like "Koala RestAPI with an access token"
+    it_should_behave_like "Koala GraphAPI with an access token"
+    
+    before(:each) do
+      @api = Koala::Facebook::GraphAndRestAPI.new(@token)
+    end
+  end
+end

data/spec/koala/graph_api/graph_api_no_access_token_tests.rb

@@ -0,0 +1,114 @@
+shared_examples_for "Koala GraphAPI without an access token" do
+  it "should get public data about a user" do
+    result = @api.get_object("koppel")
+    # the results should have an ID and a name, among other things
+    (result["id"] && result["name"]).should
+  end
+
+  it "should not get private data about a user" do
+    result = @api.get_object("koppel")
+    # updated_time should be a pretty fixed test case
+    result["updated_time"].should be_nil
+  end
+
+  it "should get public data about a Page" do
+    result = @api.get_object("contextoptional")
+    # the results should have an ID and a name, among other things
+    (result["id"] && result["name"]).should
+  end
+
+  it "should not be able to get data about 'me'" do
+    lambda { @api.get_object("me") }.should raise_error(Koala::Facebook::APIError)
+  end
+
+  it "should be able to get multiple objects" do
+    results = @api.get_objects(["contextoptional", "naitik"])
+    results.length.should == 2
+  end
+
+  it "shouldn't be able to access connections from users" do
+    lambda { @api.get_connections("lukeshepard", "likes") }.should raise_error(Koala::Facebook::APIError)
+  end
+
+  it "should be able to access a user's picture" do
+    @api.get_picture("chris.baclig").should =~ /http\:\/\//
+  end
+
+  it "should be able to access a user's picture, given a picture type"  do
+    @api.get_picture("chris.baclig", {:type => 'large'}).should =~ /^http\:\/\//
+  end
+
+  it "should be able to access connections from public Pages" do
+    result = @api.get_connections("contextoptional", "photos")
+    result.should be_a(Array)
+  end
+  
+  # paging
+  # see also graph_collection_tests
+  it "should make a request for a page when provided a specific set of page params" do
+    query = [1, 2]
+    @api.should_receive(:graph_call).with(*query)
+    @api.get_page(query)
+  end
+
+  it "should not be able to put an object" do
+    lambda { @result = @api.put_object("lukeshepard", "feed", :message => "Hello, world") }.should raise_error(Koala::Facebook::APIError)
+    puts "Error!  Object #{@result.inspect} somehow put onto Luke Shepard's wall!" if @result
+  end
+
+  # these are not strictly necessary as the other put methods resolve to put_object, but are here for completeness
+  it "should not be able to post to a feed" do
+    (lambda do
+      attachment = {:name => "Context Optional", :link => "http://www.contextoptional.com/"}
+      @result = @api.put_wall_post("Hello, world", attachment, "contextoptional") 
+    end).should raise_error(Koala::Facebook::APIError)
+    puts "Error!  Object #{@result.inspect} somehow put onto Context Optional's wall!" if @result
+  end
+
+  it "should not be able to comment on an object" do
+    # random public post on the ContextOptional wall
+    lambda { @result = @api.put_comment("7204941866_119776748033392", "The hackathon was great!") }.should raise_error(Koala::Facebook::APIError)
+    puts "Error!  Object #{@result.inspect} somehow commented on post 7204941866_119776748033392!" if @result    
+  end
+
+  it "should not be able to like an object" do
+    lambda { @api.put_like("7204941866_119776748033392") }.should raise_error(Koala::Facebook::APIError)
+  end
+  
+  # DELETE
+  it "should not be able to delete posts" do 
+    # test post on the Ruby SDK Test application
+    lambda { @result = @api.delete_object("115349521819193_113815981982767") }.should raise_error(Koala::Facebook::APIError)
+  end
+
+  # SEARCH
+  it "should be able to search" do
+    result = @api.search("facebook")
+    result.length.should be_an(Integer)
+  end
+
+  it_should_behave_like "Koala GraphAPI with GraphCollection"
+  
+  # API
+  it "should never use the rest api server" do
+    Koala.should_receive(:make_request).with(
+      anything,
+      anything,
+      anything,
+      hash_not_including(:rest_api => true)
+    ).and_return(Koala::Response.new(200, "", {}))      
+    
+    @api.api("anything")
+  end
+end
+
+class FacebookNoAccessTokenTests < Test::Unit::TestCase
+  describe "Koala GraphAPI without an access token" do
+    before :each do
+      @api = Koala::Facebook::GraphAPI.new
+    end  
+    
+    it_should_behave_like "Koala GraphAPI without an access token"
+  end
+end
+  

data/spec/koala/graph_api/graph_api_with_access_token_tests.rb

@@ -0,0 +1,150 @@
+shared_examples_for "Koala GraphAPI with an access token" do
+  it "should get public data about a user" do
+      result = @api.get_object("koppel")
+      # the results should have an ID and a name, among other things
+      (result["id"] && result["name"]).should_not be_nil
+    end
+
+    it "should get private data about a user" do
+      result = @api.get_object("koppel")
+      # updated_time should be a pretty fixed test case
+      result["updated_time"].should_not be_nil
+    end
+
+    it "should get public data about a Page" do
+      result = @api.get_object("contextoptional")
+      # the results should have an ID and a name, among other things
+      (result["id"] && result["name"]).should
+    end
+  
+    it "should get data about 'me'" do
+      result = @api.get_object("me")
+      result["updated_time"].should
+    end
+  
+    it "should be able to get multiple objects" do
+      result = @api.get_objects(["contextoptional", "naitik"])
+      result.length.should == 2
+    end
+  
+    it "should be able to access a user's picture" do
+      @api.get_picture("chris.baclig").should =~ /http\:\/\//
+    end
+  
+    it "should be able to access a user's picture, given a picture type"  do
+      @api.get_picture("chris.baclig", {:type => 'large'}).should =~ /^http\:\/\//
+    end
+  
+    it "should be able to access connections from users" do
+      result = @api.get_connections("lukeshepard", "likes")
+      result.length.should > 0
+    end
+
+    it "should be able to access connections from public Pages" do
+      result = @api.get_connections("contextoptional", "photos")
+      result.should be_a(Array)
+    end
+    
+    # paging
+    # see also graph_collection_tests
+    it "should make a request for a page when provided a specific set of page params" do
+      query = [1, 2]
+      @api.should_receive(:graph_call).with(*query)
+      @api.get_page(query)
+    end
+    
+    
+    # PUT
+    it "should be able to write an object to the graph" do
+      result = @api.put_wall_post("Hello, world, from the test suite!")
+      @temporary_object_id = result["id"]
+      @temporary_object_id.should_not be_nil
+    end
+
+    # DELETE
+    it "should be able to delete posts" do 
+      result = @api.put_wall_post("Hello, world, from the test suite delete method!")
+      object_id_to_delete = result["id"]
+      delete_result = @api.delete_object(object_id_to_delete)
+      delete_result.should == true
+    end
+
+    # additional put tests
+    it "should be able to verify messages posted to a wall" do
+      message = "the cats are asleep"
+      put_result = @api.put_wall_post(message)
+      @temporary_object_id = put_result["id"]
+      get_result = @api.get_object(@temporary_object_id)
+      
+      # make sure the message we sent is the message that got posted
+      get_result["message"].should == message
+    end
+
+    it "should be able to post a message with an attachment to a feed" do
+      result = @api.put_wall_post("Hello, world, from the test suite again!", {:name => "Context Optional", :link => "http://www.contextoptional.com/"})
+      @temporary_object_id = result["id"]
+      @temporary_object_id.should_not be_nil
+    end
+    
+    it "should be able to verify a message with an attachment posted to a feed" do
+      attachment = {"name" => "Context Optional", "link" => "http://www.contextoptional.com/"}
+      result = @api.put_wall_post("Hello, world, from the test suite again!", attachment)
+      @temporary_object_id = result["id"]
+      get_result = @api.get_object(@temporary_object_id)
+
+      # make sure the result we fetch includes all the parameters we sent
+      it_matches = attachment.inject(true) {|valid, param| valid && (get_result[param[0]] == attachment[param[0]])}
+      it_matches.should == true 
+    end
+
+    it "should be able to comment on an object" do
+      result = @api.put_wall_post("Hello, world, from the test suite, testing comments!")
+      @temporary_object_id = result["id"]
+      
+      # this will be deleted when the post gets deleted 
+      comment_result = @api.put_comment(@temporary_object_id, "it's my comment!")
+      comment_result.should_not be_nil
+    end
+    
+    it "should be able to verify a comment posted about an object" do
+      message_text = "Hello, world, from the test suite, testing comments!"
+      result = @api.put_wall_post(message_text)
+      @temporary_object_id = result["id"]
+      
+      # this will be deleted when the post gets deleted 
+      comment_text = "it's my comment!"
+      comment_result = @api.put_comment(@temporary_object_id, comment_text)
+      get_result = @api.get_object(comment_result["id"])
+
+      # make sure the text of the comment matches what we sent
+      get_result["message"].should == comment_text
+    end
+
+    it "should be able to like an object" do
+      result = @api.put_wall_post("Hello, world, from the test suite, testing comments!")
+      @temporary_object_id = result["id"]
+      like_result = @api.put_like(@temporary_object_id)
+    end
+
+    # SEARCH
+    it "should be able to search" do
+      result = @api.search("facebook")
+      result.length.should be_an(Integer)
+    end
+
+    # API
+    # the above tests test this already, but we should consider additional api tests
+
+    it_should_behave_like "Koala GraphAPI with GraphCollection"
+end
+
+class FacebookWithAccessTokenTests < Test::Unit::TestCase
+  describe "Koala GraphAPI with an access token" do
+    it_should_behave_like "live testing examples"
+    it_should_behave_like "Koala GraphAPI with an access token"
+    
+    before :each do
+      @api = Koala::Facebook::GraphAPI.new(@token)
+    end
+  end
+end

data/spec/koala/live_testing_data_helper.rb

@@ -0,0 +1,15 @@
+shared_examples_for "live testing examples" do
+    before :each do
+      @token = $testing_data["oauth_token"]
+      raise Exception, "Must supply access token to run FacebookWithAccessTokenTests!" unless @token
+    end
+    
+    after :each do 
+      # clean up any temporary objects
+      if @temporary_object_id
+        puts "\nCleaning up temporary object #{@temporary_object_id.to_s}"
+        result = @api.delete_object(@temporary_object_id)
+        raise "Unable to clean up temporary Graph object #{@temporary_object_id}!" unless result
+      end
+    end
+end