├── .editorconfig ├── .gitignore ├── .travis.yml ├── HISTORY.rst ├── LICENSE ├── README.rst ├── build.sh ├── guerrillamail.py ├── requirements.txt ├── setup.py └── tests.py /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | trim_trailing_whitespace = true 6 | insert_final_newline = true 7 | indent_style = space 8 | indent_size = 4 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.egg-info 3 | .project 4 | .pydevproject 5 | *~ 6 | build 7 | dist 8 | .cache 9 | *.swp 10 | tags 11 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "2.7" 4 | - "3.3" 5 | - "3.4" 6 | - "3.5" 7 | install: "pip install -r requirements.txt" 8 | script: py.test tests.py 9 | -------------------------------------------------------------------------------- /HISTORY.rst: -------------------------------------------------------------------------------- 1 | Change History 2 | -------------- 3 | 4 | 0.2.0 5 | +++++ 6 | 7 | + Add support for Python 3.3, 3.4 and 3.5. 8 | + Add "guerrillamail" executable. 9 | 10 | 11 | 0.1.2 12 | +++++ 13 | 14 | + Fix mail "excerpt" property. 15 | 16 | 17 | 0.1.1 18 | +++++ 19 | 20 | + Remove version restriction on Requests dependency. 21 | 22 | 23 | 0.1.0 24 | +++++ 25 | 26 | + Initial release. 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Python Guerrillamail 2 | ==================== 3 | 4 | Python Guerrillamail is a Python client API and command line interface for 5 | interacting with a `Guerrillamail`_ temporary email server. 6 | 7 | .. image:: https://travis-ci.org/ncjones/python-guerrillamail.svg?branch=master 8 | :target: https://travis-ci.org/ncjones/python-guerrillamail 9 | :alt: Build Status 10 | 11 | 12 | Installation 13 | ------------ 14 | 15 | .. code-block:: sh 16 | 17 | pip install python-guerrillamail 18 | 19 | 20 | Example Usage 21 | ------------- 22 | 23 | Create session using auto-assigned email address, print email address and print 24 | id of first message in inbox: 25 | 26 | .. code-block:: python 27 | 28 | from guerrillamail import GuerrillaMailSession 29 | session = GuerrillaMailSession() 30 | print session.get_session_state()['email_address'] 31 | print session.get_email_list()[0].guid 32 | 33 | 34 | Example CLI Usage 35 | ----------------- 36 | 37 | Set email address: 38 | 39 | .. code-block:: 40 | 41 | $ guerrillamail setaddr john.doe 42 | $ guerrillamail info 43 | Email: john.doe@guerrillamailblock.com 44 | 45 | 46 | List inbox contents: 47 | 48 | .. code-block:: 49 | 50 | $ guerrillamail list 51 | (*) 48859781 23:45:27+00:00 spam@example.com 52 | Example messsage 2 53 | 54 | (*) 48859574 09:25:01+00:00 spam@example.com 55 | Example message 56 | 57 | ( ) 1 00:00:00+00:00 no-reply@guerrillamail.com 58 | Welcome to Guerrilla Mail 59 | 60 | 61 | Read email message: 62 | 63 | .. code-block:: 64 | 65 | $ guerrillamail get 48859781 66 | From: spam@example.com 67 | Date: 2016-06-11 23:45:27+00:00 68 | Subject: Example message 2 69 | 70 | Example Guerrillamail message body. 71 | 72 | 73 | Using Alternative Guerrillamail Server 74 | -------------------------------------- 75 | 76 | By default, ``http://api.guerrillamail.com`` is used as the base URL for 77 | Guerrillamail API calls. This can be overridden by providing the ``base_url`` 78 | property when constructing a GuerrillaMailSession instance. When using the CLI 79 | the ``base_url`` property can be defined in the ``~/.guerrillamail`` JSON 80 | config file, for example: 81 | 82 | .. code-block:: json 83 | 84 | { 85 | "base_url": "https://api.guerrillamail.com" 86 | } 87 | 88 | 89 | License 90 | ------- 91 | 92 | Python Guerrilla Mail is free software, licensed under the GPLv3. 93 | 94 | 95 | .. _Guerrillamail: https://www.guerrillamail.com/ 96 | -------------------------------------------------------------------------------- /build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cd "$(dirname "$0")" 3 | rm -rf build dist 4 | python setup.py bdist_wheel --universal sdist 5 | -------------------------------------------------------------------------------- /guerrillamail.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # Copyright Nathan Jones 2014, 2016 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | from __future__ import print_function 19 | from __future__ import unicode_literals 20 | 21 | import argparse 22 | from datetime import tzinfo, timedelta, datetime 23 | from time import time 24 | import json 25 | from os.path import expanduser 26 | import sys 27 | 28 | import requests 29 | 30 | 31 | # UTC timezone implementation from 32 | # http://docs.python.org/2/library/datetime.html#tzinfo-objects 33 | 34 | ZERO = timedelta(0) 35 | 36 | 37 | class UTC(tzinfo): 38 | """UTC""" 39 | # 40 | def utcoffset(self, dt): 41 | return ZERO 42 | 43 | def tzname(self, dt): 44 | return "UTC" 45 | 46 | def dst(self, dt): 47 | return ZERO 48 | 49 | 50 | utc = UTC() 51 | 52 | 53 | class GuerrillaMailException(Exception): 54 | def __init__(self, message): 55 | self.message = message 56 | 57 | 58 | def _transform_dict(original, key_map): 59 | result = {} 60 | for (new_key, (old_key, transform_fn)) in list(key_map.items()): 61 | try: 62 | result[new_key] = transform_fn(original[old_key]) 63 | except KeyError: 64 | pass 65 | return result 66 | 67 | 68 | class Mail(object): 69 | @classmethod 70 | def from_response(cls, response_data): 71 | """ 72 | Factory method to create a Mail instance from a Guerrillamail response 73 | dict. 74 | """ 75 | identity = lambda x: x 76 | return Mail(**_transform_dict(response_data, { 77 | 'guid': ('mail_id', identity), 78 | 'subject': ('mail_subject', identity), 79 | 'sender': ('mail_from', identity), 80 | 'datetime': ('mail_timestamp', lambda x: datetime.utcfromtimestamp(int(x)).replace(tzinfo=utc)), 81 | 'read': ('mail_read', int), 82 | 'excerpt': ('mail_excerpt', identity), 83 | 'body': ('mail_body', identity), 84 | })) 85 | 86 | def __init__(self, guid=None, subject=None, sender=None, datetime=None, 87 | read=False, exerpt=None, excerpt=None, body=None): 88 | self.guid = guid 89 | self.subject = subject 90 | self.sender = sender 91 | self.datetime = datetime 92 | self.read = read 93 | # legacy broken "exerpt" property maintained for backwards compatibility 94 | self.exerpt = None 95 | self.excerpt = excerpt 96 | self.body = body 97 | 98 | @property 99 | def time(self): 100 | return self.datetime.time().replace(tzinfo=self.datetime.tzinfo) if self.datetime else None 101 | 102 | 103 | SESSION_TIMEOUT_SECONDS = 3600 104 | 105 | 106 | class GuerrillaMailSession(object): 107 | """ 108 | An abstraction over a GuerrillamailClient which maintains session state. 109 | 110 | This class is not thread safe. 111 | """ 112 | def __init__(self, session_id=None, email_address=None, email_timestamp=0, **kwargs): 113 | self.client = GuerrillaMailClient(**kwargs) 114 | self.session_id = session_id 115 | self.email_timestamp = email_timestamp 116 | self.email_address = email_address 117 | 118 | def _update_session_state(self, response_data): 119 | try: 120 | self.session_id = response_data['sid_token'] 121 | except KeyError: 122 | pass 123 | try: 124 | self.email_address = response_data['email_addr'] 125 | except KeyError: 126 | pass 127 | try: 128 | self.email_timestamp = response_data['email_timestamp'] 129 | except KeyError: 130 | pass 131 | 132 | def is_expired(self): 133 | current_time = int(time()) 134 | expiry_time = self.email_timestamp + SESSION_TIMEOUT_SECONDS - 5 135 | return current_time >= expiry_time 136 | 137 | def _delegate_to_client(self, method_name, *args, **kwargs): 138 | client_method = getattr(self.client, method_name) 139 | response_data = client_method(session_id=self.session_id, *args, **kwargs) 140 | self._update_session_state(response_data) 141 | return response_data 142 | 143 | def get_session_state(self): 144 | self._ensure_valid_session(fully_populate=True) 145 | return { 146 | 'email_address': self.email_address 147 | } 148 | 149 | def set_email_address(self, address_local_part): 150 | self._delegate_to_client('set_email_address', address_local_part=address_local_part) 151 | 152 | def _renew_session(self): 153 | if self.email_address: 154 | self.set_email_address(self.email_address) 155 | else: 156 | self._delegate_to_client('get_email_address') 157 | 158 | def _ensure_valid_session(self, fully_populate=False): 159 | if self.session_id is None or self.is_expired() or fully_populate and not self.email_address: 160 | self._renew_session() 161 | if self.session_id is None: 162 | raise GuerrillaMailException('Failed to obtain session id') 163 | 164 | def get_email_list(self, offset=0): 165 | self._ensure_valid_session() 166 | response_data = self._delegate_to_client('get_email_list', offset=offset) 167 | email_list = response_data.get('list') 168 | return [Mail.from_response(e) for e in email_list] if email_list else [] 169 | 170 | def get_email(self, email_id): 171 | return Mail.from_response(self._delegate_to_client('get_email', email_id=email_id)) 172 | 173 | 174 | class GuerrillaMailClient(object): 175 | """ 176 | A client to the Guerrillamail web service API 177 | (https://www.guerrillamail.com/GuerrillaMailAPI.html). 178 | """ 179 | def __init__(self, base_url='http://api.guerrillamail.com', client_ip='127.0.0.1'): 180 | self.base_url = base_url 181 | self.client_ip = client_ip 182 | 183 | def _do_request(self, session_id, **kwargs): 184 | url = self.base_url + '/ajax.php' 185 | kwargs['ip'] = self.client_ip 186 | if session_id is not None: 187 | kwargs['sid_token'] = session_id 188 | response = requests.get(url, params=kwargs) 189 | try: 190 | response.raise_for_status() 191 | except requests.HTTPError as e: 192 | raise GuerrillaMailException(('Request failed: {e.request.url} ' + 193 | '{e.response.status_code} {e.response.reason}').format(e=e)) 194 | data = json.loads(response.text) 195 | return data 196 | 197 | def get_email_address(self, session_id=None): 198 | return self._do_request(session_id, f='get_email_address') 199 | 200 | def get_email_list(self, session_id, offset=0): 201 | if session_id is None: 202 | raise ValueError('session_id is None') 203 | return self._do_request(session_id, f='get_email_list', offset=offset) 204 | 205 | def get_email(self, email_id, session_id=None): 206 | response_data = self._do_request(session_id, f='fetch_email', email_id=email_id) 207 | if not response_data: 208 | raise GuerrillaMailException('Not found: ' + str(email_id)) 209 | return response_data 210 | 211 | def set_email_address(self, address_local_part, session_id=None): 212 | return self._do_request(session_id, f='set_email_user', email_user=address_local_part) 213 | 214 | 215 | SETTINGS_FILE = '~/.guerrillamail' 216 | 217 | 218 | def load_settings(): 219 | try: 220 | with open(expanduser(SETTINGS_FILE)) as f: 221 | return json.load(f) 222 | except IOError: 223 | return {} 224 | 225 | 226 | def save_settings(settings): 227 | with open(expanduser(SETTINGS_FILE), 'w+') as f: 228 | json.dump(settings, f, indent=4) 229 | f.write('\n') 230 | 231 | 232 | class Command(object): 233 | params = [] 234 | 235 | 236 | class GetInfoCommand(Command): 237 | name = 'info' 238 | help = 'Show information about the current session.' 239 | description = 'Show information about the current session.' 240 | 241 | def invoke(self, session, args): 242 | return 'Email: ' + session.get_session_state()['email_address'] 243 | 244 | 245 | class SetAddressCommand(Command): 246 | name = 'setaddr' 247 | help = 'Set the email address for the current session.' 248 | description = '''Set the email address for the current session. This 249 | address will be used when listing inbox contents.''' 250 | params = [{ 251 | 'name': 'address', 252 | 'help': 'an email address "local part". The domain, if provided, will be ignored.' 253 | }] 254 | 255 | def invoke(self, session, args): 256 | session.set_email_address(args.address) 257 | 258 | 259 | class ListEmailCommand(Command): 260 | name = 'list' 261 | help = 'Get the current inbox contents.' 262 | description = 'Get the contents of the inbox associated with the current session' 263 | 264 | def invoke(self, session, args): 265 | email_list = session.get_email_list() 266 | output = '' 267 | for email in email_list: 268 | output += self.format_email_summary(email) + '\n' 269 | return output 270 | 271 | def format_email_summary(self, email): 272 | unread_indicator = '*' if not email.read else ' ' 273 | email_format = '({unread_indicator}) {email.guid:<8} {email.time} {email.sender}\n{email.subject}\n' 274 | return email_format.format(email=email, unread_indicator=unread_indicator) 275 | 276 | 277 | class GetEmailCommand(Command): 278 | name = 'get' 279 | help = 'Get an email message by id.' 280 | description = '''Get an email message by id. The requested email does not 281 | need to belong to the inbox associated with the current session.''' 282 | params = [{ 283 | 'name': 'id', 284 | 'help': 'an email id' 285 | }] 286 | 287 | def invoke(self, session, args): 288 | email = session.get_email(args.id) 289 | return self.format_email(email) 290 | 291 | def format_email(self, email): 292 | email_format = 'From: {email.sender}\nDate: {email.datetime}\nSubject: {email.subject}\n\n{email.body}\n' 293 | return email_format.format(email=email) 294 | 295 | 296 | COMMAND_TYPES = [GetInfoCommand, SetAddressCommand, ListEmailCommand, GetEmailCommand] 297 | 298 | 299 | def parse_args(args): 300 | parser = argparse.ArgumentParser(description='''Call a Guerrillamail web service. 301 | All commands operate on the current Guerrillamail session which is stored in {0}. If a session does not exist 302 | or has timed out a new one will be created.'''.format(SETTINGS_FILE)) 303 | subparsers = parser.add_subparsers(dest='command', metavar='') 304 | subparsers.required = True 305 | for Command in COMMAND_TYPES: 306 | command_parser = subparsers.add_parser(Command.name, help=Command.help, description=Command.description) 307 | for param in Command.params: 308 | param_name = param['name'] 309 | command_parser.add_argument(param_name, metavar='<{0}>'.format(param_name), help=param['help']) 310 | return parser.parse_args(args) 311 | 312 | 313 | def get_command(command_name): 314 | try: 315 | return [C() for C in COMMAND_TYPES if C.name == command_name][0] 316 | except IndexError: 317 | raise ValueError('Invalid command: ' + command_name) 318 | 319 | 320 | def update_settings(settings, session): 321 | settings['session_id'] = session.session_id 322 | settings['email_timestamp'] = session.email_timestamp 323 | settings['email_address'] = session.email_address 324 | 325 | 326 | def cli(*args): 327 | args = parse_args(args) 328 | settings = load_settings() 329 | session = GuerrillaMailSession(**settings) 330 | try: 331 | output = get_command(args.command).invoke(session, args) 332 | except GuerrillaMailException as e: 333 | print(e.message, file=sys.stderr) 334 | else: 335 | if output is not None: 336 | print(output) 337 | update_settings(settings, session) 338 | save_settings(settings) 339 | 340 | 341 | def main(): 342 | cli(*sys.argv[1:]) 343 | 344 | 345 | if __name__ == '__main__': 346 | main() 347 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.10.0 2 | httpretty==0.8.14 3 | mock==2.0.0 4 | sure==1.3.0 5 | pytest==2.9.2 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | from codecs import open 3 | 4 | 5 | with open('README.rst', 'r', 'utf-8') as f: 6 | readme = f.read() 7 | with open('HISTORY.rst', 'r', 'utf-8') as f: 8 | history = f.read() 9 | 10 | setup( 11 | name='python-guerrillamail', 12 | version='0.2.0', 13 | description='Client for the Guerrillamail temporary email server', 14 | long_description=readme + '\n\n' + history, 15 | keywords='guerrillamail email client cli', 16 | author='Nathan Jones', 17 | url='https://github.com/ncjones/python-guerrillamail', 18 | py_modules=['guerrillamail'], 19 | install_requires=[ 20 | 'requests', 21 | ], 22 | license='GPL3', 23 | classifiers=[ 24 | 'Development Status :: 5 - Production/Stable', 25 | 'Intended Audience :: Developers', 26 | 'Natural Language :: English', 27 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 28 | 'Programming Language :: Python', 29 | 'Programming Language :: Python :: 2', 30 | 'Programming Language :: Python :: 2.7', 31 | 'Programming Language :: Python :: 3', 32 | 'Programming Language :: Python :: 3.3', 33 | 'Programming Language :: Python :: 3.4', 34 | 'Programming Language :: Python :: 3.5' 35 | ], 36 | entry_points={ 37 | 'console_scripts': [ 38 | 'guerrillamail=guerrillamail:main', 39 | ], 40 | } 41 | ) 42 | -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # Copyright Nathan Jones 2014, 2016 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | from __future__ import unicode_literals 19 | 20 | import contextlib 21 | from datetime import datetime, time 22 | import os 23 | import sys 24 | from time import time as timetime 25 | from unittest.case import TestCase 26 | 27 | import httpretty 28 | from mock import patch, DEFAULT, Mock 29 | from sure import expect 30 | 31 | from guerrillamail import GuerrillaMailClient, GuerrillaMailException, GuerrillaMailSession, cli, GetInfoCommand, \ 32 | ListEmailCommand, GetEmailCommand, parse_args, get_command, SetAddressCommand, Mail, utc 33 | 34 | 35 | @contextlib.contextmanager 36 | def redirect_file(src_file, dest_file_path): 37 | """ 38 | A context manager to temporarily redirect open files, eg: 39 | 40 | with redirect_file(sys.stderr, os.devnull): 41 | fn_that_prints_unwantedly_to_stderr() 42 | 43 | https://stackoverflow.com/questions/977840/redirecting-fortran-called-via-f2py-output-in-python/17753573#17753573 44 | """ 45 | try: 46 | src_file_copy = os.dup(src_file.fileno()) 47 | dest_file = open(dest_file_path, 'w') 48 | os.dup2(dest_file.fileno(), src_file.fileno()) 49 | yield 50 | finally: 51 | if src_file_copy is not None: 52 | os.dup2(src_file_copy, src_file.fileno()) 53 | if dest_file is not None: 54 | dest_file.close() 55 | 56 | 57 | class MailTest(TestCase): 58 | def test_from_response_should_map_subject(self): 59 | mail = Mail.from_response({'mail_subject': 'Hello'}) 60 | expect(mail.subject).to.equal('Hello') 61 | 62 | def test_from_response_should_default_subject_to_none(self): 63 | mail = Mail.from_response({}) 64 | expect(mail.subject).to.be.none 65 | 66 | def test_from_response_should_map_sender(self): 67 | mail = Mail.from_response({'mail_from': 'test@example.com'}) 68 | expect(mail.sender).to.equal('test@example.com') 69 | 70 | def test_from_response_should_default_sender_to_none(self): 71 | mail = Mail.from_response({}) 72 | expect(mail.sender).to.be.none 73 | 74 | def test_from_response_should_map_guid(self): 75 | mail = Mail.from_response({'mail_id': '12345'}) 76 | expect(mail.guid).to.equal('12345') 77 | 78 | def test_from_response_should_default_guid_to_none(self): 79 | mail = Mail.from_response({}) 80 | expect(mail.guid).to.be.none 81 | 82 | def test_from_response_should_map_read_as_bool_false(self): 83 | mail = Mail.from_response({'mail_read': '0'}) 84 | expect(mail.read).to.be.false 85 | 86 | def test_from_response_should_map_read_as_bool_true(self): 87 | mail = Mail.from_response({'mail_read': '1'}) 88 | expect(mail.read).to.be.true 89 | 90 | def test_from_response_should_default_read_to_false(self): 91 | mail = Mail.from_response({}) 92 | expect(mail.read).to.be.false 93 | 94 | def test_from_response_should_map_datetime(self): 95 | mail = Mail.from_response({'mail_timestamp': '1392459985'}) 96 | expect(mail.datetime).to.equal(datetime(2014, 2, 15, 10, 26, 25, tzinfo=utc)) 97 | 98 | def test_from_response_should_default_datetime_to_none(self): 99 | mail = Mail.from_response({}) 100 | expect(mail.datetime).to.be.none 101 | 102 | def test_from_response_should_map_excerpt(self): 103 | mail = Mail.from_response({'mail_excerpt': 'A brief message....'}) 104 | expect(mail.excerpt).to.equal('A brief message....') 105 | 106 | def test_from_response_should_default_excerpt_to_none(self): 107 | mail = Mail.from_response({}) 108 | expect(mail.excerpt).to.be.none 109 | 110 | def test_from_response_should_not_map_typo_exerpt_property(self): 111 | mail = Mail.from_response({'mail_exerpt': 'A brief message....'}) 112 | mail = Mail.from_response({'mail_excerpt': 'A brief message....'}) 113 | expect(mail.exerpt).to.be.none 114 | 115 | def test_from_response_should_map_body(self): 116 | mail = Mail.from_response({'mail_body': 'A brief message from our sponsors'}) 117 | expect(mail.body).to.equal('A brief message from our sponsors') 118 | 119 | def test_from_response_should_default_body_to_none(self): 120 | mail = Mail.from_response({}) 121 | expect(mail.body).to.be.none 122 | 123 | def test_from_response_should_ignore_unknown_properties(self): 124 | mail = Mail.from_response({ 125 | "mail_recipient": "john", 126 | }) 127 | expect(mail).to.not_have.property('recipient') 128 | 129 | def test_time_should_be_derived_from_datetime(self): 130 | mail = Mail(datetime=datetime(2014, 2, 16, 19, 34)) 131 | expect(mail.time).to.equal(time(19, 34)) 132 | 133 | def test_time_should_be_use_same_tz_as_datetime(self): 134 | mail = Mail(datetime=datetime(2014, 2, 16, 19, 34, tzinfo=utc)) 135 | expect(mail.time).to.equal(time(19, 34, tzinfo=utc)) 136 | 137 | def test_time_should_be_none_when_datetime_is_none(self): 138 | mail = Mail(datetime=None) 139 | expect(mail.time).to.be.none 140 | 141 | 142 | class GuerrillaMailClientTest(TestCase): 143 | def setUp(self): 144 | self.client = GuerrillaMailClient(base_url='http://test-host') 145 | 146 | @httpretty.activate 147 | def test_get_email_address_should_send_query_params(self): 148 | response_body = '{"email_addr":""}' 149 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 150 | body=response_body, match_querystring=True) 151 | self.client.get_email_address() 152 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 153 | 'f': ['get_email_address'], 154 | 'ip': ['127.0.0.1'], 155 | }) 156 | 157 | @httpretty.activate 158 | def test_get_email_address_should_include_session_id_query_param_when_present(self): 159 | response_body = '{"email_addr":""}' 160 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 161 | body=response_body, match_querystring=True) 162 | self.client.get_email_address(session_id=1) 163 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 164 | 'f': ['get_email_address'], 165 | 'ip': ['127.0.0.1'], 166 | 'sid_token': ['1'], 167 | }) 168 | 169 | @httpretty.activate 170 | def test_get_email_address_should_returned_deserialized_json(self): 171 | response_body = '{"email_addr":"test@example.com"}' 172 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 173 | body=response_body, match_querystring=True) 174 | response = self.client.get_email_address() 175 | expect(response).to.equal({'email_addr': 'test@example.com'}) 176 | 177 | @httpretty.activate 178 | def test_get_email_address_should_raise_exception_on_failed_request(self): 179 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', status=500) 180 | expect(self.client.get_email_address).when.called_with().should.throw(GuerrillaMailException) 181 | 182 | @httpretty.activate 183 | def test_set_email_address_should_send_query_params(self): 184 | response_body = '{"email_addr":""}' 185 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 186 | body=response_body, match_querystring=True) 187 | self.client.set_email_address('newaddr') 188 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 189 | 'f': ['set_email_user'], 190 | 'ip': ['127.0.0.1'], 191 | 'email_user': ['newaddr'], 192 | }) 193 | 194 | @httpretty.activate 195 | def test_set_email_address_should_include_session_id_query_param_when_present(self): 196 | response_body = '{"email_addr":""}' 197 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 198 | body=response_body, match_querystring=True) 199 | self.client.set_email_address('newaddr', session_id=1) 200 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 201 | 'f': ['set_email_user'], 202 | 'ip': ['127.0.0.1'], 203 | 'email_user': ['newaddr'], 204 | 'sid_token': ['1'], 205 | }) 206 | 207 | @httpretty.activate 208 | def test_set_email_address_should_returned_deserialized_json(self): 209 | response_body = '{"email_addr":"test@example.com"}' 210 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 211 | body=response_body, match_querystring=True) 212 | response = self.client.set_email_address('newaddr') 213 | expect(response).to.equal({'email_addr': 'test@example.com'}) 214 | 215 | @httpretty.activate 216 | def test_set_email_address_should_raise_exception_on_failed_request(self): 217 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', status=500) 218 | expect(self.client.set_email_address).when.called_with('newaddr').should.throw(GuerrillaMailException) 219 | 220 | @httpretty.activate 221 | def test_get_email_list_should_send_query_params(self): 222 | response_body = '{"list":[]}' 223 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 224 | body=response_body, match_querystring=True) 225 | self.client.get_email_list(session_id=1) 226 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 227 | 'f': ['get_email_list'], 228 | 'ip': ['127.0.0.1'], 229 | 'offset': ['0'], 230 | 'sid_token': ['1'], 231 | }) 232 | 233 | def test_get_email_list_should_not_allow_session_id_to_be_none(self): 234 | expect(self.client.get_email_list).when.called_with(session_id=None).to.throw(ValueError) 235 | 236 | @httpretty.activate 237 | def test_get_email_list_should_return_deserialized_json(self): 238 | response_body = '{"list":[{"subject":"Hello"}]}' 239 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 240 | body=response_body, match_querystring=True) 241 | email_list = self.client.get_email_list(session_id=1) 242 | expect(email_list).to.equal({'list':[{'subject': 'Hello'}]}) 243 | 244 | @httpretty.activate 245 | def test_get_email_list_should_raise_exception_on_failed_request(self): 246 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', status=500) 247 | expect(self.client.get_email_list).when.called_with(session_id=1).should.throw(GuerrillaMailException) 248 | 249 | @httpretty.activate 250 | def test_get_email_should_send_query_params(self): 251 | response_body = '{"list":[]}' 252 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 253 | body=response_body, match_querystring=True) 254 | self.client.get_email(email_id=123) 255 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 256 | 'f': ['fetch_email'], 257 | 'ip': ['127.0.0.1'], 258 | 'email_id': ['123'], 259 | }) 260 | 261 | @httpretty.activate 262 | def test_get_email_should_send_session_id_query_param_when_present(self): 263 | response_body = '{"list":[]}' 264 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 265 | body=response_body, match_querystring=True) 266 | self.client.get_email(email_id=123, session_id=1) 267 | expect(httpretty.last_request()).to.have.property('querystring').being.equal({ 268 | 'f': ['fetch_email'], 269 | 'ip': ['127.0.0.1'], 270 | 'email_id': ['123'], 271 | 'sid_token': ['1'], 272 | }) 273 | 274 | @httpretty.activate 275 | def test_get_email_should_return_deserialized_json(self): 276 | response_body = '{"subject":"Hello"}' 277 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', 278 | body=response_body, match_querystring=True) 279 | email = self.client.get_email(email_id=123) 280 | expect(email).to.equal({'subject': 'Hello'}) 281 | 282 | @httpretty.activate 283 | def test_get_email_should_raise_exception_on_failed_request(self): 284 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', status=500) 285 | expect(self.client.get_email).when.called_with(email_id=123).should.throw(GuerrillaMailException) 286 | 287 | @httpretty.activate 288 | def test_get_email_should_raise_exception_when_message_not_found(self): 289 | httpretty.register_uri(httpretty.GET, 'http://test-host/ajax.php', status=200, body='false') 290 | expect(self.client.get_email).when.called_with(email_id=123).should.throw(GuerrillaMailException) 291 | 292 | 293 | def current_timestamp(): 294 | return int(timetime()) 295 | 296 | 297 | @patch.multiple('guerrillamail', GuerrillaMailClient=DEFAULT) 298 | class GuerrillaMailSessionTest(TestCase): 299 | def setup_mocks(self, GuerrillaMailClient, **kwargs): 300 | self.mock_client = Mock() 301 | GuerrillaMailClient.return_value = self.mock_client 302 | self.session = GuerrillaMailSession() 303 | 304 | def test_get_email_state_should_extract_email_address_from_response(self, **kwargs): 305 | self.setup_mocks(**kwargs) 306 | self.mock_client.get_email_address.return_value = {'email_addr': 'test@example.com', 'sid_token': 1} 307 | email_address = self.session.get_session_state() 308 | expect(email_address).to.equal({'email_address': 'test@example.com'}) 309 | 310 | def test_get_email_state_should_call_client(self, **kwargs): 311 | self.setup_mocks(**kwargs) 312 | self.mock_client.get_email_address.return_value = {'email_addr': '', 'sid_token': 1} 313 | self.session.get_session_state() 314 | self.mock_client.get_email_address.assert_called_once_with(session_id=None) 315 | 316 | def test_get_session_state_should_call_client_with_session_id_when_set(self, **kwargs): 317 | self.setup_mocks(**kwargs) 318 | self.mock_client.get_email_address.return_value = {'email_addr': ''} 319 | self.session.session_id = 1 320 | self.session.get_session_state() 321 | self.mock_client.get_email_address.assert_called_once_with(session_id=1) 322 | 323 | def test_get_session_state_should_update_session_id_when_included_in_response(self, **kwargs): 324 | self.setup_mocks(**kwargs) 325 | self.mock_client.get_email_address.return_value = {'email_addr': '', 'sid_token': 1} 326 | assert self.session.session_id == None 327 | self.session.get_session_state() 328 | expect(self.session.session_id).to.equal(1) 329 | 330 | def test_get_session_state_should_not_update_session_id_when_not_included_in_response(self, **kwargs): 331 | self.setup_mocks(**kwargs) 332 | self.mock_client.get_email_address.return_value = {'email_addr': ''} 333 | self.session.session_id = 1 334 | self.session.get_session_state() 335 | expect(self.session.session_id).to.equal(1) 336 | 337 | def test_get_session_state_should_update_email_timestamp(self, **kwargs): 338 | self.setup_mocks(**kwargs) 339 | self.mock_client.get_email_address.return_value = {'email_addr': '', 'email_timestamp': 1234, 'sid_token': 1} 340 | assert self.session.email_timestamp == 0 341 | self.session.get_session_state() 342 | expect(self.session.email_timestamp).to.equal(1234) 343 | 344 | def test_get_session_state_should_update_email_address(self, **kwargs): 345 | self.setup_mocks(**kwargs) 346 | self.mock_client.get_email_address.return_value = { 347 | 'email_addr': 'test@users.org', 'email_timestamp': 1234, 'sid_token': 1, 348 | } 349 | assert self.session.email_timestamp == 0 350 | self.session.get_session_state() 351 | expect(self.session.email_address).to.equal('test@users.org') 352 | 353 | def test_get_session_state_should_use_cached_data_when_available_and_current(self, **kwargs): 354 | self.setup_mocks(**kwargs) 355 | self.session.session_id = 1 356 | self.session.email_address = 'test@users.org' 357 | self.session.email_timestamp = current_timestamp() 358 | self.session.get_session_state() 359 | expect(self.mock_client.get_email_address.called).to.equal(False) 360 | expect(self.mock_client.set_email_address.called).to.equal(False) 361 | 362 | def test_set_email_address_should_return_none(self, **kwargs): 363 | self.setup_mocks(**kwargs) 364 | self.mock_client.set_email_address.return_value = {'email_addr': 'test@example.com'} 365 | result = self.session.set_email_address('newaddr') 366 | expect(result).to.be.none 367 | 368 | def test_set_email_address_should_call_client(self, **kwargs): 369 | self.setup_mocks(**kwargs) 370 | self.mock_client.set_email_address.return_value = {'email_addr': ''} 371 | self.session.set_email_address('newaddr') 372 | self.mock_client.set_email_address.assert_called_once_with(session_id=None, address_local_part='newaddr') 373 | 374 | def test_set_email_address_should_call_client_with_session_id_when_set(self, **kwargs): 375 | self.setup_mocks(**kwargs) 376 | self.mock_client.set_email_address.return_value = {'email_addr': ''} 377 | self.session.session_id = 1 378 | self.session.set_email_address('newaddr') 379 | self.mock_client.set_email_address.assert_called_once_with(session_id=1, address_local_part='newaddr') 380 | 381 | def test_set_email_address_should_update_session_id_when_included_in_response(self, **kwargs): 382 | self.setup_mocks(**kwargs) 383 | self.mock_client.set_email_address.return_value = {'email_addr': '', 'sid_token': 1} 384 | assert self.session.session_id == None 385 | self.session.set_email_address('newaddr') 386 | expect(self.session.session_id).to.equal(1) 387 | 388 | def test_set_email_address_should_not_update_session_id_when_not_included_in_response(self, **kwargs): 389 | self.setup_mocks(**kwargs) 390 | self.mock_client.set_email_address.return_value = {'email_addr': ''} 391 | self.session.session_id = 1 392 | self.session.set_email_address('newaddr') 393 | expect(self.session.session_id).to.equal(1) 394 | 395 | def test_set_email_address_should_update_email_timestamp(self, **kwargs): 396 | self.setup_mocks(**kwargs) 397 | self.mock_client.set_email_address.return_value = {'email_addr': '', 'email_timestamp': 1234} 398 | assert self.session.email_timestamp == 0 399 | self.session.set_email_address('newaddr') 400 | expect(self.session.email_timestamp).to.equal(1234) 401 | 402 | def test_set_email_address_should_update_email_address(self, **kwargs): 403 | self.setup_mocks(**kwargs) 404 | self.mock_client.set_email_address.return_value = {'email_addr': 'test@users.org', 'email_timestamp': 1234} 405 | assert self.session.email_timestamp == 0 406 | self.session.set_email_address('newaddr') 407 | expect(self.session.email_address).to.equal('test@users.org') 408 | 409 | def test_get_email_list_should_extract_response_list(self, **kwargs): 410 | self.setup_mocks(**kwargs) 411 | self.mock_client.get_email_list.return_value = {'list': []} 412 | self.session.session_id = 1 413 | self.session.email_timestamp = current_timestamp() 414 | email_list = self.session.get_email_list() 415 | expect(email_list).to.have.length_of(0) 416 | 417 | def test_get_email_list_should_create_mail_instances_from_response_list(self, **kwargs): 418 | self.setup_mocks(**kwargs) 419 | self.mock_client.get_email_list.return_value = { 420 | 'list': [{ 421 | 'mail_id': '1', 422 | 'mail_subject': 'Hello', 423 | 'mail_from': 'user@example.com', 424 | 'mail_timestamp': '1392501749', 425 | 'mail_read': '0', 426 | 'mail_excerpt': 'Hi there....', 427 | }] 428 | } 429 | self.session.session_id = 1 430 | self.session.email_timestamp = current_timestamp() 431 | email_list = self.session.get_email_list() 432 | email = email_list[0] 433 | expect(email_list).to.have.length_of(1) 434 | expect(email).to.have.property('guid').with_value.being.equal('1') 435 | expect(email).to.have.property('subject').with_value.being.equal('Hello') 436 | expect(email).to.have.property('sender').with_value.being.equal('user@example.com') 437 | expect(email).to.have.property('datetime').with_value.being.equal(datetime(2014, 2, 15, 22, 2, 29, tzinfo=utc)) 438 | expect(email).to.have.property('read').with_value.being.false 439 | expect(email).to.have.property('excerpt').with_value.being.equal('Hi there....') 440 | 441 | def test_get_email_list_should_call_client(self, **kwargs): 442 | self.setup_mocks(**kwargs) 443 | self.mock_client.get_email_list.return_value = {'list': []} 444 | self.session.session_id = 1 445 | self.session.email_timestamp = current_timestamp() 446 | self.session.get_email_list() 447 | self.mock_client.get_email_list.assert_called_once_with(session_id=1, offset=0) 448 | 449 | def test_get_email_list_should_call_client_with_session_id_when_set(self, **kwargs): 450 | self.setup_mocks(**kwargs) 451 | self.mock_client.get_email_list.return_value = {'list': []} 452 | self.session.session_id = 1 453 | self.session.email_timestamp = current_timestamp() 454 | self.session.get_email_list() 455 | self.mock_client.get_email_list.assert_called_once_with(session_id=1, offset=0) 456 | 457 | def test_get_email_list_should_update_session_id_when_included_in_response(self, **kwargs): 458 | self.setup_mocks(**kwargs) 459 | self.mock_client.get_email_list.return_value = {'list': [], 'sid_token': 1} 460 | self.session.session_id = 0 461 | self.session.email_timestamp = current_timestamp() 462 | self.session.get_email_list() 463 | expect(self.session.session_id).to.equal(1) 464 | 465 | def test_get_email_list_should_not_update_session_id_when_not_included_in_response(self, **kwargs): 466 | self.setup_mocks(**kwargs) 467 | self.mock_client.get_email_list.return_value = {'list': []} 468 | self.session.session_id = 1 469 | self.session.email_timestamp = current_timestamp() 470 | self.session.get_email_list() 471 | expect(self.session.session_id).to.equal(1) 472 | 473 | def test_get_email_list_should_not_invoke_get_address_when_session_id_set_and_not_expired(self, **kwargs): 474 | self.setup_mocks(**kwargs) 475 | self.session.session_id = 1 476 | self.session.email_timestamp = current_timestamp() 477 | self.mock_client.get_email_list.return_value = {'list': []} 478 | self.session.get_email_list() 479 | expect(self.mock_client.get_email_address.called).to.equal(False) 480 | 481 | def test_get_email_list_should_first_create_session_when_session_id_not_set(self, **kwargs): 482 | self.setup_mocks(**kwargs) 483 | self.mock_client.get_email_list.return_value = {'list': []} 484 | self.mock_client.get_email_address.return_value = {'sid_token': '1', 'email_addr': ''} 485 | self.session.email_timestamp = current_timestamp() 486 | assert self.session.session_id == None 487 | self.session.get_email_list() 488 | expect(self.session.session_id).to.equal('1') 489 | self.mock_client.get_email_list.assert_called_once_with(session_id='1', offset=0) 490 | 491 | def test_get_email_list_should_first_create_session_and_reuse_address_when_session_id_not_set(self, **kwargs): 492 | self.setup_mocks(**kwargs) 493 | self.mock_client.get_email_list.return_value = {'list': []} 494 | self.mock_client.set_email_address.return_value = {'sid_token': '1', 'email_addr': ''} 495 | self.session.email_timestamp = current_timestamp() 496 | self.session.email_address = 'test@users.org' 497 | assert self.session.session_id == None 498 | self.session.get_email_list() 499 | expect(self.session.session_id).to.equal('1') 500 | self.mock_client.get_email_list.assert_called_once_with(session_id='1', offset=0) 501 | 502 | def test_get_email_list_should_fail_when_session_cannot_be_obtained(self, **kwargs): 503 | self.setup_mocks(**kwargs) 504 | self.mock_client.get_email_address.return_value = {'email_addr': ''} 505 | assert self.session.session_id == None 506 | expect(self.session.get_email_list).when.called.to.throw(GuerrillaMailException) 507 | expect(self.mock_client.get_email_list.called).to.equal(False) 508 | 509 | def test_get_email_list_should_refresh_session_when_email_expired(self, **kwargs): 510 | self.setup_mocks(**kwargs) 511 | self.mock_client.get_email_list.return_value = {'list': []} 512 | self.mock_client.get_email_address.return_value = {'email_addr': '', 'sid_token': '2', 'email_timestamp': 1234} 513 | self.session.session_id = 1 514 | self.session.email_timestamp = current_timestamp() - 3600 515 | self.session.get_email_list() 516 | expect(self.session.session_id).to.equal('2') 517 | expect(self.session.email_timestamp).to.equal(1234) 518 | self.mock_client.get_email_list.assert_called_once_with(session_id='2', offset=0) 519 | 520 | def test_get_email_list_should_refresh_session_and_reuse_address_when_email_expired(self, **kwargs): 521 | self.setup_mocks(**kwargs) 522 | self.mock_client.get_email_list.return_value = {'list': []} 523 | self.mock_client.set_email_address.return_value = {'email_addr': '', 'sid_token': '2', 'email_timestamp': 1234} 524 | self.session.session_id = 1 525 | self.session.email_address = 'user@test.com' 526 | self.session.email_timestamp = current_timestamp() - 3600 527 | self.session.get_email_list() 528 | expect(self.session.session_id).to.equal('2') 529 | expect(self.session.email_timestamp).to.equal(1234) 530 | self.mock_client.get_email_list.assert_called_once_with(session_id='2', offset=0) 531 | 532 | def test_get_email_list_should_not_refresh_session_when_email_not_expired(self, **kwargs): 533 | self.setup_mocks(**kwargs) 534 | self.mock_client.get_email_list.return_value = {'list': []} 535 | self.session.session_id = 1 536 | self.session.email_timestamp = current_timestamp() - 3590 537 | self.session.get_email_list() 538 | expect(self.mock_client.get_email_address.called).to.equal(False) 539 | 540 | def test_get_email_should_create_mail_instance_from_client_response_data(self, **kwargs): 541 | self.setup_mocks(**kwargs) 542 | self.mock_client.get_email.return_value = { 543 | 'mail_id': '1', 544 | 'mail_subject': 'Hello', 545 | 'mail_from': 'user@example.com', 546 | 'mail_timestamp': '1392501749', 547 | 'mail_read': '0', 548 | 'mail_excerpt': 'Hi there....', 549 | 'mail_body': 'Hi there partner', 550 | } 551 | email = self.session.get_email('123') 552 | expect(email).to.have.property('guid').with_value.being.equal('1') 553 | expect(email).to.have.property('subject').with_value.being.equal('Hello') 554 | expect(email).to.have.property('sender').with_value.being.equal('user@example.com') 555 | expect(email).to.have.property('datetime').with_value.being.equal(datetime(2014, 2, 15, 22, 2, 29, tzinfo=utc)) 556 | expect(email).to.have.property('read').with_value.being.false 557 | expect(email).to.have.property('excerpt').with_value.being.equal('Hi there....') 558 | expect(email).to.have.property('body').with_value.being.equal('Hi there partner') 559 | 560 | def test_get_email_should_call_client(self, **kwargs): 561 | self.setup_mocks(**kwargs) 562 | self.mock_client.get_email.return_value = {} 563 | self.session.get_email('123') 564 | self.mock_client.get_email.assert_called_once_with(email_id='123', session_id=None) 565 | 566 | def test_get_email_should_call_client_with_session_id_when_set(self, **kwargs): 567 | self.setup_mocks(**kwargs) 568 | self.mock_client.get_email.return_value = {} 569 | self.session.session_id = 1 570 | self.session.get_email('123') 571 | self.mock_client.get_email.assert_called_once_with(email_id='123', session_id=1) 572 | 573 | def test_get_email_should_update_session_id_when_included_in_response(self, **kwargs): 574 | self.setup_mocks(**kwargs) 575 | self.mock_client.get_email.return_value = {'sid_token': 1} 576 | assert self.session.session_id == None 577 | self.session.get_email('123') 578 | expect(self.session.session_id).to.equal(1) 579 | 580 | def test_get_email_should_not_update_session_id_when_not_included_in_response(self, **kwargs): 581 | self.setup_mocks(**kwargs) 582 | self.mock_client.get_email.return_value = {} 583 | self.session.session_id = 1 584 | self.session.get_email('123') 585 | expect(self.session.session_id).to.equal(1) 586 | 587 | 588 | class GetInfoCommandTest(TestCase): 589 | def setUp(self): 590 | self.command = GetInfoCommand() 591 | 592 | def test_invoke_should_get_email_address_from_session(self): 593 | mock_session = Mock(get_session_state=lambda: {'email_address': 'test@example.com'}) 594 | output = self.command.invoke(mock_session, None) 595 | expect(output).to.equal('Email: test@example.com') 596 | 597 | 598 | class SetAddressCommandTest(TestCase): 599 | def setUp(self): 600 | self.command = SetAddressCommand() 601 | 602 | def test_invoke_should_call_set_email_address_on_session(self): 603 | mock_session = Mock() 604 | mock_args = Mock(address='john91') 605 | self.command.invoke(mock_session, mock_args) 606 | mock_session.set_email_address.assert_called_with('john91') 607 | 608 | def test_invoke_should_have_no_output(self): 609 | mock_session = Mock() 610 | mock_args = Mock(address='john91') 611 | output = self.command.invoke(mock_session, mock_args) 612 | expect(output).to.be.none 613 | 614 | 615 | class ListEmailCommandTest(TestCase): 616 | def setUp(self): 617 | self.command = ListEmailCommand() 618 | 619 | def test_invoke_should_format_mail_summaries(self): 620 | date = datetime(2014, 2, 16, 12, 34) 621 | mail = Mail(subject='Test', sender='user@example.com', guid='1234567', datetime=date) 622 | mock_session = Mock(get_email_list=lambda: [mail]) 623 | output = self.command.invoke(mock_session, None) 624 | expect(output).to.equal('(*) 1234567 12:34:00 user@example.com\nTest\n\n') 625 | 626 | def test_invoke_should_format_mail_summaries_without_star_when_read(self): 627 | date = datetime(2014, 2, 16, 12, 34) 628 | mail = Mail(subject='Test', sender='user@example.com', guid='1234567', datetime=date, read=True) 629 | mock_session = Mock(get_email_list=lambda: [mail]) 630 | output = self.command.invoke(mock_session, None) 631 | expect(output).to.equal('( ) 1234567 12:34:00 user@example.com\nTest\n\n') 632 | 633 | def test_invoke_should_format_mail_summaries_with_left_aligned_guid(self): 634 | date = datetime(2014, 2, 16, 12, 34) 635 | mail = Mail(subject='Test', sender='user@example.com', guid='123', datetime=date) 636 | mock_session = Mock(get_email_list=lambda: [mail]) 637 | output = self.command.invoke(mock_session, None) 638 | expect(output).to.equal('(*) 123 12:34:00 user@example.com\nTest\n\n') 639 | 640 | def test_invoke_should_format_mail_summaries_with_min_two_spaces_after_guid(self): 641 | date = datetime(2014, 2, 16, 12, 34) 642 | mail = Mail(subject='Test', sender='user@example.com', guid='1234567890', datetime=date) 643 | mock_session = Mock(get_email_list=lambda: [mail]) 644 | output = self.command.invoke(mock_session, None) 645 | expect(output).to.equal('(*) 1234567890 12:34:00 user@example.com\nTest\n\n') 646 | 647 | def test_invoke_should_handle_unicode_chars(self): 648 | date = datetime(2014, 2, 16, 12, 34) 649 | mail = Mail(subject=u'Test\u0131', sender='user@example.com', guid='1234567', datetime=date) 650 | mock_session = Mock(get_email_list=lambda: [mail]) 651 | output = self.command.invoke(mock_session, None) 652 | expect(output).to.equal(u'(*) 1234567 12:34:00 user@example.com\nTest\u0131\n\n') 653 | 654 | def test_invoke_should_format_mail_summaries_with_tz_when_present(self): 655 | date = datetime(2014, 2, 16, 12, 34, tzinfo=utc) 656 | mail = Mail(subject='Test', sender='user@example.com', guid='1234567', datetime=date, read=True) 657 | mock_session = Mock(get_email_list=lambda: [mail]) 658 | output = self.command.invoke(mock_session, None) 659 | expect(output).to.equal('( ) 1234567 12:34:00+00:00 user@example.com\nTest\n\n') 660 | 661 | 662 | class GetEmailCommandTest(TestCase): 663 | def setUp(self): 664 | self.command = GetEmailCommand() 665 | 666 | def test_invoke_should_format_mail(self): 667 | mail = Mail( 668 | subject='Test', 669 | sender='user@example.com', 670 | datetime=datetime(2014, 2, 15, 22, 2, 29), 671 | body='Hello' 672 | ) 673 | mock_session = Mock(get_email=lambda _: mail) 674 | mock_args = Mock(id=1) 675 | output = self.command.invoke(mock_session, mock_args) 676 | expect(output).to.equal('From: user@example.com\nDate: {0}\nSubject: Test\n\nHello\n'.format(mail.datetime)) 677 | 678 | 679 | class GuerrillaMailParseArgsTest(TestCase): 680 | def test_parse_args_should_extract_info_command(self, **kwargs): 681 | args = parse_args(['info']) 682 | expect(args.command).to.equal('info') 683 | 684 | def test_parse_args_should_extract_set_address_command(self, **kwargs): 685 | args = parse_args(['setaddr', 'john91']) 686 | expect(args.command).to.equal('setaddr') 687 | expect(args.address).to.equal('john91') 688 | 689 | def test_parse_args_should_extract_list_command(self, **kwargs): 690 | args = parse_args(['list']) 691 | expect(args.command).to.equal('list') 692 | 693 | def test_parse_args_should_extract_get_command(self, **kwargs): 694 | args = parse_args(['get', '123']) 695 | expect(args.command).to.equal('get') 696 | expect(args.id).to.equal('123') 697 | 698 | def test_parse_args_should_reject_unknown_command(self, **kwargs): 699 | with redirect_file(sys.stderr, os.devnull): 700 | self.assertRaises(SystemExit, parse_args, ['cheese']) 701 | 702 | def test_parse_args_should_reject_get_command_with_id_missing(self, **kwargs): 703 | with redirect_file(sys.stderr, os.devnull): 704 | self.assertRaises(SystemExit, parse_args, ['get']) 705 | 706 | 707 | class GuerrillaMailGetCommandTest(TestCase): 708 | def test_get_address_command_should_return_get_address_command_instance(self): 709 | command = get_command('info') 710 | expect(command).to.be.a('guerrillamail.GetInfoCommand') 711 | 712 | def test_set_address_command_should_return_set_address_command_instance(self): 713 | command = get_command('setaddr') 714 | expect(command).to.be.a('guerrillamail.SetAddressCommand') 715 | 716 | def test_get_list_command_should_return_get_list_command_instance(self): 717 | command = get_command('list') 718 | expect(command).to.be.a('guerrillamail.ListEmailCommand') 719 | 720 | def test_get_get_command_should_return_get_email_command_instance(self): 721 | command = get_command('get') 722 | expect(command).to.be.a('guerrillamail.GetEmailCommand') 723 | 724 | def test_get_unknown_command_should_raise_exception(self): 725 | expect(get_command).when.called_with('cheese').to.throw(ValueError) 726 | 727 | 728 | @patch.multiple('guerrillamail', load_settings=DEFAULT, save_settings=DEFAULT, GuerrillaMailSession=DEFAULT, 729 | parse_args=DEFAULT, get_command=DEFAULT) 730 | class GuerrillaMailCliTest(TestCase): 731 | def setup_mocks(self, GuerrillaMailSession, load_settings, parse_args, get_command, **kwargs): 732 | load_settings.return_value = {} 733 | self.mock_session = Mock() 734 | self.mock_args = Mock() 735 | self.mock_command = Mock() 736 | GuerrillaMailSession.return_value = self.mock_session 737 | parse_args.return_value = self.mock_args 738 | get_command.return_value = self.mock_command 739 | 740 | def test_cli_should_create_session_using_settings(self, GuerrillaMailSession, load_settings, **kwargs): 741 | self.setup_mocks(GuerrillaMailSession=GuerrillaMailSession, load_settings=load_settings, **kwargs) 742 | load_settings.return_value = {'arg1': 1, 'arg2': 'cheese'} 743 | cli() 744 | GuerrillaMailSession.assert_called_with(arg1=1, arg2='cheese') 745 | 746 | def test_cli_should_get_command_by_command_name_arg(self, get_command, **kwargs): 747 | self.setup_mocks(get_command=get_command, **kwargs) 748 | self.mock_args.command = 'cheese' 749 | cli() 750 | get_command.assert_called_with('cheese') 751 | 752 | def test_cli_should_invoke_command(self, **kwargs): 753 | self.setup_mocks(**kwargs) 754 | cli() 755 | self.mock_command.invoke.assert_called_once_with(self.mock_session, self.mock_args) 756 | 757 | def test_cli_should_save_settings_with_updated_session_id(self, save_settings, **kwargs): 758 | self.setup_mocks(**kwargs) 759 | self.mock_args.command = 'cheese' 760 | def set_session_state(*args): 761 | self.mock_session.session_id = 123 762 | self.mock_session.email_timestamp = 4321 763 | self.mock_session.email_address = 'test@users.com' 764 | self.mock_command.invoke.side_effect = set_session_state 765 | cli() 766 | expected_settings = {'session_id': 123, 'email_timestamp': 4321, 'email_address': 'test@users.com'} 767 | save_settings.assert_called_with(expected_settings) 768 | 769 | def test_cli_should_capture_guerrillamail_exception(self, **kwargs): 770 | self.setup_mocks(**kwargs) 771 | def raise_exception(*args): 772 | raise GuerrillaMailException(None) 773 | self.mock_command.invoke.side_effect = raise_exception 774 | cli() 775 | 776 | def test_cli_should_not_capture_unexpected_exception(self, **kwargs): 777 | self.setup_mocks(**kwargs) 778 | def raise_exception(*args): 779 | raise Exception() 780 | self.mock_command.invoke.side_effect = raise_exception 781 | expect(cli).when.called.to.throw(Exception) 782 | --------------------------------------------------------------------------------