rublox 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca58ae27999a8a9d6dad08937ce3167d34163e903571912c47da20cd19c1814a
-  data.tar.gz: 6116e15392c612305c88425a84d737a867bf6531d36022354f4d410147987837
+  metadata.gz: 4d71b3699e8ae0069057c6df240c9ab0199b98f7891c9675543f4b058faf49d3
+  data.tar.gz: b1816f4f994d9d5a78d10bd9cb9ce53882ebabcf3847f2bb58ae9d8d0c5d2cc0
 SHA512:
-  metadata.gz: 353887d40de73fdb4926837cdfc5209e310db9a9bd323283f288ed312e709e71425133f556f734badd7a54429fbff8fd8acc066fe00dc5701a72ca5c0491bc18
-  data.tar.gz: 03bbc4ff1011eda5b039c7dcdd9dafcbec8c3f20ae6c462e6e817dcd3b5e2abe849fd2a318ed6d92e7ff542e882aa4b5647e5070430e80b34ade740631b77631
+  metadata.gz: 33ab5fe58df3c385f14334db14cfced103b5c7004c62b25b8005041b070cf336e5fffbefc00aa5691a05ee11ba3970157f7533e08e32380d72e0f13f4ff31058
+  data.tar.gz: f76ac4fec783276f419fdf1814cd2b6a71cbc82bbeaf5930f373727e6d3c7e0ebd8f2f8ee555596aa53268d1bbb2752c9a79b8efae4d4a6e2154fcf00e2f518e

data/lib/rublox/derive/group.rb

@@ -14,16 +14,19 @@ module Rublox
 				))
 			end
 
+			# @return [nil]
 			def accept_join_request(user_id)
 				APIHelper.post("https://groups.roblox.com/v1/groups/#{@id}/join-requests/users/#{user_id}")
 				nil
 			end
 
+			# @return [nil]
 			def decline_join_request(user_id)
 				APIHelper.delete("https://groups.roblox.com/v1/groups/#{@id}/join-requests/users/#{user_id}")
 				nil
 			end
 
+			# @return [nil]
 			def kick(user_id)
 				APIHelper.delete("https://groups.roblox.com/v1/groups/#{@id}/users/#{user_id}")
 				nil

data/lib/rublox/derive/user.rb

@@ -8,7 +8,7 @@ module Rublox
 		module User
 			include Model
 
-			# @return [Number] the amount of robux the current authenticated user has
+			# @return [Integer] the amount of robux the current authenticated user has
 			def currency
 				APIHelper.get("https://economy.roblox.com/v1/users/#{@id}/currency")["robux"]
 			end

data/lib/rublox/models/full_group.rb

@@ -15,9 +15,9 @@ module Rublox
 			attr_reader :name
 			# @return [String]
 			attr_reader :description
-			# @return [SkinnyUser]
+			# @return [SkinnyUser, nil]
 			attr_reader :owner
-			# @return [GroupShout]
+			# @return [GroupShout, nil]
 			attr_reader :shout
 			# @return [Integer]
 			attr_reader :member_count
@@ -47,6 +47,7 @@ module Rublox
 			end
 
 			# Updates the group shout and sets {#shout} to the new group shout
+			# @return [nil]
 			def update_shout!(message)
 				@shout = update_shout(message)
 			end

data/lib/rublox/models/full_user.rb

@@ -13,7 +13,7 @@ module Rublox
 			attr_reader :created
 			# @return [Boolean]
 			attr_reader :is_banned
-			# @return [String?]
+			# @return [String, nil]
 			attr_reader :external_app_display_name
 			# @return [Boolean]
 			attr_reader :has_verified_badge

data/lib/rublox/models/presence.rb

@@ -32,10 +32,12 @@ module Rublox
 			attr_reader :user_presence_type
 			# @return [String]
 			attr_reader :last_location
+
 			# attr_reader :place_id
 			# attr_reader :root_place_id
 			# attr_reader :game_id
 			# attr_reader :universe_id
+
 			# @return [Bases::BaseUser]
 			attr_reader :user
 			# @return [Time]

