rublox 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1d91f1dc37df6df866bdf110705af8a5f78e68748edd2d577ff44de821e0f7
-  data.tar.gz: c91696dacf025936ce517ffdcca4cae5672856bcd46822b04f28c002bc5eb0e5
+  metadata.gz: ca58ae27999a8a9d6dad08937ce3167d34163e903571912c47da20cd19c1814a
+  data.tar.gz: 6116e15392c612305c88425a84d737a867bf6531d36022354f4d410147987837
 SHA512:
-  metadata.gz: db8304263e8be041a5fb44b6c090240014c5473c84088d72b7c881b0c40abad7134d6f5dec7842b1d7a767655db833a193d4c8c79d5f0486c9a06d59748ea175
-  data.tar.gz: a32d33986c09589f38f95f9e91b8f4746b4236fea4263aabbb41af8fc63f6d717e865d21d02755b1a578c2673a45cf4f5a22fda4f3f8fb13b6fd659856fd4a6f
+  metadata.gz: 353887d40de73fdb4926837cdfc5209e310db9a9bd323283f288ed312e709e71425133f556f734badd7a54429fbff8fd8acc066fe00dc5701a72ca5c0491bc18
+  data.tar.gz: 03bbc4ff1011eda5b039c7dcdd9dafcbec8c3f20ae6c462e6e817dcd3b5e2abe849fd2a318ed6d92e7ff542e882aa4b5647e5070430e80b34ade740631b77631

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Roblox API wrappers
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Roblox API wrappers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/{README.MD → README.md}

