rublox 0.1.0 → 0.3.0

data/lib/rublox/models/full_user.rb

@@ -1,49 +1,40 @@
-# frozen_string_literal: true
-
-require "time"
-
-require "rublox/derive/user"
-
-module Rublox
-  # @note This class is handled internally by the public interface such as
-  #   {Client#user_from_id}. You should not be creating it yourself.
-  # The {FullUser} class corresponds to a full user response you can get via
-  # https://users.roblox.com/v1/users/userId. You can use it to get information
-  # about users.
-  #
-  # See {User} for methods you can call on users!
-  class FullUser
-    include User
-
-    # @return [Integer] the user's ID
-    attr_reader :id
-
-    # @return [String] the user's username
-    attr_reader :username
-
-    # @return [String] the user's display name
-    attr_reader :display_name
-
-    # @return [String] the user's profile description
-    attr_reader :description
-
-    # @return [true, false] is the user banned?
-    attr_reader :banned
-
-    # @return [Time] the user's join date
-    attr_reader :join_date
-
-    # @param data [Hash]
-    # @param client [Client]
-    def initialize(data, client)
-      @id = data["id"]
-      @username = data["name"]
-      @display_name = data["displayName"]
-      @description = data["description"]
-      @banned = data["banned"]
-      @join_date = Time.iso8601(data["created"])
-
-      @client = client
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/derive/user"
+
+module Rublox
+	module Models
+		class FullUser
+			include Derive::User
+
+			# @return [String]
+			attr_reader :description
+			# @return [Time]
+			attr_reader :created
+			# @return [Boolean]
+			attr_reader :is_banned
+			# @return [String?]
+			attr_reader :external_app_display_name
+			# @return [Boolean]
+			attr_reader :has_verified_badge
+			# @return [Integer]
+			attr_reader :id
+			# @return [String]
+			attr_reader :name
+			# @return [String]
+			attr_reader :display_name
+
+			# @!visibility private
+			def initialize(data)
+				@description = data["description"]
+				@created = Time.iso8601(data["created"])
+				@is_banned = data["isBanned"]
+				@external_app_display_name = data["externalAppDisplayName"]
+				@has_verified_badge = data["hasVerifiedBadge"]
+				@id = data["id"]
+				@name = data["name"]
+				@display_name = data["displayName"]
+			end
+		end
+	end
+end

data/lib/rublox/models/group_shout.rb

@@ -1,62 +1,26 @@
-# frozen_string_literal: true
-
-require "rublox/models/limited_user"
-
-module Rublox
-  # @note This class is handled internally by the public interface such as
-  #   {FullGroup#shout}. You should not be creating it yourself.
-  # The {GroupShout} class corresponds to a shout response. You can use it to get
-  # and set information about group shouts.
-  class GroupShout
-    # @return [String] the shout's body
-    attr_reader :body
-
-    # @return [LimitedUser, nil] the user that made the shout, can be nil if the
-    #   shout has no poster
-    attr_reader :poster
-
-    # @param data [Hash]
-    # @param client [Client]
-    # @param group_id [Integer]
-    def initialize(data, client, group_id)
-      @body = data["body"]
-      @poster = LimitedUser.new(data["poster"], client) if data["poster"]
-
-      @group_id = group_id
-      @client = client
-    end
-
-    # Sends a new shout.
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(1)
-    #   group.shout.send_shout("new shout")
-    # @param new_shout [String] the body of the new shout
-    # @return [void]
-    def send_shout(new_shout)
-      @client.http_client.patch(
-        URL.endpoint("groups", "v1/groups/#{@group_id}/status"),
-        json: {
-          message: new_shout
-        }
-      )
-    end
-
-    # Clears the group shout. Same as calling {#send_shout} with an empty string.
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(1)
-    #   group.shout.clear
-    #   # same as
-    #   group.shout.send_shout("")
-    # @return [void]
-    def clear
-      send_shout("")
-    end
-
-    # @return [GroupShout] A new group shout object with updated information.
-    def refresh
-      @client.group_from_id(@group_id).shout
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/models/skinny_user"
+
+module Rublox
+	module Models
+		class GroupShout
+			# @return [String]
+			attr_reader :body
+			# @return [SkinnyUser]
+			attr_reader :poster
+			# @return [Time]
+			attr_reader :created
+			# @return [Time]
+			attr_reader :updated
+
+			# @!visibility private
+			def initialize(data)
+				@body = data["body"]
+				@poster = SkinnyUser.new(data["poster"])
+				@created = Time.iso8601(data["created"])
+				@updated = Time.iso8601(data["updated"])
+			end
+		end
+	end
+end

