[#500] Trails: Modify endpoints to match requirements discussed today.

data61 · Jul 22, 2019 · fec715b · fec715b
1 parent 4ec6f8b
commit fec715b
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 25 deletions.
diff --git a/projects/trails/src/Mirza/Trails/API.hs b/projects/trails/src/Mirza/Trails/API.hs
@@ -4,7 +4,7 @@
 
 module Mirza.Trails.API where
 
-import           Mirza.Trails.Types (TrailEntryResponse)
+import           Mirza.Trails.Types (SignaturePlaceholder, TrailEntryResponse)
 
 import           Mirza.Common.Types (HealthResponse)
 
@@ -34,5 +34,6 @@ serverAPI = Proxy
 type PublicAPI =
        "healthz" :> Get '[JSON] HealthResponse
   :<|> "version" :> Get '[JSON] String
-  :<|> "trail"   :> Capture "eventId" EventId  :> Get '[JSON] [TrailEntryResponse]
-  :<|> "trail"   :> ReqBody '[JSON] TrailEntryResponse :> Post '[JSON] NoContent
+  :<|> "trail"   :> Capture "eventId"   EventId               :> Get '[JSON] [TrailEntryResponse]
+  :<|> "trail"   :> Capture "signature" SignaturePlaceholder  :> Get '[JSON] [TrailEntryResponse]
+  :<|> "trail"   :> ReqBody '[JSON] [TrailEntryResponse] :> Post '[JSON] NoContent
diff --git a/projects/trails/src/Mirza/Trails/Client/Servant.hs b/projects/trails/src/Mirza/Trails/Client/Servant.hs
@@ -3,7 +3,8 @@ module Mirza.Trails.Client.Servant
   -- * Public API
     health
   , versionInfo
-  , getTrail
+  , getTrailByEventId
+  , getTrailBySignature
   , addTrail
   ) where
 
@@ -23,8 +24,9 @@ import           Servant.Client
 
 health                :: ClientM HealthResponse
 versionInfo           :: ClientM String
-getTrail              :: EventId -> ClientM [TrailEntryResponse]
-addTrail              :: TrailEntryResponse -> ClientM NoContent
+getTrailByEventId     :: EventId -> ClientM [TrailEntryResponse]
+getTrailBySignature   :: SignaturePlaceholder -> ClientM [TrailEntryResponse]
+addTrail              :: [TrailEntryResponse] -> ClientM NoContent
 
 
 _api     :: Client ClientM ServerAPI
@@ -33,7 +35,8 @@ _api@(
   _pubAPI@(
          health
     :<|> versionInfo
-    :<|> getTrail
+    :<|> getTrailByEventId
+    :<|> getTrailBySignature
     :<|> addTrail
   )
  ) = client (Proxy :: Proxy ServerAPI)
diff --git a/projects/trails/src/Mirza/Trails/Handlers/Trails.hs b/projects/trails/src/Mirza/Trails/Handlers/Trails.hs
@@ -10,23 +10,36 @@ import           Data.GS1.EPC       (GS1CompanyPrefix (..))
 import           Data.GS1.EventId   (EventId (..))
 
 import           Data.Time.Clock
--- import           Data.UUID.V4
+import           Data.UUID.V4
 
 import           Servant
 
 
-getTrail :: EventId ->  AppM context err [TrailEntryResponse]
-getTrail (EventId uuid) = do
-                          time <- liftIO getCurrentTime
-                          --uuid1 <- liftIO nextRandom
-                          pure $ [ TrailEntryResponse 1
-                                        (EntryTime time)
-                                        (GS1CompanyPrefix "0000001")
-                                        (EventId uuid)
-                                        []
-                                        (SignaturePlaceholder "TODO")
-                                 ]
-
-
-addTrail :: TrailEntryResponse ->  AppM context err NoContent
+getTrailByEventId :: EventId ->  AppM context err [TrailEntryResponse]
+getTrailByEventId (EventId uuid) = do
+  time <- liftIO getCurrentTime
+  --uuid1 <- liftIO nextRandom
+  pure $ [ TrailEntryResponse 1
+                (EntryTime time)
+                (GS1CompanyPrefix "0000001")
+                (EventId uuid)
+                []
+                (SignaturePlaceholder "TODO")
+         ]
+
+
+getTrailBySignature :: SignaturePlaceholder ->  AppM context err [TrailEntryResponse]
+getTrailBySignature (SignaturePlaceholder sig) = do
+       time <- liftIO getCurrentTime
+       uuid <- liftIO nextRandom
+       pure $ [ TrailEntryResponse 1
+                     (EntryTime time)
+                     (GS1CompanyPrefix "0000002")
+                     (EventId uuid)
+                     []
+                     (SignaturePlaceholder sig)
+              ]
+
+
+addTrail :: [TrailEntryResponse] ->  AppM context err NoContent
 addTrail _ = pure NoContent
diff --git a/projects/trails/src/Mirza/Trails/Service.hs b/projects/trails/src/Mirza/Trails/Service.hs
@@ -50,7 +50,8 @@ publicServer :: ( Member context '[HasDB]
 publicServer =
        health
   :<|> versionInfo
-  :<|> getTrail
+  :<|> getTrailByEventId
+  :<|> getTrailBySignature
   :<|> addTrail
 
 

diff --git a/projects/trails/src/Mirza/Trails/Types.hs b/projects/trails/src/Mirza/Trails/Types.hs
@@ -19,7 +19,10 @@ import           Katip                      as K
 import           Data.Aeson                 (FromJSON (..), ToJSON (..), object,
                                              withObject, (.:), (.=))
 
-import           Data.Swagger               (ToSchema)
+import           Data.Swagger               (ToParamSchema, ToSchema)
+
+import           Servant                    (FromHttpApiData (..),
+                                             ToHttpApiData (..))
 
 import           Control.Lens               hiding ((.=))
 
@@ -127,7 +130,11 @@ instance FromJSON SignaturePlaceholder where
 instance ToJSON SignaturePlaceholder where
   toJSON = toJSON . getSignature
 instance ToSchema SignaturePlaceholder
-
+instance ToParamSchema SignaturePlaceholder
+instance FromHttpApiData SignaturePlaceholder where
+  parseUrlPiece t = SignaturePlaceholder <$> (parseUrlPiece t)
+instance ToHttpApiData SignaturePlaceholder where
+  toUrlPiece (SignaturePlaceholder sig) = toUrlPiece sig
 
 
 -- *****************************************************************************