cotweet_koala 0.8.0.1

data/spec/koala/rest_api/rest_api_no_access_token_tests.rb

@@ -0,0 +1,94 @@
+shared_examples_for "Koala RestAPI without an access token" do
+  # REST_CALL
+  describe "when making a rest request" do
+    it "should use the proper path" do
+      method = stub('methodName')
+      @api.should_receive(:api).with(
+        "method/#{method}",
+        anything,
+        anything,
+        anything
+      )
+      
+      @api.rest_call(method)  
+    end
+    
+    it "should always use the rest api" do
+      @api.should_receive(:api).with(
+        anything,
+        anything,
+        anything,
+        :rest_api => true
+      )  
+      
+      @api.rest_call('anything')
+    end
+    
+    it "should take an optional hash of arguments" do
+      args = {:arg1 => 'arg1'}
+      
+      @api.should_receive(:api).with(
+        anything,
+        hash_including(args),
+        anything,
+        anything
+      )
+      
+      @api.rest_call('anything', args)
+    end
+    
+    it "should always ask for JSON" do
+      @api.should_receive(:api).with(
+        anything,
+        hash_including('format' => 'json'),
+        anything,
+        anything
+      )
+      
+      @api.rest_call('anything')
+    end
+  end 
+
+  # FQL_QUERY
+  describe "when making a FQL request" do
+    it "should call fql.query method" do
+      @api.should_receive(:rest_call).with(
+        "fql.query", 
+        anything
+      ).and_return(Koala::Response.new(200, "2", {}))
+      
+      @api.fql_query stub('query string')
+    end
+    
+    it "should pass a query argument" do
+      query = stub('query string')
+      
+      @api.should_receive(:rest_call).with(
+        anything,
+        hash_including("query" => query)
+      )
+      
+      @api.fql_query(query)
+    end
+  
+    it "should be able to access public information via FQL" do
+      @result = @api.fql_query("select first_name from user where uid = 216743")
+      @result.size.should == 1
+      @result.first["first_name"].should == "Chris"
+    end
+    
+    it "should not be able to access protected information via FQL" do
+      lambda { @api.fql_query("select read_stream from permissions where uid = 216743") }.should raise_error(Koala::Facebook::APIError)
+    end
+  end
+end
+
+class FacebookRestAPINoAccessTokenTest < Test::Unit::TestCase
+  before :each do
+    @api = Koala::Facebook::RestAPI.new
+  end
+  
+  describe "Koala RestAPI without an access token" do
+    it_should_behave_like "Koala RestAPI without an access token" 
+  end
+end

data/spec/koala/rest_api/rest_api_with_access_token_tests.rb

@@ -0,0 +1,36 @@
+shared_examples_for "Koala RestAPI with an access token" do
+  # FQL
+  it "should be able to access public information via FQL" do
+    result = @api.fql_query('select first_name from user where uid = 216743')
+    result.size.should == 1
+    result.first['first_name'].should == 'Chris'
+  end
+
+  it "should be able to access protected information via FQL" do
+    # Tests agains the permissions fql table
+    
+    # get the current user's ID
+    # we're sneakily using the Graph API, which should be okay since it has its own tests
+    g = Koala::Facebook::GraphAPI.new(@token)
+    id = g.get_object("me", :fields => "id")["id"]
+
+    # now send a query about your permissions
+    result = @api.fql_query("select read_stream from permissions where uid = #{id}")
+
+    result.size.should == 1
+    # we assume that you have read_stream permissions, so we can test against that
+    # (should we keep this?)
+    result.first["read_stream"].should == 1
+  end
+end
+
+class FacebookRestAPIWithAccessTokenTests < Test::Unit::TestCase
+  describe "Koala RestAPI with an access token" do
+    it_should_behave_like "live testing examples"
+    it_should_behave_like "Koala RestAPI with an access token"
+    
+    before :each do
+      @api = Koala::Facebook::RestAPI.new(@token)
+    end
+  end
+end

data/spec/koala_spec.rb

@@ -0,0 +1,18 @@
+require 'koala_spec_helper'
+require 'mock_http_service'
+
+# Runs Koala specs using stubs for HTTP requests
+#
+# Valid OAuth token and code are not necessary to run these
+# specs.  Because of this, specs do not fail due to Facebook
+# imposed rate-limits or server timeouts. 
+# 
+# However as a result they are more brittle since
+# we are not testing the latest responses from the Facebook servers.
+# Therefore, to be certain all specs pass with the current 
+# Facebook services, run koala_spec_without_mocks.rb.
+
+
+Koala.http_service = Koala::MockHTTPService
+
+$testing_data = Koala::MockHTTPService::TEST_DATA

