root-me-api-wrapper v1.1.6

root-me-API-wrapper

Description

This a wrapper for the root-me API.

Installation

Simply use npm :

npm install root-me-api-wrapper

Usage

const { Client } = require("root-me-api-wrapper");
const { api_key } = require("./config.json"); // Get your API key from https://www.root-me.org/?page=preferences

// Create a new client
const client = new Client(api_key);

//get the information about a user
client.getUser(userid).then(user => {
    console.log(user);
    // The user variable is an User object
});

//get the information about a challenge
client.getChallenge(challengeid).then(challenge => {
    console.log(challenge);
    // The challenge variable is a Challenge object
});

client.getUserByName(username).then(users => {
    console.log(users);
    // The users variables is an array of tuples [userid, username]
});

client.getChallengeByName(challengename).then(challenges => {
    console.log(challenges);
    // The challenges variable is an array of challenge objects
});

client.getAllChallenges().then(challenges => {
    console.log(challenges);
    // The challenges variable is an array of numbers with the ids of every challenges of Root Me
});

Documentation

User Object Owerview

User Object:

• id: The user id (integer)
• name: The pseudo of the user (string)
• rank: The overall rank of the user (number)
• score: The number of points the user has (number)
• solve: The array of the ids of challenges solved by the user (array of integers)
• title: The title of the user (string)
• challenges: The array of the ids of challenges created by the user (array of integers)

Challenge Object:

• id : The challenge id (integer)
• title : The title of the challenge (string)
• description : The description of the challenge (string)
• points : The number of points the challenge is worth (number)
• authors : An array of the authors names (array of string)
• authors_id : An array of the authors ids (array of integer)
• date : The date of the challenge creation (string)
• category : The category of the challenge (string)
• difficulty : The difficulty of the challenge (string)

To Do

• Write tests