├── .gitignore ├── .travis.yml ├── LICENSE.txt ├── Makefile ├── README.md ├── addon.xml ├── changelog.txt ├── lib ├── routing.py └── tests.py ├── pylintrc ├── requirements.txt ├── resources └── icon.png └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.pyo 3 | .pytest_cache/ 4 | .tox/ 5 | 6 | build/ 7 | dist/ 8 | routing.egg-info/ 9 | 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | python: 4 | - '2.7' 5 | - '3.6' 6 | - '3.7' 7 | 8 | sudo: false 9 | 10 | env: 11 | PYTHONPATH: lib 12 | 13 | install: 14 | - pip install -r requirements.txt 15 | 16 | script: 17 | - pylint lib/*.py 18 | - pytest lib/tests.py 19 | #- if [[ $TRAVIS_PYTHON_VERSION != 2.7 ]]; then (kodi-addon-checker --branch=krypton .); fi 20 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | 676 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ENVS := flake8,py27,py36 2 | export PYTHONPATH := $(CURDIR)/lib 3 | addon_xml := addon.xml 4 | 5 | # Collect information to build as sensible package name 6 | name = $(shell xmllint --xpath 'string(/addon/@id)' $(addon_xml)) 7 | version = $(shell xmllint --xpath 'string(/addon/@version)' $(addon_xml)) 8 | git_branch = $(shell git rev-parse --abbrev-ref HEAD) 9 | git_hash = $(shell git rev-parse --short HEAD) 10 | 11 | zip_name = $(name)-$(version)-$(git_branch)-$(git_hash).zip 12 | include_files = addon.xml changelog.txt LICENSE.txt README.md lib/ 13 | include_paths = $(patsubst %,$(name)/%,$(include_files)) 14 | exclude_files = \*.new \*.orig \*.pyc \*.pyo 15 | zip_dir = $(name)/ 16 | 17 | blue = \e[1;34m 18 | white = \e[1;37m 19 | reset = \e[0m 20 | 21 | .PHONY: test 22 | 23 | all: test 24 | 25 | package: zip 26 | 27 | test: sanity unit addon 28 | 29 | sanity: pylint 30 | 31 | tox: 32 | @echo -e "$(white)=$(blue) Starting sanity tox test$(reset)" 33 | tox -q -e $(ENVS) 34 | 35 | pylint: 36 | @echo -e "$(white)=$(blue) Starting sanity pylint test$(reset)" 37 | pylint lib/*.py 38 | 39 | addon: clean 40 | @echo -e "$(white)=$(blue) Starting sanity addon tests$(reset)" 41 | kodi-addon-checker . --branch=krypton 42 | kodi-addon-checker . --branch=leia 43 | 44 | unit: 45 | @echo -e "$(white)=$(blue) Starting unit tests$(reset)" 46 | pytest lib/tests.py 47 | 48 | # NOTE: To make this work you need to clone to $name-$version 49 | zip: clean 50 | @echo -e "$(white)=$(blue) Building new package$(reset)" 51 | @rm -f ../$(zip_name) 52 | cd ..; zip -r $(zip_name) $(include_paths) -x $(exclude_files) 53 | @echo -e "$(white)=$(blue) Successfully wrote package as: $(white)../$(zip_name)$(reset)" 54 | 55 | clean: 56 | find lib/ -name '*.pyc' -type f -delete 57 | find lib/ -name '__pycache__' -type d -delete 58 | rm -rf .pytest_cache/ .tox/ *.log 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![GitHub release](https://img.shields.io/github/release/tamland/kodi-plugin-routing.svg)](https://github.com/tamland/kodi-plugin-routing/releases) 2 | [![Build Status](https://travis-ci.org/tamland/kodi-plugin-routing.svg?branch=master)](https://travis-ci.org/tamland/kodi-plugin-routing) 3 | [![License: GPLv3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/GPL-3.0) 4 | [![Contributors](https://img.shields.io/github/contributors/tamland/kodi-plugin-routing.svg)](https://github.com/tamland/kodi-plugin-routing/graphs/contributors) 5 | 6 | # Plugin routing 7 | 8 | Library for building and parsing URLs in [Kodi](http://kodi.tv) plugins. 9 | 10 | 11 | ## Example 12 | 13 | ```python 14 | import routing 15 | from xbmcgui import ListItem 16 | from xbmcplugin import addDirectoryItem, endOfDirectory 17 | 18 | plugin = routing.Plugin() 19 | 20 | @plugin.route('/') 21 | def index(): 22 | addDirectoryItem(plugin.handle, plugin.url_for(show_category, "one"), ListItem("Category One"), True) 23 | addDirectoryItem(plugin.handle, plugin.url_for(show_category, "two"), ListItem("Category Two"), True) 24 | addDirectoryItem(plugin.handle, plugin.url_for(show_directory, "/dir/one"), ListItem("Directory One"), True) 25 | addDirectoryItem(plugin.handle, plugin.url_for(show_directory, "/dir/two"), ListItem("Directory Two"), True) 26 | endOfDirectory(plugin.handle) 27 | 28 | @plugin.route('/category/') 29 | def show_category(category_id): 30 | addDirectoryItem(plugin.handle, "", ListItem("Hello category %s!" % category_id)) 31 | endOfDirectory(plugin.handle) 32 | 33 | @plugin.route('/directory/') 34 | def show_directory(dir): 35 | addDirectoryItem(plugin.handle, "", ListItem("List directory %s!" % dir)) 36 | endOfDirectory(plugin.handle) 37 | 38 | if __name__ == '__main__': 39 | plugin.run() 40 | ``` 41 | 42 | 43 | ## Creating rules 44 | 45 | The `route()` decorator binds a function to an URL pattern. The pattern is a 46 | path expression consisting of static parts and variable parts of an URL. 47 | Variables are enclosed in angle brackets as `` and will be passed 48 | to the function as keyword arguments. 49 | 50 | For example: 51 | 52 | ```python 53 | @plugin.route('/hello/') 54 | def hello(what): 55 | # will be called for all incoming URLs like "/hello/world", "/hello/123" etc. 56 | # 'what' will contain "world", "123" etc. depending on the URL. 57 | pass 58 | ``` 59 | 60 | In case your variable contains slashes (i.e. is a path or URL) and you want 61 | to match this, you can use the `path` identifier in the patern. 62 | 63 | ```python 64 | @plugin.route('/url/') 65 | def parse_url(url): 66 | # will be called for all incoming URLs like "/url/https://foo.bar/baz" etc. 67 | # 'url' can be any string with slashes. 68 | pass 69 | ``` 70 | 71 | Routes can also be registered manually with the `add_route` method. 72 | 73 | 74 | ## Building URLs 75 | 76 | `url_for()` can be used to build URLs for registered functions. It takes a 77 | reference to a function and a number of arguments that corresponds to variables 78 | in the URL rule. 79 | 80 | For example: 81 | 82 | ```python 83 | plugin.url_for(hello, what="world") 84 | ``` 85 | 86 | will read the rule for `hello`, fill in the variable parts and return a final URL: 87 | 88 | ``` 89 | plugin://my.addon.id/hello/world 90 | ``` 91 | 92 | which can be passed to `xbmcplugin.addDirectoryItem()`. All variable parts must 93 | be passed to `url_for` either as ordered arguments or keyword arguments. 94 | 95 | Keywords that does not occur in the function/pattern will be added as query string in the returned URL. 96 | 97 | Alternatively, URLs can be created directly from a path with `url_for_path`. For 98 | example `url_for_path('/foo/bar')` will return `plugin://my.addon.id/foo/bar`. 99 | Unlike `url_for` this method will not check that the path is valid. 100 | 101 | 102 | ## Query string 103 | 104 | The query string part of the URL is parsed with `urlparse.parse_qs` and is 105 | accessible via the `plugin.args` attribute. The dictionary keys corresponds to 106 | query variables and values to lists of query values. 107 | 108 | Example: 109 | 110 | ```python 111 | @plugin.route('/') 112 | def index(): 113 | url = plugin.url_for(search, query="hello world") 114 | addDirectoryItem(plugin.handle, url, ListItem("Search")) 115 | # ... 116 | 117 | 118 | @plugin.route('/search') 119 | def search(): 120 | query = plugin.args['query'][0] 121 | addDirectoryItem(plugin.handle, "", ListItem("You searched for '%s'" % query)) 122 | # ... 123 | ``` 124 | 125 | 126 | ## Creating a dependency in your addon 127 | 128 | To get kodi to install this dependency you will have to add a command to your `addons.xml`. 129 | ```xml 130 | 131 | 132 | 133 | 134 | ``` 135 | -------------------------------------------------------------------------------- /addon.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Routing module for plugins 9 | Library for building and parsing plugin URLs. 10 | GNU GENERAL PUBLIC LICENSE. Version 3, 29 June 2007 11 | all 12 | en_GB 13 | https://github.com/tamland/kodi-plugin-routing 14 | 15 | resources/icon.png 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /changelog.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tamland/kodi-plugin-routing/c3fb9eaa60f09504f53e11568308a8b0bbd59382/changelog.txt -------------------------------------------------------------------------------- /lib/routing.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2014-2015 Thomas Amland 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 absolute_import, division, print_function, unicode_literals 19 | 20 | import re 21 | import sys 22 | try: 23 | from urlparse import urlsplit, parse_qs 24 | except ImportError: 25 | from urllib.parse import urlsplit, parse_qs 26 | try: 27 | from urllib import urlencode 28 | except ImportError: 29 | from urllib.parse import urlencode 30 | 31 | try: 32 | import xbmc 33 | import xbmcaddon 34 | _addon_id = xbmcaddon.Addon().getAddonInfo('id') 35 | 36 | def log(msg): 37 | msg = "[%s][routing] %s" % (_addon_id, msg) 38 | xbmc.log(msg, level=xbmc.LOGDEBUG) 39 | except ImportError: 40 | def log(msg): 41 | print(msg) 42 | 43 | 44 | class RoutingError(Exception): 45 | pass 46 | 47 | 48 | class Plugin: 49 | """ 50 | :ivar handle: The plugin handle from kodi 51 | :type handle: int 52 | 53 | :ivar path: The current path 54 | :type path: byte string 55 | 56 | :ivar args: The parsed query string. 57 | :type args: dict of byte strings 58 | """ 59 | 60 | def __init__(self, base_url=None): 61 | self._rules = {} # function to list of rules 62 | if sys.argv: 63 | self.path = urlsplit(sys.argv[0]).path or '/' 64 | else: 65 | self.path = '/' 66 | if len(sys.argv) > 1 and sys.argv[1].isdigit(): 67 | self.handle = int(sys.argv[1]) 68 | else: 69 | self.handle = -1 70 | self.args = {} 71 | self.base_url = base_url 72 | if self.base_url is None: 73 | self.base_url = "plugin://" + xbmcaddon.Addon().getAddonInfo('id') 74 | 75 | def route_for(self, path): 76 | """ 77 | Returns the view function for path. 78 | 79 | :type path: byte string. 80 | """ 81 | if path.startswith(self.base_url): 82 | path = path.split(self.base_url, 1)[1] 83 | 84 | for view_fun, rules in iter(list(self._rules.items())): 85 | for rule in rules: 86 | if rule.match(path) is not None: 87 | return view_fun 88 | return None 89 | 90 | def url_for(self, func, *args, **kwargs): 91 | """ 92 | Construct and returns an URL for view function with give arguments. 93 | """ 94 | if func in self._rules: 95 | for rule in self._rules[func]: 96 | path = rule.make_path(*args, **kwargs) 97 | if path is not None: 98 | return self.url_for_path(path) 99 | raise RoutingError("No known paths to '{0}' with args {1} and " 100 | "kwargs {2}".format(func.__name__, args, kwargs)) 101 | 102 | def url_for_path(self, path): 103 | """ 104 | Returns the complete URL for a path. 105 | """ 106 | path = path if path.startswith('/') else '/' + path 107 | return self.base_url + path 108 | 109 | def route(self, pattern): 110 | """ Register a route. """ 111 | def decorator(func): 112 | self.add_route(func, pattern) 113 | return func 114 | return decorator 115 | 116 | def add_route(self, func, pattern): 117 | """ Register a route. """ 118 | rule = UrlRule(pattern) 119 | if func not in self._rules: 120 | self._rules[func] = [] 121 | self._rules[func].append(rule) 122 | 123 | def run(self, argv=None): 124 | if argv is None: 125 | argv = sys.argv 126 | self.path = urlsplit(argv[0]).path 127 | self.path = self.path.rstrip('/') 128 | if len(argv) > 2: 129 | self.args = parse_qs(argv[2].lstrip('?')) 130 | self._dispatch(self.path) 131 | 132 | def redirect(self, path): 133 | self._dispatch(path) 134 | 135 | def _dispatch(self, path): 136 | for view_func, rules in iter(list(self._rules.items())): 137 | for rule in rules: 138 | kwargs = rule.match(path) 139 | if kwargs is not None: 140 | log("Dispatching to '%s', args: %s" % (view_func.__name__, kwargs)) 141 | view_func(**kwargs) 142 | return 143 | raise RoutingError('No route to path "%s"' % path) 144 | 145 | 146 | class UrlRule: 147 | 148 | def __init__(self, pattern): 149 | pattern = pattern.rstrip('/') 150 | kw_pattern = r'<(?:[^:]+:)?([A-z]+)>' 151 | self._pattern = re.sub(kw_pattern, '{\\1}', pattern) 152 | self._keywords = re.findall(kw_pattern, pattern) 153 | 154 | p = re.sub('<([A-z]+)>', '', pattern) 155 | p = re.sub('', '(?P<\\1>[^/]+?)', p) 156 | p = re.sub('', '(?P<\\1>.*)', p) 157 | self._compiled_pattern = p 158 | self._regex = re.compile('^' + p + '$') 159 | 160 | def match(self, path): 161 | """ 162 | Check if path matches this rule. Returns a dictionary of the extracted 163 | arguments if match, otherwise None. 164 | """ 165 | # match = self._regex.search(urlsplit(path).path) 166 | match = self._regex.search(path) 167 | return match.groupdict() if match else None 168 | 169 | def make_path(self, *args, **kwargs): 170 | """Construct a path from arguments.""" 171 | if args and kwargs: 172 | return None # can't use both args and kwargs 173 | if args: 174 | # Replace the named groups %s and format 175 | try: 176 | return re.sub(r'{[A-z]+}', r'%s', self._pattern) % args 177 | except TypeError: 178 | return None 179 | 180 | # We need to find the keys from kwargs that occur in our pattern. 181 | # Unknown keys are pushed to the query string. 182 | url_kwargs = dict(((k, v) for k, v in list(kwargs.items()) if k in self._keywords)) 183 | qs_kwargs = dict(((k, v) for k, v in list(kwargs.items()) if k not in self._keywords)) 184 | 185 | query = '?' + urlencode(qs_kwargs) if qs_kwargs else '' 186 | try: 187 | return self._pattern.format(**url_kwargs) + query 188 | except KeyError: 189 | return None 190 | 191 | def __str__(self): 192 | return b"Rule(pattern=%s, keywords=%s)" % (self._pattern, self._keywords) 193 | -------------------------------------------------------------------------------- /lib/tests.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2015 Thomas Amland 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 absolute_import, division, print_function, unicode_literals 19 | 20 | import pytest 21 | import mock 22 | from routing import Plugin, UrlRule, RoutingError 23 | 24 | 25 | @pytest.fixture() 26 | def plugin(): 27 | return Plugin('plugin://py.test') 28 | 29 | 30 | def test_match(): 31 | assert UrlRule("/p/").match("/p/bar") == {'foo': 'bar'} 32 | 33 | 34 | def test_make_path(): 35 | rule = UrlRule("/p//") 36 | assert rule.make_path(bar=2, foo=1) == "/p/1/2" 37 | assert rule.make_path(1, 2) == "/p/1/2" 38 | assert rule.make_path(baz=3, foo=1, bar=2) == "/p/1/2?baz=3" 39 | assert rule.make_path(1) is None 40 | 41 | 42 | def test_make_path_should_urlencode_args(): 43 | rule = UrlRule("/foo") 44 | assert rule.make_path(bar="b a&r") == "/foo?bar=b+a%26r" 45 | 46 | 47 | def test_url_for_path(): 48 | plugin = Plugin('plugin://foo.bar') 49 | assert plugin.url_for_path("/baz") == "plugin://foo.bar/baz" 50 | 51 | 52 | def test_url_for(plugin): 53 | f = lambda: None 54 | plugin.route("/foo")(f) 55 | assert plugin.url_for(f) == plugin.base_url + "/foo" 56 | 57 | 58 | def test_url_for_kwargs(plugin): 59 | f = lambda a, b: None 60 | plugin.route("/foo//")(f) 61 | assert plugin.url_for(f, a=1, b=2) == plugin.base_url + "/foo/1/2" 62 | 63 | 64 | def test_url_for_args(plugin): 65 | f = lambda a, b: None 66 | plugin.route("//")(f) 67 | assert plugin.url_for(f, 1, 2) == plugin.base_url + "/1/2" 68 | 69 | 70 | def test_route_for(plugin): 71 | f = lambda: None 72 | plugin.route("/foo")(f) 73 | assert plugin.route_for(plugin.base_url + "/foo") is f 74 | 75 | 76 | def test_route_for_args(plugin): 77 | f = lambda: None 78 | plugin.route("/foo//")(f) 79 | assert plugin.route_for(plugin.base_url + "/foo/1/2") is f 80 | 81 | 82 | def test_dispatch(plugin): 83 | f = mock.create_autospec(lambda: None) 84 | plugin.route("/foo")(f) 85 | plugin.run(['plugin://py.test/foo', '0', '?bar=baz']) 86 | f.assert_called_with() 87 | 88 | 89 | def test_path(plugin): 90 | f = mock.create_autospec(lambda: None) 91 | plugin.route("/foo")(f) 92 | plugin.run(['plugin://py.test/foo', '0']) 93 | assert plugin.path == '/foo' 94 | plugin.route("/foo/bar/baz")(f) 95 | plugin.run(['plugin://py.test/foo/bar/baz', '0']) 96 | assert plugin.path == '/foo/bar/baz' 97 | 98 | 99 | def test_no_route(plugin): 100 | f = lambda a: None 101 | plugin.route("/foo//")(f) 102 | with pytest.raises(RoutingError): 103 | plugin.url_for(f, 1) 104 | 105 | with pytest.raises(RoutingError): 106 | plugin.run([plugin.base_url + "/foo"]) 107 | 108 | assert plugin.route_for(plugin.base_url + "/foo") is None 109 | 110 | 111 | def test_arg_parsing(plugin): 112 | f = mock.create_autospec(lambda: None) 113 | plugin.route("/foo")(f) 114 | plugin.run(['plugin://py.test/foo', '0', '?bar=baz']) 115 | assert plugin.args['bar'][0] == 'baz' 116 | 117 | def test_trailing_slash_in_route_definition(plugin): 118 | """ Should call registered route with trailing slash. """ 119 | f = mock.create_autospec(lambda: None) 120 | plugin.route("/foo/")(f) 121 | plugin.run(['plugin://py.test/foo', '0']) 122 | assert f.call_count == 1 123 | 124 | def test_trailing_slashes_in_run(plugin): 125 | """ Should call registered route without trailing slash. """ 126 | f = mock.create_autospec(lambda: None) 127 | plugin.route("/foo")(f) 128 | plugin.run(['plugin://py.test/foo/', '0']) 129 | assert f.call_count == 1 130 | 131 | def test_trailing_slash_handling_for_root(plugin): 132 | f = mock.create_autospec(lambda: None) 133 | plugin.route("/")(lambda: None) 134 | plugin.route("/")(f) 135 | plugin.run(['plugin://py.test/', '0']) 136 | plugin.run(['plugin://py.test', '0']) 137 | assert f.call_count == 2 138 | with pytest.raises(RoutingError): 139 | plugin.run(['plugin://py.test/a/b', '0']) 140 | -------------------------------------------------------------------------------- /pylintrc: -------------------------------------------------------------------------------- 1 | [MESSAGES CONTROL] 2 | disable= 3 | invalid-name, 4 | missing-docstring, 5 | old-style-class, 6 | redefined-outer-name, 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | kodi-addon-checker 2 | mock 3 | pylint 4 | pytest 5 | -------------------------------------------------------------------------------- /resources/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tamland/kodi-plugin-routing/c3fb9eaa60f09504f53e11568308a8b0bbd59382/resources/icon.png -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | import os.path 5 | from xml.dom.minidom import parse 6 | from setuptools import setup 7 | 8 | project_dir = os.path.dirname(os.path.abspath(__file__)) 9 | metadata = parse(os.path.join(project_dir, 'addon.xml')) 10 | addon_version = metadata.firstChild.getAttribute('version') 11 | 12 | setup( 13 | name='routing', 14 | version=addon_version, 15 | url='https://github.com/tamland/kodi-plugin-routing', 16 | author='tamland', 17 | description='A routing module for kodi plugins', 18 | long_description=open(os.path.join(project_dir, 'README.md')).read(), 19 | keywords='Kodi, plugin, routing', 20 | license='GPL-3.0', 21 | package_dir={'': 'lib'}, 22 | py_modules=['routing'], 23 | zip_safe=False, 24 | ) 25 | --------------------------------------------------------------------------------