data/lib/rublox/models/presence.rb

@@ -1,98 +1,59 @@
-# frozen_string_literal: true
-
-require "time"
-
-module Rublox
-  # The state of the presence.
-  #
-  # Can be offline, online/on the website, playing a game, developing on studio.
-  module PresenceType
-    # The user is/was offline.
-    OFFLINE = :Offline
-    # The user is/was online (this also applies to the website).
-    ONLINE = :Online
-    # The user is/was playing a game.
-    GAME = :"In game"
-    # The user is/was developing on studio.
-    STUDIO = :"In Studio"
-
-    # @!visibility private
-    PRESENCE_MAP = [
-      OFFLINE,
-      ONLINE,
-      GAME,
-      STUDIO
-    ].freeze
-
-    # Convert the Roblox PresenceType enum response to rublox's PresenceType
-    # equivalent.
-    # @!visibility private
-    # @param enum [Integer]
-    # @return [Symbol]
-    def self.enum_to_presence_type(enum)
-      PRESENCE_MAP[enum]
-    end
-  end
-
-  # @note This class is handled internally by the public interface such as
-  #   {Client#user_presence_from_id}. You should not be creating it yourself.
-  # The {Presence} class corresponds to a response you can get via
-  # https://presence.roblox.com/v1/presence/users. You can use it to get information
-  # about the presence states of users.
-  class Presence
-    # @return [PresenceType] the current presence type
-    attr_reader :presence_type
-
-    # @return [PresenceType] the last presence type of the user
-    attr_reader :last_presence_type
-
-    # @note Unlike it sounds, this is not a numerical ID like of a user. It's a
-    # randomly generated string with hexadecimal numbers containing the server's
-    # job ID (which looks like "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"), it can be
-    # also accessed in-game via the game.JobId property.
-    # @return [String, nil] the job ID of the game last played by the user.
-    attr_reader :game_job_id
-
-    # @return [Time] the date at which the user was last online
-    attr_reader :last_online_date
-
-    def initialize(data, client)
-      @presence_type = PresenceType.enum_to_presence_type(data["userPresenceType"])
-      @last_location = data["lastLocation"]
-      @place_id = data["placeId"]
-      @root_place_id = data["rootPlaceId"]
-      @game_job_id = data["gameId"]
-      @universe_id = data["universeId"]
-      @user_id = data["userId"]
-      @last_online_date = Time.iso8601(data["lastOnline"])
-
-      @client = client
-    end
-
-    # @todo add Place class
-    # @return [Place, nil] the place last visited by the user, can be nil if the
-    #   user has never played a game
-    def place
-      return unless @place_id
-    end
-
-    # @todo add Place class
-    # @return [Place, nil] the root of the place last visited by the user, can
-    #   be nil if the user has never played a game
-    def root_place
-      return unless @root_place_id
-    end
-
-    # @todo add Universe class
-    # @return [Universe, nil] the universe of the place last visited by the user,
-    #   can be nil if the user has never played a game
-    def universe
-      return unless @universe_id
-    end
-
-    # @return [FullUser] the user tied to the presence
-    def user
-      @client.user_from_id(@user_id)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/derive/model"
+require "rublox/bases/base_user"
+
+module Rublox
+	module Models
+		module PresenceType
+			OFFLINE = :offline
+			ONLINE = :online
+			IN_GAME = :in_game
+			IN_STUDIO = :in_studio
+
+			PRESENCE_MAP = [
+				OFFLINE,
+				ONLINE,
+				IN_GAME,
+				IN_STUDIO
+			].freeze
+			private_constant :PRESENCE_MAP
+
+			# @!visibility private
+			def self.get(enum)
+				PRESENCE_MAP[enum]
+			end
+		end
+
+		class Presence
+			include Derive::Model
+
+			# @return [PresenceType]
+			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]
+			attr_reader :last_online
+
+			# @!visibility private
+			def initialize(data)
+				@user_presence_type = PresenceType.get(data["userPresenceType"])
+				@last_location = data["lastLocation"]
+				# @place_id = data["placeId"]
+				# @root_place_id = data["rootPlaceId"]
+				# @game_id = data["gameId"]
+				# @universe_id = data["universeId"]
+				@user = Bases::BaseUser.new(data["userId"])
+				@last_online = Time.iso8601(data["lastOnline"])
+
+				@id = @user_id
+			end
+		end
+	end
+end

