Yields to given block to configure the Twitter4R API.

Helper method mostly for irb shell prototyping.

Reads in login/password Twitter credentials from YAML file found at the location given by config_file that has the following format:

 envname:
   login: mytwitterlogin
   password: mytwitterpassword

Where envname is the name of the environment like ‘test’, ‘dev’ or ‘prod’. The env argument defaults to ‘test’.

To use this in the shell you would do something like the following examples:

 twitter = Twitter::Client.from_config('config/twitter.yml', 'dev')
 twitter = Twitter::Client.from_config('config/twitter.yml')

Provides access to the Featured Twitter API.

Currently the only value for type accepted is :users, which will return an Array of blessed Twitter::User objects that represent Twitter‘s featured users.

Provides access to the Twitter Friendship API.

You can add and remove friends using this method.

action can be any of the following values:

• :add - to add a friend, you would use this action value
• :remove - to remove an existing friend from your friends list use this.

The value must be either the user to befriend or defriend‘s screen name, integer unique user ID or Twitter::User object representation.

Examples:

 screen_name = 'dictionary'
 client.friend(:add, 'dictionary')
 client.friend(:remove, 'dictionary')
 id = 1260061
 client.friend(:add, id)
 client.friend(:remove, id)
 user = Twitter::User.find(id, client)
 client.friend(:add, user)
 client.friend(:remove, user)

Provides access to Twitter‘s Messaging API for sending and deleting direct messages to other users.

action can be:

• :post - to send a new direct message, value, to user given.
• :delete - to delete direct message with message ID value.

value should be:

• String when action is :post. Will be the message text sent to given user.
• Integer or Twitter::Message object when action is :delete. Will refer to the unique message ID to delete. When passing in an instance of Twitter::Message that Status will be

user should be:

• Twitter::User or Integer object when action is :post.
• totally ignore when action is :delete. It has no purpose in this use case scenario.

Examples: The example below sends the message text ‘Are you coming over at 6pm for the BBQ tonight?’ to user with screen name ‘myfriendslogin’…

 @twitter.message(:post, 'Are you coming over at 6pm for the BBQ tonight?', 'myfriendslogin')

The example below sends the same message text as above to user with unique integer ID of 1234567890… the example below sends the same message text as above to user represented by user object instance of Twitter::User…

 @twitter.message(:post, 'Are you coming over at 6pm for the BBQ tonight?', user)
 message = @twitter.message(:post, 'Are you coming over at 6pm for the BBQ tonight?', 1234567890)

the example below delete‘s the message send directly above to user with unique ID 1234567890…

 @twitter.message(:delete, message)

Or the following can also be done…

 @twitter.message(:delete, message.id)

In both scenarios (action is :post or :delete) a blessed Twitter::Message object is returned that represents the newly posted or newly deleted message.

Provides access to Twitter‘s Messaging API for received and sent direct messages.

Syntactic sugar for queries relating to authenticated user in Twitter‘s User API

When action is:

• :info - Returns user instance for the authenticated user.
• :friends - Returns Array of users that are authenticated user‘s friends
• :followers - Returns Array of users that are authenticated user‘s followers

Provides access to individual statuses via Twitter‘s Status APIs

action can be of the following values:

• :get to retrieve status content. Assumes value given responds to :to_i message in meaningful way to yield intended status id.
• :post to publish a new status
• :delete to remove an existing status. Assumes value given responds to :to_i message in meaningful way to yield intended status id.

value should be set to:

• the status identifier for :get case
• the status text message for :post case
• none necessary for :delete case

Examples:

 twitter.status(:get, 107786772)
 twitter.status(:post, "New Ruby open source project Twitter4R version 0.2.0 released.")
 twitter.status(:delete, 107790712)

Provides access to Twitter‘s Timeline APIs

Returns timeline for given type.

type can take the following values:

• public
• friends or friend
• user or me

:id is on key applicable to be defined in </tt>options</tt>:

• the id or screen name (aka login) for :friends
• the id or screen name (aka login) for :user
• meaningless for the :me case, since twitter.timeline_for(:user, ‘mylogin’) and twitter.timeline_for(:me) are the same assuming ‘mylogin’ is the authenticated user‘s screen name (aka login).

Examples:

 # returns the public statuses since status with id of 6543210
 twitter.timeline_for(:public, id => 6543210)
 # returns the statuses for friend with user id 43210
 twitter.timeline_for(:friend, :id => 43210)
 # returns the statuses for friend with screen name (aka login) of 'otherlogin'
 twitter.timeline_for(:friend, :id => 'otherlogin')
 # returns the statuses for user with screen name (aka login) of 'otherlogin'
 twitter.timeline_for(:user, :id => 'otherlogin')

options can also include the following keys:

• :id is the user ID, screen name of Twitter::User representation of a Twitter user.
• :since is a Time object specifying the date-time from which to return results for. Applicable for the :friend, :friends, :user and :me cases.
• :count specifies the number of statuses to retrieve. Only applicable for the :user case.
• since_id is the status id of the public timeline from which to retrieve statuses for :public. Only applicable for the :public case.

You can also pass this method a block, which will iterate through the results of the requested timeline and apply the block logic for each status returned.

Example:

 twitter.timeline_for(:public) do |status|
   puts status.user.screen_name, status.text
 end

 twitter.timeline_for(:friend, :id => 'myfriend', :since => 30.minutes.ago) do |status|
   puts status.user.screen_name, status.text
 end

 timeline = twitter.timeline_for(:me) do |status|
   puts status.text
 end

Provides access to Twitter‘s User APIs

Returns user instance for the id given. The id can either refer to the numeric user ID or the user‘s screen name.

For example,

 @twitter.user(234943) #=> Twitter::User object instance for user with numeric id of 234943
 @twitter.user('mylogin') #=> Twitter::User object instance for user with screen name 'mylogin'

"Blesses" model object with client information

Returns the response of the HTTP connection.