3 :public => '/statuses/public_timeline.json',
4 :friends => '/statuses/friends_timeline.json',
5 :friend => '/statuses/friends_timeline.json',
6 :user => '/statuses/user_timeline.json',
7 :me => '/statuses/user_timeline.json',
8 :replies => '/statuses/replies.json',
11 # Provides access to Twitter's Timeline APIs
13 # Returns timeline for given <tt>type</tt>.
15 # <tt>type</tt> can take the following values:
17 # * <tt>friends</tt> or <tt>friend</tt>
18 # * <tt>user</tt> or <tt>me</tt>
20 # <tt>:id</tt> is on key applicable to be defined in </tt>options</tt>:
21 # * the id or screen name (aka login) for :friends
22 # * the id or screen name (aka login) for :user
23 # * meaningless for the :me case, since <tt>twitter.timeline_for(:user, 'mylogin')</tt> and <tt>twitter.timeline_for(:me)</tt> are the same assuming 'mylogin' is the authenticated user's screen name (aka login).
26 # # returns the public statuses since status with id of 6543210
27 # twitter.timeline_for(:public, id => 6543210)
28 # # returns the statuses for friend with user id 43210
29 # twitter.timeline_for(:friend, :id => 43210)
30 # # returns the statuses for friend with screen name (aka login) of 'otherlogin'
31 # twitter.timeline_for(:friend, :id => 'otherlogin')
32 # # returns the statuses for user with screen name (aka login) of 'otherlogin'
33 # twitter.timeline_for(:user, :id => 'otherlogin')
35 # <tt>options</tt> can also include the following keys:
36 # * <tt>:id</tt> is the user ID, screen name of Twitter::User representation of a <tt>Twitter</tt> user.
37 # * <tt>:since</tt> is a Time object specifying the date-time from which to return results for. Applicable for the :friend, :friends, :user and :me cases.
38 # * <tt>:count</tt> specifies the number of statuses to retrieve. Only applicable for the :user case.
39 # * <tt>since_id</tt> is the status id of the public timeline from which to retrieve statuses for <tt>:public</tt>. Only applicable for the :public case.
41 # You can also pass this method a block, which will iterate through the results
42 # of the requested timeline and apply the block logic for each status returned.
45 # twitter.timeline_for(:public) do |status|
46 # puts status.user.screen_name, status.text
49 # twitter.timeline_for(:friend, :id => 'myfriend', :since => 30.minutes.ago) do |status|
50 # puts status.user.screen_name, status.text
53 # timeline = twitter.timeline_for(:me) do |status|
57 # An <tt>ArgumentError</tt> will be raised if an invalid <tt>type</tt>
58 # is given. Valid types are:
64 def timeline_for(type, options = {}, &block)
65 raise ArgumentError, "Invalid timeline type: #{type}" unless @@TIMELINE_URIS.keys.member?(type)
66 uri = @@TIMELINE_URIS[type]
67 response = http_connect {|conn| create_http_get_request(uri, options) }
68 timeline = Twitter::Status.unmarshal(response.body)
69 timeline.each {|status| bless_model(status); yield status if block_given? }