mjfreshyfresh-mini_fb 0.1.15 → 0.1.17

data/lib/mini_fb.rb

@@ -1,290 +1,246 @@
 require 'digest/md5'
 require 'erb'
 require 'json' unless defined? JSON
+require 'net/http'
+require 'cgi' unless defined? Rack
 
 module MiniFB
+  
+  FB_URL = "http://api.facebook.com/restserver.php"
+  FB_API_VERSION = "1.0"
+  RETRY_ATTEMPTS = 10
+  
+  BAD_JSON_METHODS = %w{ users.getLoggedInUser }
+
+  @@logging = false
+
+  def enable_logging
+      @@logging = true
+  end
+
+  def disable_logging
+      @@logging = false
+  end
+
+  class BadJSONDataError < StandardError
+    # Error that happens when facebook sends back bad JSON 
+    def initialize(returned_data)
+      super "Facebook returned bad JSON data - #{returned_data}"
+    end
+  end
 
-    # Global constants
-    FB_URL = "http://api.facebook.com/restserver.php"
-    FB_API_VERSION = "1.0"
-    
-    RETRY_ATTEMPTS = 10
+  class FaceBookError < StandardError
+    # Error that happens during a facebook call.
+    def initialize( error_code, error_msg )
+        super("Facebook error #{error_code}: #{error_msg}" )
+    end
+  end
 
-    @@logging = false
+  class Session
+    attr_accessor :api_key, :secret_key, :session_key, :uid
 
-    def enable_logging
-        @@logging = true
+    def initialize(api_key, secret_key, session_key, uid)
+        @api_key = api_key
+        @secret_key = FaceBookSecret.new secret_key
+        @session_key = session_key
+        @uid = uid
     end
 
-    def disable_logging
-        @@logging = false
+    # returns current user
+    def user
+        return @user unless @user.nil?
+        @user = User.new(MiniFB.call(@api_key, @secret_key, "Users.getInfo", "session_key"=>@session_key, "uids"=>@uid, "fields"=>User.all_fields)[0], self)
+        @user
     end
 
-    class FaceBookError < StandardError
-        # Error that happens during a facebook call.
-        def initialize( error_code, error_msg )
-            super("Facebook error #{error_code}: #{error_msg}" )
-        end
+    def photos
+        Photos.new(self)
     end
 
-    class Session
-        attr_accessor :api_key, :secret_key, :session_key, :uid
-
-
-        def initialize(api_key, secret_key, session_key, uid)
-            @api_key = api_key
-            @secret_key = FaceBookSecret.new secret_key
-            @session_key = session_key
-            @uid = uid
-        end
-
-        # returns current user
-        def user
-            return @user unless @user.nil?
-            @user = User.new(MiniFB.call(@api_key, @secret_key, "Users.getInfo", "session_key"=>@session_key, "uids"=>@uid, "fields"=>User.all_fields)[0], self)
-            @user
-        end
-
-        def photos
-            Photos.new(self)
-        end
-
-
-        def call(method, params={})
-            return MiniFB.call(api_key, secret_key, method, params.update("session_key"=>session_key))
-        end
-
-
+    def call(method, params={})
+        return MiniFB.call(api_key, secret_key, method, params.update("session_key"=>session_key))
     end
