Module: Rublox
- Defined in:
- lib/rublox.rb,
lib/rublox/derive/user.rb,
lib/rublox/util/errors.rb,
lib/rublox/derive/group.rb,
lib/rublox/derive/model.rb,
lib/rublox/bases/base_user.rb,
lib/rublox/models/presence.rb,
lib/rublox/util/api_helper.rb,
lib/rublox/bases/base_group.rb,
lib/rublox/models/full_user.rb,
lib/rublox/models/full_group.rb,
lib/rublox/models/group_shout.rb,
lib/rublox/models/skinny_user.rb
Overview
rublox is a Roblox web API wrapper written in Ruby. It aims to provide an object oriented interface to get and modify data from Roblox’s web API. Docs: rubydoc.info/gems/rublox
Defined Under Namespace
Modules: APIHelper, Bases, Derive, Errors, Models
Class Method Summary
collapse
Class Method Details
Returns the current authenticated user.
22
23
24
|
# File 'lib/rublox.rb', line 22
def self.authenticated_user
Models::SkinnyUser.new(APIHelper.get("https://users.roblox.com/v1/users/authenticated"))
end
|
68
69
70
|
# File 'lib/rublox.rb', line 68
def self.base_group(id)
Bases::BaseGroup.new(id)
end
|
27
28
29
|
# File 'lib/rublox.rb', line 27
def self.base_user(id)
Bases::BaseUser.new(id)
end
|
.roblosecurity=(roblosecurity) ⇒ nil
Sets the .ROBLOSECURITY cookie to send authenticated requests
17
18
19
|
# File 'lib/rublox.rb', line 17
def self.roblosecurity=(roblosecurity)
APIHelper.roblosecurity = roblosecurity
end
|
.user_from_username(username, exclude_banned_users: false) ⇒ Models::SkinnyUser
63
64
65
|
# File 'lib/rublox.rb', line 63
def self.user_from_username(username, exclude_banned_users: false)
users_from_usernames([username], exclude_banned_users: exclude_banned_users)[0] or raise Errors::UserNotFoundError
end
|
94
95
96
|
# File 'lib/rublox.rb', line 94
def self.user_presence_from_id(id)
user_presences_from_ids([id])[0]
end
|
.users_from_ids(ids, exclude_banned_users: false) ⇒ Array<Models::SkinnyUser>
41
42
43
44
45
46
47
48
49
|
# File 'lib/rublox.rb', line 41
def self.users_from_ids(ids, exclude_banned_users: false)
APIHelper.post(
"https://users.roblox.com/v1/users",
json: {
userIds: ids,
excludeBannedUsers: exclude_banned_users
}
)["data"].map { |data| Models::SkinnyUser.new(data) }
end
|
.users_from_usernames(usernames, exclude_banned_users: false) ⇒ Array<Models::SkinnyUser>
52
53
54
55
56
57
58
59
60
|
# File 'lib/rublox.rb', line 52
def self.users_from_usernames(usernames, exclude_banned_users: false)
APIHelper.post(
"https://users.roblox.com/v1/usernames/users",
json: {
usernames: usernames,
excludeBannedUsers: exclude_banned_users
}
)["data"].map { |data| Models::SkinnyUser.new(data) }
end
|