polytoriarb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 296157b168c77954001a5a0e290482ea166e42ec5a1827588bd5aa091de3df47
+  data.tar.gz: b800732536b0440c642be3bcde3b531f7e32e9f0af136959eef47d4fb4648428
+SHA512:
+  metadata.gz: f37b915d755dd0f42aa152633cefe6cc749cbbbf0597d027c14dea52b4bb7e6b1e3c6ad822bd2e96d8833d03675baee67fe54bf8c5814859c6616f475a0033ed
+  data.tar.gz: 848ca56176a1ca25b97c25d800421e9998a947248e763b2fb2ca977fbe71f94f336eca4fd224138f3b3d81cdf6d255738584059b232fa5065c79abb28d4b4a2c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Roxanne Wolf
+
+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

@@ -0,0 +1,68 @@
+# polytoriarb
+
+Polytoriarb is a Ruby package (a.k.a. Gem) for interacting with Polytoria's REST API. The goal of this gem is to make using Polytoria's REST API easy to use for your Ruby projects.
+
+You need Ruby 3.0 or newer in order to use this package (Ruby 3.2 or newer is recommended)
+
+DISCLAIMER: This Ruby gem is not an official Polytoria product and made by a 3rd party. This gem is not officially endorsed by Polytoria.
+
+## Setup
+
+You can install polytoriarb through the following methods:
+
+#### Method 1: Install from rubygems.org (Bundler)
+
+Add the following to your Gemfile file and run the "[bundle install](https://rubygems.org/gems/polytoriarb)" command:
+
+```ruby
+gem 'polytoriarb'
+```
+
+#### Method 2: Install via Git
+
+Add the following to your Gemfile file and run the "bundle install" command:
+
+```ruby
+gem 'polytoriarb', git: 'https://gitlab.com/roxannewolf/polytoriarb'
+```
+
+## Usage
+
+Here is a basic example of using the /v1/places/#{id} endpoint
+
+```ruby
+require 'polytoriarb'
+polytoriaclient = PolytoriaRB.client
+
+place_id = 1822
+begin
+	place_data = polytoriaclient.place(place_id)
+	puts "Place Name: #{place_data['name']}"
+	puts "Visits: #{place_data['visits']}"
+rescue PolytoriaRB::APIError => e
+	puts "Error: #{e.code} - #{e.message}"
+end
+```
+
+Here is an example of using the /v1/places/#{id}/achievements endpoint that has query with a limit of 3
+
+```ruby
+require 'polytoriarb'
+polytoriaclient = PolytoriaRB.client
+
+place_id = 1822
+begin
+	achievements_response = polytoriaclient.place_achievements(place_id, limit: 3)
+	achievements_array = achievements_response['achievements']
+	puts "Found #{achievements_array.length} achievements in this place:"
+	achievements_array.each do |achievement|
+		puts " - #{achievement['asset']['name']} (ID: #{achievement['asset']['id']})"
+	end
+rescue PolytoriaRB::APIError => e
+	puts "Error fetching achievements: #{e.code} - #{e.message}"
+end
+```
+
+## Support and Help
+
+If you need help with this ruby package (a.k.a. Gem), feel free to open an issue on our [Gitlab repo](https://gitlab.com/roxannewolf/polytoriarb) or [Codeberg repo](https://codeberg.org/roxannewolf/polytoriarb)

data/lib/polytoriarb/client.rb

@@ -0,0 +1,115 @@
+# lib/polytoriarb/client.rb
+module PolytoriaRB
+	class Client
+		include HTTParty
+		base_uri "https://api.polytoria.com"
+		
+		def format_response(data)
+			case data
+			when Hash
+				data.transform_values { |v| format_response(v) }
+			when Array
+				data.map { |v| format_response(v) }
+			when NilClass
+				'N/A'
+			else
+				data
+			end
+		end
+
+		def self.get(path, options = {})
+			response = super(path, options)
+			unless response.success?
+				raise PolytoriaRB::APIError.new(response)
+			end
+			Client.new.send(:format_response, response.parsed_response)
+		end
+
+
+
+		# ---------- PLACES ----------
+		def place(id)
+			self.class.get("/v1/places/#{id}")
+		end
+
+		# Query: search (string), page (integer), limit (integer)
+		def place_achievements(id, options = {})
+			self.class.get("/v1/places/#{id}/achievements", query: options)
+		end
+
+		# Query: page (integer), limit (integer)
+		def place_gamepasses(id, options = {})
+			self.class.get("/v1/places/#{id}/gamepasses", query: options)
+		end
+
+		# ---------- GUILDS ----------
+		def guild(id)
+			self.class.get("/v1/guilds/#{id}")
+		end
+
+		# Query: page (integer), limit (query)
+		def guilds(options = {})
+			self.class.get("/v1/guilds", query: options)
+		end
+
+		# Query: page (integer), limit (integer)
+		def guild_members(id, options = {})
+			self.class.get("/v1/guilds/#{id}/members", query: options)
+		end
+
+		# Query: page (integer), limit (integer)
+		def guild_store(id, options = {})
+			self.class.get("/v1/guilds/#{id}/store", query: options)
+		end
+
+		# ---------- STORE ----------
+		def store_item(id)
+			self.class.get("/v1/store/#{id}")
+		end
+		
+		# Query: search (string), sort (string. accepts: name, price, createdAt, updatedAt), order (string. accepts: asc, desc), page (integer), limit (integer)
+		def store(options = {})
+			self.class.get("/v1/store", query: options)
+		end
+
+		# ---------- USERS ----------
+		# Query: search (string, accepts: id, username, registeredAt, lastSeenAt), sort (string), order (string, accepts asc, desc), page (integer), limit (integer)
+		def users(options = {})
+			self.class.get("/v1/users", query: options)
+		end
+		
+		def user(username)
+			self.class.get("/v1/users/find?username=#{username}")
+		end
+
+		# Query: page (integer), limit (integer)
+		def user_friends(id, options = {})
+			self.class.get("/v1/users/#{id}/friends", query: options)
+		end
+
+		# Query: type (string, accepts: achievement, audio, decal, face, gamePass, hat, mesh, pants, shirt, tool), limited (boolean), page (integer), limit (integer)
+		def user_inventory(id, options = {})
+			self.class.get("/v1/users/#{id}/inventory", query: options)
+		end
+
+		# Query: page (integer), limit (integer)
+		def user_store(id, options = {})
+			self.class.get("/v1/users/#{id}/store", query: options)
+		end
+
+		# Query: page (integer), limit (integer)
+		def user_badges(id, options = {})
+			self.class.get("/v1/users/#{id}/badges", query: options)
+		end
+	end
+	class APIError < StandardError
+		attr_reader :code, :message, :response
+
+		def initialize(response)
+			@code = response.code
+			@message = response.message
+			@response = response
+			super("[Polytoriarb] AN ERROR HAS OCCURED: Polytoria REST API request failed with status code #{code}: #{message}")
+		end
+	end
+end

data/lib/polytoriarb/version.rb

@@ -0,0 +1,6 @@
+# lib/polytoriarb/version.rb
+
+module PolytoriaRB
+	# The current version of polytoriarb
+	VERSION = "1.0.0"
+end

data/lib/polytoriarb.rb

@@ -0,0 +1,12 @@
+# lib/polytoriarb.rb
+require "httparty"
+require "polytoriarb/version"
+require "polytoriarb/client"
+
+module PolytoriaRB
+	class << self
+		def client
+			@client ||= Client.new
+		end
+	end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: polytoriarb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roxanne Studios
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: A simple gem made to help with interacting with Polytoria's REST API
+  for the Ruby programming language in a simplier way. Not officially endorsed by
+  Polytoria
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/polytoriarb.rb
+- lib/polytoriarb/client.rb
+- lib/polytoriarb/version.rb
+homepage: https://gitlab.com/roxannewolf/polytoriarb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Ruby gem for using the Polytoria REST API.
+test_files: []