data/spec/koala_spec_helper.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'rubygems'
+require 'spec/test/unit'
+
+# load the libraries
+require 'koala'
+
+# load testing data libraries
+require 'koala/live_testing_data_helper'
+
+# API tests
+require 'koala/api_base_tests'
+
+require 'koala/graph_api/graph_api_no_access_token_tests'
+require 'koala/graph_api/graph_api_with_access_token_tests'
+
+require 'koala/rest_api/rest_api_no_access_token_tests'
+require 'koala/rest_api/rest_api_with_access_token_tests'
+
+require 'koala/graph_and_rest_api/graph_and_rest_api_no_token_tests'
+require 'koala/graph_and_rest_api/graph_and_rest_api_with_token_tests'
+
+# OAuth tests
+require 'koala/oauth/oauth_tests'
+
+# Subscriptions tests
+require 'koala/realtime_updates/realtime_updates_tests'
+
+# Services tests
+require 'koala/net_http_service_tests'

data/spec/koala_spec_without_mocks.rb

@@ -0,0 +1,19 @@
+require 'koala_spec_helper'
+
+# Runs Koala specs through the Facebook servers
+#
+# Note that you need a valid OAuth token and code for these
+# specs to run.  See facebook_data.yml for more information.
+
+# load testing data (see note in readme.md)
+# I'm seeing a bug with spec and gets where the facebook_test_suite.rb file gets read in when gets is called
+# until that's solved, we'll need to store/update tokens in the access_token file
+$testing_data = YAML.load_file(File.join(File.dirname(__FILE__), 'facebook_data.yml')) rescue {}
+
+unless $testing_data["oauth_token"]
+  puts "Access token tests will fail until you store a valid token in facebook_data.yml"
+end
+
+unless $testing_data["oauth_test_data"] && $testing_data["oauth_test_data"]["code"] && $testing_data["oauth_test_data"]["secret"]
+  puts "Cookie tests will fail until you store valid data for the cookie hash, app_id, and app secret in facebook_data.yml"
+end

data/spec/mock_facebook_responses.yml

