codequiry 1.0.2 → 1.0.4

package/README.md

@@ -1,16 +1,225 @@
-## NodeJS Wrapper for Codequiry API 
-
-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.
-
-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
-
-API Docs:
-https://codequiry.com/usage/api
+# NodeJS SDK for Codequiry API 
+
+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.
+
+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
+
+## Installation
+
+```
+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
+```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)"
+        }
+    ]
+}
+```
+
+
+```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)
+});
+```
+#### 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.
+```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);
+    });
+});
+```

package/index.js

@@ -1,126 +1,126 @@
-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();
-            }
-        });
-    }
-};
-exports.emitter = em;
-exports.setAPIKey = function(api) {
-    api_key = api;
-};
-// Other stuff...
-exports.account = function(callback) {
-    runner('account', {}, function(data, err) {
-        callback(data, err)
-    });
-};
-exports.checks = function(callback) {
-    runner('checks', {}, function(data, err) {
-        callback(data, err)
-    });
-};
-exports.createCheck = function(checkname, lang, callback) {
-    runner('check/create', {
-        name: checkname,
-        language: lang
-    }, function(data, err) {
-        callback(data, err)
-    });
-};
-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)
-    });
-};
-exports.uploadFile = function(checkid, filein, callback) {
-    var params = {
-        check_id: checkid,
-        file: fs.createReadStream(filein)
-    };
-    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)
-    });
-};
-
-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.error);
-        })
-    } else {
-        callback(null, 'No API Key was set');
-    }
+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();
+            }
+        });
+    }
+};
+exports.emitter = em;
+exports.setAPIKey = function(api) {
+    api_key = api;
+};
+// Other stuff...
+exports.account = function(callback) {
+    runner('account', {}, function(data, err) {
+        callback(data, err)
+    });
+};
+exports.checks = function(callback) {
+    runner('checks', {}, function(data, err) {
+        callback(data, err)
+    });
+};
+exports.createCheck = function(checkname, lang, callback) {
+    runner('check/create', {
+        name: checkname,
+        language: lang
+    }, function(data, err) {
+        callback(data, err)
+    });
+};
+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)
+    });
+};
+exports.uploadFile = function(checkid, filein, callback) {
+    var params = {
+        check_id: checkid,
+        file: fs.createReadStream(filein)
+    };
+    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)
+    });
+};
+
+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');
+    }
 };

package/package.json

@@ -1,35 +1,35 @@
-{
-  "name": "codequiry",
-  "version": "1.0.2",
-  "description": "Node JS SDK for Codequiry's Plagiarism Checking API ",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cqchecker/codequiry-sdk.git"
-  },
-  "keywords": [
-    "codequiry",
-    "codequiry nodejs",
-    "code plagiarism checker",
-    "code similarity api",
-    "moss api",
-    "code plagiarism api",
-    "detect code plagiarism",
-    "code check api"
-  ],
-  "author": "Codequiry",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/cqchecker/codequiry-sdk/issues"
-  },
-  "homepage": "https://github.com/cqchecker/codequiry-sdk#readme",
-  "dependencies": {
-    "axios": "^0.19.0",
-    "events": "^3.0.0",
-    "request": "^2.88.0",
-    "socket.io-client": "^2.2.0"
-  }
-}
+{
+  "name": "codequiry",
+  "version": "1.0.4",
+  "description": "Node JS SDK for Codequiry's Plagiarism Checking API ",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cqchecker/codequiry-sdk.git"
+  },
+  "keywords": [
+    "codequiry",
+    "codequiry nodejs",
+    "code plagiarism checker",
+    "code similarity api",
+    "moss api",
+    "code plagiarism api",
+    "detect code plagiarism",
+    "code check api"
+  ],
+  "author": "Codequiry",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/cqchecker/codequiry-sdk/issues"
+  },
+  "homepage": "https://github.com/cqchecker/codequiry-sdk#readme",
+  "dependencies": {
+    "axios": "^0.19.0",
+    "events": "^3.0.0",
+    "request": "^2.88.0",
+    "socket.io-client": "^2.2.0"
+  }
+}