-    class User
-        FIELDS = [:uid, :status, :political, :pic_small, :name, :quotes, :is_app_user, :tv, :profile_update_time, :meeting_sex, :hs_info, :timezone, :relationship_status, :hometown_location, :about_me, :wall_count, :significant_other_id, :pic_big, :music, :work_history, :sex, :religion, :notes_count, :activities, :pic_square, :movies, :has_added_app, :education_history, :birthday, :birthday_date, :first_name, :meeting_for, :last_name, :interests, :current_location, :pic, :books, :affiliations, :locale, :profile_url, :proxied_email, :email_hashes, :allowed_restrictions, :pic_with_logo, :pic_big_with_logo, :pic_small_with_logo, :pic_square_with_logo]
-        STANDARD_FIELDS = [:uid, :first_name, :last_name, :name, :timezone, :birthday, :sex, :affiliations, :locale, :profile_url, :proxied_email]
-
-        def self.all_fields
-            FIELDS.join(",")
-        end
-
-        def self.standard_fields
-            STANDARD_FIELDS.join(",")
-        end
-
-        def initialize(fb_hash, session)
-            @fb_hash = fb_hash
-            @session = session
-        end
-
-        def [](key)
-            @fb_hash[key]
-        end
-
-        def uid
-            return self["uid"]
-        end
-
-        def profile_photos
-            @session.photos.get("uid"=>uid, "aid"=>profile_pic_album_id)
-        end
-
-        def profile_pic_album_id
-            merge_aid(-3, uid)
-        end
-
-        def merge_aid(aid, uid)
-            uid = uid.to_i
-            ret = (uid << 32) + (aid & 0xFFFFFFFF)
-#            puts 'merge_aid=' + ret.inspect
-            return ret
-        end
+  end
+  
+  class User
+    FIELDS = [:uid, :status, :political, :pic_small, :name, :quotes, :is_app_user, :tv, :profile_update_time, :meeting_sex, :hs_info, :timezone, :relationship_status, :hometown_location, :about_me, :wall_count, :significant_other_id, :pic_big, :music, :work_history, :sex, :religion, :notes_count, :activities, :pic_square, :movies, :has_added_app, :education_history, :birthday, :birthday_date, :first_name, :meeting_for, :last_name, :interests, :current_location, :pic, :books, :affiliations, :locale, :profile_url, :proxied_email, :email_hashes, :allowed_restrictions, :pic_with_logo, :pic_big_with_logo, :pic_small_with_logo, :pic_square_with_logo]
+    STANDARD_FIELDS = [:uid, :first_name, :last_name, :name, :timezone, :birthday, :sex, :affiliations, :locale, :profile_url, :proxied_email]
+
+    def self.all_fields
+        FIELDS.join(",")
     end
 
-    class Photos
-
-        def initialize(session)
-            @session = session
-        end
-
-        def get(params)
-            pids = params["pids"]
-            if !pids.nil? && pids.is_a?(Array)
-                pids = pids.join(",")
-                params["pids"] = pids
-            end
-            @session.call("photos.get", params)
-        end
+    def self.standard_fields
+        STANDARD_FIELDS.join(",")
     end
 
-    BAD_JSON_METHODS = ["users.getLoggedInUser","auth.promoteSession"]
-
-    # Call facebook server with a method request. Most keyword arguments
-    # are passed directly to the server with a few exceptions.
-    # The 'sig' value will always be computed automatically.
-    # The 'v' version will be supplied automatically if needed.
-    # The 'call_id' defaults to True, which will generate a valid
-    # number. Otherwise it should be a valid number or False to disable.
-
-    # The default return is a parsed json object.
-    # Unless the 'format' and/or 'callback' arguments are given,
-    # in which case the raw text of the reply is returned. The string
-    # will always be returned, even during errors.
-
-    # If an error occurs, a FacebookError exception will be raised
-    # with the proper code and message.
-
-    # The secret argument should be an instance of FacebookSecret
-    # to hide value from simple introspection.
-    def MiniFB.call( api_key, secret, method, kwargs )
-
-        puts 'kwargs=' + kwargs.inspect if @@logging
-
-        if secret.is_a? String
-            secret = FaceBookSecret.new(secret)
-        end
-
-        # Prepare arguments for call
-        call_id = kwargs.fetch("call_id", true)
-        if call_id == true then
-            kwargs["call_id"] = Time.now.tv_sec.to_s
-        else
-            kwargs.delete("call_id")
-        end
-
-        custom_format = kwargs.include?("format") or kwargs.include?("callback")
-        kwargs["format"] ||= "JSON"
-        kwargs["v"] ||= FB_API_VERSION
-        kwargs["api_key"]||= api_key
-        kwargs["method"] ||= method
-
-        # Hash with secret
-        arg_string = String.new
-        kwargs.each { |k,v| (kwargs[k.to_s] = v ; kwargs.delete(k)) if k.is_a? Symbol }
-        kwargs.sort.each { |kv| arg_string << kv[0] << "=" << kv[1].to_s }
-        kwargs["sig"] = Digest::MD5.hexdigest( arg_string + secret.value.call )
-
-        # Call website with POST request
-        attempt = 0
-        begin
-          response = Net::HTTP.post_form( URI.parse(FB_URL), kwargs )
-        rescue SocketError, Errno::ECONNRESET, EOFError => err
-          if attempt < RETRY_ATTEMPTS
-            attempt += 1
-            retry
-          else
-            raise
-          end
-          # raise IOError.new( "Cannot connect to the facebook server: " + err )
-        rescue
-          raise
-        end
-
-        # Handle response
-        return response.body if custom_format
-
-        fb_method = kwargs["method"]
-        body = response.body
-
-        begin
-            data = JSON.parse( body )
-            puts 'response=' + data.inspect if @@logging
-            if data.include?( "error_msg" ) then
-                raise FaceBookError.new( data["error_code"] || 1, data["error_msg"] )
-            end
-
-        rescue JSON::ParserError => ex
-            if BAD_JSON_METHODS.include?(fb_method) # Little hack because this response isn't valid JSON
-                return body
-            else
-                raise ex
-            end
-        end
-        return data
+    def initialize(fb_hash, session)
+        @fb_hash = fb_hash
+        @session = session
     end
 