@@ -0,0 +1,228 @@
+# Responses by MockHTTPService are taken directly from 
+# this file.
+# 
+# Structure
+# ----------
+#
+# path:
+#   arguments:    # sorted by key
+#     method:     # HTTP method (GET, POST, DELETE, etc.)
+#       with_token:
+#       no_token:
+
+# ====== REST API ===== 
+rest_api:
+
+# -- Stubbed Responses --
+  method/fql.query:
+    query=select first_name from user where uid = 216743:
+      get: 
+        no_token: '[{"first_name":"Chris"}]'
+        with_token: '[{"first_name":"Chris"}]'
+    query=select read_stream from permissions where uid = 216743:
+      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 = 216743"}]}'
+
+
+# ====== GRAPH API =====
+graph_api:
+
+# -- Common Responses --
+
+  # Error responses for when a token is required, but not given
+  token_required_responses: &token_required
+    no_token: '{"error":{"type":"OAuthAccessTokenException", "message":"An access token is required to request this resource."}}'
+  
+  # Common mock item responses
+  item_deleted: &item_deleted
+    delete:
+      with_token: 'true'
+
+  # OAuth error response
+  oauth_error: &oauth_error
+    no_token: '{"error": {"type": "OAuthException", "message": "Error validating verification code."}}'
+
+  # Subscription error response
+  verification_error: &verification_error
+    with_token: '{"error": {"type": "OAuthException", "message": "Error validating verification code."}}'
+      
+# -- Stubbed Responses --
+  root:
+    ids=contextoptional,naitik: 
+      get:
+        with_token: '[{}, {}]'
+        no_token: '[{}, {}]'
+  me:
+    no_args:
+      get:
+        <<: *token_required
+        with_token: '{"updated_time": 1}'
+    fields=id:
+      get: 
+        with_token: '{"id": "216743"}'
+        
+  me/feed:
+    message=Hello, world, from the test suite!: 
+      post: 
+        with_token: '{"id": "MOCK_FEED_ITEM"}'
+    message=Hello, world, from the test suite, testing comments!:
+      post:
+        with_token: '{"id": "MOCK_FEED_ITEM"}'
+    message=the cats are asleep: 
+      post: 
+        with_token: '{"id": "FEED_ITEM_CATS"}'
+    message=Hello, world, from the test suite delete method!: 
+      post: 
+        with_token: '{"id": "FEED_ITEM_DELETE"}'
+    link=http://www.contextoptional.com/&message=Hello, world, from the test suite again!&name=Context Optional:
+      post:
+        with_token: '{"id": "FEED_ITEM_CONTEXT"}'
+        
+  koppel:
+    no_args:
+      get:
+        with_token: '{"id": 1, "name": 1, "updated_time": 1}'
+        no_token: '{"id": 1, "name": 1}'
+                
+  contextoptional:
+    no_args:
+      get:
+        with_token: '{"id": 1, "name": 1}'
+        no_token: '{"id": 1, "name": 1}'
+        
+  contextoptional/likes: 
+    no_args: 
+      get: 
+        with_token: '{"data": [{}]}'
+        no_token: '{"data": [{}]}'
+        
+  lukeshepard/likes: 
+    no_args: 
+      get: 
+        <<: *token_required
+        with_token: '{"data": [{}]}'
+        
+  chris.baclig/picture:
+    no_args:
+      get:
+        no_token:
+          code: 302
+          headers:
+            Location: http://facebook.com/
+        with_token:
+          code: 302
+          headers:
+            Location: http://facebook.com/
+    type=large:
+      get:
+        no_token:
+          code: 302
+          headers:
+            Location: http://facebook.com/large
+        with_token:
+          code: 302
+          headers:
+            Location: http://facebook.com/large
+
+
+  search:
+    q=facebook:
+      get: 
+        with_token: '{"data": [{"id": "507731521_100412693339488"}]}'
+        no_token: '{"data": [{"id": "507731521_100412693339488"}]}'
+        
+  '115349521819193_113815981982767':
+    no_args:
+      delete:
+        <<: *token_required
+  
+  # -- OAuth responses --
+  oauth/access_token: 
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&code=<%= OAUTH_CODE %>&redirect_uri=<%= OAUTH_DATA["callback_url"] %>:
+      get:
+        no_token: access_token=<%= ACCESS_TOKEN %>
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&code=foo&redirect_uri=<%= OAUTH_DATA["callback_url"] %>: 
+      get: 
+        <<: *oauth_error
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&type=client_cred:
+      post:
+        no_token: access_token=<%= ACCESS_TOKEN %>
+  oauth/exchange_sessions:
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&sessions=<%= OAUTH_DATA["session_key"] %>&type=client_cred: 
+      post:
+        no_token: '[{"access_token":"<%= ACCESS_TOKEN %>","expires":4315}]'
+    client_id=<%= APP_ID %>&client_secret=<%= SECRET %>&sessions=<%= OAUTH_DATA["multiple_session_keys"].join(",") %>&type=client_cred: 
+      post:
+        no_token: '[{"access_token":"<%= ACCESS_TOKEN %>","expires":4315}, {"access_token":"<%= ACCESS_TOKEN %>","expires":4315}]'
+
+
+
+# -- Subscription Responses -- 
+  <%= APP_ID %>/subscriptions:
+    callback_url=<%= SUBSCRIPTION_DATA["subscription_path"] %>&fields=name&object=user&verify_token=<%= SUBSCRIPTION_DATA["verify_token"] %>:
+      post: 
+        with_token:
+          code: 200
+    callback_url=<%= SUBSCRIPTION_DATA["subscription_path"] %>foo&fields=name&object=user&verify_token=<%= SUBSCRIPTION_DATA["verify_token"] %>:
+      post: 
+        with_token: '{"error":{"type":"Exception","message":"(#2200) subscription validation failed"}}'
+    callback_url=foo&fields=name&object=user&verify_token=<%= SUBSCRIPTION_DATA["verify_token"] %>:
+      post: 
+        with_token: '{"error":{"type":"Exception","message":"(#100) callback_url URL is not properly formatted"}}'
+    object=user:
+      delete:
+        with_token:
+          code: 200
+    object=kittens:
+      delete:
+        with_token: '{"error":{"type":"Exception","message":"(#100) Invalid parameter"}}'
+    no_args:
+      delete: 
+        with_token:
+          code: 200
+      get:
+        with_token: '{"data":[{"callback_url":"http://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+
+
+    callback_url=<%= SUBSCRIPTION_DATA["subscription_path"] %>:
+      get:
+        with_token: '{"data":[{"callback_url":"http://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+
+# -- Mock Item Responses --
+
+  MOCK_FEED_ITEM/likes:
+    no_args:
+      post:
+        with_token: '{"id": "MOCK_LIKE"}'
+        
+  MOCK_FEED_ITEM/comments:
+    message=it's my comment!:
+      post:
+        with_token: '{"id": "MOCK_COMMENT"}'
+  
+  MOCK_FEED_ITEM:
+    no_args:
+      <<: *item_deleted
+  
+  FEED_ITEM_CONTEXT:
+    no_args: 
+      <<: *item_deleted
+      get:
+        with_token: '{"link":"http://www.contextoptional.com/", "name": "Context Optional"}'
+  
+  FEED_ITEM_CATS:
+    no_args:
+      <<: *item_deleted
+      get: 
+        with_token: '{"message": "the cats are asleep"}'
+  
+  FEED_ITEM_DELETE:
+    no_args:
+      <<: *item_deleted
+      
+  MOCK_COMMENT:
+    no_args:
+      <<: *item_deleted
+      get:
+        with_token: "{\"message\": \"it\'s my comment!\"}"

