rublox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1d91f1dc37df6df866bdf110705af8a5f78e68748edd2d577ff44de821e0f7
-  data.tar.gz: c91696dacf025936ce517ffdcca4cae5672856bcd46822b04f28c002bc5eb0e5
+  metadata.gz: 1fe191ff9c3e921f2a1c0f00ccdf523b5aabc191eb78549f3838da2232950408
+  data.tar.gz: 1fda6fca724bbff7f182f39a7f7731f3a3e71014a5d6c421d74e604a14a8814d
 SHA512:
-  metadata.gz: db8304263e8be041a5fb44b6c090240014c5473c84088d72b7c881b0c40abad7134d6f5dec7842b1d7a767655db833a193d4c8c79d5f0486c9a06d59748ea175
-  data.tar.gz: a32d33986c09589f38f95f9e91b8f4746b4236fea4263aabbb41af8fc63f6d717e865d21d02755b1a578c2673a45cf4f5a22fda4f3f8fb13b6fd659856fd4a6f
+  metadata.gz: 99cd4156f683cdfa1743c4fb28f6264636df0708d5c7a0b9050ae30285222385eba0aa5a144438b5ccdad29a751b41af9c178ae542862649bc8cc44d86ccfe73
+  data.tar.gz: 5ea680e0d48a0c46f3fc247f113881146d2f60e12c9d8bb5adb7d4f53052d051fc8b871476fcda5e4f73398f872b68a9bb557337b45a279a986e4ba74b32666f

data/Gemfile

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

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,68 @@
-<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>
+
+  <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.2.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.

data/Rakefile

@@ -1,33 +1,33 @@
-# 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
+# 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/derive/group.rb

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

data/lib/rublox/derive/user.rb

@@ -1,89 +1,89 @@
-# 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/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 the user 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