koala 1.1.0 → 1.2.0beta1

data/.travis.yml

@@ -1,8 +1,9 @@
 rvm:
   - 1.8.7 # (current default)
   - 1.9.2
+  - 1.9.3
+  - ruby-head
   - rbx
   - rbx-2.0
   - ree
   - jruby
-  - ruby-head

data/CHANGELOG

@@ -1,3 +1,29 @@
+v1.2
+New methods:
+-- API is now the main API class, contains both Graph and REST methods
+  -- Old classes are aliased with deprecation warnings (non-breaking change)
+-- TestUsers#update lets you update the name or password of an existing test user
+-- API.get_page_access_token lets you easily fetch the access token for a page you manage (thanks, marcgg!)
+Updated methods:
+-- API.put_picture now accepts URLs to images (thanks, marcgg!)
+Internal improvements:
+-- Koala now uses Faraday to make requests, replacing the HTTPServices (see wiki)
+  -- Koala::HTTPService.http_options allows specification of default Faraday connection options
+  -- Koala::HTTPService.faraday_middleware allows custom middleware configurations
+  -- Koala now defaults to Net::HTTP rather than Typhoeus
+  -- Koala::NetHTTPService and Koala::TyphoeusService modules no longer exist
+  -- Koala no longer automatically switches to Net::HTTP when uploading IO objects to Facebook
+-- RealTimeUpdates and TestUsers are no longer subclasses of API, but have their own .api objects
+  -- The old .graph_api accessor is aliases to .api with a deprecation warning
+Testing improvements:
+-- Live test suites now run against test users by default
+  -- Test suite can be repeatedly run live without having to update facebook_data.yml
+  -- OAuth code and session key tests cannot be run against test users
+-- Faraday adapter for live tests can be specified with ADAPTER=[your adapter] in the shell command
+-- Tests now pass against all rubies on Travis CI
+-- Expanded test coverage
+-- Fixed bug with YAML parsing in Ruby 1.9
+
 v1.1
 New methods:
 -- Added Batch API support (thanks, seejohnrun and spiegela!)

data/Gemfile

@@ -1,7 +1,11 @@
 source :rubygems
 
-gemspec
+group :development, :test do
+  gem "typhoeus"
+end
 
 if defined? JRUBY_VERSION
   gem "jruby-openssl"
-end
+end
+
+gemspec

data/Rakefile

@@ -7,7 +7,6 @@ rescue LoadError
   puts 'although not required, bundler is recommened for running the tests'
 end
 
-
 task :default => :spec
 
 require 'rspec/core/rake_task'

data/koala.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name    = %q{koala}
-  s.version = "1.1.0"
-  s.date    = %q{2011-07-18}
+  s.version = "1.2.0beta1"
+  s.date    = %q{2011-08-17}
 
   s.summary     = %q{A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication.}
   s.description = %q{Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph and REST APIs, 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.}
@@ -29,22 +29,22 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<multi_json>,      ["~> 1.0"])
-      s.add_runtime_dependency(%q<multipart-post>,  ["~> 1.0"])
+      s.add_runtime_dependency(%q<faraday>,  ["~> 0.7.4"])
+      s.add_runtime_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
       s.add_development_dependency(%q<rspec>,     ["~> 2.5"])
       s.add_development_dependency(%q<rake>,      ["~> 0.8.7"])
-      s.add_development_dependency(%q<typhoeus>,  ["~> 0.2.4"])
     else
       s.add_dependency(%q<multi_json>,      ["~> 1.0"])
-      s.add_dependency(%q<multipart-post>,  ["~> 1.0"])
       s.add_dependency(%q<rspec>,     ["~> 2.5"])
       s.add_dependency(%q<rake>,      ["~> 0.8.7"])
-      s.add_dependency(%q<typhoeus>,  ["~> 0.2.4"])
+      s.add_dependency(%q<faraday>,  ["~> 0.7.4"])
+      s.add_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
     end
   else
     s.add_dependency(%q<multi_json>,      ["~> 1.0"])
-    s.add_dependency(%q<multipart-post>,  ["~> 1.0"])
     s.add_dependency(%q<rspec>,     ["~> 2.5"])
     s.add_dependency(%q<rake>,      ["~> 0.8.7"])
