rublox 0.1.0 → 0.3.0

data/lib/rublox.rb

@@ -1,136 +1,89 @@
-# frozen_string_literal: true
-
-require "http"
-
-require "rublox/version"
-require "rublox/util/http_client"
-require "rublox/util/cache"
-require "rublox/models/full_user"
-require "rublox/models/full_group"
-require "rublox/models/presence"
-
-# rublox is a Roblox web API wrapper written in Ruby. It aims to provide an
-# object oriented interface to get and modify data from Roblox's web API.
-#
-# Repository: https://github.com/roblox-api-wrappers/rublox
-#
-# Docs: https://rubydoc.info/gems/rublox
-module Rublox
-  # The {Client} object is the gateway to the API. Tt supplies methods that
-  # return classes modeled after the interactions you can do with the API.
-  #
-  # Initialize the client with a .ROBLOSECURITY cookie if you need functionality
-  # that requires it.
-  # @example
-  #   require "rublox"
-  #   # without a cookie
-  #   client = Rublox::Client.new
-  #   # with a cookie
-  #   client = Rublox::Client.new("_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this ...")
-  class Client
-    # @note The HTTP client should only be used when there are no methods
-    #   provided by the library to achieve what you want.
-    # @return [HTTPClient]
-    attr_reader :http_client
-
-    # Initialize the client with a .ROBLOSECURITY cookie if you require functionality
-    # that needs it.
-    # @example
-    #   require "rublox"
-    #   # without a cookie
-    #   client = Rublox::Client.new
-    #   # with a cookie
-    #   client = Rublox::Client.new("_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this ...")
-    # @param roblosecurity [String, nil] a valid .ROBLOSECURITY cookie
-    def initialize(roblosecurity = "")
-      @http_client = HTTPClient.new(roblosecurity)
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.username # -> Roblox
-    # @param id [Integer] the user's ID
-    # @return [FullUser] a model of the user specified by the ID
-    def user_from_id(id)
-      user = Cache.get(Cache::USER, id)
-      return user if user
-
-      data = @http_client.get(
-        URL.endpoint("users", "v1/users/#{id}")
-      )
-    rescue Errors::UnhandledStatusCodeError
-      raise Errors::UserNotFoundError, id
-    else
-      user = FullUser.new(
-        data,
-        self
-      )
-      Cache.set(Cache::USER, id, user)
-
-      user
-    end
-
-    # @note This method sends 2 requests, use {#user_from_id} if possible.
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_username("Roblox")
-    #   puts user.id # -> 1
-    # @param username [String] the user's username
-    # @return [FullUser] a model of the user specified by the ID
-    def user_from_username(username)
-      data = @http_client.post(
-        URL.endpoint("users", "/v1/usernames/users"),
-        json: {
-          usernames: [username],
-          excludeBannedUsers: false
-        }
-      )["data"]
-      raise Errors::UserNotFoundError.new(nil, username) if data.empty?
-
-      user_from_id(
-        data[0]["id"]
-      )
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(1)
-    #   puts group.name # -> RobloHunks
-    # @param id [Integer] the groups's ID
-    # @return [FullGroup] a model of the group specified by the ID
-    def group_from_id(id)
-      group = Cache.get(Cache::GROUP, id)
-      return group if group
-
-      data = @http_client.get(
-        URL.endpoint("groups", "v1/groups/#{id}")
-      )
-    rescue Errors::UnhandledStatusCodeError
-      raise Errors::GroupNotFoundError, id
-    else
-      group = FullGroup.new(data, self)
-      Cache.set(Cache::GROUP, id, group)
-
-      group
-    end
-
-    # @param id [Integer] the user's ID
-    # @return [Presence] a model of the presence specified by the user's ID
-    def user_presence_from_id(id)
-      data = http_client.post(
-        URL.endpoint("presence", "v1/presence/users"),
-        json: {
-          userIds: [id]
-        }
-      )
-    rescue Errors::UnhandledStatusCodeError
-      raise Errors::PresenceNotFoundError, id
-    else
-      Presence.new(
-        data["userPresences"][0],
-        self
-      )
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/util/api_helper"
+require "rublox/util/errors"
+require "rublox/models/full_user"
+require "rublox/models/skinny_user"
+require "rublox/models/presence"
+require "rublox/bases/base_user"
+require "rublox/bases/base_group"
+
+# rublox is a Roblox web API wrapper written in Ruby. It aims to provide an
+# object oriented interface to get and modify data from Roblox's web API.
+# Docs: https://rubydoc.info/gems/rublox
+module Rublox
+	# Sets the .ROBLOSECURITY cookie to send authenticated requests
+	def self.roblosecurity=(roblosecurity)
+		APIHelper.roblosecurity = roblosecurity
+	end
+
+	# Returns the current authenticated user
+	def self.authenticated_user
+		Models::SkinnyUser.new(APIHelper.get("https://users.roblox.com/v1/users/authenticated"))
+	end
+
+	# Returns a BaseUser
+	def self.base_user(id)
+		Bases::BaseUser.new(id)
+	end
+
+	# Returns a user
+	def self.user_from_id(id)
+		Models::FullUser.new(APIHelper.get("https://users.roblox.com/v1/users/#{id}"))
+	rescue Errors::UnhandledStatusCodeError => e
+		raise Errors::UserNotFoundError, cause: nil if e.response.status == 404
+
+		raise
+	end
+
+	def self.users_from_ids(ids, exclude_banned_users: false)
+		APIHelper.post(
+			"https://users.roblox.com/v1/users",
+			json: {
+				userIds: ids,
+				excludeBannedUsers: exclude_banned_users
+			}
+		)["data"].map { |data| Models::SkinnyUser.new(data) }
+	end
+
+	def self.users_from_usernames(usernames, exclude_banned_users: false)
+		APIHelper.post(
+			"https://users.roblox.com/v1/usernames/users",
+			json: {
+				usernames: usernames,
+				excludeBannedUsers: exclude_banned_users
+			}
+		)["data"].map { |data| Models::SkinnyUser.new(data) }
+	end
+
+	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
+
+	def self.base_group(id)
+		Bases::BaseGroup.new(id)
+	end
+
+	def self.group_from_id(id)
+		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
+
+	def self.user_presences_from_ids(ids)
+		APIHelper.post(
+			"https://presence.roblox.com/v1/presence/users",
+			json: { userIds: ids }
+		)["userPresences"].map { |data| Models::Presence.new(data) }
+	rescue Errors::UnhandledStatusCodeError => e
+		raise Errors::PresenceRequestError, cause: nil if e.response.status == 400
+
+		raise
+	end
+
+	def self.user_presence_from_id(id)
+		user_presences_from_ids([id])[0]
+	end
+end

