koala 0.7.4 → 0.8.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.8.0
+-- Breaking interface changes
+  -- Removed string overloading for the methods, per 0.7.3, which caused Marshaling issues
+  -- Removed ability to provide a string as the second argument to url_for_access_token, per 0.5.0
+
 v0.7.4 
 -- Fixed bug with get_user_from_cookies
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake'
 require 'echoe'
 
 # gem management
-Echoe.new('koala', '0.7.4') do |p|
+Echoe.new('koala', '0.8.0') do |p|
   p.summary    = "A lightweight, flexible library for Facebook with support for the Graph API, the old REST API, realtime updates, and OAuth validation."
   p.description = "Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph API and the older REST API, as well as support for realtime updates and OAuth and Facebook Connect authentication.  Koala is fully tested and supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services."
   p.url            = "http://github.com/arsduo/koala"

data/koala.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{koala}
-  s.version = "0.7.4"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional"]
-  s.date = %q{2010-06-23}
+  s.date = %q{2010-06-27}
   s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph API and the older REST API, as well as support for realtime updates and OAuth and Facebook Connect authentication.  Koala is fully tested and supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services.}
   s.email = %q{alex@alexkoppel.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "lib/koala.rb", "lib/koala/graph_api.rb", "lib/koala/http_services.rb", "lib/koala/realtime_updates.rb", "lib/koala/rest_api.rb"]

data/lib/koala.rb

@@ -107,7 +107,7 @@ module Koala
         @app_secret = app_secret
         @oauth_callback_url = oauth_callback_url 
       end
-    
+
       def get_user_info_from_cookie(cookie_hash)
         # Parses the cookie set by the official Facebook JavaScript SDK.
         # 
@@ -141,7 +141,6 @@ module Koala
       def get_user_from_cookie(cookies)
         if info = get_user_info_from_cookies(cookies)
           string = info["uid"]
-          overload_as_hash(string, info)
         end
       end
       alias_method :get_user_from_cookies, :get_user_from_cookie
@@ -162,10 +161,6 @@ module Koala
         
       def url_for_access_token(code, options = {})
         # Creates the URL for the token corresponding to a given code generated by Facebook
-        if options.is_a?(String) # changing the arguments
-          puts "Deprecation warning: url_for_access_token now takes an options hash as the second argument; pass the callback as :callback."
-          options = {:callback => options}
-        end
         callback = options[:callback] || @oauth_callback_url
         raise ArgumentError, "url_for_access_token must get a callback either from the OAuth object or in the parameters!" unless callback
         "https://#{GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@app_secret}&code=#{code}"
@@ -178,11 +173,10 @@ module Koala
       end
       
       def get_access_token(code)
-        info = get_access_token_info(code)
         # upstream methods will throw errors if needed
-        string = info["access_token"]
-
-        overload_as_hash(string, info)          
+        if info = get_access_token_info(code) 
+          string = info["access_token"]        
+        end
       end
       
       def get_app_access_token_info
@@ -191,12 +185,11 @@ module Koala
       end
       
       def get_app_access_token
-        info = get_app_access_token_info
-        string = info["access_token"]
-
-        overload_as_hash(string, info)
+        if info = get_app_access_token_info
+          string = info["access_token"] 
+        end
       end
-      
+
       # from session keys
       def get_token_info_from_session_keys(sessions)
         # fetch the OAuth tokens from Facebook
@@ -217,13 +210,8 @@ module Koala
       def get_tokens_from_session_keys(sessions)
         # get the original hash results
         results = get_token_info_from_session_keys(sessions)
-        # now recollect them as backward-compatible strings
-        # for easier use
-        results.collect do |r|
-          string = r["access_token"]
-
-          overload_as_hash string, r
-        end
+        # now recollect them as just the access tokens
+        results.collect { |r| string = r["access_token"] }
       end
       
       def get_token_from_session_key(session)
@@ -259,23 +247,6 @@ module Koala
           :client_secret => @app_secret
         }.merge!(args), post ? "post" : "get").body
       end
