Used to query or post to the Twitter REST API to simplify code.
inspect | -> | old_inspect |
login | [RW] | |
password | [RW] |
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 Twitter rate limit status API.
You can find out information about your account status. Currently the only supported type of account status is the :rate_limit_status which returns a Twitter::RateLimitStatus object.
Example:
account_status = client.account_info puts account_status.remaining_hits
Provides access to the Twitter Block API.
You can add and remove blocks to users using this method.
action can be any of the following values:
The value must be either the user screen name, integer unique user ID or Twitter::User object representation.
Examples:
screen_name = 'dictionary' client.block(:add, 'dictionary') client.block(:remove, 'dictionary') id = 1260061 client.block(:add, id) client.block(:remove, id) user = Twitter::User.find(id, client) client.block(:add, user) client.block(:remove, user)
Provides access to the Twitter add/remove favorite API.
You can add and remove favorite status using this method.
action can be any of the following values:
The value must be either the status object to add or remove or the integer unique status ID.
Examples:
id = 126006103423 client.favorite(:add, id) client.favorite(:remove, id) status = Twitter::Status.find(id, client) client.favorite(:add, status) client.favorite(:remove, status)
Provides access to the Twitter list favorites API.
You can access the authenticated [Twitter] user‘s favorites list using this method.
By default you will receive the last twenty statuses added to your favorites list. To get a previous page you can provide options to this method. For example,
statuses = client.favorites(:page => 2)
The above one-liner will get the second page of favorites for the authenticated user.
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:
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 the Twitter Social Graphing API.
You can retrieve the full graph of a user‘s friends or followers in one method call.
action can be any of the following values:
The value must be either the user screen name, integer unique user ID or Twitter::User object representation.
Examples:
screen_name = 'dictionary' client.graph(:friends, 'dictionary') client.graph(:followers, 'dictionary') id = 1260061 client.graph(:friends, id) client.graph(:followers, id) user = Twitter::User.find(id, client) client.graph(:friends, user) client.graph(:followers, user)
Provides access to Twitter‘s Messaging API for sending and deleting direct messages to other users.
action can be:
value should be:
user should be:
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.
An ArgumentError will be raised if an invalid action is given. Valid actions are:
An ArgumentError is also raised when no user argument is supplied when action is +:post+.
Syntactic sugar for queries relating to authenticated user in Twitter‘s User API
Where action is one of the following:
Where options is a Hash of options that can include:
An ArgumentError will be raised if an invalid action is given. Valid actions are:
Provides access to the Twitter Profile API.
You can update profile information. You can update the types of profile information:
sidebar_border_color)
Example:
user = client.profile(:info, :location => "University Library") puts user.inspect
Provides access to Twitter‘s Search API.
Example:
# For keyword search iterator = @twitter.search(:q => "coworking") while (tweet = iterator.next) puts tweet.text end
An ArgumentError will be raised if an invalid action is given. Valid actions are:
Provides access to individual statuses via Twitter‘s Status APIs
action can be of the following values:
value should be set to:
Examples:
twitter.status(:get, 107786772) twitter.status(:post, "New Ruby open source project Twitter4R version 0.2.0 released.") twitter.status(:delete, 107790712)
An ArgumentError will be raised if an invalid action is given. Valid actions are:
Provides access to Twitter‘s Timeline APIs
Returns timeline for given type.
type can take the following values:
:id is on key applicable to be defined in </tt>options</tt>:
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:
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
An ArgumentError will be raised if an invalid type is given. Valid types are:
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'
Where options is a Hash of options that can include:
An ArgumentError will be raised if an invalid action is given. Valid actions are:
+Note:+ You should not use this method to attempt to retrieve the authenticated user‘s followers. Please use any of the following ways of accessing this list:
followers = client.my(:followers)
OR
followers = client.my(:info).followers