data/spec/mock_http_service.rb

@@ -0,0 +1,81 @@
+require 'erb'
+require 'yaml'
+
+module Koala
+  module MockHTTPService
+    # Mocks all HTTP requests for with koala_spec_with_mocks.rb
+
+    # Mocked values to be included in TEST_DATA used in specs
+    ACCESS_TOKEN = '*'
+    OAUTH_CODE = 'OAUTHCODE'
+    
+    # Loads testing data
+    TEST_DATA = YAML.load_file(File.join(File.dirname(__FILE__), 'facebook_data.yml'))
+    TEST_DATA.merge!('oauth_token' => Koala::MockHTTPService::ACCESS_TOKEN)
+    TEST_DATA['oauth_test_data'].merge!('code' => Koala::MockHTTPService::OAUTH_CODE)
+    
+    # Useful in mock_facebook_responses.yml
+    OAUTH_DATA = TEST_DATA['oauth_test_data']
+    OAUTH_DATA.merge!({
+      'app_access_token' => Koala::MockHTTPService::ACCESS_TOKEN,
+      'session_key' => "session_key",
+      'multiple_session_keys' => ["session_key", "session_key_2"]
+    })
+    APP_ID = OAUTH_DATA['app_id']
+    SECRET = OAUTH_DATA['secret']
+    SUBSCRIPTION_DATA = TEST_DATA["subscription_test_data"]
+
+    # Loads the mock response data via ERB to substitue values for TEST_DATA (see oauth/access_token)
+    mock_response_file_path = File.join(File.dirname(__FILE__), 'mock_facebook_responses.yml') 
+    RESPONSES = YAML.load(ERB.new(IO.read(mock_response_file_path)).result(binding))         
+
+    def self.included(base)
+      base.class_eval do
+        
+        def self.make_request(path, args, verb, options = {})
+          path = 'root' if path == ''
+          verb ||= 'get'
+          server = options[:rest_api] ? 'rest_api' : 'graph_api'
+          with_token = args.delete('access_token') == ACCESS_TOKEN ? 'with_token' : 'no_token'
+          
+          # Assume format is always JSON
+          args.delete('format')
+          
+          # Create a hash key for the arguments
+          args = args.empty? ? 'no_args' : args.sort{|a,b| a[0].to_s <=> b[0].to_s }.map{|arr| arr.join('=')}.join('&')
+          
+          begin
+            response = RESPONSES[server][path][args][verb][with_token]
+            
+            # Raises an error of with_token/no_token key is missing
+            raise NoMethodError unless response
+            
+            # create response class object
+            response_object = if response.is_a? String
+                Koala::Response.new(200, response, {})
+              else
+                Koala::Response.new(response["code"] || 200, response["body"] || "", response["headers"] || {})
+              end
+              
+          rescue NoMethodError
+            # Raises an error message with the place in the data YML
+            # to place a mock as well as a URL to request from
+            # Facebook's servers for the actual data
+            # (Don't forget to replace ACCESS_TOKEN with a real access token)  
+            
+            data_trace = [server, path, args, verb, with_token] * ': '
+            
+            args = args == 'no_args' ? '' : "#{args}&"
+            args += 'format=json'
+            args += "&access_token=#{ACCESS_TOKEN}" if with_token 
+            
+            raise "Missing a mock response for #{data_trace}\nAPI PATH: #{[path, args].join('?')}"
+          end
+          
+          response_object
+        end
+        
+      end # class_eval
+    end # included
+  end
+end