mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/src/API.hs

77 lines
2.4 KiB
Haskell
Raw Normal View History

Support a basic API Use Servant to create a REST API supporting the following routes: - GET /number - POST /other The server interacts with a SQLite database.
2020-07-24 20:00:29 +02:00
{-# LANGUAGE DataKinds #-}
Integrate Persistent with Servant Query my SQLite database from within my Servant handlers. Nothing I've written is domain-specific to the business logic yet -- I'm just making sure everything integrates.
2020-07-24 23:46:54 +02:00
{-# LANGUAGE TypeOperators #-}
Support a basic API Use Servant to create a REST API supporting the following routes: - GET /number - POST /other The server interacts with a SQLite database.
2020-07-24 20:00:29 +02:00
--------------------------------------------------------------------------------
module API where
--------------------------------------------------------------------------------
Integrate Persistent with Servant Query my SQLite database from within my Servant handlers. Nothing I've written is domain-specific to the business logic yet -- I'm just making sure everything integrates.
2020-07-24 23:46:54 +02:00
import Data.Text
import Servant.API
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
import Web.Cookie
Support a basic API Use Servant to create a REST API supporting the following routes: - GET /number - POST /other The server interacts with a SQLite database.
2020-07-24 20:00:29 +02:00
Integrate Persistent with Servant Query my SQLite database from within my Servant handlers. Nothing I've written is domain-specific to the business logic yet -- I'm just making sure everything integrates.
2020-07-24 23:46:54 +02:00
import qualified Types as T
Support a basic API Use Servant to create a REST API supporting the following routes: - GET /number - POST /other The server interacts with a SQLite database.
2020-07-24 20:00:29 +02:00
--------------------------------------------------------------------------------
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
-- | Once authenticated, users receive a SessionCookie.
Fully support login, logout Refactor my handlers to use the `Handler a` type instead of `IO a`; this allows me to throwError inside of handlers that Servant properly handles. Previously I was creating 500 errors unnecessarily.
2020-07-29 21:26:23 +02:00
type SessionCookie = Header' '[Required] "Cookie" T.SessionCookie
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
type API =
-- accounts: Create
"accounts"
Prevent non-admins from creating Manager or Admin accounts Client-side, I'm not exposing the role option to users. Server-side, I'm asserting that requests to create Manager and Admin accounts are attempted by users with a session tied to an admin account.
2020-08-01 12:48:55 +02:00
:> Header "Cookie" T.SessionCookie
Hash passwords when creating accounts TL;DR: - introduce the Cryptonite library - Remove the redundant language extensions, imports, deps from Persistent - Prefer NoContent return type for POST /accounts - Define custom {To,From}JSON instances for Role
2020-07-28 13:49:16 +02:00
:> ReqBody '[JSON] T.CreateAccountRequest
:> Post '[JSON] NoContent
Verify users' email addresses when they attempt to sign-up Lots of changes here: - Add the GET /verify endpoint - Email users a secret using MailGun - Create a PendingAccounts table and record type - Prefer do-notation for FromRow instances (and in general) instead of the <*> or a liftA2 style. Using instances using `<*>` makes the instances depend on the order in which the record's fields were defined. When combined with a "SELECT *", which returns the columns in whichever order the schema defines them (or depending on the DB implementation), produces runtime parse errors at best and silent errors at worst. - Delete bill from accounts.csv to free up the wpcarro@gmail.com when testing the /verify route.
2020-07-30 19:38:46 +02:00
:<|> "verify"
:> QueryParam' '[Required] "username" Text
Support POST /accept-invitation Allow users to accept invitations that we email to them. TL;DR: - I learned how to write FromHttpApiData instances, which allows me to parse/validate data at the edges of my application; this substantially cleans up my Handler code.
2020-08-02 17:30:28 +02:00
:> QueryParam' '[Required] "secret" T.RegistrationSecret
Verify users' email addresses when they attempt to sign-up Lots of changes here: - Add the GET /verify endpoint - Email users a secret using MailGun - Create a PendingAccounts table and record type - Prefer do-notation for FromRow instances (and in general) instead of the <*> or a liftA2 style. Using instances using `<*>` makes the instances depend on the order in which the record's fields were defined. When combined with a "SELECT *", which returns the columns in whichever order the schema defines them (or depending on the DB implementation), produces runtime parse errors at best and silent errors at worst. - Delete bill from accounts.csv to free up the wpcarro@gmail.com when testing the /verify route.
2020-07-30 19:38:46 +02:00
:> Get '[JSON] NoContent
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
-- accounts: Read
-- accounts: Update
-- accounts: Delete
:<|> "accounts"
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
:> SessionCookie
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
:> QueryParam' '[Required] "username" Text
:> Delete '[JSON] NoContent
-- accounts: List
:<|> "accounts"
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
:> SessionCookie
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
:> Get '[JSON] [T.User]
-- trips: Create
Partially support DELETE /trips Allow a user to delete a trip entry from the Trips table using the Primary Key. While this type-checks and compiles, it doesn't appear to be working as intended. Perhaps I should use an auto-incrementing integer as the Primary Key. I'm not sure how I want to handle this, so I'm punting for now.
2020-07-28 11:14:33 +02:00
:<|> "trips"
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
:> SessionCookie
Allow API users to create Trip entries Next up: - list trips - update existing trip entries - delete existing trip entries
2020-07-28 10:10:54 +02:00
:> ReqBody '[JSON] T.Trip
Prefer NoContent response to Bool When I first wrote this handler I wasn't aware of the NoContent response option.
2020-07-28 11:12:25 +02:00
:> Post '[JSON] NoContent
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
-- trips: Read
-- trips: Update
Support PATCH /trips Support a top-level PATCH request to trips that permits any admin to update any trip, and any user to update any of their trips. I'm using Aeson's (:?) combinator to support missing fields from the incoming JSON requests, and then M.fromMaybe to apply these values to any record that matches the primary key. See the TODOs that I introduced for some shortcomings.
2020-07-31 12:25:36 +02:00
:<|> "trips"
:> SessionCookie
:> ReqBody '[JSON] T.UpdateTripRequest
Prefer PUT to PATCH It was always a PUT. Nothing to see here, folks.
2020-07-31 19:29:22 +02:00
:> Put '[JSON] NoContent
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
-- trips: Delete
Partially support DELETE /trips Allow a user to delete a trip entry from the Trips table using the Primary Key. While this type-checks and compiles, it doesn't appear to be working as intended. Perhaps I should use an auto-incrementing integer as the Primary Key. I'm not sure how I want to handle this, so I'm punting for now.
2020-07-28 11:14:33 +02:00
:<|> "trips"
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
:> SessionCookie
Partially support DELETE /trips Allow a user to delete a trip entry from the Trips table using the Primary Key. While this type-checks and compiles, it doesn't appear to be working as intended. Perhaps I should use an auto-incrementing integer as the Primary Key. I'm not sure how I want to handle this, so I'm punting for now.
2020-07-28 11:14:33 +02:00
:> ReqBody '[JSON] T.TripPK
:> Delete '[JSON] NoContent
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
-- trips: List
:<|> "trips"
Protect GET /trips with a session cookie When an admin requests /trips, they see all of the trips in the Trips table. When a user requests /trips, they see only their trips.
2020-07-31 11:55:10 +02:00
:> SessionCookie
Distinguish b/w Account and User Additionally: supporting more CRUDL methods for the Accounts and Trips tables.
2020-07-28 11:57:15 +02:00
:> Get '[JSON] [T.Trip]
Support /login Support basic authentication. Note the TODOs that this commit introduces to track some of the remaining work.
2020-07-28 15:15:41 +02:00
-- Miscellaneous
:<|> "login"
:> ReqBody '[JSON] T.AccountCredentials
Return a JSON Session on a successful POST /login This will make the UX on a the client-side smoother.
2020-07-31 19:28:41 +02:00
:> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie] T.Session)
Support reading / writing cookies in API Update my API type and handler types to reflect which handlers read and write cookies. TODO: - Actually read from and write to Set-Cookie header - Returning `pure NoContent` breaks my types, so I'm returning `undefined` now
2020-07-29 15:14:47 +02:00
:<|> "logout"
:> SessionCookie
:> Get '[JSON] (Headers '[Header "Set-Cookie" SetCookie] NoContent)
Support POST /unfreeze Allow admins and managers to unfreeze accounts that we froze for security reasons.
2020-07-31 12:37:45 +02:00
:<|> "unfreeze"
:> SessionCookie
:> ReqBody '[JSON] T.UnfreezeAccountRequest
:> Post '[JSON] NoContent
Support POST /invite Allow Admin accounts to invite users to the application.
2020-08-02 17:07:35 +02:00
:<|> "invite"
:> SessionCookie
:> ReqBody '[JSON] T.InviteUserRequest
:> Post '[JSON] NoContent
Support POST /accept-invitation Allow users to accept invitations that we email to them. TL;DR: - I learned how to write FromHttpApiData instances, which allows me to parse/validate data at the edges of my application; this substantially cleans up my Handler code.
2020-08-02 17:30:28 +02:00
:<|> "accept-invitation"
:> ReqBody '[JSON] T.AcceptInvitationRequest
:> Get '[JSON] NoContent
Reference in a new issue Copy permalink