DigitalOcean: A client library for the DigitalOcean API

[ agpl, library, network ] [ Propose Tags ] [ Report a vulnerability ]
Versions [RSS] 0.1.0.0, 0.1.1.0
Dependencies aeson, base (>=4.7 && <4.8), bytestring, containers, exceptions, lens, mtl, text (>=1.2.0.3 && <1.3), transformers, unordered-containers, vector, wreq [details]
License AGPL-3.0-only
Author Laurie Clark-Michalek
Maintainer lclarkmichalek@gmail.com
Category Network
Uploaded by lclarkmichalek at 2014-12-27T14:01:24Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 2036 total (3 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2014-12-27 [all 1 reports]

Readme for DigitalOcean-0.1.1.0

[back to package description]

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