summaryrefslogtreecommitdiffhomepage
path: root/HTTP.hs
blob: ac4eeabaca5f61693bff0e5c917fbec9b6b49cc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE TypeOperators #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}

{- Copyright 2016 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU AGPL version 3 or higher.
 -}

module HTTP where

import Types
import Types.Storage
import Serialization ()
import Raaz.Core.Encode
import Servant.API
import Data.Text
import Data.Aeson.Types
import GHC.Generics hiding (V1)
import qualified Data.Text.Encoding as T
import qualified Data.ByteString.Lazy as L

-- | Keysafe's http API
type HttpAPI = 
	"keysafe" :> "apiversion" :> Get '[JSON] APIVersion
	:<|> "keysafe" :> V1 :> "motd" :> Get '[JSON] Motd
	:<|> "keysafe" :> V1 :> "proofofwork" :> "requirement" 
		:> Get '[JSON] (Maybe ProofOfWorkRequirement)
	:<|> "keysafe" :> V1 :> "objects" :> ObjectIdent :> POWParam
		:> Get '[OctetStream] StorableObject
	:<|> "keysafe" :> V1 :> "objects" :> ObjectIdent :> POWParam
		:> ReqBody '[OctetStream] StorableObject
		:> Put '[JSON] StoreResult
	:<|> "keysafe" :> V1 :> "stats" :> "countobjects" :> POWParam
		:> Get '[JSON] CountResult

newtype APIVersion = APIVersion Int
	deriving (Generic)

type V1 = "v1"

newtype Motd = Motd Text
	deriving (Generic)

data ProofOfWorkRequirement = ProofOfWorkRequirement
	{ leadingZeros :: Int
	, argon2Iterations :: Int
	}
	deriving (Generic)

newtype ProofOfWork = ProofOfWork Text

type POWParam = QueryParam "proofofwork" ProofOfWork

type ObjectIdent = Capture "ident" StorableObjectIdent

instance ToJSON APIVersion
instance FromJSON APIVersion
instance ToJSON Motd
instance FromJSON Motd
instance ToJSON ProofOfWorkRequirement
instance FromJSON ProofOfWorkRequirement

instance FromHttpApiData ProofOfWork where
	parseUrlPiece = Right . ProofOfWork

instance FromHttpApiData StorableObjectIdent where
	parseUrlPiece = Right . StorableObjectIdent . T.encodeUtf8

instance MimeRender OctetStream StorableObject where
	mimeRender _ = L.fromStrict . toByteString

instance MimeUnrender OctetStream StorableObject where
	mimeUnrender _ = maybe (Left "object encoding error") Right 
		. fromByteString . L.toStrict