data/lib/rublox/models/skinny_user.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rublox/derive/user"
+
+module Rublox
+	module Models
+		class SkinnyUser
+			include Derive::User
+
+			# @return [Integer]
+			attr_reader :id
+			# @return [String]
+			attr_reader :name
+			# @return [String]
+			attr_reader :display_name
+			# @return [Boolean]
+			attr_reader :has_verified_badge
+
+			# @!visibility private
+			def initialize(data)
+				@id = data["id"] || data["userId"]
+				@name = data["name"] || data["username"]
+				@display_name = data["displayName"]
+				@has_verified_badge = data["hasVerifiedBadge"]
+			end
+		end
+	end
+end

data/lib/rublox/util/api_helper.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "http"
+require "json"
+
+require "rublox/util/errors"
+
+module Rublox
+	module APIHelper
+		@client = HTTP::Client.new
+
+		# @!visibility private
+		def self.roblosecurity=(roblosecurity)
+			@client = @client.cookies(
+				{
+					".ROBLOSECURITY" => roblosecurity
+				}
+			)
+		end
+
+		def self.get(url, *args)
+			request(:get, url, *args)
+		end
+
+		def self.post(url, *args)
+			request(:post, url, *args)
+		end
+
+		def self.patch(url, *args)
+			request(:patch, url, *args)
+		end
+
+		def self.delete(url, *args)
+			request(:delete, url, *args)
+		end
+
+		def self.request(method, url, *args)
+			response = @client.request(method, url, *args)
+			case response.status
+			when 200
+				JSON.parse(response.body)
+			when 403
+				if JSON.parse(response.body).any? { |error| error.code.zero? }
+					@client = @client.headers(
+						{
+							"x-csrf-token" => response.headers
+						}
+					)
+				end
+			when 401
+				raise Errors::InvalidROBLOSECURITYError
+			else
+				raise Errors::UnhandledStatusCodeError.new(response, get_errors_from_response(response))
+			end
+		end
+
+		def self.get_errors_from_response(response)
+			body = JSON.parse(response.body)
+		rescue JSON::ParserError
+			"\ncould not parse errors, raw body:\n#{response.body}\n"
+		else
+			body["errors"].reduce("") do |error_message, error|
+				error_message + "\tCode: #{error['code']}\n\tMessage: #{error['message']}\n\n"
+			end
+		end
+
+		private_class_method :request, :get_errors_from_response
+	end
+end

data/lib/rublox/util/errors.rb

