mirror of
https://github.com/ajayyy/SponsorBlockServer.git
synced 2025-12-12 14:37:17 +03:00
Added getUserInfo endpoint
This endpoint provides the following data about the user: * userID * userName * minutesSaved * segmentCount * viewCount
This commit is contained in:
@@ -22,6 +22,7 @@ var getViewsForUser = require('./routes/getViewsForUser.js');
|
|||||||
var getTopUsers = require('./routes/getTopUsers.js');
|
var getTopUsers = require('./routes/getTopUsers.js');
|
||||||
var getTotalStats = require('./routes/getTotalStats.js');
|
var getTotalStats = require('./routes/getTotalStats.js');
|
||||||
var getDaysSavedFormatted = require('./routes/getDaysSavedFormatted.js');
|
var getDaysSavedFormatted = require('./routes/getDaysSavedFormatted.js');
|
||||||
|
var getUserInfo = require('./routes/getUserInfo.js');
|
||||||
|
|
||||||
// Old Routes
|
// Old Routes
|
||||||
var oldGetVideoSponsorTimes = require('./routes/oldGetVideoSponsorTimes.js');
|
var oldGetVideoSponsorTimes = require('./routes/oldGetVideoSponsorTimes.js');
|
||||||
@@ -86,6 +87,8 @@ app.get('/api/getTopUsers', getTopUsers);
|
|||||||
//send the total submissions, total views and total minutes saved
|
//send the total submissions, total views and total minutes saved
|
||||||
app.get('/api/getTotalStats', getTotalStats);
|
app.get('/api/getTotalStats', getTotalStats);
|
||||||
|
|
||||||
|
app.get('/api/getUserInfo', getUserInfo);
|
||||||
|
|
||||||
//send out a formatted time saved total
|
//send out a formatted time saved total
|
||||||
app.get('/api/getDaysSavedFormatted', getDaysSavedFormatted);
|
app.get('/api/getDaysSavedFormatted', getDaysSavedFormatted);
|
||||||
|
|
||||||
|
|||||||
71
src/routes/getUserInfo.js
Normal file
71
src/routes/getUserInfo.js
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
const db = require('../databases/databases.js').db;
|
||||||
|
const getHash = require('../utils/getHash.js');
|
||||||
|
|
||||||
|
function dbGetSubmittedSegmentSummary (userID) {
|
||||||
|
try {
|
||||||
|
let row = db.prepare("get", "SELECT SUM(((endTime - startTime) / 60) * views) as minutesSaved, count(*) as segmentCount FROM sponsorTimes WHERE userID = ? AND votes > -2 AND shadowHidden != 1", [userID]);
|
||||||
|
if (row.minutesSaved != null) {
|
||||||
|
return {
|
||||||
|
minutesSaved: row.minutesSaved,
|
||||||
|
segmentCount: row.segmentCount,
|
||||||
|
};
|
||||||
|
} else {
|
||||||
|
return {
|
||||||
|
minutesSaved: 0,
|
||||||
|
segmentCount: 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function dbGetUsername (userID) {
|
||||||
|
try {
|
||||||
|
let row = db.prepare('get', "SELECT userName FROM userNames WHERE userID = ?", [userID]);
|
||||||
|
if (row !== undefined) {
|
||||||
|
return row.userName;
|
||||||
|
} else {
|
||||||
|
//no username yet, just send back the userID
|
||||||
|
return userID;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function dbGetViewsForUser (userID) {
|
||||||
|
try {
|
||||||
|
let row = db.prepare('get', "SELECT SUM(views) as viewCount FROM sponsorTimes WHERE userID = ? AND votes > -2 AND shadowHidden != 1", [userID]);
|
||||||
|
//increase the view count by one
|
||||||
|
if (row.viewCount != null) {
|
||||||
|
return row.viewCount;
|
||||||
|
} else {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = function getUserInfo (req, res) {
|
||||||
|
let userID = req.query.userID;
|
||||||
|
|
||||||
|
if (userID == undefined) {
|
||||||
|
//invalid request
|
||||||
|
res.status(400).send('Parameters are not valid');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
//hash the userID
|
||||||
|
userID = getHash(userID);
|
||||||
|
|
||||||
|
const segmentsSummary = dbGetSubmittedSegmentSummary(userID);
|
||||||
|
res.send({
|
||||||
|
userID,
|
||||||
|
userName: dbGetUsername(userID),
|
||||||
|
minutesSaved: segmentsSummary.minutesSaved,
|
||||||
|
segmentCount: segmentsSummary.segmentCount,
|
||||||
|
viewCount: dbGetViewsForUser(userID),
|
||||||
|
});
|
||||||
|
}
|
||||||
101
test/cases/getUserInfo.js
Normal file
101
test/cases/getUserInfo.js
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
var request = require('request');
|
||||||
|
var utils = require('../utils.js');
|
||||||
|
var db = require('../../src/databases/databases.js').db;
|
||||||
|
var getHash = require('../../src/utils/getHash.js');
|
||||||
|
|
||||||
|
describe('getUserInfo', () => {
|
||||||
|
before(() => {
|
||||||
|
let startOfUserNamesQuery = "INSERT INTO userNames (userID, userName) VALUES";
|
||||||
|
db.exec(startOfUserNamesQuery + "('" + getHash("getuserinfo_user_01") + "', 'Username user 01')");
|
||||||
|
let startOfSponsorTimesQuery = "INSERT INTO sponsorTimes (videoID, startTime, endTime, votes, UUID, userID, timeSubmitted, views, category, shadowHidden) VALUES";
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('xxxyyyzzz', 1, 11, 2, 'uuid000001', '" + getHash("getuserinfo_user_01") + "', 0, 10, 'sponsor', 0)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('xxxyyyzzz', 1, 11, 2, 'uuid000002', '" + getHash("getuserinfo_user_01") + "', 0, 10, 'sponsor', 0)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('yyyxxxzzz', 1, 11, -1, 'uuid000003', '" + getHash("getuserinfo_user_01") + "', 0, 10, 'sponsor', 0)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('yyyxxxzzz', 1, 11, -2, 'uuid000004', '" + getHash("getuserinfo_user_01") + "', 0, 10, 'sponsor', 1)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('xzzzxxyyy', 1, 11, -5, 'uuid000005', '" + getHash("getuserinfo_user_01") + "', 0, 10, 'sponsor', 1)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('zzzxxxyyy', 1, 11, 2, 'uuid000006', '" + getHash("getuserinfo_user_02") + "', 0, 10, 'sponsor', 0)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('xxxyyyzzz', 1, 11, 2, 'uuid000007', '" + getHash("getuserinfo_user_02") + "', 0, 10, 'sponsor', 1)");
|
||||||
|
db.exec(startOfSponsorTimesQuery + "('xxxyyyzzz', 1, 11, 2, 'uuid000008', '" + getHash("getuserinfo_user_02") + "', 0, 10, 'sponsor', 1)");
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Should be able to get a 200', (done) => {
|
||||||
|
request.get(utils.getbaseURL()
|
||||||
|
+ '/api/getUserInfo?userID=getuserinfo_user_01', null,
|
||||||
|
(err, res, body) => {
|
||||||
|
if (err) {
|
||||||
|
done('couldn\'t call endpoint');
|
||||||
|
} else {
|
||||||
|
if (res.statusCode !== 200) {
|
||||||
|
done('non 200');
|
||||||
|
} else {
|
||||||
|
done(); // pass
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Should be able to get a 400 (No userID parameter)', (done) => {
|
||||||
|
request.get(utils.getbaseURL()
|
||||||
|
+ '/api/getUserInfo', null,
|
||||||
|
(err, res, body) => {
|
||||||
|
if (err) {
|
||||||
|
done('couldn\'t call endpoint');
|
||||||
|
} else {
|
||||||
|
if (res.statusCode !== 400) {
|
||||||
|
done('non 400');
|
||||||
|
} else {
|
||||||
|
done(); // pass
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Should return info', (done) => {
|
||||||
|
request.get(utils.getbaseURL()
|
||||||
|
+ '/api/getUserInfo?userID=getuserinfo_user_01', null,
|
||||||
|
(err, res, body) => {
|
||||||
|
if (err) {
|
||||||
|
done("couldn't call endpoint");
|
||||||
|
} else {
|
||||||
|
if (res.statusCode !== 200) {
|
||||||
|
done("non 200");
|
||||||
|
} else {
|
||||||
|
const data = JSON.parse(body);
|
||||||
|
if (data.userName !== 'Username user 01') {
|
||||||
|
return done('Returned incorrect userName "' + data.userName + '"');
|
||||||
|
}
|
||||||
|
if (data.minutesSaved !== 5) {
|
||||||
|
return done('Returned incorrect minutesSaved "' + data.minutesSaved + '"');
|
||||||
|
}
|
||||||
|
if (data.viewCount !== 30) {
|
||||||
|
return done('Returned incorrect viewCount "' + data.viewCount + '"');
|
||||||
|
}
|
||||||
|
if (data.segmentCount !== 3) {
|
||||||
|
return done('Returned incorrect segmentCount "' + data.segmentCount + '"');
|
||||||
|
}
|
||||||
|
done(); // pass
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Should return userID for userName (No userName set)', (done) => {
|
||||||
|
request.get(utils.getbaseURL()
|
||||||
|
+ '/api/getUserInfo?userID=getuserinfo_user_02', null,
|
||||||
|
(err, res, body) => {
|
||||||
|
if (err) {
|
||||||
|
done('couldn\'t call endpoint');
|
||||||
|
} else {
|
||||||
|
if (res.statusCode !== 200) {
|
||||||
|
done('non 200');
|
||||||
|
} else {
|
||||||
|
const data = JSON.parse(body);
|
||||||
|
if (data.userName !== 'c2a28fd225e88f74945794ae85aef96001d4a1aaa1022c656f0dd48ac0a3ea0f') {
|
||||||
|
return done('Did not return userID for userName');
|
||||||
|
}
|
||||||
|
done(); // pass
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user