rublox 0.2.0 → 0.3.0

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rublox
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Zamdie
-- Keef
+- zmλdie
+- keef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -17,116 +17,99 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.15.2
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.26
-description: This gem allows easy interaction with the Roblox web API via class models.
+        version: 0.9.28
+description: This gem allows easy interaction with the Roblox web API via modules
+  and classes.
 email: rorg.devv@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/rublox.rb
+- lib/rublox/bases/base_group.rb
+- lib/rublox/bases/base_user.rb
 - lib/rublox/derive/group.rb
+- lib/rublox/derive/model.rb
 - lib/rublox/derive/user.rb
 - lib/rublox/models/full_group.rb
 - lib/rublox/models/full_user.rb
-- lib/rublox/models/group_member.rb
-- lib/rublox/models/group_role.rb
 - lib/rublox/models/group_shout.rb
-- lib/rublox/models/limited_user.rb
 - lib/rublox/models/presence.rb
-- lib/rublox/util/cache.rb
+- lib/rublox/models/skinny_user.rb
+- lib/rublox/util/api_helper.rb
 - lib/rublox/util/errors.rb
-- lib/rublox/util/http_client.rb
-- lib/rublox/util/pages.rb
-- lib/rublox/util/url.rb
-- lib/rublox/version.rb
 - rublox.gemspec
 homepage: https://github.com/roblox-api-wrappers/rublox
 licenses:
 - MIT
-metadata: {}
+metadata:
+  Documentation: https://rubydoc.info/gems/rublox
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -135,14 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A Roblox web API wrapper written in Ruby

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "http://rubygems.org"
-ruby ">= 3.0"
-
-gemspec

data/Rakefile

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "rake"
-
-desc "run rubocop"
-task :rubocop do
-  system "rubocop"
-end
-
-desc "run tests"
-task :test do
-  system "ruby -I ./lib ./tests/run_tests.rb"
-end
-
-desc "build docs"
-task :docs do
-  system "yardoc"
-end
-
-desc "build docs, showing private objects"
-task :docs_priv do
-  system "yardoc --private"
-end
-
-desc "open local server to live preview docs"
-task :doc_server do
-  system "yard server --reload"
-end
-
-desc "list all undocumented objects"
-task :list_undoc do
-  system "yard stats --list-undoc"
-end

data/lib/rublox/models/group_member.rb

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

data/lib/rublox/models/group_role.rb

