UNPKG

openhim-core

Version:

The OpenHIM core application that provides logging and routing of http requests

480 lines (477 loc) 18 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/api/clients.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> clients.coffee </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">16.67% </span> <span class="quiet">Statements</span> <span class='fraction'>11/66</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/8</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Functions</span> <span class='fraction'>0/6</span> </div> <div class='fl pad1y space-right2'> <span class="strong">16.67% </span> <span class="quiet">Lines</span> <span class='fraction'>11/66</span> </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</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">Client = require('../model/clients').Client Q = require 'q' logger = require 'winston' authorisation = require './authorisation' utils = require '../utils' &nbsp; ### # Adds a client ### exports.addClient = <span class="fstat-no" title="function not covered" ></span>() -&gt; &nbsp; # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to addClient denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; <span class="cstat-no" title="statement not covered" > clientData = this.request.b</span>ody &nbsp; try <span class="cstat-no" title="statement not covered" > client = new C</span>lient clientData <span class="cstat-no" title="statement not covered" > result = y</span>ield Q.ninvoke client, 'save' <span class="cstat-no" title="statement not covered" > logger.info "User #{this.authenticated.email} created client with id #{client.id}"</span> <span class="cstat-no" title="statement not covered" > this.body = '</span>Client successfully created' this.status = 201 catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not add a client via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.body = e.m</span>essage this.status = 400 &nbsp; ### # Retrieves the details of a specific client ### exports.getClient = <span class="fstat-no" title="function not covered" >(</span>clientId, property) -&gt; <span class="cstat-no" title="statement not covered" > projectionRestriction = n</span>ull &nbsp; # if property - Setup client projection and bypass authorization if typeof property is 'string' <span class="cstat-no" title="statement not covered" > if property is 'clientName'</span> <span class="cstat-no" title="statement not covered" > projectionRestriction =</span> _id: 0 name: 1 else <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 404, "The property (#{property}) you are trying to retrieve is not found.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> else # Test if the user is authorised <span class="cstat-no" title="statement not covered" > if not authorisation.inGroup 'admin', this.authenticated</span> <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to findClientById denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; <span class="cstat-no" title="statement not covered" > clientId = u</span>nescape clientId &nbsp; try <span class="cstat-no" title="statement not covered" > result = y</span>ield Client.findById(clientId, projectionRestriction).exec() <span class="cstat-no" title="statement not covered" > if result is null</span> utils.logAndSetResponse this, 404, "Client with id #{clientId} could not be found.", 'info' else this.body = result catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not find client by id #{clientId} via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.body = e.m</span>essage this.status = 500 &nbsp; &nbsp; exports.findClientByDomain = <span class="fstat-no" title="function not covered" >(</span>clientDomain) -&gt; &nbsp; # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to findClientByDomain denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; <span class="cstat-no" title="statement not covered" > clientDomain = u</span>nescape clientDomain &nbsp; try <span class="cstat-no" title="statement not covered" > result = y</span>ield Client.findOne(clientDomain: clientDomain).exec() <span class="cstat-no" title="statement not covered" > if result is null</span> utils.logAndSetResponse this, 404, "Could not find client with clientDomain #{clientDomain}", 'info' else this.body = result catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not find client by client Domain #{clientDomain} via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.body = e.m</span>essage this.status = 500 &nbsp; exports.updateClient = <span class="fstat-no" title="function not covered" >(</span>clientId) -&gt; &nbsp; # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to updateClient denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; <span class="cstat-no" title="statement not covered" > clientId = u</span>nescape clientId <span class="cstat-no" title="statement not covered" > clientData = this.request.b</span>ody &nbsp; # Ignore _id if it exists, a user shouldn't be able to update the internal id <span class="cstat-no" title="statement not covered" ></span> delete clientData._id if clientData._id &nbsp; try <span class="cstat-no" title="statement not covered" > yield Client.findByIdAndUpdate(clientId, clientData).exec()</span> <span class="cstat-no" title="statement not covered" > logger.info "User #{this.authenticated.email} updated client with id #{clientId}"</span> this.body = 'Successfully updated client.' catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not update client by ID #{clientId} via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.body = e.m</span>essage this.status = 500 &nbsp; exports.removeClient = <span class="fstat-no" title="function not covered" >(</span>clientId) -&gt; # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to removeClient denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; <span class="cstat-no" title="statement not covered" > clientId = u</span>nescape clientId &nbsp; try <span class="cstat-no" title="statement not covered" > yield Client.findByIdAndRemove(clientId).exec()</span> <span class="cstat-no" title="statement not covered" > this.body = "Successfully removed client with ID #{c</span>lientId}" logger.info "User #{this.authenticated.email} removed client with id #{clientId}" catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not remove client by ID #{clientId} via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.body = e.m</span>essage this.status = 500 &nbsp; exports.getClients = <span class="fstat-no" title="function not covered" ></span>() -&gt; &nbsp; # Test if the user is authorised if not authorisation.inGroup 'admin', this.authenticated <span class="cstat-no" title="statement not covered" > utils.logAndSetResponse this, 403, "User #{this.authenticated.email} is not an admin, API access to getClients denied.", 'info'</span> <span class="cstat-no" title="statement not covered" > return</span> &nbsp; try this.body = yield Client.find().exec() catch <span class="cstat-no" title="statement not covered" >e</span> <span class="cstat-no" title="statement not covered" > logger.error "Could not fetch all clients via the API: #{e.message}"</span> <span class="cstat-no" title="statement not covered" > this.message = e.m</span>essage this.status = 500 &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <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>