@@ -1,109 +1,44 @@
-# frozen_string_literal: true
-
-module Rublox
-  # This module contains errors that can be raised by rublox methods.
-  module Errors
-    # Exception raised when a user cannot be found.
-    class UserNotFoundError < StandardError
-      # @return [Integer, "(no ID information provided)"] the given user's ID
-      attr_reader :user_id
-
-      # @return [String, "(no username information provided)"] the given user's
-      #   username
-      attr_reader :user_username
-
-      # @param user_id [Integer]
-      # @param username [String, nil]
-      def initialize(
-        user_id = "(no ID information provided)",
-        username = "(no username information provided)"
-      )
-        @user_id = user_id
-        @user_username = username
-        super("The user of ID #{user_id} and username #{username} could not be found.")
-      end
-    end
-
-    # Exception raised when a group cannot be found.
-    class GroupNotFoundError < StandardError
-      # @return [Integer] the given group's ID
-      attr_reader :group_id
-
-      # @param group_id [Integer]
-      def initialize(group_id)
-        @group_id = group_id
-        super("The group of ID #{group_id} could not be found.")
-      end
-    end
-
-    # Exception raised when a user's presence cannot be found.
-    class PresenceNotFoundError < StandardError
-      # @return [Integer] the presence user's ID
-      attr_reader :user_id
-
-      def initialize(user_id)
-        @user_id = user_id
-        super("The presence of the user with ID #{user_id} could not be found.")
-      end
-    end
-
-    # Exception raised when a user is not part of a group.
-    class MemberNotFoundError < StandardError
-      # @return [Integer] the given user's ID
-      attr_reader :user_id
-
-      # @return [Integer] the given group's ID
-      attr_reader :group_id
-
-      # @param id [Integer]
-      # @param group_id [Integer]
-      def initialize(id, group_id)
-        @user_id = id
-        @group_id = group_id
-        super("The user of ID #{id} is not part of this group of ID #{group_id}")
-      end
-    end
-
-    # Exception raised when a role doesn't exist.
-    class RoleNotFoundError < StandardError
-      # @return [Integer] the given role's ID
-      attr_reader :role_id
-
-      # @return [Integer] the given group's ID
-      attr_reader :group_id
-
-      # @param role_id [Integer]
-      # @param group_id [Integer]
-      def initialize(role_id, group_id)
-        @role_id = role_id
-        @group_id = group_id
-        super("The role of ID #{role_id} does not exist in group of ID #{group_id}.")
-      end
-    end
-
-    # Exception raised when an unhandled status code is returned.
-    class UnhandledStatusCodeError < StandardError
-      # @return [HTTP::Response::Status] the unhandled status code
-      attr_reader :status_code
-
-      # @return [String] a string containing all the errors returned by the API
-      #   neatly formatted
-      attr_reader :errors
-
-      # @param status_code [Integer]
-      # @param errors [String, nil]
-      def initialize(status_code, errors = "")
-        super("Unhandled status code #{status_code}.\nRoblox errors:\n#{errors}")
-        @status_code = status_code
-        @errors = errors
-      end
-    end
-
-    # Exception raised when an invalid .ROBLOSECURITY cookie is used.
-    class InvalidROBLOSECURITYError < StandardError
-      def initialize
-        super("A valid .ROBLOSECURITY cookie needs to be passed to Rublox's constructor for this action.")
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Rublox
+	module Errors
+		# This error is raised when a user couldn't be found
+		class UserNotFoundError < StandardError
+		end
+
+		# This error is raised when a group couldn't be found
+		class GroupNotFoundError < StandardError
+		end
+
+		# This error is raised when one of the provided user IDs are invalid, or if a user ID is repeated
+		class PresenceRequestError < StandardError
+			# @!visibility private
+			def initialize
+				super("An invalid or repeated user ID was provided")
+			end
+		end
+
+		# This error is raised when an error returned by the Roblox API should be dealt by the user
+		class UnhandledStatusCodeError < StandardError
+			# @return [HTTP::Response] the response object
+			attr_reader :response
+			# @return [String] a formatted string of errors returned by the Roblox API
+			attr_reader :errors
+
+			# @!visibility private
+			def initialize(response, errors)
+				super("Unhandled status code #{response.status}.\nRoblox errors:\n#{errors}")
+				@response = response
+				@errors = errors
+			end
+		end
+
+		# This error is raised when a method that requires authenticated is called without a valid .ROBLOSECURITY cookie set
+		class InvalidROBLOSECURITYError < StandardError
+			# @!visibility private
+			def initialize
+				super("A valid .ROBLOSECURITY cookie needs to be passed to Rublox for this action.")
+			end
+		end
+	end
+end