rublox 0.1.0 → 0.2.0

data/lib/rublox/models/full_group.rb

@@ -1,60 +1,60 @@
-# frozen_string_literal: true
-
-require "rublox/models/group_shout"
-require "rublox/models/limited_user"
-require "rublox/derive/group"
-
-module Rublox
-  # @note This class is handled internally by the public interface such as
-  #   {Client#group_from_id}. You should not be creating it yourself.
-  # The {FullGroup} class corresponds to a full group response you can get via
-  # https://groups.roblox.com/v1/groups/groupId. You can use it to get information
-  # about groups.
-  #
-  # See {Group} for methods you can call on groups!
-  class FullGroup
-    include Group
-
-    # @return [Integer] the group's ID
-    attr_reader :id
-
-    # @return [String] the group's name
-    attr_reader :name
-
-    # @return [String] the group's description
-    attr_reader :description
-
-    # @return [LimitedUser, nil] the group's owner, can be nil if the group has
-    #   no owner
-    attr_reader :owner
-
-    # @return [GroupShout, nil] the group's shout, can be nil if the group has
-    #   no shout
-    attr_reader :shout
-
-    # @return [Integer] the count of how many members the group has
-    attr_reader :member_count
-
-    # @return [true, false] is the group locked?
-    attr_reader :locked
-
-    # @return [true, false] is the group private/invite only?
-    attr_reader :private
-
-    # @param data [Hash]
-    # @param client [Client]
-    def initialize(data, client)
-      @id = data["id"]
-      @name = data["name"]
-      @description = data["description"]
-      @owner = LimitedUser.new(data["owner"], client) if data["owner"]
-      @shout = GroupShout.new(data["shout"], client, @id) if data["shout"]
-      @member_count = data["memberCount"]
-      # isLocked is only returned if the group is locked, else it is just null (awesome)
-      @locked = !data["isLocked"].nil?
-      @private = data["publicEntryAllowed"]
-
-      @client = client
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/models/group_shout"
+require "rublox/models/limited_user"
+require "rublox/derive/group"
+
+module Rublox
+  # @note This class is handled internally by the public interface such as
+  #   {Client#group_from_id}. You should not be creating it yourself.
+  # The {FullGroup} class corresponds to a full group response you can get via
+  # https://groups.roblox.com/v1/groups/groupId. You can use it to get information
+  # about groups.
+  #
+  # See {Group} for methods you can call on groups!
+  class FullGroup
+    include Group
+
+    # @return [Integer] the group's ID
+    attr_reader :id
+
+    # @return [String] the group's name
+    attr_reader :name
+
+    # @return [String] the group's description
+    attr_reader :description
+
+    # @return [LimitedUser, nil] the group's owner, can be nil if the group has
+    #   no owner
+    attr_reader :owner
+
+    # @return [GroupShout, nil] the group's shout, can be nil if the group has
+    #   no shout
+    attr_reader :shout
+
+    # @return [Integer] the count of how many members the group has
+    attr_reader :member_count
+
+    # @return [true, false] is the group locked?
+    attr_reader :locked
+
+    # @return [true, false] is the group private/invite only?
+    attr_reader :private
+
+    # @param data [Hash]
+    # @param client [Client]
+    def initialize(data, client)
+      @id = data["id"]
+      @name = data["name"]
+      @description = data["description"]
+      @owner = LimitedUser.new(data["owner"], client) if data["owner"]
+      @shout = GroupShout.new(data["shout"], client, @id) if data["shout"]
+      @member_count = data["memberCount"]
+      # isLocked is only returned if the group is locked, else it is just null (awesome)
+      @locked = !data["isLocked"].nil?
+      @private = data["publicEntryAllowed"]
+
+      @client = client
+    end
+  end
+end

data/lib/rublox/models/full_user.rb

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

data/lib/rublox/models/group_member.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-
-module Rublox
-  # @note This class is handled internally by the public interface such as
-  #   such as {Group#member_by_user}. You should not be creating it yourself.
-  # The {GroupMember} class corresponds to a member response, which contains
-  # information about the user, their role and group.
-  class GroupMember
-    # @return [LimitedUser] the user object tied to this member
-    attr_reader :user
-
-    # @return {GroupRole} the role object tied to this member
-    attr_reader :role
-
-    # @return [FullGroup] the group object tied to this member
-    attr_reader :group
-
-    # @param user [FullUser, LimitedUser]
-    # @param role [GroupRole]
-    # @param group [FullGroup]
-    # @param client [Client]
-    def initialize(user, role, group, client)
-      @user = user
-      @role = role
-      @group = group
-      @client = client
-    end
-
-    # @note Use this if you need the state of the member changed. If you only
-    #   want the role's state updated without updating the member's state, use
-    #   {GroupRole#refresh}
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(7384468)
-    #   member = group.member_by_id(1)
-    #   puts member.role.rank # -> 1
-    #   # Assume Roblox now has the Owner role
-    #   updated_member = member.refresh_role
-    #   puts updated_member.role.rank # -> 255
-    # @return [GroupMember] a new {GroupMember} with a new {#role}, if it has been changed.
-    def refresh_role
-      data = @client.http_client.get(
-        URL.endpoint("groups", "/v2/users/#{@user.id}/groups/roles")
-      )["data"].find { |role| role["group"]["id"] == @group.id }
-
-      GroupMember.new(
-        @user,
-        GroupRole.new(data["role"], @group, @client),
-        @group,
-        @client
-      )
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Rublox
+  # @note This class is handled internally by the public interface such as
+  #   such as {Group#member_by_user}. You should not be creating it yourself.
+  # The {GroupMember} class corresponds to a member response, which contains
+  # information about the user, their role and group.
+  class GroupMember
+    # @return [LimitedUser] the user object tied to this member
+    attr_reader :user
+
+    # @return {GroupRole} the role object tied to this member
+    attr_reader :role
+
+    # @return [FullGroup] the group object tied to this member
+    attr_reader :group
+
+    # @param user [FullUser, LimitedUser]
+    # @param role [GroupRole]
+    # @param group [FullGroup]
+    # @param client [Client]
+    def initialize(user, role, group, client)
+      @user = user
+      @role = role
+      @group = group
+      @client = client
+    end
+
+    # @note Use this if you need the state of the member changed. If you only
+    #   want the role's state updated without updating the member's state, use
+    #   {GroupRole#refresh}
+    # @example
+    #   client = Rublox::Client.new
+    #   group = client.group_from_id(7384468)
+    #   member = group.member_by_id(1)
+    #   puts member.role.rank # -> 1
+    #   # Assume Roblox now has the Owner role
+    #   updated_member = member.refresh_role
+    #   puts updated_member.role.rank # -> 255
+    # @return [GroupMember] a new {GroupMember} with a new {#role}, if it has been changed.
+    def refresh_role
+      data = @client.http_client.get(
+        URL.endpoint("groups", "/v2/users/#{@user.id}/groups/roles")
+      )["data"].find { |role| role["group"]["id"] == @group.id }
+
+      GroupMember.new(
+        @user,
+        GroupRole.new(data["role"], @group, @client),
+        @group,
+        @client
+      )
+    end
+  end
+end