koala 0.7.1 → 0.7.3

data/spec/koala/net_http_service_tests.rb

@@ -1,4 +1,4 @@
-require 'http_services'
+require 'koala/http_services'
   
 class NetHTTPServiceTests < Test::Unit::TestCase
   module Bear
@@ -8,10 +8,174 @@ class NetHTTPServiceTests < Test::Unit::TestCase
   it "should define a make_request static module method" do
     Bear.respond_to?(:make_request).should be_true
   end
-  
-  it "should return a string for location header"
 
-  it "should use POST if verb is not GET"
+  describe "when making a request" do
+    before(:each) do
+      # Setup stubs for make_request to execute without exceptions
+      @mock_http_response = stub('Net::HTTPResponse', :code => 1)
+      @mock_body = stub('Net::HTTPResponse body')
+      @http_request_result = [@mock_http_response, @mock_body]
+      
+      @http_yield_mock = mock('Net::HTTP start yielded object')
+      
+      @http_yield_mock.stub(:post).and_return(@http_request_result)
+      @http_yield_mock.stub(:get).and_return(@http_request_result)
+      
+      @http_mock = stub('Net::HTTP object', 'use_ssl=' => true, 'verify_mode=' => true)
+      @http_mock.stub(:start).and_yield(@http_yield_mock)
+      
+      Net::HTTP.stub(:new).and_return(@http_mock)
+    end
+  
+    it "should use POST if verb is not GET" do
+      @http_yield_mock.should_receive(:post).and_return(@mock_http_response)
+      @http_mock.should_receive(:start).and_yield(@http_yield_mock)
+      
+      Bear.make_request('anything', {}, 'anything')
+    end
+    
+    it "should use port 443" do
+      Net::HTTP.should_receive(:new).with(anything, 443).and_return(@http_mock)
+      
+      Bear.make_request('anything', {}, 'anything')  
+    end
+    
+    it "should use SSL" do
+      @http_mock.should_receive('use_ssl=').with(true)
+      
+      Bear.make_request('anything', {}, 'anything')  
+    end
+    
+    it "should use the graph server by default" do
+      Net::HTTP.should_receive(:new).with(Koala::Facebook::GRAPH_SERVER, anything).and_return(@http_mock)
+      Bear.make_request('anything', {}, 'anything')  
+    end
+    
+    it "should use the REST server if the :rest_api option is true" do
+      Net::HTTP.should_receive(:new).with(Koala::Facebook::REST_SERVER, anything).and_return(@http_mock)
+      Bear.make_request('anything', {}, 'anything', :rest_api => true)  
+    end
+    
+    it "should turn off vertificate validaiton warnings" do
+      @http_mock.should_receive('verify_mode=').with(OpenSSL::SSL::VERIFY_NONE)
+      
+      Bear.make_request('anything', {}, 'anything')
+    end
+    
+    it "should start an HTTP connection" do
+      @http_mock.should_receive(:start).and_yield(@http_yield_mock)
+      Bear.make_request('anything', {}, 'anything')
+    end
+    
+    describe "via POST" do
+      it "should use Net::HTTP to make a POST request" do
+        @http_yield_mock.should_receive(:post).and_return(@http_request_result)
+        
+        Bear.make_request('anything', {}, 'post')
+      end
+      
+      it "should go to the specified path" do
+        path = mock('Path')
+        @http_yield_mock.should_receive(:post).with(path, anything).and_return(@http_request_result)
+        
+        Bear.make_request(path, {}, 'post')        
+      end
+      
+      it "should use encoded parameters" do
+        args = {}
+        params = mock('Encoded parameters')
+        Bear.should_receive(:encode_params).with(args).and_return(params)
+        
+        @http_yield_mock.should_receive(:post).with(anything, params).and_return(@http_request_result)
+        
+        Bear.make_request('anything', args, 'post')
+      end
+    end
+    
+    describe "via GET" do
+      it "should use Net::HTTP to make a GET request" do
+        @http_yield_mock.should_receive(:get).and_return(@http_request_result)
+        
+        Bear.make_request('anything', {}, 'get')
+      end
+      
+      it "should use the correct path, including arguments" do
+        path = mock('Path')
+        params = mock('Encoded parameters')
+        args = {}
+        
+        Bear.should_receive(:encode_params).with(args).and_return(params)
+        @http_yield_mock.should_receive(:get).with("#{path}?#{params}").and_return(@http_request_result)
+        
+        Bear.make_request(path, args, 'get')
+      end
+    end
+    
+    describe "the returned value" do
+      before(:each) do
+        @response = Bear.make_request('anything', {}, 'anything')
+      end
+      
+      it "should return a Koala::Response object" do
+        @response.class.should == Koala::Response
+      end
+      
+      it "should return a Koala::Response with the right status" do
+        @response.status.should == @mock_http_response.code  
+      end
+      
+      it "should reutrn a Koala::Response with the right body" do
+        @response.body.should == @mock_body
+      end
+      
+      it "should return a Koala::Response with the Net::HTTPResponse object as headers" do
+        @response.headers.should == @mock_http_response
+      end
+    end # describe return value
+  end # describe when making a request
   
