tjplurker 1.2 → 1.3

data/lib/tjplurker/core.rb

@@ -34,6 +34,7 @@ module TJP
             })
         end
         
+        
         # return:: authorize URL
         def get_authorize_url
             @request_token = @consumer.get_request_token
@@ -72,62 +73,22 @@ module TJP
             return json
         end
         
-
-        #:section: Offical API wrapping 
-        
+        # :section: Users
         
-        # qualifier:: The Plurk's qualifier, must be in English. Can be following:
-        #              loves, likes, shares, gives, hates, wants, has, will, asks, wishes, was,
-        #              feels, thinks, says, is, :, freestyle, hopes, needs, wonders
-        # limited_to:: Limit the plurk only to some users (also known as private plurking).
-        #              Should can be a JSON list of friend ids in String formatting or Ruby Array, e.g.
-        #              \[3,4,66,34] or "\[3,4,66,34]" will only be plurked to these user ids.
-        #              If it's [0] then the Plurk is privatley posted to the poster's friends.
-        # no_comments:: If set to 1 or "1", then responses are disabled for this plurk.
-        #               If set to 2 or "2", then only friends can respond to this plurk.
-        # lang:: The plurk's language. Can be following:
-        #         'en': 'English', 'pt_BR': 'Português', 'cn': '中文 (中国)', 'ca': 'Català', 'el': 'Ελληνικά'
-        #         'dk': 'Dansk', 'de': 'Deutsch', 'es': 'Español', 'sv': 'Svenska', 'nb': 'Norsk bokmål'
-        #         'hi': 'Hindi', 'ro': 'Română', 'hr': 'Hrvatski', 'fr': 'Français', 'ru': 'Pусский'
-        #         'it': 'Italiano', 'ja': '日本語', 'he': 'עברית', 'hu': 'Magyar', 'ne': 'Nederlands', 'th': 'ไทย'
-        #         'ta_fp': 'Filipino', 'in': 'Bahasa Indonesia', 'pl': 'Polski', 'ar': 'العربية', 'fi': 'Finnish'
-        #         'tr_ch': '中文 (繁體中文)', 'tr': 'Türkçe', 'ga': 'Gaeilge', 'sk': 'Slovenský'
-        #         'uk': 'українська', 'fa': 'فارسی
-        def plurk_add content, qualifier=':', limited_to=nil, no_comments=nil, lang='tr_ch'
-            method = "/APP/Timeline/plurkAdd"
-            limited_to = limited_to.to_s if limited_to.is_a? Array
-            attr = {:content=>content, :qualifier=>qualifier, :limited_to=>limited_to, :no_comments=>no_comments, :lang=>lang}
-            api(method, attr)
-        end
-        
-        # Adds a responses to +plurk_id+. Language is inherited from the plurk.
-        def response_add plurk_id, content, qualifier=':'
-            method = "/APP/Responses/responseAdd"
-            attr = {:plurk_id=>plurk_id, :content=>content, :qualifier=>qualifier}
-            api(method, attr)
-        end
-        
-        # Accept all friendship requests as friends.
-        def add_all_as_friends
-            method = "/APP/Alerts/addAllAsFriends"
+        # Returns info about current user's karma, including current karma,
+        # karma growth, karma graph and the latest reason why the karma has dropped.
+        def get_karma_stats
+            method = "/APP/Users/getKarmaStats"
             api(method)
         end
         
-        # Become fan of +fan_id+. To stop being a fan of someone, use set_following
-        def become_fan fan_id
-            method = "/APP/FriendsFans/becomeFan"
-            attr = {:fan_id=>fan_id}
-            api(method, attr)
-        end
+        # :section: Profile
         
-        # Returns user_id's friend list in chucks of 100 friends at a time.
-        # limit:: The max number of friends to be returned.
-        # offset:: Can be Numeric or String, e.g. 10, "20", 30, "40" etc.
-        # return:: An Array
-        def get_friends_by_offset user_id, limit=100, offset=0
-            method = "/APP/FriendsFans/getFriendsByOffset"
-            attr = {:user_id=>user_id, :offset=>offset, :limit=>limit}
-            api(method, attr)
+        # Returns data that's private for the current user.
+        # This can be used to construct a profile and render a timeline of the latest plurks.
+        def get_own_profile
+            method = "/APP/Profile/getOwnProfile"
+            api(method)
         end
         
         # Fetches public information such as a user's public plurks and basic information.
@@ -138,16 +99,7 @@ module TJP
             api(method, attr)
         end
         
