Class: Turntabler::User

Inherits:
Resource show all
Defined in:
lib/turntabler/user.rb

Overview

Represents an unauthorized user on Turntable

Direct Known Subclasses

AuthorizedUser

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#==, attribute, #attributes=, #hash, #initialize, #loaded?, #pretty_print, #pretty_print_instance_variables

Methods included from Assertions

#assert_valid_keys, #assert_valid_values

Methods included from DigestHelpers

#digest

Constructor Details

This class inherits a constructor from Turntabler::Resource

Instance Attribute Details

#about ⇒ String (readonly)

A brief description about the user

Returns:

  • (String) 


53
 
# File 'lib/turntabler/user.rb', line 53

attribute :about

#acl ⇒ Fixnum (readonly)

The access control determining what is authorized

Returns:

  • (Fixnum) 


31
 
# File 'lib/turntabler/user.rb', line 31

attribute :acl

#avatar ⇒ Turntabler::Avatar (readonly)

The user’s currently active avatar

Returns:



65
66
67
 
# File 'lib/turntabler/user.rb', line 65

attribute :avatar, :avatarid do |value|
  Avatar.new(client, :_id => value)
end

#facebook_url ⇒ String (readonly)

Note:

This is only available if the user is connected to the authorized user through Facebook

The user’s unique identifier on Facebook

Returns:

  • (String) 


40
 
# File 'lib/turntabler/user.rb', line 40

attribute :facebook_url, :facebook

#fans_count ⇒ Fixnum (readonly)

The number of fans this user has

Returns:

  • (Fixnum) 


35
 
# File 'lib/turntabler/user.rb', line 35

attribute :fans_count, :fans

#hangout ⇒ String (readonly)

A description of the rooms on Turntable the user likes to hang out

Returns:

  • (String) 


61
 
# File 'lib/turntabler/user.rb', line 61

attribute :hangout

#id ⇒ String (readonly)

Allow the id to be set via the “userid” attribute

Returns:

  • (String) 


11
 
# File 'lib/turntabler/user.rb', line 11

attribute :id, :userid, :load => false

#laptop_name ⇒ String (readonly)

The name of the laptop the DJ uses

Returns:

  • (String) 


19
 
# File 'lib/turntabler/user.rb', line 19

attribute :laptop_name, :laptop

#laptop_version ⇒ String (readonly)

The version # for the laptop

Returns:

  • (String) 


23
 
# File 'lib/turntabler/user.rb', line 23

attribute :laptop_version

#name ⇒ String (readonly)

The DJ name for this user

Returns:

  • (String) 


15
 
# File 'lib/turntabler/user.rb', line 15

attribute :name, :name, :username

#points ⇒ Fixnum (readonly)

The total number of points accumulated all-time

Returns:

  • (Fixnum) 


27
 
# File 'lib/turntabler/user.rb', line 27

attribute :points

#sticker_placements(reload = false) ⇒ Array<Turntabler::StickerPlacement> (readonly)

Gets the stickers that are currently placed on the user’s laptop.

Examples:

user.sticker_placements   # => [#<Turntabler::StickerPlacement ...>, ...]

Parameters:

  • reload (Boolean) (defaults to: false) —

    Whether to forcefully reload the user’s list of sticker placements

Returns:

Raises:



71
72
73
74
 
# File 'lib/turntabler/user.rb', line 71

attribute :sticker_placements, :sticker_placements, :placements do |placements|
  placements = placements.keys if placements.is_a?(Hash)
  placements.map {|attrs| StickerPlacement.new(client, attrs)}
end

#top_artists ⇒ String (readonly)

The user’s favorite artists

Returns:

  • (String) 


57
 
# File 'lib/turntabler/user.rb', line 57

attribute :top_artists, :topartists

#twitter_id ⇒ String (readonly)

Note:

This is only available if the user is connected to the authorized user through Twitter

The user’s unique identifier on Twitter

Returns:

  • (String) 


45
 
# File 'lib/turntabler/user.rb', line 45

attribute :twitter_id, :twitter, :twitterid_lower

#website ⇒ String (readonly)

The user’s personal website

Returns:

  • (String) 


49
 
# File 'lib/turntabler/user.rb', line 49

attribute :website

Instance Method Details

#add_as_moderator ⇒ Object

Adds the user as a moderator in the current room.

user.add_as_moderator   # => true



199
200
201
202
 
# File 'lib/turntabler/user.rb', line 199

def add_as_moderator
  api('room.add_moderator', :roomid => room.id, :section => room.section, :target_userid => id)
  true
end

#become_fan ⇒ true

Marks the current user as a fan of this user.

Examples:

user.become_fan   # => true

Returns:

  • (true)

Raises:



119
120
121
122
 
# File 'lib/turntabler/user.rb', line 119

def become_fan
  api('user.become_fan', :djid => id)
  true
end

#block ⇒ true

Blocks this user from being able to send private messages.

Examples:

user.block    # => true

Returns:

  • (true)

Raises:



235
236
237
238
 
# File 'lib/turntabler/user.rb', line 235

def block
  api('block.add', :blockedid => id)
  true
end

#boot(reason = '') ⇒ true

