codequiry-cli 1.0.0

package/README.md

@@ -0,0 +1,179 @@
+# Node.js CLI for Plagiarism Checker API
+
+## Detail
+Command Line Interface (CLI) to interact with the Plagiarism Checker API
+
+## Install
+```
+npm install
+npm install -g .
+```
+
+## Usage
+After installation, you can use the following commands:
+
+1. `auth`: Authenticate your API key
+2. `createCheck`: Create a new plagiarism check
+3. `uploadToCheck`: Upload a file to be checked
+4. `startCheck`: Start a plagiarism check
+5. `retriveCheck`: Retrieve existing checks
+6. `checkStatus`: Check the status of a plagiarism check
+7. `resultOverview`: Get an overview of the check results
+8. `detailedResult`: Get detailed results of a check
+
+## Examples
+Here are detailed examples of how to use each command:
+
+### Authenticate
+```
+codequiry auth
+```
+This will prompt you to enter your API key for authentication.
+If you are not authenticated, you will be prompted to enter your API key:
+```
+Enter your API key:
+```
+Once you are authenticated successfully, it will save to apikey.json file and you can see following.
+```
+Hello, lion!
+Your email is victor19930515@outlook.com.
+? Choose an action:
+❯ Create Check
+  Start Check
+  Upload to Check
+```
+### Create Check
+This will initiate the process of creating a new check and provide you with a check ID.
+```
+codequiry createCheck
+```
+You will be prompted to enter the programming language you want to check and name:
+```
+? Enter the programming language: 13
+? Enter the your name:
+```
+Available languages are:
+```
+"available_languages": [
+        { id: 13, language: 'Java (.java)' },
+        { id: 14, language: 'Python (.py)' },
+        { id: 16, language: 'C (.c/.h)' },
+        { id: 17, language: 'C/C++ (.cc/.c/.h/.cpp/.hpp)' },
+        { id: 18, language: 'C# (.cs)' },
+        { id: 20, language: 'Perl (.pl/.sh)' },
+        { id: 21, language: 'PHP (.php)' },
+        { id: 22, language: 'SQL (.sql)' },
+        { id: 23, language: 'VB (.vb/.bas)' },
+        { id: 24, language: 'XML (.xml)' },
+        { id: 28, language: 'Haskell (.hs/.lhs)' },
+        { id: 29, language: 'Pascal (.pas/.inc)' },
+        { id: 30, language: 'Go (.go)' },
+        { id: 31, language: 'Matlab (.m)' },
+        { id: 32, language: 'Lisp (.el)' },
+        { id: 33, language: 'Ruby (.rb)' },
+        { id: 34, language: 'Assembly (.asm/.s)' },
+        { id: 38, language: 'HTML Javascript (.html/.htm/.xhtml)' },
+        { id: 39, language: 'Javascript (.js/.ts)' },
+        { id: 40, language: 'HTML (.html/.htm/.xhtml)' },
+        { id: 41, language: 'Plain text (.txt)' },
+        { id: 42, language: 'Text file by char (.txt)' },
+        { id: 43, language: 'Swift (.swift)' },
+        { id: 44, language: 'Kotlin (.kt/.kts)' },
+        { id: 45, language: 'Yacc (.y,.yy,.ypp,.yxx)' },
+        { id: 46, language: 'Lex (.l,.ll)' },
+        { id: 47, language: 'Elixir (.ex, .exs)' },
+        { id: 48, language: 'Python Jupyter Notebook (.ipynb)' },
+        { id: 49, language: 'Dart (.dart)' },
+        { id: 50, language: 'Shell (.sh/.bash)' },
+        { id: 51, language: 'Rust (.rs)' },
+        { id: 52, language: 'Scala (.scala)' },
+        { id: 53, language: 'R (.r)' },
+        { id: 54, language: 'Objective-C (.m, .mm)' },
+        { id: 55, language: 'TypeScript (.ts, .tsx)' },
+        { id: 56, language: 'Markdown (.md)' },
+        { id: 57, language: 'Julia (.jl)' },
+        { id: 58, language: 'Groovy (.groovy)' },
+        { id: 59, language: 'Sass/SCSS (.scss, .sass)' },
+        { id: 60, language: 'CoffeeScript (.coffee)' },
+        { id: 61, language: 'Lua (.lua)' },
+        { id: 62, language: 'Erlang (.erl, .hrl)' },
+        { id: 63, language: 'F# (.fs, .fsi, .fsx)' },
+        { id: 64, language: 'Fortran (.f90, .f95)' },
+        { id: 65, language: 'Haxe (.hx)' },
+        { id: 66, language: 'Scheme (.scm, .ss)' },
+        { id: 67, language: 'Tcl (.tcl)' },
+        { id: 68, language: 'Ada (.adb, .ads)' },
+        { id: 69, language: 'COBOL (.cob, .cbl)' },
+        { id: 70, language: 'VHDL (.vhd, .vhdl)' }
+    ]
+```
+
+### Upload to Check
+This will upload files in uploads folder to check.
+**Files in uploads folder must be zip files.**
+```
+codequiry uploadToCheck
+```
+You will be prompted to enter check ID.
+```
+? Enter the check ID:
+```
+
+### Start Check
+This will start check.
+```
+codequiry startCheck
+```
+You will be prompted to enter check ID.
+```
+? Enter the check ID:
+? Select the additional check type: (Use arrow keys)
+❯ webcheck
+  dbcheck
+```
+```
+dbcheck: If you would like to run the database check
+webcheck: If you would like to run the web check
+```
+### Retrive Check
+This will retrive check.
+```
+codequiry retriveCheck
+```
+
+### Get Check Status
+This will get check status.
+```
+codequiry checkStatus
+```
+You will be prompted to enter check ID.
+```
+? Enter the check ID:
+```
+
+### Get Result Overview
+This will get result overview.
+```
+codequiry resultOverview
+```
+You will be prompted to enter check ID.
+```
+? Enter the check ID:
+```
+
+### Get Detailed Result
+This will get detailed result.
+```
+codequiry detailedResult
+```
+You will be prompted to enter check ID and submission ID.
+```
+? Enter the check ID: 95663
+? Enter the submission ID: 220801
+```
+
+## Version
+Current version: 1.0.0
+
+## License
+ISC

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "codequiry-cli",
+  "version": "1.0.0",
+  "description": "Command Line Interface (CLI) to interact with the Code Plagiarism Checker API",
+  "main": "index.js",
+  "bin": {
+    "codequiry": "src/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.7.2",
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "dotenv": "^16.4.5",
+    "form-data": "^4.0.0",
+    "fs": "^0.0.1-security",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^10.1.2"
+  },
+  "type": "module"
+}