data/lib/rublox/util/api_helper.rb

@@ -46,6 +46,8 @@ module Rublox
 							"x-csrf-token" => response.headers
 						}
 					)
+				else
+					raise Errors::UnhandledStatusCodeError.new(response, get_errors_from_response(response))
 				end
 			when 401
 				raise Errors::InvalidROBLOSECURITYError

data/lib/rublox/util/errors.rb

@@ -33,7 +33,7 @@ module Rublox
 			end
 		end
 
-		# This error is raised when a method that requires authenticated is called without a valid .ROBLOSECURITY cookie set
+		# This error is raised when a method that requires authentication is called without a valid .ROBLOSECURITY cookie set
 		class InvalidROBLOSECURITYError < StandardError
 			# @!visibility private
 			def initialize

data/lib/rublox.rb

@@ -13,21 +13,22 @@ require "rublox/bases/base_group"
 # Docs: https://rubydoc.info/gems/rublox
 module Rublox
 	# Sets the .ROBLOSECURITY cookie to send authenticated requests
+	# @return [nil]
 	def self.roblosecurity=(roblosecurity)
 		APIHelper.roblosecurity = roblosecurity
 	end
 
-	# Returns the current authenticated user
+	# @return [Models::SkinnyUser] the current authenticated user
 	def self.authenticated_user
 		Models::SkinnyUser.new(APIHelper.get("https://users.roblox.com/v1/users/authenticated"))
 	end
 
-	# Returns a BaseUser
+	# @return [Bases::BaseUser]
 	def self.base_user(id)
 		Bases::BaseUser.new(id)
 	end
 
-	# Returns a user
+	# @return [Models::FullUser]
 	def self.user_from_id(id)
 		Models::FullUser.new(APIHelper.get("https://users.roblox.com/v1/users/#{id}"))
 	rescue Errors::UnhandledStatusCodeError => e
@@ -36,6 +37,7 @@ module Rublox
 		raise
 	end
 
+	# @return [Array<Models::SkinnyUser>]
 	def self.users_from_ids(ids, exclude_banned_users: false)
 		APIHelper.post(
 			"https://users.roblox.com/v1/users",
@@ -46,6 +48,7 @@ module Rublox
 		)["data"].map { |data| Models::SkinnyUser.new(data) }
 	end
 
+	# @return [Array<Models::SkinnyUser>]
 	def self.users_from_usernames(usernames, exclude_banned_users: false)
 		APIHelper.post(
 			"https://users.roblox.com/v1/usernames/users",
@@ -56,22 +59,26 @@ module Rublox
 		)["data"].map { |data| Models::SkinnyUser.new(data) }
 	end
 
+	# @return [Models::SkinnyUser]
 	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
 
+	# @return [Bases::BaseUser]
 	def self.base_group(id)
 		Bases::BaseGroup.new(id)
 	end
 
+	# @return [Models::FullGroup]
 	def self.group_from_id(id)
-		APIHelper.get("https://groups.roblox.com/v1/groups/#{id}")
+		Models::FullGroup.new(APIHelper.get("https://groups.roblox.com/v1/groups/#{id}"))
 	rescue Errors::UnhandledStatusCodeError => e
 		raise Errors::GroupNotFoundError, cause: nil if e.response.status == 400
 
 		raise
 	end
 
+	# @return [Array<Models::Presence>]
 	def self.user_presences_from_ids(ids)
 		APIHelper.post(
 			"https://presence.roblox.com/v1/presence/users",
@@ -83,6 +90,7 @@ module Rublox
 		raise
 	end
 
+	# @return [Models::Presence]
 	def self.user_presence_from_id(id)
 		user_presences_from_ids([id])[0]
 	end

data/rublox.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
 	spec.name = "rublox"
-	spec.version = "0.3.0"
+	spec.version = "0.3.1"
 	spec.authors = %w[zmλdie keef]
 	spec.email = "rorg.devv@gmail.com"
 	spec.summary = "A Roblox web API wrapper written in Ruby"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rublox
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - zmλdie
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http