-  it "should return a Koala::Response object"
+  describe "when encoding parameters" do
+    it "should return an empty string if param_hash evaluates to false" do
+      Bear.encode_params(nil).should == ''
+    end
+    
+    it "should convert values to JSON if the value is not a String" do
+      val = 'json_value'
+      not_a_string = 'not_a_string'
+      not_a_string.stub(:class).and_return('NotAString')
+      not_a_string.should_receive(:to_json).and_return(val)
+      
+      string = "hi"
+      
+      args = {
+        not_a_string => not_a_string,
+        string => string
+      }
+      
+      result = Bear.encode_params(args)
+      result.split('&').find do |key_and_val|
+        key_and_val.match("#{not_a_string}=#{val}")
+      end.should be_true
+    end
+    
+    it "should escape all values" do
+      args = Hash[*(1..4).map {|i| [i.to_s, "Value #{i}($"]}.flatten]
+      
+      result = Bear.encode_params(args)
+      result.split('&').each do |key_val|
+        key, val = key_val.split('=')
+        val.should == CGI.escape(args[key])
+      end
+    end
+    
+    it "should convert all keys to Strings" do
+      args = Hash[*(1..4).map {|i| [i, "val#{i}"]}.flatten]
+      
+      result = Bear.encode_params(args)
+      result.split('&').each do |key_val|
+        key, val = key_val.split('=')
+        key.should == args.find{|key_val_arr| key_val_arr.last == val}.first.to_s
+      end
+    end
+  end
 end

data/spec/koala/oauth/oauth_tests.rb

@@ -51,41 +51,66 @@ class FacebookOAuthTests < Test::Unit::TestCase
         @oauth.oauth_callback_url == nil).should be_true
     end
     
-    # cookie parsing
-    it "should properly parse valid cookies" do
-      result = @oauth.get_user_from_cookie(@oauth_data["valid_cookies"])
-      result["uid"].should
-    end
+    describe "cookie parsing" do
+      describe "get_user_info_from_cookies" do
+        it "should properly parse valid cookies" do
+          result = @oauth.get_user_info_from_cookies(@oauth_data["valid_cookies"])
+          result.should be_a(Hash)
+        end
     
-    it "should return all the cookie components from valid cookie string" do
-      cookie_data = @oauth_data["valid_cookies"]
-      parsing_results = @oauth.get_user_from_cookie(cookie_data)
-      number_of_components = cookie_data["fbs_#{@app_id.to_s}"].scan(/\=/).length
-      parsing_results.length.should == number_of_components
-    end
+        it "should return all the cookie components from valid cookie string" do
+          cookie_data = @oauth_data["valid_cookies"]
+          parsing_results = @oauth.get_user_info_from_cookies(cookie_data)
+          number_of_components = cookie_data["fbs_#{@app_id.to_s}"].scan(/\=/).length
+          parsing_results.length.should == number_of_components
+        end
 
-    it "should properly parse valid offline access cookies (e.g. no expiration)" do 
-      result = @oauth.get_user_from_cookie(@oauth_data["offline_access_cookies"])
-      result["uid"].should      
-    end
+        it "should properly parse valid offline access cookies (e.g. no expiration)" do 
+          result = @oauth.get_user_info_from_cookies(@oauth_data["offline_access_cookies"])
+          result["uid"].should      
+        end
 
-    it "should return all the cookie components from offline access cookies" do
-      cookie_data = @oauth_data["offline_access_cookies"]
-      parsing_results = @oauth.get_user_from_cookie(cookie_data)
-      number_of_components = cookie_data["fbs_#{@app_id.to_s}"].scan(/\=/).length
-      parsing_results.length.should == number_of_components
-    end
+        it "should return all the cookie components from offline access cookies" do
+          cookie_data = @oauth_data["offline_access_cookies"]
+          parsing_results = @oauth.get_user_info_from_cookies(cookie_data)
+          number_of_components = cookie_data["fbs_#{@app_id.to_s}"].scan(/\=/).length
+          parsing_results.length.should == number_of_components
+        end
 
-    it "shouldn't parse expired cookies" do
-      result = @oauth.get_user_from_cookie(@oauth_data["expired_cookies"])
-      result.should be_nil
-    end
+        it "shouldn't parse expired cookies" do
+          result = @oauth.get_user_info_from_cookies(@oauth_data["expired_cookies"])
+          result.should be_nil
+        end
     
