re-structure post API, placeholder handlers

contributes to #41, #32

src/Hash2Pub/FediChordTypes.hs

@@ -607,7 +607,7 @@ data FediChordConf = FediChordConf
     -- ^ list of potential bootstrapping nodes
     , confBootstrapSamplingInterval :: Int
     -- ^ pause between sampling the own ID through bootstrap nodes, in seconds
-    , confMaxLookupCacheAge :: POSIXTime
+    , confMaxLookupCacheAge         :: POSIXTime
     -- ^ maximum age of lookup cache entries in seconds
     }
     deriving (Show, Eq)

src/Hash2Pub/PostService.hs

@@ -1,17 +1,60 @@
-{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DataKinds         #-}
-{-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeOperators     #-}
 
 module Hash2Pub.PostService where
 
-import Servant
+import           Data.Maybe (fromMaybe)
-import qualified Data.Text as Txt
+import qualified Data.Text  as Txt
 
-type ServiceAPI = "relay" :> "inbox" :> PostCreated '[PlainText] Txt.Text
+import           Servant
-             -- ^ delivery endpoint of new posts to relay 
+
-             :<|> "relay" :> "subscribers" :> Post '[PlainText] Txt.Text
+type PostServiceAPI = "relay" :> "inbox" :> ReqBody '[PlainText] Txt.Text :> PostCreated '[PlainText] Txt.Text
-             -- ^ endpoint for delivering the subscription and outstanding queue 
+                 -- ^ delivery endpoint of newly published posts of the relay's instance
-             :<|> "post" :> Capture "postid" Txt.Text :> Get '[PlainText] Txt.Text
+                 :<|> "relay" :> "subscribers" :> ReqBody '[PlainText] Txt.Text :> Post '[PlainText] Txt.Text
-             :<|> "tags" :> Capture "hashtag" Txt.Text :> PostCreated '[PlainText] Txt.Text
+                 -- ^ endpoint for delivering the subscriptions and outstanding queue
-             :<|> "tags" :> Capture "hashtag" Txt.Text :> "subscribe" :> Header "Origin" Txt.Text :> Get '[PlainText] Txt.Text
+                 :<|> "post" :> Capture "postid" Txt.Text :> Get '[PlainText] Txt.Text
-             :<|> "tags" :> Capture "hashtag" Txt.Text :> "unsubscribe" :> Header "Origin" Txt.Text :> Get '[PlainText] Txt.Text
+                 -- ^ fetch endpoint for posts, full post ID is http://$domain/post/$postid
+                 :<|> "posts" :> ReqBody '[PlainText] Txt.Text :> Post '[PlainText] Txt.Text
+                 -- ^ endpoint for fetching multiple posts at once
+                 :<|> "tags" :> Capture "hashtag" Txt.Text :> ReqBody '[PlainText] Txt.Text :> PostCreated '[PlainText] Txt.Text
+                 -- ^ delivery endpoint for posts of $tag at subscribing instance
+                 :<|> "tags" :> Capture "hashtag" Txt.Text :> "subscribe" :> Header "Origin" Txt.Text :> Get '[PlainText] Integer
+                 -- ^ endpoint for subscribing the instance specified in
+                 -- the Origin header to $hashtag.
+                 -- Returns subscription lease time in seconds.
+                 :<|> "tags" :> Capture "hashtag" Txt.Text :> "unsubscribe" :> Header "Origin" Txt.Text :> Get '[PlainText] Txt.Text
+                 -- ^ endpoint for unsubscribing the instance specified in
+                 -- the Origin header to $hashtag
+
+
+postServer :: Server PostServiceAPI
+postServer = relayInbox
+        :<|> subscriptionDelivery
+        :<|> postFetch
+        :<|> postMultiFetch
+        :<|> tagDelivery
+        :<|> tagSubscribe
+        :<|> tagUnsubscribe
+
+relayInbox :: Txt.Text -> Handler Txt.Text
+relayInbox post = pure $ "Here be InboxDragons with " <> post
+
+subscriptionDelivery :: Txt.Text -> Handler Txt.Text
+subscriptionDelivery subList = pure $ "Here be Subscription List dragons: " <> subList
+
+postFetch :: Txt.Text -> Handler Txt.Text
+postFetch postID = pure $ "Here be a post with dragon ID " <> postID
+
+postMultiFetch :: Txt.Text -> Handler Txt.Text
+postMultiFetch postIDs = pure $ "Here be multiple post dragons: "
+                      <> (Txt.unwords . Txt.lines $ postIDs)
+
+tagDelivery :: Txt.Text -> Txt.Text -> Handler Txt.Text
+tagDelivery hashtag posts = pure $ "Here be #" <> hashtag <> " dragons with " <> posts
+
+tagSubscribe :: Txt.Text -> Maybe Txt.Text -> Handler Integer
+tagSubscribe hashtag origin = pure 42
+
+tagUnsubscribe :: Txt.Text -> Maybe Txt.Text -> Handler Txt.Text
+tagUnsubscribe hashtag origin = pure $ "Here be a dragon unsubscription from " <> fromMaybe "Nothing" origin <> " to " <> hashtag