openhim-core

<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/api/roles.coffee</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../prettify.css" /> <link rel="stylesheet" href="../../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../../index.html">All files</a> / <a href="index.html">src/api</a> roles.coffee </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 10.16% Statements 13/128 </div> <div class='fl pad1y space-right2'> 0% Branches 0/58 </div> <div class='fl pad1y space-right2'> 0% Functions 0/10 </div> <div class='fl pad1y space-right2'> 10.48% Lines 13/124 </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265</td><td class="line-coverage quiet">1x 1x 1x 1x 1x                       1x                                                                     1x                               1x                                         1x                                                       1x                                                         1x                                                                             1x                                                                                                                       1x                                        </td><td class="text"><pre class="prettyprint lang-js">Channel = require('../model/channels').Channel Client = require('../model/clients').Client logger = require 'winston' authorisation = require './authorisation' utils = require '../utils'     ### # Roles is a virtual API; virtual in the sense that it is not linked # to a concrete roles collection. # # Rather it an abstraction of the 'allow' field on Channels and 'roles' on Clients, # providing a mechanism for setting up allowed permissions. ###     filterRolesFromChannels = (channels, clients) -> rolesMap = {} # K: permission, V: channels, clients that share permission   for ch in channels for permission in ch.allow isClient = false for cl in clients if cl.clientID is permission isClient = true   if not isClient if not rolesMap[permission] rolesMap[permission] = channels: [] clients: [] rolesMap[permission].channels.push _id: ch._id, name: ch.name   for cl in clients for permission in cl.roles if not rolesMap[permission] rolesMap[permission] = channels: [] clients: [] rolesMap[permission].clients.push _id: cl._id, clientID: cl.clientID   rolesArray = [] for role of rolesMap rolesArray.push name: role channels: rolesMap[role].channels clients: rolesMap[role].clients   return rolesArray     exports.getRoles = -> # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated return utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to getRoles denied.", 'info'   try channels = yield Channel.find({}, {name: 1, allow: 1 }).exec() clients = yield Client.find({}, {clientID: 1, roles: 1 }).exec()   this.body = filterRolesFromChannels channels, clients catch e logger.error "Could not fetch roles via the API: #{e.message}" this.message = e.message this.status = 500     exports.getRole = (name) -> # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated return utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to getRole denied.", 'info'   try channels = yield Channel.find({allow: {$in: [name]}}, {name: 1 }).exec() clients = yield Client.find({ roles: $in: [name]}, {clientID: 1 }).exec() if (channels is null or channels.length is 0) and (clients is null or clients.length is 0) utils.logAndSetResponse this, 404, "Role with name '#{name}' could not be found.", 'info' else this.body = name: name channels: channels.map (r) -> _id: r._id, name: r.name clients: clients.map (c) -> _id: c._id, clientID: c.clientID catch e logger.error "Could not find role with name '#{name}' via the API: #{e.message}" this.body = e.message this.status = 500     buildFindChannelByIdOrNameCriteria = (ctx, role) -> criteria = {} ids = [] names = [] for ch in role.channels if ch._id ids.push ch._id else if ch.name names.push ch.name else utils.logAndSetResponse ctx, 400, "_id and/or name must be specified for a channel", 'info' return null   if ids.length > 0 and names.length > 0 criteria = $or: [ _id: $in: ids , name: $in: names ] else if ids.length > 0 criteria._id = $in: ids if names.length > 0 criteria.name = $in: names   return criteria   buildFindClientByIdOrClientIDCriteria = (ctx, role) -> criteria = {} ids = [] clientIDs = [] for ch in role.clients if ch._id ids.push ch._id else if ch.clientID clientIDs.push ch.clientID else utils.logAndSetResponse ctx, 400, "_id and/or clientID must be specified for a client", 'info' return null   if ids.length > 0 and clientIDs.length > 0 criteria = $or: [ _id: $in: ids , clientID: $in: clientIDs ] else if ids.length > 0 criteria._id = $in: ids if clientIDs.length > 0 criteria.clientID = $in: clientIDs   return criteria     exports.addRole = -> # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated return utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to addRole denied.", 'info'   role = this.request.body if not role.name return utils.logAndSetResponse this, 400, 'Must specify a role name', 'info' if role.channels?.length is 0 and role.clients?.length is 0 return utils.logAndSetResponse this, 400, 'Must specify at least one channel or client to link the role to', 'info'   try chResult = yield Channel.find({allow: {$in: [role.name]}}, {name: 1 }).exec() clResult = yield Client.find({roles: {$in: [role.name]}}, {clientID: 1 }).exec() if chResult?.length > 0 or clResults?.length > 0 return utils.logAndSetResponse this, 400, "Role with name '#{role.name}' already exists.", 'info'   if role.channels chCriteria = buildFindChannelByIdOrNameCriteria this, role return if not chCriteria   if role.clients clCriteria = buildFindClientByIdOrClientIDCriteria this, role return if not clCriteria   if role.channels yield Channel.update(chCriteria, { $push: allow: role.name }, { multi: true }).exec() if role.clients yield Client.update(clCriteria, { $push: roles: role.name }, { multi: true }).exec()   logger.info "User #{this.authenticated.email} setup role '#{role.name}'" this.body = 'Role successfully created' this.status = 201 catch e logger.error "Could not add a role via the API: #{e.message}" this.body = e.message this.status = 400     exports.updateRole = (name) -> # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated return utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to updateRole denied.", 'info'   role = this.request.body   try # request validity checks chResult = yield Channel.find({allow: {$in: [name]}}, {name: 1 }).exec() clResult = yield Client.find({roles: {$in: [name]}}, {clientID: 1 }).exec() if (chResult is null or chResult.length is 0) and (clResult is null or clResult.length is 0) return utils.logAndSetResponse this, 404, "Role with name '#{name}' could not be found.", 'info'   if role.name # do check here but only perform rename updates later after channel/client updates channels = yield Channel.find({allow: {$in: [role.name]}}, {name: 1 }).exec() clients = yield Client.find({roles: {$in: [role.name]}}, {name: 1 }).exec() if channels?.length > 0 or clients?.length > 0 return utils.logAndSetResponse this, 400, "Role with name '#{role.name}' already exists.", 'info'   if role.channels chCriteria = buildFindChannelByIdOrNameCriteria this, role return if not chCriteria if role.clients clCriteria = buildFindClientByIdOrClientIDCriteria this, role return if not clCriteria   # update channels if role.channels # clear role from existing yield Channel.update({}, { $pull: allow: name }, { multi: true }).exec() # set role on channels if role.channels.length > 0 yield Channel.update(chCriteria, { $push: allow: name }, { multi: true }).exec()   # update clients if role.clients # clear role from existing yield Client.update({}, { $pull: roles: name }, { multi: true }).exec() # set role on clients if role.clients?.length > 0 yield Client.update(clCriteria, { $push: roles: name }, { multi: true }).exec()   # rename role if role.name yield Channel.update({ allow: $in: [name] }, { $push: allow: role.name }, { multi: true }).exec() yield Channel.update({ allow: $in: [name] }, { $pull: allow: name }, { multi: true }).exec() yield Client.update({ roles: $in: [name] }, { $push: roles: role.name }, { multi: true }).exec() yield Client.update({ roles: $in: [name] }, { $pull: roles: name }, { multi: true }).exec()   logger.info "User #{this.authenticated.email} updated role with name '#{name}'" this.body = 'Successfully updated role' this.status = 200 catch e logger.error "Could not update role with name '#{name}' via the API: #{e.message}" this.body = e.message this.status = 500     exports.deleteRole = (name) -> # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated return utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to updateRole denied.", 'info'   try channels = yield Channel.find({allow: {$in: [name]}}, {name: 1 }).exec() clients = yield Client.find({ roles: $in: [name]}, {clientID: 1 }).exec() if (channels is null or channels.length is 0) and (clients is null or clients.length is 0) return utils.logAndSetResponse this, 404, "Role with name '#{name}' could not be found.", 'info'   yield Channel.update({}, { $pull: allow: name }, { multi: true }).exec() yield Client.update({}, { $pull: roles: name }, { multi: true }).exec()   logger.info "User #{this.authenticated.email} deleted role with name '#{name}'" this.body = 'Successfully deleted role' catch e logger.error "Could not update role with name '#{name}' via the API: #{e.message}" this.body = e.message this.status = 500  </pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Mon Oct 10 2016 13:39:22 GMT+0200 (SAST) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../sorter.js"></script> </body> </html>