├── COPYING ├── grapnel.el ├── grapnel_test.el └── readme.org /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /grapnel.el: -------------------------------------------------------------------------------- 1 | ;;; grapnel.el --- HTTP request lib with flexible callback dispatch 2 | 3 | ;; Copyright © 2013 David Leatherman 4 | 5 | ;; Author: David Leatherman 6 | ;; URL: http://www.github.com/leathekd/grapnel 7 | ;; Version: 0.5.3 8 | 9 | ;; This file is not part of GNU Emacs. 10 | 11 | ;;; Commentary: 12 | 13 | ;; grapnel is an HTTP request library that uses a curl subprocess and 14 | ;; offers flexible callback dispatch. Not only can you pass in an 15 | ;; alist of request outcomes to callback functions (see below) but you 16 | ;; can also override the dispatch function itself if the default one 17 | ;; doesn't suit your needs. Further, grapnel will build the query 18 | ;; string, request data (i.e., POST body), and headers from alists 19 | ;; that are passed in. 20 | 21 | ;; An example: 22 | ;; (grapnel-retrieve-url 23 | ;; "www.google.com" 24 | ;; '((success . (lambda (res hdrs) (message "%s" res))) 25 | ;; (failure . (lambda (res hdrs) (message "Fail: %s" res))) 26 | ;; (error . (lambda (res err) (message "Err: %s" err)))) 27 | ;; "GET" 28 | ;; '((q . "ASIN B001EN71CW"))) 29 | 30 | ;; History 31 | 32 | ;; 0.5.1 - Initial release. 33 | 34 | ;; 0.5.2 - Fix some quoting issues on Windows 35 | 36 | ;; 0.5.3 - Handle HTTP 100 responses, fix a hanging curl request 37 | 38 | ;;; License: 39 | 40 | ;; This program is free software; you can redistribute it and/or 41 | ;; modify it under the terms of the GNU General Public License 42 | ;; as published by the Free Software Foundation; either version 3 43 | ;; of the License, or (at your option) any later version. 44 | ;; 45 | ;; This program is distributed in the hope that it will be useful, 46 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 47 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 48 | ;; GNU General Public License for more details. 49 | ;; 50 | ;; You should have received a copy of the GNU General Public License 51 | ;; along with GNU Emacs; see the file COPYING. If not, write to the 52 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 53 | ;; Boston, MA 02110-1301, USA. 54 | 55 | ;;; Code: 56 | (defvar grapnel-program (executable-find "curl") 57 | "Path to the curl executable") 58 | 59 | (defvar grapnel-options "" 60 | "Additional options to pass to all curl requests. Enter them just as they 61 | would be entered on the command line.") 62 | 63 | (defvar grapnel-callback-dispatch-fn 'grapnel-callback-dispatch 64 | "Dispatch function for handling the curl response.") 65 | 66 | (defun grapnel-url-escape (str) 67 | "URI encode STR" 68 | (url-hexify-string 69 | (encode-coding-string (format "%s" str) 'utf-8))) 70 | 71 | (defun grapnel-format-params (params) 72 | "Convert an alist of params into an & delimeted string suitable for curl" 73 | (mapconcat 74 | (lambda (p) 75 | (cond 76 | ((consp p) 77 | (concat (grapnel-url-escape (car p)) "=" (grapnel-url-escape (cdr p)))) 78 | (t (grapnel-url-escape p)))) 79 | params "&")) 80 | 81 | (defun grapnel-command (url &optional 82 | request-method url-params 83 | request-data-file request-headers) 84 | "Converts the passed arguments into the curl command" 85 | (let* ((method (or request-method "GET")) 86 | (filename (when request-data-file 87 | (expand-file-name request-data-file))) 88 | (filesize (if filename 89 | (nth 7 (file-attributes filename)) 90 | 0)) 91 | (url (if (null url-params) 92 | url 93 | (concat url 94 | (if (string-match-p "\?" url) "&" "?") 95 | (grapnel-format-params url-params)))) 96 | (data (if filename 97 | (format " --data @%s" filename) 98 | "")) 99 | (headers (if (and (equal "POST" method) 100 | (null (cdr (assoc "Content-Length" 101 | request-headers)))) 102 | (cons `("Content-Length" . ,filesize) 103 | request-headers) 104 | request-headers)) 105 | (headers (if (null headers) 106 | "" 107 | (mapconcat 108 | (lambda (header-pair) 109 | (format " --header %s" 110 | (shell-quote-argument 111 | (format "%s: %s" 112 | (car header-pair) 113 | (cdr header-pair))))) 114 | headers 115 | ""))) 116 | (options (if (< 0 (length grapnel-options)) 117 | (concat " " grapnel-options) 118 | ""))) 119 | (format "%s%s%s --include --silent --request %s%s %s" 120 | grapnel-program options headers method data 121 | (shell-quote-argument url)))) 122 | 123 | (defun grapnel-parse-headers (header-str) 124 | "Extracts the response code and converts the headers into an alist" 125 | (when header-str 126 | (let ((split-headers (split-string header-str "\n" t))) 127 | (cons 128 | (list "response-code" 129 | (progn (string-match "\\([[:digit:]][[:digit:]][[:digit:]]\\)" 130 | (car split-headers)) 131 | (string-to-number (match-string 1 (car split-headers))))) 132 | (mapcar (lambda (line) (split-string line ": ")) 133 | (cdr split-headers)))))) 134 | 135 | (defun grapnel-response-headers () 136 | "Extract the headers from the response buffer" 137 | (unless (= (point-min) (point-max)) 138 | (goto-char (point-min)) 139 | (while (re-search-forward "[\r]" nil t) 140 | (replace-match "" nil nil)) 141 | (goto-char (point-min)) 142 | (while (re-search-forward "^HTTP/1.1 100 Continue" nil t) 143 | (delete-region (point-at-bol) 144 | ;; delete the following blank line, too 145 | (progn (forward-line 2) (point)))) 146 | (goto-char (point-min)) 147 | (let ((pos (search-forward-regexp "^$" nil t))) 148 | (when pos 149 | (let ((headers (buffer-substring (point-min) pos))) 150 | (delete-region (point-min) (1+ pos)) 151 | headers))))) 152 | 153 | (defun grapnel-callback-dispatch (handler-alist exit-code response headers) 154 | "Default dispatch function. Call the first matching function in HANDLER-ALIST 155 | based on the response. HANDLER-ALIST is in the form: 156 | 157 | '((success . (lambda (response response-headers) ...)) 158 | (error . (lambda (response error-code) ...))) 159 | 160 | The valid keys in the alist are (in order of precedence): 161 | - 'error - for when the curl call fails in some way 162 | - the HTTP response code as a number 163 | - 'success - any HTTP response 200-299 164 | - 'failure - any HTTP response 400-599 165 | - 'complete - any HTTP response 166 | 167 | 'error is the only one that is called with (response error-code) all of the 168 | rest of them are called with (response headers)" 169 | (let ((response-code (cadr (assoc "response-code" headers)))) 170 | (cond 171 | ;; curl error 172 | ((and (assoc 'error handler-alist) 173 | (not (= 0 exit-code))) 174 | (apply (cdr (assoc 'error handler-alist)) 175 | (list response exit-code))) 176 | 177 | ;; response code 178 | ((assoc response-code handler-alist) 179 | (apply (cdr (assoc response-code handler-alist)) 180 | (list response headers))) 181 | 182 | ;; success 183 | ((and (assoc 'success handler-alist) 184 | (<= 200 response-code) 185 | (< response-code 300)) 186 | (apply (cdr (assoc 'success handler-alist)) 187 | (list response headers))) 188 | 189 | ;; failure 190 | ((and (assoc 'failure handler-alist) 191 | (<= 400 response-code) 192 | (< response-code 600)) 193 | (apply (cdr (assoc 'failure handler-alist)) 194 | (list response headers))) 195 | 196 | ;; complete (both success and failure) 197 | ((assoc 'complete handler-alist) 198 | (apply (cdr (assoc 'complete handler-alist)) 199 | (list response headers))) 200 | 201 | ;; warn if there was no handler 202 | (t (message (concat "GRAPNEL WARNING: Missing handler for response. " 203 | "Curl exit code: %s, Response code: %s") 204 | exit-code response-code))))) 205 | 206 | (defun grapnel-sentinel (handler-alist buffer-name data-file process signal) 207 | "Sentinel function that watches the curl process" 208 | (unwind-protect 209 | (when (or (string-match "^finished" signal) 210 | (string-match "^exited abnormally" signal)) 211 | (with-current-buffer buffer-name 212 | (let ((headers (grapnel-parse-headers (grapnel-response-headers))) 213 | (response (buffer-string))) 214 | (funcall grapnel-callback-dispatch-fn 215 | handler-alist (process-exit-status process) 216 | response headers)) 217 | (kill-buffer buffer-name))) 218 | (condition-case err 219 | (when (and (file-exists-p data-file) 220 | (not (process-live-p process))) 221 | (delete-file data-file)) 222 | (error nil)))) 223 | 224 | (defun grapnel-prepare-data-file (data) 225 | "Create and return a temp file populated with DATA. Return nil if 226 | there is no data." 227 | (when data 228 | (let ((data-file (make-temp-file "grapnel" nil "tmp"))) 229 | (with-temp-file data-file 230 | (when data 231 | (insert data))) 232 | data-file))) 233 | 234 | ;;;###autoload 235 | (defun grapnel-retrieve-url (url handler-alist &optional 236 | request-method url-params 237 | request-data request-headers) 238 | "Retrieve URL asynchronously and call the corresponding handler in 239 | HANDLER-ALIST. See the documentation for `grapnel-callback-dispatch' for 240 | details on HANDLER-ALIST. 241 | 242 | REQUEST-METHOD: a string and can be any valid HTTP verb 243 | URL-PARAMS: an alist and will be formatted into a query string and url encoded 244 | REQUEST-DATA: an alist, automatically formatted and urlencoded, sent over stdin 245 | REQUEST-HEADERS: an alist of header name to value pairs" 246 | (let* ((data (when request-data 247 | (if (listp request-data) 248 | (grapnel-format-params request-data) 249 | request-data))) 250 | (tmp-file (grapnel-prepare-data-file data)) 251 | (buffer-name (generate-new-buffer-name " grapnel"))) 252 | (condition-case err 253 | (let* ((command (grapnel-command url request-method url-params 254 | tmp-file 255 | request-headers)) 256 | (proc (start-process-shell-command "grapnel" 257 | buffer-name 258 | command))) 259 | (set-process-sentinel proc (apply-partially 'grapnel-sentinel 260 | handler-alist 261 | buffer-name 262 | tmp-file))) 263 | (error 264 | (when (file-exists-p tmp-file) 265 | (delete-file tmp-file))))) 266 | nil) 267 | 268 | ;;;###autoload 269 | (defun grapnel-retrieve-url-sync (url handler-alist &optional 270 | request-method url-params 271 | request-data request-headers) 272 | "Behaves the same as `grapnel-retrieve-url' but synchronously." 273 | (let* ((data (when request-data 274 | (if (listp request-data) 275 | (grapnel-format-params request-data) 276 | request-data))) 277 | (buffer-name (generate-new-buffer-name " grapnel")) 278 | (tmp-file (grapnel-prepare-data-file data))) 279 | (unwind-protect 280 | (progn 281 | (let* ((command (grapnel-command url request-method url-params 282 | tmp-file request-headers)) 283 | (exit-code (call-process-shell-command command tmp-file 284 | buffer-name nil))) 285 | (with-current-buffer buffer-name 286 | (let* ((headers (grapnel-parse-headers 287 | (grapnel-response-headers))) 288 | (response (buffer-string)) 289 | (ret (funcall grapnel-callback-dispatch-fn 290 | handler-alist exit-code response headers))) 291 | (kill-buffer buffer-name) 292 | ret)))) 293 | (condition-case err 294 | (when (file-exists-p tmp-file) 295 | (delete-file tmp-file)) 296 | (error nil))))) 297 | 298 | (provide 'grapnel) 299 | 300 | ;;; grapnel.el ends here 301 | -------------------------------------------------------------------------------- /grapnel_test.el: -------------------------------------------------------------------------------- 1 | (require 'ert) 2 | (require 'grapnel) 3 | 4 | (ert-deftest grapnel-test-well-documented () 5 | (let ((needs-docs nil)) 6 | (mapatoms (lambda (x) 7 | (when (and (fboundp x) 8 | (string-match "^grapnel" (symbol-name x)) 9 | (or (not (documentation x t)) 10 | (string= "" (s-trim (documentation x t))))) 11 | (setq needs-docs (cons (symbol-name x) needs-docs))))) 12 | (should (eql nil (sort needs-docs 'string<))))) 13 | 14 | (ert-deftest grapnel-test-url-escape () 15 | (should (equal (downcase "fire%20%3d%3f%2bfly") 16 | (downcase (grapnel-url-escape "fire =?+fly"))))) 17 | (ert-deftest grapnel-test-format-params () 18 | (should (equal "fire=fly&brown=coat" 19 | (grapnel-format-params '(("fire" . "fly") 20 | ("brown" . "coat")))))) 21 | 22 | (ert-deftest grapnel-test-command () 23 | (let ((grapnel-program "curl")) 24 | (should (equal (concat "curl --include --silent --request GET" 25 | " http\\://www.google.com") 26 | (grapnel-command "http://www.google.com"))) 27 | (should (equal (concat "curl --header Content-Length\\:\\ 0 --include" 28 | " --silent --request POST http\\://www.google.com") 29 | (grapnel-command "http://www.google.com" "POST"))) 30 | (should (equal (concat "curl --header Content-Length\\:\\ 0 --include" 31 | " --silent --request POST" 32 | " http\\://www.google.com\\?q\\=serenity") 33 | (grapnel-command "http://www.google.com" "POST" 34 | '(("q" . "serenity"))))) 35 | (let* ((data-file (expand-file-name (grapnel-prepare-data-file 36 | "1")))) 37 | (unwind-protect 38 | (progn 39 | (should (equal 40 | (concat "curl --header Content-Length\\:\\ 1 --include" 41 | " --silent --request POST --data @" data-file 42 | " http\\://www.google.com\\?q\\=serenity") 43 | (grapnel-command "http://www.google.com" "POST" 44 | '(("q" . "serenity")) 45 | data-file))) 46 | (should (equal 47 | (concat "curl --header Content-Length\\:\\ 1" 48 | " --header header\\:\\ value --include --silent" 49 | " --request POST --data @" data-file 50 | " http\\://www.google.com\\?q\\=serenity") 51 | (grapnel-command "http://www.google.com" "POST" 52 | '(("q" . "serenity")) 53 | data-file 54 | '(("header" . "value")))))) 55 | (condition-case err 56 | (delete-file data-file) 57 | (error nil)))))) 58 | 59 | (ert-deftest grapnel-test-parse-headers () 60 | (let ((headers (concat 61 | "HTTP/1.1 200 OK\n" 62 | "Date: Sat, 23 Mar 2013 21:49:44 GMT\n" 63 | "Expires: -1\n" 64 | "Cache-Control: private, max-age=0\n" 65 | "Content-Type: text/html; charset=ISO-8859-1\n"))) 66 | (should (equal (grapnel-parse-headers headers) 67 | '(("response-code" 200) 68 | ("Date" "Sat, 23 Mar 2013 21:49:44 GMT") 69 | ("Expires" "-1") 70 | ("Cache-Control" "private, max-age=0") 71 | ("Content-Type" "text/html; charset=ISO-8859-1")))))) 72 | 73 | (ert-deftest grapnel-test-parse-headers-continue () 74 | (with-temp-buffer 75 | (insert (concat 76 | "HTTP/1.1 100 Continue\n" 77 | "\n" 78 | "HTTP/1.1 200 OK\n" 79 | "Date: Sat, 23 Mar 2013 21:49:44 GMT\n" 80 | "Expires: -1\n" 81 | "Cache-Control: private, max-age=0\n" 82 | "Content-Type: text/html; charset=ISO-8859-1\n" 83 | "\n")) 84 | (goto-char (point-min)) 85 | (should (equal (grapnel-parse-headers (grapnel-response-headers)) 86 | '(("response-code" 200) 87 | ("Date" "Sat, 23 Mar 2013 21:49:44 GMT") 88 | ("Expires" "-1") 89 | ("Cache-Control" "private, max-age=0") 90 | ("Content-Type" "text/html; charset=ISO-8859-1")))))) 91 | 92 | (ert-deftest grapnel-test-response-headers () 93 | (let ((headers (concat 94 | "HTTP/1.1 200 OK\n" 95 | "Date: Sat, 23 Mar 2013 21:49:44 GMT\n" 96 | "Expires: -1\n" 97 | "Cache-Control: private, max-age=0\n" 98 | "Content-Type: text/html; charset=ISO-8859-1\n"))) 99 | (with-temp-buffer 100 | (insert headers 101 | "\n" 102 | "body") 103 | (should (equal headers (grapnel-response-headers)))))) 104 | 105 | (ert-deftest grapnel-test-callback-dispatch () 106 | (let ((dispatch '((201 . (lambda (_ _) "201")) 107 | (success . (lambda (_ _) "success")) 108 | (failure . (lambda (_ _) "failure")) 109 | (complete . (lambda (_ _) "complete")) 110 | (error . (lambda (_ _) "error")))) 111 | (complete '((201 . (lambda (_ _) 201)) 112 | (complete . (lambda (_ _) "complete")) 113 | (error . (lambda (_ _) "error"))))) 114 | (should (equal "success" 115 | (grapnel-callback-dispatch dispatch 0 1 116 | '(("response-code" 200))))) 117 | (should (equal "201" 118 | (grapnel-callback-dispatch dispatch 0 1 119 | '(("response-code" 201))))) 120 | (should (equal "failure" 121 | (grapnel-callback-dispatch dispatch 0 1 122 | '(("response-code" 400))))) 123 | (should (equal "error" (grapnel-callback-dispatch dispatch 1 1 nil))) 124 | (should (equal "complete" 125 | (grapnel-callback-dispatch complete 0 1 126 | '(("response-code" 200))))) 127 | (should (equal "complete" 128 | (grapnel-callback-dispatch complete 0 1 129 | '(("response-code" 400))))) 130 | ;; TODO: figure out how to test that a warning occurs 131 | ;;(grapnel-callback-dispatch '() 1 1 '()) 132 | )) 133 | 134 | (defun grapnel-test-callback (filename resp headers) 135 | "Create the file that the test looks for" 136 | (with-temp-file filename 137 | (insert resp))) 138 | 139 | (ert-deftest grapnel-test-retrieve-url-sync () 140 | (should 141 | (equal "success" 142 | (grapnel-retrieve-url-sync 143 | "www.google.com" 144 | '((success . (lambda (resp hdrs) "success")) 145 | (failure . (lambda (&rest args) "failure"))))))) 146 | 147 | (ert-deftest grapnel-test-retrieve-url () 148 | (let* ((tmp-file (make-temp-file "grapnel_test" nil "tmp")) 149 | (tries 10)) 150 | (unwind-protect 151 | (progn 152 | (grapnel-retrieve-url 153 | "www.google.com" 154 | `((success . ,(apply-partially 'grapnel-test-callback tmp-file)) 155 | (failure . (lambda (&rest args) 156 | (should 157 | (error "The request should have succeeded")))))) 158 | ;; kinda gross and will possibly fail on slow connections. :/ 159 | (while (and (not (file-exists-p tmp-file)) (< 0 tries)) 160 | (setq tries (- tries 1)) 161 | (sleep-for 0.5)) 162 | (should (file-exists-p tmp-file))) 163 | (condition-case err 164 | (delete-file tmp-file) 165 | (error nil))))) 166 | 167 | (ert-deftest grapnel-test-headers () 168 | (let ((opera-mini-resp 169 | (grapnel-retrieve-url-sync 170 | "www.google.com" 171 | `((success . (lambda (resp hdrs) resp)) 172 | (failure . (lambda (&rest args) (error "The request failed")))) 173 | "GET" 174 | nil 175 | nil 176 | '(("Accept" . (mapconcat 'identity 177 | '("application/vnd.wap.wmlc" 178 | "application/vnd.wap.wmlscriptc" 179 | "image/vnd.wap.wbmp" 180 | "application/vnd.wap.wtls-ca-certificate" 181 | "image/gif" 182 | "text/plain") 183 | ", ")) 184 | ;; this is here just for the embedded quotes 185 | ("If-None-Match" "\"abc123\"") 186 | ("User-Agent" . "Nokia8310/1.0 (04.53)")))) 187 | (response 188 | (grapnel-retrieve-url-sync 189 | "www.google.com" 190 | `((success . (lambda (resp hdrs) resp)) 191 | (failure . (lambda (&rest args) (error "The request failed")))) 192 | "GET"))) 193 | (should (string-match "WAPFORUM//DTD" opera-mini-resp)) 194 | (should (> (length response) (length opera-mini-resp))))) 195 | -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | *NO LONGER DEVELOPED* Probably apparent from the commit log, but this 2 | is no longer developed. Check out the [[https://github.com/tkf/emacs-request][request]] 3 | library for a great alternative. It features a similar callback 4 | dispatch that I was aiming for when I originally wrote grapnel. 5 | Good luck! 6 | 7 | * grapnel 8 | A HTTP request lib for Emacs with flexible callback dispatch. 9 | 10 | grapnel is an HTTP request library that uses a curl subprocess and 11 | offers flexible callback dispatch. Not only can you pass in an alist 12 | of request outcomes to callback functions (see below) but you can also 13 | override the dispatch function itself if the default one doesn't suit 14 | your needs. Further, grapnel will build the query string, request data 15 | (i.e., POST body), and headers from alists that are passed in. 16 | 17 | See the inline docs for more information. 18 | 19 | ** Installation 20 | *** Via Marmalade/Melpa 21 | #+BEGIN_EXAMPLE 22 | (require 'package) 23 | (add-to-list 'package-archives 24 | '("marmalade" . "http://marmalade-repo.org/packages/") t) 25 | (add-to-list 'package-archives 26 | '("melpa" . "https://melpa.org/packages/") t) 27 | (package-initialize) 28 | #+END_EXAMPLE 29 | 30 | Then you can install it: 31 | 32 | #+BEGIN_EXAMPLE 33 | M-x package-refresh-contents 34 | M-x package-install RET grapnel RET 35 | #+END_EXAMPLE 36 | 37 | *** Manually (via git) 38 | Download the source or clone the repo and add the following 39 | to ~/.emacs.d/init.el: 40 | 41 | #+BEGIN_EXAMPLE 42 | (add-to-list 'load-path "path/to/grapnel") 43 | (require 'grapnel) 44 | #+END_EXAMPLE 45 | 46 | ** Usage Example 47 | 48 | #+BEGIN_EXAMPLE 49 | (grapnel-retrieve-url 50 | url 51 | `((401 . (lambda (response headers) 52 | (error "Unauthorized!"))) 53 | (success . ,success-callback) 54 | (failure . (lambda (response headers) 55 | (error "Failed with: %s for %s" 56 | (cadr (assoc "response-code" headers)) 57 | ,url))) 58 | (error . (lambda (response) 59 | (error "Error: %s" response)))) 60 | "GET" 61 | '((some-param . "some-value"))) 62 | #+END_EXAMPLE 63 | 64 | ** License 65 | Copyright © 2013 David Leatherman. 66 | 67 | Files are licensed under the same license as Emacs unless otherwise 68 | specified. See the file LICENSE for details. 69 | 70 | You should have received a copy of the GNU General Public License 71 | along with this program. If not, see . 72 | --------------------------------------------------------------------------------