diff --git a/.docs/assets/workswith.png b/.docs/assets/workswith.png new file mode 100644 index 0000000..d8fa5ba Binary files /dev/null and b/.docs/assets/workswith.png differ diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..65c4c7b --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: [dwillcocks] +custom: https://share.octopus.energy/dusk-shark-465 diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..0d3a88a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,14 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + assignees: + - "dwillcocks" + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "daily" + assignees: + - "dwillcocks" diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..8dee7b9 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,34 @@ +name: tests + +on: + push: + +jobs: + build: + strategy: + matrix: + go-version: [1.15.x, 1.16.x] + + runs-on: ubuntu-latest + + steps: + - name: Checkout + id: checkout + uses: actions/checkout@v2.3.4 + + - name: Set up Go + id: installGo + uses: actions/setup-go@v2 + with: + go-version: ${{ matrix.version }} + + - name: Lint + id: lint + uses: golangci/golangci-lint-action@v2 + with: + skip-go-installation: true + + - name: GoGoGo + run: | + go build ./... + go test ./... diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2977f8c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.idea/ +example/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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/README.md b/README.md index a4c03f4..4294ea6 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -# octopus_energy_client_go \ No newline at end of file +

+ logo +

Octopus Energy Golang API client

+

+ +--- +[![PkgGoDev](https://pkg.go.dev/badge/github.com/danopstech/octopusenergy/)](https://pkg.go.dev/github.com/danopstech/octopusenergy/) +[![License](https://img.shields.io/github/license/danopstech/octopusenergy)](/LICENSE) +[![Release](https://img.shields.io/github/release/danopstech/octopusenergy.svg)](https://github.com/danopstech/octopusenergy/releases/latest) +[![tests](https://github.com/danopstech/octopusenergy/actions/workflows/build.yaml/badge.svg)](https://github.com/danopstech/octopusenergy/actions/workflows/build.yaml) + +This package provides a Golang client to [Octopus Energy's API](https://developer.octopus.energy/docs/api/). Octopus Energy provides a REST API for customers to interact with our platform. Amongst other things, it provides functionality for: + +- Browsing energy products, tariffs and their charges. +- Retrieving details about a UK electricity meter-point. +- Browsing the half-hourly consumption of an electricity or gas meter. +- Determining the grid-supply-point (GSP) for a UK postcode. + +If you are an Octopus Energy customer, you can generate an API key from your [online dashboard](https://octopus.energy/dashboard/developer/). + +### Authentication +Authentication is required for all API end-points when using this API client. This is performed via [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). This is configured when you instantiate a new client with a config object. +**Warning: Do not share your secret API keys with anyone.** + +### Not an Octopus Energy customer? +Please read about the Octopus tariffs and ensure they are right for you, if you think they are, then please use my [referral link](https://share.octopus.energy/dusk-shark-465). (at the time of writing this we will both receive £50 credit) + +### Usage +More in the examples folder + +```golang +ctx, cancel := context.WithTimeout(context.Background(), time.Second*30) +defer cancel() + +var netClient = http.Client{ + Timeout: time.Second * 10, +} + +client := octopusenergy.NewClient(octopusenergy.NewConfig(). + WithApiKeyFromEnvironments(). + WithHTTPClient(netClient), +) + +consumption, err := client.Consumption.GetPagesWithContext(ctx, &octopusenergy.ConsumptionGetOptions{ + MPN: "1111111111", // <--- replace + SerialNumber: "1111111111", // <--- replace + FuelType: octopusenergy.FuelTypeElectricity, + PeriodFrom: octopusenergy.Time(time.Now().Add(-48 * time.Hour)), +}) + +if err != nil { + log.Fatalf("failed to getting consumption: %s", err.Error()) +} +``` + +### Links +- [Octopus Energy API Docs](https://developer.octopus.energy/docs/api/) +- [Get API Key](https://octopus.energy/dashboard/developer/) diff --git a/config.go b/config.go new file mode 100644 index 0000000..be0c58c --- /dev/null +++ b/config.go @@ -0,0 +1,64 @@ +package octopusenergy + +import ( + "log" + "net/http" + "os" +) + +// Config provides service configuration for client. +type Config struct { + // Required for Authentication on all API end-points when using this client. + // If you are an Octopus Energy customer, you can generate an API key from your online dashboard + // https://octopus.energy/dashboard/developer/. + ApiKey string + + // All API requests will use this base URL. + Endpoint *string + + // The HTTP client to use when sending requests. Defaults to `http.DefaultClient`. + HTTPClient *http.Client +} + +// NewConfig returns a new Config pointer that can be chained with builder +// methods to set multiple configuration values inline without using pointers. +// +// client := octopusenergy.NewClient(octopusenergy.NewConfig(). +// WithApiKey("your-api-key"), +// )) +func NewConfig() *Config { + return &Config{} +} + +// WithApiKey sets a config ApiKey value returning a Config pointer for chaining. +func (c *Config) WithApiKey(apiKey string) *Config { + c.ApiKey = apiKey + return c +} + +// WithApiKeyFromEnvironments sets a config ApiKey value from environments valuable +// returning a Config pointer for chaining. +func (c *Config) WithApiKeyFromEnvironments() *Config { + apiKey, ok := os.LookupEnv(apiKeyEnvKey) + if !ok { + log.Fatalln("could not find api key in environment variable 'OCTOPUS_ENERGY_API_KEY'") + } + if apiKey == "" { + log.Fatalln("the api key in environment variable 'OCTOPUS_ENERGY_API_KEY' is blank") + } + + c.ApiKey = apiKey + return c +} + +// WithEndpoint sets a config Endpoint value returning a Config pointer for chaining. +func (c *Config) WithEndpoint(endpoint string) *Config { + c.Endpoint = &endpoint + return c +} + +// WithHTTPClient sets a config HTTP Client value returning a Config pointer for chaining. +func (c *Config) WithHTTPClient(HTTPClient http.Client) *Config { + c.HTTPClient = &HTTPClient + return c +} diff --git a/consumption.go b/consumption.go new file mode 100644 index 0000000..f5ade4f --- /dev/null +++ b/consumption.go @@ -0,0 +1,121 @@ +package octopusenergy + +import ( + "context" + "fmt" + "net/http" + "net/url" + "time" +) + +// ConsumptionService handles communication with the consumption related Octopus API. +type ConsumptionService service + +// ConsumptionGetOptions is the options for GetConsumption. +type ConsumptionGetOptions struct { + // The Meter Point Number this is the electricity meter-point’s MPAN or gas meter-point’s MPRN + MPN string `url:"-"` + + // The meter’s serial number. + SerialNumber string `url:"-"` + + // Fueltype: electricity or gas + FuelType FuelType `url:"-"` + + // Show consumption from the given datetime (inclusive). This parameter can be provided on its own. + PeriodFrom *time.Time `url:"period_from,omitempty" layout:"2006-01-02T15:04:05Z" optional:"true"` + + // Show consumption to the given datetime (exclusive). + // This parameter also requires providing the period_from parameter to create a range. + PeriodTo *time.Time `url:"period_to,omitempty" layout:"2006-01-02T15:04:05Z" optional:"true"` + + // Page size of returned results. + // Default is 100, maximum is 25,000 to give a full year of half-hourly consumption details. + PageSize *int `url:"page_size,omitempty" optional:"true"` + + // Ordering of results returned. + // Default is that results are returned in reverse order from latest available figure. + // Valid values: * ‘period’, to give results ordered forward. * ‘-period’, (default), to give results ordered from most recent backwards. + OrderBy *string `url:"order_by,omitempty" optional:"true"` + + // Aggregates consumption over a specified time period. + // A day is considered to start and end at midnight in the server’s timezone. + // The default is that consumption is returned in half-hour periods. Accepted values are: * ‘hour’ * ‘day’ * ‘week’ * ‘month’ * ‘quarter’ + GroupBy *string `url:"group_by,omitempty" optional:"true"` + + // Pagination page to be returned on this request + Page *int `url:"page,omitempty" optional:"true"` +} + +// ConsumptionGetOutput is the returned struct from GetConsumption. +type ConsumptionGetOutput struct { + Count int `json:"count"` + Next string `json:"next"` + Previous string `json:"previous"` + Results []struct { + Consumption float64 `json:"consumption"` + IntervalStart string `json:"interval_start"` + IntervalEnd string `json:"interval_end"` + } `json:"results"` +} + +// Get consumption data for give meter details. This endpoint is paginated, it will return +// next and previous links if returned data is larger than the set page size, you are responsible +// to request the next page if required. +func (s *ConsumptionService) Get(options *ConsumptionGetOptions) (*ConsumptionGetOutput, error) { + return s.GetWithContext(context.Background(), options) +} + +// GetWithContext same as Get except it takes a Context. +func (s *ConsumptionService) GetWithContext(ctx context.Context, options *ConsumptionGetOptions) (*ConsumptionGetOutput, error) { + path := fmt.Sprintf("v1/%s-meter-points/%s/meters/%s/consumption", options.FuelType.String(), options.MPN, options.SerialNumber) + rel := &url.URL{Path: path} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := ConsumptionGetOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} + +// GetPages same as Get except it returns all pages in one request. +func (s *ConsumptionService) GetPages(options *ConsumptionGetOptions) (*ConsumptionGetOutput, error) { + return s.GetPagesWithContext(context.Background(), options) +} + +// GetPagesWithContext same as GetPages except it takes a Context. +func (s *ConsumptionService) GetPagesWithContext(ctx context.Context, options *ConsumptionGetOptions) (*ConsumptionGetOutput, error) { + options.PageSize = Int(1500) + options.Page = nil + + fullResp := ConsumptionGetOutput{} + var lastPage bool + var i int + + for !lastPage { + page, err := s.GetWithContext(ctx, options) + if err != nil { + return nil, err + } + fullResp.Count = page.Count + fullResp.Results = append(fullResp.Results, page.Results...) + if page.Next == "" { + lastPage = true + } + i++ + options.Page = Int(i) + } + + return &fullResp, nil +} diff --git a/convert_types.go b/convert_types.go new file mode 100644 index 0000000..b70bcf5 --- /dev/null +++ b/convert_types.go @@ -0,0 +1,33 @@ +package octopusenergy + +import ( + "time" +) + +// String returns a pointer to the string value passed in. +// This is a helper function when you need to provide pointers to +// optional fields in the input options object. +func String(v string) *string { + return &v +} + +// Int returns a pointer to the int value passed in. +// This is a helper function when you need to provide pointers to +// optional fields in the input options object. +func Int(v int) *int { + return &v +} + +// Bool returns a pointer to the bool value passed in. +// This is a helper function when you need to provide pointers to +// optional fields in the input options object. +func Bool(v bool) *bool { + return &v +} + +// Time returns a pointer to the time.Time value passed in. +// This is a helper function when you need to provide pointers to +// optional fields in the input options object. +func Time(v time.Time) *time.Time { + return &v +} diff --git a/convert_types_test.go b/convert_types_test.go new file mode 100644 index 0000000..918a544 --- /dev/null +++ b/convert_types_test.go @@ -0,0 +1,33 @@ +package octopusenergy_test + +import ( + "fmt" + "time" + + "github.com/danopstech/octopusenergy" +) + +func ExampleBool() { + boolPtr := octopusenergy.Bool(true) + fmt.Println(*boolPtr) + // Output: true +} + +func ExampleString() { + stringPtr := octopusenergy.String("example") + fmt.Println(*stringPtr) + // Output: example +} + +func ExampleInt() { + intPtr := octopusenergy.Int(5) + fmt.Println(*intPtr) + // Output: 5 +} + +func ExampleTime() { + wayBack := time.Date(1974, time.May, 19, 1, 2, 3, 4, time.UTC) + timePtr := octopusenergy.Time(wayBack) + fmt.Println(*timePtr) + // Output: 1974-05-19 01:02:03.000000004 +0000 UTC +} diff --git a/errors.go b/errors.go new file mode 100644 index 0000000..c5338d4 --- /dev/null +++ b/errors.go @@ -0,0 +1,6 @@ +package octopusenergy + +// errorResponse is the returned body when API error accrues +type errorResponse struct { + Detail string `json:"detail"` +} diff --git a/examples/getconsumption/main.go b/examples/getconsumption/main.go new file mode 100644 index 0000000..52a8564 --- /dev/null +++ b/examples/getconsumption/main.go @@ -0,0 +1,43 @@ +package main + +import ( + "context" + "encoding/json" + "fmt" + "log" + "net/http" + "time" + + "github.com/danopstech/octopusenergy" +) + +func main() { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*30) + defer cancel() + + var netClient = http.Client{ + Timeout: time.Second * 10, + } + + client := octopusenergy.NewClient(octopusenergy.NewConfig(). + WithApiKeyFromEnvironments(). + WithHTTPClient(netClient), + ) + + consumption, err := client.Consumption.GetPagesWithContext(ctx, &octopusenergy.ConsumptionGetOptions{ + MPN: "1111111111", // <--- replace + SerialNumber: "1111111111", // <--- replace + FuelType: octopusenergy.FuelTypeElectricity, + PeriodFrom: octopusenergy.Time(time.Now().Add(-48 * time.Hour)), + }) + + if err != nil { + log.Fatalf("failed to getting consumption: %s", err.Error()) + } + + b, err := json.MarshalIndent(consumption, "", " ") + if err != nil { + log.Fatalf("failed to pretty print: %s", err.Error()) + } + fmt.Print(string(b)) +} diff --git a/examples/getproduct/main.go b/examples/getproduct/main.go new file mode 100644 index 0000000..efec07a --- /dev/null +++ b/examples/getproduct/main.go @@ -0,0 +1,40 @@ +package main + +import ( + "context" + "encoding/json" + "fmt" + "log" + "net/http" + "time" + + "github.com/danopstech/octopusenergy" +) + +func main() { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*30) + defer cancel() + + var netClient = http.Client{ + Timeout: time.Second * 10, + } + + client := octopusenergy.NewClient(octopusenergy.NewConfig(). + WithApiKeyFromEnvironments(). + WithHTTPClient(netClient), + ) + + product, err := client.Product.GetWithContext(ctx, &octopusenergy.ProductsGetOptions{ + ProductCode: octopusenergy.ProductCodeAgile180221, + }) + + if err != nil { + log.Fatalf("failed to get product: %s", err.Error()) + } + + b, err := json.MarshalIndent(product, "", " ") + if err != nil { + log.Fatalf("failed to pretty print: %s", err.Error()) + } + fmt.Print(string(b)) +} diff --git a/examples/listproducts/main.go b/examples/listproducts/main.go new file mode 100644 index 0000000..0071af0 --- /dev/null +++ b/examples/listproducts/main.go @@ -0,0 +1,38 @@ +package main + +import ( + "context" + "encoding/json" + "fmt" + "log" + "net/http" + "time" + + "github.com/danopstech/octopusenergy" +) + +func main() { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*30) + defer cancel() + + var netClient = http.Client{ + Timeout: time.Second * 10, + } + + client := octopusenergy.NewClient(octopusenergy.NewConfig(). + WithApiKeyFromEnvironments(). + WithHTTPClient(netClient), + ) + + products, err := client.Product.ListWithContext(ctx, &octopusenergy.ProductsListOptions{}) + + if err != nil { + log.Fatalf("failed to list products: %s", err.Error()) + } + + b, err := json.MarshalIndent(products, "", " ") + if err != nil { + log.Fatalf("failed to pretty print: %s", err.Error()) + } + fmt.Print(string(b)) +} diff --git a/gen_stringer.go b/gen_stringer.go new file mode 100644 index 0000000..a588cf1 --- /dev/null +++ b/gen_stringer.go @@ -0,0 +1,44 @@ +// Code generated by "stringer -linecomment -output=gen_stringer.go -type=FuelType,Rate"; DO NOT EDIT. + +package octopusenergy + +import "strconv" + +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[FuelTypeElectricity-0] + _ = x[FuelTypeGas-1] +} + +const _FuelType_name = "electricitygas" + +var _FuelType_index = [...]uint8{0, 11, 14} + +func (i FuelType) String() string { + if i < 0 || i >= FuelType(len(_FuelType_index)-1) { + return "FuelType(" + strconv.FormatInt(int64(i), 10) + ")" + } + return _FuelType_name[_FuelType_index[i]:_FuelType_index[i+1]] +} +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[RateStandingCharge-0] + _ = x[RateStandardUnit-1] + _ = x[RateDayUnit-2] + _ = x[RateNightUnit-3] +} + +const _Rate_name = "standing-chargesstandard-unit-ratesday-unit-ratesnight-unit-rates" + +var _Rate_index = [...]uint8{0, 16, 35, 49, 65} + +func (i Rate) String() string { + if i < 0 || i >= Rate(len(_Rate_index)-1) { + return "Rate(" + strconv.FormatInt(int64(i), 10) + ")" + } + return _Rate_name[_Rate_index[i]:_Rate_index[i+1]] +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..ecc99cf --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module github.com/danopstech/octopusenergy + +go 1.16 + +require ( + github.com/google/go-cmp v0.5.4 // indirect + github.com/google/go-querystring v1.1.0 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..646f269 --- /dev/null +++ b/go.sum @@ -0,0 +1,7 @@ +github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M= +github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= +github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/grid_supply_point.go b/grid_supply_point.go new file mode 100644 index 0000000..7d49f4e --- /dev/null +++ b/grid_supply_point.go @@ -0,0 +1,52 @@ +package octopusenergy + +import ( + "context" + "net/http" + "net/url" +) + +// GridSupplyPointService handles communication with the grid supply point related Octopus API. +type GridSupplyPointService service + +// GridSupplyPointGetOptions is the options for GetGridSupplyPoint. +type GridSupplyPointGetOptions struct { + // A postcode to filter on. + // If Octopus are unable to map the passed postcode to a GSP, an empty list will be returned. + Postcode *string `url:"postcode,omitempty" optional:"true"` +} + +// GridSupplyPointGetOutput is the returned struct from GetGridSupplyPoint. +type GridSupplyPointGetOutput struct { + Count int `json:"count"` + Results []struct { + GroupID string `json:"group_id"` + } `json:"results"` +} + +// Get gets the GSP and group ID, filtered by postcode if one is given. +func (s *GridSupplyPointService) Get(options *GridSupplyPointGetOptions) (*GridSupplyPointGetOutput, error) { + return s.GetWithContext(context.Background(), options) +} + +// GetWithContext same as Get except it takes a Context. +func (s *GridSupplyPointService) GetWithContext(ctx context.Context, options *GridSupplyPointGetOptions) (*GridSupplyPointGetOutput, error) { + rel := &url.URL{Path: "v1/industry/grid-supply-points"} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := GridSupplyPointGetOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} diff --git a/meter_point.go b/meter_point.go new file mode 100644 index 0000000..09b20b1 --- /dev/null +++ b/meter_point.go @@ -0,0 +1,57 @@ +package octopusenergy + +import ( + "context" + "fmt" + "net/http" + "net/url" +) + +// MeterPointService handles communication with the meter point related Octopus API. +type MeterPointService service + +// MeterPointGetOptions is the options for GetMeterPoint. +type MeterPointGetOptions struct { + // The electricity meter-point’s MPAN. + MPAN string `url:"-"` +} + +// MeterPointGetOutput is the returned struct from GetMeterPoint. +type MeterPointGetOutput struct { + // Grid Supply Point + GSP string `json:"gsp"` + + // The electricity meter-point’s MPAN. + MPAN string `json:"mpan"` + + // ProfileClass + ProfileClass int `json:"profile_class"` +} + +// Get the GSP and profile of a given MPAN. +func (s *MeterPointService) Get(options *MeterPointGetOptions) (*MeterPointGetOutput, error) { + return s.GetWithContext(context.Background(), options) +} + +// GetWithContext same as Get except it takes a Context +func (s *MeterPointService) GetWithContext(ctx context.Context, options *MeterPointGetOptions) (*MeterPointGetOutput, error) { + path := fmt.Sprintf("v1/electricity-meter-points/%s", options.MPAN) + rel := &url.URL{Path: path} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := MeterPointGetOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} diff --git a/octopusenergy.go b/octopusenergy.go new file mode 100644 index 0000000..5eb78c4 --- /dev/null +++ b/octopusenergy.go @@ -0,0 +1,132 @@ +//go:generate stringer -linecomment -output=gen_stringer.go -type=FuelType,Rate + +// Package octopusenergy proves an interface for Octopus Energy REST APIs. +package octopusenergy + +import ( + "encoding/base64" + "encoding/json" + "errors" + "fmt" + "net/http" + "net/url" + "reflect" + + "github.com/google/go-querystring/query" +) + +const ( + // ProductCodeAgile180221 is the product code to Octopus current Agile tariff + ProductCodeAgile180221 = "AGILE-18-02-21" + + defaultBaseURL = "https://api.octopus.energy/" + userAgent = "octopus-energy-api-client-go/0.0.0" + apiKeyEnvKey = "OCTOPUS_ENERGY_API_KEY" +) + +type FuelType int + +const ( + FuelTypeElectricity FuelType = iota // electricity + FuelTypeGas // gas +) + +type service struct { + client *Client +} + +type Client struct { + // Base URL for API requests. Defaults to the public Octopus API. + BaseURL url.URL + + // + auth string + + // User agent used when communicating with the GitHub API. + userAgent string + + // HTTP client used to communicate with the API. + HTTPClient *http.Client + + common service // Reuse a single struct instead of allocating one for each service on the heap. + + // Services used for talking to different parts of the Octopus API. + TariffCharge *TariffChargeService + MeterPoint *MeterPointService + Product *ProductService + GridSupplyPoint *GridSupplyPointService + Consumption *ConsumptionService +} + +// NewClient accepts a config object and returns an initiated client ready to use. +func NewClient(cfg *Config) *Client { + url, _ := url.Parse(defaultBaseURL) + httpClient := http.DefaultClient + + if cfg.Endpoint != nil { + url, _ = url.Parse(*cfg.Endpoint) + } + + if cfg.HTTPClient != nil { + httpClient = cfg.HTTPClient + } + + c := &Client{ + BaseURL: *url, + auth: base64.StdEncoding.EncodeToString([]byte(cfg.ApiKey + ":")), + userAgent: userAgent, + HTTPClient: httpClient, + } + + c.common.client = c + c.TariffCharge = (*TariffChargeService)(&c.common) + c.MeterPoint = (*MeterPointService)(&c.common) + c.Product = (*ProductService)(&c.common) + c.GridSupplyPoint = (*GridSupplyPointService)(&c.common) + c.Consumption = (*ConsumptionService)(&c.common) + + return c +} + +func addParameters(url *url.URL, parameters interface{}) (*url.URL, error) { + v := reflect.ValueOf(parameters) + if v.Kind() == reflect.Ptr && v.IsNil() { + return url, nil + } + + vs, err := query.Values(parameters) + if err != nil { + return url, err + } + url.RawQuery = vs.Encode() + return url, nil +} + +func (c *Client) sendRequest(req *http.Request, castTo interface{}) error { + req.Header.Set("Content-Type", "application/json; charset=utf-8") + req.Header.Set("Accept", "application/json; charset=utf-8") + req.Header.Set("User-Agent", c.userAgent) + req.Header.Set("Authorization", "Basic "+c.auth) + + res, err := c.HTTPClient.Do(req) + if err != nil { + return err + } + + defer res.Body.Close() + + if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusBadRequest { + var errRes errorResponse + if err = json.NewDecoder(res.Body).Decode(&errRes); err == nil { + // TODO: return common custom errors types + return errors.New(errRes.Detail) + } + return fmt.Errorf("unknown error, status code: %d", res.StatusCode) + } + + if err = json.NewDecoder(res.Body).Decode(&castTo); err != nil { + return err + } + + return nil +} diff --git a/product.go b/product.go new file mode 100644 index 0000000..0007ac3 --- /dev/null +++ b/product.go @@ -0,0 +1,252 @@ +package octopusenergy + +import ( + "context" + "fmt" + "net/http" + "net/url" + "time" +) + +// ProductService handles communication with the product related Octopus API. +type ProductService service + +// ProductsListOptions is the options for ListProduct. +type ProductsListOptions struct { + // Show only variable products. + IsVariable *bool `url:"is_variable,omitempty" optional:"true"` + + // Show only green products. + IsGreen *bool `url:"is_green,omitempty" optional:"true"` + + // Show only tracker products. + IsTracker *bool `url:"is_tracker,omitempty" optional:"true"` + + // Show only pre-pay products. + IsPrepay *bool `url:"is_prepay,omitempty" optional:"true"` + + // Show only business products. + IsBusiness *bool `url:"is_business,omitempty" optional:"true"` + + // Show products available for new agreements on the given datetime. + // Defaults to current datetime, effectively showing products that are currently available. + AvailableAt *time.Time `url:"available_at,omitempty" layout:"2006-01-02T15:04:05Z" optional:"true"` + + // Pagination page to be returned on this request + Page *int `url:"page,omitempty" optional:"true"` +} + +// ProductsListOutput is the returned struct from ListProduct. +type ProductsListOutput struct { + Count int `json:"count"` + Next string `json:"next"` + Previous string `json:"previous"` + Results []struct { + Code string `json:"code"` + FullName string `json:"full_name"` + DisplayName string `json:"display_name"` + Description string `json:"description"` + IsVariable bool `json:"is_variable"` + IsGreen bool `json:"is_green"` + IsTracker bool `json:"is_tracker"` + IsPrepay bool `json:"is_prepay"` + IsBusiness bool `json:"is_business"` + IsRestricted bool `json:"is_restricted"` + Term int `json:"term"` + Brand string `json:"brand"` + AvailableFrom time.Time `json:"available_from"` + AvailableTo interface{} `json:"available_to"` + Links []struct { + Href string `json:"href"` + Method string `json:"method"` + Rel string `json:"rel"` + } `json:"links"` + } `json:"results"` +} + +// List return a list of energy products. This endpoint is paginated, it will return +// next and previous links if returned data is larger than the set page size, you are responsible +// to request the next page if required. +func (s *ProductService) List(options *ProductsListOptions) (*ProductsListOutput, error) { + return s.ListWithContext(context.Background(), options) +} + +// ListWithContext same as ListProducts except it takes a Context. +func (s *ProductService) ListWithContext(ctx context.Context, options *ProductsListOptions) (*ProductsListOutput, error) { + rel := &url.URL{Path: "v1/products/"} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := ProductsListOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} + +// ListPages same as List except it returns all pages in one request. +func (s *ProductService) ListPages(options *ProductsListOptions) (*ProductsListOutput, error) { + return s.ListPagesWithContext(context.Background(), options) +} + +// ListPagesWithContext same as ListPages except it takes a Context. +func (s *ProductService) ListPagesWithContext(ctx context.Context, options *ProductsListOptions) (*ProductsListOutput, error) { + options.Page = nil + + fullResp := ProductsListOutput{} + var lastPage bool + var i int + + for !lastPage { + page, err := s.ListWithContext(ctx, options) + if err != nil { + return nil, err + } + fullResp.Count = page.Count + fullResp.Results = append(fullResp.Results, page.Results...) + if page.Next == "" { + lastPage = true + } + i++ + options.Page = Int(i) + } + + return &fullResp, nil +} + +// ProductsGetOptions is the options for GetProduct. +type ProductsGetOptions struct { + // The code of the product to be retrieved. + ProductCode string `url:"-"` + + // The point in time in which to show the active charges. Defaults to current datetime. + TariffsActiveAt *time.Time `url:"tariffs_active_at" layout:"2006-01-02T15:04:05Z" optional:"true"` +} + +// ProductsGetOutput is the returned struct from GetProduct. +type ProductsGetOutput struct { + Code string `json:"code"` + FullName string `json:"full_name"` + DisplayName string `json:"display_name"` + Description string `json:"description"` + IsVariable bool `json:"is_variable"` + IsGreen bool `json:"is_green"` + IsTracker bool `json:"is_tracker"` + IsPrepay bool `json:"is_prepay"` + IsBusiness bool `json:"is_business"` + IsRestricted bool `json:"is_restricted"` + Brand string `json:"brand"` + Term int `json:"term"` + AvailableFrom time.Time `json:"available_from"` + AvailableTo time.Time `json:"available_to"` + TariffsActiveAt time.Time `json:"tariffs_active_at"` + SingleRegisterElectricityTariffs map[string]Tariff `json:"single_register_electricity_tariffs"` + DualRegisterElectricityTariffs map[string]Tariff `json:"dual_register_electricity_tariffs"` + SingleRegisterGasTariffs map[string]Tariff `json:"single_register_gas_tariffs"` + SampleQuotes map[string]SampleQuote `json:"sample_quotes"` + SampleConsumption SampleConsumption `json:"sample_consumption"` + Links []struct { + Href string `json:"href"` + Method string `json:"method"` + Rel string `json:"rel"` + } `json:"links"` +} + +type Tariff struct { + DirectDebitMonthly TariffDirectDebit `json:"direct_debit_monthly"` + DirectDebitQuarterly TariffDirectDebit `json:"direct_debit_quarterly"` +} + +type TariffDirectDebit struct { + Code string `json:"code"` + StandardUnitRateExcVat float64 `json:"standard_unit_rate_exc_vat"` + StandardUnitRateIncVat float64 `json:"standard_unit_rate_inc_vat"` + StandingChargeExcVat float64 `json:"standing_charge_exc_vat"` + StandingChargeIncVat float64 `json:"standing_charge_inc_vat"` + OnlineDiscountExcVat int `json:"online_discount_exc_vat"` + OnlineDiscountIncVat int `json:"online_discount_inc_vat"` + DualFuelDiscountExcVat int `json:"dual_fuel_discount_exc_vat"` + DualFuelDiscountIncVat int `json:"dual_fuel_discount_inc_vat"` + ExitFeesExcVat int `json:"exit_fees_exc_vat"` + ExitFeesIncVat int `json:"exit_fees_inc_vat"` + Links []struct { + Href string `json:"href"` + Method string `json:"method"` + Rel string + } `json:"direct_debit_monthly"` +} + +type SampleQuote struct { + DirectDebitMonthly SampleQuoteDirectDebit `json:"direct_debit_monthly"` + DirectDebitQuarterly SampleQuoteDirectDebit `json:"direct_debit_quarterly"` +} + +type SampleQuoteDirectDebit struct { + ElectricitySingleRate SampleQuoteDirectDebitRate `json:"electricity_single_rate"` + ElectricityDualRate SampleQuoteDirectDebitRate `json:"electricity_dual_rate"` + DualFuelSingleRate SampleQuoteDirectDebitRate `json:"dual_fuel_single_rate"` + DualFuelDualRate SampleQuoteDirectDebitRate `json:"dual_fuel_dual_rate"` +} + +type SampleQuoteDirectDebitRate struct { + AnnualCostIncVat int `json:"annual_cost_inc_vat"` + AnnualCostExcVat int `json:"annual_cost_exc_vat"` +} + +type SampleConsumption struct { + ElectricitySingleRate struct { + ElectricityStandard int `json:"electricity_standard"` + } `json:"electricity_single_rate"` + ElectricityDualRate struct { + ElectricityDay int `json:"electricity_day"` + ElectricityNight int `json:"electricity_night"` + } `json:"electricity_dual_rate"` + DualFuelSingleRate struct { + ElectricityStandard int `json:"electricity_standard"` + GasStandard int `json:"gas_standard"` + } `json:"dual_fuel_single_rate"` + DualFuelDualRate struct { + ElectricityDay int `json:"electricity_day"` + ElectricityNight int `json:"electricity_night"` + GasStandard int `json:"gas_standard"` + } `json:"dual_fuel_dual_rate"` +} + +// Get retrieves the details of a product (including all its tariffs) for a particular point in time. +// This endpoint is paginated, it will return next and previous links if returned data is larger than +// the set page size, you are responsible to request the next page if required. +func (s *ProductService) Get(options *ProductsGetOptions) (*ProductsGetOutput, error) { + return s.GetWithContext(context.Background(), options) +} + +// GetWithContext same as Get except it takes a Context +func (s *ProductService) GetWithContext(ctx context.Context, options *ProductsGetOptions) (*ProductsGetOutput, error) { + path := fmt.Sprintf("/v1/products/%s", options.ProductCode) + rel := &url.URL{Path: path} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := ProductsGetOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} diff --git a/tariff_charges.go b/tariff_charges.go new file mode 100644 index 0000000..45db09a --- /dev/null +++ b/tariff_charges.go @@ -0,0 +1,127 @@ +package octopusenergy + +import ( + "context" + "fmt" + "net/http" + "net/url" + "time" +) + +// TariffChargeService handles communication with the tariff related Octopus API. +type TariffChargeService service + +// Rate is the type of charge, example standing-charges, day-unit-rates, standard-unit-rates +type Rate int + +const ( + RateStandingCharge Rate = iota // standing-charges + RateStandardUnit // standard-unit-rates + RateDayUnit // day-unit-rates + RateNightUnit // night-unit-rates +) + +// TariffChargesGetOptions is the options for GetTariffCharges. +type TariffChargesGetOptions struct { + // The code of the product to be retrieved. + ProductCode string `url:"-"` + + // The code of the tariff to be retrieved. + TariffCode string `url:"-"` + + // Fueltype: electricity or gas + FuelType FuelType `url:"-"` + + // The type of charge + Rate Rate `url:"-"` + + // Show charges active from the given datetime (inclusive). This parameter can be provided on its own. + PeriodFrom *time.Time `url:"period_from,omitempty" layout:"2006-01-02T15:04:05Z" optional:"true"` + + // Show charges active up to the given datetime (exclusive). + // You must also provide the period_from parameter in order to create a range. + PeriodTo *time.Time `url:"period_to,omitempty" layout:"2006-01-02T15:04:05Z" optional:"true"` + + // Page size of returned results. + // Default is 100, maximum is 1,500 to give up to a month of half-hourly prices. + PageSize *int `url:"page_size,omitempty" optional:"true"` + + // Pagination page to be returned on this request + Page *int `url:"page,omitempty" optional:"true"` +} + +// TariffChargesGetOutput is the returned struct from GetTariffCharges. +type TariffChargesGetOutput struct { + Count int `json:"count"` + Next string `json:"next"` + Previous string `json:"previous"` + Results []struct { + ValueExcVat float64 `json:"value_exc_vat"` + ValueIncVat float64 `json:"value_inc_vat"` + ValidFrom time.Time `json:"valid_from"` + ValidTo time.Time `json:"valid_to"` + } `json:"results"` +} + +// Get retrieves the details of a tariffs changes. This endpoint is paginated, it will return +// next and previous links if returned data is larger than the set page size, you are responsible +// to request the next page if required. +func (s *TariffChargeService) Get(options *TariffChargesGetOptions) (*TariffChargesGetOutput, error) { + return s.GetWithContext(context.Background(), options) +} + +// GetWithContext same as Get except it takes a Context +func (s *TariffChargeService) GetWithContext(ctx context.Context, options *TariffChargesGetOptions) (*TariffChargesGetOutput, error) { + path := fmt.Sprintf("/v1/products/%s/%s-tariffs/%s/%s/", options.ProductCode, options.FuelType.String(), options.TariffCode, options.Rate.String()) + rel := &url.URL{Path: path} + u := s.client.BaseURL.ResolveReference(rel) + url, err := addParameters(u, options) + if err != nil { + return nil, err + } + + fmt.Println(url.String()) + + req, err := http.NewRequestWithContext(ctx, "GET", url.String(), nil) + if err != nil { + return nil, err + } + + res := TariffChargesGetOutput{} + if err := s.client.sendRequest(req, &res); err != nil { + return nil, err + } + + return &res, nil +} + +// GetPages same as Get except it returns all pages in one request +func (s *TariffChargeService) GetPages(options *TariffChargesGetOptions) (*TariffChargesGetOutput, error) { + return s.GetPagesWithContext(context.Background(), options) +} + +// GetPagesWithContext same as GetPages except it takes a Context +func (s *TariffChargeService) GetPagesWithContext(ctx context.Context, options *TariffChargesGetOptions) (*TariffChargesGetOutput, error) { + options.PageSize = Int(1500) + options.Page = nil + + fullResp := TariffChargesGetOutput{} + var lastPage bool + var i int + + for !lastPage { + page, err := s.GetWithContext(ctx, options) + if err != nil { + return nil, err + } + fullResp.Count = page.Count + fullResp.Results = append(fullResp.Results, page.Results...) + if page.Next == "" { + lastPage = true + } + i++ + options.Page = Int(i) + } + + return &fullResp, nil +}