@@ -1,355 +0,0 @@
-# frozen_string_literal: true
-
-require "rublox/util/errors"
-
-module Rublox
-  # This class is used to set a role's permissions. It uses the builder pattern to assign permissions.
-  # @example (see Rublox::RolePermissions#initialize)
-  class RolePermissions # rubocop:disable Metrics/ClassLength
-    # @!visibility private
-    PERMISSIONS = {
-      permissions: {
-        DeleteFromWall: nil,
-        PostToWall: nil,
-        InviteMembers: nil,
-        PostToStatus: nil,
-        RemoveMembers: nil,
-        ViewStatus: nil,
-        ViewWall: nil,
-        ChangeRank: nil,
-        AdvertiseGroup: nil,
-        ManageRelationships: nil,
-        AddGroupPlaces: nil,
-        ViewAuditLogs: nil,
-        CreateItems: nil,
-        ManageItems: nil,
-        SpendGroupFunds: nil,
-        ManageClan: nil,
-        ManageGroupGames: nil,
-        UseCloudAuthentication: nil,
-        AdministerCloudAuthentication: nil
-      }
-    }.freeze
-
-    # Initialize a RolePermissions object from an endpoint's data
-    # @!visibility private
-    # @param data [Hash]
-    # @return [RolePermissions]
-    def self.from_data(data) # rubocop:disable Metrics/AbcSize
-      permissions_data = data["permissions"]
-      group_posts_permissions = permissions_data["groupPostsPermissions"]
-      group_membership_permissions = permissions_data["groupMembershipPermissions"]
-      group_management_permissions = permissions_data["groupManagementPermissions"]
-      group_economy_permissions = permissions_data["groupEconomyPermissions"]
-      # group_open_cloud_permissions = permissions_data["groupOpenCloudPermissions"]
-
-      object = new
-      object._permissions = {
-        permissions: {
-          DeleteFromWall: group_posts_permissions["deleteFromWall"],
-          PostToWall: group_posts_permissions["postToWall"],
-          InviteMembers: group_membership_permissions["inviteMembers"],
-          PostToStatus: group_posts_permissions["postToStatus"],
-          RemoveMembers: group_membership_permissions["removeMembers"],
-          ViewStatus: group_posts_permissions["viewStatus"],
-          ViewWall: group_posts_permissions["viewWall"],
-          ChangeRank: group_membership_permissions["changeRank"],
-          AdvertiseGroup: group_economy_permissions["advertiseGroup"],
-          ManageRelationships: group_management_permissions["manageRelationships"],
-          AddGroupPlaces: group_economy_permissions["addGroupPlaces"],
-          ViewAuditLogs: group_management_permissions["viewAuditLogs"],
-          CreateItems: group_economy_permissions["createItems"],
-          ManageItems: group_economy_permissions["manageItems"],
-          SpendGroupFunds: group_economy_permissions["spendGroupFunds"],
-          ManageClan: group_management_permissions["manageClan"],
-          ManageGroupGames: group_economy_permissions["manageGroupGames"]
-          # UseCloudAuthentication: group_open_cloud_permissions["useCloudAuthentication"],
-          # AdministerCloudAuthentication: group_open_cloud_permissions["administerCloudAuthentication"]
-        }
-      }
-
-      object
-    end
-
-    # @example
-    #   # give permissions to view and delete messages from the group wall
-    #   role_permissions = Rublox::RolePermissions.new
-    #     .view_wall
-    #     .delete_from_wall
-    def initialize
-      @permissions = PERMISSIONS.clone
-    end
-
-    # Private getter for permissions
-    # @!visibility private
-    # @return [Hash]
-    def _permissions
-      @permissions
-    end
-
-    # Private setter for permissions
-    # @!visibility private
-    # @return [nil]
-    def _permissions=(value)
-      @permissions = value
-    end
-
-    # Allow members with the role to view the group wall
-    # @return [RolePermissions]
-    def delete_from_wall
-      @permissions[:permissions][:DeleteFromWall] = true
-      self
-    end
-
-    # Allow members with the role to invite members
-    # @return [RolePermissions]
-    def invite_members
-      @permissions[:permissions][:InviteMembers] = true
-      self
-    end
-
-    # Allow members with the role to post to the group's status
-    # @return [RolePermissions]
-    def post_to_status
-      @permissions[:permissions][:PostToStatus] = true
-      self
-    end
-
-    # Allow members with the role to remove members
-    # @return [RolePermissions]
-    def remove_members
-      @permissions[:permissions][:RemoveMembers] = true
-      self
-    end
-
-    # Allow members with the role to view the group's status
-    # @return [RolePermissions]
-    def view_status
-      @permissions[:permissions][:ViewStatus] = true
-      self
-    end
-
-    # Allow members with the role to view the group's wall
-    # @return [RolePermissions]
-    def view_wall
-      @permissions[:permissions][:ViewWall] = true
-      self
-    end
-
-    # Allow members with the role to change the rank of other members
-    # @return [RolePermissions]
-    def change_rank
-      @permissions[:permissions][:ChangeRank] = true
-      self
-    end
-
-    # Allow members with the role to advertise the group
-    # @return [RolePermissions]
-    def advertise_group
-      @permissions[:permissions][:AdvertiseGroup] = true
-      self
-    end
-
-    # Allow members with the role to manage the group's relationships with other groups
-    # @return [RolePermissions]
-    def manage_relationships
-      @permissions[:permissions][:ManageRelationships] = true
-      self
-    end
-
-    # Allow members with the role to create group places
-    # @return [RolePermissions]
-    def add_group_places
-      @permissions[:permissions][:AddGroupPlaces] = true
-      self
-    end
-
-    # Allow members with the role to view audit logs
-    # @return [RolePermissions]
-    def view_audit_logs
-      @permissions[:permissions][:ViewAuditLogs] = true
-      self
-    end
-
-    # Allow members with the role to create items
-    # @return [RolePermissions]
-    def create_items
-      @permissions[:permissions][:ViewStatus] = true
-      self
-    end
-
-    # Allow members with the role to manage items
-    # @return [RolePermissions]
-    def manage_items
-      @permissions[:permissions][:ViewStatus] = true
-      self
-    end
-
-    # Allow members with the role to spend group funds
-    # @return [RolePermissions]
-    def spend_group_funds
-      @permissions[:permissions][:SpendGroupFunds] = true
-      self
-    end
-
-    # Allow members with the role to manage the clan
-    # @return [RolePermissions]
-    def manage_clan
-      @permissions[:permissions][:ManageClan] = true
-      self
-    end
-
-    # Allow members with the role to manage group games
-    # @return [RolePermissions]
-    def manage_group_games
-      @permissions[:permissions][:ManageGroupGames] = true
-      self
-    end
-
-    # @!visibility private
-    # @todo find out what this does (open cloud?)
-    # @return [RolePermissions]
-    def use_cloud_authentication
-      @permissions[:permissions][:UseCloudAuthentication] = true
-      self
-    end
-
-    # (see #use_cloud_authentication)
-    def administer_cloud_authentication
-      @permissions[:permissions][:AdministerCloudAuthentication] = true
-      self
-    end
-  end
-
-  # @note This class is handled internally by the public interface such as
-  #   {Group#roles}. You should not be creating it yourself.
-  # The {GroupRole} class corresponds to a group's role. You can use it to get
-  # and set information about roles.
-  class GroupRole
-    # @return [Integer] the role's ID
-    attr_reader :id
-
-    # @return [String] the role's name
-    attr_reader :name
-
-    # @return [String, nil] the role's description. Can be nil if the authenticated
-    #   user does not have access to the group's role settings.
-    attr_reader :description
-
-    # @return [Integer] the role's rank (0-255)
-    attr_reader :rank
-
-    # @return [Integer] the count of how many users have the role
-    attr_reader :member_count
-
-    # @return [Group] the group tied to this role
-    attr_reader :group
-
-    # @param data [Hash]
-    # @param group [FullGroup]
-    # @param client [Client]
-    def initialize(data, group, client)
-      @id = data["id"]
-      @name = data["name"]
-      @description = data["description"]
-      @rank = data["rank"]
-      @member_count = data["memberCount"]
-      @group = group
-
-      @client = client
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   client.group_from_id(7384468)
-    #   role = client
-    #     .group_from_id(7384468)
-    #     .member_by_id(1)
-    #     .role
-    #   puts role.rank # -> 1
-    #   # Assume Roblox now has the Owner role
-    #   updated_role = role.refresh
-    #   puts updated_role.rank # -> 255
-    # @return [GroupRole] a mirrored {GroupRole} object, containing new information
-    #   about the role if it has been changed.
-    def refresh
-      data = @client.http_client.get(
-        URL.endpoint("groups", "/v1/groups/#{@group.id}/roles")
-      )["roles"].find { |role| role["id"] == @id }
-      raise Errors::RoleNotFoundError.new(@id, @group.id) unless data
-
-      GroupRole.new(
-        data,
-        @group,
-        @client
-      )
-    end
-
-    # Change the role's permissions
-    # @example
-    #   client = Rublox::Client.new("COOKIE")
-    #   permissions = Rublox::RolePermissions.new
-    #     .manage_items
-    #     .create_items
-    #
-    #   role = client
-    #     .group_from_id(1)
-    #     .member_by_id(1)
-    #     .role
-    #   role.change_permissions(permissions)
-    # @param permissions [RolePermissions]
-    # @return [nil]
-    def change_permissions(permissions)
-      @client.http_client.patch(
-        URL.endpoint("groups", "v1/groups/#{@group.id}/roles/#{@id}/permissions"),
-        json: permissions._permisions
-      )
-
-      nil
-    end
-
-    # Get the role's permissions
-    # @example
-    #   client = Rublox::Client.new("COOKIE")
-    #
-    #   role = client
-    #     .group_from_id(1)
-    #     .member_by_id(1)
-    #     .role
-    #   permissions = role.permissions
-    # @return [RolePermissions]
-    def permissions
-      RolePermissions.from_data(
-        @client.http_client.get(
-          URL.endpoint("groups", "v1/groups/#{@group.id}/roles/#{@id}/permissions")
-        )
-      )
-    end
-
-    # Edit the role's information
-    # @example
-    #   role = client
-    #     .group_from_id(1)
-    #     .member_by_id(1)
-    #     .role
-    #
-    #   role.edit(name: "cool epic name", rank: 255)
-    #   role.edit(name: "some better name", description: "cool role")
-    # @param name [String, nil]
-    # @param description [String, nil]
-    # @param rank [Integer, nil]
-    # @return [nil]
-    def edit(name: nil, description: nil, rank: nil)
-      @client.http_client.patch(
-        URL.endpoint("groups", "v1/groups/#{@group.id}/rolesets/#{@id}"),
-        json: {
-          name: name || @name,
-          description: description || @description,
-          rank: rank || @rank
-        }
-      )
-
-      nil
-    end
-  end
-end

data/lib/rublox/models/limited_user.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require "time"
-
-require "rublox/derive/user"
-
-module Rublox
-  # @note This class is handled internally by the public interface such as
-  #   {FullGroup#owner}. You should not be creating it yourself.
-  # The {LimitedUser} is an user containing less information. It exists as some
-  # API's do not return full user information, and I decided to not send extra
-  # requests. You can call {#refresh} to get a {FullUser} if needed.
-  class LimitedUser
-    include User
-
-    # (see FullUser#id)
-    attr_reader :id
-
-    # (see FullUser#username)
-    attr_reader :username
-
-    # (see FullUser#display_name)
-    attr_reader :display_name
-
-    # (see FullUser#initialize)
-    def initialize(data, client)
-      @id = data["id"] || data["userId"] || data["builderId"]
-      @username = data["name"] || data["username"] || data["builder"]
-      @display_name = data["displayName"] || data["DisplayName"]
-
-      @client = client
-    end
-  end
-end

data/lib/rublox/util/cache.rb

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