simianarmy-facebooker 1.0.40

data/lib/facebooker/parser.rb

@@ -0,0 +1,650 @@
+require 'rexml/document'
+require 'facebooker/session'
+module Facebooker
+  class Parser
+    
+    module REXMLElementExtensions
+      def text_value
+        self.children.first.to_s.strip
+      end
+    end
+    
+    ::REXML::Element.__send__(:include, REXMLElementExtensions)
+    
+    def self.parse(method, data)
+      Errors.process(data)
+      parser = Parser::PARSERS[method]
+      parser.process(
+        data
+      )
+    end
+    
+    def self.array_of(response_element, element_name)
+      values_to_return = []
+      response_element.elements.each(element_name) do |element|
+        values_to_return << yield(element)
+      end
+      values_to_return
+    end
+    
+    def self.array_of_text_values(response_element, element_name)
+      array_of(response_element, element_name) do |element|
+        element.text_value
+      end
+    end
+
+    def self.array_of_hashes(response_element, element_name)
+      array_of(response_element, element_name) do |element|
+        hashinate(element)
+      end
+    end
+    
+    def self.element(name, data)
+      data = data.body rescue data # either data or an HTTP response
+      doc = REXML::Document.new(data)
+      doc.elements.each(name) do |element|
+        return element
+      end
+      raise "Element #{name} not found in #{data}"
+    end
+    
+    def self.hash_or_value_for(element)
+      if element.children.size == 1 && element.children.first.kind_of?(REXML::Text)
+        element.text_value
+      else
+        hashinate(element)
+      end
+    end
+    
+    def self.hashinate(response_element)
+      response_element.children.reject{|c| c.kind_of? REXML::Text}.inject({}) do |hash, child|
+        # puts "hash => "
+        #         puts hash.inspect
+        #         puts "child => "
+        #         puts child.inspect
+        # If the node hasn't any child, and is not a list, we want empty strings, not empty hashes,
+        #   except if attributes['nil'] == true
+        hash[child.name] = 
+        if (child.attributes['nil'] == 'true')
+          nil 
+        elsif (child.children.size == 1 && child.children.first.kind_of?(REXML::Text)) || (child.children.size == 0 && child.attributes['list'] != 'true')
+          anonymous_field_from(child, hash) || child.text_value
+        elsif child.attributes['list'] == 'true'
+          child.children.reject{|c| c.kind_of? REXML::Text}.map { |subchild| hash_or_value_for(subchild)}    
+        else
+          child.children.reject{|c| c.kind_of? REXML::Text}.inject({}) do |subhash, subchild|
+            subhash[subchild.name] = hash_or_value_for(subchild)
+            subhash
+          end
+        end #if (child.attributes)
+        hash
+      end #do |hash, child|      
+    end
+    
+    def self.booleanize(response)
+      response == "1" ? true : false
+    end
+    
+    def self.anonymous_field_from(child, hash)
+      if child.name == 'anon'
+        (hash[child.name] || []) << child.text_value
+      end
+    end
+    
+  end  
+  
+  class RevokeAuthorization < Parser#:nodoc:
+    def self.process(data)
+      booleanize(data)
+    end
+  end
+  
+  class CreateToken < Parser#:nodoc:
+    def self.process(data)
+      element('auth_createToken_response', data).text_value
+    end
+  end
+  
+  class RegisterUsers < Parser
+    def self.process(data)
+      array_of_text_values(element("connect_registerUsers_response", data), "connect_registerUsers_response_elt")
+    end
+  end
+  
+  class UnregisterUsers < Parser
+    def self.process(data)
+      array_of_text_values(element("connect_unregisterUsers_response", data), "connect_unregisterUsers_response_elt")
+    end
+  end
+
+  class GetUnconnectedFriendsCount < Parser
+    def self.process(data)
+      hash_or_value_for(element("connect_getUnconnectedFriendsCount_response",data)).to_i 
+    end
+  end
+
+  class GetSession < Parser#:nodoc:
+    def self.process(data)      
+      hashinate(element('auth_getSession_response', data))
+    end
+  end
+  
+  class GetFriends < Parser#:nodoc:
+    def self.process(data)
+      array_of_text_values(element('friends_get_response', data), 'uid')
+    end
+  end
+  
+  class FriendListsGet < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('friends_getLists_response', data), 'friendlist')
+    end
+  end
+ 
+  class UserInfo < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('users_getInfo_response', data), 'user')
+    end
+  end
+  
+  class UserStandardInfo < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('users_getStandardInfo_response', data), 'standard_user_info')
+    end
+  end
+  
+  class GetLoggedInUser < Parser#:nodoc:
+    def self.process(data)
+      Integer(element('users_getLoggedInUser_response', data).text_value)
+    end
+  end
+
+  class PagesIsAdmin < Parser#:nodoc:
+    def self.process(data)
+      element('pages_isAdmin_response', data).text_value == '1'
+    end
+  end
+
+  class PagesGetInfo < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('pages_getInfo_response', data), 'page')
+    end
+  end
+  
+  class PagesIsFan < Parser#:nodoc:
+    def self.process(data)
+      element('pages_isFan_response', data).text_value == '1'
+    end
+  end  
+
+  class PublishStoryToUser < Parser#:nodoc:
+    def self.process(data)
+      element('feed_publishStoryToUser_response', data).text_value
+    end
+  end
+
+  class RegisterTemplateBundle < Parser#:nodoc:
+    def self.process(data)
+      element('feed_registerTemplateBundle_response', data).text_value.to_i
+    end
+  end
+
+  class GetRegisteredTemplateBundles < Parser
+    def self.process(data)
+      array_of_hashes(element('feed_getRegisteredTemplateBundles_response',data), 'template_bundle')
+    end
+  end
+
+  class DeactivateTemplateBundleByID < Parser#:nodoc:
+    def self.process(data)
+      element('feed_deactivateTemplateBundleByID_response', data).text_value == '1'
+    end
+  end
+
+  class PublishUserAction < Parser#:nodoc:
+    def self.process(data)
+      element('feed_publishUserAction_response', data).children[1].text_value == "1"
+    end
+  end
+  
+  class PublishActionOfUser < Parser#:nodoc:
+    def self.process(data)
+      element('feed_publishActionOfUser_response', data).text_value
+    end
+  end
+    
+  class PublishTemplatizedAction < Parser#:nodoc:
+    def self.process(data)
+      element('feed_publishTemplatizedAction_response', data).children[1].text_value
+    end
+  end
+  
+  class SetAppProperties < Parser#:nodoc:
+    def self.process(data)
+      element('admin_setAppProperties_response', data).text_value
+    end
+  end  
+  
+  class GetAppProperties < Parser#:nodoc:
+    def self.process(data)
+      element('admin_getAppProperties_response', data).text_value
+    end
+  end
+  
+  class SetRestrictionInfo < Parser#:nodoc:
+    def self.process(data)
+      element('admin_setRestrictionInfo_response', data).text_value
+    end
+  end  
+  
+  class GetRestrictionInfo < Parser#:nodoc:
+    def self.process(data)
+      element('admin_getRestrictionInfo_response', data).text_value
+    end
+  end
+  
+  class GetAllocation < Parser#:nodoc:
+    def self.process(data)
+      element('admin_getAllocation_response', data).text_value
+    end
+  end
+  
+  class BatchRun < Parser #:nodoc:
+    class << self
+      def current_batch=(current_batch)
+        Thread.current[:facebooker_current_batch]=current_batch
+      end
+      def current_batch
+        Thread.current[:facebooker_current_batch]
+      end
+    end
+    def self.process(data)
+      array_of_text_values(element('batch_run_response',data),"batch_run_response_elt").each_with_index do |response,i|
+        batch_request=current_batch[i]
+        body=Struct.new(:body).new
+        body.body=CGI.unescapeHTML(response)
+        begin
+          batch_request.result=Parser.parse(batch_request.method,body)
+        rescue Exception=>ex
+          batch_request.exception_raised=ex
+        end
+      end
+    end
+  end
+  
+  class GetAppUsers < Parser#:nodoc:
+    def self.process(data)
+      array_of_text_values(element('friends_getAppUsers_response', data), 'uid')
+    end
+  end
+  
+  class NotificationsGet < Parser#:nodoc:
+    def self.process(data)
+      hashinate(element('notifications_get_response', data))
+    end
+  end
+  
+  class NotificationsSend < Parser#:nodoc:
+    def self.process(data)
+      element('notifications_send_response', data).text_value
+    end
+  end 
+
+  class NotificationsSendEmail < Parser#:nodoc:
+    def self.process(data)  
+      element('notifications_sendEmail_response', data).text_value
+    end
+  end
+
+  class GetTags < Parser#nodoc:
+    def self.process(data)
+      array_of_hashes(element('photos_getTags_response', data), 'photo_tag')
+    end
+  end
+  
+  class AddTags < Parser#nodoc:
+    def self.process(data)
+      element('photos_addTag_response', data)
+    end
+  end
+
+  class GetPhotos < Parser#nodoc:
+    def self.process(data)
+      array_of_hashes(element('photos_get_response', data), 'photo')
+    end
+  end
+  
+  class GetAlbums < Parser#nodoc:
+    def self.process(data)
+      array_of_hashes(element('photos_getAlbums_response', data), 'album')
+    end
+  end
+  
+  class CreateAlbum < Parser#:nodoc:
+    def self.process(data)
+      hashinate(element('photos_createAlbum_response', data))
+    end
+  end  
+  
+  class UploadPhoto < Parser#:nodoc:
+    def self.process(data)
+      hashinate(element('photos_upload_response', data))
+    end
+  end
+
+  class UploadVideo < Parser#:nodoc:
+    def self.process(data)
+      hashinate(element('video_upload_response', data))
+    end
+  end
+  
+  class SendRequest < Parser#:nodoc:
+    def self.process(data)
+      element('notifications_sendRequest_response', data).text_value
+    end
+  end
+  
+  class ProfileFBML < Parser#:nodoc:
+    def self.process(data)
+      element('profile_getFBML_response', data).text_value
+    end
+  end
+  
+  class ProfileFBMLSet < Parser#:nodoc:
+    def self.process(data)
+      element('profile_setFBML_response', data).text_value
+    end
+  end
+  
+  class ProfileInfo < Parser#:nodoc:
+    def self.process(data)
+      hashinate(element('profile_getInfo_response info_fields', data))
+    end
+  end
+  
+  class ProfileInfoSet < Parser#:nodoc:
+    def self.process(data)
+      element('profile_setInfo_response', data).text_value
+    end
+  end
+  
+  class FqlQuery < Parser#nodoc
+    def self.process(data)
+      root = element('fql_query_response', data)
+      first_child = root.children.reject{|c| c.kind_of?(REXML::Text)}.first
+      first_child.nil? ? [] : [first_child.name, array_of_hashes(root, first_child.name)]
+    end
+  end
+  
+  class FqlMultiquery < Parser#nodoc
+     def self.process(data)
+       root = element('fql_multiquery_response', data)
+       root.elements.collect do |elm|
+         [
+           elm.elements[1].text,
+           if elm.elements[2].elements[1].nil?
+             []
+           else
+             [
+               elm.elements[2].elements[1].name,
+               array_of_hashes(elm.elements[2], elm.elements[2].elements[1].name)
+             ]
+           end
+         ]
+       end
+     end
+   end
+   
+  class SetRefHandle < Parser#:nodoc:
+    def self.process(data)
+      element('fbml_setRefHandle_response', data).text_value
+    end
+  end
+  
+  class RefreshRefURL < Parser#:nodoc:
+    def self.process(data)
+      element('fbml_refreshRefUrl_response', data).text_value
+    end
+  end
+  
+  class RefreshImgSrc < Parser#:nodoc:
+    def self.process(data)
+      element('fbml_refreshImgSrc_response', data).text_value
+    end
+  end
+  
+  class SetCookie < Parser#:nodoc:
+    def self.process(data)
+      element('data_setCookie_response', data).text_value
+    end
+  end
+  
+  class GetCookies < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('data_getCookie_response', data), 'cookies')
+    end
+  end
+  
+  class EventsGet < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('events_get_response', data), 'event')
+    end
+  end
+  
+  class GroupGetMembers < Parser#:nodoc:
+    def self.process(data)
+      root = element('groups_getMembers_response', data)
+      result = ['members', 'admins', 'officers', 'not_replied'].map do |position|
+        array_of(root, position) {|element| element}.map do |element|
+          array_of_text_values(element, 'uid').map do |uid|
+            {:position => position}.merge(:uid => uid)
+          end
+        end
+      end.flatten      
+    end
+  end
+  
+  class EventMembersGet < Parser#:nodoc:
+    def self.process(data)
+      root = element('events_getMembers_response', data)
+      result = ['attending', 'declined', 'unsure', 'not_replied'].map do |rsvp_status|
+        array_of(root, rsvp_status) {|element| element}.map do |element|
+          array_of_text_values(element, 'uid').map do |uid|
+            {:rsvp_status => rsvp_status}.merge(:uid => uid)
+          end
+        end
+      end.flatten
+    end
+  end
+  
+  class GroupsGet < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('groups_get_response', data), 'group')
+    end
+  end
+  
+  class AreFriends < Parser#:nodoc:
+    def self.process(data)
+      array_of_hashes(element('friends_areFriends_response', data), 'friend_info').inject({}) do |memo, hash|
+        memo[[Integer(hash['uid1']), Integer(hash['uid2'])].sort] = are_friends?(hash['are_friends'])
+        memo
+      end
+    end
+
+  private
+    def self.are_friends?(raw_value)
+      if raw_value == '1'
+        true
+      elsif raw_value == '0'
+        false
+      else
+        nil
+      end
+    end
+  end
+  
+  class SetStatus < Parser
+    def self.process(data)
+      element('users_setStatus_response',data).text_value == '1'
+    end
+  end
+  
+  class GetPreference < Parser#:nodoc:
+    def self.process(data)
+      element('data_getUserPreference_response', data).text_value
+    end
+  end
+  
+  class SetPreference < Parser#:nodoc:
+    def self.process(data)
+      element('data_setUserPreference_response', data).text_value
+    end
+  end
+    
+  class UserHasPermission < Parser
+    def self.process(data)
+      element('users_hasAppPermission_response', data).text_value
+    end
+  end  
+
+  class SmsSend < Parser#:nodoc:
+    def self.process(data)
+      element('sms_send_response', data).text_value == '0'
+    end
+  end
+  
+  class SmsCanSend < Parser#:nodoc:
+    def self.process(data)
+      element('sms_canSend_response', data).text_value
+    end
+  end
+  
+  class StreamGet < Parser
+    def self.process(data)
+      res = hashinate(element('stream_get_response', data))
+      res.each do |key, val|
+        puts "#{key} => #{val.inspect}"
+        5.times { puts }
+      end
+    end
+  end
+
+  class Errors < Parser#:nodoc:
+    EXCEPTIONS = {
+      1 	=> Facebooker::Session::UnknownError,
+      2 	=> Facebooker::Session::ServiceUnavailable,
+      4 	=> Facebooker::Session::MaxRequestsDepleted,
+      5 	=> Facebooker::Session::HostNotAllowed,
+      100 => Facebooker::Session::MissingOrInvalidParameter,
+      101 => Facebooker::Session::InvalidAPIKey,
+      102 => Facebooker::Session::SessionExpired,
+      103 => Facebooker::Session::CallOutOfOrder,
+      104 => Facebooker::Session::IncorrectSignature,
+      120 => Facebooker::Session::InvalidAlbumId,
+      250 => Facebooker::Session::ExtendedPermissionRequired,
+      321 => Facebooker::Session::AlbumIsFull,
+      324 => Facebooker::Session::MissingOrInvalidImageFile,
+      325 => Facebooker::Session::TooManyUnapprovedPhotosPending,
+      330 => Facebooker::Session::TemplateDataMissingRequiredTokens,
+      340 => Facebooker::Session::TooManyUserCalls,
+      341 => Facebooker::Session::TooManyUserActionCalls,
+      342 => Facebooker::Session::InvalidFeedTitleLink,
+      343 => Facebooker::Session::InvalidFeedTitleLength,
+      344 => Facebooker::Session::InvalidFeedTitleName,
+      345 => Facebooker::Session::BlankFeedTitle,
+      346 => Facebooker::Session::FeedBodyLengthTooLong,
+      347 => Facebooker::Session::InvalidFeedPhotoSource,
+      348 => Facebooker::Session::InvalidFeedPhotoLink,      
+      330 => Facebooker::Session::FeedMarkupInvalid,
+      360 => Facebooker::Session::FeedTitleDataInvalid,
+      361 => Facebooker::Session::FeedTitleTemplateInvalid,
+      362 => Facebooker::Session::FeedBodyDataInvalid,
+      363 => Facebooker::Session::FeedBodyTemplateInvalid,
+      364 => Facebooker::Session::FeedPhotosNotRetrieved,
+      366 => Facebooker::Session::FeedTargetIdsInvalid,
+      601 => Facebooker::Session::FQLParseError,
+      602 => Facebooker::Session::FQLFieldDoesNotExist,
+      603 => Facebooker::Session::FQLTableDoesNotExist,
+      604 => Facebooker::Session::FQLStatementNotIndexable,
+      605 => Facebooker::Session::FQLFunctionDoesNotExist,
+      606 => Facebooker::Session::FQLWrongNumberArgumentsPassedToFunction,
+      807 => Facebooker::Session::TemplateBundleInvalid
+    }
+    def self.process(data)
+      response_element = element('error_response', data) rescue nil
+      if response_element
+        hash = hashinate(response_element)
+        exception = EXCEPTIONS[Integer(hash['error_code'])] || StandardError
+        raise exception, hash['error_msg']
+      end
+    end
+  end
+  
+  class Parser
+    PARSERS = {
+      'facebook.auth.revokeAuthorization' => RevokeAuthorization,
+      'facebook.auth.createToken' => CreateToken,
+      'facebook.auth.getSession' => GetSession,
+      'facebook.connect.registerUsers' => RegisterUsers,
+      'facebook.connect.unregisterUsers' => UnregisterUsers,
+      'facebook.connect.getUnconnectedFriendsCount' => GetUnconnectedFriendsCount,
+      'facebook.users.getInfo' => UserInfo,
+      'facebook.users.getStandardInfo' => UserStandardInfo,
+      'facebook.users.setStatus' => SetStatus,
+      'facebook.users.getLoggedInUser' => GetLoggedInUser,
+      'facebook.users.hasAppPermission' => UserHasPermission,
+      'facebook.pages.isAdmin' => PagesIsAdmin,
+      'facebook.pages.getInfo' => PagesGetInfo,
+      'facebook.pages.isFan' => PagesIsFan,      
+      'facebook.friends.get' => GetFriends,
+      'facebook.friends.getLists' => FriendListsGet,
+      'facebook.friends.areFriends' => AreFriends,
+      'facebook.friends.getAppUsers' => GetAppUsers,
+      'facebook.feed.publishStoryToUser' => PublishStoryToUser,
+      'facebook.feed.publishActionOfUser' => PublishActionOfUser,
+      'facebook.feed.publishTemplatizedAction' => PublishTemplatizedAction,
+      'facebook.feed.registerTemplateBundle' => RegisterTemplateBundle,
+      'facebook.feed.deactivateTemplateBundleByID' => DeactivateTemplateBundleByID,
+      'facebook.feed.getRegisteredTemplateBundles' => GetRegisteredTemplateBundles,
+      'facebook.feed.publishUserAction' => PublishUserAction,
+      'facebook.notifications.get' => NotificationsGet,
+      'facebook.notifications.send' => NotificationsSend,
+      'facebook.notifications.sendRequest' => SendRequest,
+      'facebook.profile.getFBML' => ProfileFBML,
+      'facebook.profile.setFBML' => ProfileFBMLSet,
+      'facebook.profile.getInfo' => ProfileInfo,
+      'facebook.profile.setInfo' => ProfileInfoSet,
+      'facebook.fbml.setRefHandle' => SetRefHandle,
+      'facebook.fbml.refreshRefUrl' => RefreshRefURL,
+      'facebook.fbml.refreshImgSrc' => RefreshImgSrc,
+      'facebook.data.setCookie' => SetCookie,
+      'facebook.data.getCookies' => GetCookies,
+      'facebook.admin.setAppProperties' => SetAppProperties,
+      'facebook.admin.getAppProperties' => GetAppProperties,
+      'facebook.admin.setRestrictionInfo' => SetRestrictionInfo,
+      'facebook.admin.getRestrictionInfo' => GetRestrictionInfo,
+      'facebook.admin.getAllocation' => GetAllocation,
+      'facebook.batch.run' => BatchRun,
+      'facebook.fql.query' => FqlQuery,
+      'facebook.fql.multiquery' => FqlMultiquery,
+      'facebook.photos.get' => GetPhotos,
+      'facebook.photos.getAlbums' => GetAlbums,
+      'facebook.photos.createAlbum' => CreateAlbum,
+      'facebook.photos.getTags' => GetTags,
+      'facebook.photos.addTag' => AddTags,
+      'facebook.photos.upload' => UploadPhoto,
+      'facebook.events.get' => EventsGet,
+      'facebook.groups.get' => GroupsGet,
+      'facebook.events.getMembers' => EventMembersGet,
+      'facebook.groups.getMembers' => GroupGetMembers,
+      'facebook.notifications.sendEmail' => NotificationsSendEmail,
+      'facebook.data.getUserPreference' => GetPreference,
+      'facebook.data.setUserPreference' => SetPreference,
+      'facebook.video.upload' => UploadVideo,
+      'facebook.sms.send' => SmsSend,
+      'facebook.sms.canSend' => SmsCanSend,
+      # $Author$ added code for stream fetching
+      'facebook.stream.get' => StreamGet
+    }
+  end
+end

data/lib/facebooker/rails/backwards_compatible_param_checks.rb

@@ -0,0 +1,31 @@
+module Facebooker::Rails::BackwardsCompatibleParamChecks
+
+    def one_or_true( value )
+      case value
+        when String then
+          value == "1"
+        when Numeric then
+          value.to_f == 1.0
+        when TrueClass then
+          true
+        else
+          false
+      end
+    end
+
+    def zero_or_false( value )
+      case value
+        when String then
+          value == "0"
+        when Numeric then
+          value.to_f == 0.0
+        when FalseClass then
+          true
+        when NilClass then
+          true
+        else
+          false
+      end
+    end
+
+end