habitica/test/api.mocha.coffee

512 lines
18 KiB
CoffeeScript
Raw Normal View History

2013-05-23 16:34:27 +00:00
_ = require 'lodash'
2013-02-21 19:18:53 +00:00
request = require 'superagent'
2013-02-26 21:44:26 +00:00
expect = require 'expect.js'
2013-02-26 07:55:33 +00:00
require 'coffee-script'
2013-04-21 15:53:36 +00:00
utils = require 'derby-auth/utils'
async = require 'async'
2013-02-20 18:35:21 +00:00
2013-02-27 22:06:47 +00:00
conf = require("nconf")
2013-02-28 23:24:14 +00:00
conf.argv().env().file({file: __dirname + '../config.json'}).defaults
2013-02-27 22:06:47 +00:00
# Override normal ENV values with nconf ENV values (ENV values are used the same way without nconf)
2013-02-28 23:24:14 +00:00
#FIXME can't get nconf file above to load...
2013-02-27 22:06:47 +00:00
process.env.BASE_URL = conf.get("BASE_URL")
process.env.FACEBOOK_KEY = conf.get("FACEBOOK_KEY")
process.env.FACEBOOK_SECRET = conf.get("FACEBOOK_SECRET")
2013-03-13 00:52:44 +00:00
process.env.NODE_DB_URI = 'mongodb://localhost/habitrpg'
2013-02-27 22:06:47 +00:00
2013-02-25 07:43:50 +00:00
## monkey-patch expect.js for better diffs on mocha
## see: https://github.com/LearnBoost/expect.js/pull/34
origBe = expect.Assertion::be
expect.Assertion::be = expect.Assertion::equal = (obj) ->
@_expected = obj
origBe.call this, obj
2013-02-20 18:35:21 +00:00
# Custom modules
helpers = require 'habitrpg-shared/script/helpers'
2013-02-20 18:35:21 +00:00
###### Helpers & Variables ######
model = null
uuid = null
taskPath = null
2013-02-26 07:56:47 +00:00
baseURL = 'http://localhost:1337/api/v1'
2013-02-20 18:35:21 +00:00
expectUserEqual = (u1, u2) ->
'lastCron update__'.split(' ').forEach (path) ->
delete u1[path]; delete u2[path]
expect(u1).to.eql(u2)
2013-02-20 18:35:21 +00:00
###### Specs ######
describe 'API', ->
2013-02-26 08:48:10 +00:00
server = null
store = null
model = null
user = null
uid = null
token = null
2013-04-21 15:53:36 +00:00
username = null
2013-02-26 08:48:10 +00:00
###
Function for registring new users, so we can futz with data
###
registerNewUser = (cb) ->
randomID = model.id()
params =
username: randomID
password: randomID
confirmPassword: randomID
email: "#{randomID}@gmail.com"
request.post("#{baseURL}/register")
.set('Accept', 'application/json')
.send(params)
.end (res) ->
cb(res.body)
2013-02-26 07:55:33 +00:00
before (done) ->
server = require '../src/server'
server.listen '1337', '0.0.0.0', ->
2013-02-26 08:48:10 +00:00
store = server.habitStore
#store.flush()
model = store.createModel()
# nasty hack, why isn't server.listen callback fired when server is completely up?
setTimeout done, 2000
2013-02-26 07:36:51 +00:00
2013-02-21 01:04:09 +00:00
describe 'Without token or user id', ->
2013-02-20 18:35:21 +00:00
2013-02-22 18:56:24 +00:00
it '/api/v1/status', (done) ->
request.get("#{baseURL}/status")
.set('Accept', 'application/json')
.end (res) ->
2013-02-23 09:45:00 +00:00
expect(res.statusCode).to.be 200
expect(res.body.status).to.be 'up'
2013-02-22 18:56:24 +00:00
done()
2013-02-21 01:04:09 +00:00
it '/api/v1/user', (done) ->
2013-02-22 01:17:23 +00:00
request.get("#{baseURL}/user")
2013-02-21 19:18:53 +00:00
.set('Accept', 'application/json')
.end (res) ->
2013-02-26 21:44:26 +00:00
expect(res.statusCode).to.be 401
2013-02-23 09:45:00 +00:00
expect(res.body.err).to.be 'You must include a token and uid (user id) in your request'
2013-02-21 19:18:53 +00:00
done()
2013-02-20 18:35:21 +00:00
2013-02-21 01:04:09 +00:00
describe 'With token and user id', ->
2013-02-25 04:00:22 +00:00
params = null
currentUser = null
before (done) ->
registerNewUser (_res) ->
[uid, token, username] = [_res.id, _res.apiToken, _res.auth.local.username]
model.query('users').withIdAndToken(uid, token).fetch (err, _user) ->
console.error {err} if err
user = _user
params =
title: 'Title'
text: 'Text'
type: 'habit'
done()
2013-02-20 18:35:21 +00:00
2013-02-25 04:00:22 +00:00
beforeEach ->
currentUser = user.get()
it 'GET /api/v1/user', (done) ->
2013-02-23 03:24:21 +00:00
request.get("#{baseURL}/user")
.set('Accept', 'application/json')
2013-02-25 07:43:50 +00:00
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
2013-02-23 03:24:21 +00:00
.end (res) ->
2013-02-25 04:00:22 +00:00
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body.id).not.to.be.empty()
2013-02-26 08:48:10 +00:00
self = _.clone(currentUser)
2013-02-27 22:10:20 +00:00
delete self.apiToken
self.stats.toNextLevel = 150
2013-03-06 14:11:14 +00:00
self.stats.maxHealth = 50
2013-02-26 08:48:10 +00:00
expectUserEqual(res.body, self)
2013-02-25 04:00:22 +00:00
done()
2013-03-01 20:11:35 +00:00
it 'GET /api/v1/user/task/:id', (done) ->
2013-02-26 20:21:17 +00:00
tid = _.pluck(currentUser.tasks, 'id')[0]
2013-03-01 20:11:35 +00:00
request.get("#{baseURL}/user/task/#{tid}")
2013-02-26 07:36:51 +00:00
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body).to.eql currentUser.tasks[tid]
done()
2013-02-25 04:00:22 +00:00
it 'POST /api/v1/user/task', (done) ->
2013-02-23 08:20:16 +00:00
request.post("#{baseURL}/user/task")
2013-02-21 19:18:53 +00:00
.set('Accept', 'application/json')
2013-02-25 07:43:50 +00:00
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
2013-02-22 01:38:12 +00:00
.send(params)
2013-02-21 19:18:53 +00:00
.end (res) ->
2013-02-26 08:48:10 +00:00
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 201
expect(res.body.id).not.to.be.empty()
# Ensure that user owns the newly created object
2013-02-27 00:17:11 +00:00
expect(user.get().tasks[res.body.id]).to.be.an('object')
2013-02-26 08:48:10 +00:00
done()
2013-02-25 04:00:22 +00:00
it 'POST /api/v1/user/task (without type)', (done) ->
request.post("#{baseURL}/user/task")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send({})
.end (res) ->
2013-03-01 11:03:05 +00:00
expect(res.body.err).to.be 'type must be habit, todo, daily, or reward'
expect(res.statusCode).to.be 400
done()
it 'POST /api/v1/user/task (only type)', (done) ->
request.post("#{baseURL}/user/task")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(type: 'habit')
.end (res) ->
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 201
expect(res.body.id).not.to.be.empty()
# Ensure that user owns the newly created object
expect(user.get().tasks[res.body.id]).to.be.an('object')
# Ensure that value gets set to 0 since not otherwise specified
expect(user.get().tasks[res.body.id].value).to.be.equal(0)
done()
2013-03-01 20:11:35 +00:00
it 'PUT /api/v1/user/task/:id', (done) ->
2013-02-26 20:21:17 +00:00
tid = _.pluck(currentUser.tasks, 'id')[0]
2013-03-01 20:11:35 +00:00
request.put("#{baseURL}/user/task/#{tid}")
2013-02-26 20:21:17 +00:00
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(text: 'bye')
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
currentUser.tasks[tid].text = 'bye'
expect(res.body).to.eql currentUser.tasks[tid]
done()
2013-03-01 20:11:35 +00:00
it 'PUT /api/v1/user/task/:id (shouldnt update type)', (done) ->
2013-03-01 10:48:49 +00:00
tid = _.pluck(currentUser.tasks, 'id')[1]
type = if currentUser.tasks[tid].type is 'habit' then 'daily' else 'habit'
2013-03-01 20:11:35 +00:00
request.put("#{baseURL}/user/task/#{tid}")
2013-03-01 10:48:49 +00:00
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(type: type, text: 'fishman')
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
currentUser.tasks[tid].text = 'fishman'
expect(res.body).to.eql currentUser.tasks[tid]
done()
2013-03-01 20:11:35 +00:00
it 'PUT /api/v1/user/task/:id (update notes)', (done) ->
2013-03-01 10:48:49 +00:00
tid = _.pluck(currentUser.tasks, 'id')[2]
2013-03-01 20:11:35 +00:00
request.put("#{baseURL}/user/task/#{tid}")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(text: 'hi',notes:'foobar matey')
2013-02-26 20:21:17 +00:00
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
2013-02-27 00:17:11 +00:00
currentUser.tasks[tid].text = 'hi'
currentUser.tasks[tid].notes = 'foobar matey'
2013-02-26 20:21:17 +00:00
expect(res.body).to.eql currentUser.tasks[tid]
done()
2013-02-25 04:00:22 +00:00
it 'GET /api/v1/user/tasks', (done) ->
request.get("#{baseURL}/user/tasks")
.set('Accept', 'application/json')
2013-02-25 07:43:50 +00:00
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
2013-02-25 04:00:22 +00:00
.end (res) ->
2013-02-26 08:48:10 +00:00
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
2013-02-27 00:17:11 +00:00
model.ref '_user', user
2013-02-26 08:48:10 +00:00
tasks = []
for type in ['habit','todo','daily','reward']
model.refList "_#{type}List", "_user.tasks", "_user.#{type}Ids"
tasks = tasks.concat model.get("_#{type}List")
# Ensure that user owns the tasks
expect(res.body.length).to.equal tasks.length
# Ensure that the two sets are equal
expect(_.difference(_.pluck(res.body,'id'), _.pluck(tasks,'id')).length).to.equal 0
done()
2013-02-26 21:44:26 +00:00
it 'GET /api/v1/user/tasks (todos)', (done) ->
request.get("#{baseURL}/user/tasks")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.query(type:'todo')
.end (res) ->
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
2013-02-27 00:17:11 +00:00
model.ref '_user', user
2013-02-26 21:44:26 +00:00
model.refList "_todoList", "_user.tasks", "_user.todoIds"
tasks = model.get("_todoList")
# Ensure that user owns the tasks
expect(res.body.length).to.equal tasks.length
# Ensure that the two sets are equal
expect(_.difference(_.pluck(res.body,'id'), _.pluck(tasks,'id')).length).to.equal 0
done()
2013-03-09 07:08:50 +00:00
it 'DELETE /api/v1/user/task/:id', (done) ->
tid = currentUser.habitIds[2]
request.del("#{baseURL}/user/task/#{tid}")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 204
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(user.get('habitIds').indexOf(tid)).to.be -1
expect(user.get("tasks.#{tid}")).to.be undefined
2013-03-09 07:08:50 +00:00
done()
it 'DELETE /api/v1/user/task/:id (no task found)', (done) ->
tid = "adsfasdfjunkshouldntbeatask"
request.del("#{baseURL}/user/task/#{tid}")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.end (res) ->
expect(res.statusCode).to.be 400
expect(res.body.err).to.be 'No task found.'
done()
2013-03-20 20:52:32 +00:00
it 'POST /api/v1/user/task/:id/up (habit)', (done) ->
2013-03-20 20:52:32 +00:00
tid = currentUser.habitIds[0]
request.post("#{baseURL}/user/task/#{tid}/up")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send({})
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body).to.eql { gp: 1, exp: 7.5, lvl: 1, hp: 50, delta: 1 }
done()
it 'POST /api/v1/user/task/:id/up (daily)', (done) ->
tid = currentUser.dailyIds[0]
request.post("#{baseURL}/user/task/#{tid}/up")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send({})
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body).to.eql { gp: 2, exp: 15, lvl: 1, hp: 50, delta: 1 }
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(user.get("tasks.#{tid}.completed")).to.be true
done()
2013-03-22 20:52:33 +00:00
it 'POST /api/v1/user/task (array)', (done) ->
habitId = currentUser.habitIds[0]
dailyId = currentUser.dailyIds[0]
arr = [{
id: habitId
text: 'hello'
notes: 'note'
},{
text: 'new task'
notes: 'notes!'
},{
id: dailyId
del: true
}]
request.post("#{baseURL}/user/tasks")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(arr)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 201
expect(res.body[0]).to.eql {id: habitId,text: 'hello',notes: 'note'}
expect(res.body[1].id).to.be.a 'string'
expect(res.body[1].text).to.be 'new task'
expect(res.body[1].notes).to.be 'notes!'
expect(res.body[2]).to.eql deleted: true
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) ->
expect(user.get("tasks.#{habitId}")).to.eql {id: habitId,text: 'hello',notes: 'note'}
expect(user.get("tasks.#{dailyId}")).to.be undefined
expect(user.get("tasks.#{res.body[1].id}")).to.eql id: res.body[1].id, text: 'new task', notes: 'notes!'
done()
2013-04-12 19:53:44 +00:00
it 'PUT /api/v1/user', (done) ->
userBefore = {}
query = model.query('users').withIdAndToken(currentUser.id, currentUser.apiToken)
query.fetch (err, user) -> userBefore = user.get()
habitId = currentUser.habitIds[0]
dailyId = currentUser.dailyIds[0]
userUpdates =
stats:
hp: 30
flags:
itemsEnabled: true
tasks: [{
id: habitId
text: 'hello2'
notes: 'note2'
},{
text: 'new task2'
notes: 'notes2'
},{
id: dailyId
del: true
}]
request.put("#{baseURL}/user")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(user: userUpdates)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
2013-04-12 19:53:44 +00:00
tasks = res.body.tasks
2013-05-25 18:42:59 +00:00
expect(_.find(tasks,{id:habitId})).to.eql {id: habitId,text: 'hello2',notes: 'note2'}
2013-04-12 19:53:44 +00:00
2013-05-25 18:42:59 +00:00
foundNewTask = _.find(tasks,{text:'new task2'})
2013-04-12 19:53:44 +00:00
expect(foundNewTask.text).to.be 'new task2'
expect(foundNewTask.notes).to.be 'notes2'
2013-05-25 18:42:59 +00:00
found = _.find(res.body.tasks, {id:dailyId})
2013-04-12 19:53:44 +00:00
expect(found).to.not.be.ok()
query.fetch (err, user) ->
expect(user.get("tasks.#{habitId}")).to.eql {id: habitId, text: 'hello2',notes: 'note2'}
expect(user.get("tasks.#{dailyId}")).to.be undefined
tasks = res.body.tasks
expect(user.get("tasks.#{foundNewTask.id}")).to.eql id: foundNewTask.id, text: 'new task2', notes: 'notes2'
done()
2013-07-12 21:15:11 +00:00
it 'POST /api/v1/user/auth/local', (done) ->
2013-04-21 15:53:36 +00:00
userAuth =
username: username
password: 'icculus'
request.post("#{baseURL}/user/auth")
.set('Accept', 'application/json')
.send(userAuth)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body.id).to.be currentUser.id
expect(res.body.token).to.be currentUser.apiToken
done()
2013-07-12 21:15:11 +00:00
it 'POST /api/v1/user/auth/facebook', (done) ->
id = model.id()
userAuth = facebook_id: 12345, name: 'Tyler Renelle', email: 'x@y.com'
newUser = helpers.newUser(true)
newUser.id = id
newUser.auth = facebook:
id: userAuth.facebook_id
name: userAuth.name
email: userAuth.email
model.set "users.#{id}", newUser, ->
request.post("#{baseURL}/user/auth/facebook")
.set('Accept', 'application/json')
.send(userAuth)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expect(res.body.id).to.be newUser.id
#expect(res.body.token).to.be newUser.apiToken
done()
it 'POST /api/v1/batch-update (handles corrupt values)', (done) ->
registerNewUser (_res) ->
model.set '_userId', _res.id
model.session = {userId:_res.id}
# corrupt the tasks, and let's see how the server handles this
ids = _res.dailyIds
_res.tasks[ids[0]].value = NaN
_res.tasks[ids[1]].value = undefined
_res.tasks[ids[2]] = {}
_res.tasks["undefined"] = {}
_res.stats.hp = _res.stats.gp = NaN
_res.lastCron = +new Date('08/13/2013')
model.set "users.#{_res.id}", _res, ->
ops = [{'cron'}]
request.post("#{baseURL}/user/batch-update")
.set('Accept', 'application/json')
.set('X-API-User', _res.id)
.set('X-API-Key', _res.apiToken)
.send(ops)
.end (res) ->
expect(res.statusCode).to.be 200
console.log {stats:res.body.stats, tasks:res.body.tasks}
done()
it 'POST /api/v1/batch-update', (done) ->
userBefore = _.cloneDeep(currentUser)
habits = _.where currentUser.tasks, {type: 'habit'}
dailys = _.where currentUser.tasks, {type: 'dailys'}
todos = _.where currentUser.tasks, {type: 'todos'}
rewards = _.where currentUser.tasks, {type: 'rewards'}
jsonRaw = [
# Good scores
op: 'score', task: habits[0], dir: 'up'
op: 'score', task: habits[1], dir: 'down'
op: 'score', task: dailys[1], dir: 'up'
op: 'score', task: todos[1], dir: 'up'
# Bad scores, should handle gracefully
op: 'score', task: todos[2], dir: 'down'
op: 'score', task: {}, dir: 'up'
op: 'score', task: {id:null, value: NaN}, dir: 'up'
]
request.post("#{baseURL}/user/batch-update")
.set('Accept', 'application/json')
.set('X-API-User', currentUser.id)
.set('X-API-Key', currentUser.apiToken)
.send(jsonRaw)
.end (res) ->
expect(res.body.err).to.be undefined
expect(res.statusCode).to.be 200
expectUserEqual(userBefore, res.body)
done()