From 5894cae117a8524f3cc26d1519d7fadf463dabee Mon Sep 17 00:00:00 2001 From: Kazuma SATO Date: Thu, 25 Jun 2015 22:59:08 +0900 Subject: [PATCH] change tests to comments #1 --- src/DigitalOcean/Account.hs | 14 ++++++++------ src/DigitalOcean/Droplet.hs | 13 +++++++------ src/DigitalOcean/Image.hs | 26 ++++++++++++++------------ src/DigitalOcean/NewDroplet.hs | 34 +++++++++++++++++----------------- src/DigitalOcean/Region.hs | 13 +++++++------ src/DigitalOcean/SSHKey.hs | 13 +++++++------ src/DigitalOcean/Size.hs | 13 +++++++------ 7 files changed, 67 insertions(+), 59 deletions(-) diff --git a/src/DigitalOcean/Account.hs b/src/DigitalOcean/Account.hs index 438077c..fb74f34 100644 --- a/src/DigitalOcean/Account.hs +++ b/src/DigitalOcean/Account.hs @@ -41,13 +41,15 @@ instance FromJSON Account where parseJSON _ = mzero -- | Get User Information --- >>> :{ +-- Example: +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- mayBeAcnt <- account $ Authentication tkn --- print $ show $ isJust mayBeAcnt --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- mayBeAcnt <- account $ Authentication tkn +-- print $ show $ isJust mayBeAcnt +-- @ +-- account :: Authentication -> (MonadIO m) => m (Maybe Account) account a = liftM toAccount $ liftM decode (requestGet "account" a) diff --git a/src/DigitalOcean/Droplet.hs b/src/DigitalOcean/Droplet.hs index 49b563d..3f59bb4 100644 --- a/src/DigitalOcean/Droplet.hs +++ b/src/DigitalOcean/Droplet.hs @@ -52,13 +52,14 @@ instance FromJSON Droplet where -- | List all Droplets --- :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeDroplets <- droplets $ Authentication tkn --- print $ show $ isJust maybeDroplets --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeDroplets <- droplets $ Authentication tkn +-- print $ show $ isJust maybeDroplets +-- @ +-- droplets :: Authentication -> (MonadIO m) => m (Maybe [Droplet]) droplets a = liftM toList $ liftM decode (requestGet "droplets?page=1&per_page=100" a) diff --git a/src/DigitalOcean/Image.hs b/src/DigitalOcean/Image.hs index c36a7f7..a71d5c9 100644 --- a/src/DigitalOcean/Image.hs +++ b/src/DigitalOcean/Image.hs @@ -32,24 +32,26 @@ data Image = Image { } deriving(Show, Read) -- | List all Images --- >>> :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeImages <- images $ Authentication tkn --- print $ show $ isJust maybeImages --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeImages <- images $ Authentication tkn +-- print $ show $ isJust maybeImages +-- @ +-- images :: Authentication -> (MonadIO m) => m (Maybe [Image]) images a = liftM toList $ liftM decode (requestGet "images?page=1&per_page=1" a) -- | List all Distribution Images --- >>> :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeImages <- listAllDistributionImages $ Authentication tkn --- print $ show $ isJust maybeImages --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeImages <- listAllDistributionImages $ Authentication tkn +-- print $ show $ isJust maybeImages +-- @ +-- listAllDistributionImages :: Authentication -> (MonadIO m) => m (Maybe [Image]) listAllDistributionImages a = liftM toList $ liftM decode (requestGet "images?page=1&per_page=100&type=distribution" a) diff --git a/src/DigitalOcean/NewDroplet.hs b/src/DigitalOcean/NewDroplet.hs index 56f20f1..84f9a2f 100644 --- a/src/DigitalOcean/NewDroplet.hs +++ b/src/DigitalOcean/NewDroplet.hs @@ -52,24 +52,24 @@ instance FromJSON OuterDroplet where -- | create new Droplet --- :{ +-- +-- @ -- do --- let d = NewDropletRequest { --- ndname="hoge", --- region="nyc3", --- size="512mb", --- image=12241402, --- ndsshKeys=[], --- backups = False, --- ipv6=True, --- userData = Nothing, --- privateNetworking=False --- } --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeNewDroplet <- newDroplet ( Authentication tkn) d --- print $ show $ isJust maybeNewDroplet --- :} --- "True" +-- let d = NewDropletRequest { +-- ndname="hoge", +-- region="nyc3", +-- size="512mb", +-- image=12241402, +-- ndsshKeys=[], +-- backups = False, +-- ipv6=True, +-- userData = Nothing, +-- privateNetworking=False +-- } +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeNewDroplet <- newDroplet ( Authentication tkn) d +-- @ +-- newDroplet :: Authentication -> NewDropletRequest -> (MonadIO m) => m (Maybe Droplet) newDroplet a d = liftM toDroplet $ liftM decode (requestPost "droplets" a d) diff --git a/src/DigitalOcean/Region.hs b/src/DigitalOcean/Region.hs index aad1b64..9dd80cd 100644 --- a/src/DigitalOcean/Region.hs +++ b/src/DigitalOcean/Region.hs @@ -25,13 +25,14 @@ data Region = Region { -- | List all Regions --- >>> :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeRegions <- regions $ Authentication tkn --- print $ show $ isJust maybeRegions --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeRegions <- regions $ Authentication tkn +-- print $ show $ isJust maybeRegions +-- @ +-- regions :: Authentication -> (MonadIO m) => m (Maybe [Region]) regions a = liftM toList $ liftM decode (requestGet "regions" a) diff --git a/src/DigitalOcean/SSHKey.hs b/src/DigitalOcean/SSHKey.hs index d80eb58..213f68e 100644 --- a/src/DigitalOcean/SSHKey.hs +++ b/src/DigitalOcean/SSHKey.hs @@ -40,13 +40,14 @@ instance FromJSON SSHKey where parseJSON _ = mzero -- | List all Keys --- >>> :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeKeys <- listAllKeys $ Authentication tkn --- print $ show $ isJust maybeKeys --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeKeys <- listAllKeys $ Authentication tkn +-- print $ show $ isJust maybeKeys +-- @ +-- listAllKeys :: Authentication -> (MonadIO m) => m (Maybe [SSHKey]) listAllKeys a = liftM toList $ liftM decode (requestGet "account/keys" a) diff --git a/src/DigitalOcean/Size.hs b/src/DigitalOcean/Size.hs index 84019a8..3290952 100644 --- a/src/DigitalOcean/Size.hs +++ b/src/DigitalOcean/Size.hs @@ -35,13 +35,14 @@ instance FromJSON Sizes where parseJSON _ = mzero -- | List all Sizes --- >>> :{ +-- +-- @ -- do --- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" --- maybeSizes <- sizes $ Authentication tkn --- print $ show $ isJust maybeSizes --- :} --- "True" +-- tkn <- getEnv "DIGITAL_OCEAN_PERSONAL_ACCESS_TOKEN" +-- maybeSizes <- sizes $ Authentication tkn +-- print $ show $ isJust maybeSizes +-- @ +-- sizes :: Authentication -> (MonadIO m) => m (Maybe [Size]) sizes a = liftM toList $ liftM decode (requestGet "sizes" a)