rublox 0.1.0 → 0.2.0

data/lib/rublox/models/presence.rb

@@ -1,98 +1,98 @@
-# 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 "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

data/lib/rublox/util/cache.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-
-module Rublox
-  # @note Only use if you have an use case that the library doesn't cover (and
-  #   create an issue and perhaps we'll implement it!).
-  module Cache
-    # The key for the user cache.
-    USER = :users
-    # The key for the group cache.
-    GROUP = :groups
-    # The key for the page cache.
-    PAGE = :pages
-
-    # @!visiblity private
-    @cache = {
-      users: {},
-      groups: {},
-      pages: {}
-    }
-
-    # Try to get an object from cache.
-    # @param type [Symbol] {USER}, {GROUP} or {PAGE}
-    # @param id [Integer] the ID of the object
-    # @return [FullUser, FullGroup, Pages, nil]
-    def self.get(type, id)
-      @cache[type][id]
-    end
-
-    # Set an object in the cache, under the type's key.
-    # @param type [Symbol] {USER}, {GROUP} or {PAGE}
-    # @param id [Integer] the ID of the object
-    # @param object [FullUser, FullGroup, Pages] the object to be added to the
-    #   cache
-    # @return [nil]
-    def self.set(type, id, object)
-      @cache[type][id] = object
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Rublox
+  # @note Only use if you have an use case that the library doesn't cover (and
+  #   create an issue and perhaps we'll implement it!).
+  module Cache
+    # The key for the user cache.
+    USER = :users
+    # The key for the group cache.
+    GROUP = :groups
+    # The key for the page cache.
+    PAGE = :pages
+
+    # @!visiblity private
+    @cache = {
+      users: {},
+      groups: {},
+      pages: {}
+    }
+
+    # Try to get an object from cache.
+    # @param type [Symbol] {USER}, {GROUP} or {PAGE}
+    # @param id [Integer] the ID of the object
+    # @return [FullUser, FullGroup, Pages, nil]
+    def self.get(type, id)
+      @cache[type][id]
+    end
+
+    # Set an object in the cache, under the type's key.
+    # @param type [Symbol] {USER}, {GROUP} or {PAGE}
+    # @param id [Integer] the ID of the object
+    # @param object [FullUser, FullGroup, Pages] the object to be added to the
+    #   cache
+    # @return [nil]
+    def self.set(type, id, object)
+      @cache[type][id] = object
+    end
+  end
+end

data/lib/rublox/util/errors.rb

@@ -1,109 +1,109 @@
-# 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
+  # 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