data/rublox.gemspec

@@ -1,32 +1,30 @@
-# frozen_string_literal: true
-
-require_relative "lib/rublox/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rublox"
-  spec.version = Rublox::VERSION
-  spec.authors = %w[Zamdie Keef]
-  spec.email = "rorg.devv@gmail.com"
-  spec.summary = "A Roblox web API wrapper written in Ruby"
-  spec.description = "This gem allows easy interaction with the Roblox web API via class models."
-  spec.homepage = "https://github.com/roblox-api-wrappers/rublox"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
-  spec.files = Dir[
-      "LICENSE",
-      "CHANGELOG.MD",
-      "lib/**/*.rb",
-      "rublox.gemspec",
-      "Gemfile",
-      "Rakefile"
-  ]
-  spec.extra_rdoc_files = ["README.MD"]
-
-  spec.add_dependency "http", "~> 5.0.2"
-
-  spec.add_development_dependency "dotenv", "~> 2.7"
-  spec.add_development_dependency "rake", "~> 13.0.6"
-  spec.add_development_dependency "rubocop", "~> 1.21.0"
-  spec.add_development_dependency "rubocop-performance", "~> 1.11.5"
-  spec.add_development_dependency "yard", "~> 0.9.26"
-end
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+	spec.name = "rublox"
+	spec.version = "0.3.0"
+	spec.authors = %w[zmλdie keef]
+	spec.email = "rorg.devv@gmail.com"
+	spec.summary = "A Roblox web API wrapper written in Ruby"
+	spec.description = "This gem allows easy interaction with the Roblox web API via modules and classes."
+	spec.homepage = "https://github.com/roblox-api-wrappers/rublox"
+	spec.metadata = {
+		"Documentation" => "https://rubydoc.info/gems/rublox",
+		"rubygems_mfa_required" => "true"
+	}
+	spec.license = "MIT"
+	spec.required_ruby_version = ">= 2.7.0"
+	spec.files = Dir[
+		"README.md",
+		"LICENSE",
+		"lib/**/*.rb",
+		"rublox.gemspec"
+	]
+
+	spec.add_dependency "http", "~> 5.1.1"
+
+	spec.add_development_dependency "rubocop", "~> 1.44.1"
+	spec.add_development_dependency "rubocop-performance", "~> 1.15.2"
+	spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
+	spec.add_development_dependency "yard", "~> 0.9.28"
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rublox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Zamdie
-- Keef
+- zmλdie
+- keef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -17,117 +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:
-- CHANGELOG.MD
-- Gemfile
 - LICENSE
-- README.MD
-- Rakefile
+- README.md
 - 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:
@@ -136,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.15
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A Roblox web API wrapper written in Ruby

data/CHANGELOG.MD

@@ -1,4 +0,0 @@
-# 0.1.0 (9th October, 2021)
-
--   Initial repository and package setup
--   User, group, presence, group member and group role APIs added

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,70 +0,0 @@
-# frozen_string_literal: true
-
-require "rublox/util/Errors"
-
-module Rublox
-  # @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
-  end
-end