-- |
-- This provides a generic, framework-agnostic interface to routing.
-- If you have a 'RouteMap' (see "Web.Route.Invertible.Common"), make a 'Request' to describe an incoming request, and call 'lookupRoute' or 'routeRequest' to find the route.
-- See 'RouteRequest' for handling errors or the result.
--
-- You can also use 'requestActionRoute' to produce a 'Request' from a route endpoint.
module Web.Route.Invertible
  ( module Web.Route.Invertible.Common
  , normRoute
    -- * Request representation
  , HostString
  , PathString
  , normalizePath
  , Method(..)
  , IsMethod(..)
  , Request(..)
    -- * Forward routing
  , RouteResult(..)
  , lookupRoute
  , routeRequest
    -- * Reverse routing
  , requestActionRoute
  , (!:?)
  , requestBoundRoute
  ) where

import Control.Invertible.Monoidal
import Network.HTTP.Types.Header (ResponseHeaders)
import Network.HTTP.Types.Status (Status)

import Web.Route.Invertible.Parameter
import Web.Route.Invertible.Placeholder
import Web.Route.Invertible.Sequence
import Web.Route.Invertible.Host
import Web.Route.Invertible.Path
import Web.Route.Invertible.Method
import Web.Route.Invertible.Query
import Web.Route.Invertible.Route
import Web.Route.Invertible.Request
import Web.Route.Invertible.Result
import Web.Route.Invertible.Map.Route
import Web.Route.Invertible.Common

-- |Lookup a request in a routing table and transform errors to appropriate HTTP status and headers.
-- It is up to the user to provide an appropriate body (if any).
routeRequest :: Request -> RouteMap a -> Either (Status, ResponseHeaders) a
routeRequest q = routeResult . lookupRoute q