Initial commit.
This is enough code to start using the tool to debug itself, so it's time to start committing individual bugfixes.
This commit is contained in:
commit
2ff353bebb
16 changed files with 2157 additions and 0 deletions
8
.gitignore
vendored
Normal file
8
.gitignore
vendored
Normal file
|
@ -0,0 +1,8 @@
|
|||
build/
|
||||
.cache/
|
||||
*.egg
|
||||
*.egg-info/
|
||||
.eggs
|
||||
.mypy_cache/
|
||||
.tox/
|
||||
__pycache__/
|
661
LICENSE.txt
Normal file
661
LICENSE.txt
Normal file
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
22
paypal_rest/__init__.py
Normal file
22
paypal_rest/__init__.py
Normal file
|
@ -0,0 +1,22 @@
|
|||
"""__init__.py - paypal_rest module initialization"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
from .client import (
|
||||
PayPalAPIClient,
|
||||
PayPalSite,
|
||||
SubscriptionFields,
|
||||
TransactionFields,
|
||||
)
|
265
paypal_rest/client.py
Normal file
265
paypal_rest/client.py
Normal file
|
@ -0,0 +1,265 @@
|
|||
"""client.py - PayPal API client class"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import collections
|
||||
import datetime
|
||||
import enum
|
||||
import functools
|
||||
import logging
|
||||
import math
|
||||
import urllib.parse as urlparse
|
||||
|
||||
import requests
|
||||
import requests_oauthlib # type:ignore[import]
|
||||
from oauthlib import oauth2 # type:ignore[import]
|
||||
|
||||
from typing import (
|
||||
Any,
|
||||
Iterator,
|
||||
Mapping,
|
||||
Optional,
|
||||
Sequence,
|
||||
Type,
|
||||
TypeVar,
|
||||
Union,
|
||||
)
|
||||
from .paypal_types import (
|
||||
APIResponse,
|
||||
)
|
||||
from .transaction import Transaction
|
||||
|
||||
FieldsType = TypeVar('FieldsType', bound='PayPalFields')
|
||||
Params = Mapping[str, str]
|
||||
|
||||
class PayPalSite(enum.Enum):
|
||||
SANDBOX = 'api-m.sandbox.paypal.com'
|
||||
LIVE = 'api-m.paypal.com'
|
||||
|
||||
def url(self) -> str:
|
||||
return f'https://{self.value}'
|
||||
|
||||
|
||||
class PayPalFields(enum.Flag):
|
||||
@classmethod
|
||||
def choices(cls) -> Iterator[str]:
|
||||
for flag in cls:
|
||||
yield flag.name.lower()
|
||||
|
||||
@classmethod
|
||||
def combine(cls: Type[FieldsType], fields: Optional[Sequence[FieldsType]]=None) -> FieldsType:
|
||||
if fields:
|
||||
fields_iter = iter(fields)
|
||||
else:
|
||||
fields_iter = iter(cls)
|
||||
retval = next(fields_iter)
|
||||
for field in fields_iter:
|
||||
retval |= field
|
||||
return retval
|
||||
|
||||
@classmethod
|
||||
def from_arg(cls: Type[FieldsType], arg: str) -> FieldsType:
|
||||
try:
|
||||
return cls[arg.upper()]
|
||||
except KeyError:
|
||||
raise ValueError(f"unknown {cls.__name__} {arg!r}") from None
|
||||
|
||||
def is_base_field(self) -> bool:
|
||||
return not math.log2(self.value) % 1
|
||||
|
||||
def _base_value(self) -> str:
|
||||
return self.name.lower()
|
||||
|
||||
def param_value(self) -> str:
|
||||
return ','.join(
|
||||
flag._base_value()
|
||||
for flag in type(self)
|
||||
if flag & self and flag.is_base_field()
|
||||
)
|
||||
|
||||
|
||||
class SubscriptionFields(PayPalFields):
|
||||
LAST_FAILED_PAYMENT = enum.auto()
|
||||
PLAN = enum.auto()
|
||||
ALL = LAST_FAILED_PAYMENT | PLAN
|
||||
|
||||
|
||||
class TransactionFields(PayPalFields):
|
||||
TRANSACTION = enum.auto()
|
||||
PAYER = enum.auto()
|
||||
SHIPPING = enum.auto()
|
||||
AUCTION = enum.auto()
|
||||
CART = enum.auto()
|
||||
INCENTIVE = enum.auto()
|
||||
STORE = enum.auto()
|
||||
ALL = TRANSACTION | PAYER | SHIPPING | AUCTION | CART | INCENTIVE | STORE
|
||||
|
||||
def _base_value(self) -> str:
|
||||
return f'{self.name.lower()}_info'
|
||||
|
||||
|
||||
class PayPalSession(requests_oauthlib.OAuth2Session):
|
||||
TOKEN_PATH = '/v1/oauth2/token'
|
||||
|
||||
def __init__(self, client: oauth2.Client, client_secret: str) -> None:
|
||||
super().__init__(client=client)
|
||||
self._client_secret = client_secret
|
||||
|
||||
def request(self, method: str, url: str, **kwargs: Any) -> requests.Response:
|
||||
response = super().request(method, url, **kwargs)
|
||||
if response.status_code == requests.codes.UNAUTHORIZED:
|
||||
self.fetch_token(
|
||||
token_url=urlparse.urljoin(url, self.TOKEN_PATH),
|
||||
client_id=self._client.client_id,
|
||||
client_secret=self._client_secret,
|
||||
)
|
||||
response = super().request(method, url, **kwargs)
|
||||
return response
|
||||
|
||||
|
||||
class PayPalAPIClient:
|
||||
def __init__(
|
||||
self,
|
||||
session: requests.Session,
|
||||
root_url: Union[str, PayPalSite]=PayPalSite.SANDBOX,
|
||||
logger: Optional[logging.Logger]=None,
|
||||
) -> None:
|
||||
self._session = session
|
||||
if isinstance(root_url, str):
|
||||
self._root_url = root_url
|
||||
else:
|
||||
self._root_url = root_url.url()
|
||||
if logger is None:
|
||||
host_parts = urlparse.urlsplit(self._root_url).netloc.split('.')
|
||||
host_parts.reverse()
|
||||
logger_name = f'paypal_rest.PayPalAPIClient.{".".join(host_parts)}'
|
||||
logger = logging.getLogger(logger_name)
|
||||
self.logger = logger
|
||||
|
||||
@classmethod
|
||||
def from_client_secret(
|
||||
cls,
|
||||
client_id: str,
|
||||
client_secret: str,
|
||||
root_url: Union[str, PayPalSite]=PayPalSite.SANDBOX,
|
||||
logger: Optional[logging.Logger]=None,
|
||||
) -> 'PayPalAPIClient':
|
||||
client = oauth2.BackendApplicationClient(client_id=client_id)
|
||||
session = PayPalSession(client, client_secret)
|
||||
return cls(session, root_url, logger)
|
||||
|
||||
@classmethod
|
||||
def from_config(
|
||||
cls,
|
||||
config: Mapping[str, str],
|
||||
default_url: Union[str, PayPalSite]=PayPalSite.SANDBOX,
|
||||
logger: Optional[logging.Logger]=None,
|
||||
) -> 'PayPalAPIClient':
|
||||
try:
|
||||
client_id = config['client_id']
|
||||
client_secret = config['client_secret']
|
||||
except KeyError as error:
|
||||
raise ValueError(f"configuration missing {error.args[0]!r}") from None
|
||||
try:
|
||||
root_url: Union[str, PayPalSite] = config['site']
|
||||
except KeyError:
|
||||
root_url = default_url
|
||||
else:
|
||||
try:
|
||||
# In this case, we know root_url must be a str because we got
|
||||
# it from the Mapping, but mypy doesn't track that.
|
||||
root_url = PayPalSite[root_url.upper()] # type:ignore[union-attr]
|
||||
except KeyError:
|
||||
pass
|
||||
return cls.from_client_secret(client_id, client_secret, root_url, logger)
|
||||
|
||||
def _get_json(self, path: str, params: Optional[Params]=None) -> APIResponse:
|
||||
url = urlparse.urljoin(self._root_url, path)
|
||||
response = self._session.get(url, params=params)
|
||||
try:
|
||||
response.raise_for_status()
|
||||
except requests.HTTPError:
|
||||
self._log_error(response.json())
|
||||
raise
|
||||
else:
|
||||
return response.json()
|
||||
|
||||
def _iter_pages(self, path: str, params: Params) -> Iterator[APIResponse]:
|
||||
response: APIResponse = {'page': 0, 'total_pages': 1}
|
||||
page_params = collections.ChainMap(params).new_child()
|
||||
while response['page'] < response['total_pages']:
|
||||
page_params['page'] = str(response['page'] + 1)
|
||||
response = self._get_json(path, page_params)
|
||||
yield response
|
||||
|
||||
def _log_error(self, error: APIResponse) -> None:
|
||||
parts = [
|
||||
'{name}: {message}'.format_map(error),
|
||||
*('{issue} (in {location})'.format_map(detail)
|
||||
for detail in error.get('details', ())),
|
||||
]
|
||||
self.logger.error(" — ".join(parts))
|
||||
|
||||
def get_subscription(
|
||||
self,
|
||||
subscription_id: str,
|
||||
fields: SubscriptionFields=SubscriptionFields.ALL,
|
||||
) -> APIResponse:
|
||||
return self._get_json(f'/v1/billing/subscriptions/{subscription_id}', {
|
||||
'fields': fields.param_value(),
|
||||
})
|
||||
|
||||
def get_transaction(
|
||||
self,
|
||||
transaction_id: str,
|
||||
end_date: Optional[datetime.datetime]=None,
|
||||
start_date: Optional[datetime.datetime]=None,
|
||||
fields: TransactionFields=TransactionFields.TRANSACTION,
|
||||
) -> APIResponse:
|
||||
now = datetime.datetime.now(datetime.timezone.utc)
|
||||
if end_date is None:
|
||||
end_date = now
|
||||
if start_date is None:
|
||||
# The API only goes back three years
|
||||
start_date = now - datetime.timedelta(days=365 * 3)
|
||||
date_diff = datetime.timedelta(days=30)
|
||||
response: APIResponse = {'transaction_details': None}
|
||||
while end_date > start_date and not response['transaction_details']:
|
||||
search_start = max(end_date - date_diff, start_date)
|
||||
response = self._get_json('/v1/reporting/transactions', {
|
||||
'transaction_id': transaction_id,
|
||||
'fields': fields.param_value(),
|
||||
'start_date': search_start.isoformat(timespec='seconds'),
|
||||
'end_date': end_date.isoformat(timespec='seconds'),
|
||||
})
|
||||
end_date = search_start
|
||||
if response['transaction_details']:
|
||||
return Transaction(response['transaction_details'][0])
|
||||
else:
|
||||
raise ValueError(f"transaction {transaction_id!r} not found")
|
||||
|
||||
def iter_transactions(
|
||||
self,
|
||||
start_date: datetime.datetime,
|
||||
end_date: datetime.datetime,
|
||||
fields: TransactionFields=TransactionFields.TRANSACTION,
|
||||
) -> Iterator[Transaction]:
|
||||
for page in self._iter_pages('/v1/reporting/transactions', {
|
||||
'fields': fields.param_value(),
|
||||
'start_date': start_date.isoformat(timespec='seconds'),
|
||||
'end_date': end_date.isoformat(timespec='seconds'),
|
||||
}):
|
||||
for txn_source in page['transaction_details']:
|
||||
yield Transaction(txn_source)
|
197
paypal_rest/cliquery.py
Executable file
197
paypal_rest/cliquery.py
Executable file
|
@ -0,0 +1,197 @@
|
|||
#!/usr/bin/env python3
|
||||
"""cliquery.py - Command line tool to query PayPal transactions and subscriptions"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import argparse
|
||||
import collections
|
||||
import datetime
|
||||
import logging
|
||||
import sys
|
||||
|
||||
from pathlib import Path
|
||||
import yaml
|
||||
|
||||
from . import client as clientmod
|
||||
from . import cliutil
|
||||
from . import config as configmod
|
||||
from . import paypal_types
|
||||
from .transaction import CartItem, Transaction
|
||||
|
||||
from typing import (
|
||||
Optional,
|
||||
Sequence,
|
||||
TextIO,
|
||||
Type,
|
||||
)
|
||||
|
||||
PROGNAME = 'paypal-query'
|
||||
|
||||
logger = logging.getLogger('paypal_rest.cliquery')
|
||||
|
||||
class YAMLDumper(yaml.SafeDumper):
|
||||
TRANSACTION_FIELD_ORDER = [
|
||||
clientmod.TransactionFields.SHIPPING,
|
||||
clientmod.TransactionFields.PAYER,
|
||||
clientmod.TransactionFields.TRANSACTION,
|
||||
clientmod.TransactionFields.CART,
|
||||
clientmod.TransactionFields.STORE,
|
||||
clientmod.TransactionFields.AUCTION,
|
||||
clientmod.TransactionFields.INCENTIVE,
|
||||
]
|
||||
|
||||
@classmethod
|
||||
def add_transaction_representer(cls, fields: clientmod.TransactionFields) -> None:
|
||||
txn_key_order = [
|
||||
f'{flag.name.lower()}_info'
|
||||
for flag in cls.TRANSACTION_FIELD_ORDER
|
||||
if flag & fields
|
||||
]
|
||||
def transaction_representer(self: 'YAMLDumper', data: Transaction) -> yaml.nodes.MappingNode:
|
||||
return self.represent_dict((key, data[key]) for key in txn_key_order)
|
||||
cls.add_representer(Transaction, transaction_representer)
|
||||
|
||||
|
||||
def add_fields_argument(
|
||||
parser: argparse.ArgumentParser,
|
||||
field_type: Type[clientmod.PayPalFields],
|
||||
*short_flags: str,
|
||||
) -> argparse.Action:
|
||||
type_name = field_type.__name__[:-6].lower()
|
||||
return parser.add_argument(
|
||||
f'--{type_name}-fields', *short_flags,
|
||||
action='append',
|
||||
metavar='FIELD',
|
||||
type=field_type.from_arg,
|
||||
help=f"Only show these field(s) in {type_name} results."
|
||||
" You can specify this option multiple times."
|
||||
f" Choices are {', '.join(field_type.choices())}."
|
||||
)
|
||||
|
||||
def parse_arguments(arglist: Optional[Sequence[str]]=None) -> argparse.Namespace:
|
||||
parser = argparse.ArgumentParser(prog=PROGNAME)
|
||||
cliutil.add_version_argument(parser)
|
||||
parser.add_argument(
|
||||
'--config-file', '-C',
|
||||
type=Path,
|
||||
metavar='PATH',
|
||||
help="""Read client configuration from this INI file
|
||||
""")
|
||||
parser.add_argument(
|
||||
'--config-section', '-c',
|
||||
default='query',
|
||||
help="""Read client configuration from this section of the config file
|
||||
""")
|
||||
parser.add_argument(
|
||||
'--begin', '--start', '-b',
|
||||
dest='start_date',
|
||||
metavar='DATETIME',
|
||||
type=paypal_types.parse_datetime,
|
||||
help="""Datetime to begin the search, in ISO 8601 format
|
||||
""")
|
||||
parser.add_argument(
|
||||
'--end', '--stop', '-e',
|
||||
dest='end_date',
|
||||
metavar='DATETIME',
|
||||
type=paypal_types.parse_datetime,
|
||||
help="""Datetime to end the search, in ISO 8601 format
|
||||
""")
|
||||
add_fields_argument(parser, clientmod.TransactionFields, '--txn-fields', '-T')
|
||||
add_fields_argument(parser, clientmod.SubscriptionFields, '--sub-fields', '-S')
|
||||
parser.add_argument(
|
||||
'paypal_ids',
|
||||
metavar='ID',
|
||||
nargs='*',
|
||||
help="""ID of PayPal object(s) to look up and return. If no IDs are
|
||||
specified, lists all transactions in your specified date range (default last
|
||||
24 hours).
|
||||
""")
|
||||
cliutil.add_loglevel_argument(parser)
|
||||
args = parser.parse_args(arglist)
|
||||
args.transaction_fields = clientmod.TransactionFields.combine(args.transaction_fields)
|
||||
args.subscription_fields = clientmod.SubscriptionFields.combine(args.subscription_fields)
|
||||
if args.end_date is None:
|
||||
args.end_date = datetime.datetime.now(datetime.timezone.utc)
|
||||
return args
|
||||
|
||||
def summarize_transaction(txn: Transaction, stream: TextIO) -> None:
|
||||
date_s = txn.updated_date().astimezone(datetime.timezone.utc).strftime('%Y-%m-%d %H:%M')
|
||||
status = txn.status().value
|
||||
try:
|
||||
from_s = f"\t{txn.payer_fullname()} ({txn.payer_email()})"
|
||||
except KeyError:
|
||||
from_s = ""
|
||||
print(f"{date_s}\t{txn.transaction_id()}\t{status}{from_s}", file=stream)
|
||||
cart = list(txn.cart_items())
|
||||
if not cart:
|
||||
txn_name = txn['transaction_info'].get('transaction_subject', "Gross Amount")
|
||||
txn_amt = txn.amount()
|
||||
cart.append(CartItem(None, txn_name, None, 1, txn_amt, txn_amt))
|
||||
fee_amt = txn.fee_amount()
|
||||
cart.append(CartItem(None, "PayPal Fee", None, 1, fee_amt, fee_amt))
|
||||
names = [
|
||||
item.name or item.description or item.code or "Unknown Item"
|
||||
for item in cart
|
||||
]
|
||||
amounts = [str(item.total_price) for item in cart]
|
||||
name_len = max(len(name) for name in names)
|
||||
amt_len = max(len(amt_s) for amt_s in amounts)
|
||||
line_fmt = f' {{:>{name_len}}} │ {{:>{amt_len}}}{{}}'
|
||||
for item, name, amt_s in zip(cart, names, amounts):
|
||||
if item.quantity != 1:
|
||||
unit_s = f" ({item.quantity:,g} @ {item.unit_price})"
|
||||
else:
|
||||
unit_s = ""
|
||||
print(line_fmt.format(name, amt_s, unit_s), file=stream)
|
||||
|
||||
def main(
|
||||
arglist: Optional[Sequence[str]]=None,
|
||||
stdout: TextIO=sys.stdout,
|
||||
stderr: TextIO=sys.stderr,
|
||||
) -> int:
|
||||
args = parse_arguments(arglist)
|
||||
cliutil.set_loglevel(logger, args.loglevel)
|
||||
|
||||
config = configmod.load_config(args.config_file)
|
||||
if args.config_section not in config:
|
||||
config.add_section(args.config_section)
|
||||
paypal = clientmod.PayPalAPIClient.from_config(config[args.config_section])
|
||||
|
||||
if not args.paypal_ids:
|
||||
if args.start_date is None:
|
||||
args.start_date = args.end_date - datetime.timedelta(hours=24)
|
||||
args.transaction_fields |= clientmod.TransactionFields.TRANSACTION
|
||||
for txn in paypal.iter_transactions(
|
||||
args.start_date, args.end_date, args.transaction_fields,
|
||||
):
|
||||
summarize_transaction(txn, stdout)
|
||||
else:
|
||||
YAMLDumper.add_transaction_representer(args.transaction_fields)
|
||||
for paypal_id in args.paypal_ids:
|
||||
paypal_id = paypal_id.upper()
|
||||
paypal_obj: paypal_types.APIResponse
|
||||
if paypal_id.startswith('I-'):
|
||||
paypal_obj = paypal.get_subscription(paypal_id, fields=args.subscription_fields)
|
||||
else:
|
||||
paypal_obj = paypal.get_transaction(
|
||||
paypal_id, args.end_date, args.start_date, args.transaction_fields,
|
||||
)
|
||||
yaml.dump(paypal_obj, stdout, Dumper=YAMLDumper)
|
||||
return 0
|
||||
|
||||
entry_point = cliutil.make_entry_point(__name__, PROGNAME)
|
||||
|
||||
if __name__ == '__main__':
|
||||
exit(entry_point())
|
199
paypal_rest/cliutil.py
Normal file
199
paypal_rest/cliutil.py
Normal file
|
@ -0,0 +1,199 @@
|
|||
"""cliutil - Utilities for CLI tools"""
|
||||
PKGNAME = 'paypal_rest'
|
||||
LICENSE = """
|
||||
Copyright © 2020 Brett Smith
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>."""
|
||||
|
||||
import argparse
|
||||
import enum
|
||||
import logging
|
||||
import operator
|
||||
import os
|
||||
import pkg_resources
|
||||
import signal
|
||||
import sys
|
||||
import traceback
|
||||
import types
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import requests
|
||||
|
||||
from typing import (
|
||||
Any,
|
||||
Callable,
|
||||
Iterator,
|
||||
NoReturn,
|
||||
Optional,
|
||||
Sequence,
|
||||
TextIO,
|
||||
Type,
|
||||
Union,
|
||||
)
|
||||
|
||||
VERSION = pkg_resources.require(PKGNAME)[0].version
|
||||
|
||||
class ExceptHook:
|
||||
def __init__(self, logger: Optional[logging.Logger]=None) -> None:
|
||||
if logger is None:
|
||||
logger = logging.getLogger()
|
||||
self.logger = logger
|
||||
|
||||
def __call__(self,
|
||||
exc_type: Type[BaseException],
|
||||
exc_value: BaseException,
|
||||
exc_tb: types.TracebackType,
|
||||
) -> NoReturn:
|
||||
error_type = type(exc_value).__name__
|
||||
msg = ": ".join(str(arg) for arg in exc_value.args)
|
||||
if isinstance(exc_value, KeyboardInterrupt):
|
||||
signal.signal(signal.SIGINT, signal.SIG_DFL)
|
||||
os.kill(0, signal.SIGINT)
|
||||
signal.pause()
|
||||
elif isinstance(exc_value, requests.HTTPError):
|
||||
error_type = "PayPal API error"
|
||||
if exc_value.response is None:
|
||||
status_code = 500
|
||||
else:
|
||||
status_code = exc_value.response.status_code
|
||||
if (status_code == requests.codes.UNAUTHORIZED
|
||||
or status_code == requests.codes.FORBIDDEN):
|
||||
exitcode = os.EX_NOPERM
|
||||
elif status_code < 500:
|
||||
exitcode = os.EX_SOFTWARE
|
||||
else:
|
||||
exitcode = os.EX_UNAVAILABLE
|
||||
elif isinstance(exc_value, OSError):
|
||||
if exc_value.filename is None:
|
||||
exitcode = os.EX_OSERR
|
||||
error_type = "OS error"
|
||||
msg = exc_value.strerror
|
||||
else:
|
||||
# There are more specific exit codes for input problems vs.
|
||||
# output problems, but without knowing how the file was
|
||||
# intended to be used, we can't use them.
|
||||
exitcode = os.EX_IOERR
|
||||
error_type = "I/O error"
|
||||
msg = f"{exc_value.filename}: {exc_value.strerror}"
|
||||
else:
|
||||
exitcode = os.EX_SOFTWARE
|
||||
error_type = f"internal {error_type}"
|
||||
self.logger.critical("%s%s%s", error_type, ": " if msg else "", msg)
|
||||
self.logger.debug(
|
||||
''.join(traceback.format_exception(exc_type, exc_value, exc_tb)),
|
||||
)
|
||||
raise SystemExit(exitcode)
|
||||
|
||||
|
||||
class InfoAction(argparse.Action):
|
||||
def __call__(self,
|
||||
parser: argparse.ArgumentParser,
|
||||
namespace: argparse.Namespace,
|
||||
values: Union[Sequence[Any], str, None]=None,
|
||||
option_string: Optional[str]=None,
|
||||
) -> NoReturn:
|
||||
if isinstance(self.const, str):
|
||||
info = self.const
|
||||
exitcode = 0
|
||||
else:
|
||||
info, exitcode = self.const
|
||||
print(info)
|
||||
raise SystemExit(exitcode)
|
||||
|
||||
|
||||
class LogLevel(enum.IntEnum):
|
||||
DEBUG = logging.DEBUG
|
||||
INFO = logging.INFO
|
||||
WARNING = logging.WARNING
|
||||
ERROR = logging.ERROR
|
||||
CRITICAL = logging.CRITICAL
|
||||
WARN = WARNING
|
||||
ERR = ERROR
|
||||
CRIT = CRITICAL
|
||||
|
||||
@classmethod
|
||||
def from_arg(cls, arg: str) -> int:
|
||||
try:
|
||||
return cls[arg.upper()].value
|
||||
except KeyError:
|
||||
raise ValueError(f"unknown loglevel {arg!r}") from None
|
||||
|
||||
@classmethod
|
||||
def choices(cls) -> Iterator[str]:
|
||||
for level in sorted(cls, key=operator.attrgetter('value')):
|
||||
yield level.name.lower()
|
||||
|
||||
|
||||
def add_loglevel_argument(parser: argparse.ArgumentParser,
|
||||
default: LogLevel=LogLevel.INFO) -> argparse.Action:
|
||||
return parser.add_argument(
|
||||
'--loglevel',
|
||||
metavar='LEVEL',
|
||||
default=default.value,
|
||||
type=LogLevel.from_arg,
|
||||
help="Show logs at this level and above."
|
||||
f" Specify one of {', '.join(LogLevel.choices())}."
|
||||
f" Default {default.name.lower()}.",
|
||||
)
|
||||
|
||||
def add_version_argument(parser: argparse.ArgumentParser) -> argparse.Action:
|
||||
progname = parser.prog or sys.argv[0]
|
||||
return parser.add_argument(
|
||||
'--version', '--copyright', '--license',
|
||||
action=InfoAction,
|
||||
nargs=0,
|
||||
const=f"{progname} version {VERSION}\n{LICENSE}",
|
||||
help="Show program version and license information",
|
||||
)
|
||||
|
||||
def make_entry_point(mod_name: str, prog_name: str=sys.argv[0]) -> Callable[[], int]:
|
||||
"""Create an entry_point function for a tool
|
||||
|
||||
The returned function is suitable for use as an entry_point in setup.py.
|
||||
It sets up the root logger and excepthook, then calls the module's main
|
||||
function.
|
||||
"""
|
||||
def entry_point(): # type:ignore
|
||||
prog_mod = sys.modules[mod_name]
|
||||
setup_logger()
|
||||
prog_mod.logger = logging.getLogger(prog_name)
|
||||
sys.excepthook = ExceptHook(prog_mod.logger)
|
||||
return prog_mod.main()
|
||||
return entry_point
|
||||
|
||||
def setup_logger(logger: Union[str, logging.Logger]='',
|
||||
stream: TextIO=sys.stderr,
|
||||
fmt: str='%(name)s: %(levelname)s: %(message)s',
|
||||
) -> logging.Logger:
|
||||
"""Set up a logger with a StreamHandler with the given format"""
|
||||
if isinstance(logger, str):
|
||||
logger = logging.getLogger(logger)
|
||||
formatter = logging.Formatter(fmt)
|
||||
handler = logging.StreamHandler(stream)
|
||||
handler.setFormatter(formatter)
|
||||
logger.addHandler(handler)
|
||||
return logger
|
||||
|
||||
def set_loglevel(logger: logging.Logger, loglevel: int=logging.INFO) -> None:
|
||||
"""Set the loglevel for a tool or module
|
||||
|
||||
If the given logger is not under a hierarchy, this function sets the
|
||||
loglevel for the root logger, along with some specific levels for libraries
|
||||
used by reporting tools. Otherwise, it's the same as
|
||||
``logger.setLevel(loglevel)``.
|
||||
"""
|
||||
if '.' not in logger.name:
|
||||
logger = logging.getLogger()
|
||||
logger.setLevel(loglevel)
|
37
paypal_rest/config.py
Normal file
37
paypal_rest/config.py
Normal file
|
@ -0,0 +1,37 @@
|
|||
"""config.py - Load user configuration for PayPal API client"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import configparser
|
||||
|
||||
from pathlib import Path
|
||||
from xdg import BaseDirectory # type:ignore[import]
|
||||
|
||||
from typing import (
|
||||
Union,
|
||||
)
|
||||
|
||||
CONFIG_PATH = Path('paypal_rest', 'config.ini')
|
||||
|
||||
def load_config(path: Union[Path, str, None]=None) -> configparser.ConfigParser:
|
||||
if path is None:
|
||||
path = BaseDirectory.load_first_config(str(CONFIG_PATH))
|
||||
if path is None:
|
||||
# This path doesn't exist, but we'll handle that case later.
|
||||
path = Path(BaseDirectory.xdg_config_home, CONFIG_PATH)
|
||||
config = configparser.ConfigParser()
|
||||
with open(path) as config_file:
|
||||
config.read_file(config_file)
|
||||
return config
|
18
paypal_rest/errors.py
Normal file
18
paypal_rest/errors.py
Normal file
|
@ -0,0 +1,18 @@
|
|||
"""errors.py - PayPal API client exception classes"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
class MissingFieldError(KeyError):
|
||||
pass
|
46
paypal_rest/paypal_types.py
Normal file
46
paypal_rest/paypal_types.py
Normal file
|
@ -0,0 +1,46 @@
|
|||
"""paypal_types.py - Common types and classes across the PayPal API"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import datetime
|
||||
|
||||
from decimal import Decimal
|
||||
|
||||
from typing import (
|
||||
Any,
|
||||
Callable,
|
||||
Mapping,
|
||||
NamedTuple,
|
||||
)
|
||||
|
||||
# Declare a type definition for the one function of iso8601 that we use.
|
||||
import iso8601 # type:ignore[import]
|
||||
parse_datetime: Callable[[str], datetime.datetime] = iso8601.parse_date
|
||||
|
||||
APIResponse = Mapping[str, Any]
|
||||
|
||||
class Amount(NamedTuple):
|
||||
number: Decimal
|
||||
currency: str
|
||||
|
||||
@classmethod
|
||||
def from_api(cls, source: APIResponse) -> 'Amount':
|
||||
return cls(
|
||||
Decimal(source['value']),
|
||||
source['currency_code'],
|
||||
)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return '{:,g} {}'.format(*self)
|
152
paypal_rest/transaction.py
Normal file
152
paypal_rest/transaction.py
Normal file
|
@ -0,0 +1,152 @@
|
|||
"""transaction.py - High-level access to PayPal transactions"""
|
||||
# Copyright © 2020 Brett Smith
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import enum
|
||||
|
||||
from . import errors
|
||||
|
||||
from decimal import Decimal
|
||||
|
||||
from typing import (
|
||||
Any,
|
||||
Callable,
|
||||
Iterable,
|
||||
Iterator,
|
||||
NamedTuple,
|
||||
Optional,
|
||||
TypeVar,
|
||||
Union,
|
||||
)
|
||||
from .paypal_types import (
|
||||
Amount,
|
||||
APIResponse,
|
||||
parse_datetime,
|
||||
)
|
||||
|
||||
T = TypeVar('T')
|
||||
|
||||
class CartItem(NamedTuple):
|
||||
code: Optional[str]
|
||||
name: Optional[str]
|
||||
description: Optional[str]
|
||||
quantity: Union[int, Decimal]
|
||||
unit_price: Amount
|
||||
total_price: Amount
|
||||
|
||||
@classmethod
|
||||
def from_api(cls, source: APIResponse) -> 'CartItem':
|
||||
total_price = Amount.from_api(source['item_amount'])
|
||||
quantity = Decimal(source.get('item_quantity', 1))
|
||||
try:
|
||||
unit_price = Amount.from_api(source['item_unit_price'])
|
||||
except KeyError:
|
||||
unit_price = total_price._replace(number=total_price.number / quantity)
|
||||
return cls(
|
||||
source.get('item_code'),
|
||||
source.get('item_name'),
|
||||
source.get('item_description'),
|
||||
quantity,
|
||||
unit_price,
|
||||
total_price,
|
||||
)
|
||||
|
||||
|
||||
class TransactionStatus(enum.Enum):
|
||||
D = "Denied"
|
||||
DENIED = D
|
||||
F = "Partially Refunded"
|
||||
REFUNDED = F
|
||||
P = "Pending"
|
||||
PENDING = P
|
||||
S = "Successful"
|
||||
SUCCESSFUL = S
|
||||
SUCCESS = S
|
||||
V = "Reversed"
|
||||
REVERSED = V
|
||||
|
||||
|
||||
class Transaction(APIResponse):
|
||||
__slots__ = ['_response']
|
||||
|
||||
def __init__(self, response: APIResponse) -> None:
|
||||
self._response = response
|
||||
|
||||
def __getitem__(self, key: str) -> Any:
|
||||
return self._response[key]
|
||||
|
||||
def __iter__(self) -> Iterator[str]:
|
||||
return iter(self._response)
|
||||
|
||||
def __len__(self) -> int:
|
||||
return len(self._response)
|
||||
|
||||
def _from_response( # type:ignore[misc]
|
||||
func: Callable[[Any], T],
|
||||
*keys: str,
|
||||
) -> Callable[['Transaction'], T]:
|
||||
def _load_from_response(self: 'Transaction') -> T:
|
||||
source = self._response
|
||||
for index, key in enumerate(keys):
|
||||
try:
|
||||
source = source[key]
|
||||
except KeyError as error:
|
||||
if source is self._response:
|
||||
raise errors.MissingFieldError(
|
||||
f"transaction was not loaded with {error.args[0]!r} field",
|
||||
) from None
|
||||
else:
|
||||
key_s = '→'.join(repr(key) for key in keys[:index + 1])
|
||||
raise KeyError(f"Transaction {key_s}") from None
|
||||
return func(source)
|
||||