-    it "shouldn't parse invalid cookies" do
-      # make an invalid string by replacing some values
-      bad_cookie_hash = @oauth_data["valid_cookies"].inject({}) { |hash, value| hash[value[0]] = value[1].gsub(/[0-9]/, "3") }
-      result = @oauth.get_user_from_cookie(bad_cookie_hash)
-      result.should be_nil
+        it "shouldn't parse invalid cookies" do
+          # make an invalid string by replacing some values
+          bad_cookie_hash = @oauth_data["valid_cookies"].inject({}) { |hash, value| hash[value[0]] = value[1].gsub(/[0-9]/, "3") }
+          result = @oauth.get_user_info_from_cookies(bad_cookie_hash)
+          result.should be_nil
+        end
+      end
+      
+      describe "get_user_from_cookies" do
+        it "should use get_user_info_from_cookies to parse the cookies" do
+          data = @oauth_data["valid_cookies"]
+          @oauth.should_receive(:get_user_info_from_cookies).with(data).and_return({})
+          @oauth.get_user_from_cookies(data)
+        end
+
+        it "should use return a string" do
+          result = @oauth.get_user_from_cookies(@oauth_data["valid_cookies"])
+          result.should be_a(String)
+        end
+        
+        describe "backward compatibility" do
+          before :each do
+            @result = @oauth.get_user_from_cookies(@oauth_data["valid_cookies"])
+            @key = "uid"
+          end
+          
+          it_should_behave_like "methods that return overloaded strings"
+        end
+      end
     end
     
     # OAuth URLs
@@ -157,21 +182,149 @@ class FacebookOAuthTests < Test::Unit::TestCase
       out.should_not be_nil
     end
 
-    # START CODE THAT NEEDS MOCKING
+    describe "get_access_token_info" do
+      it "should properly get and parse an access token token results into a hash" do
+        result = @oauth.get_access_token_info(@code)
+        result.should be_a(Hash)
+      end
+
+      it "should properly include the access token results" do
+        result = @oauth.get_access_token_info(@code)
+        result["access_token"].should
+      end
+
+      it "should raise an error when get_access_token is called with a bad code" do
+        lambda { @oauth.get_access_token_info("foo") }.should raise_error(Koala::Facebook::APIError) 
+      end
+    end
+
+    describe "get_access_token" do
+      it "should use get_access_token_info to get and parse an access token token results" do
+        result = @oauth.get_access_token(@code)
+        result.should be_a(String)
+      end
+
+      it "should return the access token as a string" do
+        result = @oauth.get_access_token(@code)
+        original = @oauth.get_access_token_info(@code)
+        result.should == original["access_token"]
+      end
+
+      it "should raise an error when get_access_token is called with a bad code" do
+        lambda { @oauth.get_access_token("foo") }.should raise_error(Koala::Facebook::APIError) 
+      end
+
+      describe "backwards compatibility" do
+        before :each do
+          @result = @oauth.get_access_token(@code)
+        end
 
-    # get_access_token
-    it "should properly get and parse an access token token results" do
-      result = @oauth.get_access_token(@code)
-      result["access_token"].should
+        it_should_behave_like "methods that return overloaded strings"
+      end
     end
 
-    it "should raise an error when get_access_token is called with a bad code" do
-      lambda { @oauth.get_access_token("foo") }.should raise_error(Koala::Facebook::APIError) 
+    describe "get_app_access_token_info" do
+      it "should properly get and parse an app's access token as a hash" do
+        result = @oauth.get_app_access_token_info
+        result.should be_a(Hash)
+      end
+    
+      it "should include the access token" do
+        result = @oauth.get_app_access_token_info
+        result["access_token"].should
+      end
     end
     