package/src/auth.js

@@ -0,0 +1,47 @@
+import inquirer from 'inquirer';
+import axios from 'axios';
+import fs from 'fs';
+import { manageChecks } from './check.js';
+import { API_KEY_FILE } from './const.js';
+import { getApiKey } from './util.js';
+
+export async function authenticate() {
+  let apiKey = getApiKey();
+
+  if (!apiKey) {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'apiKey',
+        message: 'Enter your API key:'
+      }
+    ]);
+
+    apiKey = answers.apiKey;
+  }
+
+  if (apiKey) {
+    try {
+      const response = await axios.post('https://codequiry.com/api/v1/account', null, {
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200) {
+        fs.writeFileSync(API_KEY_FILE, JSON.stringify({ apiKey }));
+        console.log(`Hello, ${response.data.user}!\nYour email is ${response.data.email}.`);
+
+        manageChecks();
+      } else {
+        console.log('Invalid API key. Please re-enter the key.');
+      }
+    } catch (error) {
+      console.error('Authentication failed:', error.response.data);
+      if (fs.existsSync(API_KEY_FILE)) {
+        fs.unlinkSync(API_KEY_FILE);
+      }
+    }
+  }
+}

package/src/check.js

@@ -0,0 +1,444 @@
+import inquirer from 'inquirer';
+import axios from 'axios';
+import fs from 'fs';
+import FormData from 'form-data';
+import { API_KEY_FILE, validLanguageIds } from './const.js'
+import { isValidNumber, getApiKey, getZipFiles } from './util.js'
+
+
+export async function manageChecks() {
+  try {
+    const { apiKey } = JSON.parse(fs.readFileSync(API_KEY_FILE, 'utf8'));
+
+    const action = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'action',
+        message: 'Choose an action:',
+        choices: ['Create Check', 'Start Check', 'Upload to Check']
+      }
+    ]);
+
+    switch (action.action) {
+      case 'Create Check':
+        await _createCheck(apiKey);
+        break;
+      case 'Start Check':
+        await _startCheck(apiKey);
+        break;
+      case 'Upload to Check':
+        await _uploadToCheck(apiKey);
+        break;
+      default:
+        console.log('Invalid action.');
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+export function createCheck() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    _createCheck(apiKey);
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+async function _createCheck(apiKey) {
+  try {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'language',
+        message: 'Enter the programming language:'
+      },
+      {
+        type: 'input',
+        name: 'name',
+        message: 'Enter the your name:'
+      },
+    ]);
+
+    if (answers.language === '' || !isValidNumber(answers.language)) {
+      console.log(validLanguageIds);
+      return;
+    }
+    if (answers.name === '' || answers.name.length < 4) {
+      console.log('Please enter name. And name must be at least 4 characters.');
+      return;
+    }
+
+    try {
+      const response = await axios.post('https://codequiry.com/api/v1/check/create', null, {
+        params: {
+          name: answers.name,
+          language: answers.language,
+        },
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 201) {
+        console.log('Check created successfully:', response.data);
+      } else {
+        console.log('Failed to create check.');
+      }
+    } catch (error) {
+      console.error('Error Creating Check:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+export function startCheck() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    _startCheck(apiKey);
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+async function _startCheck(apiKey) {
+  try {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'checkId',
+        message: 'Enter the check ID:'
+      },
+      {
+        type: 'list',
+        name: 'addintionalCheck',
+        message: 'Select the additional check type:',
+        choices: ['webcheck', 'dbcheck', 'group_similarity_only']
+      }
+    ]);
+
+    if (answers.checkId === '' || !isValidNumber(answers.checkId)) {
+      console.log('Please enter check ID. And check ID must be a number.');
+      return;
+    }
+    if (answers.addintionalCheck === '') {
+      console.log('Please select additional check type.');
+      return;
+    }
+
+    let params = {};
+    if (answers.addintionalCheck === 'webcheck') {
+      params = { 'check_id': answers.checkId, 'webcheck': 1 };
+    } else if (answers.addintionalCheck === 'dbcheck') {
+      params = { 'check_id': answers.checkId, 'dbcheck': 1 };
+    } else if (answers.addintionalCheck === 'group_similarity_only') {
+      params = { 'check_id': answers.checkId };
+    }
+    try {
+      const response = await axios.post(`https://codequiry.com/api/v1/check/start`, null, {
+        params: {
+          ...params
+        },
+        headers: {
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200 && !response.data.hasOwnProperty('error')) {
+        console.log('Check started successfully.\n', response.data);
+      } else {
+        console.log('Failed to start check.', response.data);
+      }
+    } catch (error) {
+      console.error('Error starting check:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+
+}
+
+export function uploadToCheck() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    _uploadToCheck(apiKey);
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+
+}
+
+async function _uploadToCheck(apiKey) {
+  try {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'checkId',
+        message: 'Enter the check ID:'
+      }
+    ]);
+
+    if (answers.checkId === '' || !isValidNumber(answers.checkId)) {
+      console.log('Please enter check ID. And check ID must be a number.');
+      return;
+    }
+
+    const files = getZipFiles();
+
+    if (answers.checkId === '') {
+      console.log('Please enter check ID.');
+      return;
+    }
+    if (files.length === 0) {
+      console.log('No ZIP files found in uploads folder.\nPlease copy files in upload folder and try again.');
+      return;
+    }
+
+
+    files.forEach(async (file, index) => {
+      try {
+        const form = new FormData();
+        form.append('file', fs.createReadStream(`./uploads/${file}`));
+        form.append('check_id', answers.checkId);
+        const response = await axios.post('https://codequiry.com/api/v1/check/upload', form, {
+          headers: {
+            apikey: apiKey,
+          }
+        });
+
+        if (response.status === 200) {
+          console.log('File uploaded successfully.', response.data);
+        } else {
+          console.log('Failed to upload file.');
+        }
+      } catch (error) {
+        console.error('Error uploading file:', error.message);
+      }
+    });
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+export async function retriveCheck() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+
+    try {
+      const response = await axios.post(`https://codequiry.com/api/v1/checks`, null, {
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200) {
+        console.log('Retrive Checks successfully.\n', response.data);
+      } else {
+        console.log('Failed to retrive check.', response.data);
+      }
+    } catch (error) {
+      console.error('Error retriving checks:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+
+}
+
+export async function checkStatus() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'checkId',
+        message: 'Enter the check ID:'
+      }
+    ]);
+    if (answers.checkId === '' || !isValidNumber(answers.checkId)) {
+      console.log('Please enter check ID. And check ID must be a number.');
+      return;
+    }
+
+    let params = { check_id: answers.checkId };
+
+    try {
+      const response = await axios.post(`https://codequiry.com/api/v1/check/get`, null, {
+        params: {
+          ...params
+        },
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200) {
+        console.log('Check status successfully.\n', response.data);
+      } else {
+        console.log('Failed to check status.', response.data);
+      }
+    } catch (error) {
+      console.error('Error check status:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+export async function resultOverview() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'checkId',
+        message: 'Enter the check ID:'
+      }
+    ]);
+
+    if (answers.checkId === '' || !isValidNumber(answers.checkId)) {
+      console.log('Please enter check ID. And check ID must be a number.');
+      return;
+    }
+
+    let params = { check_id: answers.checkId };
+
+    try {
+      const response = await axios.post(`https://codequiry.com/api/v1/check/overview`, null, {
+        params: {
+          ...params
+        },
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200) {
+        console.log('Result Overview.\n', response.data);
+      } else {
+        console.log('Failed to check result overview.', response.data);
+      }
+    } catch (error) {
+      console.error('Error check result overview:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}
+
+export async function detailedResult() {
+  try {
+    const apiKey = getApiKey();
+    if (!apiKey) {
+      console.log('Please authenticate first.');
+      return;
+    }
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'checkId',
+        message: 'Enter the check ID:'
+      },
+      {
+        type: 'input',
+        name: 'submissionId',
+        message: 'Enter the submission ID:'
+      }
+    ]);
+    if (answers.checkId === '' || !isValidNumber(answers.checkId)) {
+      console.log('Please enter check ID. And check ID must be a number.');
+      return;
+    }
+    if (answers.submissionId === '' || !isValidNumber(answers.submissionId)) {
+      console.log('Please enter submission ID. And submission ID must be a number.');
+      return;
+    }
+
+    let params = { check_id: answers.checkId, submission_id: answers.submissionId };
+
+    try {
+      const response = await axios.post(`https://codequiry.com/api/v1/check/overview`, null, {
+        params: {
+          ...params
+        },
+        headers: {
+          'Accept': '*/*',
+          'apikey': apiKey,
+        }
+      });
+
+      if (response.status === 200) {
+        console.log('Detailed Result.\n', response.data);
+      } else {
+        console.log('Failed to detailed result.', response.data);
+      }
+    } catch (error) {
+      console.error('Error get detailed result:', error.response.data);
+    }
+  } catch (error) {
+    if (error.message.includes('User force closed the prompt')) {
+    } else {
+      console.error('An unexpected error occurred:', error);
+    }
+  }
+}