├── .gitignore ├── .vscode └── launch.json ├── Dockerfile ├── LICENSE ├── README.md ├── config └── firebase-configuration.ts ├── docker-compose.yml ├── package.json ├── src ├── app.module.ts ├── assets │ └── swagger.PNG ├── common │ └── base-data.service.ts ├── device │ ├── core │ │ ├── create-device.dto.ts │ │ ├── device.controller.spec.ts │ │ ├── device.controller.ts │ │ ├── device.interface.ts │ │ ├── device.schema.ts │ │ └── device.service.ts │ └── device.module.ts ├── main.ts └── message │ ├── core │ ├── firebase.ts │ └── firebase.type.ts │ ├── message.dto.ts │ ├── messaging.module.ts │ ├── messaging.service.spec.ts │ └── messaging.service.ts ├── test ├── device │ └── device.e2e-spec.ts └── jest-e2e.json ├── tsconfig.json └── tslint.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | coverage 3 | dist/ 4 | package-lock.json 5 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | 8 | { 9 | "type": "node", 10 | "request": "launch", 11 | "name": "App Debug", 12 | "program": "${workspaceFolder}/dist/server.js", 13 | "preLaunchTask": "tsc: build - tsconfig.json", 14 | "outFiles": [ 15 | "${workspaceFolder}/dist/**/*.js" 16 | ] 17 | }, 18 | { 19 | "type": "node", 20 | "request": "launch", 21 | "name": "E2E", 22 | "program": "${workspaceRoot}/node_modules/.bin/jest", 23 | "args": ["--config", "./test/jest-e2e.json"], 24 | "console": "integratedTerminal", 25 | "internalConsoleOptions": "neverOpen", 26 | "windows": { 27 | "program": "${workspaceFolder}/node_modules/jest/bin/jest", 28 | } 29 | }, 30 | { 31 | "type": "node", 32 | "request": "launch", 33 | "name": "Unit test", 34 | "program": "${workspaceRoot}/node_modules/.bin/jest", 35 | "args": ["--runInBand"], 36 | "console": "integratedTerminal", 37 | "internalConsoleOptions": "neverOpen", 38 | "windows": { 39 | "program": "${workspaceFolder}/node_modules/jest/bin/jest", 40 | } 41 | } 42 | ] 43 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:8 2 | 3 | WORKDIR /app 4 | COPY . /app/ 5 | # Install app dependencies 6 | 7 | RUN npm install && npm run build 8 | 9 | CMD [ "npm", "start" ] 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![NestJS](https://img.shields.io/badge/Powered%20by-NestJS-blue.svg?colorB=0e83cd)](https://nestjs.com/) 2 | 3 | # Push Notification API 4 | This API is used for assigning device to customer and sending notifications. 5 | 6 | # Technology stack 7 | - Node JS 8 | - [NestJS](https://github.com/nestjs/nest) framework. It provides a great way to build Node JS app 9 | - TypeScript 10 | - Firebase 11 | - Mongo 12 | - Testing by using: 13 | - SuperTest 14 | - Jest 15 | - Nock 16 | 17 | 18 | # How to use 19 | 20 | ``` 21 | $ git clone https://github.com/mukeshrawat02/push-notification-api.git 22 | $ cd 23 | $ npm install 24 | ``` 25 | 26 | ### Use one of the following to build and test: 27 | 28 | ```bash 29 | npm run dev # Run it directly with 'ts' file 30 | npm run build # Build the project using the 'tsc' compiler. 31 | npm start # Run it from converted 'js' file from 'ts' 32 | npm test # Run unit test cases 33 | npm run test:cov # Generate test coverage report 34 | npm run test:e2e # Run end to end test flow 35 | ``` 36 | > The API will run on default `3000` port which can be change in `\src\main.ts` 37 | > For make this working please add your firebase configuration in `\config\firebase-configuration.ts` 38 | 39 | 40 | # Swagger UI 41 | Swagger is active by default so when server is up you can see the API definition on 42 | `http://localhost:3000/api` 43 | 44 | ![Alt text](/src/assets/swagger.PNG?raw=true "Swagger") 45 | 46 | -------------------------------------------------------------------------------- /config/firebase-configuration.ts: -------------------------------------------------------------------------------- 1 | export default { 2 | projects: [ 3 | { 4 | id: "notification_1", 5 | serverKey: "", 6 | databaseURL: "https://.firebaseio.com", 7 | serviceAccount: { 8 | type: "service_account", 9 | project_id: "", 10 | private_key_id: "", 11 | private_key: `-----BEGIN PRIVATE KEY----- 12 | MIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUp 13 | wmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ5 14 | 1s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh 15 | 3tx4VgMtrQ+WEgCjhoTwo23KMBAuJGSYnRmoBZM3lMfTKevIkAidPExvYCdm5dYq3XToLkkLv5L2 16 | pIIVOFMDG+KESnAFV7l2c+cnzRMW0+b6f8mR1CJzZuxVLL6Q02fvLi55/mbSYxECQQDeAw6fiIQX 17 | GukBI4eMZZt4nscy2o12KyYner3VpoeE+Np2q+Z3pvAMd/aNzQ/W9WaI+NRfcxUJrmfPwIGm63il 18 | AkEAxCL5HQb2bQr4ByorcMWm/hEP2MZzROV73yF41hPsRC9m66KrheO9HPTJuo3/9s5p+sqGxOlF 19 | L0NDt4SkosjgGwJAFklyR1uZ/wPJjj611cdBcztlPdqoxssQGnh85BzCj/u3WqBpE2vjvyyvyI5k 20 | X6zk7S0ljKtt2jny2+00VsBerQJBAJGC1Mg5Oydo5NwD6BiROrPxGo2bpTbu/fhrT8ebHkTz2epl 21 | U9VQQSQzY1oZMVX8i1m5WUTLPz2yLJIBQVdXqhMCQBGoiuSoSjafUhV7i1cEGpb88h5NBYZzWXGZ 22 | 37sJ5QsW+sJyoNde3xH8vdXhzU7eT82D6X/scw9RZz+/6rCJ4p0= 23 | -----END PRIVATE KEY-----`, 24 | client_email: "foo@.iam.gserviceaccount.com", 25 | client_id: "", 26 | auth_uri: "", 27 | token_uri: "", 28 | auth_provider_x509_cert_url: "", 29 | client_x509_cert_url: "" 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | notification: 4 | build: 5 | context: . 6 | dockerfile: Dockerfile 7 | restart : always 8 | image: notification_api:local 9 | container_name: notification_api_container 10 | environment: 11 | - PORT=3000 12 | - MONGO_URL=mongodb://mongo:27017/notification 13 | ports: 14 | - 3000:3000 15 | links: 16 | - mongo 17 | volumes: 18 | - ./:/notification_api 19 | mongo: 20 | image: mongo:latest 21 | container_name: mongodb 22 | restart: on-failure 23 | volumes: 24 | - ${PWD}/mongo:/data/db 25 | ports: 26 | - 27017:27017 -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "push_notification_api", 3 | "version": "1.0.0", 4 | "description": "Rest api for sending device notification and registration.", 5 | "main": "server.js", 6 | "scripts": { 7 | "build": "node_modules/.bin/tsc", 8 | "dev": "ts-node ./src/main.ts", 9 | "start": "node ./dist/main.js", 10 | "test": "jest", 11 | "test:watch": "jest --watch", 12 | "test:cov": "jest --coverage", 13 | "test:e2e": "jest --detectOpenHandles --forceExit --config ./test/jest-e2e.json" 14 | }, 15 | "jest": { 16 | "moduleFileExtensions": [ 17 | "js", 18 | "json", 19 | "ts" 20 | ], 21 | "rootDir": "src", 22 | "testRegex": ".spec.ts$", 23 | "transform": { 24 | "^.+\\.(t|j)s$": "ts-jest" 25 | }, 26 | "coverageDirectory": "../coverage", 27 | "testEnvironment": "node" 28 | }, 29 | "keywords": [], 30 | "author": "Mukesh Rawat", 31 | "license": "GPL", 32 | "dependencies": { 33 | "@nestjs/common": "^5.1.0", 34 | "@nestjs/core": "^5.1.0", 35 | "@nestjs/jwt": "^0.2.0", 36 | "@nestjs/mongoose": "^5.1.0", 37 | "@nestjs/swagger": "^2.5.1", 38 | "@types/es6-promise": "^3.3.0", 39 | "body-parser": "^1.18.3", 40 | "express": "^4.16.4", 41 | "firebase-admin": "^6.0.0", 42 | "fs": "0.0.1-security", 43 | "http-errors": "^1.7.0", 44 | "http-status-codes": "^1.3.0", 45 | "mongodb": "^3.1.1", 46 | "mongoose": "^5.2.6", 47 | "reflect-metadata": "^0.1.12", 48 | "rxjs": "^6.2.2", 49 | "typescript": "^3.1.1" 50 | }, 51 | "devDependencies": { 52 | "@nestjs/testing": "^5.1.0", 53 | "@types/http-errors": "^1.6.1", 54 | "@types/jest": "^23.3.5", 55 | "@types/mongodb": "^3.1.3", 56 | "@types/mongoose": "^5.2.3", 57 | "@types/node": "^10.5.4", 58 | "@types/supertest": "^2.0.6", 59 | "jest": "^23.6.0", 60 | "nock": "^10.0.1", 61 | "nodemon": "^1.18.3", 62 | "supertest": "^3.3.0", 63 | "ts-jest": "^23.10.4", 64 | "ts-loader": "^4.4.2", 65 | "ts-node": "^7.0.0", 66 | "tslint": "^5.11.0" 67 | } 68 | } -------------------------------------------------------------------------------- /src/app.module.ts: -------------------------------------------------------------------------------- 1 | import { Module } from '@nestjs/common'; 2 | import { MongooseModule } from '@nestjs/mongoose'; 3 | 4 | import { DeviceModule } from './device/device.module'; 5 | 6 | const mongoUrl = process.env.MONGO_URL || 'mongodb://localhost:27017/notification'; 7 | @Module({ 8 | imports: [ 9 | MongooseModule.forRoot(mongoUrl), 10 | DeviceModule 11 | ], 12 | }) 13 | export class ApplicationModule { } -------------------------------------------------------------------------------- /src/assets/swagger.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mukeshrawat02/push-notification-api/73d4c1c99f65f1aff5874baf7493698ed46bd5dd/src/assets/swagger.PNG -------------------------------------------------------------------------------- /src/common/base-data.service.ts: -------------------------------------------------------------------------------- 1 | import * as createError from 'http-errors'; 2 | import * as httpStatus from 'http-status-codes'; 3 | 4 | export abstract class BaseDataService { 5 | throwUnProcessableEntity() { 6 | return Promise.reject(createError(httpStatus.UNPROCESSABLE_ENTITY, 'Unprocessable Entity')); 7 | } 8 | 9 | throwInternalServerError(err) { 10 | return Promise.reject(createError(httpStatus.INTERNAL_SERVER_ERROR, err)); 11 | } 12 | } -------------------------------------------------------------------------------- /src/device/core/create-device.dto.ts: -------------------------------------------------------------------------------- 1 | import { ApiModelProperty, ApiModelPropertyOptional } from '@nestjs/swagger'; 2 | 3 | export class CreateDeviceDto { 4 | @ApiModelProperty() readonly fcmToken: string; 5 | @ApiModelPropertyOptional() readonly bundleId?: string; 6 | @ApiModelProperty() readonly sandbox: boolean; 7 | } 8 | -------------------------------------------------------------------------------- /src/device/core/device.controller.spec.ts: -------------------------------------------------------------------------------- 1 | import { Logger } from '@nestjs/common'; 2 | import { Test } from '@nestjs/testing'; 3 | import { getModelToken } from '@nestjs/mongoose'; 4 | 5 | import { DeviceController } from './device.controller'; 6 | import { DeviceService } from './device.service'; 7 | import { CreateDeviceDto } from './create-device.dto'; 8 | import { MessagingModule } from '../../message/messaging.module'; 9 | import { MessagingService } from '../../message/messaging.service'; 10 | import { Message } from '../../message/message'; 11 | 12 | let mockRepository = { 13 | findOne(conditions?: any) { 14 | return { 15 | exec: () => Promise.resolve({ 16 | customerId: '1', 17 | projectId: 'notification_1', 18 | token: 'banana:token' 19 | }), 20 | }; 21 | }, 22 | find(conditions?: any) { 23 | return { 24 | exec: () => Promise.resolve([{ 25 | customerId: '1', 26 | projectId: 'notification_1', 27 | token: 'banana:token' 28 | }, 29 | { 30 | customerId: '2', 31 | projectId: 'notification_2', 32 | token: 'apple:token' 33 | }]), 34 | }; 35 | }, 36 | create(...docs: any[]) { 37 | return Promise.resolve({}); 38 | }, 39 | deleteOne(conditions: any) { 40 | return { 41 | exec: () => Promise.resolve({}), 42 | }; 43 | }, 44 | }; 45 | 46 | const mockMessagingService = { 47 | sendNotification(projectId: string, token: string, notification: Message): Promise { 48 | return Promise.resolve({ data: 'notification_sent', token: 'banana:token' }); 49 | } 50 | } 51 | 52 | describe('DeviceController', () => { 53 | let deviceController: DeviceController; 54 | let deviceService: DeviceService; 55 | 56 | const response = { 57 | send: (body?: any) => body, 58 | status: (code: number) => { 59 | return { 60 | send: (body?: any) => { 61 | return { 62 | statusCode: code, 63 | data: body, 64 | }; 65 | }, 66 | }; 67 | }, 68 | }; 69 | 70 | beforeEach(async () => { 71 | await initializeModule(); 72 | }); 73 | 74 | const initializeModule = async () => { 75 | const module = await Test.createTestingModule({ 76 | imports: [MessagingModule], 77 | controllers: [DeviceController], 78 | providers: [Logger, DeviceService], 79 | }) 80 | .overrideProvider(MessagingService) 81 | .useValue(mockMessagingService) 82 | .overrideProvider(getModelToken('devices')) 83 | .useValue(mockRepository) 84 | .compile(); 85 | 86 | deviceService = module.get(DeviceService); 87 | deviceController = module.get(DeviceController); 88 | }; 89 | 90 | it('should be created', () => { 91 | expect(deviceController).toBeDefined(); 92 | }); 93 | 94 | describe('getDevices()', () => { 95 | it('should return an array of devices', async () => { 96 | const result = [{ 97 | customerId: '1', 98 | projectId: 'notification_1', 99 | token: 'banana:token' 100 | }, 101 | { 102 | customerId: '2', 103 | projectId: 'notification_2', 104 | token: 'apple:token' 105 | }]; 106 | expect(await deviceController.getDevices(response)).toEqual(result); 107 | }); 108 | 109 | it('should throw 500 when database is down', async () => { 110 | mockRepository = { 111 | ...mockRepository, 112 | find(conditions: any) { 113 | return { 114 | exec: () => Promise.reject({ message: 'connect ECONNREFUSED 127.0.0.1:27017' }), 115 | }; 116 | }, 117 | }; 118 | await initializeModule(); 119 | 120 | const res = await deviceController.getDevices(response); 121 | expect(res.statusCode).toEqual(500); 122 | }); 123 | }); 124 | 125 | describe('createDevice()', () => { 126 | let projectId, customerId; 127 | beforeAll(() => { 128 | projectId = 'notification_1'; 129 | customerId = '1'; 130 | }); 131 | 132 | it('should return \'Unprocessable Entity\' if fcm token is empty', async () => { 133 | const createDeviceDto: CreateDeviceDto = { 134 | fcmToken: null, 135 | bundleId: '', 136 | sandbox: true 137 | }; 138 | 139 | const res = await deviceController.createDevice(response, projectId, customerId, createDeviceDto); 140 | expect(res.message).toEqual('Unprocessable Entity'); 141 | }); 142 | 143 | it('should add device and return status success', async () => { 144 | const createDeviceDto: CreateDeviceDto = { 145 | fcmToken: 'banana:token', 146 | bundleId: 'bundle_1', 147 | sandbox: true 148 | }; 149 | 150 | const res = await deviceController.createDevice(response, projectId, customerId, createDeviceDto); 151 | expect(res.message).toEqual(`Device for '${projectId}' added successfully!`); 152 | expect(res.status).toEqual('success'); 153 | }); 154 | }); 155 | 156 | // describe('sendNotification()', () => { 157 | // const params = { 158 | // projectId: '', 159 | // customerId: '', 160 | // }; 161 | // beforeAll(() => { 162 | // params.projectId = 'wallet'; 163 | // params.customerId = 'wallet_customer'; 164 | // }); 165 | 166 | // it('should send notification', async () => { 167 | // request.body = { 168 | // data: { 169 | // message: 'notification_sent', 170 | // }, 171 | // }; 172 | // const res = await deviceController.sendNotification(request, response, params); 173 | // expect(res.statusCode).toEqual(200); 174 | // expect(res.data).toEqual({ data: 'notification_sent', token: 'banana:token' }); 175 | // }); 176 | 177 | // it('should send OK when error code is \'messaging/registration-token-not-registered\'', async () => { 178 | // mockMessagingService.sendNotification = () => Promise.reject({ code: 'messaging/registration-token-not-registered' }); 179 | // await initializeModule(); 180 | 181 | // deviceController.sendNotification(request, response, params).catch(err => { 182 | // expect(err.statusCode).toEqual(200); 183 | // expect(err.data).toEqual('OK'); 184 | // }); 185 | // }); 186 | 187 | // it('should send 500 when error code is different from \'messaging/registration-token-not-registered\'', async () => { 188 | // mockMessagingService.sendNotification = () => Promise.reject({ code: 'messaging/invalid-data-payload-key' }); 189 | // await initializeModule(); 190 | 191 | // deviceController.sendNotification(request, response, params).catch(err => { 192 | // expect(err.statusCode).toEqual(500); 193 | // expect(err.data).toEqual('Internal Server Error'); 194 | // }); 195 | // }); 196 | 197 | // it('should send 500 when database connection is down', async () => { 198 | // mockMessagingService.sendNotification = () => Promise.reject({ code: 'messaging/registration-token-not-registered' }); 199 | // mockRepository = { 200 | // ...mockRepository, 201 | // deleteOne(conditions: any) { 202 | // return { 203 | // exec: () => Promise.reject({ message: 'connect ECONNREFUSED 127.0.0.1:27017' }), 204 | // }; 205 | // }, 206 | // }; 207 | // await initializeModule(); 208 | 209 | // const res = await deviceController.sendNotification(request, response, params); 210 | // expect(res.statusCode).toEqual(500); 211 | // }); 212 | 213 | // it('should send OK when Project Id or Customer Id empty', async () => { 214 | // params.projectId = ''; 215 | // params.customerId = ''; 216 | 217 | // const res = await deviceController.sendNotification(request, response, params); 218 | // expect(res).toEqual('OK'); 219 | // }); 220 | // }); 221 | }); -------------------------------------------------------------------------------- /src/device/core/device.controller.ts: -------------------------------------------------------------------------------- 1 | 2 | import { Get, Post, Body, Req, Res, Controller, Param, Put, Logger } from '@nestjs/common'; 3 | import { ApiUseTags } from '@nestjs/swagger'; 4 | 5 | import { CreateDeviceDto } from './create-device.dto'; 6 | import { DeviceService } from './device.service'; 7 | import { IDevice } from './device.interface'; 8 | import { MessagingService } from '../../message/messaging.service'; 9 | import { MessageDto } from '../../message/message.dto'; 10 | 11 | @Controller('device') 12 | @ApiUseTags('notification') 13 | export class DeviceController { 14 | constructor(private readonly _deviceService: DeviceService, private readonly _messagingService: MessagingService, private readonly _loggerService: Logger) { } 15 | 16 | @Get() 17 | async getDevices(@Res() response): Promise { 18 | try { 19 | const result = await this._deviceService.getDevices(); 20 | return response.send(result); 21 | } 22 | catch (err) { 23 | return response.status(500).send(err); 24 | } 25 | } 26 | 27 | @Put('/:projectId/:customerId') 28 | async createDevice( 29 | @Res() response, 30 | @Param('projectId') projectId: string, 31 | @Param('customerId') customerId: string, 32 | @Body() body: CreateDeviceDto 33 | ): Promise { 34 | try { 35 | const fcmToken = body.fcmToken; 36 | if (fcmToken) { 37 | const deviceObj = { 38 | projectId, 39 | customerId, 40 | token: fcmToken, 41 | } as IDevice; 42 | 43 | const result = await this._deviceService.saveDevice(deviceObj); 44 | return response.send({ status: 'success', message: `Device for '${projectId}' added successfully!` }); 45 | } 46 | throw new Error('Unprocessable Entity'); 47 | } 48 | catch (err) { 49 | return response.send(err); 50 | } 51 | } 52 | 53 | @Post('/:projectId/:customerId/messages') 54 | async sendNotification( 55 | @Res() response, 56 | @Param('projectId') projectId: string, 57 | @Param('customerId') customerId: string, 58 | @Body() message: MessageDto): Promise { 59 | try { 60 | const device: IDevice = await this._deviceService.getDevice(projectId, customerId); 61 | if (device) { 62 | const fcmToken: string = device.token; 63 | const data = await this._messagingService.sendNotification(projectId, fcmToken, message); 64 | return response.send(data); 65 | } 66 | throw new Error('Unprocessable Entity'); 67 | 68 | } 69 | catch (err) { 70 | this._loggerService.error(err); 71 | return response.status(500).send('Internal Server Error'); 72 | } 73 | } 74 | } -------------------------------------------------------------------------------- /src/device/core/device.interface.ts: -------------------------------------------------------------------------------- 1 | import { Document } from 'mongoose'; 2 | 3 | export interface IDevice extends Document { 4 | projectId: string; 5 | customerId: string; 6 | token: string; 7 | } -------------------------------------------------------------------------------- /src/device/core/device.schema.ts: -------------------------------------------------------------------------------- 1 | import * as mongoose from 'mongoose'; 2 | 3 | export const DeviceSchema = new mongoose.Schema({ 4 | projectId: { type: String }, 5 | customerId: { type: String }, 6 | token: { type: String }, 7 | }, { timestamps: true }); 8 | 9 | DeviceSchema.index({ projectId: 1, customerId: 1 }); 10 | 11 | export default DeviceSchema; -------------------------------------------------------------------------------- /src/device/core/device.service.ts: -------------------------------------------------------------------------------- 1 | import { Model } from 'mongoose'; 2 | import { Injectable } from '@nestjs/common'; 3 | import { InjectModel } from '@nestjs/mongoose'; 4 | 5 | import { IDevice } from './device.interface'; 6 | import { BaseDataService } from '../../common/base-data.service'; 7 | 8 | @Injectable() 9 | export class DeviceService extends BaseDataService { 10 | constructor(@InjectModel('devices') private readonly _deviceModel: Model) { 11 | super(); 12 | } 13 | 14 | async getDevice(projectId: string, customerId: string): Promise { 15 | try { 16 | return await this._deviceModel.findOne({ projectId, customerId }).exec(); 17 | } catch (error) { 18 | return this.throwInternalServerError(error); 19 | } 20 | } 21 | 22 | async getDevices(): Promise { 23 | try { 24 | return await this._deviceModel.find().exec(); 25 | } catch (error) { 26 | return this.throwInternalServerError(error); 27 | } 28 | } 29 | 30 | async saveDevice(data: IDevice): Promise { 31 | if (data.projectId && data.customerId && data.token) { 32 | try { 33 | return await this._deviceModel.create(data); 34 | } catch (error) { 35 | return this.throwInternalServerError(error); 36 | } 37 | } 38 | return this.throwUnProcessableEntity(); 39 | } 40 | 41 | async deleteDevice(projectId: string, customerId: string): Promise { 42 | try { 43 | return await this._deviceModel.deleteOne({ projectId, customerId }).exec(); 44 | } catch (error) { 45 | return this.throwInternalServerError(error); 46 | } 47 | } 48 | } -------------------------------------------------------------------------------- /src/device/device.module.ts: -------------------------------------------------------------------------------- 1 | import { Module, Logger } from '@nestjs/common'; 2 | import { MongooseModule } from '@nestjs/mongoose'; 3 | 4 | import { DeviceController } from './core/device.controller'; 5 | import { DeviceService } from './core/device.service'; 6 | import { DeviceSchema } from './core/device.schema'; 7 | import { MessagingModule } from '../message/messaging.module'; 8 | 9 | @Module({ 10 | imports: [ 11 | MongooseModule.forFeature([{ name: 'devices', schema: DeviceSchema }]), 12 | MessagingModule 13 | ], 14 | controllers: [DeviceController], 15 | providers: [Logger, DeviceService], 16 | }) 17 | export class DeviceModule { } -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { NestFactory } from '@nestjs/core'; 2 | import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; 3 | import * as bodyParser from 'body-parser'; 4 | 5 | import { ApplicationModule } from './app.module'; 6 | 7 | const port = process.env.PORT || 3000; 8 | 9 | async function bootstrap() { 10 | const app = await NestFactory.create(ApplicationModule); 11 | 12 | const options = new DocumentBuilder() 13 | .setTitle('Push Notification API') 14 | .setDescription('API for registering devices and sending notification') 15 | .setVersion('1.0.0') 16 | .addTag('notification') 17 | .build(); 18 | const document = SwaggerModule.createDocument(app, options); 19 | SwaggerModule.setup('api', app, document); 20 | 21 | configureMiddleware(app); 22 | 23 | await app.listen(port); 24 | } 25 | 26 | function configureMiddleware(app) { 27 | app.use(bodyParser.urlencoded({ extended: true })); 28 | app.use(bodyParser.json()); 29 | } 30 | 31 | bootstrap(); -------------------------------------------------------------------------------- /src/message/core/firebase.ts: -------------------------------------------------------------------------------- 1 | import { Injectable } from '@nestjs/common'; 2 | import { credential, initializeApp, messaging, app } from 'firebase-admin'; 3 | 4 | import { default as messagingConfiguration }from '../../../config/firebase-configuration'; 5 | import { ProjectConfiguration, ProjectData } from './firebase.type'; 6 | 7 | @Injectable() 8 | export class FireBase { 9 | private _projectItems = new Map(); 10 | 11 | private projects(): Array { 12 | return messagingConfiguration.projects as ProjectConfiguration[]; 13 | } 14 | 15 | configure(): void { 16 | const data = this.projects().forEach(project => { 17 | const ref = initializeApp({ 18 | credential: credential.cert(project.serviceAccount), 19 | databaseURL: project.databaseURL, 20 | }); 21 | const appData = { id: project.id, ref, serverKey: project.serverKey } as ProjectData; 22 | this._projectItems.set(appData.id, appData); 23 | }); 24 | } 25 | 26 | getProjectData(projectId: string): ProjectData { 27 | const data = this._projectItems.get(projectId); 28 | if (!data) { 29 | throw new Error('project not found'); 30 | } 31 | return data; 32 | } 33 | 34 | async sendNotification(projectId: string, token: string, notification: any): Promise { 35 | try { 36 | const project = this.getProjectData(projectId); 37 | const data = { ...notification, token }; 38 | return await messaging(project.ref).send(data); 39 | } catch (error) { 40 | return Promise.reject(error); 41 | } 42 | } 43 | } -------------------------------------------------------------------------------- /src/message/core/firebase.type.ts: -------------------------------------------------------------------------------- 1 | export type ProjectConfiguration = { 2 | id: string, 3 | serverKey: string, 4 | databaseURL: string, 5 | serviceAccount: any, 6 | }; 7 | 8 | export type ProjectData = { 9 | id: string, 10 | ref: any, 11 | serverKey: string, 12 | }; -------------------------------------------------------------------------------- /src/message/message.dto.ts: -------------------------------------------------------------------------------- 1 | import { credential, initializeApp, messaging, app } from 'firebase-admin'; 2 | import { ApiModelPropertyOptional } from '@nestjs/swagger'; 3 | 4 | export class MessageDto { 5 | @ApiModelPropertyOptional() readonly data?: { [key: string]: string }; 6 | @ApiModelPropertyOptional() readonly notification?: messaging.Notification; 7 | @ApiModelPropertyOptional() readonly android?: messaging.AndroidConfig; 8 | @ApiModelPropertyOptional() readonly webpush?: messaging.WebpushConfig; 9 | @ApiModelPropertyOptional() readonly apns?: messaging.ApnsConfig; 10 | } -------------------------------------------------------------------------------- /src/message/messaging.module.ts: -------------------------------------------------------------------------------- 1 | import { Module, HttpModule } from '@nestjs/common'; 2 | 3 | import { MessagingService } from './messaging.service'; 4 | import { FireBase } from './core/firebase'; 5 | 6 | @Module({ 7 | imports: [HttpModule], 8 | providers: [ 9 | FireBase, 10 | MessagingService, 11 | ], 12 | exports: [MessagingService], 13 | }) 14 | export class MessagingModule { } 15 | -------------------------------------------------------------------------------- /src/message/messaging.service.spec.ts: -------------------------------------------------------------------------------- 1 | import { Test, TestingModule } from '@nestjs/testing'; 2 | import { HttpModule } from '@nestjs/common'; 3 | import * as nock from 'nock'; 4 | 5 | jest.mock('firebase-admin', () => { 6 | return { 7 | credential: { 8 | cert: (serviceAccountPathOrObject: string) => { }, 9 | }, 10 | initializeApp: () => { }, 11 | messaging: () => { 12 | return { 13 | send: (message: any) => Promise.resolve({ data: 'notification_sent', token: 'banana:token' }), 14 | }; 15 | }, 16 | }; 17 | }); 18 | 19 | import { MessagingService } from './messaging.service'; 20 | import { MessageDto } from './message.dto'; 21 | import { FireBase } from './core/firebase'; 22 | 23 | describe('MessagingService', () => { 24 | const projectId = 'notification_1'; 25 | let service: MessagingService; 26 | 27 | beforeAll(async () => { 28 | const module: TestingModule = await Test.createTestingModule({ 29 | imports: [HttpModule], 30 | providers: [FireBase, MessagingService], 31 | }) 32 | .compile(); 33 | 34 | service = module.get(MessagingService); 35 | }); 36 | 37 | afterAll(() => { 38 | jest.unmock('firebase-admin'); 39 | }); 40 | 41 | describe('sendNotification()', () => { 42 | const token = 'banana:token'; 43 | const notification: MessageDto = { 44 | data: { 45 | message: 'notification_sent', 46 | }, 47 | }; 48 | 49 | it('should call sendNotification method', async () => { 50 | expect(await service.sendNotification(projectId, token, notification)) 51 | .toStrictEqual({ data: 'notification_sent', token: 'banana:token' }); 52 | }); 53 | 54 | it('should throw error for empty projectId', async () => { 55 | await service.sendNotification(null, token, notification).catch((err) => { 56 | expect(err.message).toEqual('project not found'); 57 | }); 58 | }); 59 | }); 60 | }); 61 | -------------------------------------------------------------------------------- /src/message/messaging.service.ts: -------------------------------------------------------------------------------- 1 | import { Injectable, HttpService } from '@nestjs/common'; 2 | 3 | import { FireBase } from './core/firebase'; 4 | import { MessageDto } from './message.dto'; 5 | 6 | @Injectable() 7 | export class MessagingService { 8 | constructor(private readonly _http: HttpService, private readonly _firebase: FireBase) { 9 | this._firebase.configure(); 10 | } 11 | 12 | async sendNotification(projectId: string, token: string, notification: MessageDto): Promise { 13 | try { 14 | return await this._firebase.sendNotification(projectId, token, notification); 15 | } catch (err) { 16 | return Promise.reject(err); 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /test/device/device.e2e-spec.ts: -------------------------------------------------------------------------------- 1 | import * as request from 'supertest'; 2 | import { Test } from '@nestjs/testing'; 3 | import { INestApplication } from '@nestjs/common'; 4 | import { getModelToken } from '@nestjs/mongoose'; 5 | 6 | import { DeviceModule } from '../../src/device/device.module'; 7 | import { MessagingService } from '../../src/message/messaging.service'; 8 | import { Message } from '../../src/message/message'; 9 | 10 | describe('Device (e2e)', () => { 11 | let app: INestApplication; 12 | const mockRepository = { 13 | findOne(conditions?: any) { 14 | return { 15 | exec: () => Promise.resolve({ 16 | customerId: '1', 17 | projectId: 'notification_1', 18 | token: 'banana:token' 19 | }), 20 | }; 21 | }, 22 | find(conditions?: any) { 23 | return { 24 | exec: () => Promise.resolve([{ 25 | customerId: '1', 26 | projectId: 'notification_1', 27 | token: 'banana:token' 28 | }, 29 | { 30 | customerId: '2', 31 | projectId: 'notification_2', 32 | token: 'apple:token' 33 | }]), 34 | }; 35 | }, 36 | create(...docs: any[]) { 37 | return Promise.resolve({}); 38 | }, 39 | deleteOne(conditions: any) { 40 | return { 41 | exec: () => Promise.resolve({}), 42 | }; 43 | }, 44 | }; 45 | 46 | const mockMessagingService = { 47 | sendNotification(projectId: string, token: string, notification: Message): Promise { 48 | return Promise.resolve({ data: 'notification_sent', token: 'banana:token' }); 49 | } 50 | } 51 | 52 | beforeAll(async () => { 53 | const moduleFixture = await Test.createTestingModule({ 54 | imports: [DeviceModule], 55 | }) 56 | .overrideProvider(MessagingService) 57 | .useValue(mockMessagingService) 58 | .overrideProvider(getModelToken('devices')) 59 | .useValue(mockRepository) 60 | .compile(); 61 | 62 | app = moduleFixture.createNestApplication(); 63 | await app.init(); 64 | }); 65 | 66 | it('/device (GET)', async () => { 67 | const expected = { 68 | customerId: '1', 69 | projectId: 'notification_1', 70 | token: 'banana:token' 71 | }; 72 | 73 | const result = await request(app.getHttpServer()) 74 | .get('/device') 75 | .set('Accept', 'application/json'); 76 | 77 | expect(result.status).toEqual(200); 78 | expect(result.body).toEqual( 79 | expect.arrayContaining([ 80 | expect.objectContaining(expected), 81 | ]), 82 | ); 83 | }); 84 | 85 | it('/:projectId/:customerId (PUT)', async () => { 86 | const result = await request(app.getHttpServer()) 87 | .put('/device/notification_1/1') 88 | .send({ fcmToken: 'banana:token' }) 89 | .set('Accept', 'application/json'); 90 | 91 | expect(result.status).toEqual(200); 92 | expect(result.body).toEqual({ 93 | status: 'success', 94 | message: 'Device for \'notification_1\' added successfully!', 95 | }); 96 | }); 97 | 98 | it('/:projectId/:customerId/messages (POST)', async () => { 99 | const result = await request(app.getHttpServer()) 100 | .post('/device/notification_1/1/messages') 101 | .set('Accept', 'application/json'); 102 | 103 | expect(result.status).toEqual(200); 104 | expect(result.body).toEqual({ data: 'notification_sent', token: 'banana:token' }); 105 | }); 106 | 107 | afterAll(async () => { 108 | await app.close(); 109 | }); 110 | }); -------------------------------------------------------------------------------- /test/jest-e2e.json: -------------------------------------------------------------------------------- 1 | { 2 | "moduleFileExtensions": ["js", "json", "ts"], 3 | "rootDir": ".", 4 | "testEnvironment": "node", 5 | "testRegex": ".e2e-spec.ts$", 6 | "transform": { 7 | "^.+\\.(t|j)s$": "ts-jest" 8 | } 9 | } -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "lib": ["es6", "dom"], 5 | "esModuleInterop": false, 6 | "declaration": true, 7 | "noImplicitAny": false, 8 | "removeComments": true, 9 | "noLib": false, 10 | "allowSyntheticDefaultImports": true, 11 | "emitDecoratorMetadata": true, 12 | "experimentalDecorators": true, 13 | "target": "es6", 14 | "sourceMap": true, 15 | "outDir": "./dist", 16 | "baseUrl": "./src" 17 | }, 18 | "include": [ 19 | "src/**/*" 20 | ], 21 | "exclude": [ 22 | "node_modules", 23 | "**/*.spec.ts" 24 | ] 25 | } -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "defaultSeverity": "error", 3 | "extends": [ 4 | "tslint:recommended" 5 | ], 6 | "jsRules": { 7 | "no-unused-expression": true 8 | }, 9 | "rules": { 10 | "eofline": false, 11 | "quotemark": [ 12 | true, 13 | "single" 14 | ], 15 | "indent": false, 16 | "member-access": [ 17 | false 18 | ], 19 | "ordered-imports": [ 20 | false 21 | ], 22 | "member-ordering": [ 23 | false 24 | ], 25 | "curly": false, 26 | "interface-name": [ 27 | false 28 | ], 29 | "array-type": [ 30 | false 31 | ], 32 | "align": false, 33 | "no-empty-interface": false, 34 | "no-trailing-whitespace": false, 35 | "no-empty": false, 36 | "no-console": false, 37 | "arrow-parens": false, 38 | "object-literal-sort-keys": false, 39 | "no-unused-expression": false, 40 | "interface-over-type-literal": false, 41 | "max-line-length": false, 42 | "max-classes-per-file": [ 43 | false 44 | ], 45 | "variable-name": [ 46 | false 47 | ], 48 | "one-line": [ 49 | false 50 | ], 51 | "one-variable-per-declaration": [ 52 | false 53 | ] 54 | }, 55 | "rulesDirectory": [] 56 | } --------------------------------------------------------------------------------