Module: Ruqqus::Routes

Defined in:

lib/ruqqus/routes.rb

Overview

A module containing constants that define the method routes for the Ruqqus REST API.

Constant Summary

API_VERSION =

The Ruqqus API version.

1

HOME =

The top-level site URL.

'https://ruqqus.com'.freeze

API_BASE =

The base URL for the Ruqqus REST API.

"#{HOME}/api/v#{API_VERSION}".freeze

USER =

The endpoint for the GET method to obtain user information.

"#{API_BASE}/user/".freeze

GUILD =

The endpoint for the GET method to obtain guild information.

"#{API_BASE}/guild/".freeze

POST =

The endpoint for the GET method to obtain post information.

"#{API_BASE}/post/".freeze

COMMENT =

The endpoint for the GET method to obtain comment information.

"#{API_BASE}/comment/".freeze

POST_VOTE =

The endpoint for the POST method to place a vote on a post.

"#{API_BASE}/vote/post/".freeze

GUILD_AVAILABLE =

The endpoint for the GET method to query guild availability.

"#{HOME}/api/board_available/".freeze

USERNAME_AVAILABLE =

The endpoint for the GET method to query username availability.

"#{HOME}/api/is_available/".freeze

SUBMIT =

The endpoint for the POST method to submit a post.

"#{Routes::API_BASE}/submit/".freeze

IDENTITY =

The endpoint for the GET method to get the current user.

"#{Routes::API_BASE}/identity".freeze

GUILDS =

The endpoint for the GET method to get the guild listings.

"#{Routes::API_BASE}/guilds".freeze

FRONT_PAGE =

The endpoint for the GET method to get the front page listings.

"#{Routes::API_BASE}/front/listing".freeze

ALL_LISTINGS =

The endpoint for the GET method to get all post listings.

"#{Routes::API_BASE}/all/listing".freeze