diff --git a/DigitalOcean.cabal b/DigitalOcean.cabal new file mode 100644 --- /dev/null +++ b/DigitalOcean.cabal @@ -0,0 +1,45 @@ +name: DigitalOcean +version: 0.1.0.0 +synopsis: A client library for the DigitalOcean API +license: AGPL-3 +license-file: LICENSE +author: Laurie Clark-Michalek +maintainer: lclarkmichalek@gmail.com +category: Network +build-type: Simple +cabal-version: >=1.10 +extra-source-files: README.md, + examples/SSHKeyInfo.hs + +library + exposed-modules: Net.DigitalOcean, + Net.DigitalOcean.Actions, + Net.DigitalOcean.Regions, + Net.DigitalOcean.Sizes, + Net.DigitalOcean.Images, + Net.DigitalOcean.SSHKeys, + Net.DigitalOcean.Droplets, + Net.DigitalOcean.Config, + Net.DigitalOcean.Request + default-extensions: OverloadedStrings, TemplateHaskell, DeriveGeneric + ghc-options: -Wall + build-depends: base >=4.7 && <4.8, + text >= 1.2.0.3 && < 1.3, + -- Require Control.Monad.Except + mtl >= 2.2.1, + -- Transative dependencies I don't want to constrain + lens, wreq, aeson, containers, random, + bytestring, unordered-containers, vector, + transformers, exceptions + hs-source-dirs: src + default-language: Haskell2010 + +test-suite tests + default-extensions: OverloadedStrings, TemplateHaskell, DeriveGeneric + ghc-options: -Wall + type: exitcode-stdio-1.0 + main-is: Tests.hs + hs-source-dirs: tests + build-depends: base, DigitalOcean, hspec >= 2.0, + mtl, text, lens + default-language: Haskell2010 diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 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. + + + Copyright (C) + + 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 . + +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 +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +DigitalOcean +============ + +A Haskell Digital Ocean API. + +Exposes a lens based interface onto the Digital Ocean API. Fairly feature +complete. + +Error Handling & IO Monads +-------------------------- + +Instead of enforcing a monad to return, all functions that do IO and stuff have a +type something along the lines of: + + getSSHKeys :: (Error e, MonadError e m, MonadIO m) => Config -> m [SSHKey] + +Translated to human, this just means that the monad `m` that is returned can +1) encapsulate IO, and 2) represent an error, of type `e`. This is useful if you +want to use `ExceptT` or something similarly fun to represent your errors. +However, for simple use, you will be relived to hear that `m` may be the plain +old `IO` monad, which will represent its errors by throwing `IOException` +exceptions. + +This means, despite the confusing type signature, we may write things such as: + + main = do + auth <- fmap head getArgs -- Get the auth from the cmd line + keys <- getSSHKeys . Config . pack $ auth -- Get the ssh keys + putStrLn . show $ keys -- And display them + +See the ./examples directory for further usage + +TODO: +----- + +* Pagination +* Tests +* HTTP session reuse diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/examples/SSHKeyInfo.hs b/examples/SSHKeyInfo.hs new file mode 100644 --- /dev/null +++ b/examples/SSHKeyInfo.hs @@ -0,0 +1,19 @@ +module Main where + +import qualified Data.Text as T +import qualified Net.DigitalOcean as DO +import System.Environment (getArgs) +import Text.Printf (printf) +import Control.Lens + +main :: IO () +main = do + auth <- fmap head getArgs + + let c = DO.Config . T.pack $ auth + keys <- DO.getSSHKeys c + printf "Got %d keys" (length keys) + let printKey k = printf "Key %s: %s" + (show $ k ^. DO.keyName) + (show $ k ^. DO.keyFingerprint) + mapM_ printKey keys diff --git a/src/Net/DigitalOcean.hs b/src/Net/DigitalOcean.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean.hs @@ -0,0 +1,9 @@ +module Net.DigitalOcean (module X) where + +import Net.DigitalOcean.Config as X +import Net.DigitalOcean.Actions as X +import Net.DigitalOcean.Regions as X +import Net.DigitalOcean.Sizes as X +import Net.DigitalOcean.Images as X +import Net.DigitalOcean.SSHKeys as X +import Net.DigitalOcean.Droplets as X diff --git a/src/Net/DigitalOcean/Actions.hs b/src/Net/DigitalOcean/Actions.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Actions.hs @@ -0,0 +1,63 @@ +module Net.DigitalOcean.Actions ( + Action(..) + , getActions + , getAction + + -- ** Lens Accessors + , actId, actStatus, actType, actStartedAt, actCompletedAt + , actResourceId, actResourceType, actRegion + ) where +import qualified Data.Text as T +import Data.Aeson(FromJSON(..), Value(..), (.:)) +import Control.Applicative +import Control.Lens hiding (Action) +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.Error.Class (MonadError, Error) + +import Net.DigitalOcean.Request (get) +import Net.DigitalOcean.Config (Config) + +-- | An action that has be taken on a DigitalOcean resource +data Action = Action + { _actId :: !Int + , _actStatus :: !T.Text + , _actType :: !T.Text + , _actStartedAt :: !T.Text + , _actCompletedAt :: !T.Text + , _actResourceId :: !T.Text + , _actResourceType :: !T.Text + , _actRegion :: !T.Text + } deriving (Show, Eq) +makeLenses ''Action + +instance FromJSON Action where + parseJSON (Object x) = Action <$> + x .: "id" <*> + x .: "status" <*> + x .: "type" <*> + x .: "started_at" <*> + x .: "completed_at" <*> + x .: "resource_id" <*> + x .: "resource_type" <*> + x .: "region" + parseJSON _ = fail "action must be object" + +actionsEndpoint :: String +actionsEndpoint = "/v2/actions/" + +actionEndpoint :: T.Text -> String +actionEndpoint = (++) actionsEndpoint . T.unpack + +-- | List all actions performed on the account +-- +-- +getActions :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Action] +getActions = get actionsEndpoint "actions" + +-- | Get a single action performed on the account +-- +-- +getAction :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m Action +getAction n = get (actionEndpoint n) "actions" diff --git a/src/Net/DigitalOcean/Config.hs b/src/Net/DigitalOcean/Config.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Config.hs @@ -0,0 +1,20 @@ +module Net.DigitalOcean.Config ( + Config(..) + , confAuth + -- * Utility/Helpers + , options + ) where + +import qualified Network.Wreq as W +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) +import Control.Lens + +data Config = Config { _confAuth :: !T.Text } deriving (Show, Eq) + +makeLenses ''Config + +-- | Generate a Wreq 'W.Options' instance from the given 'Config'. Can be +-- further modified to set additional parameters, headers, etc +options :: Config -> W.Options +options c = W.defaults & W.auth ?~ W.basicAuth (encodeUtf8 $ c ^. confAuth) "" diff --git a/src/Net/DigitalOcean/Droplets.hs b/src/Net/DigitalOcean/Droplets.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Droplets.hs @@ -0,0 +1,326 @@ +{-# LANGUAGE FlexibleInstances #-} +module Net.DigitalOcean.Droplets ( + Network + , Kernel + , Droplet + , Snapshot + , Backup + , DropletAction(..) + , DropletCreationOpts + + , createDroplet + , getDroplet + , getDroplets + , getDropletKernels + , getDropletSnapshots + , getDropletBackups + , getDropletActions + , deleteDroplet + , performDropletAction + + -- * Droplet creation options + , defaultDCO + + -- * Lens Accessors + , netProto + , netIpAddr + , netNetmask + , netGateway + , netType + + , krnId + , krnName + , krnVersion + + , drpId + , drpName + , drpMemory + , drpVCPUs + , drpDisk + , drpLocked + , drpCreatedAt + , drpStatus + , drpBackupIds + , drpSnapshotIds + , drpFeatures + , drpRegion + , drpImage + , drpNetworks + , drpKernel + + , snpId + , snpName + , snpDist + , snpSlug + , snpPublic + , snpRegions + + , bckId + , bckName + , bckDist + , bckSlug + , bckPublic + , bckRegions + + , dcoName + , dcoRegion + , dcoSize + , dcoImage + , dcoSSHKeys + , dcoBackups + , dcoIpv6 + , dcoPrivateNetworking + , dcoUserData + + ) where + +import qualified Data.Text as T +import qualified Data.HashMap.Strict as HM +import qualified Data.Vector as V +import Data.Aeson (FromJSON(..), ToJSON(..), Value(..), (.:), (.=), object, Value) +import Data.Maybe (catMaybes) +import Control.Lens hiding ((.=), Action) +import Control.Applicative + +import Control.Monad.IO.Class (MonadIO(..)) +import Control.Monad.Error.Class (MonadError, Error) + +import Net.DigitalOcean.Request (get, post, delete) +import Net.DigitalOcean.Config (Config) +import Net.DigitalOcean.Regions (Region) +import Net.DigitalOcean.Images (Image) +import Net.DigitalOcean.Actions (Action) + +data Network = Network + { _netProto :: !T.Text + , _netIpAddr :: !T.Text + , _netNetmask :: !T.Text + , _netGateway :: !T.Text + , _netType :: !T.Text + } deriving (Show, Eq) +makeLenses ''Network + +instance FromJSON [Network] where + parseJSON (Object obj) = sequence . concat $ mapM parseEntry (HM.toList obj) + where parseEntry (ty, Array vals) = map (parseNetwork ty) (V.toList vals) + parseEntry _ = error "network list must be arr" + parseNetwork ty (Object n) = + Network ty <$> + n .: "ip_address" <*> + n .: "netmask" <*> + n .: "gateway" <*> + n .: "type" + parseNetwork _ _ = error "network must be object" + parseJSON _ = error "network must be object" + +data Kernel = Kernel + { _krnId :: !T.Text + , _krnName :: !T.Text + , _krnVersion :: !T.Text + } deriving (Show, Eq) +makeLenses ''Kernel + +instance FromJSON Kernel where + parseJSON (Object x) = Kernel <$> + x .: "id" <*> + x .: "name" <*> + x .: "version" + parseJSON _ = error "kernel must be object" + +data Droplet = Droplet + { _drpId :: !Int + , _drpName :: !T.Text + , _drpMemory :: !Int + , _drpVCPUs :: !Int + , _drpDisk :: !Int + , _drpLocked :: !Bool + , _drpCreatedAt :: !T.Text + , _drpStatus :: !T.Text + , _drpBackupIds :: ![T.Text] + , _drpSnapshotIds :: ![T.Text] + , _drpFeatures :: ![T.Text] + , _drpRegion :: Region + , _drpImage :: Image + , _drpNetworks :: [Network] + , _drpKernel :: Kernel + } deriving (Show, Eq) +makeLenses ''Droplet + +instance FromJSON Droplet where + parseJSON (Object x) = Droplet <$> + x .: "id" <*> + x .: "name" <*> + x .: "memory" <*> + x .: "vcpus" <*> + x .: "disk" <*> + x .: "locked" <*> + x .: "created_at" <*> + x .: "status" <*> + x .: "backup_ids" <*> + x .: "snapshot_ids" <*> + x .: "features" <*> + x .: "region" <*> + x .: "image" <*> + x .: "networks" <*> + x .: "kernel" + parseJSON _ = error "droplet must be object" + +data Snapshot = Snapshot + { _snpId :: !Int + , _snpName :: !T.Text + , _snpDist :: !T.Text + , _snpSlug :: Maybe T.Text + , _snpPublic :: !Bool + , _snpRegions :: ![T.Text] + } deriving (Show, Eq) +makeLenses ''Snapshot + +instance FromJSON Snapshot where + parseJSON (Object x) = Snapshot <$> + x .: "id" <*> + x .: "name" <*> + x .: "dist" <*> + x .: "slug" <*> + x .: "public" <*> + x .: "regions" + parseJSON _ = error "snapshot must be object" + +data Backup = Backup + { _bckId :: !Int + , _bckName :: !T.Text + , _bckDist :: !T.Text + , _bckSlug :: Maybe T.Text + , _bckPublic :: !Bool + , _bckRegions :: ![T.Text] + } deriving (Show, Eq) +makeLenses ''Backup + +instance FromJSON Backup where + parseJSON (Object x) = Backup <$> + x .: "id" <*> + x .: "name" <*> + x .: "dist" <*> + x .: "slug" <*> + x .: "public" <*> + x .: "regions" + parseJSON _ = error "backup must be object" + +data DropletCreationOpts = DropletCreationOpts + { _dcoName :: !T.Text + , _dcoRegion :: !T.Text + , _dcoSize :: !T.Text + , _dcoImage :: !T.Text + , _dcoSSHKeys :: Maybe [T.Text] + , _dcoBackups :: !Bool + , _dcoIpv6 :: !Bool + , _dcoPrivateNetworking :: !Bool + , _dcoUserData :: Maybe T.Text + } deriving (Show, Eq) +makeLenses ''DropletCreationOpts + +instance ToJSON DropletCreationOpts where + toJSON d = object (base ++ catMaybes opts) + where base = [ "name" .= (d ^. dcoName) + , "region" .= (d ^. dcoRegion) + , "size" .= (d ^. dcoSize) + , "image" .= (d ^. dcoImage) + , "backups" .= (d ^. dcoBackups) + , "ipv6" .= (d ^. dcoIpv6) + , "private_networking" .= (d ^. dcoPrivateNetworking)] + opts = [ fmap ("user_data" .=) (d ^. dcoUserData) + , fmap ("ssh_keys" .=) (d ^. dcoSSHKeys) + ] + +-- | Creates a basic Droplet creation options object with ipv6 and private +-- networking enabled, and without backups, user data or ssh keys. +-- +-- Can and should be further modified before passing to 'createDroplet' +defaultDCO :: T.Text -> T.Text -> T.Text -> T.Text -> DropletCreationOpts +defaultDCO n r s i = DropletCreationOpts n r s i Nothing False True True Nothing + +dropletsEndpoint :: String +dropletsEndpoint = "/v2/droplets/" + +dropletEndpoint :: T.Text -> String +dropletEndpoint = (++) dropletsEndpoint . T.unpack + +createDroplet :: (Error e, MonadError e m, MonadIO m) => + DropletCreationOpts -> Config -> m Droplet +createDroplet = post dropletsEndpoint "droplet" + +getDroplet :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m Droplet +getDroplet n = get (dropletEndpoint n) "droplet" + +getDroplets ::(Error e, MonadError e m, MonadIO m) => + Config -> m [Droplet] +getDroplets = get dropletsEndpoint "droplets" + +getDropletKernels :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m [Kernel] +getDropletKernels n = get (dropletEndpoint n ++ "/kernels") "kernels" + +getDropletSnapshots :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m [Snapshot] +getDropletSnapshots n = get (dropletEndpoint n ++ "/snapshots") "snapshots" + +getDropletBackups :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m [Backup] +getDropletBackups n = get (dropletEndpoint n ++ "/backups") "backups" + +getDropletActions :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m [Action] +getDropletActions n = get (dropletEndpoint n ++ "/actions") "actions" + +deleteDroplet :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m () +deleteDroplet = delete . dropletEndpoint + +-- TODO: Get droplet upgrades returns a list... + +-- | The various actions that can be performed on a droplet +-- +-- +data DropletAction + = DisableBackups + | Reboot + | PowerCycle + | Shutdown + | PowerOff + | PowerOn + | Restore + | PasswordReset + | Resize !T.Text + | Rebuild !T.Text + | Rename !T.Text + | ChangeKernel !Int + | EnableIpv6 + | EnablePrivateNetworking + | SnapshotDrp !T.Text + | Upgrade + +mType :: T.Text -> [(T.Text, Value)] -> Value +mType t rst = toJSON . HM.fromList $ ("type", toJSON t):rst + +instance ToJSON DropletAction where + toJSON DisableBackups = mType "disable_backups" [] + toJSON Reboot = mType "reboot" [] + toJSON PowerCycle = mType "power_cycle" [] + toJSON Shutdown = mType "shutdown" [] + toJSON PowerOff = mType "power_off" [] + toJSON PowerOn = mType "power_on" [] + toJSON Restore = mType "restore" [] + toJSON PasswordReset = mType "password_reset" [] + toJSON (Resize s) = mType "resize" [("size", toJSON s)] + toJSON (Rebuild i) = mType "rebuild" [("image", toJSON i)] + toJSON (Rename n) = mType "rename" [("name", toJSON n)] + toJSON (ChangeKernel i) = mType "change_kernel" [("kernel", toJSON i)] + toJSON EnableIpv6 = mType "enable_ipv6" [] + toJSON EnablePrivateNetworking = mType "enable_private_networking" [] + toJSON (SnapshotDrp n) = mType "snapshot" [("snapshot", toJSON n)] + toJSON Upgrade = mType "migrate_droplet" [] + +-- | Perform an action on the droplet with the given ID +performDropletAction :: (Error e, MonadError e m, MonadIO m) => + T.Text -> DropletAction -> Config -> m Action +performDropletAction n = post (dropletEndpoint n ++ "/actions") "action" diff --git a/src/Net/DigitalOcean/Images.hs b/src/Net/DigitalOcean/Images.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Images.hs @@ -0,0 +1,116 @@ +module Net.DigitalOcean.Images ( + Image(..) + , getImages + , getDistributionImages + , getApplicationImages + , getImage + , renameImage + , deleteImage + , transferImage + + -- ** Lens Accessors + , imgId, imgName, imgDist, imgSlug, imgPublic, imgRegions, imgCreatedAt + , imgMinDiskSize + ) where +import qualified Data.Text as T +import qualified Data.Map as M +import qualified Network.Wreq as W +import Data.Aeson(FromJSON(..), Value(..), (.:)) +import Control.Applicative +import Control.Lens hiding (Action) + +import Control.Monad.IO.Class (MonadIO(..)) +import Control.Monad.Error.Class (MonadError, Error) + +import Net.DigitalOcean.Request (get, post, put, delete, handleResp) +import Net.DigitalOcean.Config (Config, options) +import Net.DigitalOcean.Actions (Action(..)) + +-- | A Digital Ocean image +data Image = Image + { _imgId :: !Int + , _imgName :: !T.Text + , _imgDist :: !T.Text + , _imgSlug :: Maybe T.Text + , _imgPublic :: !Bool + , _imgRegions :: ![T.Text] + , _imgCreatedAt :: !T.Text + , _imgMinDiskSize :: !Int + } deriving (Show, Eq) +makeLenses ''Image + +instance FromJSON Image where + parseJSON (Object x) = Image <$> + x .: "id" <*> + x .: "name" <*> + x .: "distribution" <*> + x .: "slug" <*> + x .: "public" <*> + x .: "regions" <*> + x .: "created_at" <*> + x .: "min_disk_size" + parseJSON _ = fail "image must be object" + +imagesEndpoint :: String +imagesEndpoint = "/v2/images/" + +imageEndpoint :: T.Text -> String +imageEndpoint = (++) imagesEndpoint . T.unpack + +actionEndpoint :: T.Text -> String +actionEndpoint n = imageEndpoint n ++ "/actions" + +-- | List all images availible to the account +-- +-- +getImages :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Image] +getImages = get imagesEndpoint "images" + +-- | List all distribution images availible to the account +-- +-- +getDistributionImages :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Image] +getDistributionImages c = liftIO (W.getWith opts imagesEndpoint) >>= handleResp "images" + where opts = options c & W.param "type" .~ ["distribution"] + +-- | List all application images availible to the account +-- +-- +getApplicationImages :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Image] +getApplicationImages c = liftIO (W.getWith opts imagesEndpoint) >>= handleResp "images" + where opts = options c & W.param "type" .~ ["application"] + +-- | Get the image with the given ID/slug +-- +-- +getImage :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m Image +getImage i = get (imageEndpoint i) "image" + +-- | Rename an image +-- +-- +renameImage :: (Error e, MonadError e m, MonadIO m) => + T.Text -> T.Text -> Config -> m Image +renameImage o n = put (imageEndpoint o) "image" body + where body :: M.Map T.Text T.Text + body = M.fromList [("name", n)] + +-- | Delete an image +-- +-- +deleteImage :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m () +deleteImage n = delete (imageEndpoint n) + +-- | Transfer an image to another region +-- +-- +transferImage :: (Error e, MonadError e m, MonadIO m) => + T.Text -> T.Text -> Config -> m Action +transferImage n r = post (actionEndpoint n) "action" body + where body :: M.Map T.Text T.Text + body = M.fromList [("type", "transfer"), ("region", r)] diff --git a/src/Net/DigitalOcean/Regions.hs b/src/Net/DigitalOcean/Regions.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Regions.hs @@ -0,0 +1,43 @@ +module Net.DigitalOcean.Regions ( + Region(..) + , getRegions + + -- ** Lens Accessors + , rgnName, rgnSlug, rgnSizes, rgnFeatures, rgnAvailable + ) where +import qualified Data.Text as T +import Data.Aeson(FromJSON(..), Value(..), (.:)) +import Control.Applicative +import Control.Lens hiding (Action) + +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.Error.Class (MonadError, Error) + +import Net.DigitalOcean.Request (get) +import Net.DigitalOcean.Config (Config) + +-- | A Digital Ocean region +data Region = Region + { _rgnName :: !T.Text + , _rgnSlug :: !T.Text + , _rgnSizes :: ![T.Text] + , _rgnFeatures :: ![T.Text] + , _rgnAvailable :: !Bool + } deriving (Show, Eq) +makeLenses ''Region + +instance FromJSON Region where + parseJSON (Object x) = Region <$> + x .: "name" <*> + x .: "slug" <*> + x .: "sizes" <*> + x .: "features" <*> + x .: "available" + parseJSON _ = fail "region must be object" + +-- | Returns a list of all the visible Digital Ocean regions +-- +-- +getRegions :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Region] +getRegions = get "/v2/regions/" "regions" diff --git a/src/Net/DigitalOcean/Request.hs b/src/Net/DigitalOcean/Request.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Request.hs @@ -0,0 +1,93 @@ + {-# LANGUAGE DeriveGeneric #-} +module Net.DigitalOcean.Request ( + -- | * Request wrappers + get, + post, + put, + delete, + + -- | * Lower level methods + handleResp, + url + ) where + +import qualified Data.Text as T +import qualified Network.Wreq as W +import Data.Aeson (FromJSON, parseJSON, Value(..), eitherDecode, ToJSON, toJSON) +import Data.Aeson.Types (parseEither) +import Data.HashMap.Strict as HM (lookup) +import GHC.Generics (Generic) +import Data.ByteString.Lazy (ByteString) +import Control.Lens +import Control.Monad (liftM) +import Control.Monad.Catch (catchAll) +import Control.Monad.IO.Class (MonadIO(..)) +import Control.Monad.Error.Class (MonadError(..), Error(..)) + +import Net.DigitalOcean.Config + +data ResponseError = ResponseError + { respErr :: String + , respDesc :: String + } deriving (Show, Eq, Generic) + +instance FromJSON ResponseError + +baseUrl :: String +baseUrl = "https://api.digitalocean.com" + +-- | Get the url for an endpoint +url :: String -> String +url = (++) baseUrl + +eitherToME :: (Show t, Error e, MonadError e m) => Either t a -> m a +eitherToME (Left e) = throwError . strMsg . show $ e +eitherToME (Right v) = return v + +ensureValidResponse :: (Error e, MonadError e m, MonadIO m) => + W.Response ByteString -> m () +ensureValidResponse r = + let sc = r ^. W.responseStatus . W.statusCode + in if 200 <= sc && sc < 300 + then return () + else do + let mErr :: IO ResponseError + mErr = (liftM (view W.responseBody) (W.asJSON r)) + err <- liftIO $ catchAll mErr (throwError . strMsg . show) + throwError . strMsg $ "Err: " ++ respErr err ++ "\nSC: " ++ show sc ++ "\nDesc: " ++ + respDesc err + +-- | Given a raw response, extract the json element "key", and then parse. +-- Also error should the status code != 2xx +handleResp :: (FromJSON a, Error e, MonadError e m, MonadIO m) => + String -> W.Response ByteString -> m a +handleResp key r = do + ensureValidResponse r + ast <- eitherToME . eitherDecode $ r ^. W.responseBody + case ast of + Object obj -> case HM.lookup (T.pack key) obj of + Just v -> eitherToME $ parseEither parseJSON v + Nothing -> throwError . strMsg $ "No key " ++ key ++ " in response" + _ -> throwError . strMsg $ "Response was not object" + +-- | Send a GET request to the given endpoint, and parse the result via 'handleResp' +get :: (FromJSON a, Error e, MonadError e m, MonadIO m) => + String -> String -> Config -> m a +get e k c = liftIO (W.getWith (options c) (url e)) >>= + handleResp k + +-- | Send a POST request to the given endpoint, and parse the result via 'handleResp' +post :: (ToJSON a, FromJSON b, Error e, MonadError e m, MonadIO m) => + String -> String -> a -> Config -> m b +post e k b c = liftIO (W.postWith (options c) (url e) (toJSON b)) >>= + handleResp k + +-- | Send a PUT request to the given endpoint, and parse the result via 'handleResp' +put :: (ToJSON a, FromJSON b, Error e, MonadError e m, MonadIO m) => + String -> String -> a -> Config -> m b +put e k b c = liftIO (W.putWith (options c) (url e) (toJSON b)) >>= + handleResp k + +-- | Send a DELETE request to the given endpoint, and parse the result via 'handleResp' +delete :: (Error e, MonadError e m, MonadIO m) => String -> Config -> m () +delete e c = liftIO (W.getWith (options c) (url e)) >>= ensureValidResponse diff --git a/src/Net/DigitalOcean/SSHKeys.hs b/src/Net/DigitalOcean/SSHKeys.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/SSHKeys.hs @@ -0,0 +1,88 @@ +module Net.DigitalOcean.SSHKeys ( + SSHKey(..) + + -- ** SSHKey Actions + , getSSHKeys + , getSSHKey + , createSSHKey + , renameSSHKey + , deleteSSHKey + + -- ** Lens Accessors + , keyId, keyFingerprint, keyPublicKey, keyName + ) where + +import qualified Data.Text as T +import Data.Aeson (FromJSON(..), (.:), Value(..)) +import GHC.Generics (Generic) +import Control.Lens +import Control.Applicative +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.Error.Class (MonadError, Error) +import qualified Data.Map as M + +import Net.DigitalOcean.Request (get, post, put, delete) +import Net.DigitalOcean.Config (Config) + +-- | An SSH public key stored by Digital Ocean +data SSHKey = SSHKey + { _keyId :: !Int + , _keyFingerprint :: !T.Text + , _keyPublicKey :: !T.Text + , _keyName :: !T.Text + } deriving (Show, Eq, Generic) + +makeLenses ''SSHKey + +instance FromJSON SSHKey where + parseJSON (Object x) = SSHKey <$> + x .: "id" <*> + x .: "fingerprint" <*> + x .: "public_key" <*> + x .: "name" + parseJSON _ = fail "SSHKey can be parsed only from Object" + +keysEndpoint :: String +keysEndpoint = "/v2/account/keys/" + +keyEndpoint :: T.Text -> String +keyEndpoint name = keysEndpoint ++ T.unpack name + +-- | Returns all SSH keys associated with the account +-- +-- +getSSHKeys :: (Error e, MonadError e m, MonadIO m) => + Config -> m [SSHKey] +getSSHKeys = get keysEndpoint "ssh_keys" + +-- | Returns the ssh key with the given id or fingerprint +-- +-- +getSSHKey :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m SSHKey +getSSHKey name = get (keyEndpoint name) "ssh_key" + +-- | Creates a new SSH key with the given name and contents +-- +-- +createSSHKey :: (Error e, MonadError e m, MonadIO m) => + T.Text -> T.Text -> Config -> m SSHKey +createSSHKey name key = post keysEndpoint "ssh_key" body + where body :: M.Map T.Text T.Text + body = M.fromList [("name", name), ("public_key", key)] + +-- | Renames an existing SSH key +-- +-- +renameSSHKey :: (Error e, MonadError e m, MonadIO m) => + T.Text -> T.Text -> Config -> m SSHKey +renameSSHKey old new = put (keyEndpoint old) "ssh_key" body + where body :: M.Map T.Text T.Text + body = M.fromList [("name", new)] + +-- | Deletes an SSH key +-- +-- +deleteSSHKey :: (Error e, MonadError e m, MonadIO m) => + T.Text -> Config -> m () +deleteSSHKey name = delete (keyEndpoint name) diff --git a/src/Net/DigitalOcean/Sizes.hs b/src/Net/DigitalOcean/Sizes.hs new file mode 100644 --- /dev/null +++ b/src/Net/DigitalOcean/Sizes.hs @@ -0,0 +1,56 @@ +module Net.DigitalOcean.Sizes ( + Size(..) + , getSizes + + -- * Lense Accessors + , szSlug + , szTransfer + , szPriceMonthly + , szPriceHourly + , szMemory + , szVCPUs + , szDisk + , szRegions + ) where +import qualified Data.Text as T +import Data.Aeson(FromJSON(..), Value(..), (.:)) +import Control.Applicative +import Control.Lens hiding (Action) + +import Control.Monad.IO.Class (MonadIO) +import Control.Monad.Error.Class (MonadError, Error) + +import Net.DigitalOcean.Request (get) +import Net.DigitalOcean.Config (Config) + +-- | A potential size of a Digital Ocean droplet +data Size = Size + { _szSlug :: !T.Text + , _szTransfer :: !Int + , _szPriceMonthly :: !Double + , _szPriceHourly :: !Double + , _szMemory :: !Int + , _szVCPUs :: !Int + , _szDisk :: !Int + , _szRegions :: ![T.Text] + } deriving (Show, Eq) +makeLenses ''Size + +instance FromJSON Size where + parseJSON (Object x) = Size <$> + x .: "slug" <*> + x .: "transfer" <*> + x .: "price_monthly" <*> + x .: "price_hourly" <*> + x .: "memory" <*> + x .: "vcpus" <*> + x .: "disk" <*> + x .: "regions" + parseJSON _ = fail "size must be object" + +-- | List all potential sizes +-- +-- +getSizes :: (Error e, MonadError e m, MonadIO m) => + Config -> m [Size] +getSizes = get "/v2/size/" "sizes" diff --git a/tests/Tests.hs b/tests/Tests.hs new file mode 100644 --- /dev/null +++ b/tests/Tests.hs @@ -0,0 +1,27 @@ +module Main where + +import qualified Net.DigitalOcean as DO +import qualified Data.Text as T +import Test.Hspec + +import Control.Lens +import Data.Char (isSpace) + +rstrip :: String -> String +rstrip = reverse . dropWhile isSpace . reverse + +getAuthToken :: IO String +getAuthToken = fmap rstrip $ readFile "./auth_token.txt" + +getConfig :: IO DO.Config +getConfig = fmap (DO.Config . T.pack) getAuthToken + +main :: IO () +main = do + c <- getConfig + putStrLn $ show c + hspec $ do + describe "SSHKeys.getSSHKeys" $ do + it "returns (at least) a key named milo" $ do + keys <- DO.getSSHKeys c + keys `shouldSatisfy` any (\k -> k ^. DO.keyName == "Milo")