class Twitter::User

Represents a Twitter user

Public Class Methods

attributes() click to toggle source

Used as factory method callback

# File lib/twitter/model.rb, line 284
def attributes; @@ATTRIBUTES; end
find(id, client) click to toggle source

Returns user model object with given id using the configuration and credentials of the client object passed in.

You can pass in either the user's unique integer ID or the user's screen name.

# File lib/twitter/model.rb, line 291
def find(id, client)
  client.user(id)
end

Public Instance Methods

bless(client) click to toggle source

Override of ModelMixin#bless method.

Adds followers instance method when user object represents authenticated user. Otherwise just do basic bless.

This permits applications using Twitter4R to write Rubyish code like this:

followers = user.followers if user.is_me?

Or:

followers = user.followers if user.respond_to?(:followers)
# File lib/twitter/model.rb, line 306
def bless(client)
  basic_bless(client)
  self.instance_eval(%Q{
    self.class.send(:include, Twitter::AuthenticatedUserMixin)
  }) if self.is_me? and not self.respond_to?(:followers)
  self
end
friends() click to toggle source

Returns an Array of user objects that represents the authenticated user's friends on Twitter.

# File lib/twitter/model.rb, line 332
def friends
  @client.user(@id, :friends)
end
is_me?() click to toggle source

Returns whether this Twitter::User model object represents the authenticated user of the client that blessed it.

# File lib/twitter/model.rb, line 317
def is_me?
  # TODO: Determine whether we should cache this or not?
  # Might be dangerous to do so, but do we want to support
  # the edge case where this would cause a problem?  i.e. 
  # changing authenticated user after initial use of 
  # authenticated API.
  # TBD: To cache or not to cache.  That is the question!
  # Since this is an implementation detail we can leave this for 
  # subsequent 0.2.x releases.  It doesn't have to be decided before 
  # the 0.2.0 launch.
  @screen_name == @client.instance_eval("@login")
end