Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add user parameter to projects. #290

Merged
merged 5 commits into from
Jun 14, 2016
Merged

Add user parameter to projects. #290

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
93dba5e
Test user parameter on objects.
Jun 13, 2016
858a212
Move username into variable.
Jun 13, 2016
95065a2
WIP. Adding implementation.
Jun 14, 2016
4b52a2a
Fixed. Projects can be filtered.
Jun 14, 2016
31ca127
times -> projects
Jun 14, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 92 additions & 40 deletions src/projects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,45 +50,100 @@ module.exports = function(app) {
return outProject;
}

authRequest.get(app, app.get('version') + '/projects',
function(req, res) {
const knex = app.get('knex');
let projectsQ;
function compileProjectsQueryPromise(req, res, additional) {
return new Promise(function(resolve, reject) {
const knex = app.get('knex');
let projectsQ = knex('projects');

projectsQ = projectsQ.select(
// Select the 'slugs' to be the projectslugs name
'projectslugs.name as slug',
// Explicitly select everything else from projects
'projects.uri as uri',
'projects.name as name',
'projects.uuid as uuid',
'activities.slug as default_activity',
'projects.revision as revision',
'projects.deleted_at as deleted_at',
'projects.updated_at as updated_at',
'projects.created_at as created_at',
'projects.newest as newest',
'projects.id as id') // id will be stripped in constructProject() anyway
// Order them from most recently updated to last updated
.orderBy('projects.revision')
// Do a left join so we keep projects without a slug field
// https://en.wikipedia.org/wiki/Join_(SQL)#Left_outer_join for more info.
.leftOuterJoin('projectslugs', 'projects.id', 'projectslugs.project')
.leftOuterJoin('activities', 'projects.default_activity', 'activities.id')
;
// Yes this code is duplicated in both GET endpoints. If you have strong
// feelings about this, change it. kthnkxby

if (additional) { projectsQ = projectsQ.andWhere(additional); }

if (req.query) {
// Query for soft-deleted projects when include_deleted=true or if the
// param is passed (and not set to anything)
if (req.query.include_deleted === 'false' ||
req.query.include_deleted === undefined) {
projectsQ = projectsQ.where({'projects.deleted_at': null});
}

if (req.query.include_deleted === 'true' ||
req.query.include_deleted === '') {
projectsQ = knex('projects');
} else {
projectsQ = knex('projects').where({'projects.deleted_at': null});
}
if (req.query.user && req.query.user.length) {
let userArr = null;
// It is a string,
if (typeof req.query.user === 'string') {
// append it to the projectsQ query
userArr = [req.query.user];
// It is an array
} else if (helpers.getType(req.query.user) === 'array' &&
// with string elements
helpers.getType(req.query.user[0]) === 'string') {
// Append the array to the projectsQ query
userArr = req.query.user;
}

projectsQ = projectsQ.select(
// Select the 'slugs' to be the projectslugs name
'projectslugs.name as slug',
// Explicitly select everything else from projects
'projects.uri as uri',
'projects.name as name',
'projects.uuid as uuid',
'activities.slug as default_activity',
'projects.revision as revision',
'projects.deleted_at as deleted_at',
'projects.updated_at as updated_at',
'projects.created_at as created_at',
'projects.newest as newest',
'projects.id as id') // id will be stripped in constructProject() anyway
// Order them from most recently updated to last updated
.orderBy('projects.revision')
// Do a left join so we keep projects without a slug field
// https://en.wikipedia.org/wiki/Join_(SQL)#Left_outer_join for more info.
.leftOuterJoin('projectslugs', 'projects.id', 'projectslugs.project')
.leftOuterJoin('activities', 'projects.default_activity', 'activities.id');
// Yes this code is duplicated in both GET endpoints. If you have strong
// feelings about this, change it. kthnkxby
if (userArr) {
// Check that the user we just parsed is in the database
knex('users').whereIn('username', userArr).map(function(y) {
return y.id;
}).then(function(x) {
if (x.length !== 0) {
// append it to the timesQ query
knex('userroles').whereIn('user', x).map(function(y) {
return y.project;
}).then(function(y) {
projectsQ = projectsQ.whereIn('projects.id', y);

resolve(projectsQ);
});
} else {
// Send an error if the user is not found in the database
reject(errors.errorBadQueryValue('user', req.query.user));
}
}).catch(function(error) {
log.error(req, 'Error selecting users for filter: ' + error);
reject(errors.errorServerError(error));
});
} else {
reject(errors.errorBadQueryValue('user', req.query.user));
}
} else {
resolve(projectsQ);
}
} else {
resolve(projectsQ);
}
});
}

authRequest.get(app, app.get('version') + '/projects',
function(req, res) {
const knex = app.get('knex');
// The 'include_revisions' query parameter was included
if (req.query.include_revisions === 'true' ||
req.query.include_revisions === '') {
projectsQ.then(function(projects) {
compileProjectsQueryPromise(req, res).then(function(projects) {
if (projects.length === 0) {
return res.send([]);
}
Expand Down Expand Up @@ -141,13 +196,11 @@ module.exports = function(app) {
return errors.send(errors.errorServerError(error), res);
});
}).catch(function(error) {
log.error(req, 'Error requesting projects: ' + error);
return errors.send(errors.errorServerError(error), res);
return errors.send(error, res);
});
} else {
// If the 'slugs' field is null that means the object is a parent
// Children may have empty slug fields `[]` but not null.
projectsQ.where({'projects.newest': true}).then(function(projects) {
compileProjectsQueryPromise(req, res, {'projects.newest': true})
.then(function(projects) {
if (projects.length === 0) {
return res.send([]);
}
Expand Down Expand Up @@ -192,8 +245,7 @@ module.exports = function(app) {
return errors.send(errors.errorServerError(error), res);
});
}).catch(function(error) {
log.error(req, 'Error requestings projects: ' + error);
return errors.send(errors.errorServerError(error), res);
return errors.send(error, res);
});
}
});
Expand Down
41 changes: 41 additions & 0 deletions tests/projects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,47 @@ module.exports = function(expect, request, baseUrl) {
});
});

describe('GET /projects?user=:username', function() {
it('returns all times for a user', function(done) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you mean "returns all projects for a user"?

getAPIToken().then(function(token) {
const username = 'tschuy';
request.get(baseUrl + 'projects?user=' + username + '&token=' + token,
function(err, res, body) {
expect(err).to.equal(null);

const jsonBody = JSON.parse(body);
const expectedResult = initialData.filter(function(project) {
return project.users[username];
});

expect(jsonBody).to.deep.equal(expectedResult);
expect(res.statusCode).to.equal(200);
done();
});
});
});

it('returns an error for a nonexistent user', function(done) {
getAPIToken().then(function(token) {
request.get(baseUrl + 'projects?user=notauser&token=' + token,
function(err, res, body) {
expect(err).to.equal(null);

const jsonBody = JSON.parse(body);
const expectedResult = {
error: 'Bad Query Value',
text: 'Parameter user contained invalid value notauser',
status: 400,
};

expect(jsonBody).to.deep.equal(expectedResult);
expect(res.statusCode).to.equal(expectedResult.status);
done();
});
});
});
});

describe('GET /projects/:slug', function() {
it('should return projects by slug', function(done) {
getAPIToken().then(function(token) {
Expand Down