codequiry 1.0.4 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Codequiry
+
+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.

package/README.md

@@ -1,225 +1,123 @@
-# NodeJS SDK for Codequiry API 
+# Codequiry - Node.js SDK
 
-Codequiry is a commercial grade plagiarism and similarity detection software for source code files. Submissions are checked with billions of sources on the web as well as checked locally against provided submissions. This is a NodeJS example application for the API to check code plagiarism and similarity.
+Official Node.js SDK for [Codequiry's](https://codequiry.com) Code Plagiarism & Similarity Detection API.
 
-The API allows us to run multiple different tests on source code files: 
-1. Peer Check - Given a group of submissions as individual zip files, all lines of code are compared to each other and relative similarity scores are computed, as well as matched snippets. 
-2. Database Check - Checks submissions against popular repositories and public sources of code.
-3. Web Check - Does a full check of code with over 2 billion public sources on the web. 
-
-Checks return us tons of data such as similarity scores, individual file scores, cluster graphs, similarity histograms, highlights results, matched snippets, percentage plagiarised and similar, and a ton more... 
-
-Main Website: 
-https://codequiry.com
-
-Full API Docs:
-https://codequiry.com/usage/api
+Check source code files against billions of web sources, public repositories, and peer submissions. Supports 65+ programming languages.
 
 ## Installation
 
-```
+```bash
 npm install codequiry
 ```
-#### Initializing
-```
-var Codequiry = require('codequiry')
-```
 
-#### Setting your API Key
-```
-Codequiry.setAPIKey('YOUR_API_KEY')
-```
-## Usage
-#### Getting account information
-```javascript
-Codequiry.account(function(data, err)) {
-	 if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Getting checks
+## Quick Start
+
 ```javascript
-Codequiry.checks(function(data, err)) {
-	 if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Creating checks (specify name and programming language)
-Examples: 
-```
-{
-    "error": "Invalid programming language, must be a valid language ID",
-    "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/ASCII (.txt)"
-        },
-        {
-            "id": 42,
-            "language": "Plain Text by Character (.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)"
-        }
-    ]
+const Codequiry = require('codequiry');
+
+const cq = new Codequiry('YOUR_API_KEY');
+
+// Create a check, upload files, start, and get results
+async function run() {
+  // Create a check (language 14 = Python)
+  const check = await cq.createCheck('Assignment 1', 14);
+  console.log('Created:', check);
+
+  // Upload a zip file
+  await cq.uploadFile(check.check.id, './submissions.zip');
+
+  // Start the check
+  await cq.startCheck(check.check.id, { dbcheck: true });
+
+  // Poll until complete
+  const status = await cq.pollUntilComplete(check.check.id, {
+    onProgress: (s) => console.log('Progress:', s),
+  });
+
+  // Get results
+  const overview = await cq.getOverview(check.check.id);
+  console.log('Results:', overview);
 }
+
+run().catch(console.error);
 ```
 
+## API Reference
+
+### Constructor
 
 ```javascript
-Codequiry.createCheck('CheckNameHere', '13', function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Uploading to a check (specify check_id and file (must be a zip file)) 
-```javascript
-Codequiry.uploadFile(CHECK_ID, './test.zip', function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Starting a check (specify check_id and if running database check or web check) 
-```javascript
-Codequiry.startCheck(CHECK_ID, false, false, function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Getting a check information/status
-```javascript
-Codequiry.getCheck(CHECK_ID, function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
-```
-#### Getting results overview
-```javascript
-Codequiry.getOverview(CHECK_ID, function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
+const cq = new Codequiry('YOUR_API_KEY');
 ```
-#### Getting specific results of a submission
-```javascript
-Codequiry.getResults(CHECK_ID, SUBMISSION_ID function(data, err) {
-    if (!err) console.log(data);
-    else console.log(err)
-});
-```
-## Realtime checking progress - SocketIO
-This is an example of the listener, you can call this after getting a check status or after starting a check (both will reutrn a job ID, which you can listen to). Here we will listen to specific CHECK_ID.
+
+### Account
+
+| Method | Description |
+|--------|-------------|
+| `cq.account()` | Get account info and usage quota |
+
+### Checks
+
+| Method | Description |
+|--------|-------------|
+| `cq.checks()` | List all checks |
+| `cq.createCheck(name, languageId, testType?)` | Create a new check |
+| `cq.getCheck(checkId)` | Get check info and status |
+| `cq.deleteCheck(checkId)` | Delete a check |
+
+### Upload
+
+| Method | Description |
+|--------|-------------|
+| `cq.uploadFile(checkId, filePath)` | Upload a ZIP file |
+| `cq.uploadBatch(checkId, filePaths)` | Upload multiple ZIP files |
+
+### Start & Status
+
+| Method | Description |
+|--------|-------------|
+| `cq.startCheck(checkId, options?)` | Start a check. Options: `{ dbcheck, webcheck, testType }` |
+| `cq.getStatus(checkId)` | Get current check status |
+| `cq.pollUntilComplete(checkId, options?)` | Poll until done. Options: `{ interval, timeout, onProgress }` |
+
+### Results
+
+| Method | Description |
+|--------|-------------|
+| `cq.getOverview(checkId)` | Results overview with similarity scores |
+| `cq.getResults(checkId, submissionId)` | Detailed results for a submission |
+| `cq.getSummary(checkId)` | Summary statistics |
+
+### Reference Data
+
+| Method | Description |
+|--------|-------------|
+| `cq.getLanguages()` | List supported programming languages |
+| `cq.getTestTypes()` | List available check engine types |
+
+## Supported Languages
+
+Java, Python, C, C++, C#, Perl, PHP, SQL, VB, XML, Haskell, Pascal, Go, Matlab, Lisp, Ruby, Assembly, HTML, JavaScript/TypeScript, Swift, Kotlin, Dart, Elixir, Jupyter Notebooks, and many more.
+
+## Migration from v1
+
+v2 uses modern async/await instead of callbacks:
+
 ```javascript
-Codequiry.getCheck(CHECK_ID, function(data) {
-    console.log(data.check.job_id);
-    Codequiry.checkListen(data.check.job_id);
-    Codequiry.emitter.on('update', function(data) {
-        console.log(data);
-    });
+// v1 (old)
+Codequiry.setAPIKey('key');
+Codequiry.checks(function(data, err) {
+  console.log(data);
 });
+
+// v2 (new)
+const cq = new Codequiry('key');
+const checks = await cq.checks();
+console.log(checks);
 ```
+
+## Links
+
+- [Codequiry](https://codequiry.com)
+- [API Documentation](https://codequiry.com/usage/docs)
+- [CLI Tool](https://www.npmjs.com/package/codequiry-cli)

package/index.js

@@ -1,126 +1,253 @@
+'use strict';
+
 const axios = require('axios');
-var api_key;
-var request = require('request');
-var fs = require('fs');
-var events = require('events');
-var io = require('socket.io-client');
-var em = new events.EventEmitter();
-exports.checkListen = function(job_id) {
-    var socket = io('https://api.codequiry.com/');
-    if (job_id != 0) {
-        socket.emit('job-check', {
-            jobid: job_id
-        });
-        socket.on('job-status', function(data) {
-            em.emit('update', data);
-            if (data.error == 1 || data.percent == 100) {
-                socket.disconnect();
-            }
-        });
+const FormData = require('form-data');
+const fs = require('fs');
+
+const BASE_URL = 'https://codequiry.com/api/v1';
+
+class Codequiry {
+  /**
+   * Create a Codequiry SDK instance.
+   * @param {string} apiKey - Your Codequiry API key
+   */
+  constructor(apiKey) {
+    if (!apiKey) {
+      throw new Error('API key is required. Get one at https://codequiry.com/dashboard');
     }
-};
-exports.emitter = em;
-exports.setAPIKey = function(api) {
-    api_key = api;
-};
-// Other stuff...
-exports.account = function(callback) {
-    runner('account', {}, function(data, err) {
-        callback(data, err)
+    this.apiKey = apiKey;
+    this.client = axios.create({
+      baseURL: BASE_URL,
+      headers: {
+        apikey: apiKey,
+        Accept: 'application/json',
+      },
+      timeout: 120000,
     });
-};
-exports.checks = function(callback) {
-    runner('checks', {}, function(data, err) {
-        callback(data, err)
+  }
+
+  // ─── Account ──────────────────────────────────────────
+
+  /**
+   * Get account information and usage quota.
+   * @returns {Promise<Object>}
+   */
+  async account() {
+    const res = await this.client.get('/account');
+    return res.data;
+  }
+
+  // ─── Checks ───────────────────────────────────────────
+
+  /**
+   * List all checks.
+   * @returns {Promise<Object>}
+   */
+  async checks() {
+    const res = await this.client.get('/checks');
+    return res.data;
+  }
+
+  /**
+   * Create a new check.
+   * @param {string} name - Check name
+   * @param {number} language - Language ID (get from getLanguages())
+   * @param {number} [testType] - Test type ID (get from getTestTypes())
+   * @returns {Promise<Object>}
+   */
+  async createCheck(name, language, testType) {
+    const body = { name, language };
+    if (testType) body.test_type = testType;
+    const res = await this.client.post('/check/create', body);
+    return res.data;
+  }
+
+  /**
+   * Get check information and status.
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async getCheck(checkId) {
+    const res = await this.client.post('/check/get', { check_id: checkId });
+    return res.data;
+  }
+
+  /**
+   * Delete a check.
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async deleteCheck(checkId) {
+    const res = await this.client.delete(`/checks/${checkId}`);
+    return res.data;
+  }
+
+  // ─── Upload ───────────────────────────────────────────
+
+  /**
+   * Upload a ZIP file to a check.
+   * @param {number} checkId
+   * @param {string} filePath - Path to a .zip file
+   * @returns {Promise<Object>}
+   */
+  async uploadFile(checkId, filePath) {
+    const form = new FormData();
+    form.append('check_id', String(checkId));
+    form.append('file', fs.createReadStream(filePath));
+    const res = await this.client.post('/check/upload', form, {
+      headers: form.getHeaders(),
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
     });
-};
-exports.createCheck = function(checkname, lang, callback) {
-    runner('check/create', {
-        name: checkname,
-        language: lang
-    }, function(data, err) {
-        callback(data, err)
+    return res.data;
+  }
+
+  /**
+   * Upload multiple ZIP files to a check (batch).
+   * @param {number} checkId
+   * @param {string[]} filePaths - Array of paths to .zip files
+   * @returns {Promise<Object>}
+   */
+  async uploadBatch(checkId, filePaths) {
+    const form = new FormData();
+    form.append('check_id', String(checkId));
+    filePaths.forEach((fp) => {
+      form.append('files[]', fs.createReadStream(fp));
     });
-};
-exports.startCheck = function(checkid, db, web, callback) {
-    if (db) db = 1
-    if (web) web = 1
-    runner('check/start', {
-        check_id: checkid,
-        webcheck: web,
-        dbcheck: db
-    }, function(data, err) {
-        callback(data, err)
+    const res = await this.client.post('/check/upload-batch', form, {
+      headers: form.getHeaders(),
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
     });
-};
-exports.uploadFile = function(checkid, filein, callback) {
-    var params = {
-        check_id: checkid,
-        file: fs.createReadStream(filein)
+    return res.data;
+  }
+
+  // ─── Start & Status ───────────────────────────────────
+
+  /**
+   * Start a check.
+   * @param {number} checkId
+   * @param {Object} [options]
+   * @param {boolean} [options.dbcheck=false] - Enable database check
+   * @param {boolean} [options.webcheck=false] - Enable web check
+   * @param {number} [options.testType] - Test type override
+   * @returns {Promise<Object>}
+   */
+  async startCheck(checkId, options = {}) {
+    const body = {
+      check_id: checkId,
+      dbcheck: options.dbcheck ? 1 : 0,
+      webcheck: options.webcheck ? 1 : 0,
     };
-    var headersWebex = {
-        "Access-Control-Allow-Origin": "*",
-        'apikey': api_key,
-        'Content-Type': 'multipart/form-data'
-    }
-    request.post({
-        headers: headersWebex,
-        url: 'https://codequiry.com/api/v1/check/upload',
-        method: 'POST',
-        formData: params
-    }, function(error, response, body) {
-        if (error) callback(null, error)
-        if (JSON.parse(body).error) {
-            callback(null, JSON.parse(body).error)
-        } else {
-            callback(JSON.parse(body));
-        }
-    });
-};
-exports.getCheck = function(checkid, callback) {
-    runner('check/get', {
-        check_id: checkid
-    }, function(data, err) {
-        callback(data, err)
-    });
-};
-exports.getOverview = function(checkid, callback) {
-    runner('check/overview', {
-        check_id: checkid
-    }, function(data, err) {
-        callback(data, err)
-    });
-};
-exports.getResults = function(checkid, sid, callback) {
-    runner('check/results', {
-        check_id: checkid,
-        submission_id: sid
-    }, function(data, err) {
-        callback(data, err)
+    if (options.testType) body.test_type = options.testType;
+    const res = await this.client.post('/check/start', body);
+    return res.data;
+  }
+
+  /**
+   * Get check status (for polling).
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async getStatus(checkId) {
+    const res = await this.client.get(`/checks/${checkId}/status`);
+    return res.data;
+  }
+
+  // ─── Results ──────────────────────────────────────────
+
+  /**
+   * Get results overview for a check.
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async getOverview(checkId) {
+    const res = await this.client.post('/check/overview', { check_id: checkId });
+    return res.data;
+  }
+
+  /**
+   * Get detailed results for a specific submission.
+   * @param {number} checkId
+   * @param {number} submissionId
+   * @returns {Promise<Object>}
+   */
+  async getResults(checkId, submissionId) {
+    const res = await this.client.post('/check/results', {
+      check_id: checkId,
+      submission_id: submissionId,
     });
-};
-
-function runner(route, postdata, callback) {
-    if (api_key != null) {
-        var postData = postdata;
-        var contentType;
-        let axiosConfig = {
-            headers: {
-                'Content-Type': 'application/json',
-                "Access-Control-Allow-Origin": "*",
-                'apikey': api_key,
-            }
-        };
-        axios.post('https://codequiry.com/api/v1/' + route, postData, axiosConfig).then((res) => {
-            if (res.data.error) {
-                callback(null, res.data.error)
-            } else {
-                callback(res.data)
-            }
-        }).catch((err) => {
-            callback(null, err.response.data);
-        })
-    } else {
-        callback(null, 'No API Key was set');
+    return res.data;
+  }
+
+  /**
+   * Get summary stats for a check.
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async getSummary(checkId) {
+    const res = await this.client.get(`/checks/${checkId}/summary`);
+    return res.data;
+  }
+
+  // ─── Reference Data ───────────────────────────────────
+
+  /**
+   * Get supported programming languages.
+   * @returns {Promise<Object>}
+   */
+  async getLanguages() {
+    const res = await this.client.get('/languages');
+    return res.data;
+  }
+
+  /**
+   * Get available test/check types.
+   * @returns {Promise<Object>}
+   */
+  async getTestTypes() {
+    const res = await this.client.get('/test-types');
+    return res.data;
+  }
+
+  // ─── Helpers ──────────────────────────────────────────
+
+  /**
+   * Poll a check until completion.
+   * @param {number} checkId
+   * @param {Object} [options]
+   * @param {number} [options.interval=3000] - Poll interval in ms
+   * @param {number} [options.timeout=600000] - Max wait time in ms
+   * @param {function} [options.onProgress] - Callback with status updates
+   * @returns {Promise<Object>} Final status
+   */
+  async pollUntilComplete(checkId, options = {}) {
+    const interval = options.interval || 3000;
+    const timeout = options.timeout || 600000;
+    const startTime = Date.now();
+
+    while (Date.now() - startTime < timeout) {
+      const status = await this.getStatus(checkId);
+
+      if (options.onProgress) {
+        options.onProgress(status);
+      }
+
+      const statusId = status?.status_id;
+      // status_id 4 = Completed
+      if (statusId === 4) {
+        return status;
+      }
+      // status_id 5 = Error/Failed
+      if (statusId === 5 || statusId === -1) {
+        throw new Error('Check failed: ' + JSON.stringify(status));
+      }
+
+      await new Promise((resolve) => setTimeout(resolve, interval));
     }
-};
+
+    throw new Error('Polling timed out after ' + timeout + 'ms');
+  }
+}
+
+module.exports = Codequiry;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "codequiry",
-  "version": "1.0.4",
-  "description": "Node JS SDK for Codequiry's Plagiarism Checking API ",
+  "version": "2.0.1",
+  "description": "Node.js SDK for Codequiry's Code Plagiarism & Similarity Detection API",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"No tests yet\""
   },
   "repository": {
     "type": "git",
@@ -12,24 +12,25 @@
   },
   "keywords": [
     "codequiry",
-    "codequiry nodejs",
-    "code plagiarism checker",
-    "code similarity api",
-    "moss api",
-    "code plagiarism api",
-    "detect code plagiarism",
-    "code check api"
+    "plagiarism",
+    "code-similarity",
+    "code-plagiarism",
+    "similarity-detection",
+    "moss",
+    "api",
+    "sdk"
   ],
   "author": "Codequiry",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/cqchecker/codequiry-sdk/issues"
   },
-  "homepage": "https://github.com/cqchecker/codequiry-sdk#readme",
+  "homepage": "https://codequiry.com",
   "dependencies": {
-    "axios": "^0.19.0",
-    "events": "^3.0.0",
-    "request": "^2.88.0",
-    "socket.io-client": "^2.2.0"
+    "axios": "^1.6.0",
+    "form-data": "^4.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
   }
 }