From 3f2d7547562542c1f27bb4b257f9e472a3963eca Mon Sep 17 00:00:00 2001 From: Collin R Date: Wed, 15 Jan 2020 11:07:13 -0800 Subject: [PATCH] Initial commit --- .gitignore | 7 + LICENSE.md | 674 ++++++++++++++++++++++++++++++++++++++++++ Pipfile | 13 + Pipfile.lock | 100 +++++++ README.md | 152 ++++++++++ REFERENCE.md | 71 +++++ pointsbot/__init__.py | 18 ++ pointsbot/__main__.py | 21 ++ pointsbot/bot.py | 160 ++++++++++ pointsbot/comment.py | 110 +++++++ pointsbot/database.py | 121 ++++++++ praw.sample.ini | 6 + tests/test_comment.py | 15 + 13 files changed, 1468 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 Pipfile create mode 100644 Pipfile.lock create mode 100644 README.md create mode 100644 REFERENCE.md create mode 100644 pointsbot/__init__.py create mode 100644 pointsbot/__main__.py create mode 100644 pointsbot/bot.py create mode 100644 pointsbot/comment.py create mode 100644 pointsbot/database.py create mode 100644 praw.sample.ini create mode 100644 tests/test_comment.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9d4375e --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +praw.ini +*.db + +*.pyc +__pycache__ + +*.swp diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000..3c92edc --- /dev/null +++ b/Pipfile @@ -0,0 +1,13 @@ +[[source]] +name = "pypi" +url = "https://pypi.org/simple" +verify_ssl = true + +[dev-packages] + +[packages] +praw = "*" +toml = "*" + +[requires] +python_version = "3.7" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..2ce9ee2 --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,100 @@ +{ + "_meta": { + "hash": { + "sha256": "c5de2f495184b77e04ef9eeabbf802ca765c0a28bc36b8e6f84da0dcac053224" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.7" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "certifi": { + "hashes": [ + "sha256:017c25db2a153ce562900032d5bc68e9f191e44e9a0f762f373977de9df1fbb3", + "sha256:25b64c7da4cd7479594d035c08c2d809eb4aab3a26e5a990ea98cc450c320f1f" + ], + "version": "==2019.11.28" + }, + "chardet": { + "hashes": [ + "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae", + "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691" + ], + "version": "==3.0.4" + }, + "idna": { + "hashes": [ + "sha256:c357b3f628cf53ae2c4c05627ecc484553142ca23264e593d327bcde5e9c3407", + "sha256:ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c" + ], + "version": "==2.8" + }, + "praw": { + "hashes": [ + "sha256:252246f8ea2ae6fba59bbf45de3fed568a80c086bca66747a2745dff5e11df4a", + "sha256:544904cb821afff43c22e2dad4245658d41135d84b3a9463a5e29dd132da6efe" + ], + "index": "pypi", + "version": "==6.5.1" + }, + "prawcore": { + "hashes": [ + "sha256:25dd14bf121bc0ad2ffc78e2322d9a01a516017105a5596cc21bb1e9a928b40c", + "sha256:ab5558efb438aa73fc66c4178bfc809194dea3ce2addf4dec873de7e2fd2824e" + ], + "version": "==1.0.1" + }, + "requests": { + "hashes": [ + "sha256:11e007a8a2aa0323f5a921e9e6a2d7e4e67d9877e85773fba9ba6419025cbeb4", + "sha256:9cf5292fcd0f598c671cfc1e0d7d1a7f13bb8085e9a590f48c010551dc6c4b31" + ], + "version": "==2.22.0" + }, + "six": { + "hashes": [ + "sha256:1f1b7d42e254082a9db6279deae68afb421ceba6158efa6131de7b3003ee93fd", + "sha256:30f610279e8b2578cab6db20741130331735c781b56053c59c4076da27f06b66" + ], + "version": "==1.13.0" + }, + "toml": { + "hashes": [ + "sha256:229f81c57791a41d65e399fc06bf0848bab550a9dfd5ed66df18ce5f05e73d5c", + "sha256:235682dd292d5899d361a811df37e04a8828a5b1da3115886b73cf81ebc9100e" + ], + "index": "pypi", + "version": "==0.10.0" + }, + "update-checker": { + "hashes": [ + "sha256:59cfad7f9a0ee99f95f1dfc60f55bf184937bcab46a7270341c2c33695572453", + "sha256:70e39446fccf77b21192cf7a8214051fa93a636dc3b5c8b602b589d100a168b8" + ], + "version": "==0.16" + }, + "urllib3": { + "hashes": [ + "sha256:a8a318824cc77d1fd4b2bec2ded92646630d7fe8619497b142c84a9e6f5a7293", + "sha256:f3c5fd51747d450d4dcf6f923c81f78f811aab8205fda64b0aba34a4e48b0745" + ], + "version": "==1.25.7" + }, + "websocket-client": { + "hashes": [ + "sha256:0fc45c961324d79c781bab301359d5a1b00b13ad1b10415a4780229ef71a5549", + "sha256:d735b91d6d1692a6a181f2a8c9e0238e5f6373356f561bb9dc4c7af36f452010" + ], + "version": "==0.57.0" + } + }, + "develop": {} +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..b44461b --- /dev/null +++ b/README.md @@ -0,0 +1,152 @@ +# PointsBot + +## Table of Contents + +* [Description](#description) +* [Installation](#installation) +* [Usage](#usage) +* [Ideas](#ideas) +* [Questions](#questions) +* [License](#license) + +## Description + +This is a bot for Reddit that monitors solutions to questions or problems in a +subreddit and awards points to the user responsible for the solution. + +This bot is based on the description in +[this request](https://www.reddit.com/r/RequestABot/comments/emdeim/expert_level_bot_coding/). +While this could be used for other subreddits, this means that it is intended +for r/MinecraftHelp. + +The bot will award a point to a redditor when the OP of a submission includes +"!Solved" somewhere in a reply to the redditor's comment on that submission. +These points will allow the redditor to advance to different levels: + +* Helper (5 points) +* Trusted Helper (15 points) +* Super Helper (40 points) + +At each level, the redditor's flair for the subreddit will be updated to reflect +their current level. However, the bot should not change a mod's flair. + +Each time a point is awarded, the bot will reply to the solution comment to +notify the redditor of their total points, with a progress bar to show how many +points they need to reach the next level and a reminder of the title of the next +level. + +The first time a point is awarded, the bot's reply comment will also include a +brief message detailing the points system. + +Only the submission OP's first "!Solved" comment should result in a point being +awarded. + +## Installation + +Requirements: + +* python3 (specifically, version 3.7 or greater) + * pip (should be installed alongside python) +* pipenv + +To install, navigate to the project root directory and run `pipenv install`. +To uninstall (i.e. delete the project's virtual environment and the installed +python packages), instead run `pipenv --rm`. + +## Usage + +The simplest way to run the bot is to navigate to the project root directory and +run: + +```bash +pipenv run python -m pointsbot +``` + +## Ideas + +### Config + +* Store all config and data in a `pointsbot` directory or similar in the user's + home or data directory (OS-dependent). +* Could do something similar to packages like PRAW: + 1. Look in current working directory first. + 2. Look in OS-dependent location next. + 3. (Maybe) Finally, could look in the directory containing the source files + (using `__file__`). +* Could also allow use of environment variables, but this seems unnecessary and + could be a little too technical (though any more technically-minded users + might appreciate the option). + +### Database + +Should it keep track of the solved posts for future reference and calculate +points on the fly, rather than just keeping track of points? If so, should have +a column denoting whether the post has been deleted, if that information is +decided to be useful when determining a user's points. + +### Determining when to award points + +Methods for awarding points, in ascending order of difficulty: + +* Could just observe and wait for !Solved in addition to automoderator doing the + same, but this will create duplicate logic between automoderator and the + bot. +* Could instruct automoderator to send modmail and then have the bot use that as + its trigger to action. +* Assuming that only mods can change flairs, could find a way to check when a + submission's flair is changed to solved, and then award the points. + +To ensure that points are only awarded for the first comment marked as a +solution: + +* Alter the database to allow for tracking of each submission and the first + comment marked as the solution. Then, everytime a new solution comment is + detected, simply check the database to see if the submission is already + counted. This will avoid unnecessary calls to Reddit, which would include + scanning all the submission comments each time. +* This approach could also make it simpler to check whether a solution comment + has been edited. Instead of having to do a daily search for edits, it could + just check the original solution comment to ensure that it still contains + the "!solved" string. If not, it can remove points from that author and + award points to the new author. + +To ensure that a point is awarded to the correct user: + +* We could expand the "!solved" bot summons to include an optional username + argument. Without the argument, the bot will award the point to either the + top-level comment or the parent comment of the "!solved" comment, whichever + is decided upon. However, if the username argument is provided, the bot + could simple check that one of the comments in the comment tree belongs to + that user, and then award them the point. + +## Questions + +* Should it really display a progress bar without a bounds, since the user could + get a large amount of points? Or should it end at 40 or whatever the max + level is? +* Should the bot reply directly to the solution comment, or the OP's "!Solved" + comment and just tag the point earner? +* Should the bot check whether comments containing "!solved" have been edited to + remove it? + - If so, it could do that daily or something. + - This will be especially important if a "recovery mode" is implemented that + crawls through the whole subreddit to rebuild the database, since the + bot would only be able to see comments that haven't been removed, or + the newest version of edited comments. +* When a "!solved" comment is found, should the bot award the point to the + author of the parent comment or the root comment? In other words, should + only top-level comments be considered for points? +* Should the bot assume that the parent comment belongs to the user who solved + the issue, or should it find the first ancestor comment not made by the OP + (in case the OP responds "!solved" to one of their own comments on the + solution comment)? +* Should the bot still keep track of points for mods, even though it doesn't + update their flair? +* Should the reply comment always tag them, even if it's not their first point? +* When a user levels up, should the reply comment also mention that they have + been awarded a new flair? + +## License + +Copyright ©2020 Collin U. Rapp. This repository is released under the GNU +GPLv3 license. diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..3bafb90 --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,71 @@ +# Reference + +A quick reference for useful API elements. + +## PRAW + +Attributes are dynamically generated by PRAW and thus are not guaranteed. + +### Redditor model + +Attributes: + +* id +* name + +Methods & properties: + +* message(subject, message, from_subreddit=None) + +### Submission model + +Attributes: + +* author +* comments +* created_utc +* id +* is_self +* name +* permalink +* selftext +* title + +Methods & properties: + +* comments +* delete() +* flair +* fullname +* mod +* reply +* shortlink + +### Comment model + +Attributes: + +* author +* body +* created_utc +* edited +* id +* is_submitter + - if author is OP of the comment's submission +* link_id + - submission id +* parent_id + - parent comment id, which is same as link_id if top-level +* submission + - Submission instance + +Methods & properties: + +* is_root() + - True if top-level comment +* parent() + - Submission if top-level, else Comment for parent comment +* reply(body) + - Reply to the comment with the body string +* submission + - Same as submission above diff --git a/pointsbot/__init__.py b/pointsbot/__init__.py new file mode 100644 index 0000000..c1a014d --- /dev/null +++ b/pointsbot/__init__.py @@ -0,0 +1,18 @@ +''' + A bot for Reddit to award points to helpful subreddit members. + Copyright (C) 2020 Collin U. Rapp + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +''' +from .bot import run diff --git a/pointsbot/__main__.py b/pointsbot/__main__.py new file mode 100644 index 0000000..1672281 --- /dev/null +++ b/pointsbot/__main__.py @@ -0,0 +1,21 @@ +''' + A bot for Reddit to award points to helpful subreddit members. + Copyright (C) 2020 Collin U. Rapp + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +''' +from . import bot + +if __name__ == '__main__': + bot.run() diff --git a/pointsbot/bot.py b/pointsbot/bot.py new file mode 100644 index 0000000..ef390fd --- /dev/null +++ b/pointsbot/bot.py @@ -0,0 +1,160 @@ +''' + A bot for Reddit to award points to helpful subreddit members. + Copyright (C) 2020 Collin U. Rapp + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +''' +import re + +import praw + +from . import comment, database + +### Globals ### + +# SUBREDDIT_NAME = 'MinecraftHelp' +SUBREDDIT_NAME = 'GlipGlorp7BotTests' +PRAW_SITE_NAME = 'testbot' + +# TODO Make LEVELS a dict instead +# TODO Could also make a Level class or namedtuple that contains more info, e.g. +# flair css or template id +LEVELS = [ + ('Helper', 5), + ('Trusted Helper', 15), + ('Super Helper', 40), +] + +### Main Function ### + + +def run(): + # Connect to Reddit + reddit = praw.Reddit(site_name=PRAW_SITE_NAME) + subreddit = reddit.subreddit(SUBREDDIT_NAME) + + # xdebugx + print(f'Connected to reddit as {reddit.user.me()}') + print(f'Read-only? {reddit.read_only}') + print(f'Watching subreddit {subreddit.title}') + print(f'Mod? {bool(subreddit.moderator(redditor=reddit.user.me()))}') + + database.init() + + # Initialize database + #if not database.exists(): + #database.create() + + # The pattern to look for in comments when determining whether to award a point + # solved_pat = re.compile('!solved', re.IGNORECASE) + solved_pat = re.compile('![Ss]olved') + + # Monitor new comments for confirmed solutions + for comm in subreddit.stream.comments(skip_existing=True): + # xdebugx + print('Found comment') + print(f'Comment text: "{comm.body}"') + + if marks_as_solved(comm, solved_pat): + # Ensure that this is the first "!solved" comment in the thread + submission = comm.submission + # Retrieve any comments hidden by "more comments" + submission.comments.replace_more(limit=0) + + # Search the flattened comments tree + is_first_solution = True + for subcomm in submission.comments.list(): + # if (subcomm.is_submitter + # and subcomm.id != comm.id + # and not subcomm.is_root + # and solved_pat.search(subcomm.body) + # and subcomm.created_utc < comm.created_utc): + if (subcomm.id != comm.id + and marks_as_solved(subcomm, solved_pat) + and subcomm.created_utc < comm.created_utc): + # There is an earlier comment for the same submission + # already marked as a solution by the OP + is_first_solution = False + break + + if not is_first_solution: + # Skip this "!solved" comment and wait for the next + # xdebugx + print('This is not the first solution') + continue + + # xdebugx + print('This is the first solution') + print_solution_info(comm) + + solution = comm.parent() + solver = solution.author + print(f'Adding point for {solver.name}') + database.add_point(solver) + points = database.get_redditor_points(solver) + print(f'Points for {solver.name}: {points}') + + # Reply to the comment containing the solution + reply_body = comment.make(solver, points, LEVELS) + print(f'Replying with: "{reply_body}"') + solution.reply(reply_body) + + # Check if (non-mod) user flair should be updated to new level + for levelname, levelpoints in LEVELS: + # If the redditor's points total is equal to one of the levels, + # that means they just reached that level + if points == levelpoints: + print('User reached new level') + if not subreddit.moderator(redditor=solver): + # TODO can also use the keyword arg css_class *or* + # flair_template_id to style the flair + print(f'Setting flair text to {levelname}') + subreddit.flair.set(solver, text=levelname) + else: + # xdebugx + print('Don\'t update flair b/c user is mod') + + # Don't need to check the rest of the levels + break + else: + # xdebugx + print('Not a "!solved" comment') + + +### Auxiliary Functions ### + + +def marks_as_solved(comment, solved_pattern): + '''Return True if not top-level comment, from OP, contains "!Solved"; False + otherwise. + ''' + #comment.refresh() + return (not comment.is_root + and comment.is_submitter + and solved_pattern.search(comment.body)) + + +### Debugging ### + + +def print_solution_info(comm): + print('Submission solved') + print('\tSolution comment:') + print(f'\t\tAuthor: {comm.parent().author.name}') + print(f'\t\tBody: {comm.parent().body}') + print('\t"Solved" comment:') + print(f'\t\tAuthor: {comm.author.name}') + print(f'\t\tBody: {comm.body}') + + diff --git a/pointsbot/comment.py b/pointsbot/comment.py new file mode 100644 index 0000000..ef8a58e --- /dev/null +++ b/pointsbot/comment.py @@ -0,0 +1,110 @@ +''' + A bot for Reddit to award points to helpful subreddit members. + Copyright (C) 2020 Collin U. Rapp + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +''' + +### Globals ### + +FILLED_SYMBOL = '\u25AE' # A small filled box character +EMPTY_SYMBOL = '\u25AF' # A same-sized empty box character +DIV_SYMBOL = '|' + +### Main Functions ### + + +def make(redditor, points, levels): + body = (first_point(redditor) + '\n\n') if points == 1 else '' + body += points_status(redditor, points, levels) + return body + + +### Auxiliary Functions ### + + +def first_point(redditor): + msg = (f'Congrats, u/{redditor.name}; you have received a point! Points ' + 'help you "level up" to the next user flair!') + return msg + + +def points_status(redditor, points, levels): + '''Levels is an iterable of (level_name, points) pairs, sorted in ascending + order by points. + ''' + for next_level_name, next_level_points in levels: + if next_level_points > points: + break + + pointstext = 'points' if points > 1 else 'point' + + if points < next_level_points: + lines = [ + f'Next level: "{next_level_name}"', + f'You have {points} {pointstext}', + f'You need {next_level_points} points', + ] + else: + lines = [ + 'MAXIMUM LEVEL ACHIEVED!!!', + f'You have {points} {pointstext}', + ] + + # 2 spaces are appended to each line to force a line break but not a + # paragraph break + # lines = [line + ' ' for line in lines] + lines = list(map(lambda line: line + ' ', lines)) + + """ + if points < next_level_points: + lines = [ + f'Next level: "{next_level_name}" ', + f'You need {next_level_points} points ', + ] + else: + lines = ['MAXIMUM LEVEL ACHIEVED!!! '] + + # TODO hacky and bad :( + lines.insert(1, f'You have {points} points ') + """ + + lines.append(progress_bar(points, levels)) + + return '\n'.join(lines) + + +def progress_bar(points, levels): + '''Assumes levels is sorted in ascending order.''' + progbar = [FILLED_SYMBOL] * points + ndx_shift = 0 + for levelndx, level in enumerate(levels): + next_level_name, next_level_points = level + if next_level_points > points: + break + ndx = next_level_points + ndx_shift + progbar.insert(ndx, DIV_SYMBOL) + ndx_shift += 1 + + if next_level_points <= points: + # If just reached max level, then an extra DIV_SYMBOL was appended + progbar.pop() + else: + # Not max level, so fill slots left until next level with EMPTY_SYMBOL + remaining = next_level_points - points + progbar.extend([EMPTY_SYMBOL] * remaining) + + return '[' + ''.join(progbar) + ']' + + diff --git a/pointsbot/database.py b/pointsbot/database.py new file mode 100644 index 0000000..7c2fddb --- /dev/null +++ b/pointsbot/database.py @@ -0,0 +1,121 @@ +''' + A bot for Reddit to award points to helpful subreddit members. + Copyright (C) 2020 Collin U. Rapp + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +''' +import functools +import os.path +import sqlite3 as sqlite + +### Globals ### + +# TODO put name/path in a config file? +DB_NAME = 'pointsbot.db' +DB_PATH = DB_NAME + +DB_SCHEMA = ''' + CREATE TABLE IF NOT EXISTS redditor_points ( + id TEXT UNIQUE NOT NULL, + name TEXT UNIQUE NOT NULL, + points INTEGER DEFAULT 0 + ) +''' + +### Decorators ### + + +def transaction(func): + @functools.wraps(func) + def newfunc(*args, **kwargs): + conn = sqlite.connect(DB_PATH) + conn.row_factory = sqlite.Row + cursor = conn.cursor() + + ret = func(cursor, *args, **kwargs) + + cursor.close() + if conn.in_transaction: + conn.commit() + conn.close() + + return ret + return newfunc + + +### Private Functions ### + +# These functions are intended for internal use, since they need to be explicity +# passed a database cursor. The public methods below are wrapped with the +# transaction decorator to remove the need for keeping a connection or cursor +# opened for the entire life of the program. + + +def _init(cursor): + if not exists(): + cursor.execute(DB_SCHEMA) + + +def _add_redditor(cursor, redditor): + insert_stmt = ''' + INSERT OR IGNORE INTO redditor_points (id, name) + VALUES (:id, :name) + ''' + cursor.execute(insert_stmt, {'id': redditor.id, 'name': redditor.name}) + return cursor.rowcount + + +def _add_point(cursor, redditor): + points = _get_redditor_points(cursor, redditor, add_if_none=True) + params = {'id': redditor.id, 'name': redditor.name, 'points': points + 1} + update_stmt = ''' + UPDATE redditor_points + SET points = :points + WHERE id = :id AND name = :name + ''' + cursor.execute(update_stmt, params) + return cursor.rowcount + + +def _get_redditor_points(cursor, redditor, add_if_none=False): + params = {'id': redditor.id, 'name': redditor.name} + select_stmt = ''' + SELECT points + FROM redditor_points + WHERE id = :id AND name = :name + ''' + cursor.execute(select_stmt, params) + row = cursor.fetchone() # TODO check if more than one row + if row: + points = row['points'] + elif add_if_none: + points = 0 + _add_redditor(cursor, redditor) + + return points + + +### Public Functions ### + + +def exists(): + return os.path.exists(DB_PATH) + + +# Public wrappers for the database access functions +init = transaction(_init) +add_redditor = transaction(_add_redditor) +add_point = transaction(_add_point) +get_redditor_points = transaction(_get_redditor_points) + diff --git a/praw.sample.ini b/praw.sample.ini new file mode 100644 index 0000000..2afc426 --- /dev/null +++ b/praw.sample.ini @@ -0,0 +1,6 @@ +[bot] +client_id=REDACTED +client_secret=REDACTED +user_agent=PointsBot (by /u/GlipGlorp7) +username=REDACTED +password=REDACTED diff --git a/tests/test_comment.py b/tests/test_comment.py new file mode 100644 index 0000000..61bf14f --- /dev/null +++ b/tests/test_comment.py @@ -0,0 +1,15 @@ +import comment + +levels = [ + ('Helper', 5), + ('Trusted Helper', 15), + ('Super Helper', 40), +] + +tests = [1, 5, 10, 15, 30, 40, 45] + +for testpoints in tests: + progbar = comment.progress_bar(testpoints, levels) + print(f'Points: {testpoints}') + print(progbar) + print()