-    # Returns true is signature is valid, false otherwise.
-    def MiniFB.verify_signature( secret, arguments )
-        signature = arguments.delete( "fb_sig" )
-        return false if signature.nil?
+    def [](key)
+        @fb_hash[key]
+    end
 
-        unsigned = Hash.new
-        signed = Hash.new
+    def uid
+        return self["uid"]
+    end
 
-        arguments.each do |k, v|
-            if k =~ /^fb_sig_(.*)/ then
-                signed[$1] = v
-            else
-                unsigned[k] = v
-            end
-        end
+    def profile_photos
+        @session.photos.get("uid"=>uid, "aid"=>profile_pic_album_id)
+    end
 
-        arg_string = String.new
-        signed.sort.each { |kv| arg_string << kv[0] << "=" << kv[1] }
-        if Digest::MD5.hexdigest( arg_string + secret ) == signature
-            return true
-        end
-        return false
+    def profile_pic_album_id
+        merge_aid(-3, uid)
     end
 
-    # Returns the login/add app url for your application.
-    #
-    # options:
-    #    - :next => a relative next page to go to. relative to your facebook connect url or if :canvas is true, then relative to facebook app url
-    #    - :canvas => true/false - to say whether this is a canvas app or not
-    def self.login_url(api_key, options={})
-        login_url = "http://api.facebook.com/login.php?api_key=#{api_key}"
-        login_url << "&next=#{options[:next]}" if options[:next]
-        login_url << "&canvas" if options[:canvas]
-        login_url
+    def merge_aid(aid, uid)
+        uid = uid.to_i
+        ret = (uid << 32) + (aid & 0xFFFFFFFF)
+#            puts 'merge_aid=' + ret.inspect
+        return ret
     end
+  end
 
-    # This function expects arguments as a hash, so
-    # it is agnostic to different POST handling variants in ruby.
-    #
-    # Validate the arguments received from facebook. This is usually
-    # sent for the iframe in Facebook's canvas. It is not necessary
-    # to use this on the auth_token and uid passed to callbacks like
-    # post-add and post-remove.
-#
-    # The arguments must be a mapping of to string keys and values
-    # or a string of http request data.
-#
-    # If the data is invalid or not signed properly, an empty
-    # dictionary is returned.
-#
-    # The secret argument should be an instance of FacebookSecret
-    # to hide value from simple introspection.
-#
-    # DEPRECATED, use verify_signature instead
-    def MiniFB.validate( secret, arguments )
-
-        signature = arguments.delete( "fb_sig" )
-        return arguments if signature.nil?
-
-        unsigned = Hash.new
-        signed = Hash.new
-
-        arguments.each do |k, v|
-            if k =~ /^fb_sig_(.*)/ then
-                signed[$1] = v
-            else
-                unsigned[k] = v
-            end
-        end
+  class Photos
 