-    it "should properly get and parse an app's access token token results" do
-      result = @oauth.get_app_access_token
-      result["access_token"].should
+    describe "get_app_acess_token" do
+      it "should use get_access_token_info to get and parse an access token token results" do
+        result = @oauth.get_app_access_token
+        result.should be_a(String)
+      end
+
+      it "should return the access token as a string" do
+        result = @oauth.get_app_access_token
+        original = @oauth.get_app_access_token_info
+        result.should == original["access_token"]
+      end
+      
+      describe "backwards compatibility" do
+        before :each do
+          @result = @oauth.get_app_access_token    
+        end
+        
+        it_should_behave_like "methods that return overloaded strings"
+      end
+    end
+
+    describe "exchanging session keys" do
+      describe "with get_token_info_from_session_keys" do
+        it "should get an array of session keys from Facebook when passed a single key" do
+          result = @oauth.get_tokens_from_session_keys([@oauth_data["session_key"]])
+          result.should be_an(Array)
+          result.length.should == 1
+        end
+
+        it "should get an array of session keys from Facebook when passed multiple keys" do
+          result = @oauth.get_tokens_from_session_keys(@oauth_data["multiple_session_keys"])
+          result.should be_an(Array)
+          result.length.should == 2
+        end
+        
+        it "should return the original hashes" do
+          result = @oauth.get_token_info_from_session_keys(@oauth_data["multiple_session_keys"])
+          result[0].should be_a(Hash)
+        end
+      end
+      
+      describe "with get_tokens_from_session_keys" do
+        it "should call get_token_info_from_session_keys" do
+          args = @oauth_data["multiple_session_keys"]
+          @oauth.should_receive(:get_token_info_from_session_keys).with(args).and_return([])
+          @oauth.get_tokens_from_session_keys(args)
+        end
+        
+        it "should return an array of strings" do
+          args = @oauth_data["multiple_session_keys"]
+          result = @oauth.get_tokens_from_session_keys(args)
+          result.each {|r| r.should be_a(String) }
+        end
+        
+        describe "backwards compatibility" do
+          before :each do
+            args = @oauth_data["multiple_session_keys"]
+            @result = @oauth.get_tokens_from_session_keys(args)[0]
+          end
+
+          it_should_behave_like "methods that return overloaded strings"
+        end
+      end
+
+      describe "get_token_from_session_key" do
+        it "should call get_tokens_from_session_keys when the get_token_from_session_key is called" do
+          key = @oauth_data["session_key"]
+          @oauth.should_receive(:get_tokens_from_session_keys).with([key]).and_return([])
+          @oauth.get_token_from_session_key(key)
+        end
+
+        it "should get back the access token string from get_token_from_session_key" do
+          result = @oauth.get_token_from_session_key(@oauth_data["session_key"])
+          result.should be_a(String)
+        end
+
+        it "should be the first value in the array" do
+          result = @oauth.get_token_from_session_key(@oauth_data["session_key"])
+          array = @oauth.get_tokens_from_session_keys([@oauth_data["session_key"]])
+          result.should == array[0]
+        end
+        
+        describe "backwards compatibility" do
+          before :each do
+            @result = @oauth.get_token_from_session_key(@oauth_data["session_key"])       
+          end
+
+          it_should_behave_like "methods that return overloaded strings"
+        end
+      end    
     end
     
     # protected methods

data/spec/mock_facebook_responses.yml

@@ -114,6 +114,18 @@ graph_api:
           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: 
@@ -136,7 +148,15 @@ graph_api:
     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:

data/spec/mock_http_service.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'yaml'
 
 module Koala
   module MockHTTPService
@@ -15,7 +16,11 @@ module Koala
     
     # Useful in mock_facebook_responses.yml
     OAUTH_DATA = TEST_DATA['oauth_test_data']
-    OAUTH_DATA.merge!('app_access_token' => Koala::MockHTTPService::ACCESS_TOKEN)
+    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"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 1
-  version: 0.7.1
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 -07:00
+date: 2010-06-22 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,21 +26,37 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- lib/graph_api.rb
-- lib/http_services.rb
+- LICENSE
 - lib/koala.rb
-- lib/realtime_updates.rb
-- lib/rest_api.rb
+- lib/koala/graph_api.rb
+- lib/koala/http_services.rb
+- lib/koala/realtime_updates.rb
+- lib/koala/rest_api.rb
 files: 
 - CHANGELOG
+- LICENSE
 - Manifest
 - Rakefile
+- examples/oauth_playground/Capfile
+- examples/oauth_playground/LICENSE
+- examples/oauth_playground/Rakefile
+- examples/oauth_playground/config.ru
+- examples/oauth_playground/config/deploy.rb
+- examples/oauth_playground/config/facebook.yml
+- examples/oauth_playground/lib/load_facebook.rb
+- examples/oauth_playground/lib/oauth_playground.rb
+- examples/oauth_playground/readme.md
+- examples/oauth_playground/spec/oauth_playground_spec.rb
+- examples/oauth_playground/spec/spec_helper.rb
+- examples/oauth_playground/tmp/restart.txt
+- examples/oauth_playground/views/index.erb
+- examples/oauth_playground/views/layout.erb
 - init.rb
-- lib/graph_api.rb
-- lib/http_services.rb
 - lib/koala.rb
-- lib/realtime_updates.rb
-- lib/rest_api.rb
+- lib/koala/graph_api.rb
+- lib/koala/http_services.rb
+- lib/koala/realtime_updates.rb
+- lib/koala/rest_api.rb
 - readme.md
 - spec/facebook_data.yml
 - spec/koala/api_base_tests.rb