├── .editorconfig ├── .gitignore ├── .jshintrc ├── .npmignore ├── .travis.yml ├── CHANGES.md ├── Gruntfile.js ├── LICENSE ├── README.md ├── doc └── index.md ├── example ├── create-issue.js ├── get-custom-fields.js ├── get-redmine-issue.js ├── groups.js ├── issue-category.js ├── issue-relation.js ├── project-membership.js ├── redmine-news.js ├── redmine-project.js ├── redmine-time-entry.js ├── redmine-user.js ├── update-issue.js ├── version.js └── wiki.js ├── grunt ├── jshint.js ├── mocha_istanbul.js └── mochacli.js ├── lib └── redmine.js ├── package.json └── test ├── issue.test.js └── redmine.test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | # This file is for unifying the coding style for dirrerent editors and IDEs 2 | # editorconfig.org 3 | 4 | root = true 5 | 6 | [*] 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | indent_style = space 12 | indent_size = 4 13 | 14 | [*.js] 15 | indent_size = 2 16 | 17 | [*.json] 18 | indent_style = space 19 | indent_size = 2 20 | 21 | [*.yml] 22 | indent_style = space 23 | indent_size = 2 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # nodejs third-party modules 2 | node_modules 3 | 4 | # mocha_istanbul:coverage 5 | coverage 6 | 7 | 8 | -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "bitwise": true, 3 | "camelcase": true, 4 | "curly": true, /* custom */ 5 | "eqeqeq": true, 6 | "es3": false, 7 | "forin": true, 8 | "freeze": true, 9 | "immed": true, 10 | "indent": 2, /* custom */ 11 | "latedef": true, 12 | "newcap": true, 13 | "noarg": true, 14 | "noempty": true, 15 | "nonbsp": true, 16 | "nonew": true, 17 | "plusplus": true, /* custom */ 18 | "quotmark": true, 19 | "undef": true, 20 | "unused": true, 21 | "strict": true, /* enable later */ 22 | "trailing": true, 23 | "maxparams": false, 24 | "maxdepth": false, 25 | "maxstatements": false, 26 | "maxcomplexity": false, 27 | "maxlen": false, 28 | "asi": false, 29 | "boss": false, /* custom */ 30 | "debug": false, 31 | "eqnull": true, /* custom */ 32 | "esnext": false, 33 | "evil": false, 34 | "expr": false, 35 | "funcscope": false, 36 | "gcl": false, 37 | "globalstrict": false, 38 | "iterator": false, 39 | "lastsemic": false, 40 | "laxbreak": false, 41 | "laxcomma": false, 42 | "loopfunc": true, 43 | "moz": false, 44 | "multistr": false, 45 | "notypeof": false, 46 | "proto": false, 47 | "scripturl": false, 48 | "smarttabs": false, 49 | "shadow": false, 50 | "sub": false, 51 | "supernew": false, 52 | "noyield": false, 53 | "browser": true, /* custom */ 54 | "node": true, /* custom */ 55 | "onevar": true, /* custom */ 56 | "globals": { /* custom */ 57 | /* MOCHA: http://stackoverflow.com/a/19572515/130638 */ 58 | "describe" : false, 59 | "it" : false, 60 | "before" : false, 61 | "beforeEach" : false, 62 | "after" : false, 63 | "afterEach" : false 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | doc 2 | example 3 | test 4 | node_modules 5 | 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 4.4.4 4 | 5 | before_install: 6 | - npm install 7 | -------------------------------------------------------------------------------- /CHANGES.md: -------------------------------------------------------------------------------- 1 | CHANGES 2 | ========= 3 | 4 | 0.1.0 5 | ------- 6 | - Initialize node-redmine 7 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | 'use strict()'; 2 | 3 | var config= { 4 | port: 3000 5 | }; 6 | 7 | module.exports = function(grunt) { 8 | 9 | // Load grunt tasks automatically 10 | require('load-grunt-tasks')(grunt); 11 | 12 | // Time how long tasks take. Can help when optimizing build times 13 | require('time-grunt')(grunt); 14 | 15 | var options = { 16 | config: { 17 | src: './grunt/*.js' 18 | }, 19 | pkg: grunt.file.readJSON('package.json'), 20 | nodemon: { 21 | serve: { 22 | script: 'index.js', 23 | options: { 24 | ignore: ['node_modules/**'] 25 | } 26 | } 27 | } 28 | }; 29 | 30 | var configs = require('load-grunt-configs')(grunt, options); 31 | 32 | // Project configuration. 33 | grunt.initConfig(configs); 34 | 35 | // load jshint 36 | grunt.registerTask('lint', [ 37 | 'jshint' 38 | ]); 39 | 40 | grunt.registerTask('test', [ 41 | 'mochacli' 42 | ]); 43 | 44 | grunt.registerTask('coverage', [ 45 | 'mocha_istanbul' 46 | ]); 47 | 48 | // default option to connect server 49 | grunt.registerTask('serve', [ 50 | 'jshint', 51 | 'mochacli', 52 | 'mocha_istanbul' 53 | ]); 54 | 55 | grunt.registerTask('server', function () { 56 | grunt.log.warn('The `server` task has been deprecated. Use `grunt serve` to start a server.'); 57 | grunt.task.run(['serve:' + target]); 58 | }); 59 | }; 60 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | node-redmine 2 | ============ 3 | 4 | [![Build Status](https://travis-ci.org/zanran/node-redmine.svg?branch=master)](https://travis-ci.org/zanran/node-redmine) 5 | [![npm version](https://img.shields.io/npm/v/node-redmine.svg?style=flat)](https://www.npmjs.com/package/node-redmine) 6 | 7 | *[node-redmine](https://github.com/zanran/node-redmine) is a nodejs library that supports 100% the [Redmine's REST API](http://www.redmine.org/projects/redmine/wiki/Rest_api)'s features.* 8 | 9 | ## Installation 10 | 11 | To install node-redmine, simply: 12 | 13 | ```shell 14 | npm install node-redmine 15 | ``` 16 | 17 | ## Usage 18 | 19 | ```js 20 | var Redmine = require('node-redmine'); 21 | 22 | // protocol required in Hostname, supports both HTTP and HTTPS 23 | var hostname = process.env.REDMINE_HOST || 'http://redmine.zanran.me'; 24 | var config = { 25 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781' 26 | }; 27 | 28 | var redmine = new Redmine(hostname, config); 29 | 30 | /** 31 | * Dump issue 32 | */ 33 | var dump_issue = function(issue) { 34 | console.log('Dumping issue:'); 35 | for (var item in issue) { 36 | console.log(' ' + item + ': ' + JSON.stringify(issue[item])); 37 | } 38 | }; 39 | 40 | redmine.issues({limit: 2}, function(err, data) { 41 | if (err) throw err; 42 | 43 | for (var i in data.issues) { 44 | dump_issue(data.issues[i]); 45 | } 46 | 47 | console.log('total_count: ' + data.total_count); 48 | }); 49 | ``` 50 | 51 | ## Supported features for Redmine REST API 52 | 53 | | Resource | Status | Availability | Supported | 54 | |:--------------------|:----------|-------------:|:---------:| 55 | | Issues | Stable | 1.0 | ✓ | 56 | | Projects | Stable | 1.0 | ✓ | 57 | | Project Memberships | Alpha | 1.4 | ✓ | 58 | | Users | Stable | 1.1 | ✓ | 59 | | Time Entries | Stable | 1.1 | ✓ | 60 | | News | Prototype | 1.1 | ✓ | 61 | | Issue Relations | Alpha | 1.3 | ✓ | 62 | | Versions | Alpha | 1.3 | ✓ | 63 | | Wiki Pages | Alpha | 2.2 | ✓ | 64 | | Queries | Alpha | 1.3 | ✓ | 65 | | Attachments | Beta | 1.3 | ✓ | 66 | | Issue Statuses | Alpha | 1.3 | ✓ | 67 | | Trackers | Alpha | 1.3 | ✓ | 68 | | Enumerations | Alpha | 2.2 | ✓ | 69 | | Issue Categories | Alpha | 1.3 | ✓ | 70 | | Roles | Alpha | 1.4 | ✓ | 71 | | Groups | Alpha | 2.1 | ✓ | 72 | | Custom Fields | Alpha | 2.4 | ✓ | 73 | | Search | Alpha | 3.3 | N/A | 74 | 75 | ## Links 76 | 77 | * Redmine wiki page: http://www.redmine.org/projects/redmine/wiki/Rest_api 78 | * NPM package: https://www.npmjs.com/package/node-redmine 79 | 80 | 81 | ## Notice 82 | + node-redmine only supports using the [JSON](http://en.wikipedia.org/wiki/JSON) format. 83 | -------------------------------------------------------------------------------- /doc/index.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zanran/node-redmine/20488ac8a248053afa7f5e61cd166686fc1e8e94/doc/index.md -------------------------------------------------------------------------------- /example/create-issue.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | /* 20 | * create issue 21 | */ 22 | var issue = { 23 | "issue": { 24 | "project_id": 1, 25 | "subject": 'Redmine REST API by Node.js', 26 | "assigned_to_id": 5, 27 | "notes": "automative update redmine notes by node js", 28 | "priority_id": 4 29 | } 30 | }; 31 | 32 | redmine.create_issue(issue, function(err, data) { 33 | if (err) throw err; 34 | 35 | console.log(data); 36 | }); 37 | -------------------------------------------------------------------------------- /example/get-custom-fields.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | 20 | var dump_fields = function(fields) { 21 | console.log('Dumping Custom Fields:'); 22 | for (var item in fields) { 23 | console.log(' ' + item + ': ' + JSON.stringify(fields[item])); 24 | } 25 | }; 26 | 27 | redmine.custom_fields(function(err, data) { 28 | if (err) throw err; 29 | 30 | console.log(data); 31 | 32 | for (var i in data.custom_fields) { 33 | dump_fields(data.custom_fields[i]); 34 | } 35 | }); 36 | -------------------------------------------------------------------------------- /example/get-redmine-issue.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | /** 20 | * Dump issue 21 | */ 22 | var dump_issue = function(issue) { 23 | console.log('Dumping issue:'); 24 | for (var item in issue) { 25 | console.log(' ' + item + ': ' + JSON.stringify(issue[item])); 26 | } 27 | }; 28 | 29 | redmine.issues({limit: 2}, function(err, data) { 30 | if (err) throw err; 31 | 32 | for (var i in data.issues) { 33 | dump_issue(data.issues[i]); 34 | } 35 | 36 | console.log('total_count: ' + data.total_count); 37 | }); 38 | 39 | // get issue by id 40 | var params = {include: 'attachments,journals,watchers'}; 41 | redmine.get_issue_by_id(2, params, function(err, data) { 42 | if (err) throw err; 43 | 44 | dump_issue(data.issue); 45 | }); 46 | 47 | 48 | redmine.delete_issue(1, function(err, data) { 49 | if (err) { 50 | console.log(err); 51 | return ; 52 | } else { 53 | console.log('Delete issue #1: ' + JSON.stringify(data)); 54 | } 55 | }); 56 | 57 | 58 | // add watchers 59 | redmine.add_watcher(2, {user_id: 5}, function(err, data) { 60 | if (err) throw err; 61 | 62 | console.log(data); 63 | }); 64 | /* 65 | // remove watchers 66 | redmine.remove_watcher(2, 5, function(err, data) { 67 | if (err) throw err; 68 | 69 | console.log(data); 70 | }); 71 | */ 72 | -------------------------------------------------------------------------------- /example/groups.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | var dump_obj = function(obj) { 21 | for (var item in obj) { 22 | console.log(' ' + item + ': ' + JSON.stringify(obj[item])); 23 | } 24 | }; 25 | 26 | 27 | redmine.groups(function(err, data) { 28 | if (err) throw err; 29 | 30 | console.log(data); 31 | }); 32 | 33 | /* 34 | var group = { 35 | group: { 36 | name: 'rest-api-3-1', 37 | user_ids: [ 5] 38 | } 39 | }; 40 | redmine.create_group(group, function(err, data) { 41 | if (err) throw err; 42 | 43 | console.log(data); 44 | }); 45 | */ 46 | 47 | redmine.group_by_id(73, {include: 'users, memberships'}, function(err, data) { 48 | if (err) throw err; 49 | 50 | console.log(data); 51 | }); 52 | 53 | /* 54 | var u_group = { 55 | group: { 56 | name: 'nodejs', 57 | user_ids: [ 5] 58 | } 59 | }; 60 | redmine.update_group(73, u_group, function(err, data) { 61 | if (err) throw err; 62 | 63 | console.log(data); 64 | }); 65 | 66 | redmine.delete_group(74, function(err, data) { 67 | if (err) throw err; 68 | 69 | console.log(data); 70 | }); 71 | */ 72 | 73 | /* 74 | redmine.add_user_to_group(73, 9, function(err, data) { 75 | if (err) throw err; 76 | 77 | console.log(data); 78 | }); 79 | */ 80 | 81 | redmine.remove_user_from_group(73, 5, function(err, data) { 82 | if (err) throw err; 83 | 84 | console.log(data); 85 | }); 86 | -------------------------------------------------------------------------------- /example/issue-category.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | var dump_obj = function(obj) { 21 | for (var item in obj) { 22 | console.log(' ' + item + ': ' + JSON.stringify(obj[item])); 23 | } 24 | }; 25 | 26 | /* 27 | redmine.projects({include: "issue_categories"}, function(err, data) { 28 | if (err) throw err; 29 | 30 | for (var i in data.projects) { 31 | dump_project(data.projects[i]); 32 | } 33 | 34 | console.log('total_count: ' + data.total_count); 35 | }); 36 | */ 37 | redmine.issue_categories_by_project_id(1, function(err, data) { 38 | if (err) throw err; 39 | 40 | dump_obj(data.issue_categories); 41 | }); 42 | 43 | /* 44 | var issue_category = { 45 | issue_category: { 46 | name: 'rest api', 47 | assigned_to_id: 5 48 | } 49 | }; 50 | redmine.create_issue_category(1, issue_category, function(err, data) { 51 | if (err) throw err; 52 | 53 | console.log(data); 54 | }); 55 | */ 56 | 57 | redmine.issue_category_by_id(1, function(err, data) { 58 | if (err) throw err; 59 | 60 | dump_obj(data.issue_categories); 61 | }); 62 | /* 63 | var issue_category = { 64 | issue_category: { 65 | name: 'rest api - 2', 66 | assigned_to_id: 5 67 | } 68 | }; 69 | redmine.update_issue_category(1, issue_category, function(err, data) { 70 | if (err) throw err; 71 | 72 | console.log(data); 73 | }); 74 | 75 | 76 | redmine.delete_issue_category(1, function(err, data) { 77 | if (err) throw err; 78 | 79 | console.log(data); 80 | }); 81 | */ 82 | -------------------------------------------------------------------------------- /example/issue-relation.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | 21 | redmine.issue_relation_by_issue_id(5, function(err, data) { 22 | if (err) throw err; 23 | 24 | console.log(data); 25 | }); 26 | 27 | 28 | redmine.issue_relation_by_id(1, function(err, data) { 29 | if (err) throw err; 30 | 31 | console.log(data); 32 | }); 33 | 34 | /* 35 | redmine.delete_issue_relation(19, function(err, data) { 36 | if (err) throw err; 37 | 38 | console.log(data); 39 | }); 40 | */ 41 | 42 | var relations = { 43 | relation: { 44 | issue_to_id: 77, 45 | relation_type: 'duplicates' 46 | } 47 | }; 48 | redmine.create_issue_relation(5, relations, function(err, data) { 49 | if (err) throw err; 50 | 51 | console.log(data); 52 | }); 53 | -------------------------------------------------------------------------------- /example/project-membership.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | 21 | redmine.membership_by_project_id(1, function(err, data) { 22 | if (err) throw err; 23 | 24 | console.log(data); 25 | }); 26 | 27 | 28 | redmine.project_membership_by_id(1, function(err, data) { 29 | if (err) throw err; 30 | 31 | for (var item in data.membership) { 32 | console.log(data.membership[item]); 33 | } 34 | }); 35 | 36 | /* 37 | redmine.delete_project_membership(2, function(err, data) { 38 | if (err) throw err; 39 | 40 | console.log(data); 41 | }); 42 | */ 43 | /* 44 | var membership = { 45 | role_ids: { 46 | role_id: 5 47 | } 48 | }; 49 | redmine.update_project_membership(1, membership, function(err, data) { 50 | if (err) throw err; 51 | 52 | console.log(data); 53 | }); 54 | 55 | 56 | var membership = { 57 | user_id: 5, 58 | role_ids: [2] 59 | }; 60 | redmine.create_project_membership(5, membership, function(err, data) { 61 | if (err) throw err; 62 | 63 | console.log(data); 64 | }); 65 | */ 66 | -------------------------------------------------------------------------------- /example/redmine-news.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | 20 | var dump_news = function(fields) { 21 | for (var item in fields) { 22 | console.log(' ' + item + ': ' + JSON.stringify(fields[item])); 23 | } 24 | }; 25 | 26 | redmine.news(function(err, data) { 27 | if (err) throw err; 28 | 29 | console.log(data); 30 | 31 | for (var i in data.news) { 32 | dump_news(data.news[i]); 33 | } 34 | }); 35 | 36 | 37 | redmine.new_by_project_id(3, function(err, data) { 38 | if (err) throw err; 39 | 40 | dump_news(data.news); 41 | }); 42 | -------------------------------------------------------------------------------- /example/redmine-project.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | 20 | var dump_project = function(project) { 21 | console.log('Dumping project:'); 22 | for (var item in project) { 23 | console.log(' ' + item + ': ' + JSON.stringify(project[item])); 24 | } 25 | }; 26 | 27 | redmine.projects({include: "trackers, issue_categories, enabled_modules"}, function(err, data) { 28 | if (err) throw err; 29 | 30 | console.log(data); 31 | 32 | for (var i in data.projects) { 33 | dump_project(data.projects[i]); 34 | } 35 | 36 | console.log('total_count: ' + data.total_count); 37 | }); 38 | 39 | 40 | redmine.get_project_by_id(5, {include: "trackers, issue_categories, enabled_modules"}, function(err, data) { 41 | if (err) throw err; 42 | 43 | console.log(data); 44 | 45 | dump_project(data.project); 46 | }); 47 | 48 | /* 49 | var project = { 50 | project: { 51 | name: 'TEST PROJECT FOR REST API - 2', 52 | identifier: 'test-rest-api-2', 53 | enabled_module_names: ['boards', 'calendar', 'documents', 'files', 'gantt', 'issue_tracking', 'news'] 54 | } 55 | }; 56 | redmine.create_project(project, function(err, data) { 57 | if (err) throw err; 58 | 59 | console.log(data); 60 | }); 61 | 62 | 63 | var project = { 64 | project: { 65 | name: 'TEST PROJECT FOR REST API - 5', 66 | enabled_module_names: ['wiki', 'issue_tracking', 'news'] 67 | } 68 | }; 69 | redmine.update_project('test-rest-api-2', project, function(err, data) { 70 | if (err) throw err; 71 | 72 | console.log(data); 73 | }); 74 | 75 | 76 | redmine.delete_project('6', function(err, data) { 77 | if (err) { 78 | console.log(err); 79 | return ; 80 | } else { 81 | console.log('Delete project #1: ' + JSON.stringify(data)); 82 | } 83 | }); 84 | */ 85 | -------------------------------------------------------------------------------- /example/redmine-time-entry.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | 20 | var dump_time_entry = function(fields) { 21 | for (var item in fields) { 22 | console.log(' ' + item + ': ' + JSON.stringify(fields[item])); 23 | } 24 | }; 25 | 26 | redmine.time_entries(function(err, data) { 27 | if (err) throw err; 28 | /* 29 | console.log(data); 30 | 31 | for (var i in data.time_entries) { 32 | dump_time_entry(data.time_entries[i]); 33 | }*/ 34 | }); 35 | 36 | 37 | redmine.get_time_entry_by_id(4, function(err, data) { 38 | if (err) throw err; 39 | 40 | dump_time_entry(data.time_entry); 41 | }); 42 | 43 | /* 44 | redmine.delete_time_entry(5, function(err, data) { 45 | if (err) throw err; 46 | 47 | console.log(data); 48 | }); 49 | */ 50 | 51 | /* 52 | var time_entry = { 53 | time_entry: { 54 | project_id: 7, 55 | hours: '3' 56 | } 57 | }; 58 | redmine.create_time_entry(time_entry, function(err, data) { 59 | if (err) throw err; 60 | 61 | console.log(data); 62 | }); 63 | */ 64 | 65 | var time_entry_update = { 66 | time_entry: { 67 | issue_id: '12', 68 | hours: 3 69 | } 70 | }; 71 | redmine.update_time_entry(2, time_entry_update, function(err, data) { 72 | if (err) throw err; 73 | 74 | console.log(data); 75 | }); 76 | -------------------------------------------------------------------------------- /example/redmine-user.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | 20 | var dump_user = function(user) { 21 | console.log('Dumping user:'); 22 | for (var item in user) { 23 | console.log(' ' + item + ': ' + JSON.stringify(user[item])); 24 | } 25 | }; 26 | 27 | redmine.users({status: 1}, function(err, data) { 28 | if (err) throw err; 29 | 30 | console.log(data); 31 | 32 | for (var i in data.users) { 33 | dump_user(data.users[i]); 34 | } 35 | 36 | console.log('total_count: ' + data.total_count); 37 | }); 38 | 39 | 40 | redmine.get_user_by_id(9, {include: "memberships,groups"}, function(err, data) { 41 | if (err) throw err; 42 | 43 | 44 | dump_user(data.user); 45 | }); 46 | 47 | redmine.current_user({include: "memberships,groups"}, function(err, data) { 48 | if (err) throw err; 49 | 50 | dump_user(data.user); 51 | }); 52 | 53 | /* 54 | var user = { 55 | user: { 56 | login: 'wayne1', 57 | firstname: 'zanran1', 58 | lastname: 'tianxiaxi1', 59 | mail: 'wayne@ctwushu1.com', 60 | password: 'password', 61 | status: '3' 62 | } 63 | }; 64 | redmine.create_user(user, function(err, data) { 65 | if (err) throw err; 66 | 67 | console.log(data); 68 | }); 69 | 70 | /* 71 | var user = { 72 | user: { 73 | mail: 'wayne@zanran.me' 74 | } 75 | }; 76 | redmine.update_user(5, user, function(err, data) { 77 | if (err) throw err; 78 | 79 | console.log(data); 80 | }); 81 | 82 | redmine.delete_user('37', function(err, data) { 83 | if (err) { 84 | console.log(err); 85 | return ; 86 | } else { 87 | console.log('Delete user #1: ' + JSON.stringify(data)); 88 | } 89 | }); 90 | */ 91 | -------------------------------------------------------------------------------- /example/update-issue.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | /* 20 | * update issue 21 | */ 22 | var issue = { 23 | "issue": { 24 | "subject": 'Redmine REST API by Node.js', 25 | "assigned_to_id": 5, 26 | "notes": "automative update redmine notes by node js" 27 | } 28 | }; 29 | 30 | redmine.update_issue(5, issue, function(err, data) { 31 | if (err) throw err; 32 | 33 | console.log(data); 34 | }); 35 | -------------------------------------------------------------------------------- /example/version.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | 21 | redmine.version_by_project_id(1, function(err, data) { 22 | if (err) throw err; 23 | 24 | console.log(data); 25 | }); 26 | /* 27 | var version = { 28 | version: { 29 | name: 'test for version (bugfix - last)' 30 | } 31 | }; 32 | redmine.create_version(4, version, function(err, data) { 33 | if (err) throw err; 34 | 35 | console.log(data); 36 | }); 37 | 38 | /* 39 | redmine.version_by_id(1, function(err, data) { 40 | if (err) throw err; 41 | 42 | for (var item in data.version) { 43 | console.log(data.version[item]); 44 | } 45 | }); 46 | /* 47 | redmine.delete_version(1, function(err, data) { 48 | if (err) throw err; 49 | 50 | console.log(data); 51 | }); 52 | */ 53 | 54 | redmine.queries(function(err, data) { 55 | if (err) throw err; 56 | 57 | console.log(data); 58 | }); 59 | 60 | redmine.attachment_by_id(178, function(err, data) { 61 | if (err) throw err; 62 | 63 | console.log(data); 64 | }); 65 | 66 | redmine.issue_statuses(function(err, data) { 67 | if (err) throw err; 68 | 69 | console.log(data); 70 | }); 71 | 72 | redmine.trackers(function(err, data) { 73 | if (err) throw err; 74 | 75 | console.log(data); 76 | }); 77 | 78 | redmine.issue_priorities(function(err, data) { 79 | if (err) throw err; 80 | 81 | console.log(data); 82 | }); 83 | 84 | redmine.time_entry_activities(function(err, data) { 85 | if (err) throw err; 86 | 87 | console.log(data); 88 | }); 89 | 90 | redmine.roles(function(err, data) { 91 | if (err) throw err; 92 | 93 | console.log(data); 94 | }); 95 | 96 | redmine.role_by_id(4, function(err, data) { 97 | if (err) throw err; 98 | 99 | console.log(data); 100 | }); 101 | -------------------------------------------------------------------------------- /example/wiki.js: -------------------------------------------------------------------------------- 1 | /* 2 | * get-redmine-issue - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | 'use strict()'; 7 | 8 | var Redmine = require('../lib/redmine'); 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 12 | var config = { 13 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781', 14 | format: 'json' 15 | }; 16 | 17 | var redmine = new Redmine(hostname, config); 18 | 19 | // ----------------------------------------------------------------------------- 20 | var dump_obj = function(obj) { 21 | for (var item in obj) { 22 | console.log(' ' + item + ': ' + JSON.stringify(obj[item])); 23 | } 24 | }; 25 | 26 | 27 | redmine.wiki_by_project_id(1, function(err, data) { 28 | if (err) throw err; 29 | 30 | for (var i in data.wiki_pages) 31 | dump_obj(data.wiki_pages[i]); 32 | }); 33 | 34 | /* 35 | redmine.wiki_by_title(1, 'Hello_world', {include: 'attachments'}, function(err, data) { 36 | if (err) throw err; 37 | 38 | dump_obj(data.wiki_page); 39 | }); 40 | 41 | 42 | redmine.wiki_history_by_title(1, 'Hello_world', 1, {include: 'attachments'}, function(err, data) { 43 | if (err) throw err; 44 | 45 | dump_obj(data.wiki_page); 46 | }); 47 | 48 | 49 | redmine.delete_wiki(1, 'Hello_world', function(err, data) { 50 | if (err) throw err; 51 | 52 | dump_obj(data); 53 | }); 54 | */ 55 | 56 | // create Wiki 57 | var wiki = { 58 | wiki_page: { 59 | text: 'node js test redmine rest api', 60 | comment: 'nodejs' 61 | } 62 | }; 63 | 64 | redmine.ceate_wiki('vw-mib3', 'rest-api-wiki-2', wiki, function(err, data) { 65 | if (err) throw err; 66 | 67 | dump_obj(data); 68 | }); 69 | -------------------------------------------------------------------------------- /grunt/jshint.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | options: { 3 | globals: { 4 | reporter: require('jshint-stylish'), 5 | jshintrc: true, 6 | force: true 7 | } 8 | }, 9 | 10 | all: [ 11 | 'lib/**/*.js', 12 | 'example/**/*.js', 13 | 'test/**/*.js' 14 | ] 15 | } 16 | -------------------------------------------------------------------------------- /grunt/mocha_istanbul.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | module.exports = function mocha_istanbul(grunt) { 4 | // Load task 5 | grunt.loadNpmTasks('grunt-mocha-istanbul'); 6 | 7 | grunt.event.on('coverage', function(lcov, done) { 8 | //console.log(lcov); 9 | done(); 10 | }); 11 | 12 | // Options 13 | return { 14 | coverage: { 15 | src: 'test', // a folder works nicely 16 | options: { 17 | coverage: true, 18 | reportFormats: ['lcov','lcovonly'], 19 | root: '.', 20 | recursive: true 21 | } 22 | } 23 | }; 24 | }; 25 | -------------------------------------------------------------------------------- /grunt/mochacli.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | module.exports = function mochacli(grunt) { 4 | // Load task 5 | grunt.loadNpmTasks('grunt-mocha-cli'); 6 | 7 | // Options 8 | return { 9 | src: ['/test/**/*.js'], 10 | options: { 11 | timeout: 6000, 12 | 'check-leaks': true, 13 | ui: 'bdd', 14 | reporter: 'spec' 15 | } 16 | }; 17 | }; 18 | -------------------------------------------------------------------------------- /lib/redmine.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * node-redmine 3 | * A nodejs library which supports 100% features of Redmine's REST API. 4 | * Author: zanran 5 | * Reference: http://www.redmine.org/projects/redmine/wiki/Rest_api 6 | */ 7 | 8 | 'use strict()'; 9 | 10 | /** 11 | * Module dependencies 12 | */ 13 | var request = require('request'); 14 | var Url = require('url'); 15 | 16 | //////////////////////////////////////////////////////////////////////////////////// 17 | /** 18 | * Redmine 19 | * 20 | * @param {String} host, Redmine hostname 21 | * @param {Object} config 22 | * - {String} apiKey, API access key for Redmine, if apiKey occured, username and password will be ignored. 23 | * - {String} username, username to login Redmine. 24 | * - {String} password, password for login Redmine. 25 | * - {String} impersonate, impersonate to a login user. 26 | * @param {String} port, Redmine port (defaults to 80) 27 | */ 28 | function Redmine(host, config, port) { 29 | if (!host) throw new Error('host not specified!'); 30 | 31 | if (typeof host === 'string') { 32 | host = Url.parse(host); 33 | } else if (typeof host !== 'object') { 34 | throw new Error('host should be a string or url object!'); 35 | } 36 | if (port) { 37 | host.port = port; 38 | host.host += ':' + port.toString(); 39 | } 40 | 41 | var baseUrl = Url.format(host); 42 | this._request = request.defaults({baseUrl: baseUrl}); 43 | 44 | if (!config || !(config.apiKey || (config.username && config.password))) { 45 | throw new Error('You should provide an API key or username & password !'); 46 | } 47 | this.config = config; 48 | } 49 | 50 | Redmine.prototype = { 51 | // get & set property 52 | get apiKey() { 53 | return this.config.apiKey; 54 | }, 55 | set apiKey(apiKey) { 56 | this.config.apiKey = apiKey; 57 | }, 58 | get username() { 59 | return this.config.username; 60 | }, 61 | set username(username) { 62 | this.config.username = username; 63 | }, 64 | get password() { 65 | return this.config.password; 66 | }, 67 | set password(password) { 68 | this.config.password = password; 69 | }, 70 | get impersonate() { 71 | return this.config.impersonate; 72 | }, 73 | set impersonate(impersonateId) { 74 | this.config.impersonate = impersonateId; 75 | } 76 | }; 77 | 78 | /** 79 | * encodeURL 80 | */ 81 | Redmine.prototype.encodeURL = function(path, params) { 82 | if (path.slice(0, 1) != '/') path = '/' + path; 83 | 84 | var query = querystring.stringify(params); 85 | if (query) path = path + '?' + query; 86 | 87 | return path; 88 | }; 89 | 90 | 91 | /** 92 | * request - request url from Redmine 93 | */ 94 | Redmine.prototype.request = function(method, path, params, callback) { 95 | var isUpload = path == '/uploads.json'; 96 | var opts = { 97 | method: method, 98 | qs: method === 'GET' ? params : undefined, 99 | body: method === 'PUT' || method === 'POST' ? params : undefined, 100 | headers: { 101 | 'Content-Type': !isUpload ? 'application/json' : 'application/octet-stream' 102 | }, 103 | // auth: { user: this.username, pass: this.password }, 104 | json: !isUpload 105 | }; 106 | 107 | // impersonate to a login user 108 | if (this.impersonate) { 109 | opts.headers['X-Redmine-Switch-User'] = this.impersonate; 110 | } 111 | 112 | if (this.apiKey) { 113 | opts.headers['X-Redmine-API-Key'] = this.config.apiKey; 114 | } else if (this.username && this.password) { 115 | opts.auth = { username: this.username, password: this.password }; 116 | } else { 117 | throw new Error('Neither api key nor username/password provided !'); 118 | } 119 | 120 | var req = this._request(path, opts, function(err, res, body) { 121 | if (err) return callback(err); 122 | 123 | if (res.statusCode != 200 && res.statusCode != 201) { 124 | var msg = { 125 | ErrorCode: res.statusCode, 126 | Message: res.statusMessage, 127 | Detail: body 128 | }; 129 | return callback(JSON.stringify(msg)); 130 | } 131 | 132 | return callback(null, isUpload ? JSON.parse(body) : body); 133 | }); 134 | }; 135 | 136 | /////////////////////////////////////// REST API for issues (Stable) /////////////////////////////////////// 137 | /** 138 | * Listing issues 139 | * Returns a paginated list of issues. By default, it returns open issues only. 140 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues 141 | */ 142 | Redmine.prototype.issues = function(params, callback) { 143 | this.request('GET', '/issues.json', params, callback); 144 | }; 145 | 146 | 147 | /** 148 | * Showing an issue 149 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Showing-an-issue 150 | */ 151 | Redmine.prototype.get_issue_by_id = function(id, params, callback) { 152 | if (typeof id !== 'number') throw new Error('Issue ID must be an integer above 0 !'); 153 | 154 | this.request('GET', '/issues/' + id + '.json', params, callback); 155 | }; 156 | 157 | 158 | /** 159 | * Creating an issue 160 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue 161 | */ 162 | Redmine.prototype.create_issue = function(issue, callback) { 163 | this.request('POST', '/issues.json', issue, callback); 164 | }; 165 | 166 | /** 167 | * Updating an issue 168 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Updating-an-issue 169 | */ 170 | Redmine.prototype.update_issue = function(id, issue, callback) { 171 | this.request('PUT', '/issues/' + id + '.json', issue, callback); 172 | }; 173 | 174 | /** 175 | * Deleting an issue 176 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Deleting-an-issue 177 | */ 178 | Redmine.prototype.delete_issue = function(id, callback) { 179 | this.request('DELETE', '/issues/' + id + '.json', {}, callback); 180 | }; 181 | 182 | /** 183 | * Adding a watcher 184 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Adding-a-watcher 185 | */ 186 | Redmine.prototype.add_watcher = function(id, params, callback) { 187 | if (!params.user_id) throw new Error('user_id (required): id of the user to add as a watcher !'); 188 | 189 | this.request('POST', '/issues/' + id + '/watchers.json', params, callback); 190 | }; 191 | 192 | /** 193 | * Removing a watcher 194 | * http://www.redmine.org/projects/redmine/wiki/Rest_Issues#Removing-a-watcher 195 | */ 196 | Redmine.prototype.remove_watcher = function(issue_id, user_id, callback) { 197 | this.request('DELETE', '/issues/' + issue_id + '/watchers/' + user_id + '.json', {}, callback); 198 | }; 199 | 200 | 201 | /////////////////////////////////////// REST API for Projects (Stable) /////////////////////////////////////// 202 | /** 203 | * Listing projects 204 | * http://www.redmine.org/projects/redmine/wiki/Rest_Projects#Listing-projects 205 | */ 206 | Redmine.prototype.projects = function(params, callback) { 207 | this.request('GET', '/projects.json', params, callback); 208 | }; 209 | 210 | /** 211 | * Showing a project 212 | * http://www.redmine.org/projects/redmine/wiki/Rest_Projects#Showing-a-project 213 | */ 214 | Redmine.prototype.get_project_by_id = function(id, params, callback) { 215 | this.request('GET', '/projects/' + id + '.json', params, callback); 216 | }; 217 | 218 | /** 219 | * Creating a project 220 | * http://www.redmine.org/projects/redmine/wiki/Rest_Projects#Creating-a-project 221 | */ 222 | Redmine.prototype.create_project = function(params, callback) { 223 | this.request('POST', '/projects.json', params, callback); 224 | }; 225 | 226 | /** 227 | * Updating a project - Updates the project of given id or identifier 228 | * http://www.redmine.org/projects/redmine/wiki/Rest_Projects#Updating-a-project 229 | */ 230 | Redmine.prototype.update_project = function(id, params, callback) { 231 | this.request('PUT', '/projects/' + id + '.json', params, callback); 232 | }; 233 | 234 | /** 235 | * Deleting a project - Deletes the project of given id or identifier 236 | * http://www.redmine.org/projects/redmine/wiki/Rest_Projects#Deleting-a-project 237 | */ 238 | Redmine.prototype.delete_project = function(id, callback) { 239 | this.request('DELETE', '/projects/' + id + '.json', {}, callback); 240 | }; 241 | 242 | 243 | /////////////////////////////////////// REST API for Users (Stable) /////////////////////////////////////// 244 | /** 245 | * list Users 246 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET 247 | */ 248 | Redmine.prototype.users = function(params, callback) { 249 | this.request('GET', '/users.json', params, callback); 250 | }; 251 | 252 | /** 253 | * Returns the user details 254 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2 255 | */ 256 | Redmine.prototype.get_user_by_id = function(id, params, callback) { 257 | this.request('GET', '/users/' + id + '.json', params, callback); 258 | }; 259 | 260 | /** 261 | * Returns current user details 262 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2 263 | */ 264 | Redmine.prototype.current_user = function(params, callback) { 265 | this.request('GET', '/users/current.json', params, callback); 266 | }; 267 | 268 | /** 269 | * create user 270 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#POST 271 | */ 272 | Redmine.prototype.create_user = function(params, callback) { 273 | this.request('POST', '/users.json', params, callback); 274 | }; 275 | 276 | /** 277 | * update user 278 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#PUT 279 | */ 280 | Redmine.prototype.update_user = function(id, params, callback) { 281 | this.request('PUT', '/users/' + id + '.json', params, callback); 282 | }; 283 | 284 | /** 285 | * Deleting user 286 | * http://www.redmine.org/projects/redmine/wiki/Rest_Users#DELETE 287 | */ 288 | Redmine.prototype.delete_user = function(id, callback) { 289 | this.request('DELETE', '/users/' + id + '.json', {}, callback); 290 | }; 291 | 292 | 293 | /////////////////////////////////////// REST API for Time Entries (Stable) /////////////////////////////////////// 294 | /** 295 | * Listing time entries 296 | * http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Listing-time-entries 297 | */ 298 | Redmine.prototype.time_entries = function(params, callback) { 299 | this.request('GET', '/time_entries.json', params, callback); 300 | }; 301 | 302 | /** 303 | * Showing a time entry 304 | * http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Showing-a-time-entry 305 | */ 306 | Redmine.prototype.get_time_entry_by_id = function(id, callback) { 307 | this.request('GET', '/time_entries/' + id + '.json', {}, callback); 308 | }; 309 | 310 | /** 311 | * Creating a time entry 312 | * http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Creating-a-time-entry 313 | */ 314 | Redmine.prototype.create_time_entry = function(params, callback) { 315 | this.request('POST', '/time_entries.json', params, callback); 316 | }; 317 | 318 | /** 319 | * Updating a time entry 320 | * http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Updating-a-time-entry 321 | */ 322 | Redmine.prototype.update_time_entry = function(id, params, callback) { 323 | this.request('PUT', '/time_entries/' + id + '.json', params, callback); 324 | }; 325 | 326 | /** 327 | * Deleting a time entry 328 | * http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Deleting-a-time-entry 329 | */ 330 | Redmine.prototype.delete_time_entry = function(id, callback) { 331 | this.request('DELETE', '/time_entries/' + id + '.json', {}, callback); 332 | }; 333 | 334 | 335 | /////////////////////////////////////// REST API for Project Memberships (Alpha) /////////////////////////////////////// 336 | /** 337 | * Returns a paginated list of the project memberships. :project_id can be either the project numerical id or the project identifier. 338 | * http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET 339 | */ 340 | Redmine.prototype.membership_by_project_id = function(id, params, callback) { 341 | this.request('GET', '/projects/' + id + '/memberships.json', params, callback); 342 | }; 343 | 344 | /** 345 | * Adds a project member 346 | * http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#POST 347 | */ 348 | Redmine.prototype.create_project_membership = function(id, params, callback) { 349 | this.request('POST', '/projects/' + id + '/memberships.json', params, callback); 350 | }; 351 | 352 | /** 353 | * Returns the membership of given :id. 354 | * http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET-2 355 | */ 356 | Redmine.prototype.project_membership_by_id = function(id,params, callback) { 357 | this.request('GET', '/memberships/' + id + '.json', params, callback); 358 | }; 359 | 360 | /** 361 | * Updates the membership of given :id. Only the roles can be updated, the project and the user of a membership are read-only. 362 | * http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#PUT 363 | */ 364 | Redmine.prototype.update_project_membership = function(id, params, callback) { 365 | this.request('PUT', '/memberships/' + id + '.json', params, callback); 366 | }; 367 | 368 | /** 369 | * Deletes a memberships 370 | * http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#DELETE 371 | */ 372 | Redmine.prototype.delete_project_membership = function(id, callback) { 373 | this.request('DELETE', '/memberships/' + id + '.json', {}, callback); 374 | }; 375 | 376 | 377 | /////////////////////////////////////// REST API for Issue Relations (Alpha) /////////////////////////////////////// 378 | /** 379 | * Returns the relations for the issue of given id (:issue_id). 380 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET 381 | */ 382 | Redmine.prototype.issue_relation_by_issue_id = function(id, callback) { 383 | this.request('GET', '/issues/' + id + '/relations.json', {}, callback); 384 | }; 385 | 386 | /** 387 | * Creates a relation for the issue of given id (:issue_id). 388 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#POST 389 | */ 390 | Redmine.prototype.create_issue_relation = function(id, params, callback) { 391 | this.request('POST', '/issues/' + id + '/relations.json', params, callback); 392 | }; 393 | 394 | /** 395 | * Returns the relation of given id. 396 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET-2 397 | */ 398 | Redmine.prototype.issue_relation_by_id = function(id, callback) { 399 | this.request('GET', '/relations/' + id + '.json', {}, callback); 400 | }; 401 | 402 | /** 403 | * Deletes the relation of given id. 404 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#DELETE 405 | */ 406 | Redmine.prototype.delete_issue_relation = function(id, callback) { 407 | this.request('DELETE', '/relations/' + id + '.json', {}, callback); 408 | }; 409 | 410 | 411 | /////////////////////////////////////// REST API for News (Prototype) /////////////////////////////////////// 412 | /** 413 | * Returns all news across all projects with pagination 414 | * http://www.redmine.org/projects/redmine/wiki/Rest_News#GET 415 | */ 416 | Redmine.prototype.news = function(params,callback) { 417 | this.request('GET', '/news.json', params, callback); 418 | }; 419 | 420 | /** 421 | * Returns all news from project with given id or identifier with pagination. 422 | * http://www.redmine.org/projects/redmine/wiki/Rest_News#GET-2 423 | */ 424 | Redmine.prototype.new_by_project_id = function(id, callback) { 425 | this.request('GET', '/projects/' + id + '/news.json', {}, callback); 426 | }; 427 | 428 | 429 | /////////////////////////////////////// REST API for Versions (Alpha) /////////////////////////////////////// 430 | /** 431 | * Returns the versions available for the project of given id or identifier (:project_id). 432 | * The response may include shared versions from other projects. 433 | * http://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET 434 | */ 435 | Redmine.prototype.version_by_project_id = function(id, callback) { 436 | this.request('GET', '/projects/' + id + '/versions.json', {}, callback); 437 | }; 438 | 439 | /** 440 | * Creates a version for the project of given id or identifier (:project_id). 441 | * http://www.redmine.org/projects/redmine/wiki/Rest_Versions#POST 442 | */ 443 | Redmine.prototype.create_version = function(id, params, callback) { 444 | this.request('POST', '/projects/' + id + '/versions.json', params, callback); 445 | }; 446 | 447 | /** 448 | * Returns the version of given id 449 | * http://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET-2 450 | */ 451 | Redmine.prototype.version_by_id = function(id, callback) { 452 | this.request('GET', '/versions/' + id + '.json', {}, callback); 453 | }; 454 | 455 | /** 456 | * Updates the version of given id 457 | * http://www.redmine.org/projects/redmine/wiki/Rest_Versions#PUT 458 | */ 459 | Redmine.prototype.update_version = function(id, params, callback) { 460 | this.request('PUT', '/versions/' + id + '.json', params, callback); 461 | }; 462 | 463 | /** 464 | * Deletes the version of given id 465 | * http://www.redmine.org/projects/redmine/wiki/Rest_Versions#DELETE 466 | */ 467 | Redmine.prototype.delete_version = function(id, callback) { 468 | this.request('DELETE', '/versions/' + id + '.json', {}, callback); 469 | }; 470 | 471 | 472 | /////////////////////////////////////// REST API for Wiki Pages (Alpha) /////////////////////////////////////// 473 | /** 474 | * Getting the pages list of a wiki 475 | * http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Wiki-Pages 476 | */ 477 | Redmine.prototype.wiki_by_project_id = function(id, callback) { 478 | this.request('GET', '/projects/' + id + '/wiki/index.json', {}, callback); 479 | }; 480 | 481 | /** 482 | * Getting a wiki page 483 | * http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-a-wiki-page 484 | */ 485 | Redmine.prototype.wiki_by_title = function(id, title, params, callback) { 486 | this.request('GET', '/projects/' + id + '/wiki/' + title + '.json', params, callback); 487 | }; 488 | 489 | /** 490 | * Getting an old version of a wiki page 491 | * http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-an-old-version-of-a-wiki-page 492 | */ 493 | Redmine.prototype.wiki_history_by_title = function(id, title, version, params, callback) { 494 | this.request('GET', '/projects/' + id + '/wiki/' + title + '/' + version + '.json', params, callback); 495 | }; 496 | 497 | /** 498 | * Creating or updating a wiki page 499 | * http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Creating-or-updating-a-wiki-page 500 | */ 501 | Redmine.prototype.create_wiki = function(id, title, params, callback) { 502 | this.request('PUT', '/projects/' + id + '/wiki/' + title + '.json', params, callback); 503 | }; 504 | 505 | /** 506 | * Deletes the issue category of given id. 507 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#DELETE 508 | */ 509 | Redmine.prototype.delete_wiki = function(id, title, callback) { 510 | this.request('DELETE', '/projects/' + id + '/wiki/' + title + '.json', {}, callback); 511 | }; 512 | 513 | 514 | /////////////////////////////////////// REST API for Queries (Alpha) /////////////////////////////////////// 515 | /** 516 | * Returns the list of all custom queries visible by the user (public and private queries) for all projects. 517 | * http://www.redmine.org/projects/redmine/wiki/Rest_Queries#GET 518 | */ 519 | Redmine.prototype.queries = function(params,callback) { 520 | this.request('GET', '/queries.json', params, callback); 521 | }; 522 | 523 | 524 | /////////////////////////////////////// REST API for Attachments (Beta) /////////////////////////////////////// 525 | /** 526 | * Returns the description of the attachment of given id. 527 | * The file can actually be downloaded at the URL given by the content_url attribute in the response. 528 | * http://www.redmine.org/projects/redmine/wiki/Rest_Attachments#GET 529 | */ 530 | Redmine.prototype.attachment_by_id = function(id, callback) { 531 | this.request('GET', '/attachments/' + id + '.json', {}, callback); 532 | }; 533 | 534 | /** 535 | * Deletes the attachment of given id. 536 | * https://www.redmine.org/issues/14828 537 | */ 538 | Redmine.prototype.delete_attachment_by_id = function(id, callback) { 539 | this.request('DELETE', '/attachments/' + id + '.json', {}, callback); 540 | }; 541 | 542 | 543 | /////////////////////////////////////// REST API for Issue Statuses (Alpha) /////////////////////////////////////// 544 | /** 545 | * Returns the list of all issue statuses. 546 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET 547 | */ 548 | Redmine.prototype.issue_statuses = function(callback) { 549 | this.request('GET', '/issue_statuses.json', {}, callback); 550 | }; 551 | 552 | 553 | /////////////////////////////////////// REST API for Trackers (Alpha) /////////////////////////////////////// 554 | /** 555 | * Returns the list of all trackers. 556 | * http://www.redmine.org/projects/redmine/wiki/Rest_Trackers#GET 557 | */ 558 | Redmine.prototype.trackers = function(callback) { 559 | this.request('GET', '/trackers.json', {}, callback); 560 | }; 561 | 562 | 563 | /////////////////////////////////////// REST API for Enumerations (Alpha) /////////////////////////////////////// 564 | /** 565 | * Returns the list of issue priorities. 566 | * http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET 567 | */ 568 | Redmine.prototype.issue_priorities = function(callback) { 569 | this.request('GET', '/enumerations/issue_priorities.json', {}, callback); 570 | }; 571 | 572 | /** 573 | * Returns the list of time entry activities. 574 | * http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-2 575 | */ 576 | Redmine.prototype.time_entry_activities = function(callback) { 577 | this.request('GET', '/enumerations/time_entry_activities.json', {}, callback); 578 | }; 579 | 580 | 581 | /////////////////////////////////////// REST API for Issue Categories (Alpha) /////////////////////////////////////// 582 | /** 583 | * Returns the issue categories available for the project of given id or identifier (:project_id). 584 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET 585 | */ 586 | Redmine.prototype.issue_categories_by_project_id = function(id, callback) { 587 | this.request('GET', '/projects/' + id + '/issue_categories.json', {}, callback); 588 | }; 589 | 590 | /** 591 | * Creates an issue category for the project of given id or identifier (:project_id). 592 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#POST 593 | */ 594 | Redmine.prototype.create_issue_category = function(id, params, callback) { 595 | this.request('POST', '/projects/' + id + '/issue_categories.json', params, callback); 596 | }; 597 | 598 | /** 599 | * Returns the issue category of given id. 600 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET-2 601 | */ 602 | Redmine.prototype.issue_category_by_id = function(id, callback) { 603 | this.request('GET', '/issue_categories/' + id + '.json', {}, callback); 604 | }; 605 | 606 | /** 607 | * Updates the issue category of given id 608 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#PUT 609 | */ 610 | Redmine.prototype.update_issue_category = function(id, params, callback) { 611 | this.request('PUT', '/issue_categories/' + id + '.json', params, callback); 612 | }; 613 | 614 | /** 615 | * Deletes the issue category of given id. 616 | * http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#DELETE 617 | */ 618 | Redmine.prototype.delete_issue_category = function(id, callback) { 619 | this.request('DELETE', '/issue_categories/' + id + '.json', {}, callback); 620 | }; 621 | 622 | 623 | /////////////////////////////////////// REST API for Roles (Alpha) /////////////////////////////////////// 624 | /** 625 | * Returns the list of roles. 626 | * http://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET 627 | */ 628 | Redmine.prototype.roles = function(callback) { 629 | this.request('GET', '/roles.json', {}, callback); 630 | }; 631 | 632 | /** 633 | * Returns the list of permissions for a given role 634 | * http://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET-2 635 | */ 636 | Redmine.prototype.role_by_id = function(id, callback) { 637 | this.request('GET', '/roles/' + id + '.json', {}, callback); 638 | }; 639 | 640 | 641 | /////////////////////////////////////// REST API for Groups (Alpha) /////////////////////////////////////// 642 | /** 643 | * Returns the list of Groups 644 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#groupsformat 645 | */ 646 | Redmine.prototype.groups = function (callback) { 647 | this.request('GET', '/groups.json', {}, callback); 648 | }; 649 | 650 | /** 651 | * Creates a Group 652 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST 653 | */ 654 | Redmine.prototype.create_group = function (params, callback) { 655 | this.request('POST', '/groups.json', params, callback); 656 | }; 657 | 658 | /** 659 | * Returns details of a group. 660 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET-2 661 | */ 662 | Redmine.prototype.group_by_id = function (id, params, callback) { 663 | this.request('GET', '/groups/' + id + '.json', params, callback); 664 | }; 665 | 666 | /** 667 | * Updates an existing group 668 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#PUT 669 | */ 670 | Redmine.prototype.update_group = function (id, params, callback) { 671 | this.request('PUT', '/groups/' + id + '.json', params, callback); 672 | }; 673 | 674 | /** 675 | * Deletes an existing group 676 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE 677 | */ 678 | Redmine.prototype.delete_group = function (id, callback) { 679 | this.request('DELETE', '/groups/' + id + '.json', {}, callback); 680 | }; 681 | 682 | /** 683 | * Adds an existing user to a group 684 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST-2 685 | */ 686 | Redmine.prototype.add_user_to_group = function (group_id, user_id, callback) { 687 | var params = { 688 | user_id: user_id 689 | }; 690 | this.request('POST', '/groups/' + group_id + '/users.json', params, callback); 691 | }; 692 | 693 | /** 694 | * Removes a user from a group 695 | * http://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE-2 696 | */ 697 | Redmine.prototype.remove_user_from_group = function (group_id, user_id, callback) { 698 | this.request('DELETE', '/groups/' + group_id + '/users/' + user_id + '.json', {}, callback); 699 | }; 700 | 701 | /////////////////////////////////////// REST API for Custom Fields (Alpha) /////////////////////////////////////// 702 | /** 703 | * Get custom fields 704 | * http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET 705 | */ 706 | Redmine.prototype.custom_fields = function (callback) { 707 | this.request('GET', '/custom_fields.json', {}, callback); 708 | }; 709 | 710 | 711 | /////////////////////////////////////// REST API for Search (Alpha) /////////////////////////////////////// 712 | // http://www.redmine.org/projects/redmine/wiki/Rest_Search 713 | // Not documented yet. 714 | 715 | 716 | /////////////////////////////////////// REST API for Common (Alpha) /////////////////////////////////////// 717 | /** 718 | * upload a file to redmine 719 | * http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Attaching-files 720 | */ 721 | 722 | Redmine.prototype.upload = function (content, callback) { 723 | this.request('POST', '/uploads.json', content, callback); 724 | }; 725 | 726 | //////////////////////////////////////////////////////////////////////////////////////// 727 | module.exports = Redmine; 728 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "node-redmine", 3 | "version": "0.2.2", 4 | "description": "node-redmine is a nodejs library which supports 100% features of Redmine's REST API.", 5 | "main": "lib/redmine.js", 6 | "directories": { 7 | "doc": "doc", 8 | "example": "example", 9 | "test": "test" 10 | }, 11 | "scripts": { 12 | "test": "grunt serve" 13 | }, 14 | "keywords": [ 15 | "Redmine", 16 | "nodejs", 17 | "REST API" 18 | ], 19 | "repository": { 20 | "type": "git", 21 | "url": "https://github.com/zanran/node-redmine.git" 22 | }, 23 | "author": "wayne@zanran.me", 24 | "license": "GPL-3.0", 25 | "dependencies": { 26 | "debug": "^2.2.0", 27 | "request": "^2.75.0" 28 | }, 29 | "devDependencies": { 30 | "grunt": "^1.0.1", 31 | "grunt-contrib-jshint": "^1.0.0", 32 | "grunt-mocha-cli": "^2.1.0", 33 | "grunt-mocha-istanbul": "^4.0.2", 34 | "grunt-mocha-test": "^0.12.7", 35 | "istanbul": "^0.4.3", 36 | "jshint-stylish": "^2.2.0", 37 | "load-grunt-configs": "^1.0.0", 38 | "load-grunt-tasks": "^3.5.0", 39 | "mocha": "^2.4.5", 40 | "time-grunt": "^1.3.0" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /test/issue.test.js: -------------------------------------------------------------------------------- 1 | /* 2 | * issue.test.js - test request for issues 3 | * Author: wayne 4 | */ 5 | 6 | var assert = require('assert'); 7 | var Redmine = require('../lib/redmine'); 8 | 9 | /////////////////////////////////////////////////////////////// 10 | var hostname = process.env.REDMINE_HOST || 'redmine.zanran.me'; 11 | var config = { 12 | apiKey: process.env.REDMINE_APIKEY || 'bed1ba0544b681e530c2447341607f423c9c8781' 13 | }; 14 | 15 | var redmine = new Redmine(hostname, config); 16 | 17 | describe('issue.test.js', function() { 18 | 19 | it('test-get-issue-with-invalid-id', function(done) { 20 | 21 | try { 22 | redmine.get_issue_by_id('0', function(err, data) { 23 | if (err) throw err; 24 | }); 25 | } catch (e) { 26 | assert.equal(e, 'Error: Issue ID must be an integer above 0 !'); 27 | } 28 | done(); 29 | }); 30 | /* 31 | it('test-get-issue-by-id-1', function(done) { 32 | 33 | try { 34 | redmine.get_issue_by_id(1, {}, function(err, data) { 35 | if (err) throw err; 36 | 37 | console.log(data); 38 | }); 39 | } catch (e) { 40 | assert.equal(e, 'Error: Issue ID must be an integer above 0 !'); 41 | } 42 | done(); 43 | });*/ 44 | }); 45 | -------------------------------------------------------------------------------- /test/redmine.test.js: -------------------------------------------------------------------------------- 1 | /* 2 | * redmine.test.js - test request for redmine 3 | * Author: wayne 4 | */ 5 | 6 | var assert = require('assert'); 7 | var Redmine = require('../lib/redmine'); 8 | 9 | 10 | /////////////////////////////////////////////////////////////// 11 | var hostname = process.env.REDMINE_HOST || 'localhost'; 12 | 13 | describe('Redmine constructor', function() { 14 | it('should throw host not specified error when no host or config given', function(done) { 15 | try { 16 | new Redmine(); 17 | } catch (e) { 18 | assert.equal(e, 'Error: host not specified!'); 19 | } 20 | done(); 21 | }); 22 | 23 | it('should throw invalid hostname error when host is invalid', function(done) { 24 | try { 25 | new Redmine(1); 26 | } catch (e) { 27 | assert.equal(e, 'Error: host should be a string or url object!'); 28 | } 29 | done(); 30 | }); 31 | 32 | it('should throw authentication missing error when no config given', function(done) { 33 | try { 34 | new Redmine('localhost'); 35 | } catch (e) { 36 | assert.equal(e, 'Error: You should provide an API key or username & password !'); 37 | } 38 | done(); 39 | }); 40 | 41 | it('should throw authentication missing error when API key and credentials missing', function(done) { 42 | try { 43 | new Redmine('localhost', {}); 44 | } catch (e) { 45 | assert.equal(e, 'Error: You should provide an API key or username & password !'); 46 | } 47 | done(); 48 | }); 49 | 50 | it('should throw authentication missing error when password missing', function(done) { 51 | var config = { 52 | username: 'dummy-username' 53 | }; 54 | try { 55 | new Redmine('localhost', {}); 56 | } catch (e) { 57 | assert.equal(e, 'Error: You should provide an API key or username & password !'); 58 | } 59 | done(); 60 | }); 61 | 62 | it('should throw authentication missing error when username missing', function(done) { 63 | var config = { 64 | password: 'dummy-password' 65 | }; 66 | try { 67 | new Redmine('localhost', {}); 68 | } catch (e) { 69 | assert.equal(e, 'Error: You should provide an API key or username & password !'); 70 | } 71 | done(); 72 | }); 73 | 74 | it('should not throw errors when host and api key given', function(done) { 75 | var config = { 76 | apiKey: process.env.REDMINE_APIKEY || 'my-redmine-api-key' 77 | }; 78 | new Redmine(hostname, config); 79 | done(); 80 | }); 81 | 82 | it('should not throw errors when host and credentials given', function(done) { 83 | var config = { 84 | username: 'dummy-username', 85 | password: 'dummy-password' 86 | }; 87 | new Redmine(hostname, config); 88 | done(); 89 | }); 90 | 91 | it('test-valid-options-attributes', function(done) { 92 | var config = { 93 | apiKey: 'dummy-api-key', 94 | username: 'dummy-username', 95 | password: 'dummy-password' 96 | }; 97 | var redmine = new Redmine(hostname, config); 98 | 99 | assert.equal(redmine.apiKey, 'dummy-api-key'); 100 | assert.equal(redmine.username, 'dummy-username'); 101 | assert.equal(redmine.password, 'dummy-password'); 102 | 103 | done(); 104 | }); 105 | }); 106 | --------------------------------------------------------------------------------