-        arg_string = String.new
-        signed.sort.each { |kv| arg_string << kv[0] << "=" << kv[1] }
-        if Digest::MD5.hexdigest( arg_string + secret ) != signature
-            unsigned # Hash is incorrect, return only unsigned fields.
+      def initialize(session)
+          @session = session
+      end
+
+      def get(params)
+          pids = params["pids"]
+          if !pids.nil? && pids.is_a?(Array)
+              pids = pids.join(",")
+              params["pids"] = pids
+          end
+          @session.call("photos.get", params)
+      end
+  end
+
+  # Call facebook server with a method request. Most keyword arguments
+  # are passed directly to the server with a few exceptions.
+  # The 'sig' value will always be computed automatically.
+  # The 'v' version will be supplied automatically if needed.
+  # The 'call_id' defaults to True, which will generate a valid
+  # number. Otherwise it should be a valid number or False to disable.
+
+  # The default return is a parsed json object.
+  # Unless the 'format' and/or 'callback' arguments are given,
+  # in which case the raw text of the reply is returned. The string
+  # will always be returned, even during errors.
+
+  # If an error occurs, a FacebookError exception will be raised
+  # with the proper code and message.
+
+  # The secret argument should be an instance of FacebookSecret
+  # to hide value from simple introspection.
+  def MiniFB.call( api_key, secret, method, kwargs )
+
+      puts 'kwargs=' + kwargs.inspect if @@logging
+
+      if secret.is_a? String
+          secret = FaceBookSecret.new(secret)
+      end
+
+      # Prepare arguments for call
+      call_id = kwargs.fetch("call_id", true)
+      if call_id == true then
+          kwargs["call_id"] = Time.now.tv_sec.to_s
+      else
+          kwargs.delete("call_id")
+      end
+
+      custom_format = kwargs.include?("format") or kwargs.include?("callback")
+      kwargs["format"] ||= "JSON"
+      kwargs["v"] ||= FB_API_VERSION
+      kwargs["api_key"]||= api_key
+      kwargs["method"] ||= method
+
+      # Hash with secret
+      arg_string = String.new
+      kwargs.each { |k,v| (kwargs[k.to_s] = v ; kwargs.delete(k)) if k.is_a? Symbol }
+      kwargs.sort.each { |kv| arg_string << kv[0] << "=" << kv[1].to_s }
+      kwargs["sig"] = Digest::MD5.hexdigest( arg_string + secret.value.call )
+
+      # Call website with POST request
+      attempt = 0
+      begin
+        response = Net::HTTP.post_form( URI.parse(FB_URL), kwargs )
+      rescue SocketError, Errno::ECONNRESET, EOFError => err
+        if attempt < RETRY_ATTEMPTS
+          attempt += 1
+          retry
         else
-            unsigned.merge signed
+          raise
         end
-    end
+        # raise IOError.new( "Cannot connect to the facebook server: " + err )
+      rescue
+        raise
+      end
 
-    class FaceBookSecret
-        # Simple container that stores a secret value.
-        # Proc cannot be dumped or introspected by normal tools.
-        attr_reader :value
+      # Handle response
+      return response.body if custom_format
 
-        def initialize( value )
-            @value = Proc.new { value }
-        end
-    end
+      begin
+          data = JSON.parse( response.body )
+          puts 'response=' + data.inspect if @@logging
+          if data.include?( "error_msg" ) then
+              raise FaceBookError.new( data["error_code"] || 1, data["error_msg"] )
+          end
+
+      rescue JSON::ParserError => ex
+        return response.body if BAD_JSON_METHODS.include? kwargs["method"]
+        return (response.body == 'true') if %w{true false}.include?(response.body) # Hack for Facebook boolean API calls with BAD JSON.
+        raise BadJSONDataError, "#{kwargs["method"]} returned \"#{response.body}\""
+      end
+      return data
+  end
+
+  # Returns true is signature is valid, false otherwise.
+  def MiniFB.verify_signature( secret, arguments )
+      signature = arguments.delete( "fb_sig" )
+      return false if signature.nil?
+
+      unsigned = Hash.new
+      signed = Hash.new
+
+      arguments.each do |k, v|
+          if k =~ /^fb_sig_(.*)/ then
+              signed[$1] = v
+          else
+              unsigned[k] = v
+          end
+      end
+
+      arg_string = String.new
+      signed.sort.each { |kv| arg_string << kv[0] << "=" << kv[1] }
+      if Digest::MD5.hexdigest( arg_string + secret ) == signature
+          return true
+      end
+      return false
+  end
+
+  # Returns the login/add app url for your application.
+  #
+  # options:
+  #    - :next => a relative next page to go to. relative to your facebook connect url or if :canvas is true, then relative to facebook app url
+  #    - :canvas => true/false - to say whether this is a canvas app or not
+  def self.login_url(api_key, options={})
+    login_url = "http://api.facebook.com/login.php?api_key=#{api_key}"
+    login_url << "&next=#{defined?(Rack) ? Rack::Utils.escape(Rack::Utils.unescape(options[:next])) : CGI.escape(CGI.unescape(options[:next])) if options[:next]}" if options[:next]
+    login_url << "&canvas" if options[:canvas]
+    login_url
+  end
+
+  class FaceBookSecret
+      # Simple container that stores a secret value.
+      # Proc cannot be dumped or introspected by normal tools.
+      attr_reader :value
+
+      def initialize( value )
+          @value = Proc.new { value }
+      end
+  end
 end