-
-      # overload the object to be accessible as a hash
-      # used to make get_*_token methods backward compatible
-      # icky ruby magic, but it's _really_ cool we can do this
-      def overload_as_hash(obj, hash)
-        command = <<-EOS
-          def [](index)
-            puts "WARNING: get_app_access_token now provides the access token as a string; use get_app_access_token_info if you want the hash with expirations.  Otherwise you no longer need to call [] to get the token itself."
-            hash = #{hash.inspect}
-            hash[index]
-          end
-        EOS
-        
-        (class << obj; self; end).class_eval command
-        
-        obj
-      end
     end
   end
   

data/lib/koala/realtime_updates.rb

@@ -44,7 +44,7 @@ module Koala
         # fetch the access token if we're provided a secret
         if @secret && !@app_access_token
           oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-          @app_access_token = oauth.get_app_access_token["access_token"]
+          @app_access_token = oauth.get_app_access_token
         end
       end
       

data/spec/koala/api_base_tests.rb

@@ -77,35 +77,4 @@ class ApiBaseTests < Test::Unit::TestCase
       @service.api('anything').should be_false
     end
   end
-end
-
-shared_examples_for "methods that return overloaded strings" do
-  before :each do
-    @key ||= "access_token"
-  end
-  
-  it "should be overloaded to be backward compatible" do
-    @result.respond_to?(:[]).should be_true
-  end
-
-  it "should allow hash access to the access token info" do
-    @result[@key].should == @result
-  end
-
-  it "should output a deprecation warning when the result is used as a hash" do 
-    out = nil
-  
-    begin
-      # we want to capture the deprecation warning as well as the output
-      # credit to http://thinkingdigitally.com/archive/capturing-output-from-puts-in-ruby/ for the technique
-      out = StringIO.new
-      $stdout = out
-      @result[@key]
-    ensure
-      $stdout = STDOUT
-    end
-  
-    # ensure we got a warning
-    out.should_not be_nil
-  end
 end

data/spec/koala/oauth/oauth_tests.rb

@@ -107,16 +107,7 @@ class FacebookOAuthTests < Test::Unit::TestCase
           bad_cookie_hash = @oauth_data["valid_cookies"].inject({}) { |hash, value| hash[value[0]] = value[1].gsub(/[0-9]/, "3") }
           result = @oauth.get_user_from_cookies(bad_cookie_hash)
           result.should be_nil
-        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
     end
     
@@ -170,25 +161,6 @@ class FacebookOAuthTests < Test::Unit::TestCase
       url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@secret}&code=#{@code}"
     end
     
-    it "should output a deprecation warning but generate a properly formatted OAuth token URL when provided a callback in the deprecated fashion" do 
-      callback = "foo.com"
-      url = out = nil
-      
-      begin
-        # we want to capture the deprecation warning as well as the output
-        # credit to http://thinkingdigitally.com/archive/capturing-output-from-puts-in-ruby/ for the technique
-        out = StringIO.new
-        $stdout = out
-        url = @oauth.url_for_access_token(@code, callback)
-      ensure
-        $stdout = STDOUT
-      end
-      
-      # two assertions may be bad test writing, but this is for a deprecated method
-      url.should == "https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@secret}&code=#{@code}"
-      out.should_not be_nil
-    end
-
     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)
@@ -216,18 +188,10 @@ class FacebookOAuthTests < Test::Unit::TestCase
         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
-
-        it_should_behave_like "methods that return overloaded strings"
-      end
     end
 
     describe "get_app_access_token_info" do
@@ -253,14 +217,6 @@ class FacebookOAuthTests < Test::Unit::TestCase
         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
@@ -295,15 +251,6 @@ class FacebookOAuthTests < Test::Unit::TestCase
           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
@@ -323,14 +270,6 @@ class FacebookOAuthTests < Test::Unit::TestCase
           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
     

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 4
-  version: 0.7.4
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Alex Koppel, Chris Baclig, Rafi Jacoby, Context Optional
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-23 00:00:00 -07:00
+date: 2010-06-27 00:00:00 -07:00
 default_executable: 
 dependencies: []