Boots the user for the specified reason.

Examples:

user.boot('Broke rules')    # => true

Parameters:

  • reason (String) (defaults to: '') —

    The reason why the user is being booted

Returns:

  • (true)

Raises:



258
259
260
261
 
# File 'lib/turntabler/user.rb', line 258

def boot(reason = '')
  api('room.boot_user', :roomid => room.id, :section => room.section, :target_userid => id, :reason => reason)
  true
end

#dj? ⇒ Boolean

Is the user currently DJing in the room?

Examples:

user.dj?    # => false

Returns:

  • (Boolean) —

    true if the user is a dj, otherwise false



172
173
174
 
# File 'lib/turntabler/user.rb', line 172

def dj?
  !room.dj(id).nil?
end

#listener? ⇒ Boolean

Is the user currently a listener in the room?

Examples:

user.listener?    # => false

Returns:

  • (Boolean) —

    true if the user is a listener, otherwise false



163
164
165
 
# File 'lib/turntabler/user.rb', line 163

def listener?
  !room.listener(id).nil?
end

#load ⇒ true

Loads the attributes for this user. Attributes will automatically load when accessed, but this allows data to be forcefully loaded upfront.

Examples:

user.load         # => true
user.laptop_name  # => "chrome"

Returns:

  • (true)

Raises:



84
85
86
87
88
 
# File 'lib/turntabler/user.rb', line 84

def load
  data = api('user.get_profile', :userid => id)
  self.attributes = data
  super
end

#messages ⇒ Array<Turntabler::Message>

Gets the private conversation history with this user.

Examples:

user.messages   # => [#<Turntabler::Message ...>, ...]

Returns:

Raises:



153
154
155
156
 
# File 'lib/turntabler/user.rb', line 153

def messages
  data = api('pm.history', :receiverid => id)
  data['history'].map {|attrs| Message.new(client, attrs)}
end

#moderator? ⇒ Boolean

Is the user currently a moderator for the room?

Examples:

user.moderator?   # => false

Returns:

  • (Boolean) —

    true if the user is a moderator, otherwise false



192
193
194
 
# File 'lib/turntabler/user.rb', line 192

def moderator?
  !room.moderator(id).nil?
end

#presence ⇒ String

Gets the availability status for this user.

Examples:

user.presence   # => "available"

Returns:

  • (String) —

    “available” / “unavailable”

Raises:



96
97
98
99
 
# File 'lib/turntabler/user.rb', line 96

def presence
  data = api('presence.get', :uid => id)
  data['presence']['status']
end

#remove_as_dj ⇒ true

Stops the user from DJing.

Examples:

user.remove_as_dj   # => true

Returns:

  • (true)

Raises:



182
183
184
185
 
# File 'lib/turntabler/user.rb', line 182

def remove_as_dj
  api('room.rem_dj', :roomid => room.id, :section => room.section, :djid => id)
  true
end

#remove_as_moderator ⇒ true

Removes the user from being a moderator in the current room.

Examples:

user.remove_as_moderator    # => true

Returns:

  • (true)

Raises:



210
211
212
213
 
# File 'lib/turntabler/user.rb', line 210

def remove_as_moderator
  api('room.rem_moderator', :roomid => room.id, :section => room.section, :target_userid => id)
  true
end

#report(reason = '') ⇒ true

Reports abuse by a user.

Examples:

user.report('Verbal abuse ...')  # => true

Parameters:

  • reason (String) (defaults to: '') —

    The reason the user is being reported

Returns:

  • (true)

Raises:



270
271
272
273
 
# File 'lib/turntabler/user.rb', line 270

def report(reason = '')
  api('room.report_user', :roomid => room.id, :section => room.section, :reported => id, :reason => reason)
  true
end

#say(content) ⇒ true

Sends a private message to this user.

Examples:

user.say("Hey what's up?")    # => true

Parameters:

  • content (String) —

    The text of the message

Returns:

  • (true)

Raises:



142
143
144
145
 
# File 'lib/turntabler/user.rb', line 142

def say(content)
  api('pm.send', :receiverid => id, :text => content)
  true
end

#stalk ⇒ Turntabler::Room

Note:

This will make the current user a fan of this user

Gets the location of the user.

Examples:

user.stalk    # => #<Turntabler::Room ...>

Returns:

Raises:



222
223
224
225
226
227
 
# File 'lib/turntabler/user.rb', line 222

def stalk
  become_fan unless client.user.fan_of.include?(self)
  client.rooms.with_friends.detect do |room|
    room.listener(id)
  end
end

#unblock ⇒ true

Unblocks this user from being able to send private messages.

Examples:

user.unblock    # => true

Returns:

  • (true)

Raises:



246
247
248
249
 
# File 'lib/turntabler/user.rb', line 246

def unblock
  api('block.remove', :blockedid => id)
  true
end

#unfan ⇒ true

Marks the current user no longer as a fan of this user.

Examples:

user.unfan    # => true

Returns:

  • (true)

Raises:



130
131
132
133
 
# File 'lib/turntabler/user.rb', line 130

def unfan
  api('user.remove_fan', :djid => id)
  true
end