data/test/test_mini_fb.rb

@@ -1,29 +1,73 @@
+require 'rubygems'
 require 'test/unit'
-class MiniFBTests < Test::Unit::TestCase
-
+require 'contest'
+require 'lib/mini_fb'
+require 'cgi'
+require 'rexml/document'
 
-    def setup
-    end
+API_KEY = ''
+SECRET_KEY = ''
+SESSION_KEY = ''
+PAGE_ID = '' # If you're not an Admin of this page, you'll need to change the test below so it will pass.
+FB_USER_ID = ''
 
-    def teardown
+raise 'Missing API_KEY and/or SECRET_KEY' unless API_KEY && SECRET_KEY
 
+class MiniFBTests < Test::Unit::TestCase
+  
+  context 'A Facebook session' do
+    setup do
+      @facebook_session = MiniFB::Session.new(API_KEY, SECRET_KEY, SESSION_KEY, FB_USER_ID)
     end
-
-    # Test signature verification.
-    def test_signature
-        
+    
+    test 'users.getLoggedInUser should return successfully' do
+      result = @facebook_session.call 'users.getLoggedInUser'
+      assert result.is_a?(String)
+      assert result.to_i > 0
     end
-
-    def test_basic_calls
-
+    
+    test 'should call friends.get and return an array' do
+      results = @facebook_session.call 'Friends.get'
+      assert results.is_a? Array
+      assert results.length > 0
+      assert results[0].to_i > 0
     end
-
-    def test_session
-
+    
+    test 'should return a boolean for boolean call, and not get caught by invalid JSON returns from boolean calls on Facebook' do
+      result = @facebook_session.call 'Pages.isAdmin', 'page_id' => PAGE_ID
+      assert result == true
     end
-
-    def test_photos
-        
+    
+    test 'should return raw JSON if JSON format is directly specified' do
+      results = @facebook_session.call 'Friends.get'
+      results_raw = @facebook_session.call 'Friends.get', 'format' => 'JSON'
+      assert results == JSON.parse(results_raw)
     end
-
-end
+    
+    test 'should return XML if format is XML' do
+      results = @facebook_session.call 'Friends.get', 'format' => 'xml'
+      returned_at_least_one_response_element = false
+      returned_uids = true
+      REXML::Document.new(results).root.each_recursive do |element|
+        returned_at_least_one_response_element = true if element.name == 'Friends_get_response_elt'
+        returned_uids = false if element.text.to_s.to_i == 0 && element.name != 'Friends_get_response_elt'
+      end
+      assert returned_uids
+      assert returned_at_least_one_response_element
+    end
+    
+    test 'should return the login url' do
+      login_url = MiniFB.login_url(API_KEY)
+      assert login_url == "http://api.facebook.com/login.php?api_key=#{API_KEY}"
+    end
+    
+    test 'should return the login url with next url even if escaped' do
+      next_url = 'http://apps.facebook.com/farmexplosion'
+      login_url = MiniFB.login_url API_KEY, :next => next_url
+      login_url_escaped = MiniFB.login_url API_KEY, :next => CGI.escape(next_url)
+      assert login_url == "http://api.facebook.com/login.php?api_key=#{API_KEY}&next=#{CGI.escape next_url}"
+      assert login_url == "http://api.facebook.com/login.php?api_key=#{API_KEY}&next=#{CGI.escape next_url}"
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mjfreshyfresh-mini_fb
 version: !ruby/object:Gem::Version 
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors: 
 - Travis Reeder
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-29 00:00:00 -08:00
+date: 2010-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Tiny facebook library
+description: Tiny facebook library for direct queries to the API
 email: michael@stepchangegroup.com
 executables: []