From 89b581c6fa663d8a9db728d98e7f56c83c991444 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Tue, 11 Feb 2020 14:34:08 -0700 Subject: rework script into API::GitForge generic interface Signed-off-by: Sean Whitton --- .github/PULL_REQUEST_TEMPLATE.md | 15 + .gitignore | 1 + CONTRIBUTING | 43 +++ COPYING | 674 ++++++++++++++++++++++++++++++++++++++ Changes | 4 + DEVELOPER-CERTIFICATE | 37 +++ README | 60 ++++ bin/git-clean-forge-fork | 63 ++++ bin/git-clean-forge-repo | 74 +++++ bin/git-nuke-forge-fork | 61 ++++ dist.ini | 25 ++ lib/API/GitForge.pm | 135 ++++++++ lib/API/GitForge/GitHub.pm | 150 +++++++++ lib/API/GitForge/GitLab.pm | 130 ++++++++ lib/API/GitForge/Role/GitForge.pm | 160 +++++++++ lib/App/git/clean_forge_fork.pm | 84 +++++ lib/App/git/clean_forge_repo.pm | 78 +++++ lib/App/git/nuke_forge_fork.pm | 85 +++++ 18 files changed, 1879 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitignore create mode 100644 CONTRIBUTING create mode 100644 COPYING create mode 100644 Changes create mode 100644 DEVELOPER-CERTIFICATE create mode 100644 README create mode 100755 bin/git-clean-forge-fork create mode 100755 bin/git-clean-forge-repo create mode 100755 bin/git-nuke-forge-fork create mode 100644 dist.ini create mode 100644 lib/API/GitForge.pm create mode 100644 lib/API/GitForge/GitHub.pm create mode 100644 lib/API/GitForge/GitLab.pm create mode 100644 lib/API/GitForge/Role/GitForge.pm create mode 100644 lib/App/git/clean_forge_fork.pm create mode 100644 lib/App/git/clean_forge_repo.pm create mode 100644 lib/App/git/nuke_forge_fork.pm diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..594022f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Thank you for your interest in contributing to this project! + +Please **do not** submit a pull request on GitHub. This repository is +an automated mirror, and I don't develop using GitHub's platform. + +Instead, either + +- publish a branch somewhere (a GitHub fork is fine), and e-mail + asking me to merge your branch, possibly + using git-request-pull(1) + +- prepare patches with git-format-patch(1), and send them to + , probably using git-send-email(1) + +You may find useful. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9a4de91 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/API-GitForge-* diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..fbe48bf --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,43 @@ +Submitting patches +================== + +Thank you for your interest in contributing to this project! + +Please **do not** submit a pull request on GitHub. The repository +there is an automated mirror, and I don't develop using GitHub's +platform. + +Instead, either + +- publish a branch somewhere (a GitHub fork is fine), and e-mail + asking me to merge your branch, possibly + using git-request-pull(1) + +- prepare patches with git-format-patch(1), and send them to + , probably using git-send-email(1) + +You may find useful. + +Reporting bugs +============== + +Please use the CPAN bug tracker: + + +Please read "How to Report Bugs Effectively" to ensure your bug report +constitutes a useful contribution to the project: + + +Signing off your commits +======================== + +Contributions are accepted upstream under the terms set out in the +file ``COPYING``. You must certify the contents of the file +``DEVELOPER-CERTIFICATE`` for your contribution. To do this, append a +``Signed-off-by`` line to end of your commit message. An easy way to +add this line is to pass the ``-s`` option to git-commit(1). Here is +an example of a ``Signed-off-by`` line: + +:: + + Signed-off-by: Sean Whitton diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -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/Changes b/Changes new file mode 100644 index 0000000..a50af92 --- /dev/null +++ b/Changes @@ -0,0 +1,4 @@ +Revision history for API::GitForge + +{{$NEXT}} + - First public release. diff --git a/DEVELOPER-CERTIFICATE b/DEVELOPER-CERTIFICATE new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/DEVELOPER-CERTIFICATE @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. diff --git a/README b/README new file mode 100644 index 0000000..4519001 --- /dev/null +++ b/README @@ -0,0 +1,60 @@ +API::GitForge +------------- + +Generic interface to git forges (like GitHub, GitLab etc.) and some +scripts which make use of this interface. + +API::GitForge -- functions to create objects which do +API::GitForge::Role::GitForge + +git-clean-forge-fork -- create tidy forks for pull requests + +git-clean-forge-repo -- create repos on git forges with optional +features disabled + +git-nuke-forge-fork -- delete forks created by git-clean-forge-fork(1) + +INSTALLATION + +To install this module, run the following commands: + + % perl Makefile.PL + % make + % make test + % make install + +If you don't see Makefile.PL, it can be generated from dist.ini using +Dist::Zilla's 'dzil' program. + +SUPPORT AND DOCUMENTATION + +After installing, you can find documentation for this module and its +scripts with the perldoc & man commands. + + % perldoc API::GitForge + % man git-clean-forge-fork + +You can also look for information at: + + RT, CPAN's request tracker (please see CONTRIBUTING.rst) + http://rt.cpan.org/NoAuth/Bugs.html?Dist=API-GitForge + + MetaCPAN + https://metacpan.org/release/API-GitForge + +COPYRIGHT AND LICENCE + +Copyright (C) 2017, 2020 Sean Whitton + +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 . diff --git a/bin/git-clean-forge-fork b/bin/git-clean-forge-fork new file mode 100755 index 0000000..bcfd592 --- /dev/null +++ b/bin/git-clean-forge-fork @@ -0,0 +1,63 @@ +#!/usr/bin/perl +# PODNAME: git-clean-forge-fork +# ABSTRACT: create tidy forks for pull requests +# +# Copyright (C) 2017, 2020 Sean Whitton +# +# 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 . + +=head1 SYNOPSIS + +B [B<--upstream=>I] + +=head1 DESCRIPTION + +Creates a fork for proposing changes to a project hosted on a git +forge, like GitHub or GitLab. Also configures the fork to make it +obvious that it only exists for submitting changes, so that the fork +clutters up your git forge profile a bit less. Also adds a 'fork' +remote to which you can push your proposed changes. + +=head1 OPTIONS + +=over 4 + +=item B<--upstream=>I + +Specify the name of the upstream git remote, i.e., what you want to +fork. Defaults to "origin". + +=back + +=head1 FILES + +=over 4 + +=item $XDG_CONFIG_HOME/.config/gitforge/access_tokens/I + +Where I is the domain name of the git forge +(e.g. "github.com", "salsa.debian.org"), this file should contain an +API access token to log in to your account at the git forge. If +unset, $XDG_CONFIG_HOME defaults to ~/.config. + +=back + +=head1 SEE ALSO + +git-nuke-forge-fork(1), git-clean-forge-repo(1) + +=cut + +use App::git::clean_forge_fork; +exit App::git::clean_forge_fork->main; diff --git a/bin/git-clean-forge-repo b/bin/git-clean-forge-repo new file mode 100755 index 0000000..57afb14 --- /dev/null +++ b/bin/git-clean-forge-repo @@ -0,0 +1,74 @@ +#!/usr/bin/perl +# PODNAME: git-clean-forge-repo +# ABSTRACT: create repos on git forges with optional features disabled +# +# Copyright (C) 2017, 2020 Sean Whitton +# +# 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 . + +=head1 SYNOPSIS + +B [B<--remote=>I] + +=head1 DESCRIPTION + +Creates repos on git forges like GitHub and GitLab, and disables all +optional features of those forges. Useful for when you want to use +the forge only as an ordinary git host, and nothing more. + +=head1 OPTIONS + +=over 4 + +=item B<--remote=>I + +Specify the name of the git remote you will use to push changes to the +repository created by this script. You should already have created +this git remote; see "EXAMPLE" below. Defaults to "origin". + +=back + +=head1 EXAMPLE + +=over 4 + + % git init + % # work on new project + % git remote add origin https://salsa.debian.org/spwhitton/foo + % git clean-forge-repo + % git push -u origin master + +=back + +=head1 FILES + +=over 4 + +=item $XDG_CONFIG_HOME/.config/gitforge/access_tokens/I + +Where I is the domain name of the git forge +(e.g. "github.com", "salsa.debian.org"), this file should contain an +API access token to log in to your account at the git forge. If +unset, $XDG_CONFIG_HOME defaults to ~/.config. + +=back + +=head1 SEE ALSO + +git-clean-forge-fork(1) + +=cut + +use App::git::clean_forge_repo; +exit App::git::clean_forge_repo->main; diff --git a/bin/git-nuke-forge-fork b/bin/git-nuke-forge-fork new file mode 100755 index 0000000..7690a87 --- /dev/null +++ b/bin/git-nuke-forge-fork @@ -0,0 +1,61 @@ +#!/usr/bin/perl +# PODNAME: git-nuke-forge-fork +# ABSTRACT: delete forks created by git-clean-forge-fork(1) +# +# Copyright (C) 2020 Sean Whitton +# +# 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 . + +=head1 SYNOPSIS + +B [B<--upstream=>I] + +=head1 DESCRIPTION + +Deletes forks created by git-clean-forge-fork(1). Useful to clean up +your git forge profile after your proposed changes have been included +upstream. + +=head1 OPTIONS + +=over 4 + +=item B<--upstream=>I + +Specify the name of the upstream git remote, i.e., what you previously +forked. Defaults to "origin". + +=back + +=head1 FILES + +=over 4 + +=item $XDG_CONFIG_HOME/.config/gitforge/access_tokens/I + +Where I is the domain name of the git forge +(e.g. "github.com", "salsa.debian.org"), this file should contain an +API access token to log in to your account at the git forge. If +unset, $XDG_CONFIG_HOME defaults to ~/.config. + +=back + +=head1 SEE ALSO + +git-clean-forge-fork(1) + +=cut + +use App::git::nuke_forge_fork; +exit App::git::nuke_forge_fork->main; diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..6e418ff --- /dev/null +++ b/dist.ini @@ -0,0 +1,25 @@ +name = API-GitForge +author = Sean Whitton +license = GPL_3 +copyright_holder = Sean Whitton +copyright_year = 2017, 2020 + +[PkgVersion] +[PodWeaver] +[MetaJSON] +[NextRelease] + +[PodCoverageTests] +[PodSyntaxTests] + +[@Git] +signed = 1 + +[@Filter] +-bundle = @Basic +-remove = Readme +-remove = License + +[AutoPrereqs] +[Prereqs] +perl = 5.028 diff --git a/lib/API/GitForge.pm b/lib/API/GitForge.pm new file mode 100644 index 0000000..7c83d03 --- /dev/null +++ b/lib/API/GitForge.pm @@ -0,0 +1,135 @@ +package API::GitForge; +# ABSTRACT: generic interface to APIs of sites like GitHub, GitLab etc. +# +# Copyright (C) 2020 Sean Whitton +# +# 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 . + +=head1 SYNOPSIS + + # try to autodetect the forge type; works for GitHub and some others + my $github = API::GitForge->new_from_domain( + domain => "github.com", + access_key => "12345678" + ); + + # specify the forge type yourself by instantiating the right class + my $salsa = API::GitForge::GitLab->new( + domain => "salsa.debian.org", + access_key => "abcdef" + ); + + # generic user operations regardless of the forge type + $github->clean_fork("spwhitton/git-remote-gcrypt"); + $salsa->clean_fork("Debian/devscripts"); + +=head1 DESCRIPTION + +A I is a site like GitHub, GitLab etc. This module +provides access to some operations which one might wish to perform +against any git forge, wrapping the details of the APIs of particular +forges. An example of such an operation is forking a repository into +the user's own namespace. + +See L for details of all the currently +supported operations. Patches adding other operations, and support +for other git forges, are welcome. + +=cut + +use 5.028; +use strict; +use warnings; + +use Carp; +use Exporter "import"; +use File::Spec::Functions qw(catfile); +use Git::Wrapper; +use Cwd; +use API::GitForge::GitHub; +use API::GitForge::GitLab; + +our @EXPORT_OK = qw(new_from_domain forge_access_token remote_forge_info); + +our %known_forges = ( + "github.com" => "API::GitForge::GitHub", + "salsa.debian.org" => "API::GitForge::GitLab", +); + +=func new_from_domain domain => $domain, access_key => $key + +Instantiate an object representing the GitForge at C<$domain> which +does L. This function will only +succeed for known forges; see C<%API::GitForge::known_forges>. The +C argument is optional; if present, it should be an API +key for the forge. + + $API::GitForge::known_forges{"ourlab.com"} = "API::GitForge::GitLab"; + + my $ourlab = API::GitForge::new_from_domain( + domain => "ourlab.com", + access_key => API::GitForge::forge_access_token("ourlab.com") + ); + +=cut + +sub new_from_domain { + my %opts = @_; + croak "unknown domain" unless exists $known_forges{ $opts{domain} }; + $known_forges{ $opts{domain} }->new(%opts); +} + +=func forge_access_token $domain + +Return access token for forge at C<$domain>, assumed to be stored +under C<$ENV{XDG_CONFIG_HOME}/gitforge/access_tokens/$domain> where +the environment variable defaults to C<~/.config> if unset. + +=cut + +sub forge_access_token { + my $domain = shift; + my $root = $ENV{XDG_CONFIG_HOME} || catfile $ENV{HOME}, ".config"; + my $file = catfile $root, "gitforge", "access_tokens", $domain; + -e $file and -r _ or croak "$file does not exist or is not readable"; + open my $fh, "<", $file or die "failed to open $file for reading: $!"; + chomp(my $key = <$fh>); + $key; +} + +=func remote_forge_info($remote) + +Look at the URL for git remote C<$remote>, as returned by C, assume that this remote is a git forge, and return the +domain name of that forge and the path to the repository. + + system qw(git remote add salsa https://salsa.debian.org/spwhitton/foo); + my ($forge_domain, $forge_repo) = API::GitForge::remote_forge_info("salsa"); + + say $forge_domain; # outputs 'salsa.debian.org' + say $forge_repo; # outputs 'spwhitton/foo' + +=cut + +sub remote_forge_info { + my $remote = shift; + my $git = Git::Wrapper->new(getcwd); + my ($uri) = $git->remote("get-url", $remote); + $uri =~ m#^https?://([^:/@]+)/# + or $uri =~ m#^(?:\w+\@)?([^:/@]+):# + or croak "couldn't determine git forge info from $remote remote"; + ($1, $'); +} + +1; diff --git a/lib/API/GitForge/GitHub.pm b/lib/API/GitForge/GitHub.pm new file mode 100644 index 0000000..0bc481a --- /dev/null +++ b/lib/API/GitForge/GitHub.pm @@ -0,0 +1,150 @@ +package API::GitForge::GitHub; +# ABSTRACT: common git forge operations using the GitHub API +# +# Copyright (C) 2017, 2020 Sean Whitton +# +# 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 . + +=head1 DESCRIPTION + +See L and L for how to +use this class. + +=cut + +use 5.028; +use strict; +use warnings; + +use Role::Tiny::With; + +use Carp; +use Net::GitHub; + +with "API::GitForge::Role::GitForge"; + +sub _make_api { + my $self = shift; + my %opts; + $opts{access_token} = $self->{_access_token} + if exists $self->{_access_token}; + $self->{_api} = Net::GitHub->new(%opts); +} + +sub _ensure_fork { + my ($self, $upstream) = @_; + my ($org, $repo) = _extract_repo($upstream); + + my $repos = $self->{_api}->repos; + my $user = $self->{_api}->user->show->{login}; + my @user_repos = $repos->list_user($user); + my $repo_exists = sub { + grep { $_->{name} eq $repo } @user_repos; + }; + if (&$repo_exists) { + $self->_assert_fork_has_parent($upstream); + } else { + $repos->create_fork($org, $repo); + until (&$repo_exists) { + sleep 5; + @user_repos = $repos->list_user($user); + } + } + return "https://github.com/$user/$repo"; +} + +sub _assert_fork_has_parent { + my ($self, $upstream) = @_; + my (undef, $repo) = _extract_repo($upstream); + my $user = $self->{_api}->user->show->{login}; + my $fork = $self->{_api}->repos->get($user, $repo); + + $fork->{parent}{full_name} eq $upstream + or croak + "$user/$repo does not have parent $upstream; don't know what to do"; +} + +sub _clean_config_repo { + my ($self, $target) = @_; + my ($org, $repo) = _extract_repo($target); + my $repos = $self->{_api}->repos; + $repos->set_default_user_repo($org, $repo); + $repos->update({ + name => "$repo", + has_wiki => 0, + has_issues => 0, + has_downloads => 0, + has_pages => 0, + has_projects => 0, + }); +} + +sub _clean_config_fork { + my ($self, $upstream) = @_; + my (undef, $repo) = _extract_repo($upstream); + my $user = $self->{_api}->user->show->{login}; + + my $repos = $self->{_api}->repos; + $repos->set_default_user_repo($user, $repo); + $repos->update({ + name => "$repo", + homepage => "", + description => "Temporary fork for pull request(s)", + default_branch => "gitforge", + }); + + $self->_clean_config_repo("$user/$repo"); +} + +sub _ensure_repo { + my ($self, $target) = @_; + my ($org, $repo) = _extract_repo($target); + my $repos = $self->{_api}->repos; + my $user = $self->{_api}->user->show->{login}; + my %create_opts = (name => $repo); + my $list_method; + if ($org eq $user) { + $list_method = "list_user"; + } else { + $list_method = "list_org"; + $create_opts{org} = $org unless $org eq $user; + } + my @list_repos = $repos->$list_method($org); + my $repo_exists = sub { + grep { $_->{name} eq $repo } @list_repos; + }; + unless (&$repo_exists) { + $repos->create(\%create_opts); + until (&$repo_exists) { + sleep 5; + @list_repos = $repos->$list_method($org); + } + } + return "https://github.com/$org/$repo"; +} + +sub _nuke_fork { + my ($self, $upstream) = @_; + $self->_assert_fork_has_parent($upstream); + my (undef, $repo) = _extract_repo($upstream); + my $user = $self->{_api}->user->show->{login}; + $self->{_api}->repos->delete($user, $repo); +} + +sub _extract_repo { + $_[0] =~ m#^([^/]+)/(.+)(?:\.git)?$#; + ($1, $2); +} + +1; diff --git a/lib/API/GitForge/GitLab.pm b/lib/API/GitForge/GitLab.pm new file mode 100644 index 0000000..7ffd844 --- /dev/null +++ b/lib/API/GitForge/GitLab.pm @@ -0,0 +1,130 @@ +package API::GitForge::GitLab; +# ABSTRACT: common git forge operations using the GitLab API +# +# Copyright (C) 2020 Sean Whitton +# +# 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 . + +=head1 DESCRIPTION + +See L and L for how to +use this class. + +=cut + +use 5.028; +use strict; +use warnings; + +use Role::Tiny::With; + +use Carp; +use GitLab::API::v4; + +with "API::GitForge::Role::GitForge"; + +sub _make_api { + my $self = shift; + my %opts = (url => "https://" . $self->{_domain} . "/api/v4"); + $opts{private_token} = $self->{_access_token} + if exists $self->{_access_token}; + $self->{_api} = GitLab::API::v4->new(%opts); +} + +sub _ensure_fork { + my ($self, $upstream) = @_; + my ($path, $repo) = _extract_project_id($upstream); + + my $user = $self->{_api}->current_user->{username}; + my @user_repos; + my $update_user_repos = sub { + @user_repos + = @{ $self->{_api}->projects({ search => "$user/$repo" }) }; + }; + my $repo_exists = sub { + grep { $_->{path_with_namespace} eq "$user/$repo" } @user_repos; + }; + &$update_user_repos; + if (&$repo_exists) { + $self->_assert_fork_has_parent($upstream); + } else { + $self->{_api}->fork_project("$path/$repo"); + until (&$repo_exists) { + sleep 5; + &$update_user_repos; + } + } + return "https://" . $self->{_domain} . "/$user/$repo.git"; +} + +sub _assert_fork_has_parent { + my ($self, $upstream) = @_; + my (undef, $repo) = _extract_project_id($upstream); + my $user = $self->{_api}->current_user->{username}; + my $fork = $self->{_api}->project("$user/$repo"); + + $upstream =~ s/\.git$//; + $fork->{forked_from_project}{path_with_namespace} eq $upstream + or croak + "$user/$repo does not have parent $upstream; don't know what to do"; +} + +sub _clean_config_repo { + my ($self, $upstream) = @_; + my (undef, $repo) = _extract_project_id($upstream); + my $user = $self->{_api}->current_user->{username}; + + $self->{_api}->edit_project( + "$user/$repo", + { + issues_access_level => "disabled", + merge_requests_access_level => "disabled", + }); +} + +sub _clean_config_fork { + my ($self, $upstream) = @_; + my (undef, $repo) = _extract_project_id($upstream); + my $user = $self->{_api}->current_user->{username}; + + $self->{_api}->edit_project( + "$user/$repo", + { + default_branch => "gitforge", + description => "Temporary fork for merge request(s)", + }); + + $self->_clean_config_repo("$user/$repo"); +} + +sub _ensure_repo { + die "unimplemented"; +} + +sub _nuke_fork { + my ($self, $upstream) = @_; + $self->_assert_fork_has_parent($upstream); + my (undef, $repo) = _extract_project_id($upstream); + my $user = $self->{_api}->current_user->{username}; + $self->{_api}->delete_project("$user/$repo"); +} + +sub _extract_project_id { + my $project = shift; + $project =~ s#(?:\.git)?/?$##; + $project =~ m#/([^/]+)$#; + ($`, $1); +} + +1; diff --git a/lib/API/GitForge/Role/GitForge.pm b/lib/API/GitForge/Role/GitForge.pm new file mode 100644 index 0000000..46877ba --- /dev/null +++ b/lib/API/GitForge/Role/GitForge.pm @@ -0,0 +1,160 @@ +package API::GitForge::Role::GitForge; +# ABSTRACT: role implementing generic git forge operations +# +# Copyright (C) 2017, 2020 Sean Whitton +# +# 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 . + +=head1 DESCRIPTION + +Operations which one might wish to perform against any git forge. See +L. + +In this documentation, C should be replaced with the +domain at which your GitForge is hosted, e.g. C. + +=cut + +use 5.028; +use strict; +use warnings; + +use Role::Tiny; + +use Carp; +use File::Temp qw(tempdir); +use Git::Wrapper; +use File::Spec::Functions qw(catfile); + +=method new(domain => $domain, access_token => $token) + +Instantiate an object representing the GitForge at C<$domain>. The +C argument is optional; if present, it should be an API +key for the forge. + +=cut + +sub new { + my ($class, %opts) = @_; + croak "need domain!" unless exists $opts{domain}; + + my %attrs = (_domain => $opts{domain}); + $attrs{_access_token} = $opts{access_token} if exists $opts{access_token}; + my $self = bless \%attrs => $class; + + $self->_make_api; + + return $self; +} + +=method ensure_repo($repo) + +Create a new repo at C. + +=cut + +sub ensure_repo { shift->_create_repo(@_) } + +=method clean_repo($repo) + +Create a new repo at C and turn off +optional forge features. + +=cut + +sub clean_repo { + my ($self, $repo) = @_; + $self->_ensure_repo($repo); + $self->_clean_config_repo($repo); +} + +=method ensure_fork($upstream) + +Ensure that the current user has a fork of the repo at +C, and return URI to that fork suitable +for adding as a git remote. + +=cut + +sub ensure_fork { shift->_ensure_fork(@_) } + +=method clean_fork($upstream) + +Ensure that the current user has a fork of the repo at +C, config that fork to make it obvious +it's only there for submitting change proposals, and return URI to +fork suitable for adding as a git remote. + +=cut + +sub clean_fork { + my $self = shift; + my $fork_uri = $self->_ensure_fork(@_); + + my $temp = tempdir CLEANUP => 1; + my $git = Git::Wrapper->new($temp); + $git->init; + $git->remote(qw(add fork), $fork_uri); + my @fork_branches + = map { m#refs/heads/#; $' } $git->ls_remote(qw(--heads fork)); + return $fork_uri if grep /\Agitforge\z/, @fork_branches; + + open my $fh, ">", catfile $temp, "README.md"; + say $fh "This repository exists only in order to submit pull request(s)."; + close $fh; + $git->add("README.md"); + $git->commit({ message => "Temporary fork for pull request(s)" }); + $git->RUN("push", $fork_uri, "master:gitforge"); + $self->_clean_config_fork(@_); + + # assume that if we had to create the gitforge branch, we just + # created the fork, so can go ahead and nuke all branches there. + # may fail if some branches are protected; that's okay. + eval { $git->push($fork_uri, "--delete", @fork_branches) }; + + return $fork_uri; +} + +=method nuke_fork($upstream) + +Delete the user's fork of the repo at +C. + +=cut + +sub nuke_fork { shift->_nuke_fork(@_) } + +=method clean_config_repo($repo) + +Turn off optional forge features for repo at +C. + +=cut + +sub clean_config_repo { shift->_clean_config_repo(@_) } + +=method clean_config_fork($upstream) + +Configure user's fork of repo at C to +make it obvious that it's only there for submitting change proposals. + +=cut + +sub clean_config_fork { shift->_clean_config_fork(@_) } + +requires + qw<_make_api _ensure_repo _clean_config_repo _clean_config_fork + _ensure_fork _nuke_fork>; + +1; diff --git a/lib/App/git/clean_forge_fork.pm b/lib/App/git/clean_forge_fork.pm new file mode 100644 index 0000000..bffcbab --- /dev/null +++ b/lib/App/git/clean_forge_fork.pm @@ -0,0 +1,84 @@ +package App::git::clean_forge_fork; +# ABSTRACT: create tidy forks for pull requests +# +# Copyright (C) 2017, 2020 Sean Whitton +# +# 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 . + +use 5.028; +use strict; +use warnings; + +use subs 'main'; +use Term::UI; +use Getopt::Long; +use Git::Wrapper; +use API::GitForge qw(new_from_domain forge_access_token remote_forge_info); +use Try::Tiny; +use Cwd; + +my $exit_main = 0; + +CORE::exit main unless caller; + +=func main + +Implementation of git-clean-forge-fork(1). Please see documentation +for that command. + +Normally takes no arguments and responds to C<@ARGV>. If you want to +override that you can pass an arrayref of arguments, and those will be +used instead of the contents of C<@ARGV>. + +=cut + +sub main { + shift if $_[0] and ref $_[0] eq ""; + local @ARGV = @{ $_[0] } if $_[0] and ref $_[0] ne ""; + + my $term = Term::ReadLine->new("brand"); + my $upstream = "origin"; + my $git = Git::Wrapper->new(getcwd); + #<<< + try { + $git->rev_parse({ git_dir => 1 }); + } catch { + die "pwd doesn't look like a git repository ..\n"; + }; + #>>> + GetOptions "upstream=s" => \$upstream; + + my ($forge_domain, $upstream_repo) = remote_forge_info $upstream; + exit + unless $term->ask_yn( + prompt => "Do you want to submit changes against $upstream_repo?"); + + my $forge = new_from_domain + domain => $forge_domain, + access_token => forge_access_token $forge_domain; + my $fork_uri = $forge->clean_fork($upstream_repo); + if (grep /\Afork\z/, $git->remote) { + $fork_uri eq ($git->remote(qw(get-url fork)))[0] + or die "fork remote exists but has wrong URI\n"; + } else { + $git->remote(qw(add fork), $fork_uri); + } + + EXIT_MAIN: + return $exit_main; +} + +sub exit { $exit_main = shift // 0; goto EXIT_MAIN } + +1; diff --git a/lib/App/git/clean_forge_repo.pm b/lib/App/git/clean_forge_repo.pm new file mode 100644 index 0000000..6ecb790 --- /dev/null +++ b/lib/App/git/clean_forge_repo.pm @@ -0,0 +1,78 @@ +package App::git::clean_forge_repo; +# ABSTRACT: create repos on git forges with optional features disabled +# +# Copyright (C) 2020 Sean Whitton +# +# 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 . + +use 5.028; +use strict; +use warnings; + +use subs 'main'; +use Cwd; +use Term::UI; +use Getopt::Long; +use Git::Wrapper; +use API::GitForge qw(new_from_domain forge_access_token remote_forge_info); +use Try::Tiny; + +my $exit_main = 0; + +CORE::exit main unless caller; + +=func main + +Implementation of git-clean-forge-repo(1). Please see documentation +for that command. + +Normally takes no arguments and responds to C<@ARGV>. If you want to +override that you can pass an arrayref of arguments, and those will be +used instead of the contents of C<@ARGV>. + +=cut + +sub main { + shift if $_[0] and ref $_[0] eq ""; + local @ARGV = @{ $_[0] } if $_[0] and ref $_[0] ne ""; + + my $term = Term::ReadLine->new("brand"); + my $remote = "origin"; + my $git = Git::Wrapper->new(getcwd); + #<<< + try { + $git->rev_parse({ git_dir => 1 }); + } catch { + die "pwd doesn't look like a git repository ..\n"; + }; + #>>> + GetOptions "remote=s" => \$remote; + + my ($forge_domain, $forge_repo) = remote_forge_info $remote; + exit + unless $term->ask_yn( + prompt => "Do you want to create repo $forge_repo?"); + + my $forge = new_from_domain + domain => $forge_domain, + access_token => forge_access_token $forge_domain; + $forge->clean_repo($forge_repo); + + EXIT_MAIN: + return $exit_main; +} + +sub exit { $exit_main = shift // 0; goto EXIT_MAIN } + +1; diff --git a/lib/App/git/nuke_forge_fork.pm b/lib/App/git/nuke_forge_fork.pm new file mode 100644 index 0000000..6e6997a --- /dev/null +++ b/lib/App/git/nuke_forge_fork.pm @@ -0,0 +1,85 @@ +package App::git::nuke_forge_fork; +# ABSTRACT: delete forks created by git-clean-forge-fork(1) +# +# Copyright (C) 2020 Sean Whitton +# +# 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 . + +use 5.028; +use strict; +use warnings; + +use subs 'main'; +use Getopt::Long; +use Git::Wrapper; +use API::GitForge qw(new_from_domain forge_access_token remote_forge_info); +use Try::Tiny; +use Cwd; +use Term::UI; + +my $exit_main = 0; + +CORE::exit main unless caller; + +=func main + +Implementation of git-nuke-forge-fork(1). Please see documentation +for that command. + +Normally takes no arguments and responds to C<@ARGV>. If you want to +override that you can pass an arrayref of arguments, and those will be +used instead of the contents of C<@ARGV>. + +=cut + +sub main { + shift if $_[0] and ref $_[0] eq ""; + local @ARGV = @{ $_[0] } if $_[0] and ref $_[0] ne ""; + + my $term = Term::ReadLine->new("brand"); + my $upstream = "origin"; + my $git = Git::Wrapper->new(getcwd); + #<<< + try { + $git->rev_parse({ git_dir => 1 }); + } catch { + die "pwd doesn't look like a git repository ..\n"; + }; + #>>> + GetOptions "upstream=s" => \$upstream; + + my @fork_branches + = grep !/\Agitforge\z/, + map { m#refs/heads/#; $' } $git->ls_remote(qw(--heads fork)); + if (@fork_branches) { + say "Would delete the following branches:"; + say " $_" for @fork_branches; + print "\n"; + exit unless $term->ask_yn(prompt => "Are you sure?"); + } + + my ($forge_domain, $upstream_repo) = remote_forge_info $upstream ; + my $forge = new_from_domain + domain => $forge_domain, + access_token => forge_access_token $forge_domain; + $forge->nuke_fork($upstream_repo); + $git->remote(qw(rm fork)); + + EXIT_MAIN: + return $exit_main; +} + +sub exit { $exit_main = shift // 0; goto EXIT_MAIN } + +1; -- cgit v1.2.3