-    s.add_dependency(%q<typhoeus>,  ["~> 0.2.4"])
+    s.add_dependency(%q<faraday>,  ["~> 0.7.4"])
+    s.add_dependency(%q<faraday-stack>,  ["~> 0.1.3"])
   end
 end

data/lib/koala.rb

@@ -8,8 +8,7 @@ require 'openssl'
 require 'base64'
 
 # include koala modules
-require 'koala/http_services'
-require 'koala/http_services/net_http_service'
+require 'koala/http_service'
 require 'koala/oauth'
 require 'koala/graph_api'
 require 'koala/graph_batch_api'
@@ -18,7 +17,7 @@ require 'koala/graph_collection'
 require 'koala/rest_api'
 require 'koala/realtime_updates'
 require 'koala/test_users'
-require 'koala/http_services'
+require 'koala/utils'
 
 # add KoalaIO class
 require 'koala/uploadable_io'
@@ -31,6 +30,7 @@ module Koala
     # Contributors: Alex Koppel, Chris Baclig, Rafi Jacoby, and the team at Context Optional
     # http://github.com/arsduo/koala
 
+    # APIs
     class API
       # initialize with an access token
       def initialize(access_token = nil)
@@ -38,10 +38,13 @@ module Koala
       end
       attr_reader :access_token
 
+      include GraphAPIMethods
+      include RestAPIMethods
+
       def api(path, args = {}, verb = "get", options = {}, &error_checking_block)
         # Fetches the given path in the Graph API.
         args["access_token"] = @access_token || @app_access_token if @access_token || @app_access_token
-        
+
         # add a leading /
         path = "/#{path}" unless path =~ /^\//
 
@@ -64,35 +67,30 @@ module Koala
       end
     end
 
-    # APIs
-    
-    class GraphAPI < API
-      include GraphAPIMethods
-    end
-    
-    class GraphBatchAPI < GraphAPI
-      include GraphBatchAPIMethods      
-    end
-        
-    class RestAPI < API
-      include RestAPIMethods
-    end
-
-    class GraphAndRestAPI < API
-      include GraphAPIMethods
-      include RestAPIMethods
+    # special enhanced APIs
+    class GraphBatchAPI < API
+      include GraphBatchAPIMethods
     end
 
-    class RealtimeUpdates < API
+    class RealtimeUpdates
       include RealtimeUpdateMethods
     end
 
-    class TestUsers < API
+    class TestUsers
       include TestUserMethods
-      # make the Graph API accessible in case someone wants to make other calls to interact with their users
-      attr_reader :graph_api
     end
 
+    # legacy support for old APIs
+    class OldAPI < API;
+      def initialize(*args)
+        Koala::Utils.deprecate("#{self.class.name} is deprecated and will be removed in a future version; please use the API class instead.")
+        super
+      end
+    end
+    class GraphAPI < OldAPI; end
+    class RestAPI < OldAPI; end
+    class GraphAndRestAPI < OldAPI; end
+
     # Errors
 
     class APIError < StandardError
@@ -106,29 +104,28 @@ module Koala
 
   class KoalaError < StandardError; end
 
-  # Make an api request using the provided api service or one passed by the caller
-  def self.make_request(path, args, verb, options = {})
-    http_service = options.delete(:http_service) || Koala.http_service
-    options = options.merge(:use_ssl => true) if @always_use_ssl
-    http_service.make_request(path, args, verb, options)
-  end
 
-  # finally, set up the http service Koala methods used to make requests
-  # you can use your own (for HTTParty, etc.) by calling Koala.http_service = YourModule
+  # finally, the few things defined on the Koala module itself
   class << self
     attr_accessor :http_service
-    attr_accessor :always_use_ssl
-    attr_accessor :base_http_service
   end
-  Koala.base_http_service = NetHTTPService
-
-  # by default, try requiring Typhoeus -- if that works, use it
-  # if you have Typheous and don't want to use it (or want another service),
-  # you can run Koala.http_service = NetHTTPService (or MyHTTPService)
-  begin
-    require 'koala/http_services/typhoeus_service'
-    Koala.http_service = TyphoeusService
-  rescue LoadError
-    Koala.http_service = Koala.base_http_service
+
+  def self.http_service=(service)
+    if service.respond_to?(:deprecated_interface)
+      # if this is a deprecated module, support the old interface
+      # by changing the default adapter so the right library is used
+      # we continue to use the single HTTPService module for everything
+      service.deprecated_interface 
+    else
+      # if it's a real http_service, use it
+      @http_service = service
+    end
+  end
+
+  def self.make_request(path, args, verb, options = {})
+    http_service.make_request(path, args, verb, options)
   end
