@proghours/crawler v0.0.4

@proghours/crawler

@proghours/crawler is a library designed to extract information from programming problems available on various online judges. It pulls data, such as problem name, problem_id, contest_id, tag, difficulty etc, by fetching the information from the given problem URL. It can also fetch user submissions from supported online judges.

In cases where an API is not available, @proghours/crawler utilizes web crawling techniques to gather the necessary data. By integrating @proghours/crawler with progHours, we are able to easily extract the necessary data we needed for the system.

Installation

The library is available online and can be installed via npm

npm i @proghours/crawler

Basic Usage

Fetch information about a problem

import { fetchProblem } from "@proghours/crawler";

async function main() {
  const data = await fetchProblem(
    "https://codeforces.com/problemset/problem/1879/D"
  );

  // do something with the data
  console.log(data);
}

main();

If you are using CommonJS modules, you can also use the require function to import the library. The returned object from fetchProblem will satisfy the following interface.

interface ProblemData {
  pid: string;
  name: string;
  url: string;
  tags: string[];
  difficulty: number;
}

Fetch Submissions of an User

import { fetchUserSubmissions } from "@proghours/crawler";

async function main() {
  const data = await fetchUserSubmissions('CODEFORCES', {
    handle: "naimul_haque",
  });

  // data is of type CfSubmissions
  // do something with the data
  console.log(data.totalSolved);
  console.log(data.submissions);
}

main();

In order to fetch submissions from CodeChef, we need to pass in the 2 extra properties clientId and secret, so that our crawler can talk with the CodeChef APIs.

import { fetchUserSubmissions } from "@proghours/crawler";

async function main() {
  const data = await fetchUserSubmissions('CODECHEF', {
    handle: "naimul_haque",
    clientID: "CODECHEF_API_CLIENT_ID",
    secret: "CODECHEF_API_SECRET"
  });

  // data is of type CcSubmissions
  // do something with the data
  console.log(data.totalSolved);
  console.log(data.submissions);
}

main();

Additionally, you can also pass an optional contestId to fetch user submissions from only that contestId. This works simillarly for CodeChef as well.

import { fetchUserSubmissions } from "@proghours/crawler";

async function main() {
  const data = await fetchUserSubmissions('CODEFORCES', {
    handle: "naimul_haque",
    contestId: "1742"
  });

  // data is of type CfSubmissions
  // do something with the data
  console.log(data.totalSolved);
  console.log(data.submissions);
}

main();

Currently, fetchUserSubmissions only supports Codeforces and CodeChef. The returned object from fetchUserSubmissions will return one of the following interfaces. TypeScript will map the proper return type, based on the first parameter.

type CfSubmissions = {
  totalSolved: number;
  submissions: Array<{
    id: number;
    pid: string;
    name: string;
    url: string;
    difficulty: number;
    tags: string[];
    contestId: number;
    createdAt: Date;
    verdict: Verdict;
  }>;
};

type CcSubmissions = {
  totalSolved: number;
  submissions: Array<{
    id: number;
    pid: string;
    url: string;
    contestId: string;
    createdAt: Date;
    verdict: Verdict;
    solvedDuringContest: boolean;
  }>;
};

Online Judge Support

The library currently supports 14 different online judges.

1. Codeforces
2. CodeChef
3. CSES
4. Online Judge
5. Toph
6. SPOJ
7. HackerRank
8. LightOJ
9. AtCoder
10. EOlymp
11. LeetCode
12. Timus Online Judge
13. CodeToWin
14. Kattis

Test Coverage

We have 100% test coverage for the library, the tests could break if the 3rd party APIs or web pages changes.

Each online judge is covered by individual test files. For example, the codeforces.spec.ts file contains test cases specifically designed for the Codeforces crawler. Similarly, we have .spec.ts files for all other crawlers.

Running All Tests

To run all the tests project, you can execute the following command:

nx run crawler:test

Running Individual Test Files

If you wish to run tests for a specific online judge, you can use the following command:

nx run crawler:test --testFile=libs/crawler/src/tests/codeforces.spec.ts

Simply replace codeforces.spec.ts with the desired test file for the corresponding online judge. This command will execute the specified test file and provide the results.

By running the tests, you can ensure that the library functions as expected and handles various scenarios encountered on different online judges effectively.