@@ -1,68 +1,58 @@
-<div align="center">
-  <img src="https://raw.githubusercontent.com/roblox-api-wrappers/.github/main/res/rublox_logo.png" alt="rublox" width="15%" height="15%"/>
-</div>
-
-<br>
-
-<div align="center">
-  <a href="https://rubygems.org/gems/rublox">
-    <img alt="gem" src="https://img.shields.io/gem/dt/rublox?color=rgb%28170%2C%200%2C%200%29&logo=rubygems&style=flat-square">
-  </a>
-
-  <a href="https://rubygems.org/gems/rublox">
-    <img alt="gem version" src="https://img.shields.io/gem/v/rublox?color=rgb%28170%2C%200%2C%200%29&label=gem%20version&logo=rubygems&style=flat-square">
-  </a>
-
-  <a href="https://github.com/roblox-api-wrappers/rublox/blob/main/LICENSE">
-    <img alt="license: MIT" src="https://img.shields.io/github/license/roblox-api-wrappers/rublox?color=rgb%28150%2C%200%2C%200%29&logo=github&style=flat-square">
-  </a>
-
-  <img alt="commit activity" src="https://img.shields.io/github/commit-activity/m/roblox-api-wrappers/rublox?color=rgb%28170%2C%200%2C%200%29&logo=github&style=flat-square">
-
-  <img alt="repo stars" src="https://img.shields.io/github/stars/roblox-api-wrappers/rublox?color=rgb%28170%2C%200%2C%200%29&logo=github&style=flat-square">
-
-  <a href="https://rubydoc.info/gems/rublox">
-    <img alt="docs" src="https://img.shields.io/badge/docs-rubydoc.info-aa0000?style=flat-square">
-  </a>
-
-  <a href="https://guilded.gg/roblox-api-wrappers">
-    <img alt="support server" src="https://img.shields.io/badge/guilded-support%20server-aa0000.svg?style=flat-square&logo=guilded">
-  </a>
-</div>
-
-<div align="center"> <i>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. </i> </div>
-
-<br>
-
-# Installation
-
-Include rublox in your application's `Gemfile`
-
-```ruby
-gem "rublox", "~> 0.1.0"
-```
-
-or run
-
-> $ gem install rublox
-
-on your terminal.
-
-# Getting started
-
-The gateway to the API is the [Rublox::Client](https://rubydoc.info/gems/rublox/Rublox/Client) object. You can initialize it with your _.ROBLOSECURITY_ cookie if you need functionality that needs it.
-
-```ruby
-# Without a cookie
-client = Rublox::Client.new
-# With a cookie
-client = Rublox::Client.new("_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this ...")
-```
-
-**(if you open-source/work with other people on your application, it is recommended to keep your cookie in a `.env` file and load it with a library like [dotenv](https://rubygems.org/gems/dotenv))**
-
-From there, you can build off your application's logic with methods provided via [Rublox::Client](https://rubydoc.info/gems/rublox/Rublox/Client)
-
-# Documentation
-
-You can access the documentation at https://rubydoc.info/gems/rublox.
+<div align="center">
+  <img src="https://raw.githubusercontent.com/roblox-api-wrappers/.github/main/res/rublox_logo.png" alt="rublox" width="15%" height="15%"/>
+</div>
+
+<br>
+
+<div align="center">
+  <a href="https://rubygems.org/gems/rublox">
+    <img alt="gem" src="https://img.shields.io/gem/dt/rublox?color=rgb%28170%2C%200%2C%200%29&logo=rubygems&style=flat-square">
+  </a>
+
+  <a href="https://rubygems.org/gems/rublox">
+    <img alt="gem version" src="https://img.shields.io/gem/v/rublox?color=rgb%28170%2C%200%2C%200%29&label=gem%20version&logo=rubygems&style=flat-square">
+  </a>
+
+  <a href="https://github.com/roblox-api-wrappers/rublox/blob/main/LICENSE">
+    <img alt="license: MIT" src="https://img.shields.io/github/license/roblox-api-wrappers/rublox?color=rgb%28150%2C%200%2C%200%29&logo=github&style=flat-square">
+  </a>
+
+  <img alt="commit activity" src="https://img.shields.io/github/commit-activity/m/roblox-api-wrappers/rublox?color=rgb%28170%2C%200%2C%200%29&logo=github&style=flat-square">
+
+  <img alt="repo stars" src="https://img.shields.io/github/stars/roblox-api-wrappers/rublox?color=rgb%28170%2C%200%2C%200%29&logo=github&style=flat-square">
+
+  <a href="https://rubydoc.info/gems/rublox">
+    <img alt="docs" src="https://img.shields.io/badge/docs-rubydoc.info-aa0000?style=flat-square">
+  </a>
+</div>
+
+<div align="center"> <i>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. </i> </div>
+
+<br>
+
+# Getting Started
+
+Authentication can be done by setting the .ROBLOSECURITY cookie through `Rublox.roblosecurity=`
+```ruby
+require "rublox"
+
+Rublox.roblosecurity = "cookie"
+
+require "dotenv"
+Dotenv.load
+
+Rublox.roblosecurity = ENV["ROBLOSECURITY"]
+```
+
+All classes representing the Roblox API models should not be initialised by the user. Instead, they are all made through methods in modules and classes.
+Models can be found by searching through classes:
+
+![](https://cdn.discordapp.com/attachments/827652175609856053/1070881521348653056/image.png)
+
+And methods for getting the corresponding model can be found by searching through methods:
+
+![](https://cdn.discordapp.com/attachments/827652175609856053/1070881991093919794/image.png)
+
+# Documentation
+
+You can access the documentation at https://rubydoc.info/gems/rublox.

data/lib/rublox/bases/base_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rublox/derive/group"
+
+module Rublox
+	module Bases
+		class BaseGroup
+			include Derive::Group
+
+			# @return [Integer]
+			attr_reader :id
+
+			# @!visibility private
+			def initialize(id)
+				@id = id
+			end
+		end
+	end
+end

data/lib/rublox/bases/base_user.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rublox/derive/user"
+
+module Rublox
+	module Bases
+		class BaseUser
+			include Derive::User
+
+			# @return [Integer]
+			attr_reader :id
+
+			# @!visibility private
+			def initialize(id)
+				@id = id
+			end
+		end
+	end
+end

data/lib/rublox/derive/group.rb

@@ -1,50 +1,33 @@
-# frozen_string_literal: true
-
-require "rublox/models/group_member"
-require "rublox/models/group_role"
-
-module Rublox
-  # This mixin module contains functions that can be called on group objects.
-  # @abstract
-  module Group
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(1)
-    #   group.roles.each { |role| puts role.rank } # 0, 1, 180, 100, 254, 255
-    # @return [Array<GroupRole>] the group's roles
-    def roles
-      @client.http_client.get(
-        URL.endpoint("groups", "v1/groups/#{@id}/roles")
-      )["roles"].map { |role| GroupRole.new(role, self, @client) }
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(7384468)
-    #   member = group.member_by_id(1)
-    #   puts member.role.rank # -> 1
-    # @param id [Integer] the user's ID
-    # @return [GroupMember] the user as a group member object
-    def member_by_id(id)
-      member_by_user(@client.user_from_id(id))
-    rescue Errors::UserNotFoundError
-      raise Errors::MemberNotFoundError.new(id, @id)
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(7384468)
-    #   owner_member = group.member_by_user(group.owner)
-    #   puts owner_member.role.rank # -> 255
-    # @param user [FullUser, LimitedUser] the user to tie to the group member
-    # @return [GroupMember] the user as a group member object
-    def member_by_user(user)
-      data = @client.http_client.get(
-        URL.endpoint("groups", "v2/users/#{user.id}/groups/roles")
-      )["data"].find { |member_data| member_data["group"]["id"] == @id }
-      raise Errors::MemberNotFoundError.new(user.id, @id) unless data
-
-      GroupMember.new(user, GroupRole.new(data["role"], self, @client), self, @client)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/models/group_shout"
+require "rublox/util/api_helper"
+
+module Rublox
+	module Derive
+		module Group
+			# @return [Models::GroupShout] the new group shout
+			def update_shout(message)
+				Models::GroupShout.new(APIHelper.patch(
+					"https://groups.roblox.com/v1/groups/#{@id}/status",
+					json: { message: message }
+				))
+			end
+
+			def accept_join_request(user_id)
+				APIHelper.post("https://groups.roblox.com/v1/groups/#{@id}/join-requests/users/#{user_id}")
+				nil
+			end
+
+			def decline_join_request(user_id)
+				APIHelper.delete("https://groups.roblox.com/v1/groups/#{@id}/join-requests/users/#{user_id}")
+				nil
+			end
+
+			def kick(user_id)
+				APIHelper.delete("https://groups.roblox.com/v1/groups/#{@id}/users/#{user_id}")
+				nil
+			end
+		end
+	end
+end

data/lib/rublox/derive/model.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rublox
+	module Derive
+		module Model
+			# @return [String]
+			def to_s
+				"#<#{self.class} of ID #{@id}>"
+			end
+
+			# @return [Boolean]
+			def ==(other)
+				@id == other.id
+			end
+		end
+	end
+end

data/lib/rublox/derive/user.rb

@@ -1,89 +1,43 @@
-# frozen_string_literal: true
-
-require "rublox/util/url"
-
-module Rublox
-  # This mixin module contains functions that can be called on user objects.
-  # @abstract
-  module User
-    # @example Updating a {FullUser}
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.display_name # -> Roblox
-    #   # suppose the Roblox account changes it's display name to "ABC"
-    #   refreshed_user = user.refresh
-    #   puts refreshed_user.display_name # -> ABC
-    # @example Updating a {LimitedUser}
-    #   client = Rublox::Client.new
-    #   group = client.group_from_id(1)
-    #   # say we want the user's join date. LimitedUsers do not contain that information, so we can update it to get a
-    #   # FullUser, which has that
-    #   the_full_user_owner = group.owner.refresh
-    #   # we can now get the owner's join date
-    #   puts the_full_user_owner.join_date.inspect # "2008-09-30 15:54:26 UTC"
-    # @return [FullUser] a mirrored {FullUser} object, containing new information
-    #   about theuser if it has been changed, or if the user is a {LimitedUser}.
-    def refresh
-      @client.user_from_id(@id)
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.friend_count # -> 0
-    # @return [Integer] the count of how many friends the user has
-    def friend_count
-      @client.http_client.get(
-        URL.endpoint("friends", "/v1/users/#{@id}/friends/count")
-      )["count"]
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.follower_count # -> around 6 million
-    # @return [Integer] the count of how many followers the user has
-    def follower_count
-      @client.http_client.get(
-        URL.endpoint("friends", "/v1/users/#{@id}/followers/count")
-      )["count"]
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.followings_count # -> 0
-    # @return [Integer] the count of how many users the user has followed
-    def followings_count
-      @client.http_client.get(
-        URL.endpoint("friends", "/v1/users/#{@id}/followings/count")
-      )["count"]
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   puts user.status # -> "Welcome to Roblox, the Imagination Platform. Make friends, explore, and play games!"
-    # @return [String] the user's status
-    def status
-      @client.http_client.get(
-        URL.endpoint("users", "/v1/users/#{@id}/status")
-      )["status"]
-    end
-
-    # @example
-    #   client = Rublox::Client.new
-    #   user = client.user_from_id(1)
-    #   presence = user.presence
-    #   puts presence.last_location # -> "Website"
-    # @return [Presence] the presence state of the user
-    def presence
-      @client.user_presence_from_id(@id)
-    end
-
-    # @return [String] a readable string representation of the user
-    def to_s
-      "User of ID #{@id}, username: #{@username}"
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rublox/util/api_helper"
+require "rublox/derive/model"
+
+module Rublox
+	module Derive
+		module User
+			include Model
+
+			# @return [Number] the amount of robux the current authenticated user has
+			def currency
+				APIHelper.get("https://economy.roblox.com/v1/users/#{@id}/currency")["robux"]
+			end
+
+			# @return [Boolean]
+			def premium?
+				APIHelper.get("https://premiumfeatures.roblox.com/v1/users/#{@id}/validate-membership")
+			end
+
+			# @return [Integer]
+			def friend_count
+				get_generic_count "friends"
+			end
+
+			# @return [Integer]
+			def follower_count
+				get_generic_count "followers"
+			end
+
+			# @return [Integer]
+			def followings_count
+				get_generic_count "followings"
+			end
+
+			private
+
+			def get_generic_count(channel)
+				APIHelper.get("https://friends.roblox.com/v1/users/#{@id}/#{channel}/count")["count"]
+			end
+		end
+	end
+end

data/lib/rublox/models/full_group.rb

@@ -1,60 +1,55 @@
-# 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/derive/group"
+require "rublox/models/skinny_user"
+require "rublox/models/group_shout"
+
+module Rublox
+	module Models
+		class FullGroup
+			include Derive::Group
+
+			# @return [Integer]
+			attr_reader :id
+			# @return [String]
+			attr_reader :name
+			# @return [String]
+			attr_reader :description
+			# @return [SkinnyUser]
+			attr_reader :owner
+			# @return [GroupShout]
+			attr_reader :shout
+			# @return [Integer]
+			attr_reader :member_count
+			# @return [Boolean]
+			attr_reader :is_builders_club_only
+			# @return [Boolean]
+			attr_reader :public_entry_allowed
+			# @return [Boolean]
+			attr_reader :is_locked
+			# @return [Boolean]
+			attr_reader :has_verified_badge
+
+			# @!visibility private
+			def initialize(data)
+				owner_data = data["owner"]
+				shout_data = data["shout"]
+				@id = data["id"]
+				@name = data["name"]
+				@description = data["description"]
+				@owner = SkinnyUser.new(owner_data) if owner_data
+				@shout = GroupShout.new(shout_data) if shout_data
+				@member_count = data["memberCount"]
+				@is_builders_club_only = data["isBuildersClubOnly"]
+				@public_entry_allowed = data["publicEntryAllowed"]
+				@is_locked = !data["isLocked"].nil?
+				@has_verified_badge = data["hasVerifiedBadge"]
+			end
+
+			# Updates the group shout and sets {#shout} to the new group shout
+			def update_shout!(message)
+				@shout = update_shout(message)
+			end
+		end
+	end
+end