-        # Get plurks from user's timeline
-        # Warning:: It has bugs in offecial Plurk API.
-        # offset:: Return plurks newer than offset, formatted as 2009-6-20T21:55:34.
-        # limit:: The max number of plurks to be returned (default: 20)
-        # filter:: Can be only_user, only_responded, only_private or only_favorite
-        def get_plurks offset=nil, limit=nil, filter=nil
-            method = "/APP/Timeline/getPlurks"
-            attr = {:limit=>limit, :offset=>offset}
-            api(method, attr)
-        end
+        # :section: Real Time Notifications
         
         # Get instant notifications when there are new plurks and responses on a user's timeline.
         # Generally you don't need call this because comet_channel will automatically do that for you.
@@ -198,12 +150,457 @@ module TJP
             json
         end
         
-        # :section: TJPlurker provided
+        # :section: Polling
+        
+        # You should use this call to find out if there any new plurks posted to the user's timeline.
+        # It's much more efficient than doing it with timeline_get_plurks, so please use it :)
+        # offset:: Return plurks newer than offset, formatted as 2009-6-20T21:55:34 in String or in Time.
+        # limit:: The max number of plurks to be returned (default: 20)
+        def get_plurks offset, limit=nil
+            method = "/APP/Polling/getPlurks"
+            offset = offset.utc.strftime("%Y-%m-%dT%H:%M:%S") if offset.is_a? Time
+            attr = {:offset=>offset, :limit=>limit}
+            api(method, attr)
+        end
+        
+        # Use this call to find out if there are unread plurks on a user's timeline.
+        def get_unread_count
+            method = "/APP/Polling/getUnreadCount"
+            api(method)
+        end
+        
+        # :section: Timeline
+        
+        # Get one plurk from user's timeline
+        # plurk_id:: Can be Integer or String
+        def get_plurk plurk_id
+            method = "/APP/Timeline/getPlurk"
+            attr = {:plurk_id=>plurk_id}
+            api(method, attr)
+        end
+        
+        # Get plurks from user's timeline
+        # offset:: Return plurks older than offset, formatted as 2009-6-20T21:55:34 in String or in Time.
+        # limit:: The max number of plurks to be returned (default: 20)
+        # filter:: Can be only_user, only_responded, only_private or only_favorite
+        def timeline_get_plurks offset=nil, limit=nil, filter=nil
+            method = "/APP/Timeline/getPlurks"
+            offset = offset.utc.strftime("%Y-%m-%dT%H:%M:%S") if offset.is_a? Time
+            attr = {:offset=>offset, :limit=>limit, :filter=>filter}
+            api(method, attr)
+        end
+        
+        # Get unread plurks from user's timeline
+        # offset:: Return plurks newer than offset, formatted as 2009-6-20T21:55:34 in String or in Time.
+        # limit:: The max number of plurks to be returned (default: 20)
+        # filter:: Can be only_user, only_responded, only_private or only_favorite
+        def get_unread_plurks offset=nil, limit=nil, filter=nil
+            method = "/APP/Timeline/getUnreadPlurks"
+            offset = offset.utc.strftime("%Y-%m-%dT%H:%M:%S") if offset.is_a? Time
+            attr = {:offset=>offset, :limit=>limit, :filter=>filter}
+            api(method, attr)
+        end
+        
+        # Get public plurks from user's timeline
+        # user_id:: The user_id of the public plurks owner to get. Can be integer (like 34) or nick name (like amix).
+        # offset:: Return plurks newer than offset, formatted as 2009-6-20T21:55:34 in String or in Time.
+        # limit:: The max number of plurks to be returned (default: 20)
+        # filter:: Can be only_user, only_responded, only_private or only_favorite
+        def get_public_plurks user_id, offset=nil, limit=nil, filter=nil
+            method = "/APP/Timeline/getPublicPlurks"
+            offset = offset.utc.strftime("%Y-%m-%dT%H:%M:%S") if offset.is_a? Time
+            attr = {:user_id=>user_id, :offset=>offset, :limit=>limit, :filter=>filter}
+            api(method, attr)
+        end
+        
+        # qualifier:: The Plurk's qualifier, must be in English. Can be following:
+        #              loves, likes, shares, gives, hates, wants, has, will, asks, wishes, was,
+        #              feels, thinks, says, is, :, freestyle, hopes, needs, wonders
+        # limited_to:: Limit the plurk only to some users (also known as private plurking).
+        #              Should can be a JSON list of friend ids in String formatting or Ruby Array, e.g.
+        #              \[3,4,66,34] or "\[3,4,66,34]" will only be plurked to these user ids.
+        #              If it's [0] then the Plurk is privatley posted to the poster's friends.
+        # no_comments:: If set to 1 or "1", then responses are disabled for this plurk.
+        #               If set to 2 or "2", then only friends can respond to this plurk.
+        # lang:: The plurk's language. Can be following:
+        #         'en': 'English', 'pt_BR': 'Português', 'cn': '中文 (中国)', 'ca': 'Català', 'el': 'Ελληνικά'
+        #         'dk': 'Dansk', 'de': 'Deutsch', 'es': 'Español', 'sv': 'Svenska', 'nb': 'Norsk bokmål'
+        #         'hi': 'Hindi', 'ro': 'Română', 'hr': 'Hrvatski', 'fr': 'Français', 'ru': 'Pусский'
+        #         'it': 'Italiano', 'ja': '日本語', 'he': 'עברית', 'hu': 'Magyar', 'ne': 'Nederlands', 'th': 'ไทย'
+        #         'ta_fp': 'Filipino', 'in': 'Bahasa Indonesia', 'pl': 'Polski', 'ar': 'العربية', 'fi': 'Finnish'
+        #         'tr_ch': '中文 (繁體中文)', 'tr': 'Türkçe', 'ga': 'Gaeilge', 'sk': 'Slovenský'
+        #         'uk': 'українська', 'fa': 'فارسی
+        def plurk_add content, qualifier=':', limited_to=nil, no_comments=nil, lang='tr_ch'
+            method = "/APP/Timeline/plurkAdd"
+            limited_to = limited_to.to_s if limited_to.is_a? Array
+            attr = {:content=>content, :qualifier=>qualifier, :limited_to=>limited_to, :no_comments=>no_comments, :lang=>lang}
+            api(method, attr)
+        end
+        
+        # plurk_id:: The id of the plurk.
+        def plurk_delete plurk_id
+            method = "/APP/Timeline/plurkDelete"
+            attr = {:plurk_id=>plurk_id}
+            api(method, attr)
+        end
+        
+        # plurk_id:: The id of the plurk.
+        # content:: The content of plurk.
+        def plurk_edit plurk_id, content
+            method = "/APP/Timeline/plurkEdit"
+            attr = {:plurk_id=>plurk_id, :content=>content}
+            api(method, attr)
+        end
+        
+        # ids:: The plurk ids, formated as JSON String or Ruby Array, e.g. "[342,23242,2323]" or [342,23242,2323]
+        def mute_plurks ids
+            method = "/APP/Timeline/mutePlurks"
+            ids = ids.to_s if ids.is_a? Array
+            attr = {:ids=>ids}
+            api(method, attr)
+        end
+        
+        # ids:: The plurk ids, formated as JSON String or Ruby Array, e.g. "[342,23242,2323]" or [342,23242,2323]
+        def unmute_plurks
+            method = "/APP/Timeline/unmutePlurks"
+            ids = ids.to_s if ids.is_a? Array
+            attr = {:ids=>ids}
+            api(method, attr)
+        end
+        
+        # ids:: The plurk ids, formated as JSON String or Ruby Array, e.g. "[342,23242,2323]" or [342,23242,2323]
+        def favorite_plurks ids
+            method = "/APP/Timeline/favoritePlurks"
+            ids = ids.to_s if ids.is_a? Array
+            attr = {:ids=>ids}
+            api(method, attr)
+        end
+        
+        # ids:: The plurk ids, formated as JSON String or Ruby Array, e.g. "[342,23242,2323]" or [342,23242,2323]
+        def unfavorite_plurks ids
+            method = "/APP/Timeline/unfavoritePlurks"
+            ids = ids.to_s if ids.is_a? Array
+            attr = {:ids=>ids}
+            api(method, attr)
+        end
+        
+        # ids:: The plurk ids, formated as JSON String or Ruby Array, e.g. "[342,23242,2323]" or [342,23242,2323]
+        # note_position:: If true responses_seen of the plurks will be updated as well (to match response_count).
+        def mark_as_read ids, note_position=nil
+            method = "/APP/Timeline/markAsRead"
+            ids = ids.to_s if ids.is_a? Array
+            attr = {:ids=>ids, :note_position=>note_position}
+            api(method, attr)
+        end
+        
+        # :section: Response
+        
+        # Fetches responses for plurk with plurk_id and some basic info about the users.
+        # plurk_id:: The plurk that the responses belong to.
+        # from_response:: Only fetch responses from an offset - could be 5, 10 or 15 (default: 0)
+        def response_get plurk_id, from_response=nil
+            method = "/APP/Responses/get"
+            attr = {:plurk_id=>plurk_id, :from_response=>from_response}
+            api(method, attr)
+        end
+        
+        # Adds a responses to plurk_id. Language is inherited from the plurk.
+        # plurk_id:: The plurk that the responses belong to.
+        # content:: The response's text.
+        # qualifier:: The Plurk's qualifier, must be in English. Refers to plurk_add.
+        def response_add plurk_id, content, qualifier=':'
+            method = "/APP/Responses/responseAdd"
+            attr = {:plurk_id=>plurk_id, :content=>content, :qualifier=>qualifier}
+            api(method, attr)
+        end
+        
+        #Deletes a response. A user can delete own responses or responses that are posted to own plurks.
+        # response_id:: The id of the response to delete.
+        # plurk_id:: The plurk that the response belongs to.
+        def response_delete response_id, plurk_id
+            method = "/APP/Responses/responseDelete"
+            attr = {:response_id=>response_id, :plurk_id=>plurk_id}
+            api(method, attr)
+        end
+        
+        # :section: Friends and Fans
+        
+        # Returns user_id's friend list in chucks of 100 friends at a time.
+        # However, We suggest you use get_friends instead of get_friends_by_offset
+        # limit:: The max number of friends to be returned.
+        # offset:: Can be Numeric or String, e.g. 10, "20", 30, "40" etc.
+        # return:: An Array
+        def get_friends_by_offset user_id, limit=100, offset=0
+            method = "/APP/FriendsFans/getFriendsByOffset"
+            attr = {:user_id=>user_id, :offset=>offset, :limit=>limit}
+            api(method, attr)
+        end
+        
+        # Returns user_id's fans list in chucks of 100 fans at a time.
+        # However, We suggest you use get_fans instead of get_fans_by_offset
+        # limit:: The max number of friends to be returned.
+        # offset:: Can be Numeric or String, e.g. 10, "20", 30, "40" etc.
+        # return:: An Array
+        def get_fans_by_offset user_id, limit=100, offset=0
+            method = "/APP/FriendsFans/getFansByOffset"
+            attr = {:user_id=>user_id, :offset=>offset, :limit=>limit}
+            api(method, attr)
+        end
+        
+        # Returns users that the current logged in user follows as fan - in chucks of 100 fans at a time.
+        # However, We suggest you use get_following instead of get_following_by_offset
+        # limit:: The max number of friends to be returned.
+        # offset:: Can be Numeric or String, e.g. 10, "20", 30, "40" etc.
+        # return:: An Array
+        def get_following_by_offset limit=100, offset=0
+            method = "/APP/FriendsFans/getFollowingByOffset"
+            attr = {:offset=>offset, :limit=>limit}
+            api(method, attr)
+        end
+        
+        # Create a friend request to friend_id. User with friend_id has to accept a friendship.
+        # friend_id:: The ID of the user you want to befriend.
+        def become_friend friend_id
+            method = "/APP/FriendsFans/becomeFriend"
+            attr = {:friend_id=>friend_id}
+            api(method, attr)
+        end
+        
+        # Remove friend with ID friend_id. friend_id won't be notified.
+        # friend_id:: The ID of the user you want to remove
+        def remove_as_friend friend_id
+            method = "/APP/FriendsFans/removeAsFriend"
+            attr = {:friend_id=>friend_id}
+            api(method, attr)
+        end
+        
+        # Become fan of fan_id. To stop being a fan of someone, use set_following
+        # fan_id:: The ID of the user you want to become fan of
+        def become_fan fan_id
+            method = "/APP/FriendsFans/becomeFan"
+            attr = {:fan_id=>fan_id}
+            api(method, attr)
+        end
+        
+        # Update following of user_id. A user can befriend someone, but can unfollow them.
+        # This request is also used to stop following someone as a fan.
+        # user_id:: The ID of the user you want to follow/unfollow
+        # follow:: Normally, true if the user should be followed, and false if the user should be unfollowed.
+        #          Actually, toggle the follwing state no matter you give true or false
+        def set_following user_id, follow=true
+            method = "/APP/FriendsFans/setFollowing"
+            attr = {:user_id=>user_id, :follow=>follow}
+            api(method, attr)
+        end
+        
+        # Returns a JSON object of the logged in users friends (nick name and full name).
+        # This information can be used to construct auto-completion for private plurking.
+        # Notice that a friend list can be big, depending on how many friends a user has,
+        # so this list should be lazy-loaded in your application.
+        def get_completion
+            method = "/APP/FriendsFans/getCompletion"
+            api(method)
+        end
+        
+        # :section: Alerts
+        # ===General data structures
+        # The data returned by getActive and getHistory can be of following nature:
+        # Friendship request: 
+        #  {"type": "friendship_request", "from_user": {"nick_name": ...}, "posted": ...} 
+        #
+        # Friendship pending: 
+        #  {"type": "friendship_pending", "to_user": {"nick_name": ...}, "posted": ...} 
+        #
+        # New fan notification: (does not require actions from the user) 
+        #  {"type": "new_fan", "new_fan": {"nick_name": ...}, "posted": ...} 
+        #
+        # Friendship accepted notification: (does not require actions from the user) 
+        #  {"type": "friendship_accepted", "friend_info": {"nick_name": ...}, "posted": ...} 
+        #
+        # New friend notification: (does not require actions from the user) 
+        #  {"type": "new_friend", "new_friend": {"nick_name": ...}, "posted": ...} 
+        
+        # Return a JSON list of current active alerts.
+        def get_active
+            method = "/APP/Alerts/getActive"
+            api(method)
+        end
+        
+        # Return a JSON list of past 30 alerts.
+        def get_history
+            method = "/APP/Alerts/getHistory"
+            api(method)
+        end
+        
+        # user_id:: The user_id that has asked for friendship.
+        def add_as_fan user_id
+            method = "/APP/Alerts/addAsFan"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # Accept all friendship requests as fans.
+        def add_all_as_fan
+            method = "/APP/Alerts/addAllAsFan"
+            api(method)
+        end
+        
+        # Accept all friendship requests as friends.
+        def add_all_as_friends
+            method = "/APP/Alerts/addAllAsFriends"
+            api(method)
+        end
+        
+        # Accept user_id as friend.
+        # user_id:: The user_id that has asked for friendship.
+        def add_as_friend user_id
+            method = "/APP/Alerts/addAsFriend"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # Deny friendship to user_id.
+        # user_id:: The user_id that has asked for friendship.
+        def deny_friendship user_id
+            method = "/APP/Alerts/denyFriendship"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # Remove notification to user with id user_id.
+        # user_id:: The user_id that the current user has requested friendship for.
+        def remove_notification user_id
+            method = "/APP/Alerts/removeNotification"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # :section: Search
+        
+        # Returns the latest 20 plurks on a search term.
+        # query:: The query after Plurks.
+        # offset:: A plurk_id of the oldest Plurk in the last search result.
+        def plurk_search query, offset=nil
+            method = "/APP/PlurkSearch/search"
+            attr = {:query=>query, :offset=>offset}
+            api(method, attr)
+        end
+        
+        # Returns 10 users that match query, users are sorted by karma.
+        # query:: The query after users.
+        # offset:: Page offset, like 10, 20, 30 etc.
+        def user_search query, offset=0
+            method = "/APP/UserSearch/search"
+            attr = {:query=>query, :offset=>offset}
+            api(method, attr)
+        end
+        
+        # :section: Emoticons
+        
+        # Emoticons are a big part of Plurk since they make it easy to express feelings.
+        # Check out current Plurk emoticons. This call returns a JSON object that looks like:
+        #  {"karma": {"0": [[":-))", "http:\/\/statics.plurk.com\/XXX.gif"], ...], ...},
+        #  "recuited": {"10": [["(bigeyes)", "http:\/\/statics.plurk.com\/XXX.gif"], ...], ...} }
+        # emoticons["karma"][25] denotes that the user has to have karma over 25 to use these emoticons.
+        # emoticons["recuited"][10] means that the user has to have user.recuited >= 10 to use these emoticons.
+        # It's important to check for these things on the client as well,
+        # since the emoticon levels are checked in the models.
+        def emoticons_get
+            method = "/APP/Emoticons/get"
+            api(method)
+        end
+        
+        # :section: Blocks
+        
+        # offset:: What page should be shown, e.g. 0, 10, 20.
+        def blocks_get offset=0
+            method = "/APP/Blocks/get"
+            attr = {:offset=>offset}
+            api(method, attr)
+        end
+        
+        # user_id:: The id of the user that should be blocked.
+        def block user_id
+            method = "/APP/Blocks/block"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # user_id: The id of the user that should be unblocked.
+        def unblock user_id
+            method = "/APP/Blocks/unblock"
+            attr = {:user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # :section: Cliques
+        
+        def get_cliques
+            method = "/APP/Cliques/getCliques"
+            api(method)
+        end
+        
+        # clique_name:: The name of the new clique
+        def get_clique clique_name
+            method = "/APP/Cliques/getClique"
+            attr = {:clique_name=>clique_name}
+            api(method, attr)
+        end
+        
+        # clique_name:: The name of the new clique
+        def create_clique clique_name
+            method = "/APP/Cliques/createClique"
+            attr = {:clique_name=>clique_name}
+            api(method, attr)
+        end
+        
+        # clique_name:: The name of the clique to rename
+        # new_name:: The name of the new clique
+        def rename_clique clique_name, new_name
+            method = "/APP/Cliques/renameClique"
+            attr = {:clique_name=>clique_name, :new_name=>new_name}
+            api(method, attr)
+        end
+        
+        # clique_name:: The name of the clique
+        # user_id:: The user to add to the clique
+        def cliques_add clique_name, user_id
+            method = "/APP/Cliques/add"
+            attr = {:clique_name=>clique_name, :user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # clique_name:: The name of the clique
+        # user_id:: The user to remove from the clique
+        def cliques_remove clique_name, user_id
+            method = "/APP/Cliques/remove"
+            attr = {:clique_name=>clique_name, :user_id=>user_id}
+            api(method, attr)
+        end
+        
+        # :section: PlurkTop
+        
+        def get_collections
+            method = "/APP/PlurkTop/getCollections"
+            api(method)
+        end
+        
+        # collection_name:: only get plurks in specified collection
+        # offset:: offset of Plurks in PlurkTop, should be an float, e.g. 0.99.
+        # limit:: number of plurks returned (default: 30)
+        # sorting:: the way to sort plurks in PlurkTop, can be "hot" for sorting by popularity or "new" for posted time.
+        def plurk_top_get_plurks collection_name, limit=nil, offset=nil, sorting=nil
+            method = "/APP/PlurkTop/getPlurks"
+            attr = {:collection_name=>collection_name, :limit=>limit, :offset=>offset, :sorting=>sorting}
+            api(method, attr)
+        end
+        
+        # :section: TJPlurker Provided
         # Those methos were all provided by TJPlukrer instead of Plurk
         
         # Improved from get_friends_by_offset for getting all friends from a user
         # return:: An Array
-        def get_friends user_id, max=nil
+        def get_friends user_id, at_least=nil
             list = []
             offset = 0;
             loop{
@@ -211,7 +608,39 @@ module TJP
                 size = set.size
                 break if size == 0
                 list |= set
-                break if max && list.size>max
+                break if at_least && list.size>=at_least
+                offset += size
+            }
+            return list
+        end
+        
+        # Improved from get_fans_by_offset for getting all fans from a user
+        # return:: An Array
+        def get_fans user_id, at_least=nil
+            list = []
+            offset = 0;
+            loop{
+                set = get_fans_by_offset(user_id, 100, offset)
+                size = set.size
+                break if size == 0
+                list |= set
+                break if at_least && list.size>=at_least
+                offset += size
+            }
+            return list
+        end
+        
+        # Improved from get_following_by_offset for getting all fans from a user
+        # return:: An Array
+        def get_following at_least=nil
+            list = []
+            offset = 0;
+            loop{
+                set = get_following_by_offset(100, offset)
+                size = set.size
+                break if size == 0
+                list |= set
+                break if at_least && list.size>=at_least
                 offset += size
             }
             return list
@@ -287,10 +716,11 @@ module TJP
     end
     
     module_function
-    # Convert user name into user_id, e.g. Given "tonytonyjan", return "5874158"
+    # Convert user name into user_id, e.g. Given "tonytonyjan", return 5874158 in Integer
+    # return:: user id in Integer
     def get_uid user_name
         open("http://www.plurk.com/#{user_name}").read =~ /"user_id": (\d*)/
         raise "User \"#{user_name}\" not found." unless $1
-        return $1
+        return $1.to_i
     end
 end

data/lib/tjplurker/legacy.rb

@@ -41,10 +41,10 @@ module Legacy
         # Plurk user ID.
         attr_reader :user
 
-    =begin
-    [auto_login] 是否在建構時自動登入
-                 If +auto_login+ sets +true+, it will autologin while constructing.
-    =end
+=begin
+[auto_login] 是否在建構時自動登入
+             If +auto_login+ sets +true+, it will autologin while constructing.
+=end
         def initialize api_key, user, passwd, auto_login=true
             @user, @passwd, @api_key = user, passwd, api_key
             @cookie = nil
@@ -54,23 +54,23 @@ module Legacy
         end
 
 
-    =begin
-    :section: Offical API wrapping
-    對Plurk官方API做包裹
+=begin
+:section: Offical API wrapping
+對Plurk官方API做包裹
 
-    Plurk API wrapping 
-    =end    
+Plurk API wrapping
+=end
 
-    =begin  
-    登入
-    [no_data] 是否將登入成功後的訊息簡化成：
-               {"success_text": "ok"}
-              否則將回傳使用者的詳細資料
-              
-              If no_data sets true, the successful login message was simplified as follow:
-               {"success_text": "ok"}
-              Otherwise, more details of user's profile were retured.
-    =end
+=begin  
+登入
+[no_data] 是否將登入成功後的訊息簡化成：
+           {"success_text": "ok"}
+          否則將回傳使用者的詳細資料
+          
+          If no_data sets true, the successful login message was simplified as follow:
+           {"success_text": "ok"}
+          Otherwise, more details of user's profile were retured.
+=end
         def login no_data=true
             method = "/API/Users/login"
             attr = {:username=>@user, :password=>@passwd, :api_key=>@api_key}
@@ -78,91 +78,91 @@ module Legacy
             api(method, attr)
         end
 
-    =begin
-    發噗
+=begin
+發噗
 
-    範例：
-        require 'tjplurker'
-        tjp = TJPlurker.new("API Key", "帳號", "密碼")
-        tjp.plurk_add("Hello TJPlurker")
-    =end
+範例：
+    require 'tjplurker'
+    tjp = TJPlurker.new("API Key", "帳號", "密碼")
+    tjp.plurk_add("Hello TJPlurker")
+=end
         def plurk_add content, qualifier=':', limited_to=nil, no_comments=nil, lang='tr_ch'
             method = "/API/Timeline/plurkAdd"
             attr = {:api_key=>@api_key, :content=>content, :qualifier=>qualifier,:limited_to=>limited_to, :no_comments=>no_comments, :lang=>lang}
             api(method, attr)
         end
 
-    =begin
-    回噗
-    [qualifier] 可以是如下的字串：
-                
-                Can be the following string:
-                 loves, likes, shares, gives, hates, wants, has, will,
-                 asks, wishes, was, feels, thinks, says, is, :, freestyle, hopes, needs, wonders
-    範例：
-        require 'tjplurker'
-        tjp = TJPlurker.new("API Key", "帳號", "密碼")
-        json_obj = tjp.plurk_add("Hello TJPlurker")
-        tjp.response_add(json_obj["plurk_id"], "This is a reply.", "says")
-    =end
+=begin
+回噗
+[qualifier] 可以是如下的字串：
+            
+            Can be the following string:
+             loves, likes, shares, gives, hates, wants, has, will,
+             asks, wishes, was, feels, thinks, says, is, :, freestyle, hopes, needs, wonders
+範例：
+    require 'tjplurker'
+    tjp = TJPlurker.new("API Key", "帳號", "密碼")
+    json_obj = tjp.plurk_add("Hello TJPlurker")
+    tjp.response_add(json_obj["plurk_id"], "This is a reply.", "says")
+=end
         def response_add plurk_id, content, qualifier=':'
             method = "/API/Responses/responseAdd"
             attr = {:api_key=>@api_key, :plurk_id=>plurk_id, :content=>content, :qualifier=>qualifier}
             api(method, attr)
         end
 
-    =begin
-    成為粉絲
-    [fan_id] 你想追蹤的人的ID
-             
-             The ID of the user you want to become fan of
-    =end
+=begin
+成為粉絲
+[fan_id] 你想追蹤的人的ID
+         
+         The ID of the user you want to become fan of
+=end
         def become_fan fan_id
             method = "/API/FriendsFans/becomeFan"
             attr = {:api_key=>@api_key, :fan_id=>fan_id}
             api(method, attr)
         end
 
-    =begin
-    接受所有的好友邀請
+=begin
+接受所有的好友邀請
 
-    Accept all friendship requests as friends.
-    Successful return:
-     {"success_text": "ok"}
-    =end
+Accept all friendship requests as friends.
+Successful return:
+ {"success_text": "ok"}
+=end
         def add_all_as_friends
             method = "/API/Alerts/addAllAsFriends"
             attr = {:api_key=>@api_key}
             api(method, attr)
         end
 
-    =begin
-    取得使用者的好友名單
+=begin
+取得使用者的好友名單
 
-    Returns user_id's friend list
-    [limit] The max number of friends to be returned (default 10).
-    [Successful return] 好友名單陣列
+Returns user_id's friend list
+[limit] The max number of friends to be returned (default 10).
+[Successful return] 好友名單陣列
 
-                        Returns a list of JSON objects users, e.g.
-                         [{"id": 3, "nick_name": "alvin", ...}, ...]
-    [warnning] +limit+的最大值被官方設定為100，這個方法沒有很好用，建議你用tjp_get_friends取代
-               This maximum of +limit+ is set 100 officially, this method is not that useful.
-               We suggest you use get_friend_list instead of get_friends_by_offset.
-    =end
+                    Returns a list of JSON objects users, e.g.
+                     [{"id": 3, "nick_name": "alvin", ...}, ...]
+[warnning] +limit+的最大值被官方設定為100，這個方法沒有很好用，建議你用tjp_get_friends取代
+           This maximum of +limit+ is set 100 officially, this method is not that useful.
+           We suggest you use get_friend_list instead of get_friends_by_offset.
+=end
         def get_friends_by_offset user_id, limit=100, offset='0'
             method = "/API/FriendsFans/getFriendsByOffset"
             attr = {:api_key=>@api_key, :user_id=>user_id, :offset=>offset, :limit=>limit}
             api(method, attr)
         end
 
-    =begin
-    Fetches public information such as a user's public plurks and basic information.
-    Fetches also if the current user is following the user, are friends with or is a fan.
-    [Successful return] Returns a JSON object with a lot of information
-                        that can be used to construct a user's public profile and timeline.
-    [Error returns] HTTP 400 BAD REQUEST with {"error_text": "Invalid user_id"} as body
-                    HTTP 400 BAD REQUEST with {"error_text": "User not found"} as body
-    =end
+=begin
+Fetches public information such as a user's public plurks and basic information.
+Fetches also if the current user is following the user, are friends with or is a fan.
+[Successful return] Returns a JSON object with a lot of information
+                    that can be used to construct a user's public profile and timeline.
+[Error returns] HTTP 400 BAD REQUEST with {"error_text": "Invalid user_id"} as body
+                HTTP 400 BAD REQUEST with {"error_text": "User not found"} as body
+=end
         def get_public_profile user_id
             method = "/API/Profile/getPublicProfile"
             attr = {:api_key=>@api_key, :user_id=>user_id}
@@ -213,29 +213,29 @@ module Legacy
             json
         end
 
-    =begin
-    :section: TJPlurker provided
-    由TJPlurker提供的工具，非官方有的方法
+=begin
+:section: TJPlurker provided
+由TJPlurker提供的工具，非官方有的方法
 
-    Those methos were all provided by TJPlukrer instead of plurk
-    =end
+Those methos were all provided by TJPlukrer instead of plurk
+=end
 
-    =begin
-    這個方法游TJPlurker提供的非官方功能，改良自get_friends_by_offset，用於取得使用者所有的好友
+=begin
+這個方法游TJPlurker提供的非官方功能，改良自get_friends_by_offset，用於取得使用者所有的好友
 
-    This method is provided by TJPlurker. Improved from get_friends_by_offset for getting all friends of a user
-    [max] 取得多少好友，nil則無限制
-          
-          The maximum number of your request. Set +nil+ for unlimited.
-    [return] 陣列
-             
-             An array contains friends
-    範例：
-        require 'tjplurker'
-        tjp = TJPlurker.new("API Key", "帳號", "密碼")
-        friend_list = tjp.tjp_get_friends("5874158")
-        friend_list.each{|friend| puts friend["uid"]}
-    =end
+This method is provided by TJPlurker. Improved from get_friends_by_offset for getting all friends of a user
+[max] 取得多少好友，nil則無限制
+      
+      The maximum number of your request. Set +nil+ for unlimited.
+[return] 陣列
+         
+         An array contains friends
+範例：
+    require 'tjplurker'
+    tjp = TJPlurker.new("API Key", "帳號", "密碼")
+    friend_list = tjp.tjp_get_friends("5874158")
+    friend_list.each{|friend| puts friend["uid"]}
+=end
         def tjp_get_friends user_id, max=nil
             list = []
             offset = 0;
@@ -250,10 +250,10 @@ module Legacy
             return list
         end
         
-    =begin
-    用於追蹤大量使用者的河道
-    [level] 深度，如等於1會追蹤使用者的所有好友，等於2則會追蹤使用者所有的好友以及好友的好友
-    =end
+=begin
+用於追蹤大量使用者的河道
+[level] 深度，如等於1會追蹤使用者的所有好友，等於2則會追蹤使用者所有的好友以及好友的好友
+=end
         def tjp_super_become_fan fan_id, level=1
             return if level<=0
             become_fan(fan_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tjplurker
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-15 00:00:00.000000000Z
+date: 2011-07-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &18195672 !ruby/object:Gem::Requirement
+  requirement: &17981736 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *18195672
+  version_requirements: *17981736
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &18195384 !ruby/object:Gem::Requirement
+  requirement: &17981448 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,20 +32,21 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *18195384
+  version_requirements: *17981448
 description: A safe Plurk API wrapper based on Ruby and mainly designed for easily
   making plurk robot.
-email: tonytonyjan.cs97@g2.nctu.edu.tw
+email: tonytonyjan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tjplurker.rb
 - lib/tjplurker/core.rb
 - lib/tjplurker/legacy.rb
 - lib/tjplurker/robot.rb
+- lib/tjplurker.rb
 homepage: http://code.google.com/p/tjplurker
-licenses: []
+licenses:
+- New BSD
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: A safe Plurk API wrapper based on Ruby and mainly designed for easily making