Class Twitter::Client
In: lib/twitter/extras.rb
lib/twitter/console.rb
lib/twitter/client.rb
lib/twitter/client/auth.rb
lib/twitter/client/search.rb
lib/twitter/client/account.rb
lib/twitter/client/trends.rb
lib/twitter/client/status.rb
lib/twitter/client/messaging.rb
lib/twitter/client/user.rb
lib/twitter/client/base.rb
lib/twitter/client/friendship.rb
lib/twitter/client/favorites.rb
lib/twitter/client/graph.rb
lib/twitter/client/blocks.rb
lib/twitter/client/timeline.rb
lib/twitter/client/profile.rb
lib/twitter/config.rb
Parent: Object

Used to query or post to the Twitter REST API to simplify code.

Methods

Included Modules

Twitter::ClassUtilMixin

External Aliases

inspect -> old_inspect

Attributes

login  [RW] 
oauth_access  [RW] 
oauth_consumer  [RW] 

Public Class methods

returns configuration object

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')

Public Instance methods

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 verify credentials API.

You can verify Twitter user credentials with minimal overhead using this method.

Example:

 client.authenticate?("osxisforlightweights", "l30p@rd_s^cks!")

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:

  • :add - to add a block, you would use this action value
  • :remove - to remove a block use this.

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:

  • :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 friendship information for the following scenarios:

  • :incoming - returns an array of numeric IDs for every user who has a pending request to follow the authenticating user.
  • :outgoing - returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

Examples:

 client.friendships(:incoming)
 #=> { :id_list => { :ids => [30592818, 21249843], :next_cursor => 1288724293877798413, :previous_cursor => -1300794057949944903 }}

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:

  • :friends - retrieves ids of all friends of a given user.
  • :followers - retrieves ids of all followers of a given user.

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:

  • Twitter::User, Integer or String object when action is :post. The Integer must be the unique ID of the Twitter user you wish to send the direct message to and any Strings passed in must be the screen name of the user you wish to send the direct message to.
  • 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.

An ArgumentError will be raised if an invalid action is given. Valid actions are:

  • +:post+
  • +:delete+

An ArgumentError is also raised when no user argument is supplied when action is +:post+.

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

Example:

 received_messages = @twitter.messages(:received)

An ArgumentError will be raised if an invalid action is given. Valid actions are:

  • +:received+
  • +:sent+

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

Where action is one of the following:

  • :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

Where options is a Hash of options that can include:

  • :page - optional. Retrieves the next set of friends. There are 100 friends per page. Default: 1.
  • :lite - optional. Prevents the inline inclusion of current status. Default: false.
  • :since - optional. Only relevant for :friends action. Narrows the results to just those friends added after the date given as value of this option. Must be HTTP-formatted date.

An ArgumentError will be raised if an invalid action is given. Valid actions are:

  • +:info+
  • +:friends+
  • +:followers+

Provides access to the Twitter Profile API.

You can update profile information. You can update the types of profile information:

  • :info (name, email, url, location, description)
  • :colors (background_color, text_color, link_color, sidebar_fill_color,

sidebar_border_color)

  • :device (set device to either "sms", "im" or "none")

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:

  • +:received+
  • +:sent+

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.
  • :reply to reply to an existing status. Assumes value given is Hash which contains :in_reply_to_status_id and :status

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)
 twitter.status(:reply, :in_reply_to_status_id => 1390482942342, :status => "@t4ruby This new v0.7.0 release is da bomb! #ruby #twitterapi #twitter4r")
 twitter.status(:post, "My brand new status in all its glory here tweeted from Greenwich (the real one). #withawesomehashtag #booyah", :lat => 0, :long => 0)

An ArgumentError will be raised if an invalid action is given. Valid actions are:

  • +:get+
  • +:post+
  • +:delete+

The third argument options sends on a Hash to the Twitter API with the following keys allowed:

  • +:lat+ - latitude (for posting geolocation)
  • +:long+ - longitude (for posting geolocation)
  • +:place_id+ - using a place ID give by geo/reverse_geocode
  • +:display_coordinates+ - whether or not to put a pin in the exact coordinates

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>:

  • 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 at a time. Only applicable for the :user case.
  • :page specifies page number to retrieve.
  • since_id is the status id of the public timeline from which to retrieve statuses for :public. Only applicable for the :public case.
  • include_rts flags whether to retrieve native retweets in the timeline or not. True values are true, t or 1.

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:

  • +:public+
  • +:friends+
  • +:friend+
  • +:user+
  • +:me+
  • +:mentions+
  • +:replies+
  • +:retweetsbyme+
  • +:retweetstome+
  • +:retweetsofme+

Provides access to the Twitter list trends API.

By default you will receive top ten topics that are trending on Twitter.

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:

  • :page - optional. Retrieves the next set of friends. There are 100 friends per page. Default: 1.
  • :lite - optional. Prevents the inline inclusion of current status. Default: false.
  • :since - optional. Only relevant for :friends action. Narrows the results to just those friends added after the date given as value of this option. Must be HTTP-formatted date.

An ArgumentError will be raised if an invalid action is given. Valid actions are:

  • +:info+
  • +:friends+

+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

Protected Instance methods

"Blesses" model object with client information

Returns the response of the OAuth/HTTP(s) request for REST API requests (not Search)

Returns the response of the OAuth/HTTP(s) request for Search API requests (not REST)

[Validate]