apitech
/
Rocket.Chat
mirror of https://github.com/RocketChat/Rocket.Chat
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Break all the stuff and remove the deprecated endpoints

Browse Source
pull/5140/head
Bradley Hilton 9 years ago
parent a94d2f714f
commit 50c932dc0e
3 changed files with 13 additions and 281 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 11
      packages/rocketchat-api/server/v1/channels.js
  2. 3
      server/restapi/README.md
  3. 280
      server/restapi/restapi.coffee

11
packages/rocketchat-api/server/v1/channels.js
Unescape View File

@ -13,7 +13,7 @@ function findChannelById(roomId) {
return room;
}
RocketChat.API.v1.addRoute('channel.addall', { authRequired: true }, {
RocketChat.API.v1.addRoute('channels.addAll', { authRequired: true }, {
post: function() {
const findResult = findChannelById(this.bodyParams.roomId);
@ -334,6 +334,15 @@ RocketChat.API.v1.addRoute('channels.list', { authRequired: true }, {
}
});
RocketChat.API.v1.addRoute('channels.list.joined', { authRequired: true }, {
get: function() {
const roomIds = _.pluck(RocketChat.models.Subscriptions.findByTypeAndUserId('p', this.userId).fetch(), 'rid');
return RocketChat.API.v1.success({
channels: RocketChat.models.Rooms.findByIds(roomIds).fetch()
});
}
});
RocketChat.API.v1.addRoute('channels.open', { authRequired: true }, {
post: function() {
const findResult = findChannelById(this.bodyParams.roomId);

3
server/restapi/README.md
Unescape View File

@ -0,0 +1,3 @@
# Important Information
The REST API has moved to `/api/v1/${endpoint}`, please see the [Rocket.Chat Documentation](https://rocket.chat/docs/developer-guides/rest-api) for details on the current REST API. If a feature is currently, feel free to open a new pull request to add it. :heart:

280
server/restapi/restapi.coffee
Unescape View File

@ -1,280 +0,0 @@
Api = new Restivus
useDefaultAuth: true
prettyJson: true
enableCors: false
Api.addRoute 'info', authRequired: false,
get: -> RocketChat.Info
Api.addRoute 'version', authRequired: false,
get: ->
version = {api: '0.1', rocketchat: '0.5'}
status: 'success', versions: version
Api.addRoute 'publicRooms', authRequired: true,
get: ->
rooms = RocketChat.models.Rooms.findByType('c', { sort: { msgs:-1 } }).fetch()
status: 'success', rooms: rooms
###
@api {get} /joinedRooms Get joined rooms.
###
Api.addRoute 'joinedRooms', authRequired: true,
get: ->
rooms = RocketChat.models.Rooms.findByContainigUsername(@user.username).fetch()
status: 'success', rooms: rooms
# join a room
Api.addRoute 'rooms/:id/join', authRequired: true,
post: ->
Meteor.runAsUser this.userId, () =>
Meteor.call('joinRoom', @urlParams.id)
status: 'success' # need to handle error
# leave a room
Api.addRoute 'rooms/:id/leave', authRequired: true,
post: ->
Meteor.runAsUser this.userId, () =>
Meteor.call('leaveRoom', @urlParams.id)
status: 'success' # need to handle error
###
@api {get} /rooms/:id/messages?skip=:skip&limit=:limit Get messages in a room.
@apiParam {Number} id Room ID
@apiParam {Number} [skip=0] Number of results to skip at the beginning
@apiParam {Number} [limit=50] Maximum number of results to return
###
Api.addRoute 'rooms/:id/messages', authRequired: true,
get: ->
try
rid = @urlParams.id
# `variable | 0` means converting to int
skip = @queryParams.skip | 0 or 0
limit = @queryParams.limit | 0 or 50
limit = 50 if limit > 50
if Meteor.call('canAccessRoom', rid, this.userId)
msgs = RocketChat.models.Messages.findVisibleByRoomId(rid,
sort:
ts: -1
skip: skip
limit: limit
).fetch()
status: 'success', messages: msgs
else
statusCode: 403 # forbidden
body: status: 'fail', message: 'Cannot access room.'
catch e
statusCode: 400 # bad request or other errors
body: status: 'fail', message: e.name + ' :: ' + e.message
# send a message in a room - POST body should be { "msg" : "this is my message"}
Api.addRoute 'rooms/:id/send', authRequired: true,
post: ->
Meteor.runAsUser this.userId, () =>
console.log @bodyParams.msg
Meteor.call('sendMessage', {msg: this.bodyParams.msg, rid: @urlParams.id} )
status: 'success' #need to handle error
# get list of online users in a room
Api.addRoute 'rooms/:id/online', authRequired: true,
get: ->
room = RocketChat.models.Rooms.findOneById @urlParams.id
online = RocketChat.models.Users.findUsersNotOffline(fields:
username: 1
status: 1).fetch()
onlineInRoom = []
for user, i in online
if room.usernames.indexOf(user.username) != -1
onlineInRoom.push user.username
status: 'success', online: onlineInRoom
# validate an array of users
Api.testapiValidateUsers = (users) ->
for user, i in users
if user.name?
if user.email?
if user.pass?
try
nameValidation = new RegExp '^' + RocketChat.settings.get('UTF8_Names_Validation') + '$', 'i'
catch
nameValidation = new RegExp '^[0-9a-zA-Z-_.]+$', 'i'
if nameValidation.test user.name
if /\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+\b/i.test user.email
continue
throw new Meteor.Error 'invalid-user-record', "[restapi] bulk/register -> record #" + i + " is invalid"
return
###
@api {post} /bulk/register Register multiple users based on an input array.
@apiName register
@apiGroup TestAndAdminAutomation
@apiVersion 0.0.1
@apiDescription Caller must have 'testagent' or 'adminautomation' role.
NOTE: remove room is NOT recommended; use Meteor.reset() to clear db and re-seed instead
@apiParam {json} rooms An array of users in the body of the POST.
@apiParamExample {json} POST Request Body example:
{
'users':[ {'email': 'user1@user1.com',
'name': 'user1',
'pass': 'abc123' },
{'email': 'user2@user2.com',
'name': 'user2',
'pass': 'abc123'},
...
]
}
@apiSuccess {json} ids An array of IDs of the registered users.
@apiSuccessExample {json} Success-Response:
HTTP/1.1 200 OK
{
'ids':[ {'uid': 'uid_1'},
{'uid': 'uid_2'},
...
]
}
###
Api.addRoute 'bulk/register', authRequired: true,
post:
# restivus 0.8.4 does not support alanning:roles using groups
#roleRequired: ['testagent', 'adminautomation']
action: ->
if RocketChat.authz.hasPermission(@userId, 'bulk-register-user')
try
Api.testapiValidateUsers @bodyParams.users
this.response.setTimeout (500 * @bodyParams.users.length)
ids = []
endCount = @bodyParams.users.length - 1
for incoming, i in @bodyParams.users
ids[i] = {uid: Meteor.call 'registerUser', incoming}
Meteor.runAsUser ids[i].uid, () =>
Meteor.call 'setUsername', incoming.name
status: 'success', ids: ids
catch e
statusCode: 400 # bad request or other errors
body: status: 'fail', message: e.name + ' :: ' + e.message
else
console.log '[restapi] bulk/register -> '.red, "User does not have 'bulk-register-user' permission"
statusCode: 403
body: status: 'error', message: 'You do not have permission to do this'
# validate an array of rooms
Api.testapiValidateRooms = (rooms) ->
for room, i in rooms
if room.name?
if room.members?
if room.members.length > 0
try
nameValidation = new RegExp '^' + RocketChat.settings.get('UTF8_Names_Validation') + '$', 'i'
catch
nameValidation = new RegExp '^[0-9a-zA-Z-_.]+$', 'i'
if nameValidation.test room.name
continue
throw new Meteor.Error 'invalid-room-record', "[restapi] bulk/createRoom -> record #" + i + " is invalid"
return
###
@api {post} /bulk/createRoom Create multiple rooms based on an input array.
@apiName createRoom
@apiGroup TestAndAdminAutomation
@apiVersion 0.0.1
@apiParam {json} rooms An array of rooms in the body of the POST. 'name' is room name, 'members' is array of usernames
@apiParamExample {json} POST Request Body example:
{
'rooms':[ {'name': 'room1',
'members': ['user1', 'user2']
},
{'name': 'room2',
'members': ['user1', 'user2', 'user3']
}
...
]
}
@apiDescription Caller must have 'testagent' or 'adminautomation' role.
NOTE: remove room is NOT recommended; use Meteor.reset() to clear db and re-seed instead
@apiSuccess {json} ids An array of ids of the rooms created.
@apiSuccessExample {json} Success-Response:
HTTP/1.1 200 OK
{
'ids':[ {'rid': 'rid_1'},
{'rid': 'rid_2'},
...
]
}
###
Api.addRoute 'bulk/createRoom', authRequired: true,
post:
# restivus 0.8.4 does not support alanning:roles using groups
#roleRequired: ['testagent', 'adminautomation']
action: ->
# user must also have create-c permission because
# createChannel method requires it
if RocketChat.authz.hasPermission(@userId, 'bulk-create-c')
try
this.response.setTimeout (1000 * @bodyParams.rooms.length)
Api.testapiValidateRooms @bodyParams.rooms
ids = []
Meteor.runAsUser this.userId, () =>
(if incoming.private
ids[i] = Meteor.call 'createPrivateGroup', incoming.name, incoming.members
else
ids[i] = Meteor.call 'createChannel', incoming.name, incoming.members) for incoming,i in @bodyParams.rooms
status: 'success', ids: ids # need to handle error
catch e
statusCode: 400 # bad request or other errors
body: status: 'fail', message: e.name + ' :: ' + e.message
else
console.log '[restapi] bulk/createRoom -> '.red, "User does not have 'bulk-create-c' permission"
statusCode: 403
body: status: 'error', message: 'You do not have permission to do this'
# archive a room by it's ID
Api.addRoute 'room/:id/archive', authRequired: true,
post:
action: ->
# user must also have archive-room permission
if RocketChat.authz.hasPermission(@userId, 'archive-room')
try
Meteor.runAsUser this.userId, () =>
Meteor.call('archiveRoom', @urlParams.id)
status: 'success' # need to handle error
catch e
statusCode: 400 # bad request or other errors
body: status: 'fail', message: e.name + ' :: ' + e.message
else
console.log '[restapi] archiveRoom -> '.red, "User does not have 'archive-room' permission"
statusCode: 403
body: status: 'error', message: 'You do not have permission to do this'
# unarchive a room by it's ID
Api.addRoute 'room/:id/unarchive', authRequired: true,
post:
action: ->
# user must also have unarchive-room permission
if RocketChat.authz.hasPermission(@userId, 'unarchive-room')
try
Meteor.runAsUser this.userId, () =>
Meteor.call('unarchiveRoom', @urlParams.id)
status: 'success' # need to handle error
catch e
statusCode: 400 # bad request or other errors
body: status: 'fail', message: e.name + ' :: ' + e.message
else
console.log '[restapi] unarchiveRoom -> '.red, "User does not have 'unarchive-room' permission"
statusCode: 403
body: status: 'error', message: 'You do not have permission to do this'
Write Preview
Loading…
Cancel
Save