+
+  # we use Faraday as our main service, with mock as the other main one
+  self.http_service = HTTPService
 end

data/lib/koala/batch_operation.rb

@@ -18,25 +18,25 @@ module Koala
         @url = options[:url]
         @method = options[:method].to_sym
         @post_processing = options[:post_processing]
-        
+
         process_binary_args
-        
+
         raise Koala::KoalaError, "Batch operations require an access token, none provided." unless @access_token
       end
-      
+
       def to_batch_params(main_access_token)
         # set up the arguments
         args_string = Koala.http_service.encode_params(@access_token == main_access_token ? @args : @args.merge(:access_token => @access_token))
-        
+
         response = {
-          :method => @method.to_s, 
+          :method => @method.to_s,
           :relative_url => @url,
         }
-         
+
         # handle batch-level arguments, such as name, depends_on, and attached_files
         @batch_args[:attached_files] = @files.keys.join(",") if @files
         response.merge!(@batch_args) if @batch_args
-        
+
         # for get and delete, we append args to the URL string
         # otherwise, they go in the body
         if args_string.length > 0
@@ -46,15 +46,15 @@ module Koala
             response[:body] = args_string if args_string.length > 0
           end
         end
-        
+
         response
       end
-  
+
       protected
-      
+
       def process_binary_args
         # collect binary files
-        @args.each_pair do |key, value| 
+        @args.each_pair do |key, value|
           if UploadableIO.binary_content?(value)
             @files ||= {}
             # we use a class-level counter to ensure unique file identifiers across multiple batch operations
@@ -63,12 +63,12 @@ module Koala
             id = "op#{identifier}_file#{@files.keys.length}"
             @files[id] = @args.delete(key).is_a?(UploadableIO) ? value : UploadableIO.new(value)
           end
-        end          
+        end
       end
-      
+
       def args_in_url?
-        @method == :get || @method == :delete 
-      end   
+        @method == :get || @method == :delete
+      end
     end
   end
 end

data/lib/koala/graph_api.rb

@@ -1,30 +1,30 @@
 module Koala
   module Facebook
-    GRAPH_SERVER = "graph.facebook.com"   
+    GRAPH_SERVER = "graph.facebook.com"
 
     module GraphAPIMethods
       # A client for the Facebook Graph API.
-      # 
+      #
       # See http://github.com/arsduo/koala for Ruby/Koala documentation
       # and http://developers.facebook.com/docs/api for Facebook API documentation
-      # 
+      #
       # The Graph API is made up of the objects in Facebook (e.g., people, pages,
       # events, photos) and the connections between them (e.g., friends,
       # photo tags, and event RSVPs). This client provides access to those
       # primitive types in a generic way. For example, given an OAuth access
       # token, this will fetch the profile of the active user and the list
       # of the user's friends:
-      # 
-      #    graph = Koala::Facebook::GraphAPI.new(access_token)
+      #
+      #    graph = Koala::Facebook::API.new(access_token)
       #    user = graph.get_object("me")
       #    friends = graph.get_connections(user["id"], "friends")
-      # 
+      #
       # You can see a list of all of the objects and connections supported
       # by the API at http://developers.facebook.com/docs/reference/api/.
-      # 
+      #
       # You can obtain an access token via OAuth or by using the Facebook
       # JavaScript SDK. See the Koala and Facebook documentation for more information.
-      # 
+      #
       # If you are using the JavaScript SDK, you can use the
       # Koala::Facebook::OAuth.get_user_from_cookie() method below to get the OAuth access token
       # for the active user from the cookie saved by the SDK.
@@ -35,19 +35,19 @@ module Koala
         # Fetchs the given object from the graph.
         graph_call(id, args, "get", options)
       end
-    
+
       def get_objects(ids, args = {}, options = {})
         # Fetchs all of the given objects from the graph.
         # If any of the IDs are invalid, they'll raise an exception.
         return [] if ids.empty?
         graph_call("", args.merge("ids" => ids.respond_to?(:join) ? ids.join(",") : ids), "get", options)
       end
-      
+
       def put_object(parent_object, connection_name, args = {}, options = {})
         # Writes the given object to the graph, connected to the given parent.
         # See http://developers.facebook.com/docs/api#publishing for all of
         # the supported writeable objects.
-        # 
+        #
         # For example,
         #     graph.put_object("me", "feed", :message => "Hello, world")
         # writes "Hello, world" to the active user's wall.
@@ -56,7 +56,7 @@ module Koala
         # publishing wall posts requires the "publish_stream" permission. See
         # http://developers.facebook.com/docs/authentication/ for details about
         # extended permissions.
-    
+
         raise APIError.new({"type" => "KoalaMissingAccessToken", "message" => "Write operations require an access token"}) unless @access_token
         graph_call("#{parent_object}/#{connection_name}", args, "post", options)
       end
@@ -66,9 +66,9 @@ module Koala
         raise APIError.new({"type" => "KoalaMissingAccessToken", "message" => "Delete requires an access token"}) unless @access_token
         graph_call(id, {}, "delete", options)
       end
-      
+
       # Connections
-          
+
       def get_connections(id, connection_name, args = {}, options = {})
         # Fetchs the connections for given object.
         graph_call("#{id}/#{connection_name}", args, "get", options) do |result|
@@ -76,14 +76,6 @@ module Koala
         end
       end
 
-      def get_comments_for_urls(urls = [], args = {}, options = {})
-        # Fetchs the comments for given URLs (array or comma-separated string)
-        # see https://developers.facebook.com/blog/post/490
-        return [] if urls.empty?
-        args.merge!(:ids => urls.respond_to?(:join) ? urls.join(",") : urls)
-        get_object("comments", args, options)
-      end
-          
       def put_connections(id, connection_name, args = {}, options = {})
         # Posts a certain connection
         raise APIError.new({"type" => "KoalaMissingAccessToken", "message" => "Write operations require an access token"}) unless @access_token
@@ -98,19 +90,20 @@ module Koala
 
       # Media (photos and videos)
       # to delete photos or videos, use delete_object(object_id)
-      # note: you'll need the user_photos or user_videos permissions to actually access media after upload 
-    
+      # note: you'll need the user_photos or user_videos permissions to actually access media after upload
+
       def get_picture(object, args = {}, options = {})
         # Gets a picture object, returning the URL (which Facebook sends as a header)
         graph_call("#{object}/picture", args, "get", options.merge(:http_component => :headers)) do |result|
           result["Location"]
         end
-      end    
-      
+      end
+
       # Can be called in multiple ways:
       #
       #   put_picture(file, [content_type], ...)
       #   put_picture(path_to_file, [content_type], ...)
+      #   put_picture(picture_url, ...)
       #
       # You can pass in uploaded files directly from Rails or Sinatra.
       # (See lib/koala/uploadable_io.rb for supported frameworks)
@@ -119,29 +112,32 @@ module Koala
       # - args:       a hash of request parameters (default: {})
       # - target_id:  ID of the target where to post the picture (default: "me")
       # - options:    a hash of http options passed to the HTTPService module
-      # 
+      #
       #   put_picture(file, content_type, {:message => "Message"}, 01234560)
       #   put_picture(params[:file], {:message => "Message"})
-      
+      #
+      #   (Note that with URLs, there's no optional content type field)
+      #   put_picture(picture_url, {:message => "Message"}, my_page_id)
+
       def put_picture(*picture_args)
         put_object(*parse_media_args(picture_args, "photos"))
       end
-        
+
       def put_video(*video_args)
         args = parse_media_args(video_args, "videos")
         args.last[:video] = true
         put_object(*args)
       end
-    
+
       # Wall posts
       # To get wall posts, use get_connections(user, "feed")
       # To delete a wall post, just use delete_object(post_id)
-    
+
       def put_wall_post(message, attachment = {}, profile_id = "me", options = {})
         # attachment is a hash describing the wall post
         # (see X for more details)
-        # For instance, 
-        # 
+        # For instance,
+        #
         #     {"name" => "Link name"
         #      "link" => "http://www.example.com/",
         #      "caption" => "{*actor*} posted a new review",
@@ -150,19 +146,19 @@ module Koala
 
         self.put_object(profile_id, "feed", attachment.merge({:message => message}), options)
       end
-      
+
       # Comments
       # to delete comments, use delete_object(comment_id)
       # to get comments, use get_connections(object, "likes")
-      
+
       def put_comment(object_id, message, options = {})
         # Writes the given comment on the given post.
         self.put_object(object_id, "comments", {:message => message}, options)
       end
-        
+
       # Likes
       # to get likes, use get_connections(user, "likes")
-      
+
       def put_like(object_id, options = {})
         # Likes the given post.
         self.put_object(object_id, "likes", {}, options)
@@ -175,15 +171,30 @@ module Koala
       end
 
       # Search
-            
+
       def search(search_terms, args = {}, options = {})
         args.merge!({:q => search_terms}) unless search_terms.nil?
         graph_call("search", args, "get", options) do |result|
           result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
         end
-      end      
-      
-      
+      end
+
+      # Convenience Methods
+
+      def get_page_access_token(object_id)
+        result = get_object(object_id, :fields => "access_token") do
+          result ? result["access_token"] : nil
+        end
+      end
+
+      def get_comments_for_urls(urls = [], args = {}, options = {})
+        # Fetchs the comments for given URLs (array or comma-separated string)
+        # see https://developers.facebook.com/blog/post/490
+        return [] if urls.empty?
+        args.merge!(:ids => urls.respond_to?(:join) ? urls.join(",") : urls)
+        get_object("comments", args, options)
+      end
+
       # GraphCollection support
       def get_page(params)
         # Pages through a set of results stored in a GraphCollection
@@ -192,8 +203,7 @@ module Koala
           result ? GraphCollection.new(result, self) : nil # when facebook is down nil can be returned
         end
       end
-      
-      
+
       # Batch API
       def batch(http_options = {}, &block)
         batch_client = GraphBatchAPI.new(access_token)
@@ -203,8 +213,8 @@ module Koala
         else
           batch_client
         end
-      end        
-      
+      end
+
       def self.included(base)
         base.class_eval do
           def self.batch
@@ -212,7 +222,7 @@ module Koala
           end
         end
       end
-      
+
       # Direct access to the Facebook API
       # see any of the above methods for example invocations
       def graph_call(path, args = {}, verb = "get", options = {}, &post_processing)
@@ -224,35 +234,48 @@ module Koala
         # now process as appropriate (get picture header, make GraphCollection, etc.)
         post_processing ? post_processing.call(result) : result
       end
-      
+
       def check_response(response)
         # check for Graph API-specific errors
         # this returns an error, which is immediately raised (non-batch)
         # or added to the list of batch results (batch)
         if response.is_a?(Hash) && error_details = response["error"]
-          APIError.new(error_details) 
+          APIError.new(error_details)
         end
       end
-      
+
       private
-      
+
       def parse_media_args(media_args, method)
         # photo and video uploads can accept different types of arguments (see above)
         # so here, we parse the arguments into a form directly usable in put_object
         raise KoalaError.new("Wrong number of arguments for put_#{method == "photos" ? "picture" : "video"}") unless media_args.size.between?(1, 5)
-        
+
         args_offset = media_args[1].kind_of?(Hash) || media_args.size == 1 ? 0 : 1
-        
+
         args      = media_args[1 + args_offset] || {}
         target_id = media_args[2 + args_offset] || "me"
-        options   = media_args[3 + args_offset] || {} 
-        
-        args["source"] = Koala::UploadableIO.new(*media_args.slice(0, 1 + args_offset))
+        options   = media_args[3 + args_offset] || {}
 
-        options[:http_service] = Koala.base_http_service if args["source"].requires_base_http_service
+        if url?(media_args.first)
+          # If media_args is a URL, we can upload without UploadableIO
+          args.merge!(:url => media_args.first)
+        else
+          args["source"] = Koala::UploadableIO.new(*media_args.slice(0, 1 + args_offset))
+        end
 
         [target_id, method, args, options]
-      end      
+      end
+
+      def url?(data)
+        return false unless data.is_a? String
+        begin
+          uri = URI.parse(data)
+          %w( http https ).include?(uri.scheme)
+        rescue URI::BadURIError
+          false
+        end
+      end
     end
   end
-end  
+end