servant-effectful (empty) → 1.0.0
raw patch · 10 files changed
+795/−0 lines, 10 filesdep +basedep +bytestringdep +effectfulsetup-changed
Dependencies added: base, bytestring, effectful, effectful-core, hspec-effectful, http-client-effectful, http-types, servant, servant-effectful, servant-server, transformers, wai-effectful, warp-effectful
Files
- CHANGELOG.md +12/−0
- LICENCE +287/−0
- Setup.hs +2/−0
- servant-effectful.cabal +86/−0
- src/Effectful/Servant.hs +83/−0
- src/Effectful/Servant/API.hs +17/−0
- src/Effectful/Servant/Server.hs +146/−0
- src/Effectful/Servant/Server/Generic.hs +80/−0
- src/Effectful/Servant/Server/StaticFiles.hs +28/−0
- test/Main.hs +54/−0
+ CHANGELOG.md view
@@ -0,0 +1,12 @@+# Changelog++All notable changes to this project will be documented in this file.++The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),+and this project adheres to the [Haskell Package Versioning Policy](https://pvp.haskell.org/).++## [1.0.0] - 2026-07-28++### Added++- Initial release.
+ LICENCE view
@@ -0,0 +1,287 @@+ EUROPEAN UNION PUBLIC LICENCE v. 1.2+ EUPL © the European Union 2007, 2016++This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined+below) which is provided under the terms of this Licence. Any use of the Work,+other than as authorised under this Licence is prohibited (to the extent such+use is covered by a right of the copyright holder of the Work).++The Work is provided under the terms of this Licence when the Licensor (as+defined below) has placed the following notice immediately following the+copyright notice for the Work:++ Licensed under the EUPL++or has expressed by any other means his willingness to license under the EUPL.++1. Definitions++In this Licence, the following terms have the following meaning:++- ‘The Licence’: this Licence.++- ‘The Original Work’: the work or software distributed or communicated by the+ Licensor under this Licence, available as Source Code and also as Executable+ Code as the case may be.++- ‘Derivative Works’: the works or software that could be created by the+ Licensee, based upon the Original Work or modifications thereof. This Licence+ does not define the extent of modification or dependence on the Original Work+ required in order to classify a work as a Derivative Work; this extent is+ determined by copyright law applicable in the country mentioned in Article 15.++- ‘The Work’: the Original Work or its Derivative Works.++- ‘The Source Code’: the human-readable form of the Work which is the most+ convenient for people to study and modify.++- ‘The Executable Code’: any code which has generally been compiled and which is+ meant to be interpreted by a computer as a program.++- ‘The Licensor’: the natural or legal person that distributes or communicates+ the Work under the Licence.++- ‘Contributor(s)’: any natural or legal person who modifies the Work under the+ Licence, or otherwise contributes to the creation of a Derivative Work.++- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of+ the Work under the terms of the Licence.++- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,+ renting, distributing, communicating, transmitting, or otherwise making+ available, online or offline, copies of the Work or providing access to its+ essential functionalities at the disposal of any other natural or legal+ person.++2. Scope of the rights granted by the Licence++The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,+sublicensable licence to do the following, for the duration of copyright vested+in the Original Work:++- use the Work in any circumstance and for all usage,+- reproduce the Work,+- modify the Work, and make Derivative Works based upon the Work,+- communicate to the public, including the right to make available or display+ the Work or copies thereof to the public and perform publicly, as the case may+ be, the Work,+- distribute the Work or copies thereof,+- lend and rent the Work or copies thereof,+- sublicense rights in the Work or copies thereof.++Those rights can be exercised on any media, supports and formats, whether now+known or later invented, as far as the applicable law permits so.++In the countries where moral rights apply, the Licensor waives his right to+exercise his moral right to the extent allowed by law in order to make effective+the licence of the economic rights here above listed.++The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to+any patents held by the Licensor, to the extent necessary to make use of the+rights granted on the Work under this Licence.++3. Communication of the Source Code++The Licensor may provide the Work either in its Source Code form, or as+Executable Code. If the Work is provided as Executable Code, the Licensor+provides in addition a machine-readable copy of the Source Code of the Work+along with each copy of the Work that the Licensor distributes or indicates, in+a notice following the copyright notice attached to the Work, a repository where+the Source Code is easily and freely accessible for as long as the Licensor+continues to distribute or communicate the Work.++4. Limitations on copyright++Nothing in this Licence is intended to deprive the Licensee of the benefits from+any exception or limitation to the exclusive rights of the rights owners in the+Work, of the exhaustion of those rights or of other applicable limitations+thereto.++5. Obligations of the Licensee++The grant of the rights mentioned above is subject to some restrictions and+obligations imposed on the Licensee. Those obligations are the following:++Attribution right: The Licensee shall keep intact all copyright, patent or+trademarks notices and all notices that refer to the Licence and to the+disclaimer of warranties. The Licensee must include a copy of such notices and a+copy of the Licence with every copy of the Work he/she distributes or+communicates. The Licensee must cause any Derivative Work to carry prominent+notices stating that the Work has been modified and the date of modification.++Copyleft clause: If the Licensee distributes or communicates copies of the+Original Works or Derivative Works, this Distribution or Communication will be+done under the terms of this Licence or of a later version of this Licence+unless the Original Work is expressly distributed only under this version of the+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee+(becoming Licensor) cannot offer or impose any additional terms or conditions on+the Work or Derivative Work that alter or restrict the terms of the Licence.++Compatibility clause: If the Licensee Distributes or Communicates Derivative+Works or copies thereof based upon both the Work and another work licensed under+a Compatible Licence, this Distribution or Communication can be done under the+terms of this Compatible Licence. For the sake of this clause, ‘Compatible+Licence’ refers to the licences listed in the appendix attached to this Licence.+Should the Licensee's obligations under the Compatible Licence conflict with+his/her obligations under this Licence, the obligations of the Compatible+Licence shall prevail.++Provision of Source Code: When distributing or communicating copies of the Work,+the Licensee will provide a machine-readable copy of the Source Code or indicate+a repository where this Source will be easily and freely available for as long+as the Licensee continues to distribute or communicate the Work.++Legal Protection: This Licence does not grant permission to use the trade names,+trademarks, service marks, or names of the Licensor, except as required for+reasonable and customary use in describing the origin of the Work and+reproducing the content of the copyright notice.++6. Chain of Authorship++The original Licensor warrants that the copyright in the Original Work granted+hereunder is owned by him/her or licensed to him/her and that he/she has the+power and authority to grant the Licence.++Each Contributor warrants that the copyright in the modifications he/she brings+to the Work are owned by him/her or licensed to him/her and that he/she has the+power and authority to grant the Licence.++Each time You accept the Licence, the original Licensor and subsequent+Contributors grant You a licence to their contributions to the Work, under the+terms of this Licence.++7. Disclaimer of Warranty++The Work is a work in progress, which is continuously improved by numerous+Contributors. It is not a finished work and may therefore contain defects or+‘bugs’ inherent to this type of development.++For the above reason, the Work is provided under the Licence on an ‘as is’ basis+and without warranties of any kind concerning the Work, including without+limitation merchantability, fitness for a particular purpose, absence of defects+or errors, accuracy, non-infringement of intellectual property rights other than+copyright as stated in Article 6 of this Licence.++This disclaimer of warranty is an essential part of the Licence and a condition+for the grant of any rights to the Work.++8. Disclaimer of Liability++Except in the cases of wilful misconduct or damages directly caused to natural+persons, the Licensor will in no event be liable for any direct or indirect,+material or moral, damages of any kind, arising out of the Licence or of the use+of the Work, including without limitation, damages for loss of goodwill, work+stoppage, computer failure or malfunction, loss of data or any commercial+damage, even if the Licensor has been advised of the possibility of such damage.+However, the Licensor will be liable under statutory product liability laws as+far such laws apply to the Work.++9. Additional agreements++While distributing the Work, You may choose to conclude an additional agreement,+defining obligations or services consistent with this Licence. However, if+accepting obligations, You may act only on your own behalf and on your sole+responsibility, not on behalf of the original Licensor or any other Contributor,+and only if You agree to indemnify, defend, and hold each Contributor harmless+for any liability incurred by, or claims asserted against such Contributor by+the fact You have accepted any warranty or additional liability.++10. Acceptance of the Licence++The provisions of this Licence can be accepted by clicking on an icon ‘I agree’+placed under the bottom of a window displaying the text of this Licence or by+affirming consent in any other similar way, in accordance with the rules of+applicable law. Clicking on that icon indicates your clear and irrevocable+acceptance of this Licence and all of its terms and conditions.++Similarly, you irrevocably accept this Licence and all of its terms and+conditions by exercising any rights granted to You by Article 2 of this Licence,+such as the use of the Work, the creation by You of a Derivative Work or the+Distribution or Communication by You of the Work or copies thereof.++11. Information to the public++In case of any Distribution or Communication of the Work by means of electronic+communication by You (for example, by offering to download the Work from a+remote location) the distribution channel or media (for example, a website) must+at least provide to the public the information requested by the applicable law+regarding the Licensor, the Licence and the way it may be accessible, concluded,+stored and reproduced by the Licensee.++12. Termination of the Licence++The Licence and the rights granted hereunder will terminate automatically upon+any breach by the Licensee of the terms of the Licence.++Such a termination will not terminate the licences of any person who has+received the Work from the Licensee under the Licence, provided such persons+remain in full compliance with the Licence.++13. Miscellaneous++Without prejudice of Article 9 above, the Licence represents the complete+agreement between the Parties as to the Work.++If any provision of the Licence is invalid or unenforceable under applicable+law, this will not affect the validity or enforceability of the Licence as a+whole. Such provision will be construed or reformed so as necessary to make it+valid and enforceable.++The European Commission may publish other linguistic versions or new versions of+this Licence or updated versions of the Appendix, so far this is required and+reasonable, without reducing the scope of the rights granted by the Licence. New+versions of the Licence will be published with a unique version number.++All linguistic versions of this Licence, approved by the European Commission,+have identical value. Parties can take advantage of the linguistic version of+their choice.++14. Jurisdiction++Without prejudice to specific agreement between parties,++- any litigation resulting from the interpretation of this License, arising+ between the European Union institutions, bodies, offices or agencies, as a+ Licensor, and any Licensee, will be subject to the jurisdiction of the Court+ of Justice of the European Union, as laid down in article 272 of the Treaty on+ the Functioning of the European Union,++- any litigation arising between other parties and resulting from the+ interpretation of this License, will be subject to the exclusive jurisdiction+ of the competent court where the Licensor resides or conducts its primary+ business.++15. Applicable Law++Without prejudice to specific agreement between parties,++- this Licence shall be governed by the law of the European Union Member State+ where the Licensor has his seat, resides or has his registered office,++- this licence shall be governed by Belgian law if the Licensor has no seat,+ residence or registered office inside a European Union Member State.++Appendix++‘Compatible Licences’ according to Article 5 EUPL are:++- GNU General Public License (GPL) v. 2, v. 3+- GNU Affero General Public License (AGPL) v. 3+- Open Software License (OSL) v. 2.1, v. 3.0+- Eclipse Public License (EPL) v. 1.0+- CeCILL v. 2.0, v. 2.1+- Mozilla Public Licence (MPL) v. 2+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for+ works other than software+- European Union Public Licence (EUPL) v. 1.1, v. 1.2+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong+ Reciprocity (LiLiQ-R+).++The European Commission may update this Appendix to later versions of the above+licences without producing a new version of the EUPL, as long as they provide+the rights granted in Article 2 of this Licence and protect the covered Source+Code from exclusive appropriation.++All other changes or additions to this Appendix require the production of a new+EUPL version.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ servant-effectful.cabal view
@@ -0,0 +1,86 @@+cabal-version: 3.0+name: servant-effectful+version: 1.0.0+synopsis: Effectful bindings for the Servant library+description:+ Adaptation of the @<https://hackage.haskell.org/package/servant Servant>@ library for the @<https://hackage.haskell.org/package/effectful effectful>@ ecosystem.++homepage: https://digital-autonomy.institute+license: EUPL-1.2+license-file: LICENCE+author: IDA+maintainer: IDA+bug-reports: https://issues.digital-autonomy.institute+category: Network+build-type: Simple+extra-doc-files:+ CHANGELOG.md++common common+ default-language: Haskell2010+ ghc-options:+ -Weverything+ -Wno-unsafe+ -Wno-missing-safe-haskell-mode+ -Wno-missing-export-lists+ -Wno-missing-import-lists+ -Wno-missing-kind-signatures+ -Wno-all-missed-specialisations+ -Wno-missing-role-annotations++ default-extensions:+ BlockArguments+ ConstraintKinds+ DataKinds+ DeriveGeneric+ DerivingStrategies+ DerivingVia+ ExplicitNamespaces+ FlexibleContexts+ ImportQualifiedPost+ LambdaCase+ NoImplicitPrelude+ OverloadedStrings+ PatternSynonyms+ PolyKinds+ RankNTypes+ RecordWildCards+ ScopedTypeVariables+ TypeApplications+ TypeFamilies+ TypeOperators+ ViewPatterns++ build-depends:+ base >=4.10 && <5,+ bytestring >=0.12 && <0.13,+ effectful >=2.6 && <2.7,+ wai-effectful >=1.0 && <1.1,++library+ import: common+ hs-source-dirs: src+ exposed-modules:+ Effectful.Servant+ Effectful.Servant.API+ Effectful.Servant.Server+ Effectful.Servant.Server.Generic+ Effectful.Servant.Server.StaticFiles++ build-depends:+ effectful-core >=2 && <3,+ servant >=0.20 && <0.21,+ servant-server >=0.20 && <0.21,+ transformers >=0.4 && <0.7,++test-suite test+ import: common+ type: exitcode-stdio-1.0+ hs-source-dirs: test+ main-is: Main.hs+ build-depends:+ hspec-effectful >=1.0 && <1.2,+ http-client-effectful >=1.0 && <1.1,+ http-types >=0.12 && <0.13,+ servant-effectful,+ warp-effectful >=1.0 && <1.1,
+ src/Effectful/Servant.hs view
@@ -0,0 +1,83 @@+{-# LANGUAGE Trustworthy #-}++-- |+-- Module : Effectful.servant+-- Copyright : (c) 2026 Institute for Digital Autonomy+-- License : EUPL-1.2+-- Maintainer : IDA+--+-- This library provides @<http://hackage.haskell.org/package/servant-server servant-server>@+-- runners built on top of @<http://hackage.haskell.org/package/wai-effectful wai-effectful>@.+--+-- Servant and Effectful use the @:>@ type operator for different purposes.+-- This library introduces the ':/' operator as an alias to Servant's ':>' operator.+--+-- = Example usage+--+-- Define your API using standard Servant types.+-- Note the use of the ':/' type operator instead of Servant's ':>':+--+-- > type API = NamedRoutes NamedAPI+-- >+-- > data NamedAPI (mode :: Type) = NamedAPI+-- > { helloAPI :: mode :- NamedRoutes HelloAPI+-- > , handleCount :: mode :- "count" :/ Get '[JSON] Int+-- > }+-- > deriving stock (Generic)+-- >+-- > data HelloAPI (mode :: Type) = HelloAPI+-- > { hello :: mode :- Get '[PlainText] String+-- > , namedHello :: mode :- Capture "name" String :/ Get '[PlainText] String+-- > }+-- > deriving stock (Generic)+--+-- Use the 'Handler' type to implement handlers.+-- Note the use of the ':>' type operator for effects:+--+-- > server :: forall es. (State Int :> es) => NamedAPI (AsServer es)+-- > server =+-- > NamedAPI+-- > { helloAPI = HelloAPI{..}+-- > , handleCount = State.get+-- > }+-- > where+-- > hello :: Handler es String+-- > hello = State.modify @Int succ >> pure "Hello!"+-- >+-- > namedHello :: String -> Handler es String+-- > namedHello "teapot" = throwError err418+-- > namedHello name = do+-- > State.modify @Int succ+-- > pure $ "Hello, " <> name <> "!"+--+-- Call one of the 'serve' functions to convert the server to a wai 'Application':+--+-- > app :: (IOE :> es) => Application es+-- > app = serve @API Proxy server+--+-- Finally, run the 'Application' using+-- @<http://hackage.haskell.org/package/warp-effectful warp-effectful>@:+--+-- > main :: IO ()+-- > main = runEff . Warp.run 3000 $ app+module Effectful.Servant+ ( -- * Defining APIs+ module Effectful.Servant.API++ -- * Implementing servers for APIs+ , module Effectful.Servant.Server++ -- * Serving static files+ , module Effectful.Servant.Server.StaticFiles++ -- * Useful re-exports+ , module Data.Proxy+ , module Effectful.Error.Static+ )+where++import Data.Proxy (Proxy (..))+import Effectful.Error.Static (throwError)+import Effectful.Servant.API+import Effectful.Servant.Server+import Effectful.Servant.Server.StaticFiles
+ src/Effectful/Servant/API.hs view
@@ -0,0 +1,17 @@+{-# OPTIONS_GHC -Wno-unused-imports #-}++module Effectful.Servant.API+ ( module Effectful.Servant.API+ , module Servant.API+ )+where++import Data.Kind (Type)+import Effectful qualified+import Servant.API hiding ((:>))+import Servant.API qualified as Servant++-- | Convenience alias to disambiguate Servant's 'Servant.:>' from Effectful's 'Effectful.:>'.+type (path :: k) :/ (a :: Type) = path Servant.:> a++infixr 4 :/
+ src/Effectful/Servant/Server.hs view
@@ -0,0 +1,146 @@+module Effectful.Servant.Server+ ( -- * Run a wai application from an API+ serve+ , serveWithContext+ , serveWithContextT+ , ServerContext++ -- * Handlers for all standard combinators+ , HasServer (..)+ , Server+ , EmptyServer+ , emptyServer+ , Handler++ -- * Context+ , Context (..)+ , HasContextEntry (getContextEntry)+ , type (.++)+ , (.++)++ -- ** NamedContext+ , NamedContext (..)+ , descendIntoNamedContext++ -- * Basic Authentication+ , BasicAuthCheck (BasicAuthCheck, unBasicAuthCheck)+ , BasicAuthResult (..)++ -- * Default error type+ , ServerError (..)++ -- ** 3XX+ , err300+ , err301+ , err302+ , err303+ , err304+ , err305+ , err307++ -- ** 4XX+ , err400+ , err401+ , err402+ , err403+ , err404+ , err405+ , err406+ , err407+ , err409+ , err410+ , err411+ , err412+ , err413+ , err414+ , err415+ , err416+ , err417+ , err418+ , err422+ , err429++ -- ** 5XX+ , err500+ , err501+ , err502+ , err503+ , err504+ , err505+ )+where++import Control.Monad.Trans.Except (ExceptT (ExceptT))+import Data.Kind (Type)+import Data.Proxy (Proxy)+import Effectful+import Effectful.Error.Static (Error, runErrorNoCallStack)+import Effectful.Wai (Application, liftApplication)+import Servant.Server hiding+ ( Application+ , Handler+ , Server+ , respond+ , serve+ , serveWithContext+ , serveWithContextT+ )+import Servant.Server qualified as Servant+import Prelude++-- | Lifted 'Servant.Handler'.+type Handler (es :: [Effect]) = Eff (Error ServerError ': es)++-- | Lifted 'Servant.Server'.+type Server (api :: Type) (es :: [Effect]) = ServerT api (Handler es)++-- | Lifted 'Servant.serve'.+serve+ :: ( HasServer api ('[] :: [Type])+ , IOE :> es+ )+ => Proxy api+ -> Server api es+ -> Application es+serve p = serveWithContext p EmptyContext++-- | Lifted 'Servant.serveWithContext'.+serveWithContext+ :: ( HasServer api context+ , ServerContext context+ , IOE :> es+ )+ => Proxy api+ -> Context context+ -> Server api es+ -> Application es+serveWithContext p context = serveWithContextT p context id++-- | Lifted 'Servant.serveWithContextT'.+serveWithContextT+ :: ( HasServer api context+ , ServerContext context+ , IOE :> es+ )+ => Proxy api+ -> Context context+ -> (forall a. m a -> Handler es a)+ -> ServerT api m+ -> Application es+serveWithContextT p context toHandler server req respond =+ withEffToIO SeqUnlift \unlift ->+ unlift $+ liftApplication+ ( Servant.serveWithContextT+ p+ context+ ( Servant.Handler+ . ExceptT+ . unlift+ . runErrorNoCallStack+ . toHandler+ )+ server+ )+ req+ respond
+ src/Effectful/Servant/Server/Generic.hs view
@@ -0,0 +1,80 @@+module Effectful.Servant.Server.Generic+ ( module Effectful.Servant.Server.Generic+ , module Servant.Server.Generic+ )+where++import Data.Kind (Type)+import Data.Proxy (Proxy (..))+import Effectful+import Effectful.Servant.API+import Effectful.Servant.Server+import Effectful.Wai (Application)+import Servant+ ( DefaultErrorFormatters+ , ErrorFormatters+ , hoistServer+ )+import Servant.Server.Generic (AsServerT, genericServerT)+import Servant.Server.Generic qualified as Servant+import Prelude++type AsServer (es :: [Effect]) = AsServerT (Handler es)++-- | Lifted 'Servant.genericServe'.+genericServe+ :: forall (routes :: Type -> Type) (es :: [Effect])+ . ( HasServer (ToServantApi routes) '[]+ , GenericServant routes (AsServer es)+ , Server (ToServantApi routes) es ~ ToServant routes (AsServer es)+ , IOE :> es+ )+ => routes (AsServer es) -> Application es+genericServe = serve @(ToServantApi routes) Proxy . genericServer++-- | Lifted 'Servant.genericServeT'.+genericServeT+ :: forall (routes :: Type -> Type) (m :: Type -> Type) (es :: [Effect])+ . ( GenericServant routes (AsServerT m)+ , HasServer (ToServantApi routes) '[]+ , ServerT (ToServantApi routes) m ~ ToServant routes (AsServerT m)+ , IOE :> es+ )+ => (forall a. m a -> Handler es a)+ -- ^ 'hoistServer' argument to come back to 'Handler'+ -> routes (AsServerT m)+ -- ^ your record full of request handlers+ -> Application es+genericServeT f server = serve p $ hoistServer p f (Servant.genericServerT server)+ where+ p = Proxy @(ToServantApi routes)++-- | Lifted 'Servant.genericServeTWithContext'.+genericServeTWithContext+ :: forall (routes :: Type -> Type) (m :: Type -> Type) (ctx :: [Type]) (es :: [Effect])+ . ( GenericServant routes (AsServerT m)+ , HasServer (ToServantApi routes) ctx+ , HasContextEntry (ctx .++ DefaultErrorFormatters) ErrorFormatters+ , ServerT (ToServantApi routes) m ~ ToServant routes (AsServerT m)+ , IOE :> es+ )+ => (forall a. m a -> Handler es a)+ -- ^ 'hoistServer' argument to come back to 'Handler'+ -> routes (AsServerT m)+ -- ^ your record full of request handlers+ -> Context ctx+ -- ^ the 'Context' to serve the application with+ -> Application es+genericServeTWithContext f server ctx =+ serveWithContext p ctx $+ hoistServerWithContext p pctx f (Servant.genericServerT server)+ where+ p = Proxy @(ToServantApi routes)+ pctx = Proxy @ctx++-- | Lifted 'Servant.genericServer'.+genericServer+ :: (GenericServant routes (AsServer es))+ => routes (AsServer es)+ -> ToServant routes (AsServer es)+genericServer = toServant
+ src/Effectful/Servant/Server/StaticFiles.hs view
@@ -0,0 +1,28 @@+{-# OPTIONS_GHC -Wno-redundant-constraints #-}++module Effectful.Servant.Server.StaticFiles+ ( serveDirectoryWebApp+ , serveDirectoryFileServer+ , serveDirectoryEmbedded+ )+where++import Data.ByteString (ByteString)+import Effectful ((:>))+import Effectful.FileSystem (FileSystem)+import Effectful.Servant.API (Raw)+import Effectful.Servant.Server (Server)+import Servant.Server.StaticFiles qualified as Servant+import Prelude++-- | Lifted 'Servant.serveDirectoryWebApp'.+serveDirectoryWebApp :: (FileSystem :> es) => FilePath -> Server Raw es+serveDirectoryWebApp = Servant.serveDirectoryWebApp++-- | Lifted 'Servant.serveDirectoryFileServer'.+serveDirectoryFileServer :: (FileSystem :> es) => FilePath -> Server Raw es+serveDirectoryFileServer = Servant.serveDirectoryFileServer++-- | Lifted 'Servant.serveDirectoryEmbedded'.+serveDirectoryEmbedded :: [(FilePath, ByteString)] -> Server Raw es+serveDirectoryEmbedded = Servant.serveDirectoryEmbedded
+ test/Main.hs view
@@ -0,0 +1,54 @@+module Main where++import Data.ByteString.Lazy (LazyByteString)+import Data.Kind (Type)+import Effectful+import Effectful.Hspec+import Effectful.HttpClient hiding (Proxy)+import Effectful.Servant+import Effectful.Servant.Server.Generic (AsServer)+import Effectful.Wai (Application)+import Effectful.Wai.Handler.Warp (Port, withApplication)+import GHC.Generics (Generic)+import Network.HTTP.Types qualified as HTTP+import Prelude++type API = NamedRoutes NamedAPI++data NamedAPI (mode :: Type) = NamedAPI+ { hello :: mode :- Get '[PlainText] String+ , helloNamed :: mode :- Capture "name" String :/ Get '[PlainText] String+ }+ deriving stock (Generic)++server :: NamedAPI (AsServer es)+server = NamedAPI{..}+ where+ hello :: Handler es String+ hello = pure "Hello!"++ helloNamed :: String -> Handler es String+ helloNamed "teapot" = throwError err418+ helloNamed name = pure $ "Hello, " <> name <> "!"++app :: (IOE :> es) => Application es+app = serve @API Proxy server++get :: (HttpClient :> es) => String -> Port -> Eff es (Response LazyByteString)+get path port = do+ req <- parseRequest $ "http://127.0.0.1:" <> show port <> path+ httpLbs req{requestHeaders = [("Connection", "close")]}++main :: IO ()+main = runEff . runHttpClient . runHspec . describe "Servant" $ do+ it "says hello" do+ resp <- withApplication (pure app) (get "/")+ responseBody resp `shouldBe` "Hello!"++ it "says hello to Ueli" do+ resp <- withApplication (pure app) (get "/Ueli")+ responseBody resp `shouldBe` "Hello, Ueli!"++ it "is a teapot" do+ resp <- withApplication (pure app) (get "/teapot")+ responseStatus resp `shouldBe` HTTP.status418