git.iko.soy/typeable/servant
on b17c8bb help sign in
b3279d9
swap
0 ahead, 447 behind
272 files changed+2197−13084
since splitsnapshots
unifiedsplit
.github/FUNDING.yml−12 .github/run-ghcjs-tests.sh−14 .github/workflows/master.yml−147 .gitignore−6 .travis.yml+220 CONTRIBUTING.md+4−33 Makefile+22 README.md+16−26 cabal.ghcjs.project+1−6 cabal.haskell-ci+16 cabal.project+26−23 changelog.d/1432−9 changelog.d/1469−11 changelog.d/1477−9 changelog.d/1529−10 changelog.d/1556−81 changelog.d/1569−13 changelog.d/1580−12 changelog.d/1589−2 changelog.d/1595−2 changelog.d/config−2 changelog.d/servant-docs-curl−16 default.nix−38 doc/Makefile+1−1 doc/conf.py+2−1 doc/cookbook/basic-auth/basic-auth.cabal+4−4 doc/cookbook/basic-streaming/Streaming.lhs+1−4 doc/cookbook/basic-streaming/basic-streaming.cabal+5−5 doc/cookbook/cabal.project−2 doc/cookbook/cabal.project.local doc/cookbook/curl-mock/CurlMock.lhs+21−8 doc/cookbook/curl-mock/curl-mock.cabal+4−7 doc/cookbook/custom-errors/CustomErrors.lhs−189 doc/cookbook/custom-errors/custom-errors.cabal−25 doc/cookbook/db-mysql-basics/MysqlBasics.lhs−236 doc/cookbook/db-mysql-basics/mysql-basics.cabal−40 doc/cookbook/db-postgres-pool/db-postgres-pool.cabal+4−4 doc/cookbook/db-sqlite-simple/db-sqlite-simple.cabal+5−5 doc/cookbook/file-upload/FileUpload.lhs+3−3 doc/cookbook/file-upload/file-upload.cabal+4−4 doc/cookbook/generic/Generic.lhs+3−3 doc/cookbook/generic/generic.cabal+4−4 doc/cookbook/hoist-server-with-context/HoistServerWithContext.lhs+2−2 doc/cookbook/hoist-server-with-context/hoist-server-with-context.cabal+5−5 doc/cookbook/https/Https.lhs+5−5 doc/cookbook/https/https.cabal+5−5 doc/cookbook/index.rst+2−7 doc/cookbook/jwt-and-basic-auth/jwt-and-basic-auth.cabal+5−5 doc/cookbook/open-id-connect/OpenIdConnect.cabal−45 doc/cookbook/open-id-connect/OpenIdConnect.lhs−472 doc/cookbook/pagination/Pagination.lhs+8−8 doc/cookbook/pagination/pagination.cabal+5−5 doc/cookbook/sentry/Sentry.lhs+2−2 doc/cookbook/sentry/sentry.cabal+4−4 doc/cookbook/structuring-apis/StructuringApis.lhs+1−1 doc/cookbook/structuring-apis/structuring-apis.cabal+4−4 doc/cookbook/testing/Testing.lhs+13−11 doc/cookbook/testing/testing.cabal+5−5 doc/cookbook/using-custom-monad/UsingCustomMonad.lhs+1−1 doc/cookbook/using-custom-monad/using-custom-monad.cabal+4−4 doc/cookbook/using-free-client/UsingFreeClient.lhs+6−6 doc/cookbook/using-free-client/using-free-client.cabal+4−4 doc/cookbook/uverb/UVerb.lhs−223 doc/cookbook/uverb/uverb.cabal−35 doc/examples.md+1−1 doc/links.rst+3−3 doc/tutorial/ApiType.lhs+4−30 doc/tutorial/Authentication.lhs+11−10 doc/tutorial/Client.lhs+4−4 doc/tutorial/Docs.lhs+2−2 doc/tutorial/Javascript.lhs+2−2 doc/tutorial/Server.lhs+26−26 doc/tutorial/index.rst+20−1 doc/tutorial/install.rst−68 doc/tutorial/test/Spec.hs+1−11 doc/tutorial/tutorial.cabal+15−11 ghcjs.nix−22 nix/README.md−18 nix/nixpkgs.json−4 nix/nixpkgs.nix−4 nix/shell.nix+18−17 servant-auth/README.md−1 servant-auth/servant-auth-client/.ghci−1 servant-auth/servant-auth-client/CHANGELOG.md−26 servant-auth/servant-auth-client/LICENSE−31 servant-auth/servant-auth-client/Setup.hs−2 servant-auth/servant-auth-client/servant-auth-client.cabal−80 servant-auth/servant-auth-client/src/Servant/Auth/Client.hs−3 servant-auth/servant-auth-client/src/Servant/Auth/Client/Internal.hs−64 servant-auth/servant-auth-client/test/Servant/Auth/ClientSpec.hs−161 servant-auth/servant-auth-client/test/Spec.hs−1 servant-auth/servant-auth-docs/.ghci−1 servant-auth/servant-auth-docs/CHANGELOG.md−14 servant-auth/servant-auth-docs/LICENSE−31 servant-auth/servant-auth-docs/Setup.hs−33 servant-auth/servant-auth-docs/servant-auth-docs.cabal−84 servant-auth/servant-auth-docs/src/Servant/Auth/Docs.hs−96 servant-auth/servant-auth-docs/test/Spec.hs−1 servant-auth/servant-auth-docs/test/doctests.hs−12 servant-auth/servant-auth-server/.ghci−1 servant-auth/servant-auth-server/CHANGELOG.md−130 servant-auth/servant-auth-server/LICENSE−31 servant-auth/servant-auth-server/README.lhs−291 servant-auth/servant-auth-server/README.md−1 servant-auth/servant-auth-server/Setup.hs−2 servant-auth/servant-auth-server/servant-auth-server.cabal−134 servant-auth/servant-auth-server/src/Servant/Auth/Server.hs−180 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal.hs−70 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/AddSetCookie.hs−106 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/BasicAuth.hs−59 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Class.hs−72 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ConfigTypes.hs−127 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Cookie.hs−182 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/FormLogin.hs−3 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/JWT.hs−72 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ThrowAll.hs−58 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Types.hs−112 servant-auth/servant-auth-server/src/Servant/Auth/Server/SetCookieOrphan.hs−3 servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hs−607 servant-auth/servant-auth-server/test/Spec.hs−1 servant-auth/servant-auth-swagger/.ghci−1 servant-auth/servant-auth-swagger/CHANGELOG.md−24 servant-auth/servant-auth-swagger/LICENSE−31 servant-auth/servant-auth-swagger/Setup.hs−2 servant-auth/servant-auth-swagger/servant-auth-swagger.cabal−70 servant-auth/servant-auth-swagger/src/Servant/Auth/Swagger.hs−87 servant-auth/servant-auth-swagger/test/Servant/Auth/SwaggerSpec.hs−38 servant-auth/servant-auth-swagger/test/Spec.hs−1 servant-auth/servant-auth/.ghci−1 servant-auth/servant-auth/CHANGELOG.md−20 servant-auth/servant-auth/LICENSE−31 servant-auth/servant-auth/Setup.hs−2 servant-auth/servant-auth/servant-auth.cabal−47 servant-auth/servant-auth/src/Servant/Auth.hs−54 servant-auth/servant-auth/src/Servant/Auth/JWT.hs−40 servant-auth/servant-auth/test/Spec.hs−1 servant-client-core/CHANGELOG.md+2−111 servant-client-core/servant-client-core.cabal+22−22 servant-client-core/src/Servant/Client/Core.hs−3 servant-client-core/src/Servant/Client/Core/BasicAuth.hs+2 servant-client-core/src/Servant/Client/Core/HasClient.hs+34−349 servant-client-core/src/Servant/Client/Core/Reexport.hs−6 servant-client-core/src/Servant/Client/Core/Request.hs+11−50 servant-client-core/src/Servant/Client/Core/RunClient.hs+3−12 servant-client-core/src/Servant/Client/Generic.hs+11−8 servant-client-core/test/Servant/Client/Core/RequestSpec.hs−31 servant-client-ghcjs/README.md+2−2 servant-client-ghcjs/servant-client-ghcjs.cabal+9−9 servant-client-ghcjs/src/Servant/Client/Internal/XhrClient.hs+5−8 servant-client/CHANGELOG.md+2−124 servant-client/servant-client.cabal+28−39 servant-client/src/Servant/Client.hs−1 servant-client/src/Servant/Client/Internal/HttpClient.hs+23−49 servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+15−18 servant-client/src/Servant/Client/Streaming.hs−1 servant-client/test/Servant/BasicAuthSpec.hs−53 servant-client/test/Servant/BrokenSpec.hs−71 servant-client/test/Servant/ClientSpec.hs+514 servant-client/test/Servant/ClientTestUtils.hs−384 servant-client/test/Servant/ConnectionErrorSpec.hs−55 servant-client/test/Servant/FailSpec.hs−79 servant-client/test/Servant/GenAuthSpec.hs−54 servant-client/test/Servant/GenericSpec.hs−37 servant-client/test/Servant/HoistClientSpec.hs−58 servant-client/test/Servant/StreamSpec.hs+4−3 servant-client/test/Servant/SuccessSpec.hs−208 servant-client/test/Servant/WrappedApiSpec.hs−63 servant-conduit/servant-conduit.cabal+17−12 servant-docs/CHANGELOG.md−85 servant-docs/README.md+11−44 servant-docs/example/greet.hs+4−4 servant-docs/example/greet.md+2−33 servant-docs/golden/comprehensive.md+12−47 servant-docs/servant-docs.cabal+23−17 servant-docs/src/Servant/Docs/Internal.hs+38−167 servant-docs/src/Servant/Docs/Internal/Pretty.hs−19 servant-docs/test/Servant/DocsSpec.hs+6−21 servant-foreign/CHANGELOG.md−87 servant-foreign/servant-foreign.cabal+19−13 servant-foreign/src/Servant/Foreign.hs+19−22 servant-foreign/src/Servant/Foreign/Inflections.hs+13−18 servant-foreign/src/Servant/Foreign/Internal.hs+32−147 servant-foreign/test/Servant/ForeignSpec.hs+4−7 servant-http-streams/CHANGELOG.md−91 servant-http-streams/servant-http-streams.cabal+26−22 servant-http-streams/src/Servant/HttpStreams/Internal.hs+11−18 servant-http-streams/test/Servant/ClientSpec.hs+8−6 servant-machines/servant-machines.cabal+17−12 servant-pipes/CHANGELOG.md−18 servant-pipes/example/Main.hs+1−1 servant-pipes/servant-pipes.cabal+17−12 servant-pipes/src/Servant/Pipes.hs+1−1 servant-server/CHANGELOG.md+2−127 servant-server/README.md+1−1 servant-server/Setup.hs+32−1 servant-server/example/README.md+1−1 servant-server/example/greet.hs+2−16 servant-server/servant-server.cabal+49−32 servant-server/src/Servant/Server.hs+11−64 servant-server/src/Servant/Server/Generic.hs+20−18 servant-server/src/Servant/Server/Internal.hs+105−233 servant-server/src/Servant/Server/Internal/BasicAuth.hs+3−1 servant-server/src/Servant/Server/Internal/Context.hs+9−24 servant-server/src/Servant/Server/Internal/Delayed.hs+1−1 servant-server/src/Servant/Server/Internal/DelayedIO.hs+5−4 servant-server/src/Servant/Server/Internal/ErrorFormatter.hs−87 servant-server/src/Servant/Server/Internal/Handler.hs+2−7 servant-server/src/Servant/Server/Internal/Router.hs+32−50 servant-server/src/Servant/Server/Internal/ServerError.hs+1−1 servant-server/src/Servant/Server/UVerb.hs−116 servant-server/test/Servant/Server/ErrorSpec.hs+2−58 servant-server/test/Servant/Server/Internal/ContextSpec.hs+1−1 servant-server/test/Servant/Server/Internal/RoutingApplicationSpec.hs+2−2 servant-server/test/Servant/Server/RouterSpec.hs+8−129 servant-server/test/Servant/ServerSpec.hs+127−292 servant-server/test/doctests.hs+27 servant-swagger/CHANGELOG.md−143 servant-swagger/LICENSE−28 servant-swagger/README.md−46 servant-swagger/Setup.hs−33 servant-swagger/example/LICENSE−28 servant-swagger/example/example.cabal−62 servant-swagger/example/server/Main.hs−11 servant-swagger/example/src/Todo.hs−73 servant-swagger/example/swagger.json−158 servant-swagger/example/test/Spec.hs−1 servant-swagger/example/test/TodoSpec.hs−28 servant-swagger/servant-swagger.cabal−127 servant-swagger/src/Servant/Swagger.hs−188 servant-swagger/src/Servant/Swagger/Internal.hs−488 servant-swagger/src/Servant/Swagger/Internal/Orphans.hs−27 servant-swagger/src/Servant/Swagger/Internal/Test.hs−207 servant-swagger/src/Servant/Swagger/Internal/TypeLevel.hs−9 servant-swagger/src/Servant/Swagger/Internal/TypeLevel/API.hs−86 servant-swagger/src/Servant/Swagger/Internal/TypeLevel/Every.hs−63 servant-swagger/src/Servant/Swagger/Internal/TypeLevel/TMap.hs−37 servant-swagger/src/Servant/Swagger/Test.hs−13 servant-swagger/src/Servant/Swagger/TypeLevel.hs−15 servant-swagger/test/Servant/SwaggerSpec.hs−489 servant-swagger/test/Spec.hs−1 servant-swagger/test/doctests.hs−12 servant/CHANGELOG.md+15−309 servant/Setup.hs+32−1 servant/servant.cabal+63−40 servant/src/Servant/API.hs+4−21 servant/src/Servant/API/Alternative.hs+2 servant/src/Servant/API/ContentTypes.hs+3−3 servant/src/Servant/API/Description.hs+2−2 servant/src/Servant/API/Fragment.hs−25 servant/src/Servant/API/Header.hs+1−1 servant/src/Servant/API/Internal/Test/ComprehensiveAPI.hs+6 servant/src/Servant/API/Modifiers.hs+2 servant/src/Servant/API/NamedRoutes.hs−10 servant/src/Servant/API/Raw.hs+2−3 servant/src/Servant/API/ResponseHeaders.hs+9−7 servant/src/Servant/API/Status.hs−160 servant/src/Servant/API/Stream.hs+2 servant/src/Servant/API/TypeErrors.hs−40 servant/src/Servant/API/TypeLevel.hs+10−60 servant/src/Servant/API/UVerb.hs−124 servant/src/Servant/API/UVerb/Union.hs−147 servant/src/Servant/API/Verbs.hs+6−13 servant/src/Servant/Links.hs+13−94 servant/src/Servant/Test/ComprehensiveAPI.hs+2−4 servant/src/Servant/Types/SourceT.hs+1−33 servant/src/Servant/Utils/Links.hs+6 servant/test/Servant/API/ContentTypesSpec.hs+5−29 servant/test/Servant/API/StreamSpec.hs+1−1 servant/test/Servant/LinksSpec.hs+1−18 servant/test/doctests.hs+27 stack.yaml+17−5 stack.yaml.lock−19
.github/FUNDING.ymldeleted−12
@@ -1,12 +0,0 @@
1−# These are supported funding model platforms
2−
3−github: [arianvp]
4−patreon: # Replace with a single Patreon username
5−open_collective: # Replace with a single Open Collective username
6−ko_fi: # Replace with a single Ko-fi username
7−tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8−community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9−liberapay: # Replace with a single Liberapay username
10−issuehunt: # Replace with a single IssueHunt username
11−otechie: # Replace with a single Otechie username
12−custom: https://github.com/haskell-servant/haskell-servant.github.io/blob/hakyll/consultancies.md
.github/run-ghcjs-tests.shdeleted−14
@@ -1,14 +0,0 @@
1−#!/usr/bin/env bash
2−#
3−# cabal v2-test does not work with GHCJS
4−# See: https://github.com/haskell/cabal/issues/6175
5−#
6−# This invokes cabal-plan to figure out test binaries, and invokes them with node.
7−
8−cabal-plan list-bins '*:test:*' | while read -r line
9−do
10− testpkg=$(echo "$line" | perl -pe 's/:.*//')
11− testexe=$(echo "$line" | awk '{ print $2 }')
12− echo "testing $textexe in package $textpkg"
13− (cd "$testpkg" && node "$testexe".jsexe/all.js)
14−done
.github/workflows/master.ymldeleted−147
@@ -1,147 +0,0 @@
1−name: CI
2−
3−# Trigger the workflow on push or pull request, but only for the master branch
4−on:
5− pull_request:
6− push:
7− branches: [master]
8−
9−jobs:
10− cabal:
11− name: ${{ matrix.os }} / ghc ${{ matrix.ghc }}
12− runs-on: ${{ matrix.os }}
13− strategy:
14− matrix:
15− os: [ubuntu-latest]
16− cabal: ["3.6"]
17− ghc:
18− - "8.6.5"
19− - "8.8.4"
20− - "8.10.7"
21− - "9.0.2"
22− - "9.2.2"
23−
24− steps:
25− - uses: actions/checkout@v2
26−
27− - uses: haskell/actions/setup@v1
28− id: setup-haskell-cabal
29− name: Setup Haskell
30− with:
31− ghc-version: ${{ matrix.ghc }}
32− cabal-version: ${{ matrix.cabal }}
33−
34− - name: Freeze
35− run: |
36− cabal configure --enable-tests --enable-benchmarks --test-show-details=direct
37− cabal freeze
38−
39− - uses: actions/cache@v2.1.3
40− name: Cache ~/.cabal/store and dist-newstyle
41− with:
42− path: |
43− ${{ steps.setup-haskell-cabal.outputs.cabal-store }}
44− dist-newstyle
45− key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
46− restore-keys: |
47− ${{ runner.os }}-${{ matrix.ghc }}-
48−
49− - name: Configure
50− run: |
51− cabal install --ignore-project -j2 doctest --constraint='doctest ^>=0.20'
52−
53− - name: Build
54− run: |
55− cabal build all
56−
57− - name: Test
58− run: |
59− cabal test all
60−
61− - name: Run doctests
62− run: |
63− # Necessary for doctest to be found in $PATH
64− export PATH="$HOME/.cabal/bin:$PATH"
65−
66− DOCTEST="cabal repl --with-ghc=doctest --ghc-options=-w"
67− (cd servant && eval $DOCTEST)
68− (cd servant-client && eval $DOCTEST)
69− (cd servant-client-core && eval $DOCTEST)
70− (cd servant-http-streams && eval $DOCTEST)
71− (cd servant-docs && eval $DOCTEST)
72− (cd servant-foreign && eval $DOCTEST)
73− (cd servant-server && eval $DOCTEST)
74− (cd servant-machines && eval $DOCTEST)
75− (cd servant-conduit && eval $DOCTEST)
76− (cd servant-pipes && eval $DOCTEST)
77−
78− stack:
79− name: stack / ghc ${{ matrix.ghc }}
80− runs-on: ubuntu-latest
81− strategy:
82− matrix:
83− stack: ["2.7.5"]
84− ghc: ["8.10.7"]
85−
86− steps:
87− - uses: actions/checkout@v2
88−
89− - uses: haskell/actions/setup@v1
90− name: Setup Haskell Stack
91− with:
92− ghc-version: ${{ matrix.ghc }}
93− stack-version: ${{ matrix.stack }}
94−
95− - uses: actions/cache@v2.1.3
96− name: Cache ~/.stack
97− with:
98− path: ~/.stack
99− key: ${{ runner.os }}-${{ matrix.ghc }}-stack
100−
101− - name: Install dependencies
102− run: |
103− stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies
104−
105− - name: Build
106− run: |
107− stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks
108−
109− - name: Test
110− run: |
111− stack test --system-ghc
112−
113− ghcjs:
114− name: ubuntu-latest / ghcjs 8.6
115− runs-on: "ubuntu-latest"
116−
117− steps:
118− - uses: actions/checkout@v2
119− - uses: cachix/install-nix-action@v13
120− with:
121− extra_nix_config: |
122− trusted-public-keys = ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=1aba6f367982bd6dd78ec2fda75ab246a62d32c5 cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
123− substituters = https://nixcache.reflex-frp.org https://cache.nixos.org/
124− - name: Setup
125− run: |
126− # Override cabal.project with the lightweight GHCJS one
127− cp cabal.ghcjs.project cabal.project
128− cat cabal.project
129− nix-shell ghcjs.nix --run "cabal v2-update && cabal v2-freeze"
130−
131− - uses: actions/cache@v2.1.3
132− name: Cache ~/.cabal/store and dist-newstyle
133− with:
134− path: |
135− ~/.cabal/store
136− dist-newstyle
137− key: ${{ runner.os }}-ghcjs8.6-${{ hashFiles('cabal.project.freeze') }}
138− restore-keys: |
139− ${{ runner.os }}-ghcjs8.6-
140−
141− - name: Build
142− run: |
143− nix-shell ghcjs.nix --run "cabal v2-build --ghcjs --enable-tests --enable-benchmarks all"
144−
145− - name: Tests
146− run: |
147− nix-shell ghcjs.nix --run ".github/run-ghcjs-tests.sh"
.gitignore−6
@@ -1,5 +1,4 @@
11**/*/dist
2−*~
32dist-*
43.ghc.environment.*
54/bin
@@ -30,11 +29,6 @@ doc/_build
3029doc/venv
3130doc/tutorial/static/api.js
3231doc/tutorial/static/jq.js
33−shell.nix
34−.hspec-failures
35−
36−# nix
37−result*
3832
3933# local versions of things
4034servant-multipart
.travis.ymlnew file+220
@@ -0,0 +1,220 @@
1+# This Travis job script has been generated by a script via
2+#
3+# haskell-ci '--config=cabal.haskell-ci' '--output=.travis.yml' 'cabal.project'
4+#
5+# For more information, see https://github.com/haskell-CI/haskell-ci
6+#
7+language: c
8+dist: xenial
9+
10+git:
11+ submodules: false # whether to recursively clone submodules
12+
13+branches:
14+ only:
15+ - master
16+
17+cache:
18+ directories:
19+ - $HOME/.cabal/packages
20+ - $HOME/.cabal/store
21+
22+before_cache:
23+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
24+ # remove files that are regenerated by 'cabal update'
25+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*
26+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json
27+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
28+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
29+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
30+
31+ - rm -rfv $CABALHOME/packages/head.hackage
32+
33+matrix:
34+ include:
35+ - compiler: "ghc-8.6.3"
36+ # env: FOO=bar
37+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.6.3], sources: [hvr-ghc]}}
38+ - compiler: "ghc-8.4.4"
39+ # env: FOO=bar
40+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.4.4], sources: [hvr-ghc]}}
41+ - compiler: "ghc-8.2.2"
42+ # env: FOO=bar
43+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.2.2], sources: [hvr-ghc]}}
44+ - compiler: "ghc-8.0.2"
45+ # env: FOO=bar
46+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.0.2], sources: [hvr-ghc]}}
47+
48+before_install:
49+ - HC=/opt/ghc/bin/${CC}
50+ - HCPKG=${HC/ghc/ghc-pkg}
51+ - unset CC
52+ - CABAL=/opt/ghc/bin/cabal
53+ - CABALHOME=$HOME/.cabal
54+ - "export PATH=\"$CABALHOME/bin:$PATH\""
55+ - ROOTDIR=$(pwd)
56+ - HCNUMVER=$(( $(${HC} --numeric-version|sed -E 's/([0-9]+)\.([0-9]+)\.([0-9]+).*/\1 * 10000 + \2 * 100 + \3/') ))
57+ - echo $HCNUMVER
58+
59+install:
60+ - ${CABAL} --version
61+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
62+ - TEST=--enable-tests
63+ - BENCH=--enable-benchmarks
64+ - GHCHEAD=${GHCHEAD-false}
65+ - travis_retry ${CABAL} update -v
66+ - "sed -i.bak 's/^jobs:/-- jobs:/' $CABALHOME/config"
67+ - rm -fv cabal.project cabal.project.local
68+ - "sed -i.bak 's/-- ghc-options:.*/ghc-options: -j2/' $CABALHOME/config"
69+ - grep -Ev -- '^\s*--' $CABALHOME/config | grep -Ev '^\s*$'
70+ - rm -f cabal.project
71+ - touch cabal.project
72+ - "printf 'packages: \"servant\"\\n' >> cabal.project"
73+ - "printf 'packages: \"servant-client\"\\n' >> cabal.project"
74+ - "printf 'packages: \"servant-client-core\"\\n' >> cabal.project"
75+ - "printf 'packages: \"servant-http-streams\"\\n' >> cabal.project"
76+ - "printf 'packages: \"servant-docs\"\\n' >> cabal.project"
77+ - "printf 'packages: \"servant-foreign\"\\n' >> cabal.project"
78+ - "printf 'packages: \"servant-server\"\\n' >> cabal.project"
79+ - "printf 'packages: \"doc/tutorial\"\\n' >> cabal.project"
80+ - "printf 'packages: \"servant-machines\"\\n' >> cabal.project"
81+ - "printf 'packages: \"servant-conduit\"\\n' >> cabal.project"
82+ - "printf 'packages: \"servant-pipes\"\\n' >> cabal.project"
83+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/basic-auth\"\\n' >> cabal.project ; fi"
84+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/curl-mock\"\\n' >> cabal.project ; fi"
85+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/basic-streaming\"\\n' >> cabal.project ; fi"
86+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/db-postgres-pool\"\\n' >> cabal.project ; fi"
87+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/db-sqlite-simple\"\\n' >> cabal.project ; fi"
88+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/file-upload\"\\n' >> cabal.project ; fi"
89+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/generic\"\\n' >> cabal.project ; fi"
90+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/https\"\\n' >> cabal.project ; fi"
91+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/testing\"\\n' >> cabal.project ; fi"
92+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/structuring-apis\"\\n' >> cabal.project ; fi"
93+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/using-custom-monad\"\\n' >> cabal.project ; fi"
94+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/using-free-client\"\\n' >> cabal.project ; fi"
95+ - "echo 'constraints: foundation >=0.0.14' >> cabal.project"
96+ - "echo 'constraints: memory <0.14.12 || >0.14.12' >> cabal.project"
97+ - "echo 'allow-newer: servant-js:base' >> cabal.project"
98+ - "echo 'allow-newer: servant-pagination:servant' >> cabal.project"
99+ - "echo 'allow-newer: servant-pagination:servant-server' >> cabal.project"
100+ - "echo 'allow-newer: servant-multipart:servant' >> cabal.project"
101+ - "echo 'allow-newer: servant-multipart:servant-server' >> cabal.project"
102+ - "echo 'allow-newer: servant-auth-server:servant' >> cabal.project"
103+ - "echo 'allow-newer: servant-auth-server:servant-server' >> cabal.project"
104+ - "echo 'allow-newer: servant-auth-server:http-api-data' >> cabal.project"
105+ - "echo 'allow-newer: servant-js:servant' >> cabal.project"
106+ - "echo 'allow-newer: servant-js:servant-foreign' >> cabal.project"
107+ - "echo 'allow-newer: servant-quickcheck:servant' >> cabal.project"
108+ - "echo 'allow-newer: servant-quickcheck:servant-client' >> cabal.project"
109+ - "echo 'allow-newer: servant-quickcheck:servant-server' >> cabal.project"
110+ - "echo 'allow-newer: servant-quickcheck:hspec' >> cabal.project"
111+ - "echo 'allow-newer: servant-quickcheck:http-client' >> cabal.project"
112+ - "echo 'reorder-goals: True' >> cabal.project"
113+ - "echo 'optimization: False' >> cabal.project "
114+ - "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
115+ - touch cabal.project.local
116+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-https|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
117+ - cat cabal.project || true
118+ - cat cabal.project.local || true
119+ - if [ -f "servant/configure.ac" ]; then (cd "servant" && autoreconf -i); fi
120+ - if [ -f "servant-client/configure.ac" ]; then (cd "servant-client" && autoreconf -i); fi
121+ - if [ -f "servant-client-core/configure.ac" ]; then (cd "servant-client-core" && autoreconf -i); fi
122+ - if [ -f "servant-http-streams/configure.ac" ]; then (cd "servant-http-streams" && autoreconf -i); fi
123+ - if [ -f "servant-docs/configure.ac" ]; then (cd "servant-docs" && autoreconf -i); fi
124+ - if [ -f "servant-foreign/configure.ac" ]; then (cd "servant-foreign" && autoreconf -i); fi
125+ - if [ -f "servant-server/configure.ac" ]; then (cd "servant-server" && autoreconf -i); fi
126+ - if [ -f "doc/tutorial/configure.ac" ]; then (cd "doc/tutorial" && autoreconf -i); fi
127+ - if [ -f "servant-machines/configure.ac" ]; then (cd "servant-machines" && autoreconf -i); fi
128+ - if [ -f "servant-conduit/configure.ac" ]; then (cd "servant-conduit" && autoreconf -i); fi
129+ - if [ -f "servant-pipes/configure.ac" ]; then (cd "servant-pipes" && autoreconf -i); fi
130+ - if [ -f "doc/cookbook/basic-auth/configure.ac" ]; then (cd "doc/cookbook/basic-auth" && autoreconf -i); fi
131+ - if [ -f "doc/cookbook/curl-mock/configure.ac" ]; then (cd "doc/cookbook/curl-mock" && autoreconf -i); fi
132+ - if [ -f "doc/cookbook/basic-streaming/configure.ac" ]; then (cd "doc/cookbook/basic-streaming" && autoreconf -i); fi
133+ - if [ -f "doc/cookbook/db-postgres-pool/configure.ac" ]; then (cd "doc/cookbook/db-postgres-pool" && autoreconf -i); fi
134+ - if [ -f "doc/cookbook/db-sqlite-simple/configure.ac" ]; then (cd "doc/cookbook/db-sqlite-simple" && autoreconf -i); fi
135+ - if [ -f "doc/cookbook/file-upload/configure.ac" ]; then (cd "doc/cookbook/file-upload" && autoreconf -i); fi
136+ - if [ -f "doc/cookbook/generic/configure.ac" ]; then (cd "doc/cookbook/generic" && autoreconf -i); fi
137+ - if [ -f "doc/cookbook/https/configure.ac" ]; then (cd "doc/cookbook/https" && autoreconf -i); fi
138+ - if [ -f "doc/cookbook/testing/configure.ac" ]; then (cd "doc/cookbook/testing" && autoreconf -i); fi
139+ - if [ -f "doc/cookbook/structuring-apis/configure.ac" ]; then (cd "doc/cookbook/structuring-apis" && autoreconf -i); fi
140+ - if [ -f "doc/cookbook/using-custom-monad/configure.ac" ]; then (cd "doc/cookbook/using-custom-monad" && autoreconf -i); fi
141+ - if [ -f "doc/cookbook/using-free-client/configure.ac" ]; then (cd "doc/cookbook/using-free-client" && autoreconf -i); fi
142+ - rm -f cabal.project.freeze
143+ - rm -rf .ghc.environment.* "servant"/dist "servant-client"/dist "servant-client-core"/dist "servant-http-streams"/dist "servant-docs"/dist "servant-foreign"/dist "servant-server"/dist "doc/tutorial"/dist "servant-machines"/dist "servant-conduit"/dist "servant-pipes"/dist "doc/cookbook/basic-auth"/dist "doc/cookbook/curl-mock"/dist "doc/cookbook/basic-streaming"/dist "doc/cookbook/db-postgres-pool"/dist "doc/cookbook/db-sqlite-simple"/dist "doc/cookbook/file-upload"/dist "doc/cookbook/generic"/dist "doc/cookbook/https"/dist "doc/cookbook/testing"/dist "doc/cookbook/structuring-apis"/dist "doc/cookbook/using-custom-monad"/dist "doc/cookbook/using-free-client"/dist
144+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
145+
146+# Here starts the actual work to be performed for the package under test;
147+# any command which exits with a non-zero exit code causes the build to fail.
148+script:
149+ # test that source-distributions can be generated
150+ - "echo Packaging... && echo -en 'travis_fold:start:sdist\\\\r'"
151+ - ${CABAL} new-sdist all
152+ - "echo -en 'travis_fold:end:sdist\\\\r'"
153+ - "echo Unpacking... && echo -en 'travis_fold:start:unpack\\\\r'"
154+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
155+ - cd ${DISTDIR} || false
156+ - find . -maxdepth 1 -name '*.tar.gz' -exec tar -xvf '{}' \;
157+ - rm -f cabal.project
158+ - touch cabal.project
159+ - "printf 'packages: \"servant-*/*.cabal\"\\n' >> cabal.project"
160+ - "printf 'packages: \"servant-client-*/*.cabal\"\\n' >> cabal.project"
161+ - "printf 'packages: \"servant-client-core-*/*.cabal\"\\n' >> cabal.project"
162+ - "printf 'packages: \"servant-http-streams-*/*.cabal\"\\n' >> cabal.project"
163+ - "printf 'packages: \"servant-docs-*/*.cabal\"\\n' >> cabal.project"
164+ - "printf 'packages: \"servant-foreign-*/*.cabal\"\\n' >> cabal.project"
165+ - "printf 'packages: \"servant-server-*/*.cabal\"\\n' >> cabal.project"
166+ - "printf 'packages: \"tutorial-*/*.cabal\"\\n' >> cabal.project"
167+ - "printf 'packages: \"servant-machines-*/*.cabal\"\\n' >> cabal.project"
168+ - "printf 'packages: \"servant-conduit-*/*.cabal\"\\n' >> cabal.project"
169+ - "printf 'packages: \"servant-pipes-*/*.cabal\"\\n' >> cabal.project"
170+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-basic-auth-*/*.cabal\"\\n' >> cabal.project ; fi"
171+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-curl-mock-*/*.cabal\"\\n' >> cabal.project ; fi"
172+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-basic-streaming-*/*.cabal\"\\n' >> cabal.project ; fi"
173+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-db-postgres-pool-*/*.cabal\"\\n' >> cabal.project ; fi"
174+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-db-sqlite-simple-*/*.cabal\"\\n' >> cabal.project ; fi"
175+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-file-upload-*/*.cabal\"\\n' >> cabal.project ; fi"
176+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-generic-*/*.cabal\"\\n' >> cabal.project ; fi"
177+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-https-*/*.cabal\"\\n' >> cabal.project ; fi"
178+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-testing-*/*.cabal\"\\n' >> cabal.project ; fi"
179+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-structuring-apis-*/*.cabal\"\\n' >> cabal.project ; fi"
180+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-using-custom-monad-*/*.cabal\"\\n' >> cabal.project ; fi"
181+ - "if [ $HCNUMVER -eq 80404 ] || [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-using-free-client-*/*.cabal\"\\n' >> cabal.project ; fi"
182+ - "echo 'constraints: foundation >=0.0.14' >> cabal.project"
183+ - "echo 'constraints: memory <0.14.12 || >0.14.12' >> cabal.project"
184+ - "echo 'allow-newer: servant-js:base' >> cabal.project"
185+ - "echo 'allow-newer: servant-pagination:servant' >> cabal.project"
186+ - "echo 'allow-newer: servant-pagination:servant-server' >> cabal.project"
187+ - "echo 'allow-newer: servant-multipart:servant' >> cabal.project"
188+ - "echo 'allow-newer: servant-multipart:servant-server' >> cabal.project"
189+ - "echo 'allow-newer: servant-auth-server:servant' >> cabal.project"
190+ - "echo 'allow-newer: servant-auth-server:servant-server' >> cabal.project"
191+ - "echo 'allow-newer: servant-auth-server:http-api-data' >> cabal.project"
192+ - "echo 'allow-newer: servant-js:servant' >> cabal.project"
193+ - "echo 'allow-newer: servant-js:servant-foreign' >> cabal.project"
194+ - "echo 'allow-newer: servant-quickcheck:servant' >> cabal.project"
195+ - "echo 'allow-newer: servant-quickcheck:servant-client' >> cabal.project"
196+ - "echo 'allow-newer: servant-quickcheck:servant-server' >> cabal.project"
197+ - "echo 'allow-newer: servant-quickcheck:hspec' >> cabal.project"
198+ - "echo 'allow-newer: servant-quickcheck:http-client' >> cabal.project"
199+ - "echo 'reorder-goals: True' >> cabal.project"
200+ - "echo 'optimization: False' >> cabal.project "
201+ - "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
202+ - touch cabal.project.local
203+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-https|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
204+ - cat cabal.project || true
205+ - cat cabal.project.local || true
206+ - "echo -en 'travis_fold:end:unpack\\\\r'"
207+
208+ - "echo Building with tests and benchmarks... && echo -en 'travis_fold:start:build-everything\\\\r'"
209+ # build & run tests, build benchmarks
210+ - ${CABAL} new-build -w ${HC} ${TEST} ${BENCH} all
211+ - "echo -en 'travis_fold:end:build-everything\\\\r'"
212+ - if [ "x$TEST" = "x--enable-tests" ]; then ${CABAL} new-test -w ${HC} ${TEST} ${BENCH} all; fi
213+
214+ - "echo Haddock... && echo -en 'travis_fold:start:haddock\\\\r'"
215+ # haddock
216+ - ${CABAL} new-haddock -w ${HC} ${TEST} ${BENCH} all
217+
218+ - "echo -en 'travis_fold:end:haddock\\\\r'"
219+# REGENDATA ["--config=cabal.haskell-ci","--output=.travis.yml","cabal.project"]
220+# EOF
CONTRIBUTING.md+4−33
@@ -35,34 +35,7 @@ Some things we like:
3535Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
3636files in the repository provide a good baseline for consistency.
3737
38−**Important**: please do not modify the versions of the servant packages you are sending patches for.
39−
40−## Changelog entries
41−
42−We experiment with using [changelog-d tool](https://github.com/phadej/changelog-d) to assemble changelogs.
43−You are not required to install it.
44−
45−In each PR please add a file to `changelog.d` directory named after issue you are solving or the pull request itself (in a separate commit after you know the pull request number). For example
46−
47−```cabal
48−synopsis: One sentence summary of the change.
49−prs: #1219
50−issues: #1028
51−
52−description: {
53−
54−A longer description. Small changes don't need this.
55−Bigger ones definitely do, for example we try to include migration hints
56−for breaking changes.
57−
58−However if you don't know what to write, that's ok too.
59−
60−By the way, the braces around are omitted when the file is parsed.
61−They can be used so the field doesn't need to be indented, which is handy
62−for prose.
63−
64−}
65−```
38+**Important**: please do not modify the changelog files nor the versions of the servant packages you are sending patches for. We take care of this before every release and do it uniformly for all the servant packages, so there's no need to worry about this for your pull requests.
6639
6740## PR process
6841
@@ -79,10 +52,8 @@ not been a timely response to a PR, you can ping the Maintainers group (with
7952We encourage people to experiment with new combinators and instances - it is
8053one of the most powerful ways of using `servant`, and a wonderful way of
8154getting to know it better. If you do write a new combinator, we would love to
82−know about it! Either hop on
83−[#haskell-servant on libera.chat](https://web.libera.chat/#haskell-servant) and
84−let us know, or open an issue with the `news` tag (which we will close when we
85−read it).
55+know about it! Either hop on #servant on freenode and let us know, or open an
56+issue with the `news` tag (which we will close when we read it).
8657
8758As for adding them to the main repo: maintaining combinators can be expensive,
8859since official combinators must have instances for all classes (and new classes
@@ -105,7 +76,7 @@ the `news` label if you make a new package so we can know about it!
10576
10677## Release policy
10778
108−We are currently moving to a more aggressive release policy, so that you can get
79+We are currently moving to a more aggresive release policy, so that you can get
10980what you contribute from Hackage fairly soon. However, note that prior to major
11081releases it may take some time in between releases.
11182
Makefilenew file+22
@@ -0,0 +1,22 @@
1+# With common maintenance tasks
2+
3+HC ?= ghc-8.4.4
4+
5+all :
6+ @echo "Don't try to make all at once!"
7+
8+really-all :
9+ $(MAKE) build-ghc
10+ $(MAKE) build-ghc HC=ghc-8.0.2
11+ $(MAKE) build-ghc HC=ghc-8.2.2
12+ $(MAKE) build-ghc HC=ghc-8.6.3
13+ $(MAKE) build-ghcjs
14+
15+build-ghc :
16+ cabal v2-build -w $(HC) all
17+
18+build-ghcjs :
19+ cabal v2-build --builddir=dist-newstyle-ghcjs --project-file=cabal.ghcjs.project all
20+
21+packdeps :
22+ packdeps */*.cabal
README.md+16−26
@@ -4,16 +4,16 @@
44
55## Getting Started
66
7−We have a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) that
7+We have a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) that
88introduces the core features of servant. After this article, you should be able
99to write your first servant webservices, learning the rest from the haddocks'
1010examples.
1111
12−The core documentation can be found [here](http://docs.servant.dev/).
12+The central documentation can be found [here](http://haskell-servant.readthedocs.org/).
1313Other blog posts, videos and slides can be found on the
14−[website](http://www.servant.dev/).
14+[website](http://haskell-servant.github.io/).
1515
16−If you need help, drop by the IRC channel (#haskell-servant on libera.chat) or [mailing
16+If you need help, drop by the IRC channel (#servant on freenode) or [mailing
1717list](https://groups.google.com/forum/#!forum/haskell-servant).
1818
1919## Contributing
@@ -32,7 +32,7 @@ See `CONTRIBUTING.md`
3232 - It's a good idea to separate these steps, as tests often pass, if they compile :)
3333 - See `cabal.project` to selectively `allow-newer`
3434 - If some packages are broken, on your discretisation there are two options:
35− - Fix them and make PRs: it's a good idea to test against older `servant` version too.
35+ - Fix them and make PRs: it's good idea to test against older `servant` version too.
3636 - Temporarily comment out broken package
3737 - If you make a commit for `servant-universe`, you can use it as submodule in private projects to test even more
3838- When ripples are cleared out:
@@ -40,32 +40,22 @@ See `CONTRIBUTING.md`
4040 - `git push --tags`
4141 - `cabal sdist` and `cabal upload`
4242
43−## TechEmpower framework benchmarks
43+## travis
4444
45−We develop and maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/
45+`.travis.yml` is generated using `make-travis-yml` tool, in
46+[multi-ghc-travis](https://github.com/haskell-hvr/multi-ghc-travis) repository.
4647
47−To verify (i.e. compile and test that it works)
48+To regenerate the script use (*note:* atm you need to comment `doc/cookbook/` packages).
4849
49−```sh
50−./tfb --mode verify --test servant servant-beam servant-psql-simple --type json plaintext db fortune
5150```
52−
53−To compare with `warp`
54−
55−```sh
56−./tfb --mode benchmark --test warp servant servant-beam servant-psql-simple --type json plaintext db fortune
51+runghc ~/Documents/other-haskell/multi-ghc-travis/make_travis_yml_2.hs regenerate
5752```
5853
59−To compare with `reitit` (Clojure framework)
54+In case Travis jobs fail due failing build of dependency, you can temporarily
55+add `constraints` to the `cabal.project`, and regenerate the `.travis.yml`.
56+For example, the following will disallow single `troublemaker-13.37` package version:
6057
61−```sh
62−./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune
6358```
64−
65−You can see the visualised results at https://www.techempower.com/benchmarks/#section=test
66−
67−## Nix
68−
69−A developer shell.nix file is provided in the `nix` directory
70−
71−See [nix/README.md](nix/README.md)
59+constraints:
60+ troublemaker <13.37 && > 13.37
61+```
cabal.ghcjs.project+1−6
@@ -2,13 +2,8 @@
22
33packages:
44 servant/
5− servant-client/
65 servant-client-core/
6+ servant-client-ghcjs/
77
88-- we need to tell cabal we are using GHCJS
99compiler: ghcjs
10−tests: True
11−
12−-- Constraints so that reflex-platform provided packages are selected.
13−constraints: attoparsec == 0.13.2.2
14−constraints: hashable == 1.3.0.0
cabal.haskell-cinew file+16
@@ -0,0 +1,16 @@
1+folds: all-but-test
2+branches: master
3+jobs-selection: any
4+
5+-- We have inplace packages (servant-js) so we skip installing dependencies in a separate step
6+install-dependencies: False
7+
8+-- this speed-ups the build a little, but we have to check these for release
9+no-tests-no-benchmarks: False
10+unconstrained: False
11+
12+-- Don't run cabal check, as cookbook examples won't pass it
13+cabal-check: False
14+
15+-- ghc-options: -j2
16+jobs: :2
cabal.project+26−23
@@ -1,53 +1,56 @@
11packages:
22 servant/
3− servant-auth/servant-auth
4− servant-auth/servant-auth-client
5− servant-auth/servant-auth-docs
6− servant-auth/servant-auth-server
7− servant-auth/servant-auth-swagger
8−
93 servant-client/
104 servant-client-core/
115 servant-http-streams/
126 servant-docs/
137 servant-foreign/
148 servant-server/
15− servant-swagger/
169 doc/tutorial/
1710
18−-- servant streaming
19−packages:
2011 servant-machines/
2112 servant-conduit/
2213 servant-pipes/
2314
24−-- servant GHCJS
25−-- packages:
26−-- servant-jsaddle/
15+ -- doc/cookbook/*/*.cabal
2716
28−-- Cookbooks
29−packages:
3017 doc/cookbook/basic-auth
3118 doc/cookbook/curl-mock
32− doc/cookbook/custom-errors
3319 doc/cookbook/basic-streaming
3420 doc/cookbook/db-postgres-pool
3521 doc/cookbook/db-sqlite-simple
3622 doc/cookbook/file-upload
3723 doc/cookbook/generic
38− doc/cookbook/hoist-server-with-context
24+ -- doc/cookbook/hoist-server-with-context
3925 doc/cookbook/https
40− doc/cookbook/jwt-and-basic-auth
41− doc/cookbook/pagination
26+ -- doc/cookbook/jwt-and-basic-auth/
27+ -- doc/cookbook/pagination
4228 -- doc/cookbook/sentry
43− -- Commented out because servant-quickcheck currently doesn't build.
44− -- doc/cookbook/testing
45− doc/cookbook/uverb
29+ doc/cookbook/testing
4630 doc/cookbook/structuring-apis
4731 doc/cookbook/using-custom-monad
4832 doc/cookbook/using-free-client
49− -- doc/cookbook/open-id-connect
5033
5134tests: True
5235optimization: False
53−-- reorder-goals: True
36+reorder-goals: True
37+
38+allow-newer:
39+ servant-js:base
40+
41+constraints:
42+ -- see https://github.com/haskell-infra/hackage-trustees/issues/119
43+ foundation >=0.0.14,
44+ memory <0.14.12 || >0.14.12
45+
46+allow-newer:
47+ servant-pagination:servant, servant-pagination:servant-server,
48+ servant-multipart:servant, servant-multipart:servant-server,
49+ servant-auth-server:servant, servant-auth-server:servant-server, servant-auth-server:http-api-data,
50+ servant-js:servant, servant-js:servant-foreign
51+
52+-- servant-quickcheck
53+allow-newer:
54+ servant-quickcheck:servant, servant-quickcheck:servant-client, servant-quickcheck:servant-server,
55+ servant-quickcheck:hspec,
56+ servant-quickcheck:http-client
changelog.d/1432deleted−9
@@ -1,9 +0,0 @@
1−synopsis: Fixes encoding of URL parameters in servant-client
2−prs: #1432
3−issues: #1418
4−description: {
5−Some applications use query parameters to pass arbitrary (non-unicode) binary
6−data. This change modifies how servant-client handles query parameters, so
7−that application developers can use `ToHttpApiData` to marshal binary data into
8−query parameters.
9−}
changelog.d/1469deleted−11
@@ -1,11 +0,0 @@
1−synopsis: Derive HasClient good response status from Verb status
2−prs: #1469
3−description: {
4−`HasClient` instances for the `Verb` datatype use `runRequest` in
5−`clientWithRoute` definitions.
6−This means that a request performed with `runClientM` will be successful if and
7−only if the endpoint specify a response status code >=200 and <300.
8−This change replaces `runRequest` with `runRequestAcceptStatus` in `Verb`
9−instances for the `HasClient` class, deriving the good response status from
10−the `Verb` status.
11−}
changelog.d/1477deleted−9
@@ -1,9 +0,0 @@
1−synopsis: Enable FlexibleContexts in Servant.API.ContentTypes
2−prs: #1477
3−
4−description: {
5−
6−Starting with GHC 9.2, UndecidableInstances no longer implies FlexibleContexts.
7−Add this extension where it's needed to make compilation succeed.
8−
9−}
changelog.d/1529deleted−10
@@ -1,10 +0,0 @@
1−synopsis: Fix performRequest in servant-client-ghcjs
2−prs: #1529
3−
4−description: {
5−
6−performRequest function in servant-client-ghcjs was not compatible with the
7−latest RunClient typeclass. Added the acceptStatus parameter and fixed the
8−functionality to match what servant-client provides.
9−
10−}
changelog.d/1556deleted−81
@@ -1,81 +0,0 @@
1−synopsis: Display capture hints in router layout
2−prs: #1556
3−
4−description: {
5−
6−This PR enhances the `Servant.Server.layout` function, which produces a textual description of the routing layout of an API. More precisely, it changes `<capture>` blocks, so that they display the name and type of the variable being captured instead.
7−
8−Example:
9−
10−For the following API
11−```haskell
12−type API =
13− "a" :> "d" :> Get '[JSON] NoContent
14− :<|> "b" :> Capture "x" Int :> Get '[JSON] Bool
15− :<|> "a" :> "e" :> Get '[JSON] Int
16−```
17−
18−we previously got the following output:
19−
20−```
21−/
22−├─ a/
23−│ ├─ d/
24−│ │ └─•
25−│ └─ e/
26−│ └─•
27−└─ b/
28− └─ <capture>/
29− ├─•
30− ┆
31− └─•
32−```
33−
34−now we get:
35−
36−```
37−/
38−├─ a/
39−│ ├─ d/
40−│ │ └─•
41−│ └─ e/
42−│ └─•
43−└─ b/
44− └─ <x::Int>/
45− ├─•
46− ┆
47− └─•
48−```
49−
50−This change is achieved by the introduction of a CaptureHint type, which is passed as an extra argument to the CaptureRouter and CaptureAllRouter constructors for the Router' type.
51−CaptureHint values are then used in routerLayout, to display the name and type of captured values, instead of just `<capture>` previously.
52−
53−N.B.:
54−Because the choice smart constructor for routers can aggregate Capture combinators with different capture hints, the Capture*Router constructors actually take a list of CaptureHint, instead of a single one.
55−
56−This PR also introduces Spec tests for the routerLayout function.
57−
58−Warning:
59−This change is potentially breaking, because it adds the constraint `Typeable a` to all types that are to be captured. Because all types are typeable since GHC 7.10, this is not as bad as it sounds ; it only break expressions where `a` is quantified in an expression with `Capture a`.
60−In those cases, the fix is easy: it suffices to add `Typeable a` to the left-hand side of the quantification constraint.
61−
62−For instance, the following code will no longer compile:
63−```haskell
64−type MyAPI a = Capture "foo" a :> Get '[JSON] ()
65−
66−myServer :: forall a. Server (MyAPI a)
67−myServer = const $ return ()
68−
69−myApi :: forall a. Proxy (MyAPI a)
70−myApi = Proxy
71−
72−app :: forall a. (FromHttpApiData a) => Application
73−app = serve (myApi @a) (myServer @a)
74−```
75−
76−Indeed, `app` should be replaced with:
77−```haskell
78−app :: forall a. (FromHttpApiData a, Typeable a) => Application
79−app = serve (myApi @a) (myServer @a)
80−```
81−}
changelog.d/1569deleted−13
@@ -1,13 +0,0 @@
1−synopsis: Encode captures using toEncodedUrlPiece
2−prs: #1569
3−issues: #1511
4−
5−description: {
6−The `servant-client` library now makes direct use of `toEncodedUrlPiece` from `ToHttpApiData`
7−to encode captured values when building the request path. It gives user freedom to implement
8−URL-encoding however they need.
9−
10−Previous behavior was to use `toUrlPiece` and URL-encode its output using `toEncodedUrlPiece`
11−from the `Text` instance of `ToHttpApiData`. The issue with this approach is that
12−`ToHttpApiData Text` is overly zealous and also encodes characters, such as `*`, which are perfectly valid in a URL.
13−}
changelog.d/1580deleted−12
@@ -1,12 +0,0 @@
1−synopsis: Allow IO in validationKeys
2−prs: #1580
3−issues: #1579
4−
5−description: {
6−
7−Currently validationKeys are a fixed JWKSet. This does not work with OIDC
8−providers such as AWS Cognito or Okta, which regularly fetching jwks_uri to
9−discover new and expired keys.
10−
11−This change alters the type of validationKeys from JWKSet to IO JWKSet.
12−}
changelog.d/1589deleted−2
@@ -1,2 +0,0 @@
1−synopsis: Only include question mark for nonempty query strings
2−prs: 1589
changelog.d/1595deleted−2
@@ -1,2 +0,0 @@
1−synopsis: Run ClientEnv's makeClientRequest in IO.
2−prs: #1595
changelog.d/configdeleted−2
@@ -1,2 +0,0 @@
1−organization: haskell-servant
2−repository: servant
changelog.d/servant-docs-curldeleted−16
@@ -1,16 +0,0 @@
1−synopsis: Add sample cURL requests to generated documentation
2−prs: #1401
3−
4−description: {
5−
6−Add sample cURL requests to generated documentation.
7−
8−Those supplying changes to the Request `header` field manually using
9−lenses will need to add a sample bytestring value.
10−
11−`headers <>~ ["unicorn"]`
12−
13−becomes
14−
15−`headers <>~ [("unicorn", "sample value")]`
16−}
default.nixdeleted−38
@@ -1,38 +0,0 @@
1−with (builtins.fromJSON (builtins.readFile ./nix/nixpkgs.json));
2−{
3− pkgs ? import (builtins.fetchTarball {
4− url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";
5− inherit sha256;
6− }) {}
7−, compiler ? "ghc883"
8−}:
9−let
10− overrides = self: super: {
11− servant = self.callCabal2nix "servant" ./servant {};
12− servant-docs = self.callCabal2nix "servant-docs" ./servant-docs {};
13− servant-pipes = self.callCabal2nix "servant-pipes" ./servant-pipes {};
14− servant-server = self.callCabal2nix "servant-server" ./servant-server {};
15− servant-client = self.callCabal2nix "servant-client" ./servant-client {};
16− servant-foreign = self.callCabal2nix "servant-foreign" ./servant-foreign {};
17− servant-conduit = self.callCabal2nix "servant-conduit" ./servant-conduit {};
18− servant-machines = self.callCabal2nix "servant-machines" ./servant-machines {};
19− servant-client-core = self.callCabal2nix "servant-client-core" ./servant-client-core {};
20− servant-http-streams = self.callCabal2nix "servant-http-streams" ./servant-http-streams {};
21− };
22− hPkgs = pkgs.haskell.packages.${compiler}.override { inherit overrides; };
23−in
24− with hPkgs;
25− {
26− inherit
27− servant
28− servant-client
29− servant-client-core
30− servant-conduit
31− servant-docs
32− servant-foreign
33− servant-http-streams
34− servant-machines
35− servant-pipes
36− servant-server;
37− }
38−
doc/Makefile+1−1
@@ -10,7 +10,7 @@ BUILDDIR = _build
1010
1111# Put it first so that "make" without argument is like "make help".
1212help:
13− @if [ ! -d venv ]; then echo "WARNING: There is no venv directory, did you forget to 'virtualenv venv'. Check README.md."; fi
13+ @if [ ! -d venv ]; then echo "WARNING: There is no venv directory, did you forget to 'virtualenv venv'. Check building-the-docs file."; fi
1414 @if [ ! "z$$(which $(SPHINXBUILD))" = "z$$(pwd)/venv/bin/sphinx-build" ]; then echo "WARNING: Did you forgot to 'source venv/bin/activate'"; fi
1515 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1616
doc/conf.py+2−1
@@ -46,7 +46,7 @@ master_doc = 'index'
4646
4747# General information about the project.
4848project = u'Servant'
49−copyright = u'2022, Servant Contributors'
49+copyright = u'2018, Servant Contributors'
5050author = u'Servant Contributors'
5151
5252# The version info for the project you're documenting, acts as replacement for
@@ -169,3 +169,4 @@ texinfo_documents = [
169169source_parsers = {
170170 '.lhs': CommonMarkParser,
171171}
172+
doc/cookbook/basic-auth/basic-auth.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-basic-auth
32version: 0.1
43synopsis: Basic Authentication cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-basic-auth
1414 main-is: BasicAuth.lhs
doc/cookbook/basic-streaming/Streaming.lhs+1−4
@@ -8,10 +8,7 @@ In other words, without streaming libraries.
88- Some basic usage doesn't require usage of streaming libraries,
99 like `conduit`, `pipes`, `machines` or `streaming`.
1010 We have bindings for them though.
11−- Similar example is bundled with each of our streaming library interop packages (see
12−[servant-pipes](https://github.com/haskell-servant/servant/blob/master/servant-pipes/example/Main.hs),
13−[servant-conduit](https://github.com/haskell-servant/servant/blob/master/servant-conduit/example/Main.hs) and
14−[servant-machines](https://github.com/haskell-servant/servant/blob/master/servant-machines/example/Main.hs))
11+- This is similar example file, which is bundled with each of the packages (TODO: links)
1512- `SourceT` doesn't have *Prelude* with handy combinators, so we have to write
1613 things ourselves. (Note to self: `mapM` and `foldM` would be handy to have).
1714
doc/cookbook/basic-streaming/basic-streaming.cabal+5−5
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-basic-streaming
32version: 2.1
43synopsis: Streaming in servant without streaming libs
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-basic-streaming
1414 main-is: Streaming.lhs
@@ -17,7 +17,7 @@ executable cookbook-basic-streaming
1717 ghc-options: -Wall -pgmL markdown-unlit -threaded -rtsopts
1818
1919 hs-source-dirs: .
20− build-depends: base >= 4.8 && <5
20+ build-depends: base >= 4.8 && <4.13
2121 , aeson
2222 , bytestring
2323 , servant
doc/cookbook/cabal.project−2
@@ -1,7 +1,6 @@
11packages:
22 basic-auth/
33 curl-mock/
4− db-mysql-basics/
54 db-sqlite-simple/
65 db-postgres-pool/
76 using-custom-monad/
@@ -13,7 +12,6 @@ packages:
1312 pagination/
1413 sentry/
1514 testing/
16− open-id-connect/
1715 ../../servant
1816 ../../servant-server
1917 ../../servant-client-core
doc/cookbook/cabal.project.localdeleted

No changes to the content.

doc/cookbook/curl-mock/CurlMock.lhs+21−8
@@ -1,7 +1,7 @@
11# Generating mock curl calls
22
33In this example we will generate curl requests with mock post data from a servant API.
4−This may be useful for testing and development purposes.
4+This may be usefull for testing and development purposes.
55Especially post requests with a request body are tedious to send manually.
66
77Also, we will learn how to use the servant-foreign library to generate stuff from servant APIs.
@@ -24,6 +24,7 @@ Language extensions and imports:
2424import Control.Lens ((^.))
2525import Data.Aeson
2626import Data.Aeson.Text
27+import Data.Monoid ((<>))
2728import Data.Proxy (Proxy (Proxy))
2829import Data.Text (Text)
2930import Data.Text.Encoding (decodeUtf8)
@@ -85,7 +86,7 @@ listFromAPI :: (HasForeign lang ftype api, GenerateList ftype (Foreign ftype api
8586```
8687
8788This looks a bit confusing...
88−[Here](https://hackage.haskell.org/package/servant-foreign/docs/Servant-Foreign.html#t:HasForeign) is the documentation for the `HasForeign` typeclass.
89+[Here](https://hackage.haskell.org/package/servant-foreign-0.11.1/docs/Servant-Foreign.html#t:HasForeignType) is the documentation for the `HasForeign` typeclass.
8990We will not go into details here, but this allows us to create a value of type `ftype` for any type `a` in our API.
9091
9192In our case we want to create a mock of every type `a`.
@@ -129,12 +130,24 @@ generateCurl :: (GenerateList Mocked (Foreign Mocked api), HasForeign NoLang Moc
129130generateCurl p host =
130131 fmap T.unlines body
131132 where
132− body = mapM (generateEndpoint host)
133+ body = foldr (\endp curlCalls -> mCons (generateEndpoint host endp) curlCalls) (return [])
133134 $ listFromAPI (Proxy :: Proxy NoLang) (Proxy :: Proxy Mocked) p
134135```
135136
136−First, `listFromAPI` gives us a list of `Req Mocked`. Each `Req` describes one endpoint from the API type.
137−We generate a curl call for each of them using the following helper.
137+To understand this function, better start at the end:
138+
139+`listFromAPI` gives us a list of endpoints. We iterate over them (`foldr`) and call `generateEndpoint` for every endpoint.
140+
141+As generate endpoint will not return `Text` but `IO Text` (remember we need some random bits to mock), we cannot just use the cons operator but need to build `IO [Text]` from `IO Text`s.
142+
143+``` haskell
144+mCons :: IO a -> IO [a] -> IO [a]
145+mCons ele list =
146+ ele >>= \e -> list >>= \l -> return ( e : l )
147+```
148+
149+
150+Now comes the juicy part; accessing the endpoints data:
138151
139152``` haskell
140153generateEndpoint :: Text -> Req Mocked -> IO Text
@@ -156,7 +169,7 @@ generateEndpoint host req =
156169`servant-foreign` offers a multitude of lenses to be used with `Req`-values.
157170
158171`reqMethod` gives us a straigthforward `Network.HTTP.Types.Method`, `reqUrl` the url part and so on.
159−Just take a look at [the docs](https://hackage.haskell.org/package/servant-foreign/docs/Servant-Foreign.html).
172+Just take a look at [the docs](https://hackage.haskell.org/package/servant-foreign-0.11.1/docs/Servant-Foreign.html).
160173
161174But how do we get our mocked json string? This seems to be a bit to short to be true:
162175
@@ -188,7 +201,7 @@ And now, lets hook it all up in our main function:
188201``` haskell
189202main :: IO ()
190203main =
191− generateCurl api "localhost:8081" >>= T.IO.putStrLn
204+ generateCurl api "localhost:8081" >>= (\v -> T.IO.putStrLn v)
192205```
193206
194207Done:
@@ -200,6 +213,6 @@ curl -X POST -d '{"email":"wV򝣀_b򆎘:z񁊞򲙲!(3DM V","age":10,"name":"=|W"}
200213```
201214
202215This is of course no complete curl call mock generator, many things including path arguments are missing.
203−But it correctly generates mock calls for simple POST requests.
216+But it correctly generate mock calls for simple POST requests.
204217
205218Also, we now know how to use `HasForeignType` and `listFromAPI` to generate anything we want.
doc/cookbook/curl-mock/curl-mock.cabal+4−7
@@ -1,19 +1,16 @@
1−cabal-version: 2.2
21name: cookbook-curl-mock
32version: 0.1
43synopsis: Generate curl mock requests cookbook example
5−homepage: http://docs.servant.dev
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbock-curl-mock
14− if impl(ghc >= 9.2)
15− -- generic-arbitrary is incompatible
16− buildable: False
1714 main-is: CurlMock.lhs
1815 build-depends: base == 4.*
1916 , aeson
doc/cookbook/custom-errors/CustomErrors.lhsdeleted−189
@@ -1,189 +0,0 @@
1−# Customizing errors from Servant
2−
3−Servant handles a lot of parsing and validation of the input request. When it can't parse something: query
4−parameters, URL parts or request body, it will return appropriate HTTP codes like 400 Bad Request.
5−
6−These responses will contain the error message in their body without any formatting. However, it is often
7−desirable to be able to provide custom formatting for these error messages, for example, to wrap them in JSON.
8−
9−Recently Servant got a way to add such formatting. This Cookbook chapter demonstrates how to use it.
10−
11−Extensions and imports:
12−```haskell
13−{-# LANGUAGE DataKinds #-}
14−{-# LANGUAGE DeriveGeneric #-}
15−{-# LANGUAGE OverloadedStrings #-}
16−{-# LANGUAGE PolyKinds #-}
17−{-# LANGUAGE TypeFamilies #-}
18−{-# LANGUAGE TypeOperators #-}
19−
20−import Data.Aeson
21−import Data.Proxy
22−import Data.Text
23−import GHC.Generics
24−import Network.Wai
25−import Network.Wai.Handler.Warp
26−
27−import Servant
28−
29−import Data.String.Conversions
30− (cs)
31−import Servant.API.ContentTypes
32−```
33−
34−The API (from `greet.hs` example in Servant sources):
35−
36−```haskell
37−-- | A greet message data type
38−newtype Greet = Greet { _msg :: Text }
39− deriving (Generic, Show)
40−
41−instance FromJSON Greet
42−instance ToJSON Greet
43−
44−-- API specification
45−type TestApi =
46− -- GET /hello/:name?capital={true, false} returns a Greet as JSON
47− "hello" :> Capture "name" Text :> QueryParam "capital" Bool :> Get '[JSON] Greet
48−
49− -- POST /greet with a Greet as JSON in the request body,
50− -- returns a Greet as JSON
51− :<|> "greet" :> ReqBody '[JSON] Greet :> Post '[JSON] Greet
52−
53− -- DELETE /greet/:greetid
54− :<|> "greet" :> Capture "greetid" Text :> Delete '[JSON] NoContent
55−
56−testApi :: Proxy TestApi
57−testApi = Proxy
58−
59−-- Server-side handlers.
60−--
61−-- There's one handler per endpoint, which, just like in the type
62−-- that represents the API, are glued together using :<|>.
63−--
64−-- Each handler runs in the 'Handler' monad.
65−server :: Server TestApi
66−server = helloH :<|> postGreetH :<|> deleteGreetH
67−
68− where helloH name Nothing = helloH name (Just False)
69− helloH name (Just False) = return . Greet $ "Hello, " <> name
70− helloH name (Just True) = return . Greet . toUpper $ "Hello, " <> name
71−
72− postGreetH greet = return greet
73−
74− deleteGreetH _ = return NoContent
75−```
76−
77−## Error formatters
78−
79−`servant-server` provides an `ErrorFormatter` type to specify how the error message will be
80−formatted. A formatter is just a function accepting three parameters:
81−
82−- `TypeRep` from `Data.Typeable`: this is a runtime representation of the type of the combinator
83− (like `Capture` or `ReqBody`) that generated the error. It can be used to display its name (with
84− `show`) or even dynamically dispatch on the combinator type. See the docs for `Data.Typeable` and
85− `Type.Reflection` modules.
86−- `Request`: full information for the request that led to the error.
87−- `String`: specific error message from the combinator.
88−
89−The formatter is expected to produce a `ServerError` which will be returned from the handler.
90−
91−Additionally, there is `NotFoundErrorFormatter`, which accepts only `Request` and can customize the
92−error in case when no route can be matched (HTTP 404).
93−
94−Let's make two formatters. First one will wrap our error in a JSON:
95−
96−```json
97−{
98− "error": "ERROR MESSAGE",
99− "combinator": "NAME OF THE COMBINATOR"
100−}
101−```
102−
103−Additionally, this formatter will examine the `Accept` header of the request and generate JSON
104−message only if client can accept it.
105−
106−```haskell
107−customFormatter :: ErrorFormatter
108−customFormatter tr req err =
109− let
110− -- aeson Value which will be sent to the client
111− value = object ["combinator" .= show tr, "error" .= err]
112− -- Accept header of the request
113− accH = getAcceptHeader req
114− in
115− -- handleAcceptH is Servant's function that checks whether the client can accept a
116− -- certain message type.
117− -- In this case we call it with "Proxy '[JSON]" argument, meaning that we want to return a JSON.
118− case handleAcceptH (Proxy :: Proxy '[JSON]) accH value of
119− -- If client can't handle JSON, we just return the body the old way
120− Nothing -> err400 { errBody = cs err }
121− -- Otherwise, we return the JSON formatted body and set the "Content-Type" header.
122− Just (ctypeH, body) -> err400
123− { errBody = body
124− , errHeaders = [("Content-Type", cs ctypeH)]
125− }
126−
127−notFoundFormatter :: NotFoundErrorFormatter
128−notFoundFormatter req =
129− err404 { errBody = cs $ "Not found path: " <> rawPathInfo req }
130−```
131−
132−If you don't need to react to the `Accept` header, you can just unconditionally return the JSON like
133−this (with `encode` from `Data.Aeson`):
134−
135−```
136−err400
137− { errBody = encode body
138− , errHeaders = [("Content-Type", "application/json")]
139− }
140−```
141−
142−## Passing formatters to Servant
143−
144−Servant uses the Context to configure formatters. You only need to add a value of type
145−`ErrorFormatters` to your context. This is a record with the following fields:
146−
147−- `bodyParserErrorFormatter :: ErrorFormatter`
148−- `urlParseErrorFormatter :: ErrorFormatter`
149−- `headerParseErrorFormatter :: ErrorFormatter`
150−- `notFoundErrorFormatter :: NotFoundErrorFormatter`
151−
152−Default formatters are exported as `defaultErrorFormatters`, so you can use record update syntax to
153−set the only ones you need:
154−
155−```haskell
156−customFormatters :: ErrorFormatters
157−customFormatters = defaultErrorFormatters
158− { bodyParserErrorFormatter = customFormatter
159− , notFoundErrorFormatter = notFoundFormatter
160− }
161−```
162−
163−And at last, use `serveWithContext` to run your server as usual:
164−
165−```haskell
166−app :: Application
167−app = serveWithContext testApi (customFormatters :. EmptyContext) server
168−
169−main :: IO ()
170−main = run 8000 app
171−```
172−
173−Now if we try to request something with a wrong body, we will get a nice error:
174−
175−```
176−$ http -j POST localhost:8000/greet 'foo=bar'
177−HTTP/1.1 400 Bad Request
178−Content-Type: application/json;charset=utf-8
179−Date: Fri, 17 Jul 2020 13:34:18 GMT
180−Server: Warp/3.3.12
181−Transfer-Encoding: chunked
182−
183−{
184− "combinator": "ReqBody'",
185− "error": "Error in $: parsing Main.Greet(Greet) failed, key \"_msg\" not found"
186−}
187−```
188−
189−Notice the `Content-Type` header set by our combinator.
doc/cookbook/custom-errors/custom-errors.cabaldeleted−25
@@ -1,25 +0,0 @@
1−cabal-version: 2.2
2−name: cookbook-custom-errors
3−version: 0.1
4−synopsis: Return custom error messages from combinators
5−homepage: http://docs.servant.dev
6−license: BSD-3-Clause
7−license-file: ../../../servant/LICENSE
8−author: Servant Contributors
9−maintainer: haskell-servant-maintainers@googlegroups.com
10−build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
12−
13−executable cookbook-custom-errors
14− main-is: CustomErrors.lhs
15− build-depends: base == 4.*
16− , aeson
17− , servant
18− , servant-server
19− , string-conversions
20− , text
21− , wai
22− , warp
23− default-language: Haskell2010
24− ghc-options: -Wall -pgmL markdown-unlit
25− build-tool-depends: markdown-unlit:markdown-unlit
doc/cookbook/db-mysql-basics/MysqlBasics.lhsdeleted−236
@@ -1,236 +0,0 @@
1−# Overview
2−
3−This doc will walk through a single-module implementation of a servant API connecting to a MySQL database. It will also include some basic CRUD operations.
4−
5−Once you can wrap your head around this implementation, understanding more complex features like resource pools would be beneficial next steps.
6−
7−The only *prerequisite* is that you have a MySQL database open on port 3306 of your machine. Docker is an easy way to manage this.
8−
9−## Setup
10−
11−- The mysql database should be up and running on 127.0.0.1:3306
12−
13−- Our API will be exposed on localhost:8080
14−
15−## REST actions available
16−
17−*Get all people*
18−
19−```
20−/people GET
21−```
22−
23−*Get person by ID*
24−
25−```
26−/people/:id GET
27−```
28−
29−*Insert a new person*
30−
31−```
32−/people POST
33−
34−{
35− "name": "NewName",
36− "age": 24
37−}
38−```
39−
40−*Delete a person*
41−
42−```
43−/people/:id DELETE
44−```
45−
46−## Other notes
47−
48−At the time of writing this issue may occur when building your project:
49−
50−```
51−setup: Missing dependencies on foreign libraries:
52−* Missing (or bad) C libraries: ssl, crypto
53−```
54−
55−If using stack, this can be fixed by adding the following lines to your `stack.yaml`:
56−
57−```
58−extra-include-dirs:
59−- /usr/local/opt/openssl/include
60−extra-lib-dirs:
61−- /usr/local/opt/openssl/lib
62−```
63−
64−Or for cabal, running your builds with these configurations passed as options.
65−
66−## Implementation: Main.hs
67−
68−Let's jump in:
69−
70−```haskell
71−{-# LANGUAGE DataKinds #-}
72−{-# LANGUAGE DeriveGeneric #-}
73−{-# LANGUAGE FlexibleInstances #-}
74−{-# LANGUAGE GADTs #-}
75−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
76−{-# LANGUAGE MultiParamTypeClasses #-}
77−{-# LANGUAGE QuasiQuotes #-}
78−{-# LANGUAGE TemplateHaskell #-}
79−{-# LANGUAGE TypeFamilies #-}
80−{-# LANGUAGE TypeOperators #-}
81−module Lib where
82−
83−import Control.Monad.IO.Class (liftIO)
84−import Control.Monad.Logger (NoLoggingT (..))
85−import Control.Monad.Trans.Reader (runReaderT)
86−import Control.Monad.Trans.Resource (ResourceT, runResourceT)
87−import Data.Aeson as JSON
88−import Data.Int (Int64 (..))
89−import Data.Text (Text)
90−import qualified Data.Text as T
91−import qualified Data.Text.IO as T
92−import Database.Persist
93−import Database.Persist.MySQL (ConnectInfo (..),
94− SqlBackend (..),
95− defaultConnectInfo, fromSqlKey, runMigration,
96− runSqlPool, toSqlKey, withMySQLConn)
97−import Database.Persist.Sql (SqlPersistT, runSqlConn)
98−import Database.Persist.TH (mkMigrate, mkPersist,
99− persistLowerCase, share,
100− sqlSettings)
101−import Database.Persist.Types (PersistValue(PersistInt64))
102−import Servant (Handler, throwError)
103−
104−import GHC.Generics
105−import Network.Wai
106−import Network.Wai.Handler.Warp
107−import Servant
108−import Servant.API
109−import System.Environment (getArgs)
110−
111−share [mkPersist sqlSettings, mkMigrate "migrateAll"] [persistLowerCase|
112−Person json
113− Id Int Primary Unique
114− name Text
115− age Text
116− deriving Eq Show Generic
117−|]
118−
119−type Api =
120− "person" :> Get '[JSON] [Person]
121− :<|> "person" :> Capture "id" Int :> Get '[JSON] Person
122− :<|> "person" :> Capture "id" Int :> Delete '[JSON] ()
123− :<|> "person" :> ReqBody '[JSON] Person :> Post '[JSON] Person
124−
125−apiProxy :: Proxy Api
126−apiProxy = Proxy
127−
128−app :: Application
129−app = serve apiProxy server
130−
131−-- Run a database operation, and lift the result into a Handler.
132−-- This minimises usage of IO operations in other functions
133−runDB :: SqlPersistT (ResourceT (NoLoggingT IO)) a -> Handler a
134−runDB a = liftIO $ runNoLoggingT $ runResourceT $ withMySQLConn connInfo $ runSqlConn a
135−
136−-- Change these out to suit your local setup
137−connInfo :: ConnectInfo
138−connInfo = defaultConnectInfo { connectHost = "127.0.0.1", connectUser = "root", connectPassword = "abcd", connectDatabase = "test-database" }
139−
140−doMigration :: IO ()
141−doMigration = runNoLoggingT $ runResourceT $ withMySQLConn connInfo $ runReaderT $ runMigration migrateAll
142−
143−server :: Server Api
144−server =
145− personGET :<|>
146− personGETById :<|>
147− personDELETE :<|>
148− personPOST
149− where
150− personGET = selectPersons
151− personGETById id = selectPersonById id
152− personDELETE id = deletePerson id
153− personPOST personJson = createPerson personJson
154−
155−selectPersons :: Handler [Person]
156−selectPersons = do
157− personList <- runDB $ selectList [] []
158− return $ map (\(Entity _ u) -> u) personList
159−
160−selectPersonById :: Int -> Handler Person
161−selectPersonById id = do
162− sqlResult <- runDB $ get $ PersonKey id
163− case sqlResult of
164− Just person -> return person
165− Nothing -> throwError err404 { errBody = JSON.encode "Person with ID not found." }
166−
167−createPerson :: Person -> Handler Person
168−createPerson person = do
169− attemptCreate <- runDB $ insert person
170− case attemptCreate of
171− PersonKey k -> return person
172− _ -> throwError err503 { errBody = JSON.encode "Could not create Person." }
173−
174−deletePerson :: Int -> Handler ()
175−deletePerson id = do runDB $ delete $ PersonKey id
176−
177−startApp :: IO ()
178−startApp = do
179− args <- getArgs
180− let arg1 = if not (null args) then Just (head args) else Nothing
181− case arg1 of
182− Just "migrate" -> doMigration
183− _ -> run 8080 app
184−```
185−
186−## Sample requests
187−
188−Assuming that you have the db running and have first run `stack exec run migrate`, the following sample requests will test your API:
189−
190−*Create a person*
191−
192−```bash
193−curl -X POST \
194− http://localhost:8080/person \
195− -H 'Accept: */*' \
196− -H 'Accept-Encoding: gzip, deflate' \
197− -H 'Cache-Control: no-cache' \
198− -H 'Connection: keep-alive' \
199− -H 'Content-Length: 62' \
200− -H 'Content-Type: application/json' \
201− -H 'Host: localhost:8080' \
202− -H 'cache-control: no-cache' \
203− -d '{
204− "name": "Jake",
205− "age": "25"
206−}'
207−```
208−
209−*Get all persons*
210−
211−```bash
212−curl -X GET \
213− http://localhost:8080/person \
214− -H 'Accept: */*' \
215− -H 'Accept-Encoding: gzip, deflate' \
216− -H 'Cache-Control: no-cache' \
217− -H 'Connection: keep-alive' \
218− -H 'Content-Length: 33' \
219− -H 'Content-Type: application/json' \
220− -H 'Host: localhost:8080' \
221− -H 'cache-control: no-cache'
222−```
223−
224−*Get person by ID*
225−
226−```bash
227−curl -X GET \
228− http://localhost:8080/person/1 \
229− -H 'Accept: */*' \
230− -H 'Accept-Encoding: gzip, deflate' \
231− -H 'Cache-Control: no-cache' \
232− -H 'Connection: keep-alive' \
233− -H 'Content-Type: application/json' \
234− -H 'Host: localhost:8080' \
235− -H 'cache-control: no-cache'
236−```
doc/cookbook/db-mysql-basics/mysql-basics.cabaldeleted−40
@@ -1,40 +0,0 @@
1−cabal-version: 2.2
2−name: mysql-basics
3−version: 0.1.0.0
4−synopsis: Simple MySQL API cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
7−license-file: ../../../servant/LICENSE
8−author: Servant Contributors
9−maintainer: haskell-servant-maintainers@googlegroups.com
10−build-type: Simple
11−
12−executable run
13− hs-source-dirs: .
14− main-is: MysqlBasics.hs
15− ghc-options: -threaded -rtsopts -with-rtsopts=-N
16− build-depends: aeson
17− , base
18− , bytestring
19− , http-client
20− , monad-logger
21− , mysql-simple
22− , persistent
23− , persistent-mysql
24− , persistent-template
25− , resource-pool
26− , resourcet
27− , servant
28− , servant-client
29− , servant-server
30− , text
31− , transformers
32− , wai
33− , warp
34− default-language: Haskell2010
35− ghc-options: -Wall -pgmL markdown-unlit
36− build-tool-depends: markdown-unlit:markdown-unlit
37−
38−source-repository head
39− type: git
40− location: https://github.com/githubuser/mysql-basics
doc/cookbook/db-postgres-pool/db-postgres-pool.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-db-postgres-pool
32version: 0.1
43synopsis: Simple PostgreSQL connection pool cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-db-postgres-pool
1414 main-is: PostgresPool.lhs
doc/cookbook/db-sqlite-simple/db-sqlite-simple.cabal+5−5
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-db-sqlite-simple
32version: 0.1
43synopsis: Simple SQLite DB cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-db-sqlite-simple
1414 main-is: DBConnection.lhs
@@ -23,7 +23,7 @@ executable cookbook-db-sqlite-simple
2323 , http-types >= 0.12
2424 , markdown-unlit >= 0.4
2525 , http-client >= 0.5
26− , sqlite-simple >= 0.4.5.0
26+ , sqlite-simple >= 0.4
2727 , transformers
2828 default-language: Haskell2010
2929 ghc-options: -Wall -pgmL markdown-unlit
doc/cookbook/file-upload/FileUpload.lhs+3−3
@@ -90,8 +90,8 @@ startServer = run 8080 (serve api upload)
9090
9191Finally, a main function that brings up our server and
9292sends some test request with `http-client` (and not
93−servant-client this time, as servant-multipart does not
94−yet have support for client generation).
93+servant-client this time, has servant-multipart does not
94+yet have support for client generation.
9595
9696``` haskell
9797main :: IO ()
@@ -126,7 +126,7 @@ Content of "README.md"
126126
127127## Getting Started
128128
129−We have a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) that
129+We have a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) that
130130introduces the core features of servant. After this article, you should be able
131131to write your first servant webservices, learning the rest from the haddocks'
132132examples.
doc/cookbook/file-upload/file-upload.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-file-upload
32version: 0.1
43synopsis: File upload cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-file-upload
1414 main-is: FileUpload.lhs
doc/cookbook/generic/Generic.lhs+3−3
@@ -43,13 +43,13 @@ api :: Proxy (ToServantApi Routes)
4343api = genericApi (Proxy :: Proxy Routes)
4444```
4545
46−It's recommended to use `genericApi` function, as then you'll get
46+It's recommented to use `genericApi` function, as then you'll get
4747better error message, for example if you forget to `derive Generic`.
4848
4949## Links
5050
5151The clear advantage of record-based generics approach, is that
52−we can get safe links very conveniently. We don't need to define endpoint types,
52+we can get safe links very conviently. We don't need to define endpoint types,
5353as field accessors work as proxies:
5454
5555```haskell
@@ -67,7 +67,7 @@ routesLinks = allFieldLinks
6767## Client
6868
6969Even more power starts to show when we generate a record of client functions.
70−Here we use `genericClientHoist` function, which lets us simultaneously
70+Here we use `genericClientHoist` function, which let us simultaneously
7171hoist the monad, in this case from `ClientM` to `IO`.
7272
7373```haskell
doc/cookbook/generic/generic.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-generic
32version: 0.1
43synopsis: Using custom monad to pass a state between handlers
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-using-custom-monad
1414 main-is: Generic.lhs
doc/cookbook/hoist-server-with-context/HoistServerWithContext.lhs+2−2
@@ -254,7 +254,7 @@ loginHandler cookieSettings jwtSettings form = do
254254 liftIO $ pushLogStrLn logset $ toLogStr logMsg
255255 throwError err401
256256 Just applyCookies -> do
257− let successMsg = logMsg{message = "AdminUser successfully authenticated!"}
257+ let successMsg = logMsg{message = "AdminUser succesfully authenticated!"}
258258 liftIO $ pushLogStrLn logset $ toLogStr successMsg
259259 pure $ applyCookies successMsg
260260loginHandler _ _ _ = throwError err401
@@ -287,7 +287,7 @@ mkApp cfg cs jwts ctx =
287287 (flip runReaderT ctx) (adminServer cs jwts)
288288```
289289
290−One footnote: because we'd like our logs to be in JSON form, we'll also create a `Middleware` object
290+One footenote: because we'd like our logs to be in JSON form, we'll also create a `Middleware` object
291291so that `Warp` *also* will emit logs as JSON. This will ensure *all* logs are emitted as JSON:
292292
293293```haskell
doc/cookbook/hoist-server-with-context/hoist-server-with-context.cabal+5−5
@@ -1,17 +1,17 @@
1−cabal-version: 2.2
21name: cookbook-hoist-server-with-context
32version: 0.0.1
43synopsis: JWT and basic access authentication with a Custom Monad cookbook example
54description: Using servant-auth to support both JWT-based and basic
65 authentication.
7−homepage: http://docs.servant.dev/
8−license: BSD-3-Clause
6+homepage: http://haskell-servant.readthedocs.org/
7+license: BSD3
98license-file: ../../../servant/LICENSE
109author: Servant Contributors
1110maintainer: haskell-servant-maintainers@googlegroups.com
1211category: Servant
1312build-type: Simple
14−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
13+cabal-version: >=1.10
14+tested-with: GHC==8.4.4, GHC==8.6.3
1515
1616executable cookbook-hoist-server-with-context
1717 main-is: HoistServerWithContext.lhs
@@ -24,7 +24,7 @@ executable cookbook-hoist-server-with-context
2424 , servant
2525 , servant-server
2626 , servant-auth >= 0.3.2
27− , servant-auth-server >= 0.4.4.0
27+ , servant-auth-server
2828 , time
2929 , warp >= 3.2
3030 , wai >= 3.2
doc/cookbook/https/Https.lhs+5−5
@@ -34,16 +34,16 @@ app = serve api server
3434```
3535
3636It's now time to actually run the `Application`.
37−The [`warp-tls`](https://hackage.haskell.org/package/warp-tls/docs/Network-Wai-Handler-WarpTLS.html)
37+The [`warp-tls`](https://hackage.haskell.org/package/warp-tls-3.2.4/docs/Network-Wai-Handler-WarpTLS.html)
3838package provides two functions for running an `Application`, called
39−[`runTLS`](https://hackage.haskell.org/package/warp-tls/docs/Network-Wai-Handler-WarpTLS.html#v:runTLS)
40−and [`runTLSSocket`](https://hackage.haskell.org/package/warp-tls/docs/Network-Wai-Handler-WarpTLS.html#v:runTLSSocket).
39+[`runTLS`](https://hackage.haskell.org/package/warp-tls-3.2.4/docs/Network-Wai-Handler-WarpTLS.html#v:runTLS)
40+and [`runTLSSocket`](https://hackage.haskell.org/package/warp-tls-3.2.4/docs/Network-Wai-Handler-WarpTLS.html#v:runTLSSocket).
4141We will be using the first one.
4242
4343It takes two arguments,
44−[the TLS settings](https://hackage.haskell.org/package/warp-tls/docs/Network-Wai-Handler-WarpTLS.html#t:TLSSettings)
44+[the TLS settings](https://hackage.haskell.org/package/warp-tls-3.2.4/docs/Network-Wai-Handler-WarpTLS.html#t:TLSSettings)
4545(certificates, keys, ciphers, etc)
46−and [the warp settings](https://hackage.haskell.org/package/warp/docs/Network-Wai-Handler-Warp-Internal.html#t:Settings)
46+and [the warp settings](https://hackage.haskell.org/package/warp-3.2.12/docs/Network-Wai-Handler-Warp-Internal.html#t:Settings)
4747(port, logger, etc).
4848
4949We will be using very simple settings for this example but you are of
doc/cookbook/https/https.cabal+5−5
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-https
32version: 0.1
43synopsis: HTTPS cookbook example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-https
1414 main-is: Https.lhs
@@ -17,7 +17,7 @@ executable cookbook-https
1717 , servant-server
1818 , wai >= 3.2
1919 , warp >= 3.2
20− , warp-tls >= 3.2.9
20+ , warp-tls >= 3.2
2121 , markdown-unlit >= 0.4
2222 default-language: Haskell2010
2323 ghc-options: -Wall -pgmL markdown-unlit
doc/cookbook/index.rst+2−7
@@ -6,8 +6,8 @@ how to solve many common problems with servant. If you're
66interested in contributing examples of your own, feel free
77to open an issue or a pull request on
88`our github repository <https://github.com/haskell-servant/servant>`_
9−or even to just get in touch with us on the `**#haskell-servant** IRC channel
10−on libera.chat <https://web.libera.chat/#haskell-servant>_ or on
9+or even to just get in touch with us on the **#servant** IRC channel
10+on freenode or on
1111`the mailing list <https://groups.google.com/forum/#!forum/haskell-servant>`_.
1212
1313The scope is very wide. Simple and fancy authentication schemes,
@@ -20,15 +20,11 @@ you name it!
2020 structuring-apis/StructuringApis.lhs
2121 generic/Generic.lhs
2222 https/Https.lhs
23− db-mysql-basics/MysqlBasics.lhs
2423 db-sqlite-simple/DBConnection.lhs
2524 db-postgres-pool/PostgresPool.lhs
2625 using-custom-monad/UsingCustomMonad.lhs
2726 using-free-client/UsingFreeClient.lhs
28− custom-errors/CustomErrors.lhs
29− uverb/UVerb.lhs
3027 basic-auth/BasicAuth.lhs
31− basic-streaming/Streaming.lhs
3228 jwt-and-basic-auth/JWTAndBasicAuth.lhs
3329 hoist-server-with-context/HoistServerWithContext.lhs
3430 file-upload/FileUpload.lhs
@@ -36,4 +32,3 @@ you name it!
3632 curl-mock/CurlMock.lhs
3733 sentry/Sentry.lhs
3834 testing/Testing.lhs
39− open-id-connect/OpenIdConnect.lhs
doc/cookbook/jwt-and-basic-auth/jwt-and-basic-auth.cabal+5−5
@@ -1,17 +1,17 @@
1−cabal-version: 2.2
21name: cookbook-jwt-and-basic-auth
32version: 0.0.1
43synopsis: JWT and basic access authentication cookbook example
54description: Using servant-auth to support both JWT-based and basic
65 authentication.
7−homepage: http://docs.servant.dev/
8−license: BSD-3-Clause
6+homepage: http://haskell-servant.readthedocs.org/
7+license: BSD3
98license-file: ../../../servant/LICENSE
109author: Servant Contributors
1110maintainer: haskell-servant-maintainers@googlegroups.com
1211category: Servant
1312build-type: Simple
14−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
13+cabal-version: >=1.10
14+tested-with: GHC==8.4.4, GHC==8.6.3
1515
1616executable cookbook-jwt-and-basic-auth
1717 main-is: JWTAndBasicAuth.lhs
@@ -22,7 +22,7 @@ executable cookbook-jwt-and-basic-auth
2222 , servant
2323 , servant-client
2424 , servant-server
25− , servant-auth == 0.4.*
25+ , servant-auth ==0.3.*
2626 , servant-auth-server >= 0.3.1.0
2727 , warp >= 3.2
2828 , wai >= 3.2
doc/cookbook/open-id-connect/OpenIdConnect.cabaldeleted−45
@@ -1,45 +0,0 @@
1−cabal-version: 2.2
2−name: open-id-connect
3−version: 0.1
4−synopsis: OpenId Connect with Servant example
5−homepage: http://haskell-servant.readthedocs.org/
6−license: BSD-3-Clause
7−license-file: ../../../servant/LICENSE
8−author: Servant Contributors
9−maintainer: haskell-servant-maintainers@googlegroups.com
10−build-type: Simple
11−tested-with: GHC==8.6.5
12−
13−executable cookbook-openidconnect
14− main-is: OpenIdConnect.lhs
15− build-depends: base ==4.*
16− , aeson
17− , aeson-pretty
18− , binary
19− , blaze-html
20− , blaze-markup
21− , bytestring
22− , case-insensitive
23− , cereal
24− , containers
25− , generic-lens
26− , http-client
27− , http-client-tls
28− , http-types
29− , jose-jwt
30− , lens
31− , lens-aeson
32− , oidc-client
33− , protolude
34− , random
35− , servant
36− , servant-blaze
37− , servant-server
38− , text
39− , time
40− , vector
41− , wai
42− , warp >= 3.2
43− default-language: Haskell2010
44− ghc-options: -Wall -Wcompat -Wincomplete-uni-patterns -Wredundant-constraints -Wnoncanonical-monad-instances -pgmL markdown-unlit
45− build-tool-depends: markdown-unlit:markdown-unlit >= 0.4
doc/cookbook/open-id-connect/OpenIdConnect.lhsdeleted−472
@@ -1,472 +0,0 @@
1−[OpenID Connect](https://openid.net/connect/)
2−=============================================
3−
4−Use OpenID Connect to authenticate your users.
5−This example use google OIDC provider.
6−It was made for a working with single page application where
7−some login token would be saved in the user agent local storage.
8−
9−Workflow:
10−
11−1. user is presented with a login button,
12−2. when the user clicks on the button it is redirected to the OIDC
13− provider,
14−3. the user login in the OIDC provider,
15−4. the OIDC provider will redirect the user and provide a `code`,
16−5. the server will use this code to make a POST to the OIDC provider
17− and will get back authentication infos,
18−6. The user will get display an HTML page that will save a secret
19− identifying him in the local storage, then it will be redirected to
20− /.
21−
22−Let's put the imports behind us:
23−
24−``` haskell
25−{-# LANGUAGE DataKinds #-}
26−{-# LANGUAGE DeriveGeneric #-}
27−{-# LANGUAGE DuplicateRecordFields #-}
28−{-# LANGUAGE FlexibleContexts #-}
29−{-# LANGUAGE FlexibleInstances #-}
30−{-# LANGUAGE MultiParamTypeClasses #-}
31−{-# LANGUAGE NoImplicitPrelude #-}
32−{-# LANGUAGE OverloadedLists #-}
33−{-# LANGUAGE OverloadedStrings #-}
34−{-# LANGUAGE PartialTypeSignatures #-}
35−{-# LANGUAGE PolyKinds #-}
36−{-# LANGUAGE RankNTypes #-}
37−{-# LANGUAGE RecordWildCards #-}
38−{-# LANGUAGE ScopedTypeVariables #-}
39−{-# LANGUAGE TypeFamilies #-}
40−{-# LANGUAGE TypeOperators #-}
41−{-# LANGUAGE TypeSynonymInstances #-}
42−
43−module Main where
44−
45−import Protolude
46−
47−import Data.Aeson
48− (FromJSON (..), (.:))
49−import qualified Data.Aeson as JSON
50−import qualified Data.Aeson.Types as AeT
51−import qualified Data.ByteString.Lazy as LBS
52−import qualified Data.List as List
53−import qualified Data.Text as Text
54−import Jose.Jwt
55− (Jwt (..), decodeClaims)
56−import Network.HTTP.Client
57− (Manager, newManager)
58−import Network.HTTP.Client.TLS
59− (tlsManagerSettings)
60−import Network.Wai.Handler.Warp
61− (run)
62−import Servant
63−import Servant.HTML.Blaze
64− (HTML)
65−import qualified System.Random as Random
66−import Text.Blaze
67− (ToMarkup (..))
68−import qualified Text.Blaze.Html as H
69−import Text.Blaze.Html5
70− ((!))
71−import qualified Text.Blaze.Html5 as H
72−import qualified Text.Blaze.Html5.Attributes as HA
73−import Text.Blaze.Renderer.Utf8
74− (renderMarkup)
75−import qualified Web.OIDC.Client as O
76−```
77−
78−You'll need to create a new OpenID Connect client in an OpenID Provider.
79−This example was tested with Google.
80−
81−You can find a list of public OIDC provider here:
82−https://connect2id.com/products/nimbus-oauth-openid-connect-sdk/openid-connect-providers
83−
84−I copied some here:
85−
86−- Google: https://developers.google.com/identity/protocols/OpenIDConnect
87− more precisely: https://console.developers.google.com/apis/credentials
88−- Microsoft: https://docs.microsoft.com/en-us/previous-versions/azure/dn645541(v=azure.100)
89−- Yahoo: https://developer.yahoo.com/oauth2/guide/openid_connect/
90−- PayPal: https://developer.paypal.com/docs/integration/direct/identity/log-in-with-paypal/
91−
92−During the configuration you'll need to provide a redirect uri.
93−The redirect_uri should correspond to the uri user will be redirected to
94−after a successful login into the OpenID provider.
95−
96−So during your test, you should certainly just use `http://localhost:3000/login/cb`.
97−In general you should use your own domain name.
98−
99−You'll then be given a `client_id` and a `client_password`.
100−Fill those values in here:
101−
102−``` haskell
103−oidcConf :: OIDCConf
104−oidcConf = OIDCConf { redirectUri = "http://localhost:3000/login/cb"
105− , clientId = "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com"
106− , clientPassword = "************************" }
107−```
108−
109−Then we declare our main server:
110−
111−``` haskell
112−main :: IO ()
113−main = do
114− oidcEnv <- initOIDC oidcConf
115− run 3000 (app oidcEnv)
116−
117−type API = IdentityRoutes Customer
118− :<|> Get '[HTML] Homepage
119−
120−api :: Proxy API
121−api = Proxy
122−
123−server :: OIDCEnv -> Server API
124−server oidcEnv = serveOIDC oidcEnv handleOIDCLogin
125− :<|> return Homepage
126−
127−-- | Then main app
128−app :: OIDCEnv -> Application
129−app oidcEnv = serve api (server oidcEnv)
130−```
131−
132−OIDC
133−----
134−
135−That part try to separate concern, and certainly in a real world
136−application that should be in its distinct module.
137−
138−``` haskell
139−-- * OIDC
140−
141−data OIDCConf =
142− OIDCConf { redirectUri :: ByteString
143− , clientId :: ByteString
144− , clientPassword :: ByteString
145− } deriving (Show, Eq)
146−```
147−
148−First we need to initialize OIDC.
149−A short explanation about it:
150−
151−- to complete the workflow we need to make a POST request to the OIDC provider.
152− So we need to create an http manager to make those call properly.
153−- Then in order to prevent replay attack, each time an user wants to login we
154− should provide a random string called the `state`. When the user is
155− redirected to the `redirect_uri`, the OIDC provider should provide the same
156− `state` along a `code` parameter.
157−
158−``` haskell
159−initOIDC :: OIDCConf -> IO OIDCEnv
160−initOIDC OIDCConf{..} = do
161− mgr <- newManager tlsManagerSettings
162− prov <- O.discover "https://accounts.google.com" mgr
163− let oidc = O.setCredentials clientId clientPassword redirectUri (O.newOIDC prov)
164− return OIDCEnv { oidc = oidc
165− , mgr = mgr
166− , genState = genRandomBS
167− , prov = prov
168− , redirectUri = redirectUri
169− , clientId = clientId
170− , clientPassword = clientPassword
171− }
172−
173−data OIDCEnv = OIDCEnv { oidc :: O.OIDC
174− , mgr :: Manager
175− , genState :: IO ByteString
176− , prov :: O.Provider
177− , redirectUri :: ByteString
178− , clientId :: ByteString
179− , clientPassword :: ByteString
180− }
181−```
182−
183−The `IdentityRoutes` are two endpoints:
184−
185−- an endpoint to redirect the users to the OIDC Provider,
186−- another one the user will be redirected to from the OIDC Provider.
187−
188−``` haskell
189−type IdentityRoutes a =
190− "login" :> ( -- redirect User to the OpenID Provider
191− Get '[JSON] NoContent
192− -- render the page that will save the user creds in the user-agent
193− :<|> "cb" :> QueryParam "error" Text
194− :> QueryParam "code" Text
195− :> Get '[HTML] User)
196−
197−-- | gen a 302 redirect helper
198−redirects :: (StringConv s ByteString) => s -> Handler ()
199−redirects url = throwError err302 { errHeaders = [("Location",toS url)]}
200−```
201−
202−That function will generate the URL to redirect the users to when
203−they'll click on the login link: `https://yourdomain/login`.
204−
205−``` haskell
206−genOIDCURL :: OIDCEnv -> IO ByteString
207−genOIDCURL OIDCEnv{..} = do
208− st <- genState -- generate a random string
209− let oidcCreds = O.setCredentials clientId clientPassword redirectUri (O.newOIDC prov)
210− loc <- O.getAuthenticationRequestUrl oidcCreds [O.openId, O.email, O.profile] (Just st) []
211− return (show loc)
212−
213−handleLogin :: OIDCEnv -> Handler NoContent
214−handleLogin oidcenv = do
215− loc <- liftIO (genOIDCURL oidcenv)
216− redirects loc
217− return NoContent
218−```
219−
220−The `AuthInfo` is about the infos we can grab from OIDC provider.
221−
222−To be more precise, the user should come with a `code` (a token) and
223−POSTing that code to the correct OIDC provider endpoint should return a JSON
224−object. One of the fields should be named `id_token` which should be a
225−JWT containing all the information we need. Depending on the scopes we
226−asked we might get more information.
227−
228−``` haskell
229−-- | @AuthInfo@
230−data AuthInfo = AuthInfo { email :: Text
231− , emailVerified :: Bool
232− , name :: Text } deriving (Eq, Show, Generic)
233−
234−instance FromJSON AuthInfo where
235− parseJSON (JSON.Object v) = do
236− email :: Text <- v .: "email"
237− email_verified :: Bool <- v .: "email_verified"
238− name :: Text <- v .: "name"
239− return $ AuthInfo (toS email) email_verified (toS name)
240− parseJSON invalid = AeT.typeMismatch "Coord" invalid
241−instance JSON.ToJSON AuthInfo where
242− toJSON (AuthInfo e ev n) =
243− JSON.object [ "email" JSON..= (toS e :: Text)
244− , "email_verified" JSON..= ev
245− , "name" JSON..= (toS n :: Text)
246− ]
247−
248−type LoginHandler = AuthInfo -> IO (Either Text User)
249−```
250−
251−The `handleLoggedIn` is that part that will retrieve the information from
252−the user once he is redirected from the OIDC Provider after login.
253−
254−If the user is redirected to the `redirect_uri` but with an `error` query
255−parameter then it means something went wrong.
256−If there is no error query param but a `code` query param it means the user
257−successfully logged in. From there we need to make a request to the token
258−endpoint of the OIDC provider. It's a POST that should contain the code
259−as well as the client id and secret.
260−Making this HTTP POST is the responsibility of `requestTokens`.
261−
262−From there we extract the `claims` of the JWT contained in one of the value
263−of the JSON returned by the POST HTTP Request.
264−
265−``` haskell
266−data User = User { userId :: Text
267− , userSecret :: Text
268− , localStorageKey :: Text
269− , redirectUrl :: Maybe Text
270− } deriving (Show,Eq,Ord)
271−
272−handleLoggedIn :: OIDCEnv
273− -> LoginHandler -- ^ handle successful id
274− -> Maybe Text -- ^ error
275− -> Maybe Text -- ^ code
276− -> Handler User
277−handleLoggedIn oidcenv handleSuccessfulId err mcode =
278− case err of
279− Just errorMsg -> forbidden errorMsg
280− Nothing -> case mcode of
281− Just oauthCode -> do
282− tokens <- liftIO $ O.requestTokens (oidc oidcenv) (toS oauthCode) (mgr oidcenv)
283− putText . show . O.claims . O.idToken $ tokens
284− let jwt = toS . unJwt . O.jwt . O.idToken $ tokens
285− eAuthInfo = decodeClaims jwt :: Either O.JwtError (O.JwtHeader,AuthInfo)
286− case eAuthInfo of
287− Left jwtErr -> forbidden $ "JWT decode/check problem: " <> show jwtErr
288− Right (_,authInfo) ->
289− if emailVerified authInfo
290− then do
291− user <- liftIO $ handleSuccessfulId authInfo
292− either forbidden return user
293− else forbidden "Please verify your email"
294− Nothing -> do
295− liftIO $ putText "No code param"
296− forbidden "no code parameter given"
297−```
298−
299−When you render a User with blaze-html, it will generate a page with a js
300−that will put a secret for that user in the local storage. And it will
301−redirect the user to /.
302−
303−``` haskell
304−instance ToMarkup User where
305− toMarkup User{..} = H.docTypeHtml $ do
306− H.head $
307− H.title "Logged In"
308− H.body $ do
309− H.h1 "Logged In"
310− H.p (H.toHtml ("Successful login with id " <> userId))
311− H.script (H.toHtml ("localStorage.setItem('" <> localStorageKey <> "','" <> userSecret <> "');"
312− <> "localStorage.setItem('user-id','" <> userId <> "');"
313− <> "window.location='" <> fromMaybe "/" redirectUrl <> "';" -- redirect the user to /
314− ));
315−
316−serveOIDC :: OIDCEnv -> LoginHandler -> Server (IdentityRoutes a)
317−serveOIDC oidcenv loginHandler =
318− handleLogin oidcenv :<|> handleLoggedIn oidcenv loginHandler
319−
320−-- * Auth
321−type APIKey = ByteString
322−type Account = Text.Text
323−type Conf = [(APIKey,Account)]
324−data Customer = Customer {
325− account :: Account
326− , apiKey :: APIKey
327− , mail :: Maybe Text
328− , fullname :: Maybe Text
329− }
330−```
331−
332−Here is the code that displays the homepage.
333−It should contain a link to the the `/login` URL.
334−When the user clicks on this link it will be redirected to Google login page
335−with some generated information.
336−
337−The page also displays the content of the local storage.
338−And in particular the items `api-key` and `user-id`.
339−Those items should be set after a successful login when the user is redirected to
340−`/login/cb`.
341−
342−The logic used generally is to use that api-key to uniquely identify an user.
343−Another option would have been to set a cookie.
344−
345−``` haskell
346−data Homepage = Homepage
347−
348−instance ToMarkup Homepage where
349− toMarkup Homepage = H.docTypeHtml $ do
350− H.head $ do
351− H.title "OpenID Connect Servant Example"
352− H.style (H.toHtml ("body { font-family: monospace; font-size: 18px; }" :: Text.Text))
353− H.body $ do
354− H.h1 "OpenID Connect Servant Example"
355− H.div $
356− H.a ! HA.href "/login" $ "Click here to login"
357− H.ul $ do
358− H.li $ do
359− H.span "API Key in Local storage: "
360− H.script (H.toHtml ("document.write(localStorage.getItem('api-key'));" :: Text.Text))
361− H.li $ do
362− H.span "User ID in Local storage: "
363− H.script (H.toHtml ("document.write(localStorage.getItem('user-id'));" :: Text.Text))
364−```
365−
366−We need some helpers to generate random string for generating state and API Keys.
367−
368−``` haskell
369−-- | generate a random ByteString, not necessarily extremely good randomness
370−-- still the password will be long enough to be very difficult to crack
371−genRandomBS :: IO ByteString
372−genRandomBS = do
373− g <- Random.newStdGen
374− Random.randomRs (0, n) g & take 42 & fmap toChar & readable 0 & toS & return
375− where
376− n = length letters - 1
377− toChar i = letters List.!! i
378− letters = ['A'..'Z'] <> ['0'..'9'] <> ['a'..'z']
379− readable :: Int -> [Char] -> [Char]
380− readable _ [] = []
381− readable i str =
382− let blocksize = case n of
383− 0 -> 8
384− 1 -> 4
385− 2 -> 4
386− 3 -> 4
387− _ -> 12
388− block = take blocksize str
389− rest = drop blocksize str
390− in if List.null rest
391− then str
392− else block <> "-" <> readable (i+1) rest
393−
394−customerFromAuthInfo :: AuthInfo -> IO Customer
395−customerFromAuthInfo authinfo = do
396− apikey <- genRandomBS
397− return Customer { account = toS (email authinfo)
398− , apiKey = apikey
399− , mail = Just (toS (email authinfo))
400− , fullname = Just (toS (name authinfo))
401− }
402−
403−handleOIDCLogin :: LoginHandler
404−handleOIDCLogin authInfo = do
405− custInfo <- customerFromAuthInfo authInfo
406− if emailVerified authInfo
407− then return . Right . customerToUser $ custInfo
408− else return (Left "You emails is not verified by your provider. Please verify your email.")
409− where
410− customerToUser :: Customer -> User
411− customerToUser c =
412− User { userId = toS (account c)
413− , userSecret = toS (apiKey c)
414− , redirectUrl = Nothing
415− , localStorageKey = "api-key"
416− }
417−```
418−
419−`Error` helpers
420−---------------
421−
422−``` haskell
423−data Err = Err { errTitle :: Text
424− , errMsg :: Text }
425−
426−instance ToMarkup Err where
427− toMarkup Err{..} = H.docTypeHtml $ do
428− H.head $ do
429− H.title "Error"
430− H.body $ do
431− H.h1 (H.a ! HA.href "/" $ "Home")
432− H.h2 (H.toHtml errTitle)
433− H.p (H.toHtml errMsg)
434−
435−format :: ToMarkup a => a -> LBS.ByteString
436−format err = toMarkup err & renderMarkup
437−
438−appToErr :: ServerError -> Text -> ServerError
439−appToErr x msg = x
440− { errBody = toS $ format (Err (toS (errReasonPhrase x)) msg)
441− , errHeaders = [("Content-Type","text/html")]}
442−
443−unauthorized :: (MonadError ServerError m) => Text -> m a
444−unauthorized = throwError . unauthorizedErr
445−
446−unauthorizedErr :: Text -> ServerError
447−unauthorizedErr = appToErr err401
448−
449−forbidden :: (MonadError ServerError m) => Text -> m a
450−forbidden = throwError . forbiddenErr
451−
452−forbiddenErr :: Text -> ServerError
453−forbiddenErr = appToErr err403
454−
455−notFound :: ( MonadError ServerError m) => Text -> m a
456−notFound = throwError . notFoundErr
457−
458−notFoundErr :: Text -> ServerError
459−notFoundErr = appToErr err404
460−
461−preconditionFailed :: ( MonadError ServerError m) => Text -> m a
462−preconditionFailed = throwError . preconditionFailedErr
463−
464−preconditionFailedErr :: Text -> ServerError
465−preconditionFailedErr = appToErr err412
466−
467−serverError :: ( MonadError ServerError m) => Text -> m a
468−serverError = throwError . serverErrorErr
469−
470−serverErrorErr :: Text -> ServerError
471−serverErrorErr = appToErr err500
472−```
doc/cookbook/pagination/Pagination.lhs+8−8
@@ -18,7 +18,7 @@ For example: `Range: createdAt 2017-01-15T23:14:67.000Z; offset 5; order desc` i
1818the client is willing to retrieve the next batch of document in descending order that were
1919created after the fifteenth of January, skipping the first 5.
2020
21−As a response, the server may return the list of corresponding documents, and augment the
21+As a response, the server may return the list of corresponding document, and augment the
2222response with 3 headers:
2323
2424- `Accept-Ranges`: A comma-separated list of fields upon which a range can be defined
@@ -127,7 +127,7 @@ defaultRange =
127127 getDefaultRange (Proxy @Color)
128128```
129129
130−Note that `getFieldValue :: Proxy "name" -> Color -> String` is the minimal complete definition
130+Note that `getFieldValue :: Proxy "name" -> Color -> String` is the minimal complete definintion
131131of the class. Yet, you can define `getRangeOptions` to provide different parsing options (see
132132the last section of this guide). In the meantime, we've also defined a `defaultRange` as it will
133133come in handy when defining our handler.
@@ -148,7 +148,7 @@ type MyHeaders =
148148```
149149
150150`PageHeaders` is a type alias provided by the library to declare the necessary response headers
151−we mentioned in introduction. Expanding the alias boils down to the following:
151+we mentionned in introduction. Expanding the alias boils down to the following:
152152
153153``` haskell
154154-- type MyHeaders =
@@ -165,7 +165,7 @@ not, _servant-pagination_ provides an easy way to lift a collection of resources
165165#### Server
166166
167167Time to connect the last bits by defining the server implementation of our colorful API. The `Ranges`
168−type we've defined above (tied to the `Range` HTTP header) indicates the server to parse any `Range`
168+type we've defined above (tight to the `Range` HTTP header) indicates the server to parse any `Range`
169169header, looking for the format defined in introduction with fields and target types we have just declared.
170170If no such header is provided, we will end up receiving `Nothing`. Otherwise, it will be possible
171171to _extract_ a `Range` from our `Ranges`.
@@ -192,7 +192,7 @@ the format we defined, where `<field>` here can only be `name` and `<value>` mus
192192- `Range: <field> [<value>][; offset <o>][; limit <l>][; order <asc|desc>]`
193193
194194Beside the target field, everything is pretty much optional in the `Range` HTTP header. Missing parts
195−are deduced from the `RangeOptions` that are part of the `HasPagination` instance. Therefore, all
195+are deducted from the `RangeOptions` that are part of the `HasPagination` instance. Therefore, all
196196following examples are valid requests to send to our server:
197197
198198- 1 - `curl http://localhost:1442/colors -vH 'Range: name'`
@@ -219,7 +219,7 @@ The previous ranges reads as follows:
219219Note that in the simple above scenario, there's no ambiguity with `extractRange` and `returnRange`
220220because there's only one possible `Range` defined on our resource. Yet, as you've most probably
221221noticed, the `Ranges` combinator accepts a list of fields, each of which must declare a `HasPagination`
222−instance. Doing so will make the other helper functions more ambiguous and type annotations are
222+instance. Doing so will make the other helper functions more ambiguous and type annotation are
223223highly likely to be needed.
224224
225225
@@ -235,8 +235,8 @@ instance HasPagination Color "hex" where
235235#### Parsing Options
236236
237237By default, `servant-pagination` provides an implementation of `getRangeOptions` for each
238−`HasPagination` instance. However, this can be overridden when defining the instance to provide
239−your own options. These options come into play when a `Range` header is received and isn't fully
238+`HasPagination` instance. However, this can be overwritten when defining the instance to provide
239+your own options. This options come into play when a `Range` header is received and isn't fully
240240specified (`limit`, `offset`, `order` are all optional) to provide default fallback values for those.
241241
242242For instance, let's say we wanted to change the default limit to `5` in a new range on
doc/cookbook/pagination/pagination.cabal+5−5
@@ -1,21 +1,21 @@
1−cabal-version: 2.2
21name: cookbook-pagination
32version: 2.1
43synopsis: Pagination with Servant example
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-pagination
1414 main-is: Pagination.lhs
1515 build-tool-depends: markdown-unlit:markdown-unlit
1616 default-language: Haskell2010
1717 ghc-options: -Wall -pgmL markdown-unlit
18− build-depends: base >= 4.9 && <5
18+ build-depends: base >= 4.8 && <4.13
1919 , aeson
2020 , servant
2121 , servant-server
doc/cookbook/sentry/Sentry.lhs+2−2
@@ -79,14 +79,14 @@ It does three things. First it initializes the service which will communicate wi
7979
8080- the Sentry `DSN`, which is obtained when creating a new project on Sentry
8181- a default way to update sentry fields, where we use the identity function
82−- an event transport, which generally would be `sendRecord`, an HTTPS capable transport which uses http-conduit
82+- an event trasport, which generally would be `sendRecord`, an HTTPS capable trasport which uses http-conduit
8383- a fallback handler, which we choose to be `silentFallback` since later we are logging to the console anyway.
8484
8585In the second step it actually sends our message to Sentry with the `register` function. Its arguments are:
8686
8787- the configured Sentry service which we just created
8888- the name of the logger
89−- the error level (see [SentryLevel](https://hackage.haskell.org/package/raven-haskell/docs/System-Log-Raven-Types.html#t:SentryLevel) for the possible options)
89+- the error level (see [SentryLevel](https://hackage.haskell.org/package/raven-haskell-0.1.2.0/docs/System-Log-Raven-Types.html#t:SentryLevel) for the possible options)
9090- the message we want to send
9191- an update function to handle the specific `SentryRecord`
9292
doc/cookbook/sentry/sentry.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-sentry
32version: 0.1
43synopsis: Collecting runtime exceptions using Sentry
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-sentry
1414 main-is: Sentry.lhs
doc/cookbook/structuring-apis/StructuringApis.lhs+1−1
@@ -144,7 +144,7 @@ simpleAPIServer
144144 :: m [a]
145145 -> (i -> m a)
146146 -> (a -> m NoContent)
147− -> ServerT (SimpleAPI name a i) m
147+ -> Server (SimpleAPI name a i) m
148148simpleAPIServer listAs getA postA =
149149 listAs :<|> getA :<|> postA
150150
doc/cookbook/structuring-apis/structuring-apis.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-structuring-apis
32version: 0.1
43synopsis: Example that shows how APIs can be structured
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-structuring-apis
1414 main-is: StructuringApis.lhs
doc/cookbook/testing/Testing.lhs+13−11
@@ -142,31 +142,33 @@ of it and see how it responds.
142142Let's write some tests:
143143
144144```haskell
145−withUserApp :: (Warp.Port -> IO ()) -> IO ()
145+withUserApp :: IO () -> IO ()
146146withUserApp action =
147− -- testWithApplication makes sure the action is executed after the server has
148− -- started and is being properly shutdown.
149− Warp.testWithApplication (pure userApp) action
147+ -- we can spin up a server in another thread and kill that thread when done
148+ -- in an exception-safe way
149+ bracket (liftIO $ C.forkIO $ Warp.run 8888 userApp)
150+ C.killThread
151+ (const action)
150152
151153
152154businessLogicSpec :: Spec
153155businessLogicSpec =
154156 -- `around` will start our Server before the tests and turn it off after
155− around withUserApp $ do
157+ around_ withUserApp $ do
156158 -- create a test client function
157159 let createUser = client (Proxy :: Proxy UserApi)
158160 -- create a servant-client ClientEnv
159− baseUrl <- runIO $ parseBaseUrl "http://localhost"
161+ baseUrl <- runIO $ parseBaseUrl "http://localhost:8888"
160162 manager <- runIO $ newManager defaultManagerSettings
161− let clientEnv port = mkClientEnv manager (baseUrl { baseUrlPort = port })
163+ let clientEnv = mkClientEnv manager baseUrl
162164
163165 -- testing scenarios start here
164166 describe "POST /user" $ do
165− it "should create a user with a high enough ID" $ \port -> do
166− result <- runClientM (createUser 50001) (clientEnv port)
167+ it "should create a user with a high enough ID" $ do
168+ result <- runClientM (createUser 50001) clientEnv
167169 result `shouldBe` (Right $ User { name = "some user", user_id = 50001})
168− it "will it fail with a too-small ID?" $ \port -> do
169− result <- runClientM (createUser 4999) (clientEnv port)
170+ it "will it fail with a too-small ID?" $ do
171+ result <- runClientM (createUser 4999) clientEnv
170172 result `shouldBe` (Right $ User { name = "some user", user_id = 50001})
171173```
172174
doc/cookbook/testing/testing.cabal+5−5
@@ -1,16 +1,16 @@
1−cabal-version: 2.2
21name: cookbook-testing
32version: 0.0.1
43synopsis: Common testing patterns in Servant apps
54description: This recipe includes various strategies for writing tests for Servant.
6−homepage: http://docs.servant.dev/
7−license: BSD-3-Clause
5+homepage: http://haskell-servant.readthedocs.org/
6+license: BSD3
87license-file: ../../../servant/LICENSE
98author: Servant Contributors
109maintainer: haskell-servant-maintainers@googlegroups.com
1110category: Servant
1211build-type: Simple
13−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
12+cabal-version: >=1.10
13+tested-with: GHC==8.4.4, GHC==8.6.3
1414
1515executable cookbook-testing
1616 main-is: Testing.lhs
@@ -23,7 +23,7 @@ executable cookbook-testing
2323 , servant
2424 , servant-client
2525 , servant-server
26− , servant-quickcheck >= 0.0.10
26+ , servant-quickcheck
2727 , http-client
2828 , http-types >= 0.12
2929 , hspec
doc/cookbook/using-custom-monad/UsingCustomMonad.lhs+1−1
@@ -1,6 +1,6 @@
11# Using a custom monad
22
3−In this section we will create an API for a book shelf without any backing DB storage.
3+In this section we will create and API for a book shelf without any backing DB storage.
44We will keep state in memory and share it between requests using `Reader` monad and `STM`.
55
66We start with a pretty standard set of imports and definition of the model:
doc/cookbook/using-custom-monad/using-custom-monad.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-using-custom-monad
32version: 0.1
43synopsis: Using custom monad to pass a state between handlers
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-using-custom-monad
1414 main-is: UsingCustomMonad.lhs
doc/cookbook/using-free-client/UsingFreeClient.lhs+6−6
@@ -2,7 +2,7 @@
22
33or simply put: _a practical introduction to `Servant.Client.Free`_.
44
5−Someone asked on IRC how one could access the intermediate Requests (resp. Responses)
5+Someone asked on IRC how one could access the intermediate Requests (resp. Responses)
66produced (resp. received) by client functions derived using servant-client.
77My response to such inquiries is: to extend `servant-client` in an ad-hoc way (e.g for testing or debugging
88purposes), use `Servant.Client.Free`. This recipe shows how.
@@ -119,7 +119,7 @@ Now we can use `servant-client`'s internals to convert servant's `Request`
119119to http-client's `Request`, and we can inspect it:
120120
121121```haskell
122− req' <- I.defaultMakeClientRequest burl req
122+ let req' = I.requestToClientRequest burl req
123123 putStrLn $ "Making request: " ++ show req'
124124```
125125
@@ -136,12 +136,12 @@ and calling the continuation. We should get a `Pure` value.
136136
137137```haskell
138138 let res = I.clientResponseToResponse id res'
139−
139+
140140 case k res of
141141 Pure n ->
142142 putStrLn $ "Expected 1764, got " ++ show n
143− _ ->
144− putStrLn "ERROR: didn't get a response"
143+ _ ->
144+ putStrLn "ERROR: didn't got a response"
145145```
146146
147147So that's it. Using `Free` we can evaluate servant clients step-by-step, and
@@ -153,7 +153,7 @@ and responses available for us to inspect, since `RunClient` only gives us
153153access to one `Request` or `Response` at a time.
154154
155155On the other hand, a "batch collection" of requests and/or responses can be achieved
156−with both free clients and a custom `RunClient` instance rather easily, for example
156+with both free clients and a custom `RunClient` instance rather easily, for example
157157by using a `Writer [(Request, Response)]` monad.
158158
159159Here is an example of running our small `test` against a running server:
doc/cookbook/using-free-client/using-free-client.cabal+4−4
@@ -1,14 +1,14 @@
1−cabal-version: 2.2
21name: cookbook-using-free-client
32version: 0.1
43synopsis: Using Free client
5−homepage: http://docs.servant.dev/
6−license: BSD-3-Clause
4+homepage: http://haskell-servant.readthedocs.org/
5+license: BSD3
76license-file: ../../../servant/LICENSE
87author: Servant Contributors
98maintainer: haskell-servant-maintainers@googlegroups.com
109build-type: Simple
11−tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
10+cabal-version: >=1.10
11+tested-with: GHC==8.4.4, GHC==8.6.3
1212
1313executable cookbook-using-free-client
1414 main-is: UsingFreeClient.lhs
doc/cookbook/uverb/UVerb.lhsdeleted−223
@@ -1,223 +0,0 @@
1−# Listing alternative responses and exceptions in your API types
2−
3−Servant allows you to talk about the exceptions you throw in your API
4−types. This is not limited to actual exceptions, you can write
5−handlers that respond with arbitrary open unions of types.
6−
7−## Compatibility
8−
9−:warning: This cookbook is compatible with GHC 8.6.1 or higher :warning:
10−
11−## Preliminaries
12−
13−```haskell
14−{-# LANGUAGE ConstraintKinds #-}
15−{-# LANGUAGE DataKinds #-}
16−{-# LANGUAGE DeriveGeneric #-}
17−{-# LANGUAGE DerivingStrategies #-}
18−{-# LANGUAGE DeriveAnyClass #-}
19−{-# LANGUAGE DerivingVia #-}
20−{-# LANGUAGE FlexibleContexts #-}
21−{-# LANGUAGE FlexibleInstances #-}
22−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
23−{-# LANGUAGE InstanceSigs #-}
24−{-# LANGUAGE MultiParamTypeClasses #-}
25−{-# LANGUAGE OverloadedStrings #-}
26−{-# LANGUAGE ScopedTypeVariables #-}
27−{-# LANGUAGE StandaloneDeriving #-}
28−{-# LANGUAGE TypeApplications #-}
29−{-# LANGUAGE TypeFamilies #-}
30−{-# LANGUAGE TypeOperators #-}
31−{-# LANGUAGE UndecidableInstances #-}
32−{-# OPTIONS_GHC -Wall -Wno-orphans #-}
33−
34−import Control.Concurrent (threadDelay)
35−import Control.Concurrent.Async (async)
36−import Control.Monad (when)
37−import Control.Monad.Except (ExceptT (..), MonadError (..), MonadTrans (..), runExceptT)
38−import Data.Aeson (FromJSON (..), ToJSON (..))
39−import Data.Aeson.Encode.Pretty (encodePretty)
40−import Data.String.Conversions (cs)
41−import Data.Swagger (ToSchema)
42−import Data.Typeable (Proxy (Proxy))
43−import qualified GHC.Generics as GHC
44−import qualified Network.HTTP.Client as Client
45−import qualified Network.Wai.Handler.Warp as Warp
46−import Servant.API
47−import Servant.Client
48−import Servant.Server
49−import Servant.Swagger
50−```
51−
52−## The API
53−
54−This looks like a `Verb`-based routing table, except that `UVerb` has
55−no status, and carries a list of response types rather than a single
56−one. Each entry in the list carries its own response code.
57−
58−```haskell
59−type API =
60− "fisx" :> Capture "bool" Bool
61− :> UVerb 'GET '[JSON] '[FisxUser, WithStatus 303 String]
62− :<|> "arian"
63− :> UVerb 'GET '[JSON] '[WithStatus 201 ArianUser]
64−```
65−
66−Here are the details:
67−
68−```haskell
69−data FisxUser = FisxUser {name :: String}
70− deriving (Eq, Show, GHC.Generic)
71−
72−instance ToJSON FisxUser
73−instance FromJSON FisxUser
74−instance ToSchema FisxUser
75−
76−-- | 'HasStatus' allows us to can get around 'WithStatus' if we want
77−-- to, and associate the status code with our resource types directly.
78−--
79−-- (To avoid orphan instances and make it more explicit what's in the
80−-- API and what isn't, we could even introduce a newtype 'Resource'
81−-- that wraps all the types we're using in our routing table, and then
82−-- define lots of 'HasStatus' instances for @Resource This@ and
83−-- @Resource That@.)
84−instance HasStatus FisxUser where
85− type StatusOf FisxUser = 203
86−
87−data ArianUser = ArianUser
88− deriving (Eq, Show, GHC.Generic)
89−
90−instance ToJSON ArianUser
91−instance FromJSON ArianUser
92−instance ToSchema ArianUser
93−```
94−
95−## Server, Client, Swagger
96−
97−You can just respond with any of the elements of the union in handlers.
98−
99−```haskell
100−fisx :: Bool -> Handler (Union '[FisxUser, WithStatus 303 String])
101−fisx True = respond (FisxUser "fisx")
102−fisx False = respond (WithStatus @303 ("still fisx" :: String))
103−
104−arian :: Handler (Union '[WithStatus 201 ArianUser])
105−arian = respond (WithStatus @201 ArianUser)
106−```
107−
108−You can create client functions like you're used to:
109−
110−```
111−fisxClient :: Bool -> ClientM (Union '[FisxUser, WithStatus 303 String])
112−arianClient :: ClientM (Union '[WithStatus 201 ArianUser])
113−(fisxClient :<|> arianClient) = client (Proxy @API)
114−```
115−
116−... and that's basically it! Here are a few sample commands that
117−show you how the swagger docs look like and how you can handle the
118−result unions in clients:
119−
120−```
121−main :: IO ()
122−main = do
123− putStrLn . cs . encodePretty $ toSwagger (Proxy @API)
124− _ <- async . Warp.run 8080 $ serve (Proxy @API) (fisx :<|> arian)
125− threadDelay 50000
126− mgr <- Client.newManager Client.defaultManagerSettings
127− let cenv = mkClientEnv mgr (BaseUrl Http "localhost" 8080 "")
128− result <- runClientM (fisxClient True) cenv
129− print $ foldMapUnion (Proxy @Show) show <$> result
130− print $ matchUnion @FisxUser <$> result
131− print $ matchUnion @(WithStatus 303 String) <$> result
132− pure ()
133−```
134−
135−## Idiomatic exceptions
136−
137−Since `UVerb` (probably) will mostly be used for error-like responses, it may be desirable to be able to early abort handler, like with current servant one would use `throwError` with `ServerError`.
138−
139−```haskell
140−newtype UVerbT xs m a = UVerbT { unUVerbT :: ExceptT (Union xs) m a }
141− deriving (Functor, Applicative, Monad, MonadTrans)
142−
143−-- | Deliberately hide 'ExceptT's 'MonadError' instance to be able to use
144−-- underlying monad's instance.
145−instance MonadError e m => MonadError e (UVerbT xs m) where
146− throwError = lift . throwError
147− catchError (UVerbT act) h = UVerbT $ ExceptT $
148− runExceptT act `catchError` (runExceptT . unUVerbT . h)
149−
150−-- | This combinator runs 'UVerbT'. It applies 'respond' internally, so the handler
151−-- may use the usual 'return'.
152−runUVerbT :: (Monad m, HasStatus x, IsMember x xs) => UVerbT xs m x -> m (Union xs)
153−runUVerbT (UVerbT act) = either id id <$> runExceptT (act >>= respond)
154−
155−-- | Short-circuit 'UVerbT' computation returning one of the response types.
156−throwUVerb :: (Monad m, HasStatus x, IsMember x xs) => x -> UVerbT xs m a
157−throwUVerb = UVerbT . ExceptT . fmap Left . respond
158−```
159−
160−Example usage:
161−
162−```haskell
163−data Foo = Foo Int Int Int
164− deriving (Show, Eq, GHC.Generic, ToJSON)
165− deriving HasStatus via WithStatus 200 Foo
166−
167−data Bar = Bar
168− deriving (Show, Eq, GHC.Generic)
169−
170−instance ToJSON Bar
171−
172−h :: Handler (Union '[Foo, WithStatus 400 Bar])
173−h = runUVerbT $ do
174− when ({- something bad -} True) $
175− throwUVerb $ WithStatus @400 Bar
176−
177− when ({- really bad -} False) $
178− throwError $ err500
179−
180− -- a lot of code here...
181−
182− return $ Foo 1 2 3
183−```
184−
185−## Related Work
186−
187−There is the [issue from
188−2017](https://github.com/haskell-servant/servant/issues/841) that was
189−resolved by the introduction of `UVerb`, with a long discussion on
190−alternative designs.
191−
192−[servant-checked-exceptions](https://hackage.haskell.org/package/servant-checked-exceptions)
193−is a good solution to the problem, but it restricts the user to JSON
194−and a very specific envelop encoding for the union type, which is
195−often not acceptable. (One good reason for this design choice is that
196−it makes writing clients easier, where you need to get to the union
197−type from one representative, and you don't want to run several
198−parsers in the hope that the ones that should will always error out so
199−you can try until the right one returns a value.)
200−
201−[servant-exceptions](https://github.com/ch1bo/servant-exceptions) is
202−another shot at at the problem. It is inspired by
203−servant-checked-exceptions, so it may be worth taking a closer look.
204−The README claims that
205−[cardano-sl](https://github.com/input-output-hk/cardano-sl) also has
206−some code for generalized error handling.
207−
208−In an earier version of the `UVerb` implementation, we have used some
209−code from
210−[world-peace](https://hackage.haskell.org/package/world-peace), but
211−that package itself wasn't flexible enough, and we had to use
212−[sop-core](https://hackage.haskell.org/package/sop-core) to implement
213−the `HasServer` instance.
214−
215−Here is a blog post we found on the subject:
216−https://lukwagoallan.com/posts/unifying-servant-server-error-responses
217−
218−(If you have anything else, please add it here or let us know.)
219−
220−```haskell
221−main :: IO ()
222−main = return ()
223−```
doc/cookbook/uverb/uverb.cabaldeleted−35
@@ -1,35 +0,0 @@
1−cabal-version: 2.2
2−name: cookbook-uverb
3−version: 0.0.1
4−synopsis: How to use the 'UVerb' type.
5−description: Listing alternative responses and exceptions in your API types.
6−homepage: http://docs.servant.dev/
7−license: BSD-3-Clause
8−license-file: ../../../servant/LICENSE
9−author: Servant Contributors
10−maintainer: haskell-servant-maintainers@googlegroups.com
11−category: Servant
12−build-type: Simple
13−tested-with: GHC==8.6.5, GHC==8.8.4, GHC==8.10.7
14−
15−executable cookbook-uverb
16− main-is: UVerb.lhs
17− build-depends: base == 4.*
18− , aeson >= 1.2
19− , aeson-pretty >= 0.8.8
20− , async
21− , http-client
22− , mtl
23− , servant
24− , servant-client
25− , servant-server
26− , servant-swagger
27− , string-conversions
28− , swagger2
29− , wai
30− , warp
31− if impl(ghc >= 9)
32− buildable: False
33− default-language: Haskell2010
34− ghc-options: -Wall -pgmL markdown-unlit
35− build-tool-depends: markdown-unlit:markdown-unlit
doc/examples.md+1−1
@@ -8,7 +8,7 @@
88
99- **[servant-examples](https://github.com/sras/servant-examples)**:
1010
11− Similar to [the cookbook](https://docs.servant.dev/en/latest/cookbook/index.html) but
11+ Similar to [the cookbook](https://haskell-servant.readthedocs.io/en/latest/cookbook/index.html) but
1212 with no explanations, for developers who just want to look at code examples to find out how to do X or Y
1313 with servant.
1414
doc/links.rst+3−3
@@ -3,7 +3,7 @@ Helpful Links
33-------------
44
55- the central documentation (this site):
6− `docs.servant.dev <http://docs.servant.dev/>`_
6+ `haskell-servant.readthedocs.org <http://haskell-servant.readthedocs.org/>`_
77
88- the github repo:
99 `github.com/haskell-servant/servant <https://github.com/haskell-servant/servant>`_
@@ -12,13 +12,13 @@ Helpful Links
1212 `https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
1313
1414- the irc channel:
15− `#haskell-servant on libera.chat <https://web.libera.chat/#haskell-servant>`_
15+ ``#servant`` on freenode
1616
1717- the mailing list:
1818 `groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
1919
2020- blog posts and videos and slides of some talks on servant:
21− `www.servant.dev <http://www.servant.dev>`_
21+ `haskell-servant.github.io <http://haskell-servant.github.io>`_
2222
2323- the servant packages on hackage:
2424
doc/tutorial/ApiType.lhs+4−30
@@ -177,12 +177,13 @@ type UserAPI5 = "user" :> Capture "userid" Integer :> Get '[JSON] User
177177 -- except that we explicitly say that "userid"
178178 -- must be an integer
179179
180− :<|> "user" :> Capture "userid" Integer :> DeleteNoContent
180+ :<|> "user" :> Capture "userid" Integer :> DeleteNoContent '[JSON] NoContent
181181 -- equivalent to 'DELETE /user/:userid'
182182```
183183
184−In the second case, `DeleteNoContent` specifies a 204 response code
185−and that the response will always be empty.
184+In the second case, `DeleteNoContent` specifies a 204 response code,
185+`JSON` specifies the content types on which the handler will match,
186+and `NoContent` says that the response will always be empty.
186187
187188### `QueryParam`, `QueryParams`, `QueryFlag`
188189
@@ -389,30 +390,3 @@ One example for this is if you want to serve a directory of static files along
389390with the rest of your API. But you can plug in everything that is an
390391`Application`, e.g. a whole web application written in any of the web
391392frameworks that support `wai`.
392−
393−Be mindful! The `servant-server`'s router works by pattern-matching the
394−different routes that are composed using `:<|>`. `Raw`, as an escape hatch,
395−matches any route that hasn't been matched by previous patterns. Therefore,
396−any subsequent route will be silently ignored.
397−
398−``` haskell
399−type UserAPI14 = Raw
400− :<|> "users" :> Get '[JSON] [User]
401− -- In this situation, the /users endpoint
402− -- will not be reachable because the Raw
403− -- endpoint matches requests before
404−```
405−A simple way to avoid this pitfall is to either use `Raw` as the last
406−definition, or to always have it under a static path.
407−
408−``` haskell
409−type UserAPI15 = "files" :> Raw
410− -- The raw endpoint is under the /files
411− -- static path, so it won't match /users.
412− :<|> "users" :> Get '[JSON] [User]
413−
414−type UserAPI16 = "users" :> Get '[JSON] [User]
415− :<|> Raw
416− -- The Raw endpoint is matched last, so
417− -- it won't overlap another endpoint.
418−```
doc/tutorial/Authentication.lhs+11−10
@@ -47,6 +47,7 @@ module Authentication where
4747import Data.Aeson (ToJSON)
4848import Data.ByteString (ByteString)
4949import Data.Map (Map, fromList)
50+import Data.Monoid ((<>))
5051import qualified Data.Map as Map
5152import Data.Proxy (Proxy (Proxy))
5253import Data.Text (Text)
@@ -107,7 +108,7 @@ API with "private." Additionally, the private parts of our API use the
107108realm for this authentication is `"foo-realm"`).
108109
109110Unfortunately we're not done. When someone makes a request to our `"private"`
110−API, we're going to need to provide to servant the logic for validating
111+API, we're going to need to provide to servant the logic for validifying
111112usernames and passwords. This adds a certain conceptual wrinkle in servant's
112113design that we'll briefly discuss. If you want the **TL;DR**: we supply a lookup
113114function to servant's new `Context` primitive.
@@ -132,7 +133,7 @@ combinator. Using `Context`, we can supply a function of type
132133handler. This will allow the handler to check authentication and return a `User`
133134to downstream handlers if successful.
134135
135−In practice we wrap `BasicAuthData -> Handler User` into a slightly
136+In practice we wrap `BasicAuthData -> Handler` into a slightly
136137different function to better capture the semantics of basic authentication:
137138
138139``` haskell ignore
@@ -259,7 +260,7 @@ this.
259260
260261Let's implement a trivial authentication scheme. We will protect our API by
261262looking for a cookie named `"servant-auth-cookie"`. This cookie's value will
262−contain a key from which we can lookup an `Account`.
263+contain a key from which we can lookup a `Account`.
263264
264265```haskell
265266-- | An account type that we "fetch from the database" after
@@ -273,7 +274,7 @@ database = fromList [ ("key1", Account "Anne Briggs")
273274 , ("key3", Account "Ghédalia Tazartès")
274275 ]
275276
276−-- | A method that, when given a password, will return an Account.
277+-- | A method that, when given a password, will return a Account.
277278-- This is our bespoke (and bad) authentication logic.
278279lookupAccount :: ByteString -> Handler Account
279280lookupAccount key = case Map.lookup key database of
@@ -317,7 +318,7 @@ genAuthAPI = Proxy
317318
318319Now we need to bring everything together for the server. We have the
319320`AuthHandler Request Account` value and an `AuthProtected` endpoint. To bind these
320−together, we need to provide a [Type Family](https://downloads.haskell.org/~ghc/8.8.1/docs/html/users_guide/glasgow_exts.html#type-families)
321+together, we need to provide a [Type Family](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/type-families.html)
321322instance that tells the `HasServer` instance that our `Context` will supply a
322323`Account` (via `AuthHandler Request Account`) and that downstream combinators will
323324have access to this `Account` value (or an error will be thrown if authentication
@@ -345,7 +346,7 @@ genAuthServerContext = authHandler :. EmptyContext
345346
346347-- | Our API, where we provide all the author-supplied handlers for each end
347348-- point. Note that 'privateDataFunc' is a function that takes 'Account' as an
348−-- argument. We don't worry about the authentication instrumentation here,
349+-- argument. We dont' worry about the authentication instrumentation here,
349350-- that is taken care of by supplying context
350351genAuthServer :: Server AuthGenAPI
351352genAuthServer =
@@ -367,10 +368,10 @@ genAuthMain = run 8080 (serveWithContext genAuthAPI genAuthServerContext genAuth
367368$ curl -XGET localhost:8080/private
368369Missing auth header
369370
370−$ curl -XGET localhost:8080/private -H "Cookie: servant-auth-cookie=key3"
371+$ curl -XGET localhost:8080/private -H "servant-auth-cookie: key3"
371372[{"ssshhh":"this is a secret: Ghédalia Tazartès"}]
372373
373−$ curl -XGET localhost:8080/private -H "Cookie: servant-auth-cookie=bad-key"
374+$ curl -XGET localhost:8080/private -H "servant-auth-cookie: bad-key"
374375Invalid Cookie
375376
376377$ curl -XGET localhost:8080/public
@@ -384,11 +385,11 @@ Creating a generalized, ad-hoc authentication scheme was fairly straight
384385forward:
385386
3863871. use the `AuthProtect` combinator to protect your API.
387−2. choose an application-specific data type used by your server when
388+2. choose a application-specific data type used by your server when
388389authentication is successful (in our case this was `Account`).
3893903. Create a value of `AuthHandler Request Account` which encapsulates the
390391authentication logic (`Request -> Handler Account`). This function
391−will be executed every time a request matches a protected route.
392+will be executed everytime a request matches a protected route.
3923934. Provide an instance of the `AuthServerData` type family, specifying your
393394application-specific data type returned when authentication is successful (in
394395our case this was `Account`).
doc/tutorial/Client.lhs+4−4
@@ -1,9 +1,9 @@
11# Querying an API
22
3−While defining handlers that [serve an API](Server.html) has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. That said, we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate the client-side functions.
3+While defining handlers that [serve an API](Server.lhs) has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. That said, we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate the client-side functions.
44
55**servant** however has a way to inspect APIs, because APIs are just Haskell types and (GHC) Haskell lets us do quite a few things with types. In the same way that we look at an API type to deduce the types the handlers should have, we can inspect the structure of the API to *derive* Haskell functions that take one argument for each occurrence of `Capture`, `ReqBody`, `QueryParam`
6−and friends (see [the tutorial introduction](ApiType.html) for an overview). By *derive*, we mean that there's no code generation involved - the functions are defined just by the structure of the API type.
6+and friends (see [the tutorial introduction](ApiType.lhs) for an overview). By *derive*, we mean that there's no code generation involved - the functions are defined just by the structure of the API type.
77
88The source for this tutorial section is a literate Haskell file, so first we need to have some language extensions and imports:
99
@@ -161,7 +161,7 @@ The types of the arguments for the functions are the same as for (server-side) r
161161## Changing the monad the client functions live in
162162
163163Just like `hoistServer` allows us to change the monad in which request handlers
164−of a web application live, we also have `hoistClient` for changing the monad
164+of a web application live in, we also have `hoistClient` for changing the monad
165165in which _client functions_ live. Consider the following trivial API:
166166
167167``` haskell
@@ -173,7 +173,7 @@ hoistClientAPI = Proxy
173173
174174We already know how to derive client functions for this API, and as we have
175175seen above they all return results in the `ClientM` monad when using `servant-client`.
176−However, `ClientM` is rarely (or never) the actual monad we need to use the client
176+However, `ClientM` rarely (or never) is the actual monad we need to use the client
177177functions in. Sometimes we need to run them in IO, sometimes in a custom monad
178178stack. `hoistClient` is a very simple solution to the problem of "changing" the monad
179179the clients run in.
doc/tutorial/Docs.lhs+2−2
@@ -77,7 +77,7 @@ instance ToSample HelloMessage where
7777 [ ("When a value is provided for 'name'", HelloMessage "Hello, Alp")
7878 , ("When 'name' is not specified", HelloMessage "Hello, anonymous coward")
7979 ]
80− -- multiple examples to display this time
80+ -- mutliple examples to display this time
8181
8282ci :: ClientInfo
8383ci = ClientInfo "Alp" "alp@foo.com" 26 ["haskell", "mathematics"]
@@ -108,7 +108,7 @@ apiDocs = docs exampleAPI
108108markdown :: API -> String
109109```
110110
111−That lets us see what our API docs look like in markdown, by looking at `markdown apiDocs`.
111+That lets us see what our API docs look down in markdown, by looking at `markdown apiDocs`.
112112
113113````````` text
114114## GET /hello
doc/tutorial/Javascript.lhs+2−2
@@ -228,13 +228,13 @@ data CommonGeneratorOptions = CommonGeneratorOptions
228228 {
229229 -- | function generating function names
230230 functionNameBuilder :: FunctionName -> Text
231− -- | name used when a user wants to send the request body (to let you redefine it)
231+ -- | name used when a user want to send the request body (to let you redefine it)
232232 , requestBody :: Text
233233 -- | name of the callback parameter when the request was successful
234234 , successCallback :: Text
235235 -- | name of the callback parameter when the request reported an error
236236 , errorCallback :: Text
237− -- | namespace on which we define the js function (empty means local var)
237+ -- | namespace on which we define the js function (empty mean local var)
238238 , moduleName :: Text
239239 -- | a prefix that should be prepended to the URL in the generated JS
240240 , urlPrefix :: Text
doc/tutorial/Server.lhs+26−26
@@ -183,7 +183,7 @@ users2 = [isaac, albert]
183183
184184Now, just like we separate the various endpoints in `UserAPI` with `:<|>`, we
185185are going to separate the handlers with `:<|>` too! They must be provided in
186−the same order as in the API type.
186+the same order as in in the API type.
187187
188188``` haskell
189189server2 :: Server UserAPI2
@@ -313,8 +313,8 @@ For reference, here's a list of some combinators from **servant**:
313313## The `FromHttpApiData`/`ToHttpApiData` classes
314314
315315Wait... How does **servant** know how to decode the `Int`s from the URL? Or how
316−to decode a `ClientInfo` value from the request body? The following three sections will
317−help us answer these questions.
316+to decode a `ClientInfo` value from the request body? This is what this and the
317+following two sections address.
318318
319319`Capture`s and `QueryParam`s are represented by some textual value in URLs.
320320`Header`s are similarly represented by a pair of a header name and a
@@ -599,7 +599,7 @@ $ curl -H 'Accept: text/html' http://localhost:8081/persons
599599
600600## The `Handler` monad
601601
602−At the heart of the handlers is the monad they run in, namely a newtype `Handler` around `ExceptT ServerError IO`
602+At the heart of the handlers is the monad they run in, namely a newtype `Handler` around `ExceptT ServerErroror IO`
603603([haddock documentation for `ExceptT`](http://hackage.haskell.org/package/mtl-2.2.1/docs/Control-Monad-Except.html#t:ExceptT)).
604604One might wonder: why this monad? The answer is that it is the
605605simplest monad with the following properties:
@@ -620,9 +620,9 @@ In short, this means that a handler of type `Handler a` is simply
620620equivalent to a computation of type `IO (Either ServerError a)`, that is, an IO
621621action that either returns an error or a result.
622622
623−The module [`Control.Monad.Except`](https://hackage.haskell.org/package/mtl/docs/Control-Monad-Except.html#t:ExceptT)
623+The module [`Control.Monad.Except`](https://hackage.haskell.org/package/mtl-2.2.1/docs/Control-Monad-Except.html#t:ExceptT)
624624from which `ExceptT` comes is worth looking at.
625−Perhaps most importantly, `ExceptT` and `Handler` are instances of `MonadError`, so
625+Perhaps most importantly, `ExceptT` and `Handler` are an instances of `MonadError`, so
626626`throwError` can be used to return an error from your handler (whereas `return`
627627 is enough to return a success).
628628
@@ -632,9 +632,9 @@ kind and abort early. The next two sections cover how to do just that.
632632
633633### Performing IO
634634
635−Other important instances from the list above are `MonadIO m => MonadIO
636−(ExceptT e m)`, and therefore also `MonadIO Handler` as there is a `MonadIO IO` instance.
637−[`MonadIO`](http://hackage.haskell.org/package/base/docs/Control-Monad-IO-Class.html#t:MonadIO)
635+Another important instances from the list above are `MonadIO m => MonadIO
636+(ExceptT e m)`, and therefore also `MonadIO Handler` as there is `MonadIO IO` instance.
637+[`MonadIO`](http://hackage.haskell.org/package/transformers-0.4.3.0/docs/Control-Monad-IO-Class.html)
638638is a class from the **transformers** package defined as:
639639
640640``` haskell ignore
@@ -716,7 +716,7 @@ $ curl --verbose http://localhost:8081/myfile.txt
716716>
717717< HTTP/1.1 404 Not Found
718718[snip]
719−myfile.txt just isn't there, please leave this server alone.
719+myfile.txt just isnt there, please leave this server alone.
720720
721721$ echo Hello > myfile.txt
722722
@@ -818,7 +818,7 @@ If it doesn't exist, the handler will fail with a `404` status code.
818818
819819`serveDirectoryWebApp` uses some standard settings that fit the use case of
820820serving static files for most web apps. You can find out about the other
821−options in the documentation of the `Servant.Server.StaticFiles` module.
821+options in the documentation of the `Servant.Utils.StaticFiles` module.
822822
823823## Nested APIs
824824
@@ -830,7 +830,7 @@ type UserAPI3 = -- view the user with given userid, in JSON
830830 Capture "userid" Int :> Get '[JSON] User
831831
832832 :<|> -- delete the user with given userid. empty response
833− Capture "userid" Int :> DeleteNoContent
833+ Capture "userid" Int :> DeleteNoContent '[JSON] NoContent
834834```
835835
836836We can instead factor out the `userid`:
@@ -838,7 +838,7 @@ We can instead factor out the `userid`:
838838``` haskell
839839type UserAPI4 = Capture "userid" Int :>
840840 ( Get '[JSON] User
841− :<|> DeleteNoContent
841+ :<|> DeleteNoContent '[JSON] NoContent
842842 )
843843```
844844
@@ -896,13 +896,13 @@ type API1 = "users" :>
896896-- we factor out the Request Body
897897type API2 = ReqBody '[JSON] User :>
898898 ( Get '[JSON] User -- just display the same user back, don't register it
899− :<|> PostNoContent -- register the user. empty response
899+ :<|> PostNoContent '[JSON] NoContent -- register the user. empty response
900900 )
901901
902902-- we factor out a Header
903903type API3 = Header "Authorization" Token :>
904904 ( Get '[JSON] SecretData -- get some secret data, if authorized
905− :<|> ReqBody '[JSON] SecretData :> PostNoContent -- add some secret data, if authorized
905+ :<|> ReqBody '[JSON] SecretData :> PostNoContent '[JSON] NoContent -- add some secret data, if authorized
906906 )
907907
908908newtype Token = Token ByteString
@@ -915,11 +915,11 @@ API type only at the end.
915915``` haskell
916916type UsersAPI =
917917 Get '[JSON] [User] -- list users
918− :<|> ReqBody '[JSON] User :> PostNoContent -- add a user
918+ :<|> ReqBody '[JSON] User :> PostNoContent '[JSON] NoContent -- add a user
919919 :<|> Capture "userid" Int :>
920920 ( Get '[JSON] User -- view a user
921− :<|> ReqBody '[JSON] User :> PutNoContent -- update a user
922− :<|> DeleteNoContent -- delete a user
921+ :<|> ReqBody '[JSON] User :> PutNoContent '[JSON] NoContent -- update a user
922+ :<|> DeleteNoContent '[JSON] NoContent -- delete a user
923923 )
924924
925925usersServer :: Server UsersAPI
@@ -948,11 +948,11 @@ usersServer = getUsers :<|> newUser :<|> userOperations
948948``` haskell
949949type ProductsAPI =
950950 Get '[JSON] [Product] -- list products
951− :<|> ReqBody '[JSON] Product :> PostNoContent -- add a product
951+ :<|> ReqBody '[JSON] Product :> PostNoContent '[JSON] NoContent -- add a product
952952 :<|> Capture "productid" Int :>
953953 ( Get '[JSON] Product -- view a product
954− :<|> ReqBody '[JSON] Product :> PutNoContent -- update a product
955− :<|> DeleteNoContent -- delete a product
954+ :<|> ReqBody '[JSON] Product :> PutNoContent '[JSON] NoContent -- update a product
955+ :<|> DeleteNoContent '[JSON] NoContent -- delete a product
956956 )
957957
958958data Product = Product { productId :: Int }
@@ -996,11 +996,11 @@ abstract that away:
996996-- indexed by values of type 'i'
997997type APIFor a i =
998998 Get '[JSON] [a] -- list 'a's
999− :<|> ReqBody '[JSON] a :> PostNoContent -- add an 'a'
999+ :<|> ReqBody '[JSON] a :> PostNoContent '[JSON] NoContent -- add an 'a'
10001000 :<|> Capture "id" i :>
10011001 ( Get '[JSON] a -- view an 'a' given its "identifier" of type 'i'
1002− :<|> ReqBody '[JSON] a :> PutNoContent -- update an 'a'
1003− :<|> DeleteNoContent -- delete an 'a'
1002+ :<|> ReqBody '[JSON] a :> PutNoContent '[JSON] NoContent -- update an 'a'
1003+ :<|> DeleteNoContent '[JSON] NoContent -- delete an 'a'
10041004 )
10051005
10061006-- Build the appropriate 'Server'
@@ -1135,7 +1135,7 @@ true
11351135### An arrow is a reader too.
11361136
11371137In previous versions of `servant` we had an `enter` to do what `hoistServer`
1138−does now. `enter` had an ambitious design goals, but was problematic in practice.
1138+does now. `enter` had a ambitious design goals, but was problematic in practice.
11391139
11401140One problematic situation was when the source monad was `(->) r`, yet it's
11411141handy in practice, because `(->) r` is isomorphic to `Reader r`.
@@ -1166,7 +1166,7 @@ back a *stream* of results, served one at a time. Stream endpoints only provide
11661166a single content type, and also specify what framing strategy is used to
11671167delineate the results. To serve these results, we need to give back a stream
11681168producer. Adapters can be written to *Pipes*, *Conduit* and the like, or
1169−written directly as `SourceIO`s. SourceIO builds upon servant's own `SourceT`
1169+written directly as `SourceIO`s. SourceIO builts upon servant's own `SourceT`
11701170stream type (it's simpler than *Pipes* or *Conduit*).
11711171The API of a streaming endpoint needs to explicitly specify which sort of
11721172generator it produces. Note that the generator itself is returned by a
doc/tutorial/index.rst+20−1
@@ -6,10 +6,29 @@ This is an introductory tutorial to **servant**. Whilst browsing is fine, it mak
66Any comments, issues or feedback about the tutorial can be submitted
77to `servant's issue tracker <http://github.com/haskell-servant/servant/issues>`_.
88
9+In fact, the whole tutorial is a `cabal <https://cabal.readthedocs.io/en/latest/>`_
10+project and can be built and played with locally as follows:
11+
12+.. code-block:: bash
13+
14+ $ git clone https://github.com/haskell-servant/servant.git
15+ $ cd servant
16+ # build
17+ $ cabal new-build tutorial
18+ # load in ghci to play with it
19+ $ cabal new-repl tutorial
20+
21+The code can be found in the `*.lhs` files under `doc/tutorial/` in the
22+repository. Feel free to edit it while you're reading this documentation and
23+see the effect of your changes.
24+
25+`Nix <https://nixos.org/nix/>`_ users should feel free to take a look at
26+the `nix/shell.nix` file in the repository and use it to provision a suitable
27+environment to build and run the examples.
28+
929.. toctree::
1030 :maxdepth: 1
1131
12− install.rst
1332 ApiType.lhs
1433 Server.lhs
1534 Client.lhs
doc/tutorial/install.rstdeleted−68
@@ -1,68 +0,0 @@
1−Install
2−========
3−
4−cabal-install
5−--------
6−
7−The whole tutorial is a `cabal <https://cabal.readthedocs.io/en/latest/>`_
8−project and can be built locally as follows:
9−
10−.. code-block:: bash
11−
12− $ git clone https://github.com/haskell-servant/servant.git
13− $ cd servant
14− # build
15− $ cabal new-build tutorial
16− # load in ghci to play with it
17− $ cabal new-repl tutorial
18−
19−stack
20−--------
21−
22−The servant `stack <https://docs.haskellstack.org/en/stable/README/>`_ template includes the working tutorial. To initialize this template, run:
23−
24−.. code-block:: bash
25−
26− $ stack new myproj servant
27− $ cd myproj
28− # build
29− $ stack build
30− # start server
31− $ stack exec myproj-exe
32−
33−The code can be found in the `*.lhs` files under `doc/tutorial/` in the
34−repository. Feel free to edit it while you're reading this documentation and
35−see the effect of your changes.
36−
37−nix
38−--------
39−
40−`Nix <https://nixos.org/nix/>`_ users should feel free to take a look at
41−the `nix/shell.nix` file in the repository and use it to provision a suitable
42−environment to build and run the examples.
43−
44−Note for Ubuntu users
45−--------
46−
47−Ubuntu's packages for `ghc`, `cabal`, and `stack` are years out of date.
48−If the instructions above fail for you,
49−try replacing the Ubuntu packages with up-to-date versions.
50−First remove the installed versions:
51−
52−.. code-block:: bash
53−
54− # remove the obsolete versions
55− $ sudo apt remove ghc haskell-stack cabal-install
56−
57−Then install fresh versions of the Haskell toolchain
58−using the `ghcup <https://www.haskell.org/ghcup/install/>`_ installer.
59−
60−As of February 2022, one easy way to do this is by running a bootstrap script:
61−
62−.. code-block:: bash
63−
64− $ curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
65−
66−The script is interactive and will prompt you for details about what
67−you want installed and where. To install manually,
68−see `the detailed instructions <https://www.haskell.org/ghcup/install/#manual-install>`_.
doc/tutorial/test/Spec.hs+1−11
@@ -1,11 +1 @@
1−module Main where
2−
3−import qualified JavascriptSpec
4−
5−import Test.Hspec (Spec, hspec, describe)
6−
7−main :: IO ()
8−main = hspec spec
9−
10−spec :: Spec
11−spec = describe "Javascript" JavascriptSpec.spec
1+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
doc/tutorial/tutorial.cabal+15−11
@@ -1,20 +1,22 @@
1−cabal-version: 2.2
21name: tutorial
32version: 0.10
43synopsis: The servant tutorial
54description:
65 The servant tutorial can be found at
7− <http://docs.servant.dev/>
8−homepage: http://docs.servant.dev/
6+ <http://haskell-servant.readthedocs.org/>
7+homepage: http://haskell-servant.readthedocs.org/
98category: Servant, Documentation
10−license: BSD-3-Clause
9+license: BSD3
1110license-file: LICENSE
1211author: Servant Contributors
1312maintainer: haskell-servant-maintainers@googlegroups.com
1413build-type: Simple
14+cabal-version: >=1.10
1515tested-with:
16− GHC==8.6.5
17− GHC==8.8.3, GHC ==8.10.7
16+ GHC==8.0.2
17+ GHC==8.2.2
18+ GHC==8.4.4
19+ GHC==8.6.3
1820extra-source-files:
1921 static/index.html
2022 static/ui.js
@@ -32,7 +34,7 @@ library
3234 -- Packages `servant` depends on.
3335 -- We don't need to specify bounds here as this package is never released.
3436 build-depends:
35− base >= 4.7 && <5
37+ base >= 4.7 && <4.13
3638 , aeson
3739 , attoparsec
3840 , base-compat
@@ -63,11 +65,11 @@ library
6365 blaze-html >= 0.9.0.1 && < 0.10
6466 , blaze-markup >= 0.8.0.0 && < 0.9
6567 , cookie >= 0.4.3 && < 0.5
66− , js-jquery >= 3.3.1 && < 3.4
67− , lucid >= 2.9.11 && < 2.12
68− , random >= 1.1 && < 1.3
68+ , js-jquery >= 3.2.1 && < 3.3
69+ , lucid >= 2.9.11 && < 2.10
70+ , random >= 1.1 && < 1.2
6971 , servant-js >= 0.9 && < 0.10
70− , time >= 1.6.0.1 && < 1.13
72+ , time >= 1.6.0.1 && < 1.9
7173
7274 -- For legacy tools, we need to specify build-depends too
7375 build-depends: markdown-unlit >= 0.5.0 && <0.6
@@ -80,6 +82,8 @@ test-suite spec
8082 hs-source-dirs: test
8183 main-is: Spec.hs
8284 other-modules: JavascriptSpec
85+ build-tool-depends:
86+ hspec-discover:hspec-discover
8387 build-depends: base
8488 , tutorial
8589 , hspec
ghcjs.nixdeleted−22
@@ -1,22 +0,0 @@
1−let reflex-platform = import (builtins.fetchTarball
2− { name = "reflex-platform";
3− url = "https://github.com/reflex-frp/reflex-platform/archive/1aba6f367982bd6dd78ec2fda75ab246a62d32c5.tar.gz";
4− }) {};
5− pkgs = import ./nix/nixpkgs.nix; in
6−
7−pkgs.stdenv.mkDerivation {
8− name = "ghcjs-shell";
9− buildInputs =
10− [ (reflex-platform.ghcjs.ghcWithPackages (p: with p; [
11− attoparsec
12− hashable
13− ]))
14− pkgs.cabal-install
15− pkgs.gmp
16− pkgs.haskellPackages.cabal-plan
17− pkgs.haskellPackages.hspec-discover
18− pkgs.nodejs
19− pkgs.perl
20− pkgs.zlib
21− ];
22−}
nix/README.md−18
@@ -21,21 +21,3 @@ a particular ghc version, e.g:
2121``` sh
2222$ nix-shell nix/shell.nix --argstr compiler ghcHEAD
2323```
24−
25−**Possible GHC versions**
26−- `ghc865Binary`
27−- `ghc884`
28−- `ghc8104` - default
29−- `ghc901`
30−
31−### Cabal users
32−
33−GHC version can be chosen via the nix-shell parameter
34−
35−`cabal build all`
36−
37−### Stack version
38−
39−Since the ghc version is set by the LTS version, it is preferable to use the `ghc8104` version parameter for the nix-shell.
40−
41−`stack --no-nix --system-ghc <command>`
nix/nixpkgs.jsondeleted−4
@@ -1,4 +0,0 @@
1−{
2− "rev" : "05f0934825c2a0750d4888c4735f9420c906b388",
3− "sha256" : "1g8c2w0661qn89ajp44znmwfmghbbiygvdzq0rzlvlpdiz28v6gy"
4−}
nix/nixpkgs.nixdeleted−4
@@ -1,4 +0,0 @@
1−import (builtins.fetchTarball {
2− url = "https://github.com/NixOS/nixpkgs/archive/refs/tags/21.05.tar.gz";
3− sha256 = "sha256:1ckzhh24mgz6jd1xhfgx0i9mijk6xjqxwsshnvq789xsavrmsc36";
4−}) {}
nix/shell.nix+18−17
@@ -1,20 +1,21 @@
1−{ compiler ? "ghc8104"
1+{ pkgs ? import <nixpkgs> {}
2+, compiler ? "ghc822"
23, tutorial ? false
3−, pkgs ? import ./nixpkgs.nix
44}:
5−
6− with pkgs;
75
8− let
9− ghc = haskell.packages.${compiler}.ghcWithPackages (_: []);
10− docstuffs = python3.withPackages (ps: with ps; [ recommonmark sphinx sphinx_rtd_theme ]);
11− in
12− stdenv.mkDerivation {
13− name = "servant-dev";
14− buildInputs = [ ghc zlib python3 wget cabal-install postgresql openssl stack haskellPackages.hspec-discover ]
15− ++ (if tutorial then [docstuffs postgresql] else []);
16− shellHook = ''
17− eval $(grep export ${ghc}/bin/ghc)
18− export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"${zlib}/lib";
19− '';
20− }
6+with pkgs;
7+
8+let
9+ ghc = haskell.packages.${compiler}.ghcWithPackages (_: []);
10+ docstuffs = python3.withPackages (ps: with ps; [ recommonmark sphinx sphinx_rtd_theme ]);
11+in
12+
13+stdenv.mkDerivation {
14+ name = "servant-dev";
15+ buildInputs = [ ghc zlib python3 wget ]
16+ ++ (if tutorial then [docstuffs postgresql] else []);
17+ shellHook = ''
18+ eval $(grep export ${ghc}/bin/ghc)
19+ export LD_LIBRARY_PATH="${zlib}/lib";
20+ '';
21+}
servant-auth/README.mddeleted−1
@@ -1 +0,0 @@
1−servant-auth-server/README.lhs
servant-auth/servant-auth-client/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -isrc -itest -idoctest/ghci-wrapper/src
servant-auth/servant-auth-client/CHANGELOG.mddeleted−26
@@ -1,26 +0,0 @@
1−# Changelog
2−
3−All notable changes to this project will be documented in this file.
4−
5−The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6−and this project adheres to [PVP Versioning](https://pvp.haskell.org/).
7−
8−## [Unreleased]
9−
10−## [0.4.1.0] - 2020-10-06
11−
12−- Support generic Bearer token auth
13−
14−## [0.4.0.0] - 2019-03-08
15−
16−## Changed
17−
18−- #145 Support servant-0.16 in tests @domenkozar
19−- #145 Drop GHC 7.10 support @domenkozar
20−
21−## [0.3.3.0] - 2018-06-18
22−
23−### Added
24−- Support for GHC 8.4 by @phadej
25−- Support for servant-0.14 by @phadej
26−- Changelog by @domenkozar
servant-auth/servant-auth-client/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Julian K. Arni (c) 2015
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Julian K. Arni nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
servant-auth/servant-auth-client/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
servant-auth/servant-auth-client/servant-auth-client.cabaldeleted−80
@@ -1,80 +0,0 @@
1−cabal-version: 2.2
2−name: servant-auth-client
3−version: 0.4.1.0
4−synopsis: servant-client/servant-auth compatibility
5−description: This package provides instances that allow generating clients from
6− <https://hackage.haskell.org/package/servant servant>
7− APIs that use
8− <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
9− .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
11−category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
13−bug-reports: https://github.com/haskell-servant/servant/issues
14−author: Julian K. Arni
15−maintainer: jkarni@gmail.com
16−copyright: (c) Julian K. Arni
17−license: BSD-3-Clause
18−license-file: LICENSE
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.4 || ==9.0.1
20−build-type: Simple
21−extra-source-files:
22− CHANGELOG.md
23−
24−source-repository head
25− type: git
26− location: https://github.com/haskell-servant/servant
27−
28−library
29− hs-source-dirs:
30− src
31− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
32− ghc-options: -Wall
33− build-depends:
34− base >= 4.10 && < 4.17
35− , bytestring >= 0.10.6.0 && < 0.12
36− , containers >= 0.5.6.2 && < 0.7
37− , servant-auth == 0.4.*
38− , servant >= 0.13 && < 0.20
39− , servant-client-core >= 0.13 && < 0.20
40−
41− exposed-modules:
42− Servant.Auth.Client
43− Servant.Auth.Client.Internal
44− default-language: Haskell2010
45−
46−test-suite spec
47− type: exitcode-stdio-1.0
48− main-is: Spec.hs
49− hs-source-dirs:
50− test
51− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
52− ghc-options: -Wall
53− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
54−
55− -- dependencies with bounds inherited from the library stanza
56− build-depends:
57− base
58− , servant-client
59− , servant-auth
60− , servant
61− , servant-auth-client
62−
63− -- test dependencies
64− build-depends:
65− hspec >= 2.5.5 && < 2.10
66− , QuickCheck >= 2.11.3 && < 2.15
67− , aeson >= 1.3.1.1 && < 3
68− , bytestring >= 0.10.6.0 && < 0.12
69− , http-client >= 0.5.13.1 && < 0.8
70− , http-types >= 0.12.2 && < 0.13
71− , servant-auth-server >= 0.4.2.0 && < 0.5
72− , servant-server >= 0.13 && < 0.20
73− , time >= 1.5.0.1 && < 1.13
74− , transformers >= 0.4.2.0 && < 0.6
75− , wai >= 3.2.1.2 && < 3.3
76− , warp >= 3.2.25 && < 3.4
77− , jose >= 0.7.0.0 && < 0.10
78− other-modules:
79− Servant.Auth.ClientSpec
80− default-language: Haskell2010
servant-auth/servant-auth-client/src/Servant/Auth/Client.hsdeleted−3
@@ -1,3 +0,0 @@
1−module Servant.Auth.Client (Token(..), Bearer) where
2−
3−import Servant.Auth.Client.Internal (Bearer, Token(..))
servant-auth/servant-auth-client/src/Servant/Auth/Client/Internal.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE UndecidableInstances #-}
4−{-# OPTIONS_GHC -fno-warn-orphans #-}
5−#if __GLASGOW_HASKELL__ == 800
6−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
7−#endif
8−module Servant.Auth.Client.Internal where
9−
10−import qualified Data.ByteString as BS
11−import Data.Monoid
12−import Data.Proxy (Proxy (..))
13−import Data.String (IsString)
14−import GHC.Exts (Constraint)
15−import GHC.Generics (Generic)
16−import Servant.API ((:>))
17−import Servant.Auth
18−
19−import Servant.Client.Core
20−import Data.Sequence ((<|))
21−
22−-- | A simple bearer token.
23−newtype Token = Token { getToken :: BS.ByteString }
24− deriving (Eq, Show, Read, Generic, IsString)
25−
26−type family HasBearer xs :: Constraint where
27− HasBearer (Bearer ': xs) = ()
28− HasBearer (JWT ': xs) = ()
29− HasBearer (x ': xs) = HasBearer xs
30− HasBearer '[] = BearerAuthNotEnabled
31−
32−class BearerAuthNotEnabled
33−
34−-- | @'HasBearer' auths@ is nominally a redundant constraint, but ensures we're not
35−-- trying to send a token to an API that doesn't accept them.
36−instance (HasBearer auths, HasClient m api) => HasClient m (Auth auths a :> api) where
37− type Client m (Auth auths a :> api) = Token -> Client m api
38−
39− clientWithRoute m _ req (Token token)
40− = clientWithRoute m (Proxy :: Proxy api)
41− $ req { requestHeaders = ("Authorization", headerVal) <| requestHeaders req }
42− where
43− headerVal = "Bearer " <> token
44−
45−#if MIN_VERSION_servant_client_core(0,14,0)
46− hoistClientMonad pm _ nt cl = hoistClientMonad pm (Proxy :: Proxy api) nt . cl
47−#endif
48−
49−
50−-- * Authentication combinators
51−
52−-- | A Bearer token in the Authorization header:
53−--
54−-- @Authorization: Bearer <token>@
55−--
56−-- This can be any token recognized by the server, for example,
57−-- a JSON Web Token (JWT).
58−--
59−-- Note that, since the exact way the token is validated is not specified,
60−-- this combinator can only be used in the client. The server would not know
61−-- how to validate it, while the client does not care.
62−-- If you want to implement Bearer authentication in your server, you have to
63−-- choose a specific combinator, such as 'JWT'.
64−data Bearer
servant-auth/servant-auth-client/test/Servant/Auth/ClientSpec.hsdeleted−161
@@ -1,161 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveAnyClass #-}
3−module Servant.Auth.ClientSpec (spec) where
4−
5−import Crypto.JOSE (JWK,
6− KeyMaterialGenParam (OctGenParam),
7− genJWK)
8−import Data.Aeson (FromJSON (..), ToJSON (..))
9−import qualified Data.ByteString.Lazy as BSL
10−import Data.Time (UTCTime, defaultTimeLocale,
11− parseTimeOrError)
12−import GHC.Generics (Generic)
13−import Network.HTTP.Client (Manager, defaultManagerSettings,
14− newManager)
15−import Network.HTTP.Types (status401)
16−import Network.Wai.Handler.Warp (testWithApplication)
17−import Servant
18−import Servant.Client (BaseUrl (..), Scheme (Http),
19− ClientError (FailureResponse),
20−#if MIN_VERSION_servant_client(0,16,0)
21− ResponseF(..),
22−#elif MIN_VERSION_servant_client(0,13,0)
23− GenResponse(..),
24−#elif MIN_VERSION_servant_client(0,12,0)
25− Response(..),
26−#endif
27− client)
28−import System.IO.Unsafe (unsafePerformIO)
29−import Test.Hspec
30−import Test.QuickCheck
31−
32−#if MIN_VERSION_servant_client(0,13,0)
33−import Servant.Client (mkClientEnv, runClientM)
34−#elif MIN_VERSION_servant_client(0,9,0)
35−import Servant.Client (ClientEnv (..), runClientM)
36−#else
37−import Control.Monad.Trans.Except (runExceptT)
38−#endif
39−#if !MIN_VERSION_servant_server(0,16,0)
40−#define ClientError ServantError
41−#endif
42−
43−import Servant.Auth.Client
44−import Servant.Auth.Server
45−import Servant.Auth.Server.SetCookieOrphan ()
46−
47−spec :: Spec
48−spec = describe "The JWT combinator" $ do
49− hasClientSpec
50−
51−
52−------------------------------------------------------------------------------
53−-- * HasClient {{{
54−
55−hasClientSpec :: Spec
56−hasClientSpec = describe "HasClient" $ around (testWithApplication $ return app) $ do
57−
58− let mkTok :: User -> Maybe UTCTime -> IO Token
59− mkTok user mexp = do
60− Right tok <- makeJWT user jwtCfg mexp
61− return $ Token $ BSL.toStrict tok
62−
63− it "succeeds when the token does not have expiry" $ \port -> property $ \user -> do
64− tok <- mkTok user Nothing
65− v <- getIntClient tok mgr (BaseUrl Http "localhost" port "")
66− v `shouldBe` Right (length $ name user)
67−
68− it "succeeds when the token is not expired" $ \port -> property $ \user -> do
69− tok <- mkTok user (Just future)
70− v <- getIntClient tok mgr (BaseUrl Http "localhost" port "")
71− v `shouldBe` Right (length $ name user)
72−
73− it "fails when token is expired" $ \port -> property $ \user -> do
74− tok <- mkTok user (Just past)
75−#if MIN_VERSION_servant_client(0,16,0)
76− Left (FailureResponse _ (Response stat _ _ _))
77−#elif MIN_VERSION_servant_client(0,12,0)
78− Left (FailureResponse (Response stat _ _ _))
79−#elif MIN_VERSION_servant_client(0,11,0)
80− Left (FailureResponse _ stat _ _)
81−#else
82− Left (FailureResponse stat _ _)
83−#endif
84− <- getIntClient tok mgr (BaseUrl Http "localhost" port "")
85− stat `shouldBe` status401
86−
87−
88−getIntClient :: Token -> Manager -> BaseUrl -> IO (Either ClientError Int)
89−#if MIN_VERSION_servant(0,13,0)
90−getIntClient tok m burl = runClientM (client api tok) (mkClientEnv m burl)
91−#elif MIN_VERSION_servant(0,9,0)
92−getIntClient tok m burl = runClientM (client api tok) (ClientEnv m burl)
93−#else
94−getIntClient tok m burl = runExceptT $ client api tok m burl
95−#endif
96−-- }}}
97−------------------------------------------------------------------------------
98−-- * API and Server {{{
99−
100−type API = Auth '[JWT] User :> Get '[JSON] Int
101−
102−api :: Proxy API
103−api = Proxy
104−
105−theKey :: JWK
106−theKey = unsafePerformIO . genJWK $ OctGenParam 256
107−{-# NOINLINE theKey #-}
108−
109−mgr :: Manager
110−mgr = unsafePerformIO $ newManager defaultManagerSettings
111−{-# NOINLINE mgr #-}
112−
113−app :: Application
114−app = serveWithContext api ctx server
115− where
116− ctx = cookieCfg :. jwtCfg :. EmptyContext
117−
118−jwtCfg :: JWTSettings
119−jwtCfg = defaultJWTSettings theKey
120−
121−cookieCfg :: CookieSettings
122−cookieCfg = defaultCookieSettings
123−
124−
125−server :: Server API
126−server = getInt
127− where
128− getInt :: AuthResult User -> Handler Int
129− getInt (Authenticated u) = return . length $ name u
130− getInt _ = throwAll err401
131−
132−
133−-- }}}
134−------------------------------------------------------------------------------
135−-- * Utils {{{
136−
137−past :: UTCTime
138−past = parseTimeOrError True defaultTimeLocale "%Y-%m-%d" "1970-01-01"
139−
140−future :: UTCTime
141−future = parseTimeOrError True defaultTimeLocale "%Y-%m-%d" "2070-01-01"
142−
143−
144−-- }}}
145−------------------------------------------------------------------------------
146−-- * Types {{{
147−
148−data User = User
149− { name :: String
150− , _id :: String
151− } deriving (Eq, Show, Read, Generic)
152−
153−instance FromJWT User
154−instance ToJWT User
155−instance FromJSON User
156−instance ToJSON User
157−
158−instance Arbitrary User where
159− arbitrary = User <$> arbitrary <*> arbitrary
160−
161−-- }}}
servant-auth/servant-auth-client/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-auth/servant-auth-docs/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -isrc -itest -idoctest/ghci-wrapper/src
servant-auth/servant-auth-docs/CHANGELOG.mddeleted−14
@@ -1,14 +0,0 @@
1−# Changelog
2−
3−All notable changes to this project will be documented in this file.
4−
5−The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6−and this project adheres to [PVP Versioning](https://pvp.haskell.org/).
7−
8−## [Unreleased]
9−
10−## [0.2.10.0] - 2018-06-18
11−
12−### Added
13−- Support for GHC 8.4 by @phadej
14−- Changelog by @domenkozar
servant-auth/servant-auth-docs/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Julian K. Arni (c) 2015
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Julian K. Arni nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
servant-auth/servant-auth-docs/Setup.hsdeleted−33
@@ -1,33 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# OPTIONS_GHC -Wall #-}
3−module Main (main) where
4−
5−#ifndef MIN_VERSION_cabal_doctest
6−#define MIN_VERSION_cabal_doctest(x,y,z) 0
7−#endif
8−
9−#if MIN_VERSION_cabal_doctest(1,0,0)
10−
11−import Distribution.Extra.Doctest ( defaultMainWithDoctests )
12−main :: IO ()
13−main = defaultMainWithDoctests "doctests"
14−
15−#else
16−
17−#ifdef MIN_VERSION_Cabal
18−-- If the macro is defined, we have new cabal-install,
19−-- but for some reason we don't have cabal-doctest in package-db
20−--
21−-- Probably we are running cabal sdist, when otherwise using new-build
22−-- workflow
23−#warning You are configuring this package without cabal-doctest installed. \
24− The doctests test-suite will not work as a result. \
25− To fix this, install cabal-doctest before configuring.
26−#endif
27−
28−import Distribution.Simple
29−
30−main :: IO ()
31−main = defaultMain
32−
33−#endif
servant-auth/servant-auth-docs/servant-auth-docs.cabaldeleted−84
@@ -1,84 +0,0 @@
1−cabal-version: 2.2
2−name: servant-auth-docs
3−version: 0.2.10.0
4−synopsis: servant-docs/servant-auth compatibility
5−description: This package provides instances that allow generating docs from
6− <https://hackage.haskell.org/package/servant servant>
7− APIs that use
8− <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
9− .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
11−category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
13−bug-reports: https://github.com/haskell-servant/servant/issues
14−author: Julian K. Arni
15−maintainer: jkarni@gmail.com
16−copyright: (c) Julian K. Arni
17−license: BSD-3-Clause
18−license-file: LICENSE
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.4 || ==9.0.1
20−build-type: Custom
21−extra-source-files:
22− CHANGELOG.md
23−
24−custom-setup
25− setup-depends:
26− base, Cabal, cabal-doctest >=1.0.6 && <1.1
27−
28−source-repository head
29− type: git
30− location: https://github.com/haskell-servant/servant
31−
32−library
33− hs-source-dirs:
34− src
35− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
36− ghc-options: -Wall
37− build-depends:
38− base >= 4.10 && < 4.17
39− , servant-docs >= 0.11.2 && < 0.13
40− , servant >= 0.13 && < 0.20
41− , servant-auth == 0.4.*
42− , lens >= 4.16.1 && <5.2
43− exposed-modules:
44− Servant.Auth.Docs
45− default-language: Haskell2010
46−
47−test-suite doctests
48− type: exitcode-stdio-1.0
49− main-is: doctests.hs
50− build-depends:
51− base,
52− servant-auth-docs,
53− doctest >= 0.16 && < 0.19,
54− QuickCheck >= 2.11.3 && < 2.15,
55− template-haskell
56− ghc-options: -Wall -threaded
57− hs-source-dirs: test
58− default-language: Haskell2010
59−
60−test-suite spec
61− type: exitcode-stdio-1.0
62− main-is: Spec.hs
63− hs-source-dirs:
64− test
65− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
66− ghc-options: -Wall
67− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
68−
69− -- dependencies with bounds inherited from the library stanza
70− build-depends:
71− base
72− , text
73− , servant-docs
74− , servant
75− , servant-auth
76− , lens
77−
78− -- test dependencies
79− build-depends:
80− servant-auth-docs
81− , hspec >= 2.5.5 && < 2.10
82− , QuickCheck >= 2.11.3 && < 2.15
83−
84− default-language: Haskell2010
servant-auth/servant-auth-docs/src/Servant/Auth/Docs.hsdeleted−96
@@ -1,96 +0,0 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−module Servant.Auth.Docs
3− (
4− -- | The purpose of this package is provide the instance for 'servant-auth'
5− -- combinators needed for 'servant-docs' documentation generation.
6− --
7− -- >>> type API = Auth '[JWT, Cookie, BasicAuth] Int :> Get '[JSON] Int
8− -- >>> putStr $ markdown $ docs (Proxy :: Proxy API)
9− -- ## GET /
10− -- ...
11− -- ... Authentication
12− -- ...
13− -- This part of the API is protected by the following authentication mechanisms:
14− -- ...
15− -- * JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token))
16− -- * [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie)
17− -- * [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
18− -- ...
19− -- Clients must supply the following data
20− -- ...
21− -- One of the following:
22− -- ...
23− -- * A JWT Token signed with this server's key
24− -- * Cookies automatically set by browsers, plus a header
25− -- * Cookies automatically set by browsers, plus a header
26− -- ...
27−
28− -- * Re-export
29− JWT
30− , BasicAuth
31− , Cookie
32− , Auth
33− ) where
34−
35−import Control.Lens ((%~), (&), (|>))
36−import Data.List (intercalate)
37−import Data.Monoid
38−import Data.Proxy (Proxy (Proxy))
39−import Servant.API hiding (BasicAuth)
40−import Servant.Auth
41−import Servant.Docs hiding (pretty)
42−import Servant.Docs.Internal (DocAuthentication (..), authInfo)
43−
44−instance (AllDocs auths, HasDocs api) => HasDocs (Auth auths r :> api) where
45− docsFor _ (endpoint, action) =
46− docsFor (Proxy :: Proxy api) (endpoint, action & authInfo %~ (|> info))
47− where
48− (intro, reqData) = pretty $ allDocs (Proxy :: Proxy auths)
49− info = DocAuthentication intro reqData
50−
51−
52−pretty :: [(String, String)] -> (String, String)
53−pretty [] = error "shouldn't happen"
54−pretty [(i, d)] =
55− ( "This part of the API is protected by " <> i
56− , d
57− )
58−pretty rs =
59− ( "This part of the API is protected by the following authentication mechanisms:\n\n"
60− ++ " * " <> intercalate "\n * " (fst <$> rs)
61− , "\nOne of the following:\n\n"
62− ++ " * " <> intercalate "\n * " (snd <$> rs)
63− )
64−
65−
66−class AllDocs (x :: [*]) where
67− allDocs :: proxy x
68− -- intro, req
69− -> [(String, String)]
70−
71−instance (OneDoc a, AllDocs as) => AllDocs (a ': as) where
72− allDocs _ = oneDoc (Proxy :: Proxy a) : allDocs (Proxy :: Proxy as)
73−
74−instance AllDocs '[] where
75− allDocs _ = []
76−
77−class OneDoc a where
78− oneDoc :: proxy a -> (String, String)
79−
80−instance OneDoc JWT where
81− oneDoc _ =
82− ("JSON Web Tokens ([JWTs](https://en.wikipedia.org/wiki/JSON_Web_Token))"
83− , "A JWT Token signed with this server's key")
84−
85−instance OneDoc Cookie where
86− oneDoc _ =
87− ("[Cookies](https://en.wikipedia.org/wiki/HTTP_cookie)"
88− , "Cookies automatically set by browsers, plus a header")
89−
90−instance OneDoc BasicAuth where
91− oneDoc _ =
92− ( "[Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)"
93− , "Cookies automatically set by browsers, plus a header")
94−
95−-- $setup
96−-- >>> instance ToSample Int where toSamples _ = singleSample 1729
servant-auth/servant-auth-docs/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-auth/servant-auth-docs/test/doctests.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−import Build_doctests (flags, pkgs, module_sources)
4−import Data.Foldable (traverse_)
5−import Test.DocTest
6−
7−main :: IO ()
8−main = do
9− traverse_ putStrLn args
10− doctest args
11− where
12− args = flags ++ pkgs ++ module_sources
servant-auth/servant-auth-server/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -isrc -itest -idoctest/ghci-wrapper/src
servant-auth/servant-auth-server/CHANGELOG.mddeleted−130
@@ -1,130 +0,0 @@
1−# Changelog
2−
3−All notable changes to this project will be documented in this file.
4−
5−The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6−and this project adheres to [PVP Versioning](https://pvp.haskell.org/).
7−
8−## [Unreleased]
9−
10−## [0.4.6.0] - 2020-10-06
11−
12−## Changed
13−
14−- expose verifyJWT and use it in two places [@domenkozar]
15−- support GHC 8.10 [@domenkozar]
16−- move ToJWT/FromJWT to servant-auth [@erewok]
17−- #165 fix AnySite with Cookie 3.5.0 [@odr]
18−
19−## [0.4.5.1] - 2020-02-06
20−
21−## Changed
22−
23−- #158 servant 0.17 support [@phadej]
24−
25−## [0.4.5.0] - 2019-12-28
26−
27−## Changed
28−- #144 servant 0.16 support and drop GHC 7.10 support [@domenkozar]
29−- #148 removed unused constaint in HasServer instance for Auth
30−- #154 GHC 8.8 support [@phadej]
31−
32−### Added
33−- #141 Support Stream combinator [@domenkozar]
34−- #143 Allow servant-0.16 [@phadej]
35−
36−## [0.4.4.0] - 2019-03-02
37−
38−### Added
39−- #141 Support Stream combinator [@domenkozar]
40−- #143 Allow servant-0.16 [@phadej]
41−
42−## [0.4.3.0] - 2019-01-17
43−
44−## Changed
45−- #117 Avoid running auth checks unnecessarily [@sopvop]
46−- #110 Get rid of crypto-api dependency [@domenkozar]
47−- #130 clearSession: improve cross-browser compatibility [@domenkozar]
48−- #136 weed out bytestring-conversion [@stephenirl]
49−
50−## [0.4.2.0] - 2018-11-05
51−
52−### Added
53−- `Headers hs a` instance for AddSetCookieApi [@domenkozar]
54−- GHC 8.6.x support [@domenkozar]
55−
56−## [0.4.1.0] - 2018-10-05
57−
58−### Added
59−- #125 Allow setting domain name for a cookie [@domenkozar]
60−
61−## Changed
62−- bump http-api-data to 0.3.10 that includes Cookie orphan instances previously located in servant-auth-server [@phadej]
63−- #114 Export `HasSecurity` typeclass [@rockbmb]
64−
65−## [0.4.0.1] - 2018-09-23
66−
67−### Security
68−- #123 Session cookie did not apply SameSite attribute [@domenkozar]
69−
70−### Added
71−- #112 HasLink instance for Auth combinator [@adetokunbo]
72−- #111 Documentation for using hoistServer [@mschristiansen]
73−- #107 Add utility functions for reading and writing a key to a file [@mschristiansen]
74−
75−## [0.4.0.0] - 2018-06-17
76−
77−### Added
78−- Support GHC 8.4 by @phadej and @domenkozar
79−- Support for servant-0.14 by @phadej
80−- #96 Support for jose-0.7 by @xaviershay
81−- #92 add `clearSession` for logout by @plredmond and @3noch
82−- #95 makeJWT: allow setting Alg via defaultJWTSettings by @domenkozar
83−- #89 Validate JWT against a JWKSet instead of JWK by @sopvop
84−
85−### Changed
86−- #92 Rename CSRF to XSRF by @plredmond and @3noch
87−- #92 extract 'XsrfCookieSettings' from 'CookieSettings' and make XSRF checking optional
88− by @plredmond and @3noch
89−- #69 export SameSite by @domenkozar
90−- #102 Reuse Servant.Api.IsSecure instead of duplicating ADT by @domenkozar
91−
92−### Deprecated
93−- #92 Renamed 'makeCsrfCookie' to 'makeXsrfCookie' and marked the former as deprecated
94− by @plredmond and @3noc
95−- #92 Made several changes to the structure of 'CookieSettings' which will require
96− attention by users who have modified the XSRF settings by @plredmond and @3noch
97−
98−### Security
99−- #94 Force cookie expiration on serverside by @karshan
100−
101−## [0.3.2.0] - 2018-02-21
102−
103−### Added
104−- #76 Export wwwAuthenticatedErr and elaborate its annotation by @defanor
105−- Support for servant-0.14 by @phadej
106−
107−### Changed
108−- Disable the readme executable for ghcjs builds by @hamishmack
109−- #84 Make AddSetCookieApi type family open by @qnikst
110−- #79 Make CSRF checks optional for GET requests by @harendra-kumar
111−
112−## [0.3.1.0] - 2017-11-08
113−
114−### Added
115−- Support for servant-0.12 by @phadej
116−
117−## [0.3.0.0] - 2017-11-07
118−
119−### Changed
120−- #47 'cookiePath' and 'xsrfCookiePath' added to 'CookieSettings' by @mchaver
121−
122−## [0.2.8.0] - 2017-05-26
123−
124−### Added
125−- #45 Support for servant-0.11 by @phadej
126−
127−## [0.2.7.0] - 2017-02-11
128−
129−### Changed
130−- #27 #41 'acceptLogin' and 'makeCsrfCookie' functions by @bts
servant-auth/servant-auth-server/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Julian K. Arni (c) 2015
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Julian K. Arni nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
servant-auth/servant-auth-server/README.lhsdeleted−291
@@ -1,291 +0,0 @@
1−# servant-auth
2−
3−These packages provides safe and easy-to-use authentication options for
4−`servant`. The same API can be protected via:
5−- basicauth
6−- cookies
7−- JWT tokens
8−
9−
10−| Package | Hackage |
11−| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12−| servant-auth | [![servant-auth](https://img.shields.io/hackage/v/servant-auth?style=flat-square&logo=haskell&label&labelColor=5D4F85)](https://hackage.haskell.org/package/servant-auth) |
13−| servant-auth-server | [![servant-auth-server](https://img.shields.io/hackage/v/servant-auth-server.svg?style=flat-square&logo=haskell&label&labelColor=5D4F85)](https://hackage.haskell.org/package/servant-auth-server) |
14−| servant-auth-client | [![servant-auth-client](https://img.shields.io/hackage/v/servant-auth-client.svg?style=flat-square&logo=haskell&label&labelColor=5D4F85)](https://hackage.haskell.org/package/servant-auth-client) |
15−| servant-auth-swagger | [![servant-auth-swagger](https://img.shields.io/hackage/v/servant-auth-swagger.svg?style=flat-square&logo=haskell&label&labelColor=5D4F85)](https://hackage.haskell.org/package/servant-auth-swagger) |
16−| servant-auth-docs | [![servant-auth-docs](https://img.shields.io/hackage/v/servant-auth-docs.svg?style=flat-square&logo=haskell&label&labelColor=5D4F85)](https://hackage.haskell.org/package/servant-auth-docs) |
17−
18−## How it works
19−
20−First some imports:
21−
22−~~~ haskell
23−{-# OPTIONS_GHC -fno-warn-unused-binds #-}
24−{-# OPTIONS_GHC -fno-warn-deprecations #-}
25−import Control.Concurrent (forkIO)
26−import Control.Monad (forever)
27−import Control.Monad.Trans (liftIO)
28−import Data.Aeson (FromJSON, ToJSON)
29−import GHC.Generics (Generic)
30−import Network.Wai.Handler.Warp (run)
31−import System.Environment (getArgs)
32−import Servant
33−import Servant.Auth.Server
34−import Servant.Auth.Server.SetCookieOrphan ()
35−~~~
36−
37−`servant-auth` library introduces a combinator `Auth`:
38−
39−~~~ haskell
40−data Auth (auths :: [*]) val
41−~~~
42−
43−What `Auth [Auth1, Auth2] Something :> API` means is that `API` is protected by
44−*either* `Auth1` *or* `Auth2`, and the result of authentication will be of type
45−`AuthResult Something`, where :
46−
47−~~~ haskell
48−data AuthResult val
49− = BadPassword
50− | NoSuchUser
51− | Authenticated val
52− | Indefinite
53−~~~
54−
55−Your handlers will get a value of type `AuthResult Something`, and can decide
56−what to do with it.
57−
58−~~~ haskell
59−
60−data User = User { name :: String, email :: String }
61− deriving (Eq, Show, Read, Generic)
62−
63−instance ToJSON User
64−instance ToJWT User
65−instance FromJSON User
66−instance FromJWT User
67−
68−data Login = Login { username :: String, password :: String }
69− deriving (Eq, Show, Read, Generic)
70−
71−instance ToJSON Login
72−instance FromJSON Login
73−
74−type Protected
75− = "name" :> Get '[JSON] String
76− :<|> "email" :> Get '[JSON] String
77−
78−
79−-- | 'Protected' will be protected by 'auths', which we still have to specify.
80−protected :: Servant.Auth.Server.AuthResult User -> Server Protected
81−-- If we get an "Authenticated v", we can trust the information in v, since
82−-- it was signed by a key we trust.
83−protected (Servant.Auth.Server.Authenticated user) = return (name user) :<|> return (email user)
84−-- Otherwise, we return a 401.
85−protected _ = throwAll err401
86−
87−type Unprotected =
88− "login"
89− :> ReqBody '[JSON] Login
90− :> Verb 'POST 204 '[JSON] (Headers '[ Header "Set-Cookie" SetCookie
91− , Header "Set-Cookie" SetCookie]
92− NoContent)
93− :<|> Raw
94−
95−unprotected :: CookieSettings -> JWTSettings -> Server Unprotected
96−unprotected cs jwts = checkCreds cs jwts :<|> serveDirectory "example/static"
97−
98−type API auths = (Servant.Auth.Server.Auth auths User :> Protected) :<|> Unprotected
99−
100−server :: CookieSettings -> JWTSettings -> Server (API auths)
101−server cs jwts = protected :<|> unprotected cs jwts
102−
103−~~~
104−
105−The code is common to all authentications. In order to pick one or more specific
106−authentication methods, all we need to do is provide the expect configuration
107−parameters.
108−
109−## API tokens
110−
111−The following example illustrates how to protect an API with tokens.
112−
113−
114−~~~ haskell
115−-- In main, we fork the server, and allow new tokens to be created in the
116−-- command line for the specified user name and email.
117−mainWithJWT :: IO ()
118−mainWithJWT = do
119− -- We generate the key for signing tokens. This would generally be persisted,
120− -- and kept safely
121− myKey <- generateKey
122− -- Adding some configurations. All authentications require CookieSettings to
123− -- be in the context.
124− let jwtCfg = defaultJWTSettings myKey
125− cfg = defaultCookieSettings :. jwtCfg :. EmptyContext
126− --- Here we actually make concrete
127− api = Proxy :: Proxy (API '[JWT])
128− _ <- forkIO $ run 7249 $ serveWithContext api cfg (server defaultCookieSettings jwtCfg)
129−
130− putStrLn "Started server on localhost:7249"
131− putStrLn "Enter name and email separated by a space for a new token"
132−
133− forever $ do
134− xs <- words <$> getLine
135− case xs of
136− [name', email'] -> do
137− etoken <- makeJWT (User name' email') jwtCfg Nothing
138− case etoken of
139− Left e -> putStrLn $ "Error generating token:t" ++ show e
140− Right v -> putStrLn $ "New token:\t" ++ show v
141− _ -> putStrLn "Expecting a name and email separated by spaces"
142−
143−~~~
144−
145−And indeed:
146−
147−~~~ bash
148−
149−./readme JWT
150−
151− Started server on localhost:7249
152− Enter name and email separated by a space for a new token
153− alice alice@gmail.com
154− New token: "eyJhbGciOiJIUzI1NiJ9.eyJkYXQiOnsiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJuYW1lIjoiYWxpY2UifX0.xzOIrx_A9VOKzVO-R1c1JYKBqK9risF625HOxpBzpzE"
155−
156−curl localhost:7249/name -v
157−
158− * Hostname was NOT found in DNS cache
159− * Trying 127.0.0.1...
160− * Connected to localhost (127.0.0.1) port 7249 (#0)
161− > GET /name HTTP/1.1
162− > User-Agent: curl/7.35.0
163− > Host: localhost:7249
164− > Accept: */*
165− >
166− < HTTP/1.1 401 Unauthorized
167− < Transfer-Encoding: chunked
168− < Date: Wed, 07 Sep 2016 20:17:17 GMT
169− * Server Warp/3.2.7 is not blacklisted
170− < Server: Warp/3.2.7
171− <
172− * Connection #0 to host localhost left intact
173−
174−curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJkYXQiOnsiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJuYW1lIjoiYWxpY2UifX0.xzOIrx_A9VOKzVO-R1c1JYKBqK9risF625HOxpBzpzE" \
175− localhost:7249/name -v
176−
177− * Hostname was NOT found in DNS cache
178− * Trying 127.0.0.1...
179− * Connected to localhost (127.0.0.1) port 7249 (#0)
180− > GET /name HTTP/1.1
181− > User-Agent: curl/7.35.0
182− > Host: localhost:7249
183− > Accept: */*
184− > Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJkYXQiOnsiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJuYW1lIjoiYWxpY2UifX0.xzOIrx_A9VOKzVO-R1c1JYKBqK9risF625HOxpBzpzE
185− >
186− < HTTP/1.1 200 OK
187− < Transfer-Encoding: chunked
188− < Date: Wed, 07 Sep 2016 20:16:11 GMT
189− * Server Warp/3.2.7 is not blacklisted
190− < Server: Warp/3.2.7
191− < Content-Type: application/json
192− < Set-Cookie: JWT-Cookie=eyJhbGciOiJIUzI1NiJ9.eyJkYXQiOnsiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJuYW1lIjoiYWxpY2UifX0.xzOIrx_A9VOKzVO-R1c1JYKBqK9risF625HOxpBzpzE; HttpOnly; Secure
193− < Set-Cookie: XSRF-TOKEN=TWcdPnHr2QHcVyTw/TTBLQ==; Secure
194− <
195− * Connection #0 to host localhost left intact
196− "alice"%
197−
198−
199−~~~
200−
201−## Cookies
202−
203−What if, in addition to API tokens, we want to expose our API to browsers? All
204−we need to do is say so!
205−
206−~~~ haskell
207−mainWithCookies :: IO ()
208−mainWithCookies = do
209− -- We *also* need a key to sign the cookies
210− myKey <- generateKey
211− -- Adding some configurations. 'Cookie' requires, in addition to
212− -- CookieSettings, JWTSettings (for signing), so everything is just as before
213− let jwtCfg = defaultJWTSettings myKey
214− cfg = defaultCookieSettings :. jwtCfg :. EmptyContext
215− --- Here is the actual change
216− api = Proxy :: Proxy (API '[Cookie])
217− run 7249 $ serveWithContext api cfg (server defaultCookieSettings jwtCfg)
218−
219−-- Here is the login handler
220−checkCreds :: CookieSettings
221− -> JWTSettings
222− -> Login
223− -> Handler (Headers '[ Header "Set-Cookie" SetCookie
224− , Header "Set-Cookie" SetCookie]
225− NoContent)
226−checkCreds cookieSettings jwtSettings (Login "Ali Baba" "Open Sesame") = do
227− -- Usually you would ask a database for the user info. This is just a
228− -- regular servant handler, so you can follow your normal database access
229− -- patterns (including using 'enter').
230− let usr = User "Ali Baba" "ali@email.com"
231− mApplyCookies <- liftIO $ acceptLogin cookieSettings jwtSettings usr
232− case mApplyCookies of
233− Nothing -> throwError err401
234− Just applyCookies -> return $ applyCookies NoContent
235−checkCreds _ _ _ = throwError err401
236−~~~
237−
238−### XSRF and the frontend
239−
240−XSRF protection works by requiring that there be a header of the same value as
241−a distinguished cookie that is set by the server on each request. What the
242−cookie and header name are can be configured (see `xsrfCookieName` and
243−`xsrfHeaderName` in `CookieSettings`), but by default they are "XSRF-TOKEN" and
244−"X-XSRF-TOKEN". This means that, if your client is a browser and you're using
245−cookies, Javascript on the client must set the header of each request by
246−reading the cookie. For jQuery, and with the default values, that might be:
247−
248−~~~ javascript
249−
250−var token = (function() {
251− r = document.cookie.match(new RegExp('XSRF-TOKEN=([^;]+)'))
252− if (r) return r[1];
253−})();
254−
255−
256−$.ajaxPrefilter(function(opts, origOpts, xhr) {
257− xhr.setRequestHeader('X-XSRF-TOKEN', token);
258− }
259−
260−~~~
261−
262−I *believe* nothing at all needs to be done if you're using Angular's `$http`
263−directive, but I haven't tested this.
264−
265−XSRF protection can be disabled just for `GET` requests by setting
266−`xsrfExcludeGet = False`. You might want this if you're relying on the browser
267−to navigate between pages that require cookie authentication.
268−
269−XSRF protection can be completely disabled by setting `cookieXsrfSetting =
270−Nothing` in `CookieSettings`. This is not recommended! If your cookie
271−authenticated web application runs any javascript, it's recommended to send the
272−XSRF header. However, if your web application runs no javascript, disabling
273−XSRF entirely may be required.
274−
275−# Note on this README
276−
277−This README is a literate haskell file. Here is 'main', allowing you to pick
278−between the examples above.
279−
280−~~~ haskell
281−
282−main :: IO ()
283−main = do
284− args <- getArgs
285− let usage = "Usage: readme (JWT|Cookie)"
286− case args of
287− ["JWT"] -> mainWithJWT
288− ["Cookie"] -> mainWithCookies
289− e -> putStrLn $ "Arguments: \"" ++ unwords e ++ "\" not understood\n" ++ usage
290−
291−~~~
servant-auth/servant-auth-server/README.mddeleted−1
@@ -1 +0,0 @@
1−README.lhs
servant-auth/servant-auth-server/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
servant-auth/servant-auth-server/servant-auth-server.cabaldeleted−134
@@ -1,134 +0,0 @@
1−cabal-version: 2.2
2−name: servant-auth-server
3−version: 0.4.7.0
4−synopsis: servant-server/servant-auth compatibility
5−description: This package provides the required instances for using the @Auth@ combinator
6− in your 'servant' server.
7− .
8− Both cookie- and token- (REST API) based authentication is provided.
9− .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
11−category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
13−bug-reports: https://github.com/haskell-servant/servant/issues
14−author: Julian K. Arni
15−maintainer: jkarni@gmail.com
16−copyright: (c) Julian K. Arni
17−license: BSD-3-Clause
18−license-file: LICENSE
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.4 || ==9.0.1
20−build-type: Simple
21−extra-source-files:
22− CHANGELOG.md
23−
24−source-repository head
25− type: git
26− location: https://github.com/haskell-servant/servant
27−
28−library
29− hs-source-dirs:
30− src
31− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
32− ghc-options: -Wall
33− build-depends:
34− base >= 4.10 && < 4.17
35− , aeson >= 1.0.0.1 && < 3
36− , base64-bytestring >= 1.0.0.1 && < 2
37− , blaze-builder >= 0.4.1.0 && < 0.5
38− , bytestring >= 0.10.6.0 && < 0.12
39− , case-insensitive >= 1.2.0.11 && < 1.3
40− , cookie >= 0.4.4 && < 0.5
41− , data-default-class >= 0.1.2.0 && < 0.2
42− , entropy >= 0.4.1.3 && < 0.5
43− , http-types >= 0.12.2 && < 0.13
44− , jose >= 0.7.0.0 && < 0.10
45− , lens >= 4.16.1 && < 5.2
46− , memory >= 0.14.16 && < 0.18
47− , monad-time >= 0.3.1.0 && < 0.4
48− , mtl >= 2.2.2 && < 2.3
49− , servant >= 0.13 && < 0.20
50− , servant-auth == 0.4.*
51− , servant-server >= 0.13 && < 0.20
52− , tagged >= 0.8.4 && < 0.9
53− , text >= 1.2.3.0 && < 2.1
54− , time >= 1.5.0.1 && < 1.12
55− , unordered-containers >= 0.2.9.0 && < 0.3
56− , wai >= 3.2.1.2 && < 3.3
57−
58− if impl(ghc >= 9)
59− build-depends:
60− -- base64-bytestring 1.2.1.0 contains important fix for GHC-9, lower versions
61− -- produce wrong results, thus corrupring JWT via jose package.
62− -- See: https://github.com/haskell/base64-bytestring/pull/46
63− base64-bytestring >= 1.2.1.0
64−
65− exposed-modules:
66− Servant.Auth.Server
67− Servant.Auth.Server.Internal
68− Servant.Auth.Server.Internal.AddSetCookie
69− Servant.Auth.Server.Internal.BasicAuth
70− Servant.Auth.Server.Internal.Class
71− Servant.Auth.Server.Internal.ConfigTypes
72− Servant.Auth.Server.Internal.Cookie
73− Servant.Auth.Server.Internal.FormLogin
74− Servant.Auth.Server.Internal.JWT
75− Servant.Auth.Server.Internal.ThrowAll
76− Servant.Auth.Server.Internal.Types
77− Servant.Auth.Server.SetCookieOrphan
78− default-language: Haskell2010
79−
80−test-suite readme
81− type: exitcode-stdio-1.0
82− main-is: README.lhs
83− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
84− ghc-options: -Wall -pgmL markdown-unlit
85− build-tool-depends: markdown-unlit:markdown-unlit
86− build-depends:
87− base
88− , servant-auth
89− , servant-auth-server
90− , servant-server
91− , aeson
92− , mtl
93− , warp
94− default-language: Haskell2010
95− if impl(ghcjs)
96− buildable: False
97−
98−test-suite spec
99− type: exitcode-stdio-1.0
100− main-is: Spec.hs
101− hs-source-dirs:
102− test
103− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
104− ghc-options: -Wall
105− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
106−
107− -- dependencies with bounds inherited from the library stanza
108− build-depends:
109− base
110− , aeson
111− , bytestring
112− , case-insensitive
113− , jose
114− , lens
115− , mtl
116− , time
117− , http-types
118− , wai
119− , servant
120− , servant-server
121− , transformers
122−
123− -- test dependencies
124− build-depends:
125− servant-auth-server
126− , hspec >= 2.5.5 && < 2.10
127− , QuickCheck >= 2.11.3 && < 2.15
128− , http-client >= 0.5.13.1 && < 0.8
129− , lens-aeson >= 1.0.2 && < 1.3
130− , warp >= 3.2.25 && < 3.4
131− , wreq >= 0.5.2.1 && < 0.6
132− other-modules:
133− Servant.Auth.ServerSpec
134− default-language: Haskell2010
servant-auth/servant-auth-server/src/Servant/Auth/Server.hsdeleted−180
@@ -1,180 +0,0 @@
1−module Servant.Auth.Server
2− (
3− -- | This package provides implementations for some common authentication
4− -- methods. Authentication yields a trustworthy (because generated by the
5− -- server) value of an some arbitrary type:
6− --
7− -- > type MyApi = Protected
8− -- >
9− -- > type Protected = Auth '[JWT, Cookie] User :> Get '[JSON] UserAccountDetails
10− -- >
11− -- > server :: Server Protected
12− -- > server (Authenticated usr) = ... -- here we know the client really is
13− -- > -- who she claims to be
14− -- > server _ = throwAll err401
15− --
16− -- Additional configuration happens via 'Context'.
17− --
18− -- == Example for Custom Handler
19− -- To use a custom 'Servant.Server.Handler' it is necessary to use
20− -- 'Servant.Server.hoistServerWithContext' instead of
21− -- 'Servant.Server.hoistServer' and specify the 'Context'.
22− --
23− -- Below is an example of passing 'CookieSettings' and 'JWTSettings' in the
24− -- 'Context' to create a specialized function equivalent to
25− -- 'Servant.Server.hoistServer' for an API that includes cookie
26− -- authentication.
27− --
28− -- > hoistServerWithAuth
29− -- > :: HasServer api '[CookieSettings, JWTSettings]
30− -- > => Proxy api
31− -- > -> (forall x. m x -> n x)
32− -- > -> ServerT api m
33− -- > -> ServerT api n
34− -- > hoistServerWithAuth api =
35− -- > hoistServerWithContext api (Proxy :: Proxy '[CookieSettings, JWTSettings])
36−
37− ----------------------------------------------------------------------------
38− -- * Auth
39− -- | Basic types
40− Auth
41− , AuthResult(..)
42− , AuthCheck(..)
43−
44− ----------------------------------------------------------------------------
45− -- * JWT
46− -- | JSON Web Tokens (JWT) are a compact and secure way of transferring
47− -- information between parties. In this library, they are signed by the
48− -- server (or by some other party posessing the relevant key), and used to
49− -- indicate the bearer's identity or authorization.
50− --
51− -- Arbitrary information can be encoded - just declare instances for the
52− -- 'FromJWT' and 'ToJWT' classes. Don't go overboard though - be aware that
53− -- usually you'll be trasmitting this information on each request (and
54− -- response!).
55− --
56− -- Note that, while the tokens are signed, they are not encrypted. Do not put
57− -- any information you do not wish the client to know in them!
58−
59− -- ** Combinator
60− -- | Re-exported from 'servant-auth'
61− , JWT
62−
63− -- ** Classes
64− , FromJWT(..)
65− , ToJWT(..)
66−
67− -- ** Related types
68− , IsMatch(..)
69−
70− -- ** Settings
71− , JWTSettings(..)
72− , defaultJWTSettings
73−
74− -- ** Create check
75− , jwtAuthCheck
76−
77−
78− ----------------------------------------------------------------------------
79− -- * Cookie
80− -- | Cookies are also a method of identifying and authenticating a user. They
81− -- are particular common when the client is a browser
82−
83− -- ** Combinator
84− -- | Re-exported from 'servant-auth'
85− , Cookie
86−
87− -- ** Settings
88− , CookieSettings(..)
89− , XsrfCookieSettings(..)
90− , defaultCookieSettings
91− , defaultXsrfCookieSettings
92− , makeSessionCookie
93− , makeSessionCookieBS
94− , makeXsrfCookie
95− , makeCsrfCookie
96− , makeCookie
97− , makeCookieBS
98− , acceptLogin
99− , clearSession
100−
101−
102− -- ** Related types
103− , IsSecure(..)
104− , SameSite(..)
105− , AreAuths
106−
107− ----------------------------------------------------------------------------
108− -- * BasicAuth
109− -- ** Combinator
110− -- | Re-exported from 'servant-auth'
111− , BasicAuth
112−
113− -- ** Classes
114− , FromBasicAuthData(..)
115−
116− -- ** Settings
117− , BasicAuthCfg
118−
119− -- ** Related types
120− , BasicAuthData(..)
121− , IsPasswordCorrect(..)
122−
123− -- ** Authentication request
124− , wwwAuthenticatedErr
125−
126− ----------------------------------------------------------------------------
127− -- * Utilies
128− , ThrowAll(throwAll)
129− , generateKey
130− , generateSecret
131− , fromSecret
132− , writeKey
133− , readKey
134− , makeJWT
135− , verifyJWT
136−
137− -- ** Re-exports
138− , Default(def)
139− , SetCookie
140− ) where
141−
142−import Prelude hiding (readFile, writeFile)
143−import Data.ByteString (ByteString, writeFile, readFile)
144−import Data.Default.Class (Default (def))
145−import Servant.Auth
146−import Servant.Auth.JWT
147−import Servant.Auth.Server.Internal ()
148−import Servant.Auth.Server.Internal.BasicAuth
149−import Servant.Auth.Server.Internal.Class
150−import Servant.Auth.Server.Internal.ConfigTypes
151−import Servant.Auth.Server.Internal.Cookie
152−import Servant.Auth.Server.Internal.JWT
153−import Servant.Auth.Server.Internal.ThrowAll
154−import Servant.Auth.Server.Internal.Types
155−
156−import Crypto.JOSE as Jose
157−import Servant (BasicAuthData (..))
158−import Web.Cookie (SetCookie)
159−
160−-- | Generate a key suitable for use with 'defaultConfig'.
161−generateKey :: IO Jose.JWK
162−generateKey = Jose.genJWK $ Jose.OctGenParam 256
163−
164−-- | Generate a bytestring suitable for use with 'fromSecret'.
165−generateSecret :: MonadRandom m => m ByteString
166−generateSecret = Jose.getRandomBytes 256
167−
168−-- | Restores a key from a bytestring.
169−fromSecret :: ByteString -> Jose.JWK
170−fromSecret = Jose.fromOctets
171−
172−-- | Writes a secret to a file. Can for instance be used from the REPL
173−-- to persist a key to a file, which can then be included with the
174−-- application. Restore the key using 'readKey'.
175−writeKey :: FilePath -> IO ()
176−writeKey fp = writeFile fp =<< generateSecret
177−
178−-- | Reads a key from a file.
179−readKey :: FilePath -> IO Jose.JWK
180−readKey fp = fromSecret <$> readFile fp
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal.hsdeleted−70
@@ -1,70 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE UndecidableInstances #-}
3−{-# OPTIONS_GHC -fno-warn-orphans #-}
4−
5−module Servant.Auth.Server.Internal where
6−
7−import Control.Monad.Trans (liftIO)
8−import Servant ((:>), Handler, HasServer (..),
9− Proxy (..),
10− HasContextEntry(getContextEntry))
11−import Servant.Auth
12−import Servant.Auth.JWT (ToJWT)
13−
14−import Servant.Auth.Server.Internal.AddSetCookie
15−import Servant.Auth.Server.Internal.Class
16−import Servant.Auth.Server.Internal.Cookie
17−import Servant.Auth.Server.Internal.ConfigTypes
18−import Servant.Auth.Server.Internal.JWT
19−import Servant.Auth.Server.Internal.Types
20−
21−import Servant.Server.Internal (DelayedIO, addAuthCheck, withRequest)
22−
23−instance ( n ~ 'S ('S 'Z)
24− , HasServer (AddSetCookiesApi n api) ctxs, AreAuths auths ctxs v
25− , HasServer api ctxs -- this constraint is needed to implement hoistServer
26− , AddSetCookies n (ServerT api Handler) (ServerT (AddSetCookiesApi n api) Handler)
27− , ToJWT v
28− , HasContextEntry ctxs CookieSettings
29− , HasContextEntry ctxs JWTSettings
30− ) => HasServer (Auth auths v :> api) ctxs where
31− type ServerT (Auth auths v :> api) m = AuthResult v -> ServerT api m
32−
33−#if MIN_VERSION_servant_server(0,12,0)
34− hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
35−#endif
36−
37− route _ context subserver =
38− route (Proxy :: Proxy (AddSetCookiesApi n api))
39− context
40− (fmap go subserver `addAuthCheck` authCheck)
41−
42− where
43− authCheck :: DelayedIO (AuthResult v, SetCookieList ('S ('S 'Z)))
44− authCheck = withRequest $ \req -> liftIO $ do
45− authResult <- runAuthCheck (runAuths (Proxy :: Proxy auths) context) req
46− cookies <- makeCookies authResult
47− return (authResult, cookies)
48−
49− jwtSettings :: JWTSettings
50− jwtSettings = getContextEntry context
51−
52− cookieSettings :: CookieSettings
53− cookieSettings = getContextEntry context
54−
55− makeCookies :: AuthResult v -> IO (SetCookieList ('S ('S 'Z)))
56− makeCookies authResult = do
57− xsrf <- makeXsrfCookie cookieSettings
58− fmap (Just xsrf `SetCookieCons`) $
59− case authResult of
60− (Authenticated v) -> do
61− ejwt <- makeSessionCookie cookieSettings jwtSettings v
62− case ejwt of
63− Nothing -> return $ Nothing `SetCookieCons` SetCookieNil
64− Just jwt -> return $ Just jwt `SetCookieCons` SetCookieNil
65− _ -> return $ Nothing `SetCookieCons` SetCookieNil
66−
67− go :: (AuthResult v -> ServerT api Handler)
68− -> (AuthResult v, SetCookieList n)
69− -> ServerT (AddSetCookiesApi n api) Handler
70− go fn (authResult, cookies) = addSetCookies cookies $ fn authResult
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/AddSetCookie.hsdeleted−106
@@ -1,106 +0,0 @@
1−{-# LANGUAGE PolyKinds #-}
2−{-# LANGUAGE TupleSections #-}
3−{-# LANGUAGE UndecidableInstances #-}
4−{-# LANGUAGE CPP #-}
5−
6−module Servant.Auth.Server.Internal.AddSetCookie where
7−
8−import Blaze.ByteString.Builder (toByteString)
9−import qualified Data.ByteString as BS
10−import Data.Tagged (Tagged (..))
11−import qualified Network.HTTP.Types as HTTP
12−import Network.Wai (mapResponseHeaders)
13−import Servant
14−import Servant.API.Generic
15−import Servant.Server.Generic
16−import Web.Cookie
17−
18−-- What are we doing here? Well, the idea is to add headers to the response,
19−-- but the headers come from the authentication check. In order to do that, we
20−-- tweak a little the general theme of recursing down the API tree; this time,
21−-- we recurse down a variation of it that adds headers to all the endpoints.
22−-- This involves the usual type-level checks.
23−--
24−-- TODO: If the endpoints already have headers, this will not work as is.
25−
26−data Nat = Z | S Nat
27−
28−type family AddSetCookiesApi (n :: Nat) a where
29− AddSetCookiesApi ('S 'Z) a = AddSetCookieApi a
30− AddSetCookiesApi ('S n) a = AddSetCookiesApi n (AddSetCookieApi a)
31−
32−type family AddSetCookieApiVerb a where
33− AddSetCookieApiVerb (Headers ls a) = Headers (Header "Set-Cookie" SetCookie ': ls) a
34− AddSetCookieApiVerb a = Headers '[Header "Set-Cookie" SetCookie] a
35−
36−type family AddSetCookieApi a :: *
37−type instance AddSetCookieApi (a :> b) = a :> AddSetCookieApi b
38−type instance AddSetCookieApi (a :<|> b) = AddSetCookieApi a :<|> AddSetCookieApi b
39−type instance AddSetCookieApi (NamedRoutes api) = AddSetCookieApi (ToServantApi api)
40−type instance AddSetCookieApi (Verb method stat ctyps a)
41− = Verb method stat ctyps (AddSetCookieApiVerb a)
42−type instance AddSetCookieApi Raw = Raw
43−#if MIN_VERSION_servant_server(0,15,0)
44−type instance AddSetCookieApi (Stream method stat framing ctyps a)
45− = Stream method stat framing ctyps (AddSetCookieApiVerb a)
46−#endif
47−type instance AddSetCookieApi (Headers hs a) = AddSetCookieApiVerb (Headers hs a)
48−
49−data SetCookieList (n :: Nat) :: * where
50− SetCookieNil :: SetCookieList 'Z
51− SetCookieCons :: Maybe SetCookie -> SetCookieList n -> SetCookieList ('S n)
52−
53−class AddSetCookies (n :: Nat) orig new where
54− addSetCookies :: SetCookieList n -> orig -> new
55−
56−instance {-# OVERLAPS #-} AddSetCookies ('S n) oldb newb
57− => AddSetCookies ('S n) (a -> oldb) (a -> newb) where
58− addSetCookies cookies oldfn = addSetCookies cookies . oldfn
59−
60−instance AddSetCookies 'Z orig orig where
61− addSetCookies _ = id
62−
63−instance {-# OVERLAPPABLE #-}
64− ( Functor m
65− , AddSetCookies n (m old) (m cookied)
66− , AddHeader "Set-Cookie" SetCookie cookied new
67− ) => AddSetCookies ('S n) (m old) (m new) where
68− addSetCookies (mCookie `SetCookieCons` rest) oldVal =
69− case mCookie of
70− Nothing -> noHeader <$> addSetCookies rest oldVal
71− Just cookie -> addHeader cookie <$> addSetCookies rest oldVal
72−
73−instance {-# OVERLAPS #-}
74− (AddSetCookies ('S n) a a', AddSetCookies ('S n) b b')
75− => AddSetCookies ('S n) (a :<|> b) (a' :<|> b') where
76− addSetCookies cookies (a :<|> b) = addSetCookies cookies a :<|> addSetCookies cookies b
77−
78−instance {-# OVERLAPS #-}
79− ( AddSetCookies ('S n) (ServerT (ToServantApi api) m) cookiedApi
80− , Generic (api (AsServerT m))
81− , GServantProduct (Rep (api (AsServerT m)))
82− , ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
83− )
84− => AddSetCookies ('S n) (api (AsServerT m)) cookiedApi where
85− addSetCookies cookies = addSetCookies cookies . toServant
86−
87−-- | for @servant <0.11@
88−instance
89− AddSetCookies ('S n) Application Application where
90− addSetCookies cookies r request respond
91− = r request $ respond . mapResponseHeaders (++ mkHeaders cookies)
92−
93−-- | for @servant >=0.11@
94−instance
95− AddSetCookies ('S n) (Tagged m Application) (Tagged m Application) where
96− addSetCookies cookies r = Tagged $ \request respond ->
97− unTagged r request $ respond . mapResponseHeaders (++ mkHeaders cookies)
98−
99−mkHeaders :: SetCookieList x -> [HTTP.Header]
100−mkHeaders x = ("Set-Cookie",) <$> mkCookies x
101− where
102− mkCookies :: forall y. SetCookieList y -> [BS.ByteString]
103− mkCookies SetCookieNil = []
104− mkCookies (SetCookieCons Nothing rest) = mkCookies rest
105− mkCookies (SetCookieCons (Just y) rest)
106− = toByteString (renderSetCookie y) : mkCookies rest
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/BasicAuth.hsdeleted−59
@@ -1,59 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Servant.Auth.Server.Internal.BasicAuth where
3−
4−#if !MIN_VERSION_servant_server(0,16,0)
5−#define ServerError ServantErr
6−#endif
7−
8−import qualified Data.ByteString as BS
9−import Servant (BasicAuthData (..),
10− ServerError (..), err401)
11−import Servant.Server.Internal.BasicAuth (decodeBAHdr,
12− mkBAChallengerHdr)
13−
14−import Servant.Auth.Server.Internal.Types
15−
16−-- | A 'ServerError' that asks the client to authenticate via Basic
17−-- Authentication, should be invoked by an application whenever
18−-- appropriate. The argument is the realm.
19−wwwAuthenticatedErr :: BS.ByteString -> ServerError
20−wwwAuthenticatedErr realm = err401 { errHeaders = [mkBAChallengerHdr realm] }
21−
22−-- | A type holding the configuration for Basic Authentication.
23−-- It is defined as a type family with no arguments, so that
24−-- it can be instantiated to whatever type you need to
25−-- authenticate your users (use @type instance BasicAuthCfg = ...@).
26−--
27−-- Note that the instantiation is application-wide,
28−-- i.e. there can be only one instance.
29−-- As a consequence, it should not be instantiated in a library.
30−--
31−-- Basic Authentication expects an element of type 'BasicAuthCfg'
32−-- to be in the 'Context'; that element is then passed automatically
33−-- to the instance of 'FromBasicAuthData' together with the
34−-- authentication data obtained from the client.
35−--
36−-- If you do not need a configuration for Basic Authentication,
37−-- you can use just @BasicAuthCfg = ()@, and recall to also
38−-- add @()@ to the 'Context'.
39−-- A basic but more interesting example is to take as 'BasicAuthCfg'
40−-- a list of authorised username/password pairs:
41−--
42−-- > deriving instance Eq BasicAuthData
43−-- > type instance BasicAuthCfg = [BasicAuthData]
44−-- > instance FromBasicAuthData User where
45−-- > fromBasicAuthData authData authCfg =
46−-- > if elem authData authCfg then ...
47−type family BasicAuthCfg
48−
49−class FromBasicAuthData a where
50− -- | Whether the username exists and the password is correct.
51− -- Note that, rather than passing a 'Pass' to the function, we pass a
52− -- function that checks an 'EncryptedPass'. This is to make sure you don't
53− -- accidentally do something untoward with the password, like store it.
54− fromBasicAuthData :: BasicAuthData -> BasicAuthCfg -> IO (AuthResult a)
55−
56−basicAuthCheck :: FromBasicAuthData usr => BasicAuthCfg -> AuthCheck usr
57−basicAuthCheck cfg = AuthCheck $ \req -> case decodeBAHdr req of
58− Nothing -> return Indefinite
59− Just baData -> fromBasicAuthData baData cfg
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Class.hsdeleted−72
@@ -1,72 +0,0 @@
1−{-# LANGUAGE UndecidableInstances #-}
2−module Servant.Auth.Server.Internal.Class where
3−
4−import Servant.Auth
5−import Data.Monoid
6−import Servant hiding (BasicAuth)
7−
8−import Servant.Auth.JWT
9−import Servant.Auth.Server.Internal.Types
10−import Servant.Auth.Server.Internal.ConfigTypes
11−import Servant.Auth.Server.Internal.BasicAuth
12−import Servant.Auth.Server.Internal.Cookie
13−import Servant.Auth.Server.Internal.JWT (jwtAuthCheck)
14−
15−-- | @IsAuth a ctx v@ indicates that @a@ is an auth type that expects all
16−-- elements of @ctx@ to be the in the Context and whose authentication check
17−-- returns an @AuthCheck v@.
18−class IsAuth a v where
19− type family AuthArgs a :: [*]
20− runAuth :: proxy a -> proxy v -> Unapp (AuthArgs a) (AuthCheck v)
21−
22−instance FromJWT usr => IsAuth Cookie usr where
23− type AuthArgs Cookie = '[CookieSettings, JWTSettings]
24− runAuth _ _ = cookieAuthCheck
25−
26−instance FromJWT usr => IsAuth JWT usr where
27− type AuthArgs JWT = '[JWTSettings]
28− runAuth _ _ = jwtAuthCheck
29−
30−instance FromBasicAuthData usr => IsAuth BasicAuth usr where
31− type AuthArgs BasicAuth = '[BasicAuthCfg]
32− runAuth _ _ = basicAuthCheck
33−
34−-- * Helper
35−
36−class AreAuths (as :: [*]) (ctxs :: [*]) v where
37− runAuths :: proxy as -> Context ctxs -> AuthCheck v
38−
39−instance AreAuths '[] ctxs v where
40− runAuths _ _ = mempty
41−
42−instance ( AuthCheck v ~ App (AuthArgs a) (Unapp (AuthArgs a) (AuthCheck v))
43− , IsAuth a v
44− , AreAuths as ctxs v
45− , AppCtx ctxs (AuthArgs a) (Unapp (AuthArgs a) (AuthCheck v))
46− ) => AreAuths (a ': as) ctxs v where
47− runAuths _ ctxs = go <> runAuths (Proxy :: Proxy as) ctxs
48− where
49− go = appCtx (Proxy :: Proxy (AuthArgs a))
50− ctxs
51− (runAuth (Proxy :: Proxy a) (Proxy :: Proxy v))
52−
53−type family Unapp ls res where
54− Unapp '[] res = res
55− Unapp (arg1 ': rest) res = arg1 -> Unapp rest res
56−
57−type family App ls res where
58− App '[] res = res
59− App (arg1 ': rest) (arg1 -> res) = App rest res
60−
61−-- | @AppCtx@ applies the function @res@ to the arguments in @ls@ by taking the
62−-- values from the Context provided.
63−class AppCtx ctx ls res where
64− appCtx :: proxy ls -> Context ctx -> res -> App ls res
65−
66−instance ( HasContextEntry ctxs ctx
67− , AppCtx ctxs rest res
68− ) => AppCtx ctxs (ctx ': rest) (ctx -> res) where
69− appCtx _ ctx fn = appCtx (Proxy :: Proxy rest) ctx $ fn $ getContextEntry ctx
70−
71−instance AppCtx ctx '[] res where
72− appCtx _ _ r = r
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ConfigTypes.hsdeleted−127
@@ -1,127 +0,0 @@
1−module Servant.Auth.Server.Internal.ConfigTypes
2− ( module Servant.Auth.Server.Internal.ConfigTypes
3− , Servant.API.IsSecure(..)
4− ) where
5−
6−import Crypto.JOSE as Jose
7−import Crypto.JWT as Jose
8−import qualified Data.ByteString as BS
9−import Data.Default.Class
10−import Data.Time
11−import GHC.Generics (Generic)
12−import Servant.API (IsSecure(..))
13−
14−data IsMatch = Matches | DoesNotMatch
15− deriving (Eq, Show, Read, Generic, Ord)
16−
17−data IsPasswordCorrect = PasswordCorrect | PasswordIncorrect
18− deriving (Eq, Show, Read, Generic, Ord)
19−
20−-- The @SameSite@ attribute of cookies determines whether cookies will be sent
21−-- on cross-origin requests.
22−--
23−-- See <https://tools.ietf.org/html/draft-west-first-party-cookies-07 this document>
24−-- for more information.
25−data SameSite = AnySite | SameSiteStrict | SameSiteLax
26− deriving (Eq, Show, Read, Generic, Ord)
27−
28−-- | @JWTSettings@ are used to generate cookies, and to verify JWTs.
29−data JWTSettings = JWTSettings
30− {
31− -- | Key used to sign JWT.
32− signingKey :: Jose.JWK
33− -- | Algorithm used to sign JWT.
34− , jwtAlg :: Maybe Jose.Alg
35− -- | Keys used to validate JWT.
36− , validationKeys :: IO Jose.JWKSet
37− -- | An @aud@ predicate. The @aud@ is a string or URI that identifies the
38− -- intended recipient of the JWT.
39− , audienceMatches :: Jose.StringOrURI -> IsMatch
40− } deriving (Generic)
41−
42−-- | A @JWTSettings@ where the audience always matches.
43−defaultJWTSettings :: Jose.JWK -> JWTSettings
44−defaultJWTSettings k = JWTSettings
45− { signingKey = k
46− , jwtAlg = Nothing
47− , validationKeys = pure $ Jose.JWKSet [k]
48− , audienceMatches = const Matches }
49−
50−-- | The policies to use when generating cookies.
51−--
52−-- If *both* 'cookieMaxAge' and 'cookieExpires' are @Nothing@, browsers will
53−-- treat the cookie as a *session cookie*. These will be deleted when the
54−-- browser is closed.
55−--
56−-- Note that having the setting @Secure@ may cause testing failures if you are
57−-- not testing over HTTPS.
58−data CookieSettings = CookieSettings
59− {
60− -- | 'Secure' means browsers will only send cookies over HTTPS. Default:
61− -- @Secure@.
62− cookieIsSecure :: !IsSecure
63− -- | How long from now until the cookie expires. Default: @Nothing@.
64− , cookieMaxAge :: !(Maybe DiffTime)
65− -- | At what time the cookie expires. Default: @Nothing@.
66− , cookieExpires :: !(Maybe UTCTime)
67− -- | The URL path and sub-paths for which this cookie is used. Default: @Just "/"@.
68− , cookiePath :: !(Maybe BS.ByteString)
69− -- | Domain name, if set cookie also allows subdomains. Default: @Nothing@.
70− , cookieDomain :: !(Maybe BS.ByteString)
71− -- | 'SameSite' settings. Default: @SameSiteLax@.
72− , cookieSameSite :: !SameSite
73− -- | What name to use for the cookie used for the session.
74− , sessionCookieName :: !BS.ByteString
75− -- | The optional settings to use for XSRF protection. Default: @Just def@.
76− , cookieXsrfSetting :: !(Maybe XsrfCookieSettings)
77− } deriving (Eq, Show, Generic)
78−
79−instance Default CookieSettings where
80− def = defaultCookieSettings
81−
82−defaultCookieSettings :: CookieSettings
83−defaultCookieSettings = CookieSettings
84− { cookieIsSecure = Secure
85− , cookieMaxAge = Nothing
86− , cookieExpires = Nothing
87− , cookiePath = Just "/"
88− , cookieDomain = Nothing
89− , cookieSameSite = SameSiteLax
90− , sessionCookieName = "JWT-Cookie"
91− , cookieXsrfSetting = Just def
92− }
93−
94−-- | The policies to use when generating and verifying XSRF cookies
95−data XsrfCookieSettings = XsrfCookieSettings
96− {
97− -- | What name to use for the cookie used for XSRF protection.
98− xsrfCookieName :: !BS.ByteString
99− -- | What path to use for the cookie used for XSRF protection. Default @Just "/"@.
100− , xsrfCookiePath :: !(Maybe BS.ByteString)
101− -- | What name to use for the header used for XSRF protection.
102− , xsrfHeaderName :: !BS.ByteString
103− -- | Exclude GET request method from XSRF protection.
104− , xsrfExcludeGet :: !Bool
105− } deriving (Eq, Show, Generic)
106−
107−instance Default XsrfCookieSettings where
108− def = defaultXsrfCookieSettings
109−
110−defaultXsrfCookieSettings :: XsrfCookieSettings
111−defaultXsrfCookieSettings = XsrfCookieSettings
112− { xsrfCookieName = "XSRF-TOKEN"
113− , xsrfCookiePath = Just "/"
114− , xsrfHeaderName = "X-XSRF-TOKEN"
115− , xsrfExcludeGet = False
116− }
117−
118−------------------------------------------------------------------------------
119−-- Internal {{{
120−
121−jwtSettingsToJwtValidationSettings :: JWTSettings -> Jose.JWTValidationSettings
122−jwtSettingsToJwtValidationSettings s
123− = defaultJWTValidationSettings (toBool <$> audienceMatches s)
124− where
125− toBool Matches = True
126− toBool DoesNotMatch = False
127−-- }}}
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Cookie.hsdeleted−182
@@ -1,182 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Servant.Auth.Server.Internal.Cookie where
3−
4−import Blaze.ByteString.Builder (toByteString)
5−import Control.Monad.Except
6−import Control.Monad.Reader
7−import qualified Crypto.JOSE as Jose
8−import qualified Crypto.JWT as Jose
9−import Data.ByteArray (constEq)
10−import qualified Data.ByteString as BS
11−import qualified Data.ByteString.Base64 as BS64
12−import qualified Data.ByteString.Lazy as BSL
13−import Data.CaseInsensitive (mk)
14−import Data.Maybe (fromMaybe)
15−import Data.Time.Calendar (Day(..))
16−import Data.Time.Clock (UTCTime(..), secondsToDiffTime)
17−import Network.HTTP.Types (methodGet)
18−import Network.HTTP.Types.Header(hCookie)
19−import Network.Wai (Request, requestHeaders, requestMethod)
20−import Servant (AddHeader, addHeader)
21−import System.Entropy (getEntropy)
22−import Web.Cookie
23−
24−import Servant.Auth.JWT (FromJWT (decodeJWT), ToJWT)
25−import Servant.Auth.Server.Internal.ConfigTypes
26−import Servant.Auth.Server.Internal.JWT (makeJWT, verifyJWT)
27−import Servant.Auth.Server.Internal.Types
28−
29−
30−cookieAuthCheck :: FromJWT usr => CookieSettings -> JWTSettings -> AuthCheck usr
31−cookieAuthCheck ccfg jwtSettings = do
32− req <- ask
33− jwtCookie <- maybe mempty return $ do
34− cookies' <- lookup hCookie $ requestHeaders req
35− let cookies = parseCookies cookies'
36− -- Apply the XSRF check if enabled.
37− guard $ fromMaybe True $ do
38− xsrfCookieCfg <- xsrfCheckRequired ccfg req
39− return $ xsrfCookieAuthCheck xsrfCookieCfg req cookies
40− -- session cookie *must* be HttpOnly and Secure
41− lookup (sessionCookieName ccfg) cookies
42− verifiedJWT <- liftIO $ verifyJWT jwtSettings jwtCookie
43− case verifiedJWT of
44− Nothing -> mzero
45− Just v -> return v
46−
47−xsrfCheckRequired :: CookieSettings -> Request -> Maybe XsrfCookieSettings
48−xsrfCheckRequired cookieSettings req = do
49− xsrfCookieCfg <- cookieXsrfSetting cookieSettings
50− let disableForGetReq = xsrfExcludeGet xsrfCookieCfg && requestMethod req == methodGet
51− guard $ not disableForGetReq
52− return xsrfCookieCfg
53−
54−xsrfCookieAuthCheck :: XsrfCookieSettings -> Request -> [(BS.ByteString, BS.ByteString)] -> Bool
55−xsrfCookieAuthCheck xsrfCookieCfg req cookies = fromMaybe False $ do
56− xsrfCookie <- lookup (xsrfCookieName xsrfCookieCfg) cookies
57− xsrfHeader <- lookup (mk $ xsrfHeaderName xsrfCookieCfg) $ requestHeaders req
58− return $ xsrfCookie `constEq` xsrfHeader
59−
60−-- | Makes a cookie to be used for XSRF.
61−makeXsrfCookie :: CookieSettings -> IO SetCookie
62−makeXsrfCookie cookieSettings = case cookieXsrfSetting cookieSettings of
63− Just xsrfCookieSettings -> makeRealCookie xsrfCookieSettings
64− Nothing -> return $ noXsrfTokenCookie cookieSettings
65− where
66− makeRealCookie xsrfCookieSettings = do
67− xsrfValue <- BS64.encode <$> getEntropy 32
68− return
69− $ applyXsrfCookieSettings xsrfCookieSettings
70− $ applyCookieSettings cookieSettings
71− $ def{ setCookieValue = xsrfValue }
72−
73−
74−-- | Alias for 'makeXsrfCookie'.
75−makeCsrfCookie :: CookieSettings -> IO SetCookie
76−makeCsrfCookie = makeXsrfCookie
77−{-# DEPRECATED makeCsrfCookie "Use makeXsrfCookie instead" #-}
78−
79−
80−-- | Makes a cookie with session information.
81−makeSessionCookie :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe SetCookie)
82−makeSessionCookie cookieSettings jwtSettings v = do
83− ejwt <- makeJWT v jwtSettings (cookieExpires cookieSettings)
84− case ejwt of
85− Left _ -> return Nothing
86− Right jwt -> return
87− $ Just
88− $ applySessionCookieSettings cookieSettings
89− $ applyCookieSettings cookieSettings
90− $ def{ setCookieValue = BSL.toStrict jwt }
91−
92−noXsrfTokenCookie :: CookieSettings -> SetCookie
93−noXsrfTokenCookie cookieSettings =
94− applyCookieSettings cookieSettings $ def{ setCookieName = "NO-XSRF-TOKEN", setCookieValue = "" }
95−
96−applyCookieSettings :: CookieSettings -> SetCookie -> SetCookie
97−applyCookieSettings cookieSettings setCookie = setCookie
98− { setCookieMaxAge = cookieMaxAge cookieSettings
99− , setCookieExpires = cookieExpires cookieSettings
100− , setCookiePath = cookiePath cookieSettings
101− , setCookieDomain = cookieDomain cookieSettings
102− , setCookieSecure = case cookieIsSecure cookieSettings of
103− Secure -> True
104− NotSecure -> False
105− }
106−
107−applyXsrfCookieSettings :: XsrfCookieSettings -> SetCookie -> SetCookie
108−applyXsrfCookieSettings xsrfCookieSettings setCookie = setCookie
109− { setCookieName = xsrfCookieName xsrfCookieSettings
110− , setCookiePath = xsrfCookiePath xsrfCookieSettings
111− , setCookieHttpOnly = False
112− }
113−
114−applySessionCookieSettings :: CookieSettings -> SetCookie -> SetCookie
115−applySessionCookieSettings cookieSettings setCookie = setCookie
116− { setCookieName = sessionCookieName cookieSettings
117− , setCookieSameSite = case cookieSameSite cookieSettings of
118− AnySite -> anySite
119− SameSiteStrict -> Just sameSiteStrict
120− SameSiteLax -> Just sameSiteLax
121− , setCookieHttpOnly = True
122− }
123− where
124−#if MIN_VERSION_cookie(0,4,5)
125− anySite = Just sameSiteNone
126−#else
127− anySite = Nothing
128−#endif
129−
130−-- | For a JWT-serializable session, returns a function that decorates a
131−-- provided response object with XSRF and session cookies. This should be used
132−-- when a user successfully authenticates with credentials.
133−acceptLogin :: ( ToJWT session
134− , AddHeader "Set-Cookie" SetCookie response withOneCookie
135− , AddHeader "Set-Cookie" SetCookie withOneCookie withTwoCookies )
136− => CookieSettings
137− -> JWTSettings
138− -> session
139− -> IO (Maybe (response -> withTwoCookies))
140−acceptLogin cookieSettings jwtSettings session = do
141− mSessionCookie <- makeSessionCookie cookieSettings jwtSettings session
142− case mSessionCookie of
143− Nothing -> pure Nothing
144− Just sessionCookie -> do
145− xsrfCookie <- makeXsrfCookie cookieSettings
146− return $ Just $ addHeader sessionCookie . addHeader xsrfCookie
147−
148−-- | Arbitrary cookie expiry time set back in history after unix time 0
149−expireTime :: UTCTime
150−expireTime = UTCTime (ModifiedJulianDay 50000) 0
151−
152−-- | Adds headers to a response that clears all session cookies
153−-- | using max-age and expires cookie attributes.
154−clearSession :: ( AddHeader "Set-Cookie" SetCookie response withOneCookie
155− , AddHeader "Set-Cookie" SetCookie withOneCookie withTwoCookies )
156− => CookieSettings
157− -> response
158− -> withTwoCookies
159−clearSession cookieSettings = addHeader clearedSessionCookie . addHeader clearedXsrfCookie
160− where
161− -- According to RFC6265 max-age takes precedence, but IE/Edge ignore it completely so we set both
162− cookieSettingsExpires = cookieSettings
163− { cookieExpires = Just expireTime
164− , cookieMaxAge = Just (secondsToDiffTime 0)
165− }
166− clearedSessionCookie = applySessionCookieSettings cookieSettingsExpires $ applyCookieSettings cookieSettingsExpires def
167− clearedXsrfCookie = case cookieXsrfSetting cookieSettings of
168− Just xsrfCookieSettings -> applyXsrfCookieSettings xsrfCookieSettings $ applyCookieSettings cookieSettingsExpires def
169− Nothing -> noXsrfTokenCookie cookieSettingsExpires
170−
171−makeSessionCookieBS :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe BS.ByteString)
172−makeSessionCookieBS a b c = fmap (toByteString . renderSetCookie) <$> makeSessionCookie a b c
173−
174−-- | Alias for 'makeSessionCookie'.
175−makeCookie :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe SetCookie)
176−makeCookie = makeSessionCookie
177−{-# DEPRECATED makeCookie "Use makeSessionCookie instead" #-}
178−
179−-- | Alias for 'makeSessionCookieBS'.
180−makeCookieBS :: ToJWT v => CookieSettings -> JWTSettings -> v -> IO (Maybe BS.ByteString)
181−makeCookieBS = makeSessionCookieBS
182−{-# DEPRECATED makeCookieBS "Use makeSessionCookieBS instead" #-}
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/FormLogin.hsdeleted−3
@@ -1,3 +0,0 @@
1−module Servant.Auth.Server.Internal.FormLogin where
2−
3−
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/JWT.hsdeleted−72
@@ -1,72 +0,0 @@
1−module Servant.Auth.Server.Internal.JWT where
2−
3−import Control.Lens
4−import Control.Monad.Except
5−import Control.Monad.Reader
6−import qualified Crypto.JOSE as Jose
7−import qualified Crypto.JWT as Jose
8−import Data.Aeson (FromJSON, Result (..), ToJSON, fromJSON,
9− toJSON)
10−import Data.ByteArray (constEq)
11−import qualified Data.ByteString as BS
12−import qualified Data.ByteString.Lazy as BSL
13−import qualified Data.HashMap.Strict as HM
14−import Data.Maybe (fromMaybe)
15−import qualified Data.Text as T
16−import Data.Time (UTCTime)
17−import Network.Wai (requestHeaders)
18−
19−import Servant.Auth.JWT (FromJWT(..), ToJWT(..))
20−import Servant.Auth.Server.Internal.ConfigTypes
21−import Servant.Auth.Server.Internal.Types
22−
23−
24−-- | A JWT @AuthCheck@. You likely won't need to use this directly unless you
25−-- are protecting a @Raw@ endpoint.
26−jwtAuthCheck :: FromJWT usr => JWTSettings -> AuthCheck usr
27−jwtAuthCheck jwtSettings = do
28− req <- ask
29− token <- maybe mempty return $ do
30− authHdr <- lookup "Authorization" $ requestHeaders req
31− let bearer = "Bearer "
32− (mbearer, rest) = BS.splitAt (BS.length bearer) authHdr
33− guard (mbearer `constEq` bearer)
34− return rest
35− verifiedJWT <- liftIO $ verifyJWT jwtSettings token
36− case verifiedJWT of
37− Nothing -> mzero
38− Just v -> return v
39−
40−-- | Creates a JWT containing the specified data. The data is stored in the
41−-- @dat@ claim. The 'Maybe UTCTime' argument indicates the time at which the
42−-- token expires.
43−makeJWT :: ToJWT a
44− => a -> JWTSettings -> Maybe UTCTime -> IO (Either Jose.Error BSL.ByteString)
45−makeJWT v cfg expiry = runExceptT $ do
46− bestAlg <- Jose.bestJWSAlg $ signingKey cfg
47− let alg = fromMaybe bestAlg $ jwtAlg cfg
48− ejwt <- Jose.signClaims (signingKey cfg)
49− (Jose.newJWSHeader ((), alg))
50− (addExp $ encodeJWT v)
51−
52− return $ Jose.encodeCompact ejwt
53− where
54− addExp claims = case expiry of
55− Nothing -> claims
56− Just e -> claims & Jose.claimExp ?~ Jose.NumericDate e
57−
58−
59−verifyJWT :: FromJWT a => JWTSettings -> BS.ByteString -> IO (Maybe a)
60−verifyJWT jwtCfg input = do
61− keys <- validationKeys jwtCfg
62− verifiedJWT <- runExceptT $ do
63− unverifiedJWT <- Jose.decodeCompact (BSL.fromStrict input)
64− Jose.verifyClaims
65− (jwtSettingsToJwtValidationSettings jwtCfg)
66− keys
67− unverifiedJWT
68− return $ case verifiedJWT of
69− Left (_ :: Jose.JWTError) -> Nothing
70− Right v -> case decodeJWT v of
71− Left _ -> Nothing
72− Right v' -> Just v'
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ThrowAll.hsdeleted−58
@@ -1,58 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE UndecidableInstances #-}
3−module Servant.Auth.Server.Internal.ThrowAll where
4−
5−#if !MIN_VERSION_servant_server(0,16,0)
6−#define ServerError ServantErr
7−#endif
8−
9−import Control.Monad.Error.Class
10−import Data.Tagged (Tagged (..))
11−import Servant ((:<|>) (..), ServerError(..), NamedRoutes(..))
12−import Servant.API.Generic
13−import Servant.Server.Generic
14−import Servant.Server
15−import Network.HTTP.Types
16−import Network.Wai
17−
18−import qualified Data.ByteString.Char8 as BS
19−
20−class ThrowAll a where
21− -- | 'throwAll' is a convenience function to throw errors across an entire
22− -- sub-API
23− --
24− --
25− -- > throwAll err400 :: Handler a :<|> Handler b :<|> Handler c
26− -- > == throwError err400 :<|> throwError err400 :<|> err400
27− throwAll :: ServerError -> a
28−
29−instance (ThrowAll a, ThrowAll b) => ThrowAll (a :<|> b) where
30− throwAll e = throwAll e :<|> throwAll e
31−
32−instance
33− ( ThrowAll (ToServant api (AsServerT m)) , GenericServant api (AsServerT m)) =>
34− ThrowAll (api (AsServerT m)) where
35−
36− throwAll = fromServant . throwAll
37−
38−-- Really this shouldn't be necessary - ((->) a) should be an instance of
39−-- MonadError, no?
40−instance {-# OVERLAPPING #-} ThrowAll b => ThrowAll (a -> b) where
41− throwAll e = const $ throwAll e
42−
43−instance {-# OVERLAPPABLE #-} (MonadError ServerError m) => ThrowAll (m a) where
44− throwAll = throwError
45−
46−-- | for @servant <0.11@
47−instance {-# OVERLAPPING #-} ThrowAll Application where
48− throwAll e _req respond
49− = respond $ responseLBS (mkStatus (errHTTPCode e) (BS.pack $ errReasonPhrase e))
50− (errHeaders e)
51− (errBody e)
52−
53−-- | for @servant >=0.11@
54−instance {-# OVERLAPPING #-} MonadError ServerError m => ThrowAll (Tagged m Application) where
55− throwAll e = Tagged $ \_req respond ->
56− respond $ responseLBS (mkStatus (errHTTPCode e) (BS.pack $ errReasonPhrase e))
57− (errHeaders e)
58− (errBody e)
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Types.hsdeleted−112
@@ -1,112 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Servant.Auth.Server.Internal.Types where
3−
4−import Control.Applicative
5−import Control.Monad.Reader
6−import Control.Monad.Time
7−import Data.Monoid (Monoid (..))
8−import Data.Semigroup (Semigroup (..))
9−import Data.Time (getCurrentTime)
10−import GHC.Generics (Generic)
11−import Network.Wai (Request)
12−
13−import qualified Control.Monad.Fail as Fail
14−
15−-- | The result of an authentication attempt.
16−data AuthResult val
17− = BadPassword
18− | NoSuchUser
19− -- | Authentication succeeded.
20− | Authenticated val
21− -- | If an authentication procedure cannot be carried out - if for example it
22− -- expects a password and username in a header that is not present -
23− -- @Indefinite@ is returned. This indicates that other authentication
24− -- methods should be tried.
25− | Indefinite
26− deriving (Eq, Show, Read, Generic, Ord, Functor, Traversable, Foldable)
27−
28−instance Semigroup (AuthResult val) where
29− Indefinite <> y = y
30− x <> _ = x
31−
32−instance Monoid (AuthResult val) where
33− mempty = Indefinite
34− mappend = (<>)
35−
36−instance Applicative AuthResult where
37− pure = return
38− (<*>) = ap
39−
40−instance Monad AuthResult where
41− return = Authenticated
42− Authenticated v >>= f = f v
43− BadPassword >>= _ = BadPassword
44− NoSuchUser >>= _ = NoSuchUser
45− Indefinite >>= _ = Indefinite
46−
47−instance Alternative AuthResult where
48− empty = mzero
49− (<|>) = mplus
50−
51−instance MonadPlus AuthResult where
52− mzero = mempty
53− mplus = (<>)
54−
55−
56−-- | An @AuthCheck@ is the function used to decide the authentication status
57−-- (the 'AuthResult') of a request. Different @AuthCheck@s may be combined as a
58−-- Monoid or Alternative; the semantics of this is that the *first*
59−-- non-'Indefinite' result from left to right is used and the rest are ignored.
60−newtype AuthCheck val = AuthCheck
61− { runAuthCheck :: Request -> IO (AuthResult val) }
62− deriving (Generic, Functor)
63−
64−instance Semigroup (AuthCheck val) where
65− AuthCheck f <> AuthCheck g = AuthCheck $ \x -> do
66− fx <- f x
67− case fx of
68− Indefinite -> g x
69− r -> pure r
70−
71−instance Monoid (AuthCheck val) where
72− mempty = AuthCheck $ const $ return mempty
73− mappend = (<>)
74−
75−instance Applicative AuthCheck where
76− pure = return
77− (<*>) = ap
78−
79−instance Monad AuthCheck where
80− return = AuthCheck . return . return . return
81− AuthCheck ac >>= f = AuthCheck $ \req -> do
82− aresult <- ac req
83− case aresult of
84− Authenticated usr -> runAuthCheck (f usr) req
85− BadPassword -> return BadPassword
86− NoSuchUser -> return NoSuchUser
87− Indefinite -> return Indefinite
88−
89−#if !MIN_VERSION_base(4,13,0)
90− fail = Fail.fail
91−#endif
92−
93−instance Fail.MonadFail AuthCheck where
94− fail _ = AuthCheck . const $ return Indefinite
95−
96−instance MonadReader Request AuthCheck where
97− ask = AuthCheck $ \x -> return (Authenticated x)
98− local f (AuthCheck check) = AuthCheck $ \req -> check (f req)
99−
100−instance MonadIO AuthCheck where
101− liftIO action = AuthCheck $ const $ Authenticated <$> action
102−
103−instance MonadTime AuthCheck where
104− currentTime = liftIO getCurrentTime
105−
106−instance Alternative AuthCheck where
107− empty = mzero
108− (<|>) = mplus
109−
110−instance MonadPlus AuthCheck where
111− mzero = mempty
112− mplus = (<>)
servant-auth/servant-auth-server/src/Servant/Auth/Server/SetCookieOrphan.hsdeleted−3
@@ -1,3 +0,0 @@
1−module Servant.Auth.Server.SetCookieOrphan
2− {-# DEPRECATED "instance exists in http-api-data-0.3.9. This module will be removed in next major release." #-}
3− () where
servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hsdeleted−607
@@ -1,607 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Servant.Auth.ServerSpec (spec) where
3−
4−#if !MIN_VERSION_servant_server(0,16,0)
5−#define ServerError ServantErr
6−#endif
7−
8−import Control.Lens
9−import Control.Monad.Except (runExceptT)
10−import Control.Monad.IO.Class (liftIO)
11−import Crypto.JOSE (Alg (HS256, None), Error,
12− JWK, JWSHeader,
13− KeyMaterialGenParam (OctGenParam),
14− ToCompact, encodeCompact,
15− genJWK, newJWSHeader)
16−import Crypto.JWT (Audience (..), ClaimsSet,
17− NumericDate (NumericDate),
18− SignedJWT,
19− claimAud, claimNbf,
20− signClaims,
21− emptyClaimsSet,
22− unregisteredClaims)
23−import Data.Aeson (FromJSON, ToJSON, Value,
24− toJSON, encode)
25−import Data.Aeson.Lens (_JSON)
26−import qualified Data.ByteString as BS
27−import qualified Data.ByteString.Lazy as BSL
28−import Data.CaseInsensitive (mk)
29−import Data.Foldable (find)
30−import Data.Monoid
31−import Data.Time
32−import Data.Time.Clock (getCurrentTime)
33−import GHC.Generics (Generic)
34−import Network.HTTP.Client (cookie_http_only,
35− cookie_name, cookie_value,
36− cookie_expiry_time,
37− destroyCookieJar)
38−import Network.HTTP.Types (Status, status200,
39− status401)
40−import Network.Wai (responseLBS)
41−import Network.Wai.Handler.Warp (testWithApplication)
42−import Network.Wreq (Options, auth, basicAuth,
43− cookieExpiryTime, cookies,
44− defaults, get, getWith, postWith,
45− header, oauth2Bearer,
46− responseBody,
47− responseCookieJar,
48− responseHeader,
49− responseStatus)
50−import Network.Wreq.Types (Postable(..))
51−import Servant hiding (BasicAuth,
52− IsSecure (..), header)
53−import Servant.API.Generic ((:-))
54−import Servant.Auth.Server
55−import Servant.Auth.Server.Internal.Cookie (expireTime)
56−import Servant.Auth.Server.SetCookieOrphan ()
57−#if MIN_VERSION_servant_server(0,15,0)
58−import qualified Servant.Types.SourceT as S
59−#endif
60−import System.IO.Unsafe (unsafePerformIO)
61−import Test.Hspec
62−import Test.QuickCheck
63−import qualified Network.HTTP.Client as HCli
64−
65−
66−
67−spec :: Spec
68−spec = do
69− authSpec
70− cookieAuthSpec
71− jwtAuthSpec
72− throwAllSpec
73− basicAuthSpec
74−
75−------------------------------------------------------------------------------
76−-- * Auth {{{
77−
78−authSpec :: Spec
79−authSpec
80− = describe "The Auth combinator"
81− $ around (testWithApplication . return $ app jwtAndCookieApi) $ do
82−
83− it "returns a 401 if all authentications are Indefinite" $ \port -> do
84− get (url port) `shouldHTTPErrorWith` status401
85−
86− it "succeeds if one authentication suceeds" $ \port -> property $
87− \(user :: User) -> do
88− jwt <- makeJWT user jwtCfg Nothing
89− opts <- addJwtToHeader jwt
90− resp <- getWith opts (url port)
91− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
92−
93− it "fails (403) if one authentication fails" $ const $
94− pendingWith "Authentications don't yet fail, only are Indefinite"
95−
96− it "doesn't clobber pre-existing response headers" $ \port -> property $
97− \(user :: User) -> do
98− jwt <- makeJWT user jwtCfg Nothing
99− opts <- addJwtToHeader jwt
100− resp <- getWith opts (url port ++ "/header")
101− resp ^. responseHeader "Blah" `shouldBe` "1797"
102− resp ^. responseHeader "Set-Cookie" `shouldSatisfy` (/= "")
103−
104− context "Raw" $ do
105−
106− it "gets the response body" $ \port -> property $ \(user :: User) -> do
107− jwt <- makeJWT user jwtCfg Nothing
108− opts <- addJwtToHeader jwt
109− resp <- getWith opts (url port ++ "/raw")
110− resp ^. responseBody `shouldBe` "how are you?"
111−
112− it "doesn't clobber pre-existing reponse headers" $ \port -> property $
113− \(user :: User) -> do
114− jwt <- makeJWT user jwtCfg Nothing
115− opts <- addJwtToHeader jwt
116− resp <- getWith opts (url port ++ "/raw")
117− resp ^. responseHeader "hi" `shouldBe` "there"
118− resp ^. responseHeader "Set-Cookie" `shouldSatisfy` (/= "")
119−
120−
121− context "Setting cookies" $ do
122−
123− it "sets cookies that it itself accepts" $ \port -> property $ \user -> do
124− jwt <- createJWT theKey (newJWSHeader ((), HS256))
125− (claims $ toJSON user)
126− opts' <- addJwtToCookie cookieCfg jwt
127− let opts = addCookie (opts' & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ ["blah"])
128− (xsrfField xsrfCookieName cookieCfg <> "=blah")
129− resp <- getWith opts (url port)
130− let (cookieJar:_) = resp ^.. responseCookieJar
131− Just xxsrf = find (\x -> cookie_name x == xsrfField xsrfCookieName cookieCfg)
132− $ destroyCookieJar cookieJar
133− opts2 = defaults
134− & cookies .~ Just cookieJar
135− & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ [cookie_value xxsrf]
136− resp2 <- getWith opts2 (url port)
137− resp2 ^? responseBody . _JSON `shouldBe` Just (length $ name user)
138−
139− it "uses the Expiry from the configuration" $ \port -> property $ \(user :: User) -> do
140− jwt <- createJWT theKey (newJWSHeader ((), HS256))
141− (claims $ toJSON user)
142− opts' <- addJwtToCookie cookieCfg jwt
143− let opts = addCookie (opts' & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ ["blah"])
144− (xsrfField xsrfCookieName cookieCfg <> "=blah")
145− resp <- getWith opts (url port)
146− let (cookieJar:_) = resp ^.. responseCookieJar
147− Just xxsrf = find (\x -> cookie_name x == xsrfField xsrfCookieName cookieCfg)
148− $ destroyCookieJar cookieJar
149− xxsrf ^. cookieExpiryTime `shouldBe` future
150−
151− it "sets the token cookie as HttpOnly" $ \port -> property $ \(user :: User) -> do
152− jwt <- createJWT theKey (newJWSHeader ((), HS256))
153− (claims $ toJSON user)
154− opts' <- addJwtToCookie cookieCfg jwt
155− let opts = addCookie (opts' & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ ["blah"])
156− (xsrfField xsrfCookieName cookieCfg <> "=blah")
157− resp <- getWith opts (url port)
158− let (cookieJar:_) = resp ^.. responseCookieJar
159− Just token = find (\x -> cookie_name x == sessionCookieName cookieCfg)
160− $ destroyCookieJar cookieJar
161− cookie_http_only token `shouldBe` True
162−
163−
164−
165−-- }}}
166−------------------------------------------------------------------------------
167−-- * Cookie Auth {{{
168−
169−cookieAuthSpec :: Spec
170−cookieAuthSpec
171− = describe "The Auth combinator" $ do
172− describe "With XSRF check" $
173− around (testWithApplication . return $ app cookieOnlyApi) $ do
174−
175− it "fails if XSRF header and cookie don't match" $ \port -> property
176− $ \(user :: User) -> do
177− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
178− opts' <- addJwtToCookie cookieCfg jwt
179− let opts = addCookie (opts' & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ ["blah"])
180− (xsrfField xsrfCookieName cookieCfg <> "=blerg")
181− getWith opts (url port) `shouldHTTPErrorWith` status401
182−
183− it "fails with no XSRF header or cookie" $ \port -> property
184− $ \(user :: User) -> do
185− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
186− opts <- addJwtToCookie cookieCfg jwt
187− getWith opts (url port) `shouldHTTPErrorWith` status401
188−
189− it "succeeds if XSRF header and cookie match, and JWT is valid" $ \port -> property
190− $ \(user :: User) -> do
191− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
192− opts' <- addJwtToCookie cookieCfg jwt
193− let opts = addCookie (opts' & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ ["blah"])
194− (xsrfField xsrfCookieName cookieCfg <> "=blah")
195− resp <- getWith opts (url port)
196− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
197−
198− it "sets and clears the right cookies" $ \port -> property
199− $ \(user :: User) -> do
200− let optsFromResp resp =
201− let jar = resp ^. responseCookieJar
202− Just xsrfCookieValue = cookie_value <$> find (\c -> cookie_name c == xsrfField xsrfCookieName cookieCfg) (destroyCookieJar jar)
203− in defaults
204− & cookies .~ Just jar -- real cookie jars aren't updated by being replaced
205− & header (mk (xsrfField xsrfHeaderName cookieCfg)) .~ [xsrfCookieValue]
206−
207− resp <- postWith defaults (url port ++ "/login") user
208− (resp ^. responseCookieJar) `shouldMatchCookieNames`
209− [ sessionCookieName cookieCfg
210− , xsrfField xsrfCookieName cookieCfg
211− ]
212− let loggedInOpts = optsFromResp resp
213−
214− resp <- getWith loggedInOpts (url port)
215− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
216−
217− -- logout
218− resp <- getWith loggedInOpts (url port ++ "/logout")
219−
220− -- assert cookies were expired
221− now <- getCurrentTime
222− let assertCookie c = now >= cookie_expiry_time c
223− all assertCookie (destroyCookieJar (resp ^. responseCookieJar)) `shouldBe` True
224−
225− let loggedOutOpts = optsFromResp resp
226− getWith loggedOutOpts (url port) `shouldHTTPErrorWith` status401
227−
228− describe "With no XSRF check for GET requests" $ let
229− noXsrfGet xsrfCfg = xsrfCfg { xsrfExcludeGet = True }
230− cookieCfgNoXsrfGet = cookieCfg { cookieXsrfSetting = fmap noXsrfGet $ cookieXsrfSetting cookieCfg }
231− in around (testWithApplication . return $ appWithCookie cookieOnlyApi cookieCfgNoXsrfGet) $ do
232−
233− it "succeeds with no XSRF header or cookie for GET" $ \port -> property
234− $ \(user :: User) -> do
235− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
236− opts <- addJwtToCookie cookieCfgNoXsrfGet jwt
237− resp <- getWith opts (url port)
238− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
239−
240− it "fails with no XSRF header or cookie for POST" $ \port -> property
241− $ \(user :: User) number -> do
242− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
243− opts <- addJwtToCookie cookieCfgNoXsrfGet jwt
244− postWith opts (url port) (toJSON (number :: Int)) `shouldHTTPErrorWith` status401
245−
246− describe "With no XSRF check at all" $ let
247− cookieCfgNoXsrf = cookieCfg { cookieXsrfSetting = Nothing }
248− in around (testWithApplication . return $ appWithCookie cookieOnlyApi cookieCfgNoXsrf) $ do
249−
250− it "succeeds with no XSRF header or cookie for GET" $ \port -> property
251− $ \(user :: User) -> do
252− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
253− opts <- addJwtToCookie cookieCfgNoXsrf jwt
254− resp <- getWith opts (url port)
255− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
256−
257− it "succeeds with no XSRF header or cookie for POST" $ \port -> property
258− $ \(user :: User) number -> do
259− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)
260− opts <- addJwtToCookie cookieCfgNoXsrf jwt
261− resp <- postWith opts (url port) $ toJSON (number :: Int)
262− resp ^? responseBody . _JSON `shouldBe` Just number
263−
264− it "sets and clears the right cookies" $ \port -> property
265− $ \(user :: User) -> do
266− let optsFromResp resp = defaults
267− & cookies .~ Just (resp ^. responseCookieJar) -- real cookie jars aren't updated by being replaced
268−
269− resp <- postWith defaults (url port ++ "/login") user
270− (resp ^. responseCookieJar) `shouldMatchCookieNames`
271− [ sessionCookieName cookieCfg
272− , "NO-XSRF-TOKEN"
273− ]
274− let loggedInOpts = optsFromResp resp
275−
276− resp <- getWith (loggedInOpts) (url port)
277− resp ^? responseBody . _JSON `shouldBe` Just (length $ name user)
278−
279− resp <- getWith loggedInOpts (url port ++ "/logout")
280− (resp ^. responseCookieJar) `shouldMatchCookieNameValues`
281− [ (sessionCookieName cookieCfg, "value")
282− , ("NO-XSRF-TOKEN", "")
283− ]
284−
285− -- assert cookies were expired
286− now <- getCurrentTime
287− let assertCookie c = now >= cookie_expiry_time c
288− all assertCookie (destroyCookieJar (resp ^. responseCookieJar)) `shouldBe` True
289−
290− let loggedOutOpts = optsFromResp resp
291−
292− getWith loggedOutOpts (url port) `shouldHTTPErrorWith` status401
293−
294−-- }}}
295−------------------------------------------------------------------------------
296−-- * JWT Auth {{{
297−
298−jwtAuthSpec :: Spec
299−jwtAuthSpec
300− = describe "The JWT combinator"
301− $ around (testWithApplication . return $ app jwtOnlyApi) $ do
302−
303− it "fails if 'aud' does not match predicate" $ \port -> property $
304− \(user :: User) -> do
305− jwt <- createJWT theKey (newJWSHeader ((), HS256))
306− (claims (toJSON user) & claimAud .~ Just (Audience ["boo"]))
307− opts <- addJwtToHeader (jwt >>= (return . encodeCompact))
308− getWith opts (url port) `shouldHTTPErrorWith` status401
309−
310− it "succeeds if 'aud' does match predicate" $ \port -> property $
311− \(user :: User) -> do
312− jwt <- createJWT theKey (newJWSHeader ((), HS256))
313− (claims (toJSON user) & claimAud .~ Just (Audience ["anythingElse"]))
314− opts <- addJwtToHeader (jwt >>= (return . encodeCompact))
315− resp <- getWith opts (url port)
316− resp ^. responseStatus `shouldBe` status200
317−
318− it "fails if 'nbf' is set to a future date" $ \port -> property $
319− \(user :: User) -> do
320− jwt <- createJWT theKey (newJWSHeader ((), HS256))
321− (claims (toJSON user) & claimNbf .~ Just (NumericDate future))
322− opts <- addJwtToHeader (jwt >>= (return . encodeCompact))
323− getWith opts (url port) `shouldHTTPErrorWith` status401
324−
325− it "fails if 'exp' is set to a past date" $ \port -> property $
326− \(user :: User) -> do
327− jwt <- makeJWT user jwtCfg (Just past)
328− opts <- addJwtToHeader jwt
329− getWith opts (url port) `shouldHTTPErrorWith` status401
330−
331− it "succeeds if 'exp' is set to a future date" $ \port -> property $
332− \(user :: User) -> do
333− jwt <- makeJWT user jwtCfg (Just future)
334− opts <- addJwtToHeader jwt
335− resp <- getWith opts (url port)
336− resp ^. responseStatus `shouldBe` status200
337−
338− it "fails if JWT is not signed" $ \port -> property $ \(user :: User) -> do
339− jwt <- createJWT theKey (newJWSHeader ((), None))
340− (claims $ toJSON user)
341− opts <- addJwtToHeader (jwt >>= (return . encodeCompact))
342− getWith opts (url port) `shouldHTTPErrorWith` status401
343−
344− it "fails if JWT does not use expected algorithm" $ const $
345− pendingWith "Need https://github.com/frasertweedale/hs-jose/issues/19"
346−
347− it "fails if data is not valid JSON" $ \port -> do
348− jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims "{{")
349− opts <- addJwtToHeader (jwt >>= (return .encodeCompact))
350− getWith opts (url port) `shouldHTTPErrorWith` status401
351−
352− it "suceeds as wreq's oauth2Bearer" $ \port -> property $ \(user :: User) -> do
353− jwt <- createJWT theKey (newJWSHeader ((), HS256))
354− (claims $ toJSON user)
355− resp <- case jwt >>= (return . encodeCompact) of
356− Left (e :: Error) -> fail $ show e
357− Right v -> getWith (defaults & auth ?~ oauth2Bearer (BSL.toStrict v)) (url port)
358− resp ^. responseStatus `shouldBe` status200
359−
360−-- }}}
361−------------------------------------------------------------------------------
362−-- * Basic Auth {{{
363−
364−basicAuthSpec :: Spec
365−basicAuthSpec = describe "The BasicAuth combinator"
366− $ around (testWithApplication . return $ app basicAuthApi) $ do
367−
368− it "succeeds with the correct password and username" $ \port -> do
369− resp <- getWith (defaults & auth ?~ basicAuth "ali" "Open sesame") (url port)
370− resp ^. responseStatus `shouldBe` status200
371−
372− it "fails with non-existent user" $ \port -> do
373− getWith (defaults & auth ?~ basicAuth "thief" "Open sesame") (url port)
374− `shouldHTTPErrorWith` status401
375−
376− it "fails with incorrect password" $ \port -> do
377− getWith (defaults & auth ?~ basicAuth "ali" "phatic") (url port)
378− `shouldHTTPErrorWith` status401
379−
380− it "fails with no auth header" $ \port -> do
381− get (url port) `shouldHTTPErrorWith` status401
382−
383−-- }}}
384−------------------------------------------------------------------------------
385−-- * ThrowAll {{{
386−
387−throwAllSpec :: Spec
388−throwAllSpec = describe "throwAll" $ do
389−
390− it "works for plain values" $ do
391− let t :: Either ServerError Int :<|> Either ServerError Bool :<|> Either ServerError String
392− t = throwAll err401
393− t `shouldBe` throwError err401 :<|> throwError err401 :<|> throwError err401
394−
395− it "works for function types" $ property $ \i -> do
396− let t :: Int -> (Either ServerError Bool :<|> Either ServerError String)
397− t = throwAll err401
398− expected _ = throwError err401 :<|> throwError err401
399− t i `shouldBe` expected i
400−
401−-- }}}
402−------------------------------------------------------------------------------
403−-- * API and Server {{{
404−
405−type API auths
406− = Auth auths User :>
407− ( Get '[JSON] Int
408− :<|> ReqBody '[JSON] Int :> Post '[JSON] Int
409− :<|> NamedRoutes DummyRoutes
410− :<|> "header" :> Get '[JSON] (Headers '[Header "Blah" Int] Int)
411−#if MIN_VERSION_servant_server(0,15,0)
412− :<|> "stream" :> StreamGet NoFraming OctetStream (SourceIO BS.ByteString)
413−#endif
414− :<|> "raw" :> Raw
415− )
416− :<|> "login" :> ReqBody '[JSON] User :> Post '[JSON] (Headers '[ Header "Set-Cookie" SetCookie
417− , Header "Set-Cookie" SetCookie ] NoContent)
418− :<|> "logout" :> Get '[JSON] (Headers '[ Header "Set-Cookie" SetCookie
419− , Header "Set-Cookie" SetCookie ] NoContent)
420−
421−data DummyRoutes mode = DummyRoutes
422− { dummyInt :: mode :- "dummy" :> Get '[JSON] Int
423− } deriving Generic
424−
425−jwtOnlyApi :: Proxy (API '[Servant.Auth.Server.JWT])
426−jwtOnlyApi = Proxy
427−
428−cookieOnlyApi :: Proxy (API '[Cookie])
429−cookieOnlyApi = Proxy
430−
431−basicAuthApi :: Proxy (API '[BasicAuth])
432−basicAuthApi = Proxy
433−
434−jwtAndCookieApi :: Proxy (API '[Servant.Auth.Server.JWT, Cookie])
435−jwtAndCookieApi = Proxy
436−
437−theKey :: JWK
438−theKey = unsafePerformIO . genJWK $ OctGenParam 256
439−{-# NOINLINE theKey #-}
440−
441−
442−cookieCfg :: CookieSettings
443−cookieCfg = def
444− { cookieExpires = Just future
445− , cookieIsSecure = NotSecure
446− , sessionCookieName = "RuncibleSpoon"
447− , cookieXsrfSetting = pure $ def
448− { xsrfCookieName = "TheyDinedOnMince"
449− , xsrfHeaderName = "AndSlicesOfQuince"
450− }
451− }
452−xsrfField :: (XsrfCookieSettings -> a) -> CookieSettings -> a
453−xsrfField f = maybe (error "expected XsrfCookieSettings for test") f . cookieXsrfSetting
454−
455−jwtCfg :: JWTSettings
456−jwtCfg = (defaultJWTSettings theKey) { audienceMatches = \x ->
457− if x == "boo" then DoesNotMatch else Matches }
458−
459−instance FromBasicAuthData User where
460− fromBasicAuthData (BasicAuthData usr pwd) _
461− = return $ if usr == "ali" && pwd == "Open sesame"
462− then Authenticated $ User "ali" "ali@the-thieves-den.com"
463− else Indefinite
464−
465−-- Could be anything, really, but since this is already in the cfg we don't
466−-- have to add it
467−type instance BasicAuthCfg = JWK
468−
469−appWithCookie :: AreAuths auths '[CookieSettings, JWTSettings, JWK] User
470− => Proxy (API auths) -> CookieSettings -> Application
471−appWithCookie api ccfg = serveWithContext api ctx $ server ccfg
472− where
473− ctx = ccfg :. jwtCfg :. theKey :. EmptyContext
474−
475−-- | Takes a proxy parameter indicating which authentication systems to enable.
476−app :: AreAuths auths '[CookieSettings, JWTSettings, JWK] User
477− => Proxy (API auths) -> Application
478−app api = appWithCookie api cookieCfg
479−
480−server :: CookieSettings -> Server (API auths)
481−server ccfg =
482− (\authResult -> case authResult of
483− Authenticated usr -> getInt usr
484− :<|> postInt usr
485− :<|> DummyRoutes { dummyInt = getInt usr }
486− :<|> getHeaderInt
487−#if MIN_VERSION_servant_server(0,15,0)
488− :<|> return (S.source ["bytestring"])
489−#endif
490− :<|> raw
491− Indefinite -> throwAll err401
492− _ -> throwAll err403
493− )
494− :<|> getLogin
495− :<|> getLogout
496− where
497− getInt :: User -> Handler Int
498− getInt usr = return . length $ name usr
499−
500− postInt :: User -> Int -> Handler Int
501− postInt _ = return
502−
503− getHeaderInt :: Handler (Headers '[Header "Blah" Int] Int)
504− getHeaderInt = return $ addHeader 1797 17
505−
506− getLogin :: User -> Handler (Headers '[ Header "Set-Cookie" SetCookie
507− , Header "Set-Cookie" SetCookie ] NoContent)
508− getLogin user = do
509− maybeApplyCookies <- liftIO $ acceptLogin ccfg jwtCfg user
510− case maybeApplyCookies of
511− Just applyCookies -> return $ applyCookies NoContent
512− Nothing -> error "cookies failed to apply"
513−
514− getLogout :: Handler (Headers '[ Header "Set-Cookie" SetCookie
515− , Header "Set-Cookie" SetCookie ] NoContent)
516− getLogout = return $ clearSession ccfg NoContent
517−
518− raw :: Server Raw
519− raw =
520−#if MIN_VERSION_servant_server(0,11,0)
521− Tagged $
522−#endif
523− \_req respond ->
524− respond $ responseLBS status200 [("hi", "there")] "how are you?"
525−
526−-- }}}
527−------------------------------------------------------------------------------
528−-- * Utils {{{
529−
530−past :: UTCTime
531−past = parseTimeOrError True defaultTimeLocale "%Y-%m-%d" "1970-01-01"
532−
533−future :: UTCTime
534−future = parseTimeOrError True defaultTimeLocale "%Y-%m-%d" "2070-01-01"
535−
536−addJwtToHeader :: Either Error BSL.ByteString -> IO Options
537−addJwtToHeader jwt = case jwt of
538− Left e -> fail $ show e
539− Right v -> return
540− $ defaults & header "Authorization" .~ ["Bearer " <> BSL.toStrict v]
541−
542−createJWT :: JWK -> JWSHeader () -> ClaimsSet -> IO (Either Error Crypto.JWT.SignedJWT)
543−createJWT k a b = runExceptT $ signClaims k a b
544−
545−addJwtToCookie :: ToCompact a => CookieSettings -> Either Error a -> IO Options
546−addJwtToCookie ccfg jwt = case jwt >>= (return . encodeCompact) of
547− Left e -> fail $ show e
548− Right v -> return
549− $ defaults & header "Cookie" .~ [sessionCookieName ccfg <> "=" <> BSL.toStrict v]
550−
551−addCookie :: Options -> BS.ByteString -> Options
552−addCookie opts cookie' = opts & header "Cookie" %~ \c -> case c of
553− [h] -> [cookie' <> "; " <> h]
554− [] -> [cookie']
555− _ -> error "expecting single cookie header"
556−
557−
558−shouldHTTPErrorWith :: IO a -> Status -> Expectation
559−shouldHTTPErrorWith act stat = act `shouldThrow` \e -> case e of
560−#if MIN_VERSION_http_client(0,5,0)
561− HCli.HttpExceptionRequest _ (HCli.StatusCodeException resp _)
562− -> HCli.responseStatus resp == stat
563−#else
564− HCli.StatusCodeException x _ _ -> x == stat
565−#endif
566− _ -> False
567−
568−shouldMatchCookieNames :: HCli.CookieJar -> [BS.ByteString] -> Expectation
569−shouldMatchCookieNames cj patterns
570− = fmap cookie_name (destroyCookieJar cj)
571− `shouldMatchList` patterns
572−
573−shouldMatchCookieNameValues :: HCli.CookieJar -> [(BS.ByteString, BS.ByteString)] -> Expectation
574−shouldMatchCookieNameValues cj patterns
575− = fmap ((,) <$> cookie_name <*> cookie_value) (destroyCookieJar cj)
576− `shouldMatchList` patterns
577−
578−url :: Int -> String
579−url port = "http://localhost:" <> show port
580−
581−claims :: Value -> ClaimsSet
582−claims val = emptyClaimsSet & unregisteredClaims . at "dat" .~ Just val
583−-- }}}
584−------------------------------------------------------------------------------
585−-- * Types {{{
586−
587−data User = User
588− { name :: String
589− , _id :: String
590− } deriving (Eq, Show, Read, Generic)
591−
592−instance FromJWT User
593−instance ToJWT User
594−instance FromJSON User
595−instance ToJSON User
596−
597−instance Arbitrary User where
598− arbitrary = User <$> arbitrary <*> arbitrary
599−
600−instance Postable User where
601− postPayload user request = return $ request
602− { HCli.requestBody = HCli.RequestBodyLBS $ encode user
603− , HCli.requestHeaders = (mk "Content-Type", "application/json") : HCli.requestHeaders request
604− }
605−
606−
607−-- }}}
servant-auth/servant-auth-server/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-auth/servant-auth-swagger/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -isrc -itest -idoctest/ghci-wrapper/src
servant-auth/servant-auth-swagger/CHANGELOG.mddeleted−24
@@ -1,24 +0,0 @@
1−# Changelog
2−
3−All notable changes to this project will be documented in this file.
4−
5−The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6−and this project adheres to [PVP Versioning](https://pvp.haskell.org/).
7−
8−## [Unreleased]
9−
10−## [0.2.10.1] - 2020-10-06
11−
12−### Changed
13−
14−- Support GHC 8.10 @domenkozar
15−- Fix build with swagger 2.5.x @domenkozar
16−
17−## [0.2.10.0] - 2018-06-18
18−
19−### Added
20−
21−- Support for GHC 8.4 by @phadej
22−- Changelog by @domenkozar
23−- #93: Add Cookie in SwaggerSpec API by @domenkozar
24−- #42: Add dummy AllHasSecurity Cookie instance by @sordina
servant-auth/servant-auth-swagger/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Julian K. Arni (c) 2015
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Julian K. Arni nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
servant-auth/servant-auth-swagger/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
servant-auth/servant-auth-swagger/servant-auth-swagger.cabaldeleted−70
@@ -1,70 +0,0 @@
1−cabal-version: 2.2
2−name: servant-auth-swagger
3−version: 0.2.10.1
4−synopsis: servant-swagger/servant-auth compatibility
5−description: This package provides instances that allow generating swagger2 schemas from
6− <https://hackage.haskell.org/package/servant servant>
7− APIs that use
8− <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
9− .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
11−category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
13−bug-reports: https://github.com/haskell-servant/servant/issues
14−author: Julian K. Arni
15−maintainer: jkarni@gmail.com
16−copyright: (c) Julian K. Arni
17−license: BSD-3-Clause
18−license-file: LICENSE
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.4
20−build-type: Simple
21−extra-source-files:
22− CHANGELOG.md
23−
24−source-repository head
25− type: git
26− location: https://github.com/haskell-servant/servant
27−
28−library
29− hs-source-dirs:
30− src
31− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
32− ghc-options: -Wall
33− build-depends:
34− base >= 4.10 && < 4.17
35− , text >= 1.2.3.0 && < 2.1
36− , servant-swagger >= 1.1.5 && < 2
37− , swagger2 >= 2.2.2 && < 3
38− , servant >= 0.13 && < 0.20
39− , servant-auth == 0.4.*
40− , lens >= 4.16.1 && < 5.2
41− exposed-modules:
42− Servant.Auth.Swagger
43− default-language: Haskell2010
44−
45−test-suite spec
46− type: exitcode-stdio-1.0
47− main-is: Spec.hs
48− hs-source-dirs:
49− test
50− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
51− ghc-options: -Wall
52− build-tool-depends: hspec-discover:hspec-discover >= 2.5.5 && <2.10
53− -- dependencies with bounds inherited from the library stanza
54− build-depends:
55− base
56− , text
57− , servant-swagger
58− , swagger2
59− , servant
60− , servant-auth
61− , lens
62−
63− -- test dependencies
64− build-depends:
65− servant-auth-swagger
66− , hspec >= 2.5.5 && < 2.10
67− , QuickCheck >= 2.11.3 && < 2.15
68− other-modules:
69− Servant.Auth.SwaggerSpec
70− default-language: Haskell2010
servant-auth/servant-auth-swagger/src/Servant/Auth/Swagger.hsdeleted−87
@@ -1,87 +0,0 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−{-# LANGUAGE CPP #-}
3−module Servant.Auth.Swagger
4− (
5− -- | The purpose of this package is provide the instance for 'servant-auth'
6− -- combinators needed for 'servant-swagger' documentation generation.
7− --
8− -- Currently only JWT and BasicAuth are supported.
9−
10− -- * Re-export
11− JWT
12− , BasicAuth
13− , Auth
14−
15− -- * Needed to define instances of @HasSwagger@
16− , HasSecurity (..)
17− ) where
18−
19−import Control.Lens ((&), (<>~))
20−import Data.Proxy (Proxy (Proxy))
21−import Data.Swagger (ApiKeyLocation (..), ApiKeyParams (..),
22− SecurityRequirement (..), SecurityScheme (..),
23−#if MIN_VERSION_swagger2(2,6,0)
24− SecurityDefinitions(..),
25−#endif
26− SecuritySchemeType (..), allOperations, security,
27− securityDefinitions)
28−import GHC.Exts (fromList)
29−import Servant.API hiding (BasicAuth)
30−import Servant.Auth
31−import Servant.Swagger
32−
33−import qualified Data.Text as T
34−
35−instance (AllHasSecurity xs, HasSwagger api) => HasSwagger (Auth xs r :> api) where
36− toSwagger _
37− = toSwagger (Proxy :: Proxy api)
38− & securityDefinitions <>~ mkSec (fromList secs)
39− & allOperations.security <>~ secReqs
40− where
41− secs = securities (Proxy :: Proxy xs)
42− secReqs = [ SecurityRequirement (fromList [(s,[])]) | (s,_) <- secs]
43− mkSec =
44−#if MIN_VERSION_swagger2(2,6,0)
45− SecurityDefinitions
46−#else
47− id
48−#endif
49−
50−
51−class HasSecurity x where
52− securityName :: Proxy x -> T.Text
53− securityScheme :: Proxy x -> SecurityScheme
54−
55−instance HasSecurity BasicAuth where
56− securityName _ = "BasicAuth"
57− securityScheme _ = SecurityScheme type_ (Just desc)
58− where
59− type_ = SecuritySchemeBasic
60− desc = "Basic access authentication"
61−
62−instance HasSecurity JWT where
63− securityName _ = "JwtSecurity"
64− securityScheme _ = SecurityScheme type_ (Just desc)
65− where
66− type_ = SecuritySchemeApiKey (ApiKeyParams "Authorization" ApiKeyHeader)
67− desc = "JSON Web Token-based API key"
68−
69−class AllHasSecurity (x :: [*]) where
70− securities :: Proxy x -> [(T.Text,SecurityScheme)]
71−
72−instance {-# OVERLAPPABLE #-} (HasSecurity x, AllHasSecurity xs) => AllHasSecurity (x ': xs) where
73− securities _ = (securityName px, securityScheme px) : securities pxs
74− where
75− px :: Proxy x
76− px = Proxy
77− pxs :: Proxy xs
78− pxs = Proxy
79−
80−instance {-# OVERLAPPING #-} AllHasSecurity xs => AllHasSecurity (Cookie ': xs) where
81− securities _ = securities pxs
82− where
83− pxs :: Proxy xs
84− pxs = Proxy
85−
86−instance AllHasSecurity '[] where
87− securities _ = []
servant-auth/servant-auth-swagger/test/Servant/Auth/SwaggerSpec.hsdeleted−38
@@ -1,38 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Servant.Auth.SwaggerSpec (spec) where
3−
4−import Control.Lens
5−import Data.Proxy
6−import Servant.API
7−import Servant.Auth
8−import Servant.Auth.Swagger
9−import Data.Swagger
10−import Servant.Swagger
11−import Test.Hspec
12−
13−spec :: Spec
14−spec = describe "HasSwagger instance" $ do
15−
16− let swag = toSwagger (Proxy :: Proxy API)
17−
18− it "adds security definitions at the top level" $ do
19−#if MIN_VERSION_swagger2(2,6,0)
20− let (SecurityDefinitions secDefs) = swag ^. securityDefinitions
21−#else
22− let secDefs = swag ^. securityDefinitions
23−#endif
24− length secDefs `shouldSatisfy` (> 0)
25−
26− it "adds security at sub-apis" $ do
27− swag ^. security `shouldBe` []
28− show (swag ^. paths . at "/secure") `shouldContain` "JwtSecurity"
29− show (swag ^. paths . at "/insecure") `shouldNotContain` "JwtSecurity"
30−
31−-- * API
32−
33−type API = "secure" :> Auth '[JWT, Cookie] Int :> SecureAPI
34− :<|> "insecure" :> InsecureAPI
35−
36−type SecureAPI = Get '[JSON] Int :<|> ReqBody '[JSON] Int :> Post '[JSON] Int
37−
38−type InsecureAPI = SecureAPI
servant-auth/servant-auth-swagger/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-auth/servant-auth/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -isrc -itest -idoctest/ghci-wrapper/src
servant-auth/servant-auth/CHANGELOG.mddeleted−20
@@ -1,20 +0,0 @@
1−# Changelog
2−
3−All notable changes to this project will be documented in this file.
4−
5−The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6−and this project adheres to [PVP Versioning](https://pvp.haskell.org/).
7−
8−## [Unreleased]
9−
10−## [0.4.0.0] - 2020-10-06
11−
12−- Support for GHC 8.10 by @domenkozar
13−- Support servant 0.18 by @domenkozar
14−- Move `ToJWT/FromJWT` from servant-auth-server
15−
16−## [0.3.2.0] - 2018-06-18
17−
18−### Added
19−- Support for GHC 8.4 by @phadej
20−- Changelog by @domenkozar
servant-auth/servant-auth/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Julian K. Arni (c) 2015
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Julian K. Arni nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
servant-auth/servant-auth/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
servant-auth/servant-auth/servant-auth.cabaldeleted−47
@@ -1,47 +0,0 @@
1−cabal-version: 2.2
2−name: servant-auth
3−version: 0.4.1.0
4−synopsis: Authentication combinators for servant
5−description: This package provides an @Auth@ combinator for 'servant'. This combinator
6− allows using different authentication schemes in a straightforward way,
7− and possibly in conjunction with one another.
8− .
9− 'servant-auth' additionally provides concrete authentication schemes, such
10− as Basic Access Authentication, JSON Web Tokens, and Cookies.
11− .
12− For more details on how to use this, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
13−category: Web, Servant, Authentication
14−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
15−bug-reports: https://github.com/haskell-servant/servant/issues
16−author: Julian K. Arni
17−maintainer: jkarni@gmail.com
18−copyright: (c) Julian K. Arni
19−license: BSD-3-Clause
20−license-file: LICENSE
21−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.4 || ==9.0.1
22−build-type: Simple
23−extra-source-files:
24− CHANGELOG.md
25−
26−source-repository head
27− type: git
28− location: https://github.com/haskell-servant/servant
29−
30−library
31− hs-source-dirs:
32− src
33− default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
34− ghc-options: -Wall
35− build-depends:
36− base >= 4.10 && < 4.17
37− , containers >= 0.6 && < 0.7
38− , aeson >= 1.3.1.1 && < 3
39− , jose >= 0.7.0.0 && < 0.10
40− , lens >= 4.16.1 && < 5.2
41− , servant >= 0.15 && < 0.20
42− , text >= 1.2.3.0 && < 2.1
43− , unordered-containers >= 0.2.9.0 && < 0.3
44− exposed-modules:
45− Servant.Auth
46− Servant.Auth.JWT
47− default-language: Haskell2010
servant-auth/servant-auth/src/Servant/Auth.hsdeleted−54
@@ -1,54 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4−{-# LANGUAGE TypeFamilies #-}
5−{-# LANGUAGE TypeOperators #-}
6−module Servant.Auth where
7−
8−import Data.Proxy (Proxy(..))
9−import Servant.API ((:>))
10−import Servant.Links (HasLink (..))
11−
12−-- * Authentication
13−
14−-- | @Auth [auth1, auth2] val :> api@ represents an API protected *either* by
15−-- @auth1@ or @auth2@
16−data Auth (auths :: [*]) val
17−
18−-- | A @HasLink@ instance for @Auth@
19−instance HasLink sub => HasLink (Auth (tag :: [*]) value :> sub) where
20−#if MIN_VERSION_servant(0,14,0)
21− type MkLink (Auth (tag :: [*]) value :> sub) a = MkLink sub a
22− toLink toA _ = toLink toA (Proxy :: Proxy sub)
23−#else
24− type MkLink (Auth (tag :: [*]) value :> sub) = MkLink sub
25− toLink _ = toLink (Proxy :: Proxy sub)
26−#endif
27−
28−-- ** Combinators
29−
30−-- | A JSON Web Token (JWT) in the the Authorization header:
31−--
32−-- @Authorization: Bearer \<token\>@
33−--
34−-- Note that while the token is signed, it is not encrypted. Therefore do not
35−-- keep in it any information you would not like the client to know.
36−--
37−-- JWTs are described in IETF's <https://tools.ietf.org/html/rfc7519 RFC 7519>
38−data JWT
39−
40−-- | A cookie. The content cookie itself is a JWT. Another cookie is also used,
41−-- the contents of which are expected to be send back to the server in a
42−-- header, for XSRF protection.
43−data Cookie
44−
45−
46−-- We could use 'servant''s BasicAuth, but then we don't get control over the
47−-- documentation, and we'd have to polykind everything. (Also, we don't
48−-- currently depend on servant!)
49−--
50−-- | Basic Auth.
51−data BasicAuth
52−
53−-- | Login via a form.
54−data FormLogin form
servant-auth/servant-auth/src/Servant/Auth/JWT.hsdeleted−40
@@ -1,40 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−
3−module Servant.Auth.JWT where
4−
5−import Control.Lens ((^.))
6−import qualified Crypto.JWT as Jose
7−import Data.Aeson (FromJSON, Result (..), ToJSON, fromJSON,
8− toJSON)
9−#if MIN_VERSION_aeson(2,0,0)
10−import qualified Data.Map as KM
11−#else
12−import qualified Data.HashMap.Strict as KM
13−#endif
14−
15−import qualified Data.Text as T
16−
17−
18−-- This should probably also be from ClaimSet
19−--
20−-- | How to decode data from a JWT.
21−--
22−-- The default implementation assumes the data is stored in the unregistered
23−-- @dat@ claim, and uses the @FromJSON@ instance to decode value from there.
24−class FromJWT a where
25− decodeJWT :: Jose.ClaimsSet -> Either T.Text a
26− default decodeJWT :: FromJSON a => Jose.ClaimsSet -> Either T.Text a
27− decodeJWT m = case KM.lookup "dat" (m ^. Jose.unregisteredClaims) of
28− Nothing -> Left "Missing 'dat' claim"
29− Just v -> case fromJSON v of
30− Error e -> Left $ T.pack e
31− Success a -> Right a
32−
33−-- | How to encode data from a JWT.
34−--
35−-- The default implementation stores data in the unregistered @dat@ claim, and
36−-- uses the type's @ToJSON@ instance to encode the data.
37−class ToJWT a where
38− encodeJWT :: a -> Jose.ClaimsSet
39− default encodeJWT :: ToJSON a => a -> Jose.ClaimsSet
40− encodeJWT a = Jose.addClaim "dat" (toJSON a) Jose.emptyClaimsSet
servant-auth/servant-auth/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-client-core/CHANGELOG.md+2−111
@@ -1,115 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-client-core/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19
7−----
8−
9−### Significant changes
10−
11−- Drop support for GHC < 8.6.
12−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
13−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
14− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
15− related to hash collisions.
16−- Add `NamedRoutes` combinator, making support for records first-class in Servant
17− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
18−- Add custom type errors for partially applied combinators
19− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
20− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
21−- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
22− erroneous behavior, where only 2XX status codes would be considered
23− successful, irrelevant of the status parameter specified by the verb
24− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
25−- *servant-client* / *servant-client-core*: Fix `Show` instance for
26− `Servant.Client.Core.Request`.
27−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
28− in Query parameters.
29− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
30−
31−### Other changes
32−
33−- Various version bumps.
34−
35−0.18.3
36−------
37−
38−### Significant changes
39−
40−- Add response header support to UVerb (#1420)
41−
42−### Other changes
43−
44−- Support GHC-9.0.1.
45−- Bump `bytestring`, `hspec`, `base64-bytestring` and `QuickCheck` dependencies.
46−
47−0.18.2
48−------
49−
50−### Significant changes
51−
52−- Support `Fragment` combinator.
53−
54−0.18.1
55−------
56−
57−### Significant changes
58−
59−- Union verbs
60−
61−### Other changes
62−
63−- Bump "tested-with" ghc versions
64−- Loosen bound on base16-bytestring
65−
66−0.18
67−----
68−
69−### Significant changes
70−
71−- Support for ghc8.8 (#1318, #1326, #1327)
72−
73−
74−0.17
75−----
76−
77−### Significant changes
78−
79−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
80−
81− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
82− The API type changes are usually of the kind
83−
84− ```diff
85− - :<|> PostNoContent '[JSON] NoContent
86− + :<|> PostNoContent
87− ```
88−
89− i.e. one doesn't need to specify the content-type anymore. There is no content.
90−
91−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
92−
93− You can specify a lenient capture as
94−
95− ```haskell
96− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
97− ```
98−
99− which will make the capture always succeed. Handlers will be of the
100− type `Either String CapturedType`, where `Left err` represents
101− the possible parse failure.
102−
103−### Other changes
104−
105−- *servant-client* *servant-client-core* *servant-http-streams* Fix Verb with headers checking content type differently [#1200](https://github.com/haskell-servant/servant/issues/1200) [#1204](https://github.com/haskell-servant/servant/pull/1204)
106−
107− For `Verb`s with response `Headers`, the implementation didn't check
108− for the content-type of the response. Now it does.
109−
110−- *servant-client* *servant-http-streams* `HasClient` instance for `Stream` with `Headers` [#1170](https://github.com/haskell-servant/servant/issues/1170) [#1197](https://github.com/haskell-servant/servant/pull/1197)
111−- *servant-client* Redact the authorization header in Show and exceptions [#1238](https://github.com/haskell-servant/servant/pull/1238)
112−
11340.16
1145----
1156
@@ -275,9 +166,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
275166
276167- *servant-client-core* Add `hoistClient` to `HasClient`.
277168 Just like `hoistServer` allows us to change the monad in which request handlers
278− of a web application live, we also have `hoistClient` for changing the monad
169+ of a web application live in, we also have `hoistClient` for changing the monad
279170 in which *client functions* live.
280− Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
171+ Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
281172 ([#936](https://github.com/haskell-servant/servant/pull/936))
282173
283174 iF you have own combinators, you'll need to define a new method of
servant-client-core/servant-client-core.cabal+22−22
@@ -1,6 +1,6 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-client-core
3−version: 0.19
3+version: 0.16
44
55synopsis: Core functionality and class for client function generation for servant APIs
66category: Servant, Web
@@ -8,16 +8,19 @@ description:
88 This library provides backend-agnostic generation of client functions. For
99 more information, see the README.
1010
11−homepage: http://docs.servant.dev/
11+homepage: http://haskell-servant.readthedocs.org/
1212bug-reports: http://github.com/haskell-servant/servant/issues
13−license: BSD-3-Clause
13+license: BSD3
1414license-file: LICENSE
1515author: Servant Contributors
1616maintainer: haskell-servant-maintainers@googlegroups.com
1717copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
1818build-type: Simple
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
20− , GHCJS ==8.6.0.1
19+tested-with:
20+ GHC ==8.0.2
21+ || ==8.2.2
22+ || ==8.4.4
23+ || ==8.6.3
2124
2225extra-source-files:
2326 CHANGELOG.md
@@ -50,14 +53,13 @@ library
5053 --
5154 -- note: mtl lower bound is so low because of GHC-7.8
5255 build-depends:
53− base >= 4.9 && < 4.17
54− , bytestring >= 0.10.8.1 && < 0.12
55− , constraints >= 0.2 && < 0.14
56+ base >= 4.9 && < 4.13
57+ , bytestring >= 0.10.8.1 && < 0.11
5658 , containers >= 0.5.7.1 && < 0.7
5759 , deepseq >= 1.4.2.0 && < 1.5
58− , text >= 1.2.3.0 && < 2.1
60+ , text >= 1.2.3.0 && < 1.3
5961 , transformers >= 0.5.2.0 && < 0.6
60− , template-haskell >= 2.11.1.0 && < 2.19
62+ , template-haskell >= 2.11.1.0 && < 2.15
6163
6264 if !impl(ghc >= 8.2)
6365 build-depends:
@@ -65,21 +67,20 @@ library
6567
6668 -- Servant dependencies
6769 build-depends:
68− servant >= 0.19
70+ servant >= 0.16 && <0.17
6971
7072 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
7173 -- Here can be exceptions if we really need features from the newer versions.
7274 build-depends:
73− aeson >= 1.4.1.0 && < 3
74− , base-compat >= 0.10.5 && < 0.13
75− , base64-bytestring >= 1.0.0.1 && < 1.3
75+ aeson >= 1.4.1.0 && < 1.5
76+ , base-compat >= 0.10.5 && < 0.11
77+ , base64-bytestring >= 1.0.0.1 && < 1.1
7678 , exceptions >= 0.10.0 && < 0.11
7779 , free >= 5.1 && < 5.2
78− , http-media >= 0.7.1.3 && < 0.9
80+ , http-media >= 0.7.1.3 && < 0.8
7981 , http-types >= 0.12.2 && < 0.13
8082 , network-uri >= 2.6.1.0 && < 2.7
8183 , safe >= 0.3.17 && < 0.4
82− , sop-core >= 0.4.0.0 && < 0.6
8384
8485 hs-source-dirs: src
8586 default-language: Haskell2010
@@ -93,7 +94,6 @@ test-suite spec
9394 main-is: Spec.hs
9495 other-modules:
9596 Servant.Client.Core.Internal.BaseUrlSpec
96− Servant.Client.Core.RequestSpec
9797
9898 -- Dependencies inherited from the library. No need to specify bounds.
9999 build-depends:
@@ -101,11 +101,11 @@ test-suite spec
101101 , base-compat
102102 , servant-client-core
103103
104− -- Additional dependencies
104+ -- Additonal dependencies
105105 build-depends:
106106 deepseq >= 1.4.2.0 && < 1.5
107− , hspec >= 2.6.0 && < 2.10
108− , QuickCheck >= 2.12.6.1 && < 2.15
107+ , hspec >= 2.6.0 && < 2.8
108+ , QuickCheck >= 2.12.6.1 && < 2.13
109109
110110 build-tool-depends:
111− hspec-discover:hspec-discover >= 2.6.0 && <2.10
111+ hspec-discover:hspec-discover >= 2.6.0 && <2.8
servant-client-core/src/Servant/Client/Core.hs−3
@@ -18,8 +18,6 @@ module Servant.Client.Core
1818 -- * Client generation
1919 clientIn
2020 , HasClient(..)
21− , foldMapUnion
22− , matchUnion
2321
2422 -- * Request
2523 , Request
@@ -59,7 +57,6 @@ module Servant.Client.Core
5957 , appendToPath
6058 , setRequestBodyLBS
6159 , setRequestBody
62− , encodeQueryParamValue
6360 ) where
6461import Servant.Client.Core.Auth
6562import Servant.Client.Core.BaseUrl
servant-client-core/src/Servant/Client/Core/BasicAuth.hs+2
@@ -9,6 +9,8 @@ module Servant.Client.Core.BasicAuth (
99
1010import Data.ByteString.Base64
1111 (encode)
12+import Data.Monoid
13+ ((<>))
1214import Data.Text.Encoding
1315 (decodeUtf8)
1416import Servant.API.BasicAuth
servant-client-core/src/Servant/Client/Core/HasClient.hs+34−349
@@ -1,4 +1,3 @@
1−{-# LANGUAGE ConstraintKinds #-}
21{-# LANGUAGE DataKinds #-}
32{-# LANGUAGE FlexibleContexts #-}
43{-# LANGUAGE FlexibleInstances #-}
@@ -6,10 +5,8 @@
65{-# LANGUAGE MultiParamTypeClasses #-}
76{-# LANGUAGE OverloadedStrings #-}
87{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE QuantifiedConstraints #-}
108{-# LANGUAGE RankNTypes #-}
119{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeApplications #-}
1310{-# LANGUAGE TypeFamilies #-}
1411{-# LANGUAGE TypeOperators #-}
1512{-# LANGUAGE UndecidableInstances #-}
@@ -18,80 +15,47 @@ module Servant.Client.Core.HasClient (
1815 clientIn,
1916 HasClient (..),
2017 EmptyClient (..),
21− AsClientT,
22− (//),
23− (/:),
24− foldMapUnion,
25− matchUnion,
2618 ) where
2719
2820import Prelude ()
2921import Prelude.Compat
3022
31−import Control.Arrow
32− (left, (+++))
3323import Control.Monad
3424 (unless)
35−import qualified Data.ByteString as BS
36−import qualified Data.ByteString.Lazy as BL
37−import Data.Either
38− (partitionEithers)
39−import Data.Constraint (Dict(..))
25+import qualified Data.ByteString.Lazy as BL
4026import Data.Foldable
4127 (toList)
4228import Data.List
4329 (foldl')
30+import Data.Proxy
31+ (Proxy (Proxy))
4432import Data.Sequence
4533 (fromList)
4634import qualified Data.Text as T
4735import Network.HTTP.Media
48− (MediaType, matches, parseAccept)
49−import qualified Network.HTTP.Media as Media
50−import qualified Data.Sequence as Seq
51−import Data.SOP.BasicFunctors
52− (I (I), (:.:) (Comp))
53−import Data.SOP.Constraint
54− (All)
55−import Data.SOP.NP
56− (NP (..), cpure_NP)
57−import Data.SOP.NS
58− (NS (S))
36+ (MediaType, matches, parseAccept, (//))
5937import Data.String
6038 (fromString)
6139import Data.Text
6240 (Text, pack)
63−import Data.Proxy
64− (Proxy (Proxy))
6541import GHC.TypeLits
66− (KnownNat, KnownSymbol, TypeError, symbolVal)
67−import Network.HTTP.Types
68− (Status)
42+ (KnownSymbol, symbolVal)
6943import qualified Network.HTTP.Types as H
7044import Servant.API
7145 ((:<|>) ((:<|>)), (:>), AuthProtect, BasicAuth, BasicAuthData,
7246 BuildHeadersTo (..), Capture', CaptureAll, Description,
73− EmptyAPI, Fragment, FramingRender (..), FramingUnrender (..),
47+ EmptyAPI, FramingRender (..), FramingUnrender (..),
7448 FromSourceIO (..), Header', Headers (..), HttpVersion,
7549 IsSecure, MimeRender (mimeRender),
76− MimeUnrender (mimeUnrender), NoContent (NoContent),
77− NoContentVerb, QueryFlag, QueryParam', QueryParams, Raw,
78− ReflectMethod (..), RemoteHost, ReqBody', SBoolI, Stream,
79− StreamBody', Summary, ToHttpApiData, ToSourceIO (..), Vault,
80− Verb, WithNamedContext, WithStatus (..), contentType, getHeadersHList,
81− getResponse, toEncodedUrlPiece, toUrlPiece, NamedRoutes)
82−import Servant.API.Generic
83− (GenericMode(..), ToServant, ToServantApi
84− , GenericServant, toServant, fromServant)
50+ MimeUnrender (mimeUnrender), NoContent (NoContent), QueryFlag,
51+ QueryParam', QueryParams, Raw, ReflectMethod (..), RemoteHost,
52+ ReqBody', SBoolI, Stream, StreamBody', Summary, ToHttpApiData,
53+ ToSourceIO (..), Vault, Verb, WithNamedContext, contentType,
54+ getHeadersHList, getResponse, toQueryParam, toUrlPiece)
8555import Servant.API.ContentTypes
86− (contentTypes, AllMime (allMime), AllMimeUnrender (allMimeUnrender))
87−import Servant.API.Status
88− (statusFromNat)
89−import Servant.API.TypeLevel (FragmentUnique, AtLeastOneFragment)
56+ (contentTypes)
9057import Servant.API.Modifiers
9158 (FoldRequired, RequiredArgument, foldRequiredArgument)
92−import Servant.API.TypeErrors
93−import Servant.API.UVerb
94− (HasStatus, HasStatuses (Statuses, statuses), UVerb, Union, Unique, inject, statusOf, foldMapUnion, matchUnion)
9559
9660import Servant.Client.Core.Auth
9761import Servant.Client.Core.BasicAuth
@@ -208,7 +172,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m api)
208172 clientWithRoute pm (Proxy :: Proxy api)
209173 (appendToPath p req)
210174
211− where p = toEncodedUrlPiece val
175+ where p = (toUrlPiece val)
212176
213177 hoistClientMonad pm _ f cl = \a ->
214178 hoistClientMonad pm (Proxy :: Proxy api) f (cl a)
@@ -243,7 +207,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m sublayout)
243207 clientWithRoute pm (Proxy :: Proxy sublayout)
244208 (foldl' (flip appendToPath) req ps)
245209
246− where ps = map toEncodedUrlPiece vals
210+ where ps = map (toUrlPiece) vals
247211
248212 hoistClientMonad pm _ f cl = \as ->
249213 hoistClientMonad pm (Proxy :: Proxy sublayout) f (cl as)
@@ -251,11 +215,10 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m sublayout)
251215instance {-# OVERLAPPABLE #-}
252216 -- Note [Non-Empty Content Types]
253217 ( RunClient m, MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts)
254− , KnownNat status
255218 ) => HasClient m (Verb method status cts' a) where
256219 type Client m (Verb method status cts' a) = m a
257220 clientWithRoute _pm Proxy req = do
258− response <- runRequestAcceptStatus (Just [status]) req
221+ response <- runRequest req
259222 { requestAccept = fromList $ toList accept
260223 , requestMethod = method
261224 }
@@ -263,27 +226,14 @@ instance {-# OVERLAPPABLE #-}
263226 where
264227 accept = contentTypes (Proxy :: Proxy ct)
265228 method = reflectMethod (Proxy :: Proxy method)
266− status = statusFromNat (Proxy :: Proxy status)
267229
268230 hoistClientMonad _ _ f ma = f ma
269231
270232instance {-# OVERLAPPING #-}
271− ( RunClient m, ReflectMethod method, KnownNat status
233+ ( RunClient m, ReflectMethod method
272234 ) => HasClient m (Verb method status cts NoContent) where
273235 type Client m (Verb method status cts NoContent)
274236 = m NoContent
275− clientWithRoute _pm Proxy req = do
276− _response <- runRequestAcceptStatus (Just [status]) req { requestMethod = method }
277− return NoContent
278− where method = reflectMethod (Proxy :: Proxy method)
279− status = statusFromNat (Proxy :: Proxy status)
280−
281− hoistClientMonad _ _ f ma = f ma
282−
283−instance (RunClient m, ReflectMethod method) =>
284− HasClient m (NoContentVerb method) where
285− type Client m (NoContentVerb method)
286− = m NoContent
287237 clientWithRoute _pm Proxy req = do
288238 _response <- runRequest req { requestMethod = method }
289239 return NoContent
@@ -293,129 +243,41 @@ instance (RunClient m, ReflectMethod method) =>
293243
294244instance {-# OVERLAPPING #-}
295245 -- Note [Non-Empty Content Types]
296− ( RunClient m, MimeUnrender ct a, BuildHeadersTo ls, KnownNat status
246+ ( RunClient m, MimeUnrender ct a, BuildHeadersTo ls
297247 , ReflectMethod method, cts' ~ (ct ': cts)
298248 ) => HasClient m (Verb method status cts' (Headers ls a)) where
299249 type Client m (Verb method status cts' (Headers ls a))
300250 = m (Headers ls a)
301251 clientWithRoute _pm Proxy req = do
302− response <- runRequestAcceptStatus (Just [status]) req
252+ response <- runRequest req
303253 { requestMethod = method
304254 , requestAccept = fromList $ toList accept
305255 }
306− val <- response `decodedAs` (Proxy :: Proxy ct)
307− return $ Headers { getResponse = val
308− , getHeadersHList = buildHeadersTo . toList $ responseHeaders response
309− }
310− where
311− method = reflectMethod (Proxy :: Proxy method)
312− accept = contentTypes (Proxy :: Proxy ct)
313− status = statusFromNat (Proxy :: Proxy status)
256+ case mimeUnrender (Proxy :: Proxy ct) $ responseBody response of
257+ Left err -> throwClientError $ DecodeFailure (pack err) response
258+ Right val -> return $ Headers
259+ { getResponse = val
260+ , getHeadersHList = buildHeadersTo . toList $ responseHeaders response
261+ }
262+ where method = reflectMethod (Proxy :: Proxy method)
263+ accept = contentTypes (Proxy :: Proxy ct)
314264
315265 hoistClientMonad _ _ f ma = f ma
316266
317267instance {-# OVERLAPPING #-}
318− ( RunClient m, BuildHeadersTo ls, ReflectMethod method, KnownNat status
268+ ( RunClient m, BuildHeadersTo ls, ReflectMethod method
319269 ) => HasClient m (Verb method status cts (Headers ls NoContent)) where
320270 type Client m (Verb method status cts (Headers ls NoContent))
321271 = m (Headers ls NoContent)
322272 clientWithRoute _pm Proxy req = do
323− response <- runRequestAcceptStatus (Just [status]) req { requestMethod = method }
273+ let method = reflectMethod (Proxy :: Proxy method)
274+ response <- runRequest req { requestMethod = method }
324275 return $ Headers { getResponse = NoContent
325276 , getHeadersHList = buildHeadersTo . toList $ responseHeaders response
326277 }
327− where
328− method = reflectMethod (Proxy :: Proxy method)
329− status = statusFromNat (Proxy :: Proxy status)
330278
331279 hoistClientMonad _ _ f ma = f ma
332280
333−data ClientParseError = ClientParseError MediaType String | ClientStatusMismatch | ClientNoMatchingStatus
334− deriving (Eq, Show)
335−
336−class UnrenderResponse (cts :: [*]) (a :: *) where
337− unrenderResponse :: Seq.Seq H.Header -> BL.ByteString -> Proxy cts
338− -> [Either (MediaType, String) a]
339−
340−instance {-# OVERLAPPABLE #-} AllMimeUnrender cts a => UnrenderResponse cts a where
341− unrenderResponse _ body = map parse . allMimeUnrender
342− where parse (mediaType, parser) = left ((,) mediaType) (parser body)
343−
344−instance {-# OVERLAPPING #-} forall cts a h . (UnrenderResponse cts a, BuildHeadersTo h)
345− => UnrenderResponse cts (Headers h a) where
346− unrenderResponse hs body = (map . fmap) setHeaders . unrenderResponse hs body
347− where
348− setHeaders :: a -> Headers h a
349− setHeaders x = Headers x (buildHeadersTo (toList hs))
350−
351−instance {-# OVERLAPPING #-} UnrenderResponse cts a
352− => UnrenderResponse cts (WithStatus n a) where
353− unrenderResponse hs body = (map . fmap) WithStatus . unrenderResponse hs body
354−
355−instance {-# OVERLAPPING #-}
356− ( RunClient m,
357− contentTypes ~ (contentType ': otherContentTypes),
358− -- ('otherContentTypes' should be '_', but even -XPartialTypeSignatures does not seem
359− -- allow this in instance types as of 8.8.3.)
360− as ~ (a ': as'),
361− AllMime contentTypes,
362− ReflectMethod method,
363− All (UnrenderResponse contentTypes) as,
364− All HasStatus as, HasStatuses as',
365− Unique (Statuses as)
366− ) =>
367− HasClient m (UVerb method contentTypes as)
368− where
369− type Client m (UVerb method contentTypes as) = m (Union as)
370−
371− clientWithRoute _ _ request = do
372− let accept = Seq.fromList . allMime $ Proxy @contentTypes
373− -- offering to accept all mime types listed in the api gives best compatibility. eg.,
374− -- we might not own the server implementation, and the server may choose to support
375− -- only part of the api.
376−
377− method = reflectMethod $ Proxy @method
378− acceptStatus = statuses (Proxy @as)
379− response <- runRequestAcceptStatus (Just acceptStatus) request {requestMethod = method, requestAccept = accept}
380− responseContentType <- checkContentTypeHeader response
381− unless (any (matches responseContentType) accept) $ do
382− throwClientError $ UnsupportedContentType responseContentType response
383−
384− let status = responseStatusCode response
385− body = responseBody response
386− headers = responseHeaders response
387− res = tryParsers status $ mimeUnrenders (Proxy @contentTypes) headers body
388− case res of
389− Left errors -> throwClientError $ DecodeFailure (T.pack (show errors)) response
390− Right x -> return x
391− where
392− -- | Given a list of parsers of 'mkres', returns the first one that succeeds and all the
393− -- failures it encountered along the way
394− -- TODO; better name, rewrite haddocs.
395− tryParsers :: forall xs. All HasStatus xs => Status -> NP ([] :.: Either (MediaType, String)) xs -> Either [ClientParseError] (Union xs)
396− tryParsers _ Nil = Left [ClientNoMatchingStatus]
397− tryParsers status (Comp x :* xs)
398− | status == statusOf (Comp x) =
399− case partitionEithers x of
400− (err', []) -> (map (uncurry ClientParseError) err' ++) +++ S $ tryParsers status xs
401− (_, (res : _)) -> Right . inject . I $ res
402− | otherwise = -- no reason to parse in the first place. This ain't the one we're looking for
403− (ClientStatusMismatch :) +++ S $ tryParsers status xs
404−
405− -- | Given a list of types, parses the given response body as each type
406− mimeUnrenders ::
407− forall cts xs.
408− All (UnrenderResponse cts) xs =>
409− Proxy cts ->
410− Seq.Seq H.Header ->
411− BL.ByteString ->
412− NP ([] :.: Either (MediaType, String)) xs
413− mimeUnrenders ctp headers body = cpure_NP
414− (Proxy @(UnrenderResponse cts))
415− (Comp . unrenderResponse headers body $ ctp)
416−
417− hoistClientMonad _ _ nt s = nt s
418−
419281instance {-# OVERLAPPABLE #-}
420282 ( RunStreamingClient m, MimeUnrender ct chunk, ReflectMethod method,
421283 FramingUnrender framing, FromSourceIO chunk a
@@ -435,31 +297,6 @@ instance {-# OVERLAPPABLE #-}
435297 , requestMethod = reflectMethod (Proxy :: Proxy method)
436298 }
437299
438−instance {-# OVERLAPPING #-}
439− ( RunStreamingClient m, MimeUnrender ct chunk, ReflectMethod method,
440− FramingUnrender framing, FromSourceIO chunk a,
441− BuildHeadersTo hs
442− ) => HasClient m (Stream method status framing ct (Headers hs a)) where
443−
444− type Client m (Stream method status framing ct (Headers hs a)) = m (Headers hs a)
445−
446− hoistClientMonad _ _ f ma = f ma
447−
448− clientWithRoute _pm Proxy req = withStreamingRequest req' $ \gres -> do
449− let mimeUnrender' = mimeUnrender (Proxy :: Proxy ct) :: BL.ByteString -> Either String chunk
450− framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender'
451− val = fromSourceIO $ framingUnrender' $ responseBody gres
452− return $ Headers
453− { getResponse = val
454− , getHeadersHList = buildHeadersTo . toList $ responseHeaders gres
455− }
456−
457− where
458− req' = req
459− { requestAccept = fromList [contentType (Proxy :: Proxy ct)]
460− , requestMethod = reflectMethod (Proxy :: Proxy method)
461− }
462−
463300-- | If you use a 'Header' in one of your endpoints in your API,
464301-- the corresponding querying function will automatically take
465302-- an additional argument of the type specified by your 'Header',
@@ -569,7 +406,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequire
569406 (Proxy :: Proxy mods) add (maybe req add) mparam
570407 where
571408 add :: a -> Request
572− add param = appendToQueryString pname (Just $ encodeQueryParamValue param) req
409+ add param = appendToQueryString pname (Just $ toQueryParam param) req
573410
574411 pname :: Text
575412 pname = pack $ symbolVal (Proxy :: Proxy sym)
@@ -618,7 +455,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient m api)
618455 )
619456
620457 where pname = pack $ symbolVal (Proxy :: Proxy sym)
621− paramlist' = map (Just . encodeQueryParamValue) paramlist
458+ paramlist' = map (Just . toQueryParam) paramlist
622459
623460 hoistClientMonad pm _ f cl = \as ->
624461 hoistClientMonad pm (Proxy :: Proxy api) f (cl as)
@@ -740,7 +577,7 @@ instance (KnownSymbol path, HasClient m api) => HasClient m (path :> api) where
740577 clientWithRoute pm (Proxy :: Proxy api)
741578 (appendToPath p req)
742579
743− where p = toEncodedUrlPiece $ pack $ symbolVal (Proxy :: Proxy path)
580+ where p = pack $ symbolVal (Proxy :: Proxy path)
744581
745582 hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy api) f cl
746583
@@ -787,29 +624,6 @@ instance ( HasClient m api
787624 hoistClientMonad pm _ f cl = \authreq ->
788625 hoistClientMonad pm (Proxy :: Proxy api) f (cl authreq)
789626
790−-- | Ignore @'Fragment'@ in client functions.
791−-- See <https://ietf.org/rfc/rfc2616.html#section-15.1.3> for more details.
792−--
793−-- Example:
794−--
795−-- > type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book]
796−-- >
797−-- > myApi :: Proxy MyApi
798−-- > myApi = Proxy
799−-- >
800−-- > getBooks :: ClientM [Book]
801−-- > getBooks = client myApi
802−-- > -- then you can just use "getBooksBy" to query that endpoint.
803−-- > -- 'getBooks' for all books.
804−instance (AtLeastOneFragment api, FragmentUnique (Fragment a :> api), HasClient m api
805− ) => HasClient m (Fragment a :> api) where
806−
807− type Client m (Fragment a :> api) = Client m api
808−
809− clientWithRoute pm _ = clientWithRoute pm (Proxy :: Proxy api)
810−
811− hoistClientMonad pm _ = hoistClientMonad pm (Proxy :: Proxy api)
812−
813627-- * Basic Authentication
814628
815629instance HasClient m api => HasClient m (BasicAuth realm usr :> api) where
@@ -821,119 +635,6 @@ instance HasClient m api => HasClient m (BasicAuth realm usr :> api) where
821635 hoistClientMonad pm _ f cl = \bauth ->
822636 hoistClientMonad pm (Proxy :: Proxy api) f (cl bauth)
823637
824−-- | A type that specifies that an API record contains a client implementation.
825−data AsClientT (m :: * -> *)
826−instance GenericMode (AsClientT m) where
827− type AsClientT m :- api = Client m api
828−
829−
830−type GClientConstraints api m =
831− ( GenericServant api (AsClientT m)
832− , Client m (ToServantApi api) ~ ToServant api (AsClientT m)
833− )
834−
835−class GClient (api :: * -> *) m where
836− gClientProof :: Dict (GClientConstraints api m)
837−
838−instance GClientConstraints api m => GClient api m where
839− gClientProof = Dict
840−
841−instance
842− ( forall n. GClient api n
843− , HasClient m (ToServantApi api)
844− , RunClient m
845− )
846− => HasClient m (NamedRoutes api) where
847− type Client m (NamedRoutes api) = api (AsClientT m)
848−
849− clientWithRoute :: Proxy m -> Proxy (NamedRoutes api) -> Request -> Client m (NamedRoutes api)
850− clientWithRoute pm _ request =
851− case gClientProof @api @m of
852− Dict -> fromServant $ clientWithRoute pm (Proxy @(ToServantApi api)) request
853−
854− hoistClientMonad
855− :: forall ma mb.
856− Proxy m
857− -> Proxy (NamedRoutes api)
858− -> (forall x. ma x -> mb x)
859− -> Client ma (NamedRoutes api)
860− -> Client mb (NamedRoutes api)
861− hoistClientMonad _ _ nat clientA =
862− case (gClientProof @api @ma, gClientProof @api @mb) of
863− (Dict, Dict) ->
864− fromServant @api @(AsClientT mb) $
865− hoistClientMonad @m @(ToServantApi api) @ma @mb Proxy Proxy nat $
866− toServant @api @(AsClientT ma) clientA
867−
868−infixl 1 //
869−infixl 2 /:
870−
871−-- | Helper to make code using records of clients more readable.
872−--
873−-- Can be mixed with (/:) for supplying arguments.
874−--
875−-- Example:
876−--
877−-- @
878−-- type Api = NamedRoutes RootApi
879−--
880−-- data RootApi mode = RootApi
881−-- { subApi :: mode :- NamedRoutes SubApi
882−-- , …
883−-- } deriving Generic
884−--
885−-- data SubApi mode = SubApi
886−-- { endpoint :: mode :- Get '[JSON] Person
887−-- , …
888−-- } deriving Generic
889−--
890−-- api :: Proxy API
891−-- api = Proxy
892−--
893−-- rootClient :: RootApi (AsClientT ClientM)
894−-- rootClient = client api
895−--
896−-- endpointClient :: ClientM Person
897−-- endpointClient = client // subApi // endpoint
898−-- @
899−(//) :: a -> (a -> b) -> b
900−x // f = f x
901−
902−-- | Convenience function for supplying arguments to client functions when
903−-- working with records of clients.
904−--
905−-- Intended to be used in conjunction with '(//)'.
906−--
907−-- Example:
908−--
909−-- @
910−-- type Api = NamedRoutes RootApi
911−--
912−-- data RootApi mode = RootApi
913−-- { subApi :: mode :- Capture "token" String :> NamedRoutes SubApi
914−-- , hello :: mode :- Capture "name" String :> Get '[JSON] String
915−-- , …
916−-- } deriving Generic
917−--
918−-- data SubApi mode = SubApi
919−-- { endpoint :: mode :- Get '[JSON] Person
920−-- , …
921−-- } deriving Generic
922−--
923−-- api :: Proxy API
924−-- api = Proxy
925−--
926−-- rootClient :: RootApi (AsClientT ClientM)
927−-- rootClient = client api
928−--
929−-- hello :: String -> ClientM String
930−-- hello name = rootClient // hello /: name
931−--
932−-- endpointClient :: ClientM Person
933−-- endpointClient = client // subApi /: "foobar123" // endpoint
934−-- @
935−(/:) :: (a -> b -> c) -> b -> a -> c
936−(/:) = flip
937638
938639
939640{- Note [Non-Empty Content Types]
@@ -959,7 +660,7 @@ for empty and one for non-empty lists).
959660checkContentTypeHeader :: RunClient m => Response -> m MediaType
960661checkContentTypeHeader response =
961662 case lookup "Content-Type" $ toList $ responseHeaders response of
962− Nothing -> return $ "application" Media.// "octet-stream"
663+ Nothing -> return $ "application"//"octet-stream"
963664 Just t -> case parseAccept t of
964665 Nothing -> throwClientError $ InvalidContentTypeHeader response
965666 Just t' -> return t'
@@ -974,20 +675,4 @@ decodedAs response ct = do
974675 Left err -> throwClientError $ DecodeFailure (T.pack err) response
975676 Right val -> return val
976677 where
977− accept = toList $ contentTypes ct
978−
979−-------------------------------------------------------------------------------
980−-- Custom type errors
981−-------------------------------------------------------------------------------
982−
983−-- Erroring instance for HasClient' when a combinator is not fully applied
984−instance (RunClient m, TypeError (PartialApplication HasClient arr)) => HasClient m ((arr :: a -> b) :> sub)
985− where
986− type Client m (arr :> sub) = TypeError (PartialApplication HasClient arr)
987− clientWithRoute _ _ _ = error "unreachable"
988− hoistClientMonad _ _ _ _ = error "unreachable"
989−
990−-- Erroring instances for 'HasClient' for unknown API combinators
991−instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceForSub (HasClient m) ty)) => HasClient m (ty :> sub)
992−
993−instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceFor (HasClient m api))) => HasClient m api
678+ accept = toList $ contentTypes ct
servant-client-core/src/Servant/Client/Core/Reexport.hs−6
@@ -5,11 +5,6 @@ module Servant.Client.Core.Reexport
55 (
66 -- * HasClient
77 HasClient(..)
8− , foldMapUnion
9− , matchUnion
10− , AsClientT
11− , (//)
12− , (/:)
138
149 -- * Response (for @Raw@)
1510 , Response
@@ -26,7 +21,6 @@ module Servant.Client.Core.Reexport
2621 , showBaseUrl
2722 , parseBaseUrl
2823 , InvalidBaseUrlException
29−
3024 ) where
3125
3226
servant-client-core/src/Servant/Client/Core/Request.hs+11−50
@@ -17,7 +17,6 @@ module Servant.Client.Core.Request (
1717 addHeader,
1818 appendToPath,
1919 appendToQueryString,
20− encodeQueryParamValue,
2120 setRequestBody,
2221 setRequestBodyLBS,
2322 ) where
@@ -34,10 +33,10 @@ import Data.Bifunctor
3433import Data.Bitraversable
3534 (Bitraversable (..), bifoldMapDefault, bimapDefault)
3635import qualified Data.ByteString as BS
37−import Data.ByteString.Builder
38− (Builder)
3936import qualified Data.ByteString.Builder as Builder
4037import qualified Data.ByteString.Lazy as LBS
38+import Data.Semigroup
39+ ((<>))
4140import qualified Data.Sequence as Seq
4241import Data.Text
4342 (Text)
@@ -51,9 +50,9 @@ import Network.HTTP.Media
5150 (MediaType)
5251import Network.HTTP.Types
5352 (Header, HeaderName, HttpVersion (..), Method, QueryItem,
54− http11, methodGet, urlEncodeBuilder)
53+ http11, methodGet)
5554import Servant.API
56− (ToHttpApiData, toEncodedUrlPiece, toQueryParam, toHeader, SourceIO)
55+ (ToHttpApiData, toEncodedUrlPiece, toHeader, SourceIO)
5756
5857import Servant.Client.Core.Internal (mediaTypeRnf)
5958
@@ -65,33 +64,8 @@ data RequestF body path = Request
6564 , requestHeaders :: Seq.Seq Header
6665 , requestHttpVersion :: HttpVersion
6766 , requestMethod :: Method
68− } deriving (Generic, Typeable, Eq, Functor, Foldable, Traversable)
67+ } deriving (Generic, Typeable, Eq, Show, Functor, Foldable, Traversable)
6968
70−instance (Show a, Show b) =>
71− Show (Servant.Client.Core.Request.RequestF a b) where
72− showsPrec p req
73− = showParen
74− (p >= 11)
75− ( showString "Request {requestPath = "
76− . showsPrec 0 (requestPath req)
77− . showString ", requestQueryString = "
78− . showsPrec 0 (requestQueryString req)
79− . showString ", requestBody = "
80− . showsPrec 0 (requestBody req)
81− . showString ", requestAccept = "
82− . showsPrec 0 (requestAccept req)
83− . showString ", requestHeaders = "
84− . showsPrec 0 (redactSensitiveHeader <$> requestHeaders req)
85− . showString ", requestHttpVersion = "
86− . showsPrec 0 (requestHttpVersion req)
87− . showString ", requestMethod = "
88− . showsPrec 0 (requestMethod req)
89− . showString "}"
90− )
91− where
92− redactSensitiveHeader :: Header -> Header
93− redactSensitiveHeader ("Authorization", _) = ("Authorization", "<REDACTED>")
94− redactSensitiveHeader h = h
9569instance Bifunctor RequestF where bimap = bimapDefault
9670instance Bifoldable RequestF where bifoldMap = bifoldMapDefault
9771instance Bitraversable RequestF where
@@ -114,7 +88,7 @@ instance (NFData path, NFData body) => NFData (RequestF body path) where
11488 rnfB Nothing = ()
11589 rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt
11690
117−type Request = RequestF RequestBody Builder
91+type Request = RequestF RequestBody Builder.Builder
11892
11993-- | The request body. R replica of the @http-client@ @RequestBody@.
12094data RequestBody
@@ -145,31 +119,18 @@ defaultRequest = Request
145119 , requestMethod = methodGet
146120 }
147121
148−-- | Append extra path to the request being constructed.
149−--
150−-- Warning: This function assumes that the path fragment is already URL-encoded.
151−appendToPath :: Builder -> Request -> Request
122+appendToPath :: Text -> Request -> Request
152123appendToPath p req
153− = req { requestPath = requestPath req <> "/" <> p }
124+ = req { requestPath = requestPath req <> "/" <> toEncodedUrlPiece p }
154125
155−-- | Append a query parameter to the request being constructed.
156−--
157−appendToQueryString :: Text -- ^ query param name
158− -> Maybe BS.ByteString -- ^ query param value
126+appendToQueryString :: Text -- ^ param name
127+ -> Maybe Text -- ^ param value
159128 -> Request
160129 -> Request
161130appendToQueryString pname pvalue req
162131 = req { requestQueryString = requestQueryString req
163− Seq.|> (encodeUtf8 pname, pvalue)}
132+ Seq.|> (encodeUtf8 pname, encodeUtf8 <$> pvalue)}
164133
165−-- | Encode a query parameter value.
166−--
167−encodeQueryParamValue :: ToHttpApiData a => a -> BS.ByteString
168−encodeQueryParamValue = LBS.toStrict . Builder.toLazyByteString
169− . urlEncodeBuilder True . encodeUtf8 . toQueryParam
170−
171−-- | Add header to the request being constructed.
172−--
173134addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request
174135addHeader name val req
175136 = req { requestHeaders = requestHeaders req Seq.|> (name, toHeader val)}
servant-client-core/src/Servant/Client/Core/RunClient.hs+3−12
@@ -7,7 +7,6 @@
77-- | Types for possible backends to run client-side `Request` queries
88module Servant.Client.Core.RunClient (
99 RunClient (..),
10− runRequest,
1110 RunStreamingClient (..),
1211 ClientF (..),
1312 ) where
@@ -15,8 +14,6 @@ module Servant.Client.Core.RunClient (
1514import Prelude ()
1615import Prelude.Compat
1716
18−import Network.HTTP.Types.Status
19− (Status)
2017import Control.Monad.Free
2118 (Free (..), liftF)
2219
@@ -25,15 +22,10 @@ import Servant.Client.Core.Request
2522import Servant.Client.Core.Response
2623
2724class Monad m => RunClient m where
28− -- | How to make a request, with an optional list of status codes to not throw exceptions
29− -- for (default: [200..299]).
30− runRequestAcceptStatus :: Maybe [Status] -> Request -> m Response
25+ -- | How to make a request.
26+ runRequest :: Request -> m Response
3127 throwClientError :: ClientError -> m a
3228
33−-- | How to make a request.
34−runRequest :: RunClient m => Request -> m Response
35−runRequest = runRequestAcceptStatus Nothing
36−
3729class RunClient m => RunStreamingClient m where
3830 withStreamingRequest :: Request -> (StreamingResponse -> IO a) -> m a
3931
@@ -49,7 +41,6 @@ data ClientF a
4941 | Throw ClientError
5042 deriving (Functor)
5143
52−-- TODO: honour the accept-status argument.
5344instance ClientF ~ f => RunClient (Free f) where
54− runRequestAcceptStatus _ req = liftF (RunRequest req id)
45+ runRequest req = liftF (RunRequest req id)
5546 throwClientError = liftF . Throw
servant-client-core/src/Servant/Client/Generic.hs+11−8
@@ -1,10 +1,9 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE KindSignatures #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TypeFamilies #-}
7−
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE KindSignatures #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE TypeFamilies #-}
87module Servant.Client.Generic (
98 AsClientT,
109 genericClient,
@@ -16,7 +15,11 @@ import Data.Proxy
1615
1716import Servant.API.Generic
1817import Servant.Client.Core
19−import Servant.Client.Core.HasClient (AsClientT)
18+
19+-- | A type that specifies that an API reocrd contains a client implementation.
20+data AsClientT (m :: * -> *)
21+instance GenericMode (AsClientT m) where
22+ type AsClientT m :- api = Client m api
2023
2124-- | Generate a record of client functions.
2225genericClient
servant-client-core/test/Servant/Client/Core/RequestSpec.hsdeleted−31
@@ -1,31 +0,0 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−module Servant.Client.Core.RequestSpec (spec) where
4−
5−
6−import Prelude ()
7−import Prelude.Compat
8−import Control.Monad
9−import Data.List (isInfixOf)
10−import Servant.Client.Core.Request
11−import Test.Hspec
12−
13−newtype DataWithRequest = DataWithRequest (RequestF RequestBody ())
14− deriving Show
15−
16−spec :: Spec
17−spec = do
18− describe "Request" $ do
19− describe "show" $ do
20− it "has parenthesis correctly positioned" $ do
21− let d = DataWithRequest (void defaultRequest)
22− show d `shouldBe` "DataWithRequest (Request {requestPath = ()\
23− \, requestQueryString = fromList []\
24− \, requestBody = Nothing\
25− \, requestAccept = fromList []\
26− \, requestHeaders = fromList []\
27− \, requestHttpVersion = HTTP/1.1\
28− \, requestMethod = \"GET\"})"
29− it "redacts the authorization header" $ do
30− let request = void $ defaultRequest { requestHeaders = pure ("authorization", "secret") }
31− isInfixOf "secret" (show request) `shouldBe` False
servant-client-ghcjs/README.md+2−2
@@ -4,12 +4,12 @@ Type safe querying of servant APIs from the browser.
44
55`servant-client-ghcjs` is much like `servant-client`, as both packages allow you to generate functions that query the endpoints of your servant API. Both packages should feel the same in usage. The big difference lies in how they perform the actual requests. `servant-client` (indirectly) uses your operating system's socket mechanisms, whereas `servant-client-ghcjs` uses your browser's [XHR](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/Using_XMLHttpRequest) mechanisms to send requests.
66
7−This guide assumes knowledge of servant. Reading its [documentation](http://docs.servant.dev) is recommended if you're new to the subject.
7+This guide assumes knowledge of servant. Reading its [documentation](http://haskell-servant.readthedocs.io) is recommended if you're new to the subject.
88
99## Using servant-client-ghcjs
1010`servant-client-ghcjs` should feel familiar if you've worked with `servant-client`.
1111
12−Take the following API (taken from the [Querying an API](http://docs.servant.dev/en/stable/tutorial/Client.html) section in the servant documentation)
12+Take the following API (taken from the [Querying an API](http://haskell-servant.readthedocs.io/en/stable/tutorial/Client.html) section in the servant documentation)
1313
1414```haskell
1515{-# LANGUAGE DataKinds #-}
servant-client-ghcjs/servant-client-ghcjs.cabal+9−9
@@ -1,4 +1,4 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-client-ghcjs
33version: 0.16
44synopsis:
@@ -9,13 +9,13 @@ description:
99 This library lets you automatically derive Haskell functions that
1010 let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
1111 .
12− See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
12+ See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
1313 .
1414 <https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
1515
16−homepage: http://docs.servant.dev/
16+homepage: http://haskell-servant.readthedocs.org/
1717bug-reports: http://github.com/haskell-servant/servant/issues
18−license: BSD-3-Clause
18+license: BSD3
1919license-file: LICENSE
2020author: Servant Contributors
2121maintainer: haskell-servant-maintainers@googlegroups.com
@@ -38,14 +38,14 @@ library
3838 Servant.Client.Internal.XhrClient
3939
4040 build-depends:
41− base >=4.11 && <5
42− , bytestring >=0.10 && <0.12
41+ base >=4.11 && <4.12
42+ , bytestring >=0.10 && <0.11
4343 , case-insensitive >=1.2.0.0 && <1.3.0.0
4444 , containers >=0.5 && <0.7
4545 , exceptions >=0.8 && <0.11
4646 , ghcjs-base >=0.2.0.0 && <0.3.0.0
4747 , ghcjs-prim >=0.1.0.0 && <0.2.0.0
48− , http-media >=0.6.2 && <0.9
48+ , http-media >=0.6.2 && <0.8
4949 , http-types >=0.12 && <0.13
5050 , monad-control >=1.0.0.4 && <1.1
5151 , mtl >=2.2.2 && <2.3
@@ -56,8 +56,8 @@ library
5656
5757 -- strict, as we re-export stuff
5858 build-depends:
59− servant >=0.16 && <0.20
60− , servant-client-core >=0.16 && <0.20
59+ servant >=0.16 && <0.17
60+ , servant-client-core >=0.16 && <0.16.1
6161
6262 hs-source-dirs: src
6363 default-language: Haskell2010
servant-client-ghcjs/src/Servant/Client/Internal/XhrClient.hs+5−8
@@ -120,7 +120,7 @@ instance Exception StreamingNotSupportedException where
120120 displayException _ = "streamingRequest: streaming is not supported!"
121121
122122instance RunClient ClientM where
123− runRequestAcceptStatus = performRequest
123+ runRequest = performRequest
124124 throwClientError = throwError
125125
126126runClientMOrigin :: ClientM a -> ClientEnv -> IO (Either ClientError a)
@@ -152,18 +152,15 @@ runClientM m = do
152152
153153 runClientMOrigin m (ClientEnv (BaseUrl protocol hostname port ""))
154154
155−performRequest :: Maybe [Status] -> Request -> ClientM Response
156−performRequest acceptStatus req = do
155+performRequest :: Request -> ClientM Response
156+performRequest req = do
157157 xhr <- liftIO initXhr
158158 burl <- asks baseUrl
159159 liftIO $ performXhr xhr burl req
160160 resp <- toResponse xhr
161161
162− let status = responseStatusCode resp
163− goodStatus = case acceptStatus of
164− Nothing -> statusIsSuccessful status
165− Just good -> status `elem` good
166− unless goodStatus $ do
162+ let status = statusCode (responseStatusCode resp)
163+ unless (status >= 200 && status < 300) $ do
167164 let f b = (burl, BL.toStrict $ toLazyByteString b)
168165 throwError $ FailureResponse (bimap (const ()) f req) resp
169166
servant-client/CHANGELOG.md+2−124
@@ -1,128 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19
7−----
8−
9−### Significant changes
10−
11−- Drop support for GHC < 8.6.
12−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
13−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
14− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
15− related to hash collisions.
16−- Add `NamedRoutes` combinator, making support for records first-class in Servant
17− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
18−- Add custom type errors for partially applied combinators
19− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
20− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
21−- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
22− erroneous behavior, where only 2XX status codes would be considered
23− successful, irrelevant of the status parameter specified by the verb
24− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
25−- *servant-client* / *servant-client-core*: Fix `Show` instance for
26− `Servant.Client.Core.Request`.
27−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
28− in Query parameters.
29− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
30−
31−### Other changes
32−
33−- Various version bumps.
34−
35−0.18.3
36−------
37−
38−### Significant changes
39−
40−- Add response header support to UVerb (#1420)
41−
42−### Other changes
43−
44−- Support GHC-9.0.1.
45−- Bump `bytestring`, `hspec`, `http-client` and `QuickCheck` dependencies.
46−
47−0.18.2
48−------
49−
50−### Significant changes
51−
52−- Support `Fragment` combinator.
53−
54−0.18.1
55−------
56−
57−### Significant changes
58−
59−- Union verbs
60−
61−### Other changes
62−
63−- Bump "tested-with" ghc versions
64−
65−0.18
66−----
67−
68−### Significant changes
69−
70−- Support for ghc8.8 (#1318, #1326, #1327)
71−
72−
73−0.17
74−----
75−
76−### Significant changes
77−
78−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
79−
80− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
81− The API type changes are usually of the kind
82−
83− ```diff
84− - :<|> PostNoContent '[JSON] NoContent
85− + :<|> PostNoContent
86− ```
87−
88− i.e. one doesn't need to specify the content-type anymore. There is no content.
89−
90−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
91−
92− You can specify a lenient capture as
93−
94− ```haskell
95− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
96− ```
97−
98− which will make the capture always succeed. Handlers will be of the
99− type `Either String CapturedType`, where `Left err` represents
100− the possible parse failure.
101−
102−- *servant-client* Added a function to create Client.Request in ClientEnv [#1213](https://github.com/haskell-servant/servant/pull/1213) [#1255](https://github.com/haskell-servant/servant/pull/1255)
103−
104− The new member `makeClientRequest` of `ClientEnv` is used to create
105− `http-client` `Request` from `servant-client-core` `Request`.
106− This functionality can be used for example to set
107− dynamic timeouts for each request.
108−
109−### Other changes
110−
111−- *servant-client* *servant-client-core* *servant-http-streams* Fix Verb with headers checking content type differently [#1200](https://github.com/haskell-servant/servant/issues/1200) [#1204](https://github.com/haskell-servant/servant/pull/1204)
112−
113− For `Verb`s with response `Headers`, the implementation didn't check
114− for the content-type of the response. Now it does.
115−
116−- *servant-client* *servant-http-streams* `HasClient` instance for `Stream` with `Headers` [#1170](https://github.com/haskell-servant/servant/issues/1170) [#1197](https://github.com/haskell-servant/servant/pull/1197)
117−- *servant-client* Redact the authorization header in Show and exceptions [#1238](https://github.com/haskell-servant/servant/pull/1238)
118−
119−
120−
121−0.16.0.1
122−--------
123−
124−- Allow `base-compat-0.11`
125−
12640.16
1275----
1286
@@ -267,9 +145,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
267145
268146- *servant-client-core* Add `hoistClient` to `HasClient`.
269147 Just like `hoistServer` allows us to change the monad in which request handlers
270− of a web application live, we also have `hoistClient` for changing the monad
148+ of a web application live in, we also have `hoistClient` for changing the monad
271149 in which *client functions* live.
272− Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
150+ Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
273151 ([#936](https://github.com/haskell-servant/servant/pull/936))
274152
275153- *servant-client* Add more constructors to `RequestBody`, including
servant-client/servant-client.cabal+28−39
@@ -1,6 +1,6 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-client
3−version: 0.19
3+version: 0.16
44
55synopsis: Automatic derivation of querying functions for servant
66category: Servant, Web
@@ -8,20 +8,23 @@ description:
88 This library lets you derive automatically Haskell functions that
99 let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
1010 .
11− See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
11+ See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
1212 .
1313 <https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
1414
15−homepage: http://docs.servant.dev/
15+homepage: http://haskell-servant.readthedocs.org/
1616bug-reports: http://github.com/haskell-servant/servant/issues
17−license: BSD-3-Clause
17+license: BSD3
1818license-file: LICENSE
1919author: Servant Contributors
2020maintainer: haskell-servant-maintainers@googlegroups.com
2121copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
2222build-type: Simple
23−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
24− , GHCJS ==8.6.0.1
23+tested-with:
24+ GHC ==8.0.2
25+ || ==8.2.2
26+ || ==8.4.4
27+ || ==8.6.3
2528
2629extra-source-files:
2730 CHANGELOG.md
@@ -41,14 +44,14 @@ library
4144 -- Bundled with GHC: Lower bound to not force re-installs
4245 -- text and mtl are bundled starting with GHC-8.4
4346 build-depends:
44− base >= 4.9 && < 4.17
45− , bytestring >= 0.10.8.1 && < 0.12
47+ base >= 4.9 && < 4.13
48+ , bytestring >= 0.10.8.1 && < 0.11
4649 , containers >= 0.5.7.1 && < 0.7
4750 , deepseq >= 1.4.2.0 && < 1.5
4851 , mtl >= 2.2.2 && < 2.3
4952 , stm >= 2.4.5.1 && < 2.6
50− , text >= 1.2.3.0 && < 2.1
51− , time >= 1.6.0.1 && < 1.12
53+ , text >= 1.2.3.0 && < 1.3
54+ , time >= 1.6.0.1 && < 1.9
5255 , transformers >= 0.5.2.0 && < 0.6
5356
5457 if !impl(ghc >= 8.2)
@@ -58,22 +61,22 @@ library
5861 -- Servant dependencies.
5962 -- Strict dependency on `servant-client-core` as we re-export things.
6063 build-depends:
61− servant >= 0.18 && < 0.20
62− , servant-client-core >= 0.19 && < 0.19.1
64+ servant == 0.16.*
65+ , servant-client-core >= 0.16 && <0.16.1
6366
6467 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
6568 -- Here can be exceptions if we really need features from the newer versions.
6669 build-depends:
67− base-compat >= 0.10.5 && < 0.13
68− , http-client >= 0.5.13.1 && < 0.8
69− , http-media >= 0.7.1.3 && < 0.9
70+ base-compat >= 0.10.5 && < 0.11
71+ , http-client >= 0.5.13.1 && < 0.7
72+ , http-media >= 0.7.1.3 && < 0.8
7073 , http-types >= 0.12.2 && < 0.13
7174 , exceptions >= 0.10.0 && < 0.11
7275 , kan-extensions >= 5.2 && < 5.3
7376 , monad-control >= 1.0.2.3 && < 1.1
7477 , semigroupoids >= 5.3.1 && < 5.4
7578 , transformers-base >= 0.4.5.2 && < 0.5
76− , transformers-compat >= 0.6.2 && < 0.8
79+ , transformers-compat >= 0.6.2 && < 0.7
7780
7881 hs-source-dirs: src
7982 default-language: Haskell2010
@@ -83,22 +86,11 @@ test-suite spec
8386 type: exitcode-stdio-1.0
8487 ghc-options: -Wall -rtsopts -threaded "-with-rtsopts=-T -N2"
8588 default-language: Haskell2010
86− if impl(ghcjs)
87− buildable: False
8889 hs-source-dirs: test
8990 main-is: Spec.hs
9091 other-modules:
91− Servant.BasicAuthSpec
92− Servant.BrokenSpec
93− Servant.ClientTestUtils
94− Servant.ConnectionErrorSpec
95− Servant.FailSpec
96− Servant.GenAuthSpec
97− Servant.GenericSpec
98− Servant.HoistClientSpec
92+ Servant.ClientSpec
9993 Servant.StreamSpec
100− Servant.SuccessSpec
101− Servant.WrappedApiSpec
10294
10395 -- Dependencies inherited from the library. No need to specify bounds.
10496 build-depends:
@@ -113,7 +105,6 @@ test-suite spec
113105 , kan-extensions
114106 , servant-client
115107 , servant-client-core
116− , sop-core
117108 , stm
118109 , text
119110 , transformers
@@ -121,19 +112,19 @@ test-suite spec
121112 , wai
122113 , warp
123114
124− -- Additional dependencies
115+ -- Additonal dependencies
125116 build-depends:
126117 entropy >= 0.4.1.3 && < 0.5
127− , hspec >= 2.6.0 && < 2.10
118+ , hspec >= 2.6.0 && < 2.8
128119 , HUnit >= 1.6.0.0 && < 1.7
129− , network >= 2.8.0.0 && < 3.2
130− , QuickCheck >= 2.12.6.1 && < 2.15
131− , servant == 0.19.*
132− , servant-server == 0.19.*
120+ , network >= 2.8.0.0 && < 3.1
121+ , QuickCheck >= 2.12.6.1 && < 2.13
122+ , servant == 0.16.*
123+ , servant-server == 0.16.*
133124 , tdigest >= 0.2 && < 0.3
134125
135126 build-tool-depends:
136− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
127+ hspec-discover:hspec-discover >= 2.6.0 && < 2.8
137128
138129test-suite readme
139130 type: exitcode-stdio-1.0
@@ -142,5 +133,3 @@ test-suite readme
142133 build-tool-depends: markdown-unlit:markdown-unlit
143134 ghc-options: -pgmL markdown-unlit
144135 default-language: Haskell2010
145− if impl(ghcjs)
146− buildable: False
servant-client/src/Servant/Client.hs−1
@@ -9,7 +9,6 @@ module Servant.Client
99 , runClientM
1010 , ClientEnv(..)
1111 , mkClientEnv
12− , defaultMakeClientRequest
1312 , hoistClient
1413 , module Servant.Client.Core.Reexport
1514 ) where
servant-client/src/Servant/Client/Internal/HttpClient.hs+23−49
@@ -16,43 +16,41 @@ import Prelude.Compat
1616
1717import Control.Concurrent.MVar
1818 (modifyMVar, newMVar)
19+import qualified Data.ByteString as BS
1920import Control.Concurrent.STM.TVar
2021import Control.Exception
21− (SomeException (..), catch)
2222import Control.Monad
23− (unless)
2423import Control.Monad.Base
2524 (MonadBase (..))
2625import Control.Monad.Catch
27− (MonadCatch, MonadThrow, MonadMask)
26+ (MonadCatch, MonadThrow)
2827import Control.Monad.Error.Class
2928 (MonadError (..))
3029import Control.Monad.IO.Class
31− (MonadIO (..))
30+ (liftIO)
3231import Control.Monad.Reader
33− (MonadReader, ReaderT, ask, runReaderT)
3432import Control.Monad.STM
3533 (STM, atomically)
3634import Control.Monad.Trans.Control
3735 (MonadBaseControl (..))
3836import Control.Monad.Trans.Except
39− (ExceptT, runExceptT)
4037import Data.Bifunctor
4138 (bimap)
42−import qualified Data.ByteString as BS
4339import Data.ByteString.Builder
4440 (toLazyByteString)
4541import qualified Data.ByteString.Lazy as BSL
4642import Data.Either
4743 (either)
4844import Data.Foldable
49− (foldl',toList)
45+ (toList)
5046import Data.Functor.Alt
5147 (Alt (..))
5248import Data.Maybe
5349 (maybe, maybeToList)
5450import Data.Proxy
5551 (Proxy (..))
52+import Data.Semigroup
53+ ((<>))
5654import Data.Sequence
5755 (fromList)
5856import Data.String
@@ -63,34 +61,23 @@ import GHC.Generics
6361import Network.HTTP.Media
6462 (renderHeader)
6563import Network.HTTP.Types
66− (hContentType, renderQuery, statusIsSuccessful, urlEncode, Status)
64+ (hContentType, renderQuery, statusCode)
6765import Servant.Client.Core
6866
67+import qualified Servant.Types.SourceT as S
6968import qualified Network.HTTP.Client as Client
70−import qualified Servant.Types.SourceT as S
7169
7270-- | The environment in which a request is run.
73−-- The 'baseUrl' and 'makeClientRequest' function are used to create a @http-client@ request.
74−-- Cookies are then added to that request if a 'CookieJar' is set on the environment.
75−-- Finally the request is executed with the 'manager'.
76−-- The 'makeClientRequest' function can be used to modify the request to execute and set values which
77−-- are not specified on a @servant@ 'Request' like 'responseTimeout' or 'redirectCount'
7871data ClientEnv
7972 = ClientEnv
8073 { manager :: Client.Manager
8174 , baseUrl :: BaseUrl
8275 , cookieJar :: Maybe (TVar Client.CookieJar)
83− , makeClientRequest :: BaseUrl -> Request -> IO Client.Request
84− -- ^ this function can be used to customize the creation of @http-client@ requests from @servant@ requests. Default value: 'defaultMakeClientRequest'
85− -- Note that:
86− -- 1. 'makeClientRequest' exists to allow overriding operational semantics e.g. 'responseTimeout' per request,
87− -- If you need global modifications, you should use 'managerModifyRequest'
88− -- 2. the 'cookieJar', if defined, is being applied after 'makeClientRequest' is called.
8976 }
9077
9178-- | 'ClientEnv' smart constructor.
9279mkClientEnv :: Client.Manager -> BaseUrl -> ClientEnv
93−mkClientEnv mgr burl = ClientEnv mgr burl Nothing defaultMakeClientRequest
80+mkClientEnv mgr burl = ClientEnv mgr burl Nothing
9481
9582-- | Generates a set of client functions for an API.
9683--
@@ -136,7 +123,7 @@ newtype ClientM a = ClientM
136123 { unClientM :: ReaderT ClientEnv (ExceptT ClientError IO) a }
137124 deriving ( Functor, Applicative, Monad, MonadIO, Generic
138125 , MonadReader ClientEnv, MonadError ClientError, MonadThrow
139− , MonadCatch, MonadMask)
126+ , MonadCatch)
140127
141128instance MonadBase IO ClientM where
142129 liftBase = ClientM . liftBase
@@ -153,16 +140,16 @@ instance Alt ClientM where
153140 a <!> b = a `catchError` \_ -> b
154141
155142instance RunClient ClientM where
156− runRequestAcceptStatus = performRequest
143+ runRequest = performRequest
157144 throwClientError = throwError
158145
159146runClientM :: ClientM a -> ClientEnv -> IO (Either ClientError a)
160147runClientM cm env = runExceptT $ flip runReaderT env $ unClientM cm
161148
162−performRequest :: Maybe [Status] -> Request -> ClientM Response
163−performRequest acceptStatus req = do
164− ClientEnv m burl cookieJar' createClientRequest <- ask
165− clientRequest <- liftIO $ createClientRequest burl req
149+performRequest :: Request -> ClientM Response
150+performRequest req = do
151+ ClientEnv m burl cookieJar' <- ask
152+ let clientRequest = requestToClientRequest burl req
166153 request <- case cookieJar' of
167154 Nothing -> pure clientRequest
168155 Just cj -> liftIO $ do
@@ -171,7 +158,7 @@ performRequest acceptStatus req = do
171158 oldCookieJar <- readTVar cj
172159 let (newRequest, newCookieJar) =
173160 Client.insertCookiesIntoRequest
174− clientRequest
161+ (requestToClientRequest burl req)
175162 oldCookieJar
176163 now
177164 writeTVar cj newCookieJar
@@ -179,12 +166,10 @@ performRequest acceptStatus req = do
179166
180167 response <- maybe (requestWithoutCookieJar m request) (requestWithCookieJar m request) cookieJar'
181168 let status = Client.responseStatus response
169+ status_code = statusCode status
182170 ourResponse = clientResponseToResponse id response
183− goodStatus = case acceptStatus of
184− Nothing -> statusIsSuccessful status
185− Just good -> status `elem` good
186− unless goodStatus $ do
187− throwError $ mkFailureResponse burl req ourResponse
171+ unless (status_code >= 200 && status_code < 300) $
172+ throwError $ mkFailureResponse burl req ourResponse
188173 return ourResponse
189174 where
190175 requestWithoutCookieJar :: Client.Manager -> Client.Request -> ClientM (Client.Response BSL.ByteString)
@@ -226,18 +211,15 @@ clientResponseToResponse f r = Response
226211 , responseHttpVersion = Client.responseVersion r
227212 }
228213
229−-- | Create a @http-client@ 'Client.Request' from a @servant@ 'Request'
230−-- The 'Client.host', 'Client.path' and 'Client.port' fields are extracted from the 'BaseUrl'
231−-- otherwise the body, headers and query string are derived from the @servant@ 'Request'
232−defaultMakeClientRequest :: BaseUrl -> Request -> IO Client.Request
233−defaultMakeClientRequest burl r = return Client.defaultRequest
214+requestToClientRequest :: BaseUrl -> Request -> Client.Request
215+requestToClientRequest burl r = Client.defaultRequest
234216 { Client.method = requestMethod r
235217 , Client.host = fromString $ baseUrlHost burl
236218 , Client.port = baseUrlPort burl
237219 , Client.path = BSL.toStrict
238220 $ fromString (baseUrlPath burl)
239221 <> toLazyByteString (requestPath r)
240− , Client.queryString = buildQueryString . toList $ requestQueryString r
222+ , Client.queryString = renderQuery True . toList $ requestQueryString r
241223 , Client.requestHeaders =
242224 maybeToList acceptHdr ++ maybeToList contentTypeHdr ++ headers
243225 , Client.requestBody = body
@@ -246,7 +228,7 @@ defaultMakeClientRequest burl r = return Client.defaultRequest
246228 where
247229 -- Content-Type and Accept are specified by requestBody and requestAccept
248230 headers = filter (\(h, _) -> h /= "Accept" && h /= "Content-Type") $
249− toList $ requestHeaders r
231+ toList $requestHeaders r
250232
251233 acceptHdr
252234 | null hs = Nothing
@@ -288,14 +270,6 @@ defaultMakeClientRequest burl r = return Client.defaultRequest
288270 Http -> False
289271 Https -> True
290272
291− -- Query string builder which does not do any encoding
292− buildQueryString [] = mempty
293− buildQueryString qps = "?" <> foldl' addQueryParam mempty qps
294−
295− addQueryParam qs (k, v) =
296− qs <> (if BS.null qs then mempty else "&") <> urlEncode True k <> foldMap ("=" <>) v
297−
298−
299273catchConnectionError :: IO a -> IO (Either ClientError a)
300274catchConnectionError action =
301275 catch (Right <$> action) $ \e ->
servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+15−18
@@ -12,7 +12,7 @@ module Servant.Client.Internal.HttpClient.Streaming (
1212 ClientEnv (..),
1313 mkClientEnv,
1414 clientResponseToResponse,
15− defaultMakeClientRequest,
15+ requestToClientRequest,
1616 catchConnectionError,
1717 ) where
1818
@@ -47,7 +47,7 @@ import Data.Time.Clock
4747 (getCurrentTime)
4848import GHC.Generics
4949import Network.HTTP.Types
50− (Status, statusIsSuccessful)
50+ (statusCode)
5151
5252import qualified Network.HTTP.Client as Client
5353
@@ -55,7 +55,7 @@ import Servant.Client.Core
5555import Servant.Client.Internal.HttpClient
5656 (ClientEnv (..), catchConnectionError,
5757 clientResponseToResponse, mkClientEnv, mkFailureResponse,
58− defaultMakeClientRequest)
58+ requestToClientRequest)
5959import qualified Servant.Types.SourceT as S
6060
6161
@@ -112,7 +112,7 @@ instance Alt ClientM where
112112 a <!> b = a `catchError` \_ -> b
113113
114114instance RunClient ClientM where
115− runRequestAcceptStatus = performRequest
115+ runRequest = performRequest
116116 throwClientError = throwError
117117
118118instance RunStreamingClient ClientM where
@@ -130,17 +130,17 @@ withClientM cm env k =
130130-- streaming response types ('SourceT', 'Conduit', pipes 'Proxy' or 'Machine').
131131-- For those you have to use 'withClientM'.
132132--
133−-- /Note:/ we 'force' the result, so the likelihood of accidentally leaking a
133+-- /Note:/ we 'force' the result, so the likehood of accidentally leaking a
134134-- connection is smaller. Use with care.
135135--
136136runClientM :: NFData a => ClientM a -> ClientEnv -> IO (Either ClientError a)
137137runClientM cm env = withClientM cm env (evaluate . force)
138138
139−performRequest :: Maybe [Status] -> Request -> ClientM Response
140−performRequest acceptStatus req = do
139+performRequest :: Request -> ClientM Response
140+performRequest req = do
141141 -- TODO: should use Client.withResponse here too
142− ClientEnv m burl cookieJar' createClientRequest <- ask
143− clientRequest <- liftIO $ createClientRequest burl req
142+ ClientEnv m burl cookieJar' <- ask
143+ let clientRequest = requestToClientRequest burl req
144144 request <- case cookieJar' of
145145 Nothing -> pure clientRequest
146146 Just cj -> liftIO $ do
@@ -149,7 +149,7 @@ performRequest acceptStatus req = do
149149 oldCookieJar <- readTVar cj
150150 let (newRequest, newCookieJar) =
151151 Client.insertCookiesIntoRequest
152− clientRequest
152+ (requestToClientRequest burl req)
153153 oldCookieJar
154154 now
155155 writeTVar cj newCookieJar
@@ -163,27 +163,24 @@ performRequest acceptStatus req = do
163163 now' <- getCurrentTime
164164 atomically $ modifyTVar' cj (fst . Client.updateCookieJar response request now')
165165 let status = Client.responseStatus response
166+ status_code = statusCode status
166167 ourResponse = clientResponseToResponse id response
167− goodStatus = case acceptStatus of
168− Nothing -> statusIsSuccessful status
169− Just good -> status `elem` good
170− unless goodStatus $ do
168+ unless (status_code >= 200 && status_code < 300) $
171169 throwError $ mkFailureResponse burl req ourResponse
172170 return ourResponse
173171
174−-- | TODO: support UVerb ('acceptStatus' argument, like in 'performRequest' above).
175172performWithStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a
176173performWithStreamingRequest req k = do
177174 m <- asks manager
178175 burl <- asks baseUrl
179− createClientRequest <- asks makeClientRequest
180− request <- liftIO $ createClientRequest burl req
176+ let request = requestToClientRequest burl req
181177 ClientM $ lift $ lift $ Codensity $ \k1 ->
182178 Client.withResponse request m $ \res -> do
183179 let status = Client.responseStatus res
180+ status_code = statusCode status
184181
185182 -- we throw FailureResponse in IO :(
186− unless (statusIsSuccessful status) $ do
183+ unless (status_code >= 200 && status_code < 300) $ do
187184 b <- BSL.fromChunks <$> Client.brConsume (Client.responseBody res)
188185 throwIO $ mkFailureResponse burl req (clientResponseToResponse (const b) res)
189186
servant-client/src/Servant/Client/Streaming.hs−1
@@ -10,7 +10,6 @@ module Servant.Client.Streaming
1010 , runClientM
1111 , ClientEnv(..)
1212 , mkClientEnv
13− , defaultMakeClientRequest
1413 , hoistClient
1514 , module Servant.Client.Core.Reexport
1615 ) where
servant-client/test/Servant/BasicAuthSpec.hsdeleted−53
@@ -1,53 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# OPTIONS_GHC -freduction-depth=100 #-}
15−{-# OPTIONS_GHC -fno-warn-orphans #-}
16−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
17−
18−module Servant.BasicAuthSpec (spec) where
19−
20−import Prelude ()
21−import Prelude.Compat
22−
23−import Control.Arrow
24− (left)
25−import Data.Monoid ()
26−import qualified Network.HTTP.Types as HTTP
27−import Test.Hspec
28−
29−import Servant.API
30− (BasicAuthData (..))
31−import Servant.Client
32−import Servant.ClientTestUtils
33−
34−spec :: Spec
35−spec = describe "Servant.BasicAuthSpec" $ do
36− basicAuthSpec
37−
38−basicAuthSpec :: Spec
39−basicAuthSpec = beforeAll (startWaiApp basicAuthServer) $ afterAll endWaiApp $ do
40− context "Authentication works when requests are properly authenticated" $ do
41−
42− it "Authenticates a BasicAuth protected server appropriately" $ \(_,baseUrl) -> do
43− let getBasic = client basicAuthAPI
44− let basicAuthData = BasicAuthData "servant" "server"
45− left show <$> runClient (getBasic basicAuthData) baseUrl `shouldReturn` Right alice
46−
47− context "Authentication is rejected when requests are not authenticated properly" $ do
48−
49− it "Authenticates a BasicAuth protected server appropriately" $ \(_,baseUrl) -> do
50− let getBasic = client basicAuthAPI
51− let basicAuthData = BasicAuthData "not" "password"
52− Left (FailureResponse _ r) <- runClient (getBasic basicAuthData) baseUrl
53− responseStatusCode r `shouldBe` HTTP.Status 403 "Forbidden"
servant-client/test/Servant/BrokenSpec.hsdeleted−71
@@ -1,71 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE TypeOperators #-}
3−{-# OPTIONS_GHC -freduction-depth=100 #-}
4−{-# OPTIONS_GHC -fno-warn-orphans #-}
5−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
6−
7−module Servant.BrokenSpec (spec) where
8−
9−import Prelude ()
10−import Prelude.Compat
11−
12−import Data.Monoid ()
13−import Data.Proxy
14−import qualified Network.HTTP.Types as HTTP
15−import Test.Hspec
16−
17−import Servant.API
18− ((:<|>) ((:<|>)), (:>), JSON, Verb, Get, StdMethod (GET))
19−import Servant.Client
20−import Servant.ClientTestUtils
21−import Servant.Server
22−
23−-- * api for testing inconsistencies between client and server
24−
25−type Get201 = Verb 'GET 201
26−type Get301 = Verb 'GET 301
27−
28−type BrokenAPI =
29− -- the server should respond with 200, but returns 201
30− "get200" :> Get201 '[JSON] ()
31− -- the server should respond with 307, but returns 301
32− :<|> "get307" :> Get301 '[JSON] ()
33−
34−brokenApi :: Proxy BrokenAPI
35−brokenApi = Proxy
36−
37−brokenServer :: Application
38−brokenServer = serve brokenApi (pure () :<|> pure ())
39−
40−type PublicAPI =
41− -- the client expects 200
42− "get200" :> Get '[JSON] ()
43− -- the client expects 307
44− :<|> "get307" :> Get307 '[JSON] ()
45−
46−publicApi :: Proxy PublicAPI
47−publicApi = Proxy
48−
49−get200Client :: ClientM ()
50−get307Client :: ClientM ()
51−get200Client :<|> get307Client = client publicApi
52−
53−
54−spec :: Spec
55−spec = describe "Servant.BrokenSpec" $ do
56− brokenSpec
57−
58−brokenSpec :: Spec
59−brokenSpec = beforeAll (startWaiApp brokenServer) $ afterAll endWaiApp $ do
60− context "client returns errors for inconsistencies between client and server api" $ do
61− it "reports FailureResponse with wrong 2xx status code" $ \(_, baseUrl) -> do
62− res <- runClient get200Client baseUrl
63− case res of
64− Left (FailureResponse _ r) | responseStatusCode r == HTTP.status201 -> return ()
65− _ -> fail $ "expected 201 broken response, but got " <> show res
66−
67− it "reports FailureResponse with wrong 3xx status code" $ \(_, baseUrl) -> do
68− res <- runClient get307Client baseUrl
69− case res of
70− Left (FailureResponse _ r) | responseStatusCode r == HTTP.status301 -> return ()
71− _ -> fail $ "expected 301 broken response, but got " <> show res
servant-client/test/Servant/ClientSpec.hsnew file+514
@@ -0,0 +1,514 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE DeriveGeneric #-}
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE FunctionalDependencies #-}
8+{-# LANGUAGE GADTs #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE OverloadedStrings #-}
11+{-# LANGUAGE PolyKinds #-}
12+{-# LANGUAGE RecordWildCards #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TypeApplications #-}
16+{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE TypeOperators #-}
18+{-# LANGUAGE UndecidableInstances #-}
19+{-# OPTIONS_GHC -freduction-depth=100 #-}
20+{-# OPTIONS_GHC -fno-warn-orphans #-}
21+{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
22+
23+module Servant.ClientSpec (spec, Person(..), startWaiApp, endWaiApp) where
24+
25+import Prelude ()
26+import Prelude.Compat
27+
28+import Control.Arrow
29+ (left)
30+import Control.Concurrent
31+ (ThreadId, forkIO, killThread)
32+import Control.Concurrent.STM
33+ (atomically)
34+import Control.Concurrent.STM.TVar
35+ (newTVar, readTVar)
36+import Control.Exception
37+ (bracket, fromException)
38+import Control.Monad.Error.Class
39+ (throwError)
40+import Data.Aeson
41+import Data.Char
42+ (chr, isPrint)
43+import Data.Foldable
44+ (forM_, toList)
45+import Data.Maybe
46+ (isJust, listToMaybe)
47+import Data.Monoid ()
48+import Data.Proxy
49+import Data.Semigroup
50+ ((<>))
51+import GHC.Generics
52+ (Generic)
53+import qualified Network.HTTP.Client as C
54+import qualified Network.HTTP.Types as HTTP
55+import Network.Socket
56+import qualified Network.Wai as Wai
57+import Network.Wai.Handler.Warp
58+import System.IO.Unsafe
59+ (unsafePerformIO)
60+import Test.Hspec
61+import Test.Hspec.QuickCheck
62+import Test.HUnit
63+import Test.QuickCheck
64+import Web.FormUrlEncoded
65+ (FromForm, ToForm)
66+
67+import Servant.API
68+ ((:<|>) ((:<|>)), (:>), AuthProtect, BasicAuth,
69+ BasicAuthData (..), Capture, CaptureAll, Delete,
70+ DeleteNoContent, EmptyAPI, FormUrlEncoded, Get, Header,
71+ Headers, JSON, NoContent (NoContent), Post, Put, QueryFlag,
72+ QueryParam, QueryParams, Raw, ReqBody, addHeader, getHeaders)
73+import Servant.Client
74+import qualified Servant.Client.Core.Auth as Auth
75+import qualified Servant.Client.Core.Request as Req
76+import Servant.Server
77+import Servant.Server.Experimental.Auth
78+import Servant.Test.ComprehensiveAPI
79+
80+-- This declaration simply checks that all instances are in place.
81+_ = client comprehensiveAPIWithoutStreaming
82+
83+spec :: Spec
84+spec = describe "Servant.Client" $ do
85+ sucessSpec
86+ failSpec
87+ wrappedApiSpec
88+ basicAuthSpec
89+ genAuthSpec
90+ hoistClientSpec
91+ connectionErrorSpec
92+
93+-- * test data types
94+
95+data Person = Person
96+ { _name :: String
97+ , _age :: Integer
98+ } deriving (Eq, Show, Generic)
99+
100+instance ToJSON Person
101+instance FromJSON Person
102+
103+instance ToForm Person
104+instance FromForm Person
105+
106+instance Arbitrary Person where
107+ arbitrary = Person <$> arbitrary <*> arbitrary
108+
109+alice :: Person
110+alice = Person "Alice" 42
111+
112+carol :: Person
113+carol = Person "Carol" 17
114+
115+type TestHeaders = '[Header "X-Example1" Int, Header "X-Example2" String]
116+
117+type Api =
118+ Get '[JSON] Person
119+ :<|> "get" :> Get '[JSON] Person
120+ :<|> "deleteEmpty" :> DeleteNoContent '[JSON] NoContent
121+ :<|> "capture" :> Capture "name" String :> Get '[JSON,FormUrlEncoded] Person
122+ :<|> "captureAll" :> CaptureAll "names" String :> Get '[JSON] [Person]
123+ :<|> "body" :> ReqBody '[FormUrlEncoded,JSON] Person :> Post '[JSON] Person
124+ :<|> "param" :> QueryParam "name" String :> Get '[FormUrlEncoded,JSON] Person
125+ :<|> "params" :> QueryParams "names" String :> Get '[JSON] [Person]
126+ :<|> "flag" :> QueryFlag "flag" :> Get '[JSON] Bool
127+ :<|> "rawSuccess" :> Raw
128+ :<|> "rawFailure" :> Raw
129+ :<|> "multiple" :>
130+ Capture "first" String :>
131+ QueryParam "second" Int :>
132+ QueryFlag "third" :>
133+ ReqBody '[JSON] [(String, [Rational])] :>
134+ Get '[JSON] (String, Maybe Int, Bool, [(String, [Rational])])
135+ :<|> "headers" :> Get '[JSON] (Headers TestHeaders Bool)
136+ :<|> "deleteContentType" :> DeleteNoContent '[JSON] NoContent
137+ :<|> "redirectWithCookie" :> Raw
138+ :<|> "empty" :> EmptyAPI
139+
140+api :: Proxy Api
141+api = Proxy
142+
143+getRoot :: ClientM Person
144+getGet :: ClientM Person
145+getDeleteEmpty :: ClientM NoContent
146+getCapture :: String -> ClientM Person
147+getCaptureAll :: [String] -> ClientM [Person]
148+getBody :: Person -> ClientM Person
149+getQueryParam :: Maybe String -> ClientM Person
150+getQueryParams :: [String] -> ClientM [Person]
151+getQueryFlag :: Bool -> ClientM Bool
152+getRawSuccess :: HTTP.Method -> ClientM Response
153+getRawFailure :: HTTP.Method -> ClientM Response
154+getMultiple :: String -> Maybe Int -> Bool -> [(String, [Rational])]
155+ -> ClientM (String, Maybe Int, Bool, [(String, [Rational])])
156+getRespHeaders :: ClientM (Headers TestHeaders Bool)
157+getDeleteContentType :: ClientM NoContent
158+getRedirectWithCookie :: HTTP.Method -> ClientM Response
159+
160+getRoot
161+ :<|> getGet
162+ :<|> getDeleteEmpty
163+ :<|> getCapture
164+ :<|> getCaptureAll
165+ :<|> getBody
166+ :<|> getQueryParam
167+ :<|> getQueryParams
168+ :<|> getQueryFlag
169+ :<|> getRawSuccess
170+ :<|> getRawFailure
171+ :<|> getMultiple
172+ :<|> getRespHeaders
173+ :<|> getDeleteContentType
174+ :<|> getRedirectWithCookie
175+ :<|> EmptyClient = client api
176+
177+server :: Application
178+server = serve api (
179+ return carol
180+ :<|> return alice
181+ :<|> return NoContent
182+ :<|> (\ name -> return $ Person name 0)
183+ :<|> (\ names -> return (zipWith Person names [0..]))
184+ :<|> return
185+ :<|> (\ name -> case name of
186+ Just "alice" -> return alice
187+ Just n -> throwError $ ServerError 400 (n ++ " not found") "" []
188+ Nothing -> throwError $ ServerError 400 "missing parameter" "" [])
189+ :<|> (\ names -> return (zipWith Person names [0..]))
190+ :<|> return
191+ :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.ok200 [] "rawSuccess")
192+ :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.badRequest400 [] "rawFailure")
193+ :<|> (\ a b c d -> return (a, b, c, d))
194+ :<|> (return $ addHeader 1729 $ addHeader "eg2" True)
195+ :<|> return NoContent
196+ :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.found302 [("Location", "testlocation"), ("Set-Cookie", "testcookie=test")] "")
197+ :<|> emptyServer)
198+
199+type FailApi =
200+ "get" :> Raw
201+ :<|> "capture" :> Capture "name" String :> Raw
202+ :<|> "body" :> Raw
203+failApi :: Proxy FailApi
204+failApi = Proxy
205+
206+failServer :: Application
207+failServer = serve failApi (
208+ (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.ok200 [] "")
209+ :<|> (\ _capture -> Tagged $ \_request respond -> respond $ Wai.responseLBS HTTP.ok200 [("content-type", "application/json")] "")
210+ :<|> (Tagged $ \_request respond -> respond $ Wai.responseLBS HTTP.ok200 [("content-type", "fooooo")] "")
211+ )
212+
213+-- * basic auth stuff
214+
215+type BasicAuthAPI =
216+ BasicAuth "foo-realm" () :> "private" :> "basic" :> Get '[JSON] Person
217+
218+basicAuthAPI :: Proxy BasicAuthAPI
219+basicAuthAPI = Proxy
220+
221+basicAuthHandler :: BasicAuthCheck ()
222+basicAuthHandler =
223+ let check (BasicAuthData username password) =
224+ if username == "servant" && password == "server"
225+ then return (Authorized ())
226+ else return Unauthorized
227+ in BasicAuthCheck check
228+
229+basicServerContext :: Context '[ BasicAuthCheck () ]
230+basicServerContext = basicAuthHandler :. EmptyContext
231+
232+basicAuthServer :: Application
233+basicAuthServer = serveWithContext basicAuthAPI basicServerContext (const (return alice))
234+
235+-- * general auth stuff
236+
237+type GenAuthAPI =
238+ AuthProtect "auth-tag" :> "private" :> "auth" :> Get '[JSON] Person
239+
240+genAuthAPI :: Proxy GenAuthAPI
241+genAuthAPI = Proxy
242+
243+type instance AuthServerData (AuthProtect "auth-tag") = ()
244+type instance Auth.AuthClientData (AuthProtect "auth-tag") = ()
245+
246+genAuthHandler :: AuthHandler Wai.Request ()
247+genAuthHandler =
248+ let handler req = case lookup "AuthHeader" (Wai.requestHeaders req) of
249+ Nothing -> throwError (err401 { errBody = "Missing auth header" })
250+ Just _ -> return ()
251+ in mkAuthHandler handler
252+
253+genAuthServerContext :: Context '[ AuthHandler Wai.Request () ]
254+genAuthServerContext = genAuthHandler :. EmptyContext
255+
256+genAuthServer :: Application
257+genAuthServer = serveWithContext genAuthAPI genAuthServerContext (const (return alice))
258+
259+{-# NOINLINE manager' #-}
260+manager' :: C.Manager
261+manager' = unsafePerformIO $ C.newManager C.defaultManagerSettings
262+
263+runClient :: ClientM a -> BaseUrl -> IO (Either ClientError a)
264+runClient x baseUrl' = runClientM x (mkClientEnv manager' baseUrl')
265+
266+sucessSpec :: Spec
267+sucessSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
268+ it "Servant.API.Get root" $ \(_, baseUrl) -> do
269+ left show <$> runClient getRoot baseUrl `shouldReturn` Right carol
270+
271+ it "Servant.API.Get" $ \(_, baseUrl) -> do
272+ left show <$> runClient getGet baseUrl `shouldReturn` Right alice
273+
274+ describe "Servant.API.Delete" $ do
275+ it "allows empty content type" $ \(_, baseUrl) -> do
276+ left show <$> runClient getDeleteEmpty baseUrl `shouldReturn` Right NoContent
277+
278+ it "allows content type" $ \(_, baseUrl) -> do
279+ left show <$> runClient getDeleteContentType baseUrl `shouldReturn` Right NoContent
280+
281+ it "Servant.API.Capture" $ \(_, baseUrl) -> do
282+ left show <$> runClient (getCapture "Paula") baseUrl `shouldReturn` Right (Person "Paula" 0)
283+
284+ it "Servant.API.CaptureAll" $ \(_, baseUrl) -> do
285+ let expected = [(Person "Paula" 0), (Person "Peta" 1)]
286+ left show <$> runClient (getCaptureAll ["Paula", "Peta"]) baseUrl `shouldReturn` Right expected
287+
288+ it "Servant.API.ReqBody" $ \(_, baseUrl) -> do
289+ let p = Person "Clara" 42
290+ left show <$> runClient (getBody p) baseUrl `shouldReturn` Right p
291+
292+ it "Servant.API FailureResponse" $ \(_, baseUrl) -> do
293+ left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
294+ Left (FailureResponse req _) <- runClient (getQueryParam (Just "bob")) baseUrl
295+ Req.requestPath req `shouldBe` (baseUrl, "/param")
296+ toList (Req.requestQueryString req) `shouldBe` [("name", Just "bob")]
297+ Req.requestMethod req `shouldBe` HTTP.methodGet
298+
299+ it "Servant.API.QueryParam" $ \(_, baseUrl) -> do
300+ left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
301+ Left (FailureResponse _ r) <- runClient (getQueryParam (Just "bob")) baseUrl
302+ responseStatusCode r `shouldBe` HTTP.Status 400 "bob not found"
303+
304+ it "Servant.API.QueryParam.QueryParams" $ \(_, baseUrl) -> do
305+ left show <$> runClient (getQueryParams []) baseUrl `shouldReturn` Right []
306+ left show <$> runClient (getQueryParams ["alice", "bob"]) baseUrl
307+ `shouldReturn` Right [Person "alice" 0, Person "bob" 1]
308+
309+ context "Servant.API.QueryParam.QueryFlag" $
310+ forM_ [False, True] $ \ flag -> it (show flag) $ \(_, baseUrl) -> do
311+ left show <$> runClient (getQueryFlag flag) baseUrl `shouldReturn` Right flag
312+
313+ it "Servant.API.Raw on success" $ \(_, baseUrl) -> do
314+ res <- runClient (getRawSuccess HTTP.methodGet) baseUrl
315+ case res of
316+ Left e -> assertFailure $ show e
317+ Right r -> do
318+ responseStatusCode r `shouldBe` HTTP.status200
319+ responseBody r `shouldBe` "rawSuccess"
320+
321+ it "Servant.API.Raw should return a Left in case of failure" $ \(_, baseUrl) -> do
322+ res <- runClient (getRawFailure HTTP.methodGet) baseUrl
323+ case res of
324+ Right _ -> assertFailure "expected Left, but got Right"
325+ Left (FailureResponse _ r) -> do
326+ responseStatusCode r `shouldBe` HTTP.status400
327+ responseBody r `shouldBe` "rawFailure"
328+ Left e -> assertFailure $ "expected FailureResponse, but got " ++ show e
329+
330+ it "Returns headers appropriately" $ \(_, baseUrl) -> do
331+ res <- runClient getRespHeaders baseUrl
332+ case res of
333+ Left e -> assertFailure $ show e
334+ Right val -> getHeaders val `shouldBe` [("X-Example1", "1729"), ("X-Example2", "eg2")]
335+
336+ it "Stores Cookie in CookieJar after a redirect" $ \(_, baseUrl) -> do
337+ mgr <- C.newManager C.defaultManagerSettings
338+ cj <- atomically . newTVar $ C.createCookieJar []
339+ _ <- runClientM (getRedirectWithCookie HTTP.methodGet) (ClientEnv mgr baseUrl (Just cj))
340+ cookie <- listToMaybe . C.destroyCookieJar <$> atomically (readTVar cj)
341+ C.cookie_name <$> cookie `shouldBe` Just "testcookie"
342+ C.cookie_value <$> cookie `shouldBe` Just "test"
343+
344+ modifyMaxSuccess (const 20) $ do
345+ it "works for a combination of Capture, QueryParam, QueryFlag and ReqBody" $ \(_, baseUrl) ->
346+ property $ forAllShrink pathGen shrink $ \(NonEmpty cap) num flag body ->
347+ ioProperty $ do
348+ result <- left show <$> runClient (getMultiple cap num flag body) baseUrl
349+ return $
350+ result === Right (cap, num, flag, body)
351+
352+
353+wrappedApiSpec :: Spec
354+wrappedApiSpec = describe "error status codes" $ do
355+ let serveW api = serve api $ throwError $ ServerError 500 "error message" "" []
356+ context "are correctly handled by the client" $
357+ let test :: (WrappedApi, String) -> Spec
358+ test (WrappedApi api, desc) =
359+ it desc $ bracket (startWaiApp $ serveW api) endWaiApp $ \(_, baseUrl) -> do
360+ let getResponse :: ClientM ()
361+ getResponse = client api
362+ Left (FailureResponse _ r) <- runClient getResponse baseUrl
363+ responseStatusCode r `shouldBe` (HTTP.Status 500 "error message")
364+ in mapM_ test $
365+ (WrappedApi (Proxy :: Proxy (Delete '[JSON] ())), "Delete") :
366+ (WrappedApi (Proxy :: Proxy (Get '[JSON] ())), "Get") :
367+ (WrappedApi (Proxy :: Proxy (Post '[JSON] ())), "Post") :
368+ (WrappedApi (Proxy :: Proxy (Put '[JSON] ())), "Put") :
369+ []
370+
371+failSpec :: Spec
372+failSpec = beforeAll (startWaiApp failServer) $ afterAll endWaiApp $ do
373+
374+ context "client returns errors appropriately" $ do
375+ it "reports FailureResponse" $ \(_, baseUrl) -> do
376+ let (_ :<|> _ :<|> getDeleteEmpty :<|> _) = client api
377+ Left res <- runClient getDeleteEmpty baseUrl
378+ case res of
379+ FailureResponse _ r | responseStatusCode r == HTTP.status404 -> return ()
380+ _ -> fail $ "expected 404 response, but got " <> show res
381+
382+ it "reports DecodeFailure" $ \(_, baseUrl) -> do
383+ let (_ :<|> _ :<|> _ :<|> getCapture :<|> _) = client api
384+ Left res <- runClient (getCapture "foo") baseUrl
385+ case res of
386+ DecodeFailure _ _ -> return ()
387+ _ -> fail $ "expected DecodeFailure, but got " <> show res
388+
389+ it "reports ConnectionError" $ \_ -> do
390+ let (getGetWrongHost :<|> _) = client api
391+ Left res <- runClient getGetWrongHost (BaseUrl Http "127.0.0.1" 19872 "")
392+ case res of
393+ ConnectionError _ -> return ()
394+ _ -> fail $ "expected ConnectionError, but got " <> show res
395+
396+ it "reports UnsupportedContentType" $ \(_, baseUrl) -> do
397+ let (_ :<|> getGet :<|> _ ) = client api
398+ Left res <- runClient getGet baseUrl
399+ case res of
400+ UnsupportedContentType ("application/octet-stream") _ -> return ()
401+ _ -> fail $ "expected UnsupportedContentType, but got " <> show res
402+
403+ it "reports InvalidContentTypeHeader" $ \(_, baseUrl) -> do
404+ let (_ :<|> _ :<|> _ :<|> _ :<|> _ :<|> getBody :<|> _) = client api
405+ Left res <- runClient (getBody alice) baseUrl
406+ case res of
407+ InvalidContentTypeHeader _ -> return ()
408+ _ -> fail $ "expected InvalidContentTypeHeader, but got " <> show res
409+
410+data WrappedApi where
411+ WrappedApi :: (HasServer (api :: *) '[], Server api ~ Handler a,
412+ HasClient ClientM api, Client ClientM api ~ ClientM ()) =>
413+ Proxy api -> WrappedApi
414+
415+basicAuthSpec :: Spec
416+basicAuthSpec = beforeAll (startWaiApp basicAuthServer) $ afterAll endWaiApp $ do
417+ context "Authentication works when requests are properly authenticated" $ do
418+
419+ it "Authenticates a BasicAuth protected server appropriately" $ \(_,baseUrl) -> do
420+ let getBasic = client basicAuthAPI
421+ let basicAuthData = BasicAuthData "servant" "server"
422+ left show <$> runClient (getBasic basicAuthData) baseUrl `shouldReturn` Right alice
423+
424+ context "Authentication is rejected when requests are not authenticated properly" $ do
425+
426+ it "Authenticates a BasicAuth protected server appropriately" $ \(_,baseUrl) -> do
427+ let getBasic = client basicAuthAPI
428+ let basicAuthData = BasicAuthData "not" "password"
429+ Left (FailureResponse _ r) <- runClient (getBasic basicAuthData) baseUrl
430+ responseStatusCode r `shouldBe` HTTP.Status 403 "Forbidden"
431+
432+genAuthSpec :: Spec
433+genAuthSpec = beforeAll (startWaiApp genAuthServer) $ afterAll endWaiApp $ do
434+ context "Authentication works when requests are properly authenticated" $ do
435+
436+ it "Authenticates a AuthProtect protected server appropriately" $ \(_, baseUrl) -> do
437+ let getProtected = client genAuthAPI
438+ let authRequest = Auth.mkAuthenticatedRequest () (\_ req -> Req.addHeader "AuthHeader" ("cool" :: String) req)
439+ left show <$> runClient (getProtected authRequest) baseUrl `shouldReturn` Right alice
440+
441+ context "Authentication is rejected when requests are not authenticated properly" $ do
442+
443+ it "Authenticates a AuthProtect protected server appropriately" $ \(_, baseUrl) -> do
444+ let getProtected = client genAuthAPI
445+ let authRequest = Auth.mkAuthenticatedRequest () (\_ req -> Req.addHeader "Wrong" ("header" :: String) req)
446+ Left (FailureResponse _ r) <- runClient (getProtected authRequest) baseUrl
447+ responseStatusCode r `shouldBe` (HTTP.Status 401 "Unauthorized")
448+
449+-- * hoistClient
450+
451+type HoistClientAPI = Get '[JSON] Int :<|> Capture "n" Int :> Post '[JSON] Int
452+
453+hoistClientAPI :: Proxy HoistClientAPI
454+hoistClientAPI = Proxy
455+
456+hoistClientServer :: Application -- implements HoistClientAPI
457+hoistClientServer = serve hoistClientAPI $ return 5 :<|> (\n -> return n)
458+
459+hoistClientSpec :: Spec
460+hoistClientSpec = beforeAll (startWaiApp hoistClientServer) $ afterAll endWaiApp $ do
461+ describe "Servant.Client.hoistClient" $ do
462+ it "allows us to GET/POST/... requests in IO instead of ClientM" $ \(_, baseUrl) -> do
463+ let (getInt :<|> postInt)
464+ = hoistClient hoistClientAPI
465+ (fmap (either (error . show) id) . flip runClient baseUrl)
466+ (client hoistClientAPI)
467+
468+ getInt `shouldReturn` 5
469+ postInt 5 `shouldReturn` 5
470+
471+-- * ConnectionError
472+type ConnectionErrorAPI = Get '[JSON] Int
473+
474+connectionErrorAPI :: Proxy ConnectionErrorAPI
475+connectionErrorAPI = Proxy
476+
477+connectionErrorSpec :: Spec
478+connectionErrorSpec = describe "Servant.Client.ClientError" $
479+ it "correctly catches ConnectionErrors when the HTTP request can't go through" $ do
480+ let getInt = client connectionErrorAPI
481+ let baseUrl' = BaseUrl Http "example.invalid" 80 ""
482+ let isHttpError (Left (ConnectionError e)) = isJust $ fromException @C.HttpException e
483+ isHttpError _ = False
484+ (isHttpError <$> runClient getInt baseUrl') `shouldReturn` True
485+
486+-- * utils
487+
488+startWaiApp :: Application -> IO (ThreadId, BaseUrl)
489+startWaiApp app = do
490+ (port, socket) <- openTestSocket
491+ let settings = setPort port $ defaultSettings
492+ thread <- forkIO $ runSettingsSocket settings socket app
493+ return (thread, BaseUrl Http "localhost" port "")
494+
495+
496+endWaiApp :: (ThreadId, BaseUrl) -> IO ()
497+endWaiApp (thread, _) = killThread thread
498+
499+openTestSocket :: IO (Port, Socket)
500+openTestSocket = do
501+ s <- socket AF_INET Stream defaultProtocol
502+ let localhost = tupleToHostAddress (127, 0, 0, 1)
503+ bind s (SockAddrInet defaultPort localhost)
504+ listen s 1
505+ port <- socketPort s
506+ return (fromIntegral port, s)
507+
508+pathGen :: Gen (NonEmptyList Char)
509+pathGen = fmap NonEmpty path
510+ where
511+ path = listOf1 $ elements $
512+ filter (not . (`elem` ("?%[]/#;" :: String))) $
513+ filter isPrint $
514+ map chr [0..127]
servant-client/test/Servant/ClientTestUtils.hsdeleted−384
@@ -1,384 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE FlexibleContexts #-}
6−{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE GADTs #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeApplications #-}
13−{-# LANGUAGE TypeFamilies #-}
14−{-# LANGUAGE TypeOperators #-}
15−{-# LANGUAGE UndecidableInstances #-}
16−{-# OPTIONS_GHC -freduction-depth=100 #-}
17−{-# OPTIONS_GHC -fno-warn-orphans #-}
18−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
19−
20−module Servant.ClientTestUtils where
21−
22−import Prelude ()
23−import Prelude.Compat
24−
25−import Control.Concurrent
26− (ThreadId, forkIO, killThread)
27−import Control.Monad
28− (join)
29−import Control.Monad.Error.Class
30− (throwError)
31−import Data.Aeson
32−import Data.ByteString
33− (ByteString)
34−import Data.ByteString.Builder
35− (byteString)
36−import qualified Data.ByteString.Lazy as LazyByteString
37−import Data.Char
38− (chr, isPrint)
39−import Data.Monoid ()
40−import Data.Proxy
41−import Data.SOP
42−import Data.Text
43− (Text)
44−import qualified Data.Text as Text
45−import Data.Text.Encoding
46− (decodeUtf8, encodeUtf8)
47−import GHC.Generics
48− (Generic)
49−import qualified Network.HTTP.Client as C
50−import qualified Network.HTTP.Types as HTTP
51−import Network.Socket
52−import qualified Network.Wai as Wai
53−import Network.Wai.Handler.Warp
54−import System.IO.Unsafe
55− (unsafePerformIO)
56−import Test.QuickCheck
57−import Web.FormUrlEncoded
58− (FromForm, ToForm)
59−
60−import Servant.API
61− ((:<|>) ((:<|>)), (:>), AuthProtect, BasicAuth,
62− BasicAuthData (..), Capture, CaptureAll, DeleteNoContent,
63− EmptyAPI, FormUrlEncoded, Fragment, FromHttpApiData (..), Get, Header, Headers,
64− JSON, MimeRender (mimeRender), MimeUnrender (mimeUnrender),
65− NoContent (NoContent), PlainText, Post, QueryFlag, QueryParam,
66− QueryParams, Raw, ReqBody, StdMethod (GET), ToHttpApiData (..), UVerb, Union,
67− Verb, WithStatus (WithStatus), NamedRoutes, addHeader)
68−import Servant.API.Generic ((:-))
69−import Servant.Client
70−import qualified Servant.Client.Core.Auth as Auth
71−import Servant.Server
72−import Servant.Server.Experimental.Auth
73−import Servant.Test.ComprehensiveAPI
74−
75−-- This declaration simply checks that all instances are in place.
76−_ = client comprehensiveAPIWithoutStreaming
77−
78−-- * test data types
79−
80−data Person = Person
81− { _name :: String
82− , _age :: Integer
83− } deriving (Eq, Show, Read, Generic)
84−
85−instance ToJSON Person
86−instance FromJSON Person
87−
88−instance ToForm Person
89−instance FromForm Person
90−
91−instance Arbitrary Person where
92− arbitrary = Person <$> arbitrary <*> arbitrary
93−
94−instance MimeRender PlainText Person where
95− mimeRender _ = LazyByteString.fromStrict . encodeUtf8 . Text.pack . show
96−
97−instance MimeUnrender PlainText Person where
98− mimeUnrender _ =
99− -- This does not handle any errors, but it should be fine for tests
100− Right . read . Text.unpack . decodeUtf8 . LazyByteString.toStrict
101−
102−
103−alice :: Person
104−alice = Person "Alice" 42
105−
106−carol :: Person
107−carol = Person "Carol" 17
108−
109−type TestHeaders = '[Header "X-Example1" Int, Header "X-Example2" String]
110−
111−data RecordRoutes mode = RecordRoutes
112− { version :: mode :- "version" :> Get '[JSON] Int
113− , echo :: mode :- "echo" :> Capture "string" String :> Get '[JSON] String
114− , otherRoutes :: mode :- "other" :> Capture "someParam" Int :> NamedRoutes OtherRoutes
115− } deriving Generic
116−
117−data OtherRoutes mode = OtherRoutes
118− { something :: mode :- "something" :> Get '[JSON] [String]
119− } deriving Generic
120−
121−-- Get for HTTP 307 Temporary Redirect
122−type Get307 = Verb 'GET 307
123−
124−type Api =
125− Get '[JSON] Person
126− :<|> "get" :> Get '[JSON] Person
127− -- This endpoint returns a response with status code 307 Temporary Redirect,
128− -- different from the ones in the 2xx successful class, to test derivation
129− -- of clients' api.
130− :<|> "get307" :> Get307 '[PlainText] Text
131− :<|> "deleteEmpty" :> DeleteNoContent
132− :<|> "capture" :> Capture "name" String :> Get '[JSON,FormUrlEncoded] Person
133− :<|> "captureAll" :> CaptureAll "names" String :> Get '[JSON] [Person]
134− :<|> "body" :> ReqBody '[FormUrlEncoded,JSON] Person :> Post '[JSON] Person
135− :<|> "param" :> QueryParam "name" String :> Get '[FormUrlEncoded,JSON] Person
136− -- This endpoint makes use of a 'Raw' server because it is not currently
137− -- possible to handle arbitrary binary query param values with
138− -- @servant-server@
139− :<|> "param-binary" :> QueryParam "payload" UrlEncodedByteString :> Raw
140− :<|> "params" :> QueryParams "names" String :> Get '[JSON] [Person]
141− :<|> "flag" :> QueryFlag "flag" :> Get '[JSON] Bool
142− :<|> "fragment" :> Fragment String :> Get '[JSON] Person
143− :<|> "rawSuccess" :> Raw
144− :<|> "rawSuccessPassHeaders" :> Raw
145− :<|> "rawFailure" :> Raw
146− :<|> "multiple" :>
147− Capture "first" String :>
148− QueryParam "second" Int :>
149− QueryFlag "third" :>
150− ReqBody '[JSON] [(String, [Rational])] :>
151− Get '[JSON] (String, Maybe Int, Bool, [(String, [Rational])])
152− :<|> "headers" :> Get '[JSON] (Headers TestHeaders Bool)
153− :<|> "uverb-headers" :> UVerb 'GET '[JSON] '[ WithStatus 200 (Headers TestHeaders Bool), WithStatus 204 String ]
154− :<|> "deleteContentType" :> DeleteNoContent
155− :<|> "redirectWithCookie" :> Raw
156− :<|> "empty" :> EmptyAPI
157− :<|> "uverb-success-or-redirect" :>
158− Capture "bool" Bool :>
159− UVerb 'GET '[PlainText] '[WithStatus 200 Person,
160− WithStatus 301 Text]
161− :<|> "uverb-get-created" :> UVerb 'GET '[PlainText] '[WithStatus 201 Person]
162− :<|> NamedRoutes RecordRoutes
163− :<|> "captureVerbatim" :> Capture "someString" Verbatim :> Get '[PlainText] Text
164−
165−api :: Proxy Api
166−api = Proxy
167−
168−getRoot :: ClientM Person
169−getGet :: ClientM Person
170−getGet307 :: ClientM Text
171−getDeleteEmpty :: ClientM NoContent
172−getCapture :: String -> ClientM Person
173−getCaptureAll :: [String] -> ClientM [Person]
174−getBody :: Person -> ClientM Person
175−getQueryParam :: Maybe String -> ClientM Person
176−getQueryParamBinary :: Maybe UrlEncodedByteString -> HTTP.Method -> ClientM Response
177−getQueryParams :: [String] -> ClientM [Person]
178−getQueryFlag :: Bool -> ClientM Bool
179−getFragment :: ClientM Person
180−getRawSuccess :: HTTP.Method -> ClientM Response
181−getRawSuccessPassHeaders :: HTTP.Method -> ClientM Response
182−getRawFailure :: HTTP.Method -> ClientM Response
183−getMultiple :: String -> Maybe Int -> Bool -> [(String, [Rational])]
184− -> ClientM (String, Maybe Int, Bool, [(String, [Rational])])
185−getRespHeaders :: ClientM (Headers TestHeaders Bool)
186−getUVerbRespHeaders :: ClientM (Union '[ WithStatus 200 (Headers TestHeaders Bool), WithStatus 204 String ])
187−getDeleteContentType :: ClientM NoContent
188−getRedirectWithCookie :: HTTP.Method -> ClientM Response
189−uverbGetSuccessOrRedirect :: Bool
190− -> ClientM (Union '[WithStatus 200 Person,
191− WithStatus 301 Text])
192−uverbGetCreated :: ClientM (Union '[WithStatus 201 Person])
193−recordRoutes :: RecordRoutes (AsClientT ClientM)
194−
195−getRoot
196− :<|> getGet
197− :<|> getGet307
198− :<|> getDeleteEmpty
199− :<|> getCapture
200− :<|> getCaptureAll
201− :<|> getBody
202− :<|> getQueryParam
203− :<|> getQueryParamBinary
204− :<|> getQueryParams
205− :<|> getQueryFlag
206− :<|> getFragment
207− :<|> getRawSuccess
208− :<|> getRawSuccessPassHeaders
209− :<|> getRawFailure
210− :<|> getMultiple
211− :<|> getRespHeaders
212− :<|> getUVerbRespHeaders
213− :<|> getDeleteContentType
214− :<|> getRedirectWithCookie
215− :<|> EmptyClient
216− :<|> uverbGetSuccessOrRedirect
217− :<|> uverbGetCreated
218− :<|> recordRoutes
219− :<|> captureVerbatim = client api
220−
221−server :: Application
222−server = serve api (
223− return carol
224− :<|> return alice
225− :<|> return "redirecting"
226− :<|> return NoContent
227− :<|> (\ name -> return $ Person name 0)
228− :<|> (\ names -> return (zipWith Person names [0..]))
229− :<|> return
230− :<|> (\ name -> case name of
231− Just "alice" -> return alice
232− Just n -> throwError $ ServerError 400 (n ++ " not found") "" []
233− Nothing -> throwError $ ServerError 400 "missing parameter" "" [])
234− :<|> const (Tagged $ \request respond ->
235− respond . maybe (Wai.responseLBS HTTP.notFound404 [] "Missing: payload")
236− (Wai.responseLBS HTTP.ok200 [] . LazyByteString.fromStrict)
237− . join
238− . lookup "payload"
239− $ Wai.queryString request
240− )
241− :<|> (\ names -> return (zipWith Person names [0..]))
242− :<|> return
243− :<|> return alice
244− :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.ok200 [] "rawSuccess")
245− :<|> (Tagged $ \ request respond -> (respond $ Wai.responseLBS HTTP.ok200 (Wai.requestHeaders $ request) "rawSuccess"))
246− :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.badRequest400 [] "rawFailure")
247− :<|> (\ a b c d -> return (a, b, c, d))
248− :<|> (return $ addHeader 1729 $ addHeader "eg2" True)
249− :<|> (pure . Z . I . WithStatus $ addHeader 1729 $ addHeader "eg2" True)
250− :<|> return NoContent
251− :<|> (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.found302 [("Location", "testlocation"), ("Set-Cookie", "testcookie=test")] "")
252− :<|> emptyServer
253− :<|> (\shouldRedirect -> if shouldRedirect
254− then respond (WithStatus @301 ("redirecting" :: Text))
255− else respond (WithStatus @200 alice ))
256− :<|> respond (WithStatus @201 carol)
257− :<|> RecordRoutes
258− { version = pure 42
259− , echo = pure
260− , otherRoutes = \_ -> OtherRoutes
261− { something = pure ["foo", "bar", "pweet"]
262− }
263− }
264− :<|> pure . decodeUtf8 . unVerbatim
265− )
266−
267−-- * api for testing failures
268−
269−type FailApi =
270− "get" :> Raw
271− :<|> "capture" :> Capture "name" String :> Raw
272− :<|> "body" :> Raw
273− :<|> "headers" :> Raw
274−failApi :: Proxy FailApi
275−failApi = Proxy
276−
277−failServer :: Application
278−failServer = serve failApi (
279− (Tagged $ \ _request respond -> respond $ Wai.responseLBS HTTP.ok200 [] "")
280− :<|> (\ _capture -> Tagged $ \_request respond -> respond $ Wai.responseLBS HTTP.ok200 [("content-type", "application/json")] "")
281− :<|> (Tagged $ \_request respond -> respond $ Wai.responseLBS HTTP.ok200 [("content-type", "fooooo")] "")
282− :<|> (Tagged $ \_request respond -> respond $ Wai.responseLBS HTTP.ok200 [("content-type", "application/x-www-form-urlencoded"), ("X-Example1", "1"), ("X-Example2", "foo")] "")
283− )
284−
285−-- * basic auth stuff
286−
287−type BasicAuthAPI =
288− BasicAuth "foo-realm" () :> "private" :> "basic" :> Get '[JSON] Person
289−
290−basicAuthAPI :: Proxy BasicAuthAPI
291−basicAuthAPI = Proxy
292−
293−basicAuthHandler :: BasicAuthCheck ()
294−basicAuthHandler =
295− let check (BasicAuthData username password) =
296− if username == "servant" && password == "server"
297− then return (Authorized ())
298− else return Unauthorized
299− in BasicAuthCheck check
300−
301−basicServerContext :: Context '[ BasicAuthCheck () ]
302−basicServerContext = basicAuthHandler :. EmptyContext
303−
304−basicAuthServer :: Application
305−basicAuthServer = serveWithContext basicAuthAPI basicServerContext (const (return alice))
306−
307−-- * general auth stuff
308−
309−type GenAuthAPI =
310− AuthProtect "auth-tag" :> "private" :> "auth" :> Get '[JSON] Person
311−
312−genAuthAPI :: Proxy GenAuthAPI
313−genAuthAPI = Proxy
314−
315−type instance AuthServerData (AuthProtect "auth-tag") = ()
316−type instance Auth.AuthClientData (AuthProtect "auth-tag") = ()
317−
318−genAuthHandler :: AuthHandler Wai.Request ()
319−genAuthHandler =
320− let handler req = case lookup "AuthHeader" (Wai.requestHeaders req) of
321− Nothing -> throwError (err401 { errBody = "Missing auth header" })
322− Just _ -> return ()
323− in mkAuthHandler handler
324−
325−genAuthServerContext :: Context '[ AuthHandler Wai.Request () ]
326−genAuthServerContext = genAuthHandler :. EmptyContext
327−
328−genAuthServer :: Application
329−genAuthServer = serveWithContext genAuthAPI genAuthServerContext (const (return alice))
330−
331−{-# NOINLINE manager' #-}
332−manager' :: C.Manager
333−manager' = unsafePerformIO $ C.newManager C.defaultManagerSettings
334−
335−runClient :: ClientM a -> BaseUrl -> IO (Either ClientError a)
336−runClient x baseUrl' = runClientM x (mkClientEnv manager' baseUrl')
337−
338−-- * utils
339−
340−startWaiApp :: Application -> IO (ThreadId, BaseUrl)
341−startWaiApp app = do
342− (port, socket) <- openTestSocket
343− let settings = setPort port defaultSettings
344− thread <- forkIO $ runSettingsSocket settings socket app
345− return (thread, BaseUrl Http "localhost" port "")
346−
347−
348−endWaiApp :: (ThreadId, BaseUrl) -> IO ()
349−endWaiApp (thread, _) = killThread thread
350−
351−openTestSocket :: IO (Port, Socket)
352−openTestSocket = do
353− s <- socket AF_INET Stream defaultProtocol
354− let localhost = tupleToHostAddress (127, 0, 0, 1)
355− bind s (SockAddrInet defaultPort localhost)
356− listen s 1
357− port <- socketPort s
358− return (fromIntegral port, s)
359−
360−pathGen :: Gen (NonEmptyList Char)
361−pathGen = fmap NonEmpty path
362− where
363− path = listOf1 $ elements $
364− filter (not . (`elem` ("?%[]/#;" :: String))) $
365− filter isPrint $
366− map chr [0..127]
367−
368−newtype UrlEncodedByteString = UrlEncodedByteString { unUrlEncodedByteString :: ByteString }
369−
370−instance ToHttpApiData UrlEncodedByteString where
371− toEncodedUrlPiece = byteString . HTTP.urlEncode True . unUrlEncodedByteString
372− toUrlPiece = decodeUtf8 . HTTP.urlEncode True . unUrlEncodedByteString
373−
374−instance FromHttpApiData UrlEncodedByteString where
375− parseUrlPiece = pure . UrlEncodedByteString . HTTP.urlDecode True . encodeUtf8
376−
377−newtype Verbatim = Verbatim { unVerbatim :: ByteString }
378−
379−instance ToHttpApiData Verbatim where
380− toEncodedUrlPiece = byteString . unVerbatim
381− toUrlPiece = decodeUtf8 . unVerbatim
382−
383−instance FromHttpApiData Verbatim where
384− parseUrlPiece = pure . Verbatim . encodeUtf8
servant-client/test/Servant/ConnectionErrorSpec.hsdeleted−55
@@ -1,55 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeApplications #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# OPTIONS_GHC -freduction-depth=100 #-}
16−{-# OPTIONS_GHC -fno-warn-orphans #-}
17−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
18−
19−module Servant.ConnectionErrorSpec (spec) where
20−
21−import Prelude ()
22−import Prelude.Compat
23−
24−import Control.Exception
25− (fromException)
26−import Data.Maybe
27− (isJust)
28−import Data.Monoid ()
29−import Data.Proxy
30−import qualified Network.HTTP.Client as C
31−import Test.Hspec
32−
33−import Servant.API
34− (Get, JSON)
35−import Servant.Client
36−import Servant.ClientTestUtils
37−
38−
39−spec :: Spec
40−spec = describe "Servant.ConnectionErrorSpec" $ do
41− connectionErrorSpec
42−
43−type ConnectionErrorAPI = Get '[JSON] Int
44−
45−connectionErrorAPI :: Proxy ConnectionErrorAPI
46−connectionErrorAPI = Proxy
47−
48−connectionErrorSpec :: Spec
49−connectionErrorSpec = describe "Servant.Client.ClientError" $
50− it "correctly catches ConnectionErrors when the HTTP request can't go through" $ do
51− let getInt = client connectionErrorAPI
52− let baseUrl' = BaseUrl Http "example.invalid" 80 ""
53− let isHttpError (Left (ConnectionError e)) = isJust $ fromException @C.HttpException e
54− isHttpError _ = False
55− (isHttpError <$> runClient getInt baseUrl') `shouldReturn` True
servant-client/test/Servant/FailSpec.hsdeleted−79
@@ -1,79 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# OPTIONS_GHC -freduction-depth=100 #-}
15−{-# OPTIONS_GHC -fno-warn-orphans #-}
16−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
17−
18−module Servant.FailSpec (spec) where
19−
20−import Prelude ()
21−import Prelude.Compat
22−
23−import Data.Monoid ()
24−import qualified Network.HTTP.Types as HTTP
25−import Test.Hspec
26−
27−import Servant.API
28− ((:<|>) ((:<|>)))
29−import Servant.Client
30−import Servant.ClientTestUtils
31−
32−spec :: Spec
33−spec = describe "Servant.FailSpec" $ do
34− failSpec
35−
36−failSpec :: Spec
37−failSpec = beforeAll (startWaiApp failServer) $ afterAll endWaiApp $ do
38−
39− context "client returns errors appropriately" $ do
40− it "reports FailureResponse" $ \(_, baseUrl) -> do
41− let (_ :<|> _ :<|> _ :<|> getDeleteEmpty :<|> _) = client api
42− Left res <- runClient getDeleteEmpty baseUrl
43− case res of
44− FailureResponse _ r | responseStatusCode r == HTTP.status404 -> return ()
45− _ -> fail $ "expected 404 response, but got " <> show res
46−
47− it "reports DecodeFailure" $ \(_, baseUrl) -> do
48− let (_ :<|> _ :<|> _ :<|> _ :<|> getCapture :<|> _) = client api
49− Left res <- runClient (getCapture "foo") baseUrl
50− case res of
51− DecodeFailure _ _ -> return ()
52− _ -> fail $ "expected DecodeFailure, but got " <> show res
53−
54− it "reports ConnectionError" $ \_ -> do
55− let (getGetWrongHost :<|> _) = client api
56− Left res <- runClient getGetWrongHost (BaseUrl Http "127.0.0.1" 19872 "")
57− case res of
58− ConnectionError _ -> return ()
59− _ -> fail $ "expected ConnectionError, but got " <> show res
60−
61− it "reports UnsupportedContentType" $ \(_, baseUrl) -> do
62− let (_ :<|> getGet :<|> _ ) = client api
63− Left res <- runClient getGet baseUrl
64− case res of
65− UnsupportedContentType "application/octet-stream" _ -> return ()
66− _ -> fail $ "expected UnsupportedContentType, but got " <> show res
67−
68− it "reports UnsupportedContentType when there are response headers" $ \(_, baseUrl) -> do
69− Left res <- runClient getRespHeaders baseUrl
70− case res of
71− UnsupportedContentType "application/x-www-form-urlencoded" _ -> return ()
72− _ -> fail $ "expected UnsupportedContentType, but got " <> show res
73−
74− it "reports InvalidContentTypeHeader" $ \(_, baseUrl) -> do
75− let (_ :<|> _ :<|> _ :<|> _ :<|> _ :<|> _ :<|> getBody :<|> _) = client api
76− Left res <- runClient (getBody alice) baseUrl
77− case res of
78− InvalidContentTypeHeader _ -> return ()
79− _ -> fail $ "expected InvalidContentTypeHeader, but got " <> show res
servant-client/test/Servant/GenAuthSpec.hsdeleted−54
@@ -1,54 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# OPTIONS_GHC -freduction-depth=100 #-}
15−{-# OPTIONS_GHC -fno-warn-orphans #-}
16−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
17−
18−module Servant.GenAuthSpec (spec) where
19−
20−import Prelude ()
21−import Prelude.Compat
22−
23−import Control.Arrow
24− (left)
25−import Data.Monoid ()
26−import qualified Network.HTTP.Types as HTTP
27−import Test.Hspec
28−
29−import Servant.Client
30−import qualified Servant.Client.Core.Auth as Auth
31−import qualified Servant.Client.Core.Request as Req
32−import Servant.ClientTestUtils
33−
34−spec :: Spec
35−spec = describe "Servant.GenAuthSpec" $ do
36− genAuthSpec
37−
38−genAuthSpec :: Spec
39−genAuthSpec = beforeAll (startWaiApp genAuthServer) $ afterAll endWaiApp $ do
40− context "Authentication works when requests are properly authenticated" $ do
41−
42− it "Authenticates a AuthProtect protected server appropriately" $ \(_, baseUrl) -> do
43− let getProtected = client genAuthAPI
44− let authRequest = Auth.mkAuthenticatedRequest () (\_ req -> Req.addHeader "AuthHeader" ("cool" :: String) req)
45− left show <$> runClient (getProtected authRequest) baseUrl `shouldReturn` Right alice
46−
47− context "Authentication is rejected when requests are not authenticated properly" $ do
48−
49− it "Authenticates a AuthProtect protected server appropriately" $ \(_, baseUrl) -> do
50− let getProtected = client genAuthAPI
51− let authRequest = Auth.mkAuthenticatedRequest () (\_ req -> Req.addHeader "Wrong" ("header" :: String) req)
52− Left (FailureResponse _ r) <- runClient (getProtected authRequest) baseUrl
53− responseStatusCode r `shouldBe` HTTP.Status 401 "Unauthorized"
54−
servant-client/test/Servant/GenericSpec.hsdeleted−37
@@ -1,37 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# OPTIONS_GHC -freduction-depth=100 #-}
15−{-# OPTIONS_GHC -fno-warn-orphans #-}
16−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
17−
18−module Servant.GenericSpec (spec) where
19−
20−import Test.Hspec
21−
22−import Servant.Client ((//), (/:))
23−import Servant.ClientTestUtils
24−
25−spec :: Spec
26−spec = describe "Servant.GenericSpec" $ do
27− genericSpec
28−
29−genericSpec :: Spec
30−genericSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
31− context "Record clients work as expected" $ do
32−
33− it "Client functions return expected values" $ \(_,baseUrl) -> do
34− runClient (recordRoutes // version) baseUrl `shouldReturn` Right 42
35− runClient (recordRoutes // echo /: "foo") baseUrl `shouldReturn` Right "foo"
36− it "Clients can be nested" $ \(_,baseUrl) -> do
37− runClient (recordRoutes // otherRoutes /: 42 // something) baseUrl `shouldReturn` Right ["foo", "bar", "pweet"]
servant-client/test/Servant/HoistClientSpec.hsdeleted−58
@@ -1,58 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE RecordWildCards #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# OPTIONS_GHC -freduction-depth=100 #-}
16−{-# OPTIONS_GHC -fno-warn-orphans #-}
17−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
18−
19−module Servant.HoistClientSpec (spec) where
20−
21−import Prelude ()
22−import Prelude.Compat
23−
24−import Data.Monoid ()
25−import Data.Proxy
26−import Test.Hspec
27−
28−import Servant.API
29− ((:<|>) ((:<|>)), (:>), Capture,
30− Get, JSON, Post)
31−import Servant.Client
32−import Servant.Server
33−import Servant.ClientTestUtils
34−
35−
36−spec :: Spec
37−spec = describe "Servant.HoistClientSpec" $ do
38− hoistClientSpec
39−
40−type HoistClientAPI = Get '[JSON] Int :<|> Capture "n" Int :> Post '[JSON] Int
41−
42−hoistClientAPI :: Proxy HoistClientAPI
43−hoistClientAPI = Proxy
44−
45−hoistClientServer :: Application -- implements HoistClientAPI
46−hoistClientServer = serve hoistClientAPI $ return 5 :<|> return
47−
48−hoistClientSpec :: Spec
49−hoistClientSpec = beforeAll (startWaiApp hoistClientServer) $ afterAll endWaiApp $ do
50− describe "Servant.Client.hoistClient" $ do
51− it "allows us to GET/POST/... requests in IO instead of ClientM" $ \(_, baseUrl) -> do
52− let (getInt :<|> postInt)
53− = hoistClient hoistClientAPI
54− (fmap (either (error . show) id) . flip runClient baseUrl)
55− (client hoistClientAPI)
56−
57− getInt `shouldReturn` 5
58− postInt 5 `shouldReturn` 5
servant-client/test/Servant/StreamSpec.hs+4−3
@@ -39,6 +39,9 @@ import Servant.API
3939 NewlineFraming, NoFraming, OctetStream, SourceIO, StreamGet,
4040 )
4141import Servant.Client.Streaming
42+import Servant.ClientSpec
43+ (Person (..))
44+import qualified Servant.ClientSpec as CS
4245import Servant.Server
4346import Servant.Test.ComprehensiveAPI
4447import Servant.Types.SourceT
@@ -49,8 +52,6 @@ import System.IO.Unsafe
4952import System.Mem
5053 (performGC)
5154import Test.Hspec
52−import Servant.ClientTestUtils (Person(..))
53−import qualified Servant.ClientTestUtils as CT
5455
5556#if MIN_VERSION_base(4,10,0)
5657import GHC.Stats
@@ -119,7 +120,7 @@ testRunSourceIO :: SourceIO a
119120testRunSourceIO = runExceptT . runSourceT
120121
121122streamSpec :: Spec
122−streamSpec = beforeAll (CT.startWaiApp server) $ afterAll CT.endWaiApp $ do
123+streamSpec = beforeAll (CS.startWaiApp server) $ afterAll CS.endWaiApp $ do
123124 it "works with Servant.API.StreamGet.Newline" $ \(_, baseUrl) -> do
124125 withClient getGetNL baseUrl $ \(Right res) ->
125126 testRunSourceIO res `shouldReturn` Right [alice, bob, alice]
servant-client/test/Servant/SuccessSpec.hsdeleted−208
@@ -1,208 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeApplications #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# OPTIONS_GHC -freduction-depth=100 #-}
16−{-# OPTIONS_GHC -fno-warn-orphans #-}
17−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
18−
19−module Servant.SuccessSpec (spec) where
20−
21−import Prelude ()
22−import Prelude.Compat
23−
24−import Control.Arrow
25− ((+++), left)
26−import Control.Concurrent.STM
27− (atomically)
28−import Control.Concurrent.STM.TVar
29− (newTVar, readTVar)
30−import qualified Data.ByteString as BS
31−import qualified Data.ByteString.Lazy as BL
32−import Data.Foldable
33− (forM_, toList)
34−import Data.Maybe
35− (listToMaybe)
36−import Data.Monoid ()
37−import Data.Text
38− (Text)
39−import Data.Text.Encoding
40− (encodeUtf8)
41−import qualified Network.HTTP.Client as C
42−import qualified Network.HTTP.Types as HTTP
43−import Test.Hspec
44−import Test.Hspec.QuickCheck
45−import Test.HUnit
46−import Test.QuickCheck
47−
48−import Servant.API
49− (NoContent (NoContent), WithStatus (WithStatus), getHeaders, Headers(..))
50−import Servant.Client
51−import qualified Servant.Client.Core.Request as Req
52−import Servant.ClientTestUtils
53−import Servant.Test.ComprehensiveAPI
54−
55−-- This declaration simply checks that all instances are in place.
56−_ = client comprehensiveAPIWithoutStreaming
57−
58−spec :: Spec
59−spec = describe "Servant.SuccessSpec" $ do
60− successSpec
61−
62−successSpec :: Spec
63−successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
64− describe "Servant.API.Get" $ do
65− it "get root endpoint" $ \(_, baseUrl) -> do
66− left show <$> runClient getRoot baseUrl `shouldReturn` Right carol
67−
68− it "get simple endpoint" $ \(_, baseUrl) -> do
69− left show <$> runClient getGet baseUrl `shouldReturn` Right alice
70−
71− it "get redirection endpoint" $ \(_, baseUrl) -> do
72− left show <$> runClient getGet307 baseUrl `shouldReturn` Right "redirecting"
73−
74− describe "Servant.API.Delete" $ do
75− it "allows empty content type" $ \(_, baseUrl) -> do
76− left show <$> runClient getDeleteEmpty baseUrl `shouldReturn` Right NoContent
77−
78− it "allows content type" $ \(_, baseUrl) -> do
79− left show <$> runClient getDeleteContentType baseUrl `shouldReturn` Right NoContent
80−
81− it "Servant.API.Capture" $ \(_, baseUrl) -> do
82− left show <$> runClient (getCapture "Paula") baseUrl `shouldReturn` Right (Person "Paula" 0)
83−
84− it "Servant.API.CaptureAll" $ \(_, baseUrl) -> do
85− let expected = [Person "Paula" 0, Person "Peta" 1]
86− left show <$> runClient (getCaptureAll ["Paula", "Peta"]) baseUrl `shouldReturn` Right expected
87−
88− it "Servant.API.ReqBody" $ \(_, baseUrl) -> do
89− let p = Person "Clara" 42
90− left show <$> runClient (getBody p) baseUrl `shouldReturn` Right p
91−
92− it "Servant.API FailureResponse" $ \(_, baseUrl) -> do
93− left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
94− Left (FailureResponse req _) <- runClient (getQueryParam (Just "bob")) baseUrl
95− Req.requestPath req `shouldBe` (baseUrl, "/param")
96− toList (Req.requestQueryString req) `shouldBe` [("name", Just "bob")]
97− Req.requestMethod req `shouldBe` HTTP.methodGet
98−
99− it "Servant.API.QueryParam" $ \(_, baseUrl) -> do
100− left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
101− Left (FailureResponse _ r) <- runClient (getQueryParam (Just "bob")) baseUrl
102− responseStatusCode r `shouldBe` HTTP.Status 400 "bob not found"
103−
104− it "Servant.API.QueryParam binary data" $ \(_, baseUrl) -> do
105− let payload = BS.pack [0, 1, 2, 4, 8, 16, 32, 64, 128]
106− apiCall = getQueryParamBinary (Just $ UrlEncodedByteString payload) HTTP.methodGet
107− (show +++ responseBody) <$> runClient apiCall baseUrl `shouldReturn` Right (BL.fromStrict payload)
108−
109− it "Servant.API.QueryParam.QueryParams" $ \(_, baseUrl) -> do
110− left show <$> runClient (getQueryParams []) baseUrl `shouldReturn` Right []
111− left show <$> runClient (getQueryParams ["alice", "bob"]) baseUrl
112− `shouldReturn` Right [Person "alice" 0, Person "bob" 1]
113−
114− context "Servant.API.QueryParam.QueryFlag" $
115− forM_ [False, True] $ \ flag -> it (show flag) $ \(_, baseUrl) -> do
116− left show <$> runClient (getQueryFlag flag) baseUrl `shouldReturn` Right flag
117−
118− it "Servant.API.Fragment" $ \(_, baseUrl) -> do
119− left id <$> runClient getFragment baseUrl `shouldReturn` Right alice
120−
121− it "Servant.API.Raw on success" $ \(_, baseUrl) -> do
122− res <- runClient (getRawSuccess HTTP.methodGet) baseUrl
123− case res of
124− Left e -> assertFailure $ show e
125− Right r -> do
126− responseStatusCode r `shouldBe` HTTP.status200
127− responseBody r `shouldBe` "rawSuccess"
128−
129− it "Servant.API.Raw should return a Left in case of failure" $ \(_, baseUrl) -> do
130− res <- runClient (getRawFailure HTTP.methodGet) baseUrl
131− case res of
132− Right _ -> assertFailure "expected Left, but got Right"
133− Left (FailureResponse _ r) -> do
134− responseStatusCode r `shouldBe` HTTP.status400
135− responseBody r `shouldBe` "rawFailure"
136− Left e -> assertFailure $ "expected FailureResponse, but got " ++ show e
137−
138− it "Returns headers appropriately" $ \(_, baseUrl) -> do
139− res <- runClient getRespHeaders baseUrl
140− case res of
141− Left e -> assertFailure $ show e
142− Right val -> getHeaders val `shouldBe` [("X-Example1", "1729"), ("X-Example2", "eg2")]
143−
144− it "Returns headers on UVerb requests" $ \(_, baseUrl) -> do
145− res <- runClient getUVerbRespHeaders baseUrl
146− case res of
147− Left e -> assertFailure $ show e
148− Right val -> case matchUnion val of
149− Just (WithStatus val' :: WithStatus 200 (Headers TestHeaders Bool))
150− -> getHeaders val' `shouldBe` [("X-Example1", "1729"), ("X-Example2", "eg2")]
151− Nothing -> assertFailure "unexpected alternative of union"
152−
153− it "Stores Cookie in CookieJar after a redirect" $ \(_, baseUrl) -> do
154− mgr <- C.newManager C.defaultManagerSettings
155− cj <- atomically . newTVar $ C.createCookieJar []
156− _ <- runClientM (getRedirectWithCookie HTTP.methodGet) (ClientEnv mgr baseUrl (Just cj) defaultMakeClientRequest)
157− cookie <- listToMaybe . C.destroyCookieJar <$> atomically (readTVar cj)
158− C.cookie_name <$> cookie `shouldBe` Just "testcookie"
159− C.cookie_value <$> cookie `shouldBe` Just "test"
160−
161− it "Can modify the outgoing Request using the ClientEnv" $ \(_, baseUrl) -> do
162− mgr <- C.newManager C.defaultManagerSettings
163− -- In proper situation, extra headers should probably be visible in API type.
164− -- However, testing for response timeout is difficult, so we test with something which is easy to observe
165− let createClientRequest url r = fmap (\req -> req { C.requestHeaders = [("X-Added-Header", "XXX")] })
166− (defaultMakeClientRequest url r)
167− clientEnv = (mkClientEnv mgr baseUrl) { makeClientRequest = createClientRequest }
168− res <- runClientM (getRawSuccessPassHeaders HTTP.methodGet) clientEnv
169− case res of
170− Left e ->
171− assertFailure $ show e
172− Right r ->
173− ("X-Added-Header", "XXX") `elem` toList (responseHeaders r) `shouldBe` True
174−
175− modifyMaxSuccess (const 20) $ do
176− it "works for a combination of Capture, QueryParam, QueryFlag and ReqBody" $ \(_, baseUrl) ->
177− property $ forAllShrink pathGen shrink $ \(NonEmpty cap) num flag body ->
178− ioProperty $ do
179− result <- left show <$> runClient (getMultiple cap num flag body) baseUrl
180− return $
181− result === Right (cap, num, flag, body)
182−
183− context "With a route that can either return success or redirect" $ do
184− it "Redirects when appropriate" $ \(_, baseUrl) -> do
185− eitherResponse <- runClient (uverbGetSuccessOrRedirect True) baseUrl
186− case eitherResponse of
187− Left clientError -> fail $ show clientError
188− Right response -> matchUnion response `shouldBe` Just (WithStatus @301 @Text "redirecting")
189−
190− it "Returns a proper response when appropriate" $ \(_, baseUrl) -> do
191− eitherResponse <- runClient (uverbGetSuccessOrRedirect False) baseUrl
192− case eitherResponse of
193− Left clientError -> fail $ show clientError
194− Right response -> matchUnion response `shouldBe` Just (WithStatus @200 alice)
195−
196− context "with a route that uses uverb but only has a single response" $
197− it "returns the expected response" $ \(_, baseUrl) -> do
198− eitherResponse <- runClient (uverbGetCreated) baseUrl
199− case eitherResponse of
200− Left clientError -> fail $ show clientError
201− Right response -> matchUnion response `shouldBe` Just (WithStatus @201 carol)
202−
203− it "encodes URL pieces following ToHttpApiData instance" $ \(_, baseUrl) -> do
204− let textOrig = "*"
205− eitherResponse <- runClient (captureVerbatim $ Verbatim $ encodeUtf8 textOrig) baseUrl
206− case eitherResponse of
207− Left clientError -> fail $ show clientError
208− Right textBack -> textBack `shouldBe` textOrig
servant-client/test/Servant/WrappedApiSpec.hsdeleted−63
@@ -1,63 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# OPTIONS_GHC -freduction-depth=100 #-}
15−{-# OPTIONS_GHC -fno-warn-orphans #-}
16−{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
17−
18−module Servant.WrappedApiSpec (spec) where
19−
20−import Prelude ()
21−import Prelude.Compat
22−
23−import Control.Exception
24− (bracket)
25−import Control.Monad.Error.Class
26− (throwError)
27−import Data.Monoid ()
28−import Data.Proxy
29−import qualified Network.HTTP.Types as HTTP
30−import Test.Hspec
31−
32−import Servant.API
33− (Delete, Get, JSON, Post, Put)
34−import Servant.Client
35−import Servant.Server
36−import Servant.ClientTestUtils
37−
38−spec :: Spec
39−spec = describe "Servant.WrappedApiSpec" $ do
40− wrappedApiSpec
41−
42−data WrappedApi where
43− WrappedApi :: (HasServer (api :: *) '[], Server api ~ Handler a,
44− HasClient ClientM api, Client ClientM api ~ ClientM ()) =>
45− Proxy api -> WrappedApi
46−
47−wrappedApiSpec :: Spec
48−wrappedApiSpec = describe "error status codes" $ do
49− let serveW api = serve api $ throwError $ ServerError 500 "error message" "" []
50− context "are correctly handled by the client" $
51− let test :: (WrappedApi, String) -> Spec
52− test (WrappedApi api, desc) =
53− it desc $ bracket (startWaiApp $ serveW api) endWaiApp $ \(_, baseUrl) -> do
54− let getResponse :: ClientM ()
55− getResponse = client api
56− Left (FailureResponse _ r) <- runClient getResponse baseUrl
57− responseStatusCode r `shouldBe` HTTP.Status 500 "error message"
58− in mapM_ test $
59− (WrappedApi (Proxy :: Proxy (Delete '[JSON] ())), "Delete") :
60− (WrappedApi (Proxy :: Proxy (Get '[JSON] ())), "Get") :
61− (WrappedApi (Proxy :: Proxy (Post '[JSON] ())), "Post") :
62− (WrappedApi (Proxy :: Proxy (Put '[JSON] ())), "Put") :
63− []
servant-conduit/servant-conduit.cabal+17−12
@@ -1,6 +1,7 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-conduit
3−version: 0.15.1
3+version: 0.15
4+x-revision: 1
45
56synopsis: Servant Stream support for conduit.
67category: Servant, Web, Enumerator
@@ -8,33 +9,37 @@ description: Servant Stream support for conduit.
89 .
910 Provides 'ToSourceIO' and 'FromSourceIO' instances for 'ConduitT'.
1011
11−homepage: http://docs.servant.dev/
12+homepage: http://haskell-servant.readthedocs.org/
1213bug-reports: http://github.com/haskell-servant/servant/issues
13−license: BSD-3-Clause
14+license: BSD3
1415license-file: LICENSE
1516author: Servant Contributors
1617maintainer: haskell-servant-maintainers@googlegroups.com
1718copyright: 2018-2019 Servant Contributors
1819build-type: Simple
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2
20+tested-with:
21+ GHC ==8.0.2
22+ || ==8.2.2
23+ || ==8.4.4
24+ || ==8.6.3
2025
2126extra-source-files:
2227 CHANGELOG.md
2328
2429source-repository head
2530 type: git
26− location: http://github.com/haskell-servant/servant.git
31+ location: http://github.com/haskell-servant/servant-conduit.git
2732
2833library
2934 exposed-modules: Servant.Conduit
3035 build-depends:
3136 base >=4.9 && <5
32− , bytestring >=0.10.8.1 && <0.12
37+ , bytestring >=0.10.8.1 && <0.11
3338 , conduit >=1.3.1 && <1.4
3439 , mtl >=2.2.2 && <2.3
3540 , resourcet >=1.2.2 && <1.3
36− , servant >=0.15 && <0.20
37− , unliftio-core >=0.1.2.0 && <0.3
41+ , servant >=0.15 && <0.17
42+ , unliftio-core >=0.1.2.0 && <0.2
3843 hs-source-dirs: src
3944 default-language: Haskell2010
4045 ghc-options: -Wall
@@ -54,9 +59,9 @@ test-suite example
5459 , resourcet
5560 , servant
5661 , servant-conduit
57− , servant-server >=0.15 && <0.20
58− , servant-client >=0.15 && <0.20
62+ , servant-server >=0.15 && <0.17
63+ , servant-client >=0.15 && <0.17
5964 , wai >=3.2.1.2 && <3.3
60− , warp >=3.2.25 && <3.4
65+ , warp >=3.2.25 && <3.3
6166 , http-client
6267 default-language: Haskell2010
servant-docs/CHANGELOG.md−85
@@ -1,91 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−0.12
5−----
6−
7−### Significant changes
8−
9−- Generate sample cURL requests
10− ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
11− Breaking change: requires sample header values to be supplied with `headers`.
12−
13−0.11.9
14−------
15−
16−### Significant changes
17−
18−- Use Capture Description if available (#1423).
19−
20−### Other changes
21−
22−- Support GHC-9.0.1.
23−- Bump `bytestring` and `lens` dependencies.
24−
25−0.11.8
26−------
27−
28−### Significant changes
29−
30−- Support `Fragment` combinator.
31−
32−0.11.7
33−------
34−
35−### Significant changes
36−
37−- Add instance for ToSample NonEmpty
38−
39−### Other changes
40−
41−- Bump "tested-with" ghc versions
42−- Fix servant-docs code sample in README
43−
44−0.11.5
45−----
46−
47−
48−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
49−
50− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
51− The API type changes are usually of the kind
52−
53− ```diff
54− - :<|> PostNoContent '[JSON] NoContent
55− + :<|> PostNoContent
56− ```
57−
58− i.e. one doesn't need to specify the content-type anymore. There is no content.
59−
60−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
61−
62− You can specify a lenient capture as
63−
64− ```haskell
65− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
66− ```
67−
68− which will make the capture always succeed. Handlers will be of the
69− type `Either String CapturedType`, where `Left err` represents
70− the possible parse failure.
71−
72−- *servant-docs* Merge documentation from duplicate routes [#1240](https://github.com/haskell-servant/servant/issues/1240) [#1241](https://github.com/haskell-servant/servant/pull/1241)
73−
74− Servant supports defining the same route multiple times with different
75− content-types and result-types, but servant-docs was only documenting
76− the first of copy of such duplicated routes. It now combines the
77− documentation from all the copies.
78−
79− Unfortunately, it is not yet possible for the documentation to specify
80− multiple status codes.
81−
82−- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
83−
84−0.11.4
85−------
86−
87−- Drop dependency on `control-monad-omega` in favor of `Data.Universe.Helpers` from `universe-base`.
88−
8940.11.3
905------
916
servant-docs/README.md+11−44
@@ -2,56 +2,24 @@
22
33![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
44
5−Generate API docs for your _servant_ webservice. Feel free to also take a look at [servant-pandoc](https://github.com/mpickering/servant-pandoc) which uses this package to target a broad range of output formats using the excellent **pandoc**.
5+Generate API docs for your *servant* webservice. Feel free to also take a look at [servant-pandoc](https://github.com/mpickering/servant-pandoc) which uses this package to target a broad range of output formats using the excellent **pandoc**.
66
77## Example
88
99See [here](https://github.com/haskell-servant/servant/blob/master/servant-docs/example/greet.md) for the output of the following program.
1010
11−```haskell
11+``` haskell
1212{-# LANGUAGE DataKinds #-}
13−{-# LANGUAGE DeriveGeneric #-}
14−{-# LANGUAGE FlexibleInstances #-}
15−{-# LANGUAGE MultiParamTypeClasses #-}
16−{-# LANGUAGE OverloadedStrings #-}
1713{-# LANGUAGE PolyKinds #-}
1814{-# LANGUAGE TypeFamilies #-}
15+{-# LANGUAGE DeriveGeneric #-}
1916{-# LANGUAGE TypeOperators #-}
17+{-# LANGUAGE FlexibleInstances #-}
18+{-# LANGUAGE OverloadedStrings #-}
2019
21−import Data.Aeson (FromJSON, ToJSON)
22−import Data.Proxy (Proxy (..))
23−import Data.String.Conversions (cs)
24−import Data.Text (Text)
25−import GHC.Generics (Generic)
26−import Servant.API
27− ( (:<|>),
28− (:>),
29− Capture,
30− Delete,
31− Get,
32− JSON,
33− MimeRender,
34− PlainText,
35− Post,
36− QueryParam,
37− ReqBody,
38− mimeRender,
39− )
20+import Data.Proxy
21+import Data.Text
4022import Servant.Docs
41− ( API,
42− DocCapture (..),
43− DocQueryParam (..),
44− ParamKind (..),
45− ToCapture,
46− ToParam,
47− ToSample,
48− docs,
49− markdown,
50− singleSample,
51− toCapture,
52− toParam,
53− toSamples,
54− )
5523
5624-- our type for a Greeting message
5725data Greet = Greet { _msg :: Text }
@@ -61,7 +29,6 @@ data Greet = Greet { _msg :: Text }
6129-- 'MimeRender' instance for 'JSON'.
6230instance FromJSON Greet
6331instance ToJSON Greet
64−instance ToSample ()
6532
6633-- We can also implement 'MimeRender' explicitly for additional formats.
6734instance MimeRender PlainText Greet where
@@ -69,7 +36,8 @@ instance MimeRender PlainText Greet where
6936
7037-- we provide a sample value for the 'Greet' type
7138instance ToSample Greet where
72− toSamples _ = singleSample g
39+ toSample = Just g
40+
7341 where g = Greet "Hello, haskeller!"
7442
7543instance ToParam (QueryParam "capital" Bool) where
@@ -77,7 +45,6 @@ instance ToParam (QueryParam "capital" Bool) where
7745 DocQueryParam "capital"
7846 ["true", "false"]
7947 "Get the greeting message in uppercase (true) or not (false). Default is false."
80− Normal
8148
8249instance ToCapture (Capture "name" Text) where
8350 toCapture _ = DocCapture "name" "name of the person to greet"
@@ -88,8 +55,8 @@ instance ToCapture (Capture "greetid" Text) where
8855-- API specification
8956type TestApi =
9057 "hello" :> Capture "name" Text :> QueryParam "capital" Bool :> Get '[JSON,PlainText] Greet
91− :<|> "greet" :> ReqBody '[JSON] Greet :> Post '[JSON] Greet
92− :<|> "delete" :> Capture "greetid" Text :> Delete '[JSON] ()
58+ :<|> "greet" :> RQBody '[JSON] Greet :> Post '[JSON] Greet
59+ :<|> "delete" :> Capture "greetid" Text :> Delete '[] ()
9360
9461testApi :: Proxy TestApi
9562testApi = Proxy
servant-docs/example/greet.hs+4−4
@@ -75,7 +75,7 @@ intro2 = DocIntro "This title is below the last"
7575-- API specification
7676type TestApi =
7777 -- GET /hello/:name?capital={true, false} returns a Greet as JSON or PlainText
78− "hello" :> Capture "name" Text :> Header "X-Num-Fairies" Int :> QueryParam "capital" Bool :> Get '[JSON, PlainText] Greet
78+ "hello" :> Capture "name" Text :> QueryParam "capital" Bool :> Get '[JSON, PlainText] Greet
7979
8080 -- POST /greet with a Greet as JSON in the request body,
8181 -- returns a Greet as JSON
@@ -93,9 +93,9 @@ testApi = Proxy
9393extra :: ExtraInfo TestApi
9494extra =
9595 extraInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete '[JSON] NoContent)) $
96− defAction & headers <>~ [("X-Num-Unicorns", "1")]
96+ defAction & headers <>~ ["unicorns"]
9797 & notes <>~ [ DocNote "Title" ["This is some text"]
98− , DocNote "Second section" ["And some more"]
98+ , DocNote "Second secton" ["And some more"]
9999 ]
100100
101101-- Generate the data that lets us have API docs. This
@@ -109,4 +109,4 @@ docsGreet :: API
109109docsGreet = docsWith defaultDocOptions [intro1, intro2] extra testApi
110110
111111main :: IO ()
112−main = putStrLn $ markdownWith (defRenderingOptions { _renderCurlBasePath = Just "http://localhost:80" }) docsGreet
112+main = putStrLn $ markdown docsGreet
servant-docs/example/greet.md+2−33
@@ -51,22 +51,13 @@ You'll also note that multiple intros are possible.
5151"Hello, haskeller"
5252```
5353
54−### Sample Request:
55−
56−```bash
57−curl -XPOST \
58− -H "Content-Type: application/json;charset=utf-8" \
59− -d "\"HELLO, HASKELLER\"" \
60− http://localhost:80/greet
61−```
62−
6354## DELETE /greet/:greetid
6455
6556### Title
6657
6758This is some text
6859
69−### Second section
60+### Second secton
7061
7162And some more
7263
@@ -76,7 +67,7 @@ And some more
7667
7768### Headers:
7869
79−- This endpoint is sensitive to the value of the **X-Num-Unicorns** HTTP header.
70+- This endpoint is sensitive to the value of the **unicorns** HTTP header.
8071
8172### Response:
8273
@@ -94,24 +85,12 @@ And some more
9485
9586```
9687
97−### Sample Request:
98−
99−```bash
100−curl -XDELETE \
101− -H "X-Num-Unicorns: 1" \
102− http://localhost:80/greet/:greetid
103−```
104−
10588## GET /hello/:name
10689
10790### Captures:
10891
10992- *name*: name of the person to greet
11093
111−### Headers:
112−
113−- This endpoint is sensitive to the value of the **X-Num-Fairies** HTTP header.
114−
11594### GET Parameters:
11695
11796- capital
@@ -141,13 +120,3 @@ curl -XDELETE \
141120```javascript
142121"Hello, haskeller"
143122```
144−
145−### Sample Request:
146−
147−```bash
148−curl -XGET \
149− -H "X-Num-Fairies: 1729" \
150− http://localhost:80/hello/:name
151−```
152−
153−
servant-docs/golden/comprehensive.md+12−47
@@ -52,11 +52,11 @@
5252
5353```
5454
55−## GET /capture/:bar
55+## GET /capture/:foo
5656
5757### Captures:
5858
59−- *bar*: example description
59+- *foo*: Capture foo Int
6060
6161### Response:
6262
@@ -96,28 +96,6 @@
9696
9797```
9898
99−## GET /capture-lenient/:foo
100−
101−### Captures:
102−
103−- *foo*: Capture foo Int
104−
105−### Response:
106−
107−- Status code 200
108−- Headers: []
109−
110−- Supported content types are:
111−
112− - `application/json;charset=utf-8`
113− - `application/json`
114−
115−- Example (`application/json;charset=utf-8`, `application/json`):
116−
117−```javascript
118−
119−```
120−
12199## GET /description
122100
123101### foo
@@ -182,28 +160,6 @@
182160
183161```
184162
185−## GET /fragment
186−
187−### Fragment:
188−
189−- *foo*: Fragment Int
190−
191−### Response:
192−
193−- Status code 200
194−- Headers: []
195−
196−- Supported content types are:
197−
198− - `application/json;charset=utf-8`
199− - `application/json`
200−
201−- Example (`application/json;charset=utf-8`, `application/json`):
202−
203−```javascript
204−
205−```
206−
207163## GET /get-int
208164
209165### Response:
@@ -421,7 +377,16 @@
421377- Status code 204
422378- Headers: []
423379
424−- No response body
380+- Supported content types are:
381+
382+ - `application/json;charset=utf-8`
383+ - `application/json`
384+
385+- Example (`application/json;charset=utf-8`, `application/json`):
386+
387+```javascript
388+
389+```
425390
426391## GET /raw
427392
servant-docs/servant-docs.cabal+23−17
@@ -1,6 +1,7 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-docs
3−version: 0.12
3+version: 0.11.3
4+x-revision: 1
45
56synopsis: generate API docs for your servant webservice
67category: Servant, Web
@@ -11,15 +12,19 @@ description:
1112 .
1213 <https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md CHANGELOG>
1314
14−homepage: http://docs.servant.dev/
15+homepage: http://haskell-servant.readthedocs.org/
1516bug-reports: http://github.com/haskell-servant/servant/issues
16−license: BSD-3-Clause
17+license: BSD3
1718license-file: LICENSE
1819author: Servant Contributors
1920maintainer: haskell-servant-maintainers@googlegroups.com
2021copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
2122build-type: Simple
22−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
23+tested-with:
24+ GHC ==8.0.2
25+ || ==8.2.2
26+ || ==8.4.4
27+ || ==8.6.3
2328
2429extra-source-files:
2530 CHANGELOG.md
@@ -41,27 +46,27 @@ library
4146 --
4247 -- note: mtl lower bound is so low because of GHC-7.8
4348 build-depends:
44− base >= 4.9 && < 4.17
45− , bytestring >= 0.10.8.1 && < 0.12
46− , text >= 1.2.3.0 && < 2.1
49+ base >= 4.9 && < 4.13
50+ , bytestring >= 0.10.8.1 && < 0.11
51+ , text >= 1.2.3.0 && < 1.3
4752
4853 -- Servant dependencies
4954 build-depends:
50− servant >= 0.18 && <0.20
55+ servant >= 0.15 && <0.17
5156
5257 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
5358 -- Here can be exceptions if we really need features from the newer versions.
5459 build-depends:
55− aeson >= 1.4.1.0 && < 3
60+ aeson >= 1.4.1.0 && < 1.5
5661 , aeson-pretty >= 0.8.5 && < 0.9
57− , base-compat >= 0.10.5 && < 0.13
62+ , base-compat >= 0.10.5 && < 0.11
5863 , case-insensitive >= 1.2.0.11 && < 1.3
59− , hashable >= 1.2.7.0 && < 1.5
60− , http-media >= 0.7.1.3 && < 0.9
64+ , control-monad-omega >= 0.3.1 && < 0.4
65+ , hashable >= 1.2.7.0 && < 1.3
66+ , http-media >= 0.7.1.3 && < 0.8
6167 , http-types >= 0.12.2 && < 0.13
62− , lens >= 4.17 && < 5.2
68+ , lens >= 4.17 && < 4.18
6369 , string-conversions >= 0.4.0.1 && < 0.5
64− , universe-base >= 1.1.1 && < 1.2
6570 , unordered-containers >= 0.2.9.0 && < 0.3
6671
6772 hs-source-dirs: src
@@ -100,9 +105,10 @@ test-suite spec
100105 , servant-docs
101106 , string-conversions
102107
103− -- Additional dependencies
108+ -- Additonal dependencies
104109 build-depends:
105− tasty >= 1.1.0.4 && < 1.5,
110+ tasty >= 1.1.0.4 && < 1.3,
106111 tasty-golden >= 2.3.2 && < 2.4,
107112 tasty-hunit >= 0.10.0.1 && < 0.11,
108113 transformers >= 0.5.2.0 && < 0.6
114+
servant-docs/src/Servant/Docs/Internal.hs+38−167
@@ -25,14 +25,17 @@ import Control.Applicative
2525import Control.Arrow
2626 (second)
2727import Control.Lens
28− (makeLenses, mapped, each, over, set, to, toListOf, traversed, view,
29− _1, (%~), (&), (.~), (<>~), (^.), (|>))
28+ (makeLenses, mapped, over, traversed, view, (%~), (&), (.~),
29+ (<>~), (^.), (|>))
30+import qualified Control.Monad.Omega as Omega
3031import qualified Data.ByteString.Char8 as BSC
3132import Data.ByteString.Lazy.Char8
3233 (ByteString)
3334import qualified Data.CaseInsensitive as CI
3435import Data.Foldable
35− (fold, toList)
36+ (toList)
37+import Data.Foldable
38+ (fold)
3639import Data.Hashable
3740 (Hashable)
3841import Data.HashMap.Strict
@@ -50,21 +53,17 @@ import Data.Ord
5053 (comparing)
5154import Data.Proxy
5255 (Proxy (Proxy))
56+import Data.Semigroup
57+ (Semigroup (..))
5358import Data.String.Conversions
5459 (cs)
5560import Data.Text
5661 (Text, unpack)
5762import GHC.Generics
58− (Generic, Rep, K1(K1), M1(M1), U1(U1), V1,
59− (:*:)((:*:)), (:+:)(L1, R1))
60−import qualified GHC.Generics as G
6163import GHC.TypeLits
6264import Servant.API
6365import Servant.API.ContentTypes
6466import Servant.API.TypeLevel
65−import Servant.API.Generic
66−
67−import qualified Data.Universe.Helpers as U
6867
6968import qualified Data.HashMap.Strict as HM
7069import qualified Data.Text as T
@@ -131,8 +130,7 @@ instance Semigroup API where
131130 (<>) = mappend
132131
133132instance Monoid API where
134− API a1 b1 `mappend` API a2 b2 = API (a1 `mappend` a2)
135− (HM.unionWith combineAction b1 b2)
133+ API a1 b1 `mappend` API a2 b2 = API (a1 `mappend` a2) (b1 `mappend` b2)
136134 mempty = API mempty mempty
137135
138136-- | An empty 'API'
@@ -161,20 +159,6 @@ data DocQueryParam = DocQueryParam
161159 , _paramKind :: ParamKind
162160 } deriving (Eq, Ord, Show)
163161
164−-- | A type to represent fragment. Holds the name of the fragment and its description.
165−--
166−-- Write a 'ToFragment' instance for your fragment types.
167−data DocFragment = DocFragment
168− { _fragSymbol :: String -- type supplied
169− , _fragDesc :: String -- user supplied
170− } deriving (Eq, Ord, Show)
171−
172−-- | There should be at most one 'Fragment' per API endpoint.
173−-- So here we are keeping the first occurrence.
174−combineFragment :: Maybe DocFragment -> Maybe DocFragment -> Maybe DocFragment
175−Nothing `combineFragment` mdocFragment = mdocFragment
176−Just docFragment `combineFragment` _ = Just docFragment
177−
178162-- | An introductory paragraph for your documentation. You can pass these to
179163-- 'docsWithIntros'.
180164data DocIntro = DocIntro
@@ -255,15 +239,6 @@ data Response = Response
255239 , _respHeaders :: [HTTP.Header]
256240 } deriving (Eq, Ord, Show)
257241
258−-- | Combine two Responses, we can't make a monoid because merging Status breaks
259−-- the laws.
260−--
261−-- As such, we invent a non-commutative, left associative operation
262−-- 'combineResponse' to mush two together taking the status from the very left.
263−combineResponse :: Response -> Response -> Response
264−Response s ts bs hs `combineResponse` Response _ ts' bs' hs'
265− = Response s (ts <> ts') (bs <> bs') (hs <> hs')
266−
267242-- | Default response: status code 200, no response body.
268243--
269244-- Can be tweaked with four lenses.
@@ -295,9 +270,8 @@ defResponse = Response
295270data Action = Action
296271 { _authInfo :: [DocAuthentication] -- user supplied info
297272 , _captures :: [DocCapture] -- type collected + user supplied info
298− , _headers :: [HTTP.Header] -- type collected
273+ , _headers :: [Text] -- type collected
299274 , _params :: [DocQueryParam] -- type collected + user supplied info
300− , _fragment :: Maybe DocFragment -- type collected + user supplied info
301275 , _notes :: [DocNote] -- user supplied
302276 , _mxParams :: [(String, [DocQueryParam])] -- type collected + user supplied info
303277 , _rqtypes :: [M.MediaType] -- type collected
@@ -309,11 +283,11 @@ data Action = Action
309283-- laws.
310284--
311285-- As such, we invent a non-commutative, left associative operation
312−-- 'combineAction' to mush two together taking the response from the very left.
286+-- 'combineAction' to mush two together taking the response, body and content
287+-- types from the very left.
313288combineAction :: Action -> Action -> Action
314−Action a c h p f n m ts body resp
315− `combineAction` Action a' c' h' p' f' n' m' ts' body' resp' =
316− Action (a <> a') (c <> c') (h <> h') (p <> p') (f `combineFragment` f') (n <> n') (m <> m') (ts <> ts') (body <> body') (resp `combineResponse` resp')
289+Action a c h p n m ts body resp `combineAction` Action a' c' h' p' n' m' _ _ _ =
290+ Action (a <> a') (c <> c') (h <> h') (p <> p') (n <> n') (m <> m') ts body resp
317291
318292-- | Default 'Action'. Has no 'captures', no query 'params', expects
319293-- no request body ('rqbody') and the typical response is 'defResponse'.
@@ -321,10 +295,10 @@ Action a c h p f n m ts body resp
321295-- Tweakable with lenses.
322296--
323297-- >>> defAction
324−-- Action {_authInfo = [], _captures = [], _headers = [], _params = [], _fragment = Nothing, _notes = [], _mxParams = [], _rqtypes = [], _rqbody = [], _response = Response {_respStatus = 200, _respTypes = [], _respBody = [], _respHeaders = []}}
298+-- Action {_authInfo = [], _captures = [], _headers = [], _params = [], _notes = [], _mxParams = [], _rqtypes = [], _rqbody = [], _response = Response {_respStatus = 200, _respTypes = [], _respBody = [], _respHeaders = []}}
325299--
326300-- >>> defAction & response.respStatus .~ 201
327−-- Action {_authInfo = [], _captures = [], _headers = [], _params = [], _fragment = Nothing, _notes = [], _mxParams = [], _rqtypes = [], _rqbody = [], _response = Response {_respStatus = 201, _respTypes = [], _respBody = [], _respHeaders = []}}
301+-- Action {_authInfo = [], _captures = [], _headers = [], _params = [], _notes = [], _mxParams = [], _rqtypes = [], _rqbody = [], _response = Response {_respStatus = 201, _respTypes = [], _respBody = [], _respHeaders = []}}
328302--
329303defAction :: Action
330304defAction =
@@ -332,7 +306,6 @@ defAction =
332306 []
333307 []
334308 []
335− Nothing
336309 []
337310 []
338311 []
@@ -356,14 +329,12 @@ data ShowContentTypes = AllContentTypes -- ^ For each example, show each conten
356329--
357330-- @since 0.11.1
358331data RenderingOptions = RenderingOptions
359− { _requestExamples :: !ShowContentTypes
332+ { _requestExamples :: !ShowContentTypes
360333 -- ^ How many content types to display for request body examples?
361− , _responseExamples :: !ShowContentTypes
334+ , _responseExamples :: !ShowContentTypes
362335 -- ^ How many content types to display for response body examples?
363− , _notesHeading :: !(Maybe String)
336+ , _notesHeading :: !(Maybe String)
364337 -- ^ Optionally group all 'notes' together under a common heading.
365− , _renderCurlBasePath :: !(Maybe String)
366− -- ^ Optionally render example curl requests under a common base path (e.g. `http://localhost:80`).
367338 } deriving (Show)
368339
369340-- | Default API generation options.
@@ -375,10 +346,9 @@ data RenderingOptions = RenderingOptions
375346-- @since 0.11.1
376347defRenderingOptions :: RenderingOptions
377348defRenderingOptions = RenderingOptions
378− { _requestExamples = AllContentTypes
379− , _responseExamples = AllContentTypes
380− , _notesHeading = Nothing
381− , _renderCurlBasePath = Nothing
349+ { _requestExamples = AllContentTypes
350+ , _responseExamples = AllContentTypes
351+ , _notesHeading = Nothing
382352 }
383353
384354-- gimme some lenses
@@ -388,7 +358,6 @@ makeLenses ''API
388358makeLenses ''Endpoint
389359makeLenses ''DocCapture
390360makeLenses ''DocQueryParam
391−makeLenses ''DocFragment
392361makeLenses ''DocIntro
393362makeLenses ''DocNote
394363makeLenses ''Response
@@ -415,9 +384,9 @@ docsWithOptions p = docsFor p (defEndpoint, defAction)
415384-- > extra :: ExtraInfo TestApi
416385-- > extra =
417386-- > extraInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
418−-- > defAction & headers <>~ [("X-Num-Unicorns", 1)]
387+-- > defAction & headers <>~ ["unicorns"]
419388-- > & notes <>~ [ DocNote "Title" ["This is some text"]
420−-- > , DocNote "Second section" ["And some more"]
389+-- > , DocNote "Second secton" ["And some more"]
421390-- > ]
422391
423392extraInfo :: (IsIn endpoint api, HasLink endpoint, HasDocs endpoint)
@@ -510,22 +479,22 @@ samples = map ("",)
510479
511480-- | Default sample Generic-based inputs/outputs.
512481defaultSamples :: forall a. (Generic a, GToSample (Rep a)) => Proxy a -> [(Text, a)]
513−defaultSamples _ = second G.to <$> gtoSamples (Proxy :: Proxy (Rep a))
482+defaultSamples _ = Omega.runOmega $ second to <$> gtoSamples (Proxy :: Proxy (Rep a))
514483
515484-- | @'ToSample'@ for Generics.
516485--
517−-- Note: we use combinators from "Universe.Data.Helpers" for more productive sample generation.
486+-- The use of @'Omega'@ allows for more productive sample generation.
518487class GToSample t where
519− gtoSamples :: proxy t -> [(Text, t x)]
488+ gtoSamples :: proxy t -> Omega.Omega (Text, t x)
520489
521490instance GToSample U1 where
522− gtoSamples _ = singleSample U1
491+ gtoSamples _ = Omega.each (singleSample U1)
523492
524493instance GToSample V1 where
525494 gtoSamples _ = empty
526495
527496instance (GToSample p, GToSample q) => GToSample (p :*: q) where
528− gtoSamples _ = U.cartesianProduct render ps qs
497+ gtoSamples _ = render <$> ps <*> qs
529498 where
530499 ps = gtoSamples (Proxy :: Proxy p)
531500 qs = gtoSamples (Proxy :: Proxy q)
@@ -534,13 +503,13 @@ instance (GToSample p, GToSample q) => GToSample (p :*: q) where
534503 | otherwise = (ta <> ", " <> tb, a :*: b)
535504
536505instance (GToSample p, GToSample q) => GToSample (p :+: q) where
537− gtoSamples _ = lefts U.+++ rights
506+ gtoSamples _ = lefts <|> rights
538507 where
539508 lefts = second L1 <$> gtoSamples (Proxy :: Proxy p)
540509 rights = second R1 <$> gtoSamples (Proxy :: Proxy q)
541510
542511instance ToSample a => GToSample (K1 i a) where
543− gtoSamples _ = second K1 <$> toSamples (Proxy :: Proxy a)
512+ gtoSamples _ = second K1 <$> Omega.each (toSamples (Proxy :: Proxy a))
544513
545514instance (GToSample f) => GToSample (M1 i a f) where
546515 gtoSamples _ = second M1 <$> gtoSamples (Proxy :: Proxy f)
@@ -608,15 +577,6 @@ class ToCapture c where
608577class ToAuthInfo a where
609578 toAuthInfo :: Proxy a -> DocAuthentication
610579
611−-- | The class that helps us get documentation for URL fragments.
612−--
613−-- Example of an instance:
614−--
615−-- > instance ToFragment (Fragment a) where
616−-- > toFragment _ = DocFragment "fragment" "fragment description"
617−class ToFragment t where
618− toFragment :: Proxy t -> DocFragment
619−
620580-- | Generate documentation in Markdown format for
621581-- the given 'API'.
622582--
@@ -646,7 +606,7 @@ markdown = markdownWith defRenderingOptions
646606--
647607-- @since 0.11.1
648608markdownWith :: RenderingOptions -> API -> String
649−markdownWith RenderingOptions{..} api = unlines $
609+markdownWith RenderingOptions{..} api = unlines $
650610 introsStr (api ^. apiIntros)
651611 ++ (concatMap (uncurry printEndpoint) . sort . HM.toList $ api ^. apiEndpoints)
652612
@@ -657,12 +617,10 @@ markdownWith RenderingOptions{..} api = unlines $
657617 notesStr (action ^. notes) ++
658618 authStr (action ^. authInfo) ++
659619 capturesStr (action ^. captures) ++
660− headersStr (toListOf (headers . each . _1 . to (T.pack . BSC.unpack . CI.original)) action) ++
620+ headersStr (action ^. headers) ++
661621 paramsStr meth (action ^. params) ++
662− fragmentStr (action ^. fragment) ++
663622 rqbodyStr (action ^. rqtypes) (action ^. rqbody) ++
664623 responseStr (action ^. response) ++
665− maybe [] (curlStr endpoint (action ^. headers) (action ^. rqbody)) _renderCurlBasePath ++
666624 []
667625
668626 where str = "## " ++ BSC.unpack meth
@@ -762,14 +720,6 @@ markdownWith RenderingOptions{..} api = unlines $
762720
763721 where values = param ^. paramValues
764722
765− fragmentStr :: Maybe DocFragment -> [String]
766− fragmentStr Nothing = []
767− fragmentStr (Just frag) =
768− [ "### Fragment:", ""
769− , "- *" ++ (frag ^. fragSymbol) ++ "*: " ++ (frag ^. fragDesc)
770− , ""
771− ]
772−
773723 rqbodyStr :: [M.MediaType] -> [(Text, M.MediaType, ByteString)]-> [String]
774724 rqbodyStr [] [] = []
775725 rqbodyStr types s =
@@ -818,6 +768,7 @@ markdownWith RenderingOptions{..} api = unlines $
818768 ("text", "css") -> "css"
819769 (_, _) -> ""
820770
771+
821772 contentStr mime_type body =
822773 "" :
823774 "```" <> markdownForType mime_type :
@@ -842,36 +793,6 @@ markdownWith RenderingOptions{..} api = unlines $
842793 xs ->
843794 formatBodies _responseExamples xs
844795
845− curlStr :: Endpoint -> [HTTP.Header] -> [(Text, M.MediaType, ByteString)] -> String -> [String]
846− curlStr endpoint hdrs reqBodies basePath =
847− [ "### Sample Request:"
848− , ""
849− , "```bash"
850− , "curl -X" ++ BSC.unpack (endpoint ^. method) ++ " \\"
851− ] <>
852− maybe [] pure mbMediaTypeStr <>
853− headersStrs <>
854− maybe [] pure mbReqBodyStr <>
855− [ " " ++ basePath ++ showPath (endpoint ^. path)
856− , "```"
857− , ""
858− ]
859−
860− where escapeQuotes :: String -> String
861− escapeQuotes = concatMap $ \c -> case c of
862− '\"' -> "\\\""
863− _ -> [c]
864− mbReqBody = listToMaybe reqBodies
865− mbMediaTypeStr = mkMediaTypeStr <$> mbReqBody
866− headersStrs = mkHeaderStr <$> hdrs
867− mbReqBodyStr = mkReqBodyStr <$> mbReqBody
868− mkMediaTypeStr (_, media_type, _) =
869− " -H \"Content-Type: " ++ show media_type ++ "\" \\"
870− mkHeaderStr (hdrName, hdrVal) =
871− " -H \"" ++ escapeQuotes (cs (CI.original hdrName)) ++ ": " ++
872− escapeQuotes (cs hdrVal) ++ "\" \\"
873− mkReqBodyStr (_, _, body) = " -d \"" ++ escapeQuotes (cs body) ++ "\" \\"
874−
875796-- * Instances
876797
877798-- | The generated docs for @a ':<|>' b@ just appends the docs
@@ -895,7 +816,7 @@ instance HasDocs EmptyAPI where
895816-- | @"books" :> 'Capture' "isbn" Text@ will appear as
896817-- @/books/:isbn@ in the docs.
897818instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api)
898− => HasDocs (Capture' '[] sym a :> api) where
819+ => HasDocs (Capture' mods sym a :> api) where
899820
900821 docsFor Proxy (endpoint, action) =
901822 docsFor subApiP (endpoint', action')
@@ -907,28 +828,6 @@ instance (KnownSymbol sym, ToCapture (Capture sym a), HasDocs api)
907828 endpoint' = over path (\p -> p ++ [":" ++ symbolVal symP]) endpoint
908829 symP = Proxy :: Proxy sym
909830
910−instance (KnownSymbol descr, KnownSymbol sym, HasDocs api)
911− => HasDocs (Capture' (Description descr ': mods) sym a :> api) where
912−
913− docsFor Proxy (endpoint, action) =
914− docsFor subApiP (endpoint', action')
915−
916− where subApiP = Proxy :: Proxy api
917−
918− docCapture = DocCapture (symbolVal symP) (symbolVal descrP)
919− action' = over captures (|> docCapture) action
920− endpoint' = over path (\p -> p ++ [":" ++ symbolVal symP]) endpoint
921− descrP = Proxy :: Proxy descr
922− symP = Proxy :: Proxy sym
923−
924−instance {-# OVERLAPPABLE #-} HasDocs (Capture' mods sym a :> api)
925− => HasDocs (Capture' (mod ': mods) sym a :> api) where
926−
927− docsFor Proxy =
928− docsFor apiP
929−
930− where apiP = Proxy :: Proxy (Capture' mods sym a :> api)
931−
932831
933832-- | @"books" :> 'CaptureAll' "isbn" Text@ will appear as
934833-- @/books/:isbn@ in the docs.
@@ -962,18 +861,6 @@ instance {-# OVERLAPPABLE #-}
962861 status = fromInteger $ natVal (Proxy :: Proxy status)
963862 p = Proxy :: Proxy a
964863
965−instance (ReflectMethod method) =>
966− HasDocs (NoContentVerb method) where
967− docsFor Proxy (endpoint, action) DocOptions{..} =
968− single endpoint' action'
969−
970− where endpoint' = endpoint & method .~ method'
971− action' = action & response.respStatus .~ 204
972− & response.respTypes .~ []
973− & response.respBody .~ []
974− & response.respHeaders .~ []
975− method' = reflectMethod (Proxy :: Proxy method)
976−
977864-- | TODO: mention the endpoint is streaming, its framing strategy
978865--
979866-- Also there are no samples.
@@ -1010,17 +897,14 @@ instance {-# OVERLAPPING #-}
1010897 status = fromInteger $ natVal (Proxy :: Proxy status)
1011898 p = Proxy :: Proxy a
1012899
1013−instance (ToHttpApiData a, ToSample a, KnownSymbol sym, HasDocs api)
900+instance (KnownSymbol sym, HasDocs api)
1014901 => HasDocs (Header' mods sym a :> api) where
1015902 docsFor Proxy (endpoint, action) =
1016903 docsFor subApiP (endpoint, action')
1017904
1018905 where subApiP = Proxy :: Proxy api
1019− action' = over headers (|> (headerName, headerVal)) action
1020− headerName = CI.mk . cs $ symbolVal (Proxy :: Proxy sym)
1021− headerVal = case toSample (Proxy :: Proxy a) of
1022− Just x -> cs $ toHeader x
1023− Nothing -> "<no header sample provided>"
906+ action' = over headers (|> headername) action
907+ headername = T.pack $ symbolVal (Proxy :: Proxy sym)
1024908
1025909instance (KnownSymbol sym, ToParam (QueryParam' mods sym a), HasDocs api)
1026910 => HasDocs (QueryParam' mods sym a :> api) where
@@ -1053,15 +937,6 @@ instance (KnownSymbol sym, ToParam (QueryFlag sym), HasDocs api)
1053937 paramP = Proxy :: Proxy (QueryFlag sym)
1054938 action' = over params (|> toParam paramP) action
1055939
1056−instance (ToFragment (Fragment a), HasDocs api)
1057− => HasDocs (Fragment a :> api) where
1058−
1059− docsFor Proxy (endpoint, action) =
1060− docsFor subApiP (endpoint, action')
1061−
1062− where subApiP = Proxy :: Proxy api
1063− fragmentP = Proxy :: Proxy (Fragment a)
1064− action' = set fragment (Just (toFragment fragmentP)) action
1065940
1066941instance HasDocs Raw where
1067942 docsFor _proxy (endpoint, action) _ =
@@ -1151,9 +1026,6 @@ instance (ToAuthInfo (BasicAuth realm usr), HasDocs api) => HasDocs (BasicAuth r
11511026 authProxy = Proxy :: Proxy (BasicAuth realm usr)
11521027 action' = over authInfo (|> toAuthInfo authProxy) action
11531028
1154−instance HasDocs (ToServantApi api) => HasDocs (NamedRoutes api) where
1155− docsFor Proxy = docsFor (Proxy :: Proxy (ToServantApi api))
1156−
11571029-- ToSample instances for simple types
11581030instance ToSample NoContent
11591031instance ToSample Bool
@@ -1170,7 +1042,6 @@ instance (ToSample a, ToSample b, ToSample c, ToSample d, ToSample e, ToSample f
11701042instance ToSample a => ToSample (Maybe a)
11711043instance (ToSample a, ToSample b) => ToSample (Either a b)
11721044instance ToSample a => ToSample [a]
1173−instance ToSample a => ToSample (NonEmpty a)
11741045
11751046-- ToSample instances for Control.Applicative types
11761047instance ToSample a => ToSample (Const a b)
servant-docs/src/Servant/Docs/Internal/Pretty.hs−19
@@ -18,7 +18,6 @@ import Data.Proxy
1818import Network.HTTP.Media
1919 ((//))
2020import Servant.API
21−import Servant.API.Verbs
2221
2322-- | PrettyJSON content type.
2423data PrettyJSON
@@ -47,24 +46,6 @@ type family Pretty (api :: k) :: k where
4746 Pretty (Put cs r) = Put (Pretty cs) r
4847 Pretty (Delete cs r) = Delete (Pretty cs) r
4948 Pretty (Patch cs r) = Patch (Pretty cs) r
50− Pretty (GetPartialContent cs r) = GetPartialContent (Pretty cs) r
51− Pretty (PutResetContent cs r) = PutResetContent (Pretty cs) r
52− Pretty (PatchResetContent cs r) = PatchResetContent (Pretty cs) r
53− Pretty (DeleteResetContent cs r) = DeleteResetContent (Pretty cs) r
54− Pretty (PostResetContent cs r) = PostResetContent (Pretty cs) r
55− Pretty (GetResetContent cs r) = GetResetContent (Pretty cs) r
56− Pretty (PutNonAuthoritative cs r) = PutNonAuthoritative (Pretty cs) r
57− Pretty (PatchNonAuthoritative cs r) = PatchNonAuthoritative (Pretty cs) r
58− Pretty (DeleteNonAuthoritative cs r) = DeleteNonAuthoritative (Pretty cs) r
59− Pretty (PostNonAuthoritative cs r) = PostNonAuthoritative (Pretty cs) r
60− Pretty (GetNonAuthoritative cs r) = GetNonAuthoritative (Pretty cs) r
61− Pretty (PutAccepted cs r) = PutAccepted (Pretty cs) r
62− Pretty (PatchAccepted cs r) = PatchAccepted (Pretty cs) r
63− Pretty (DeleteAccepted cs r) = DeleteAccepted (Pretty cs) r
64− Pretty (PostAccepted cs r) = PostAccepted (Pretty cs) r
65− Pretty (GetAccepted cs r) = GetAccepted (Pretty cs) r
66− Pretty (PutCreated cs r) = PutCreated (Pretty cs) r
67− Pretty (PostCreated cs r) = PostCreated (Pretty cs) r
6849 Pretty (ReqBody cs r) = ReqBody (Pretty cs) r
6950 Pretty (JSON ': xs) = PrettyJSON ': xs
7051 Pretty (x ': xs) = x ': Pretty xs
servant-docs/test/Servant/DocsSpec.hs+6−21
@@ -58,8 +58,6 @@ instance ToCapture (Capture "foo" Int) where
5858 toCapture _ = DocCapture "foo" "Capture foo Int"
5959instance ToCapture (CaptureAll "foo" Int) where
6060 toCapture _ = DocCapture "foo" "Capture all foo Int"
61−instance ToFragment (Fragment Int) where
62− toFragment _ = DocFragment "foo" "Fragment Int"
6361
6462-- * specs
6563
@@ -68,10 +66,8 @@ spec = describe "Servant.Docs" $ do
6866 golden "comprehensive API" "golden/comprehensive.md" (markdown comprehensiveDocs)
6967
7068 describe "markdown" $ do
71− let md1 = markdown (docs (Proxy :: Proxy TestApi1))
72− tests1 md1
73− let md2 = markdown (docs (Proxy :: Proxy TestApi2))
74− tests2 md2
69+ let md = markdown (docs (Proxy :: Proxy TestApi1))
70+ tests md
7571
7672 describe "markdown with extra info" $ do
7773 let
@@ -83,7 +79,7 @@ spec = describe "Servant.Docs" $ do
8379 (Proxy :: Proxy (ReqBody '[JSON] String :> Post '[JSON] Datatype1))
8480 (defAction & notes <>~ [DocNote "Post data" ["Posts some Json data"]])
8581 md = markdown (docsWith defaultDocOptions [] extra (Proxy :: Proxy TestApi1))
86− tests1 md
82+ tests md
8783 it "contains the extra info provided" $ do
8884 md `shouldContain` "Get an Integer"
8985 md `shouldContain` "Post data"
@@ -111,7 +107,7 @@ spec = describe "Servant.Docs" $ do
111107
112108
113109 where
114− tests1 md = do
110+ tests md = do
115111 it "mentions supported content-types" $ do
116112 md `shouldContain` "application/json"
117113 md `shouldContain` "text/plain;charset=utf-8"
@@ -126,21 +122,14 @@ spec = describe "Servant.Docs" $ do
126122 it "mentions headers" $ do
127123 md `shouldContain` "- This endpoint is sensitive to the value of the **X-Test** HTTP header."
128124
129− it "contains response samples - dt1field1" $
130− md `shouldContain` "\"dt1field1\":\"field 1\""
131− it "contains response samples - dt1field2" $
132− md `shouldContain` "\"dt1field2\":13"
125+ it "contains response samples" $
126+ md `shouldContain` "{\"dt1field1\":\"field 1\",\"dt1field2\":13}"
133127 it "contains request body samples" $
134128 md `shouldContain` "17"
135129
136130 it "does not generate any docs mentioning the 'empty-api' path" $
137131 md `shouldNotContain` "empty-api"
138132
139− tests2 md = do
140− it "mentions the content-types from both copies of the route" $ do
141− md `shouldContain` "application/json"
142− md `shouldContain` "text/plain;charset=utf-8"
143−
144133
145134-- * APIs
146135
@@ -167,10 +156,6 @@ type TestApi1 = Get '[JSON, PlainText] (Headers '[Header "Location" String] Int)
167156 :<|> Header "X-Test" Int :> Put '[JSON] Int
168157 :<|> "empty-api" :> EmptyAPI
169158
170−type TestApi2 = "duplicate-endpoint" :> Get '[JSON] Datatype1
171− :<|> "duplicate-endpoint" :> Get '[PlainText] Int
172−
173−
174159data TT = TT1 | TT2 deriving (Show, Eq)
175160data UT = UT1 | UT2 deriving (Show, Eq)
176161
servant-foreign/CHANGELOG.md−87
@@ -1,93 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-foreign/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−0.15.4
5−------
6−
7−### Significant changes
8−
9−- Documentation improvements.
10−
11−### Other changes
12−
13−- Support GHC-9.0.1.
14−- Bump `lens` and `hspec` dependencies.
15−
16−0.15.3
17−------
18−
19−### Significant changes
20−
21−- Support `Fragment` combinator.
22−
23−0.15.2
24−------
25−
26−* Support `servant-0.18`.
27−
28−0.15.1
29−------
30−
31−* Support `servant-0.17`
32−
33−0.15
34−----
35−
36−- *servant-foreign* Add support so `HasForeign` can be implemented for
37− `MultipartForm` from [`servant-multipart`](http://hackage.haskell.org/package/servant-multipart)
38− [#1035](https://github.com/haskell-servant/servant/pull/1035)
39−
40−- Drop support for GHC older than 8.0
41− [#1008](https://github.com/haskell-servant/servant/pull/1008)
42− [#1009](https://github.com/haskell-servant/servant/pull/1009)
43−
44−
45−0.11.1
46−------
47−
48−- Add missing `Semigroup` instances
49−
50−0.11
51−----
52−
53−### Breaking changes
54−
55−- *servant* Add `Servant.API.Modifiers`
56− ([#873](https://github.com/haskell-servant/servant/pull/873))
57−- Make foreign client Header arguments have the representation of 'Maybe' in those languages
58− ([#843](https://github.com/haskell-servant/servant/pull/843))
59−
60−0.10.2
61−------
62−
63−### Changes
64−
65−* Add instances for `Description` and `Summary` combinators
66− ([#767](https://github.com/haskell-servant/servant/pull/767))
67−* Derive Data for all types
68− ([#809](https://github.com/haskell-servant/servant/pull/809))
69−
70−0.10.1
71−------
72−
73−### Changes
74−
75−* Don't drop samples in `HasDocs ReqBody` instance
76− ([#755](https://github.com/haskell-servant/servant/pull/755/files)).
77− *Breaking change in an `Internal` module*.
78−
79−0.10
80−----
81−
82−### Breaking changes
83−
84−* Do not apply JavaScript specific mangling to the names.
85− ([#191](https://github.com/haskell-servant/servant/issues/191))
86−
87−0.7.1
88−-----
89−
90−* Support GHC 8.0
9140.15
925----
936
servant-foreign/servant-foreign.cabal+19−13
@@ -1,6 +1,7 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-foreign
3−version: 0.15.4
3+version: 0.15
4+x-revision: 1
45
56synopsis: Helpers for generating clients for servant APIs in any programming language
67category: Servant, Web
@@ -13,15 +14,19 @@ description:
1314 .
1415 <https://github.com/haskell-servant/servant/blob/master/servant-foreign/CHANGELOG.md CHANGELOG>
1516
16−homepage: http://docs.servant.dev/
17+homepage: http://haskell-servant.readthedocs.org/
1718bug-reports: http://github.com/haskell-servant/servant/issues
18−license: BSD-3-Clause
19+license: BSD3
1920license-file: LICENSE
2021author: Servant Contributors
2122maintainer: haskell-servant-maintainers@googlegroups.com
2223copyright: 2015-2019 Servant Contributors
2324build-type: Simple
24−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
25+tested-with:
26+ GHC ==8.0.2
27+ || ==8.2.2
28+ || ==8.4.4
29+ || ==8.6.3
2530
2631extra-source-files:
2732 CHANGELOG.md
@@ -41,18 +46,18 @@ library
4146 --
4247 -- note: mtl lower bound is so low because of GHC-7.8
4348 build-depends:
44− base >= 4.9 && < 4.17
45− , text >= 1.2.3.0 && < 2.1
49+ base >= 4.9 && < 4.13
50+ , text >= 1.2.3.0 && < 1.3
4651
4752 -- Servant dependencies
4853 build-depends:
49− servant >=0.18 && <0.20
54+ servant >=0.15 && <0.17
5055
5156 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
5257 -- Here can be exceptions if we really need features from the newer versions.
5358 build-depends:
54− base-compat >= 0.10.5 && < 0.13
55− , lens >= 4.17 && < 5.2
59+ base-compat >= 0.10.5 && < 0.11
60+ , lens >= 4.17 && < 4.18
5661 , http-types >= 0.12.2 && < 0.13
5762
5863 hs-source-dirs: src
@@ -72,9 +77,10 @@ test-suite spec
7277 , servant
7378 , servant-foreign
7479
75− -- Additional dependencies
80+ -- Additonal dependencies
7681 build-depends:
77− hspec >= 2.6.0 && <2.10
82+ hspec >= 2.6.0 && <2.8
83+
7884 build-tool-depends:
79− hspec-discover:hspec-discover >=2.6.0 && <2.10
85+ hspec-discover:hspec-discover >=2.6.0 && <2.8
8086 default-language: Haskell2010
servant-foreign/src/Servant/Foreign.hs+19−22
@@ -1,32 +1,20 @@
11-- | Generalizes all the data needed to make code generation work with
22-- arbitrary programming languages.
3−--
4−-- See documentation of 'HasForeignType' for a simple example. 'listFromAPI' returns a list of all your endpoints and their foreign types, given a mapping from Haskell types to foreign types (conventionally called `ftypes` below).
53module Servant.Foreign
6− (
7− -- * Main API
8− listFromAPI
4+ ( ArgType(..)
5+ , HeaderArg(..)
6+ , QueryArg(..)
97 , Req(..)
10− , defReq
11− , HasForeignType(..)
12− , GenerateList(..)
13− , HasForeign(..)
14− , NoTypes
15− -- * Subtypes of 'Req'
16− , Url(..)
17− , Path
8+ , ReqBodyContentType(..)
189 , Segment(..)
1910 , SegmentType(..)
20− , isCapture
21− , captureArg
22− , QueryArg(..)
23− , ArgType(..)
24− , HeaderArg(..)
11+ , Url(..)
12+ -- aliases
13+ , Path
2514 , Arg(..)
2615 , FunctionName(..)
27− , ReqBodyContentType(..)
2816 , PathSegment(..)
29− -- * Lenses
17+ -- lenses
3018 , argName
3119 , argType
3220 , argPath
@@ -42,7 +30,7 @@ module Servant.Foreign
4230 , queryArgName
4331 , queryArgType
4432 , headerArg
45− -- * Prisms
33+ -- prisms
4634 , _PathSegment
4735 , _HeaderArg
4836 , _ReplaceHeaderArg
@@ -51,7 +39,16 @@ module Servant.Foreign
5139 , _Normal
5240 , _Flag
5341 , _List
54− -- * Re-exports
42+ -- rest of it
43+ , HasForeign(..)
44+ , HasForeignType(..)
45+ , GenerateList(..)
46+ , NoTypes
47+ , captureArg
48+ , isCapture
49+ , defReq
50+ , listFromAPI
51+ -- re-exports
5552 , module Servant.API
5653 , module Servant.Foreign.Inflections
5754 ) where
servant-foreign/src/Servant/Foreign/Inflections.hs+13−18
@@ -13,37 +13,27 @@ module Servant.Foreign.Inflections
1313import Control.Lens hiding
1414 (cons)
1515import qualified Data.Char as C
16+import Data.Monoid
1617import Data.Text hiding
1718 (map)
1819import Prelude hiding
1920 (head, tail)
2021import Servant.Foreign.Internal
2122
22−-- | Simply concat each part of the FunctionName together.
23−--
24−-- @[ "get", "documents", "by", "id" ] → "getdocumentsbyid"@
25−concatCase :: FunctionName -> Text
26−concatCase = view concatCaseL
27−
2823concatCaseL :: Getter FunctionName Text
2924concatCaseL = _FunctionName . to mconcat
3025
31−-- | Use the snake_case convention.
32−-- Each part is separated by a single underscore character.
33−--
34−-- @[ "get", "documents", "by", "id" ] → "get_documents_by_id"@
35−snakeCase :: FunctionName -> Text
36−snakeCase = view snakeCaseL
26+-- | Function name builder that simply concat each part together
27+concatCase :: FunctionName -> Text
28+concatCase = view concatCaseL
3729
3830snakeCaseL :: Getter FunctionName Text
3931snakeCaseL = _FunctionName . to (intercalate "_")
4032
41−-- | Use the camelCase convention.
42−-- The first part is lower case, every other part starts with an upper case character.
43−--
44−-- @[ "get", "documents", "by", "id" ] → "getDocumentsById"@
45−camelCase :: FunctionName -> Text
46−camelCase = view camelCaseL
33+-- | Function name builder using the snake_case convention.
34+-- each part is separated by a single underscore character.
35+snakeCase :: FunctionName -> Text
36+snakeCase = view snakeCaseL
4737
4838camelCaseL :: Getter FunctionName Text
4939camelCaseL = _FunctionName . to convert
@@ -52,3 +42,8 @@ camelCaseL = _FunctionName . to convert
5242 convert (p:ps) = mconcat $ p : map capitalize ps
5343 capitalize "" = ""
5444 capitalize name = C.toUpper (head name) `cons` tail name
45+
46+-- | Function name builder using the CamelCase convention.
47+-- each part begins with an upper case character.
48+camelCase :: FunctionName -> Text
49+camelCase = view camelCaseL
servant-foreign/src/Servant/Foreign/Internal.hs+32−147
@@ -13,6 +13,8 @@
1313{-# LANGUAGE TypeOperators #-}
1414{-# LANGUAGE UndecidableInstances #-}
1515
16+-- | Generalizes all the data needed to make code generation work with
17+-- arbitrary programming languages.
1618module Servant.Foreign.Internal where
1719
1820import Prelude ()
@@ -23,6 +25,8 @@ import Control.Lens
2325import Data.Data
2426 (Data)
2527import Data.Proxy
28+import Data.Semigroup
29+ (Semigroup)
2630import Data.String
2731import Data.Text
2832import Data.Text.Encoding
@@ -36,75 +40,50 @@ import Servant.API.Modifiers
3640 (RequiredArgument)
3741import Servant.API.TypeLevel
3842
39−-- | Canonical name of the endpoint, can be used to generate a function name.
40−--
41−-- You can use the functions in "Servant.Foreign.Inflections", like 'Servant.Foreign.Inflections.camelCase' to transform to `Text`.
4243newtype FunctionName = FunctionName { unFunctionName :: [Text] }
4344 deriving (Data, Show, Eq, Semigroup, Monoid, Typeable)
4445
4546makePrisms ''FunctionName
4647
47−-- | See documentation of 'Arg'
4848newtype PathSegment = PathSegment { unPathSegment :: Text }
4949 deriving (Data, Show, Eq, IsString, Semigroup, Monoid, Typeable)
5050
5151makePrisms ''PathSegment
5252
53−-- | Maps a name to the foreign type that belongs to the annotated value.
54−--
55−-- Used for header args, query args, and capture args.
56−data Arg ftype = Arg
53+data Arg f = Arg
5754 { _argName :: PathSegment
58− -- ^ The name to be captured.
59− --
60− -- Only for capture args it really denotes a path segment.
61− , _argType :: ftype
62− -- ^ Foreign type the associated value will have
63− }
55+ , _argType :: f }
6456 deriving (Data, Eq, Show, Typeable)
6557
6658makeLenses ''Arg
6759
68−argPath :: Getter (Arg ftype) Text
60+argPath :: Getter (Arg f) Text
6961argPath = argName . _PathSegment
7062
71−data SegmentType ftype
63+data SegmentType f
7264 = Static PathSegment
73− -- ^ Static path segment.
74− --
75− -- @"foo\/bar\/baz"@
76− --
77− -- contains the static segments @"foo"@, @"bar"@ and @"baz"@.
78− | Cap (Arg ftype)
79− -- ^ A capture.
80− --
81− -- @"user\/{userid}\/name"@
82− --
83− -- would capture the arg @userid@ with type @ftype@.
65+ -- ^ a static path segment. like "/foo"
66+ | Cap (Arg f)
67+ -- ^ a capture. like "/:userid"
8468 deriving (Data, Eq, Show, Typeable)
8569
8670makePrisms ''SegmentType
8771
88−-- | A part of the Url’s path.
89−newtype Segment ftype = Segment { unSegment :: SegmentType ftype }
72+newtype Segment f = Segment { unSegment :: SegmentType f }
9073 deriving (Data, Eq, Show, Typeable)
9174
9275makePrisms ''Segment
9376
94−-- | Whether a segment is a 'Cap'.
95−isCapture :: Segment ftype -> Bool
77+isCapture :: Segment f -> Bool
9678isCapture (Segment (Cap _)) = True
9779isCapture _ = False
9880
99−-- | Crashing Arg extraction from segment, TODO: remove
100−captureArg :: Segment ftype -> Arg ftype
81+captureArg :: Segment f -> Arg f
10182captureArg (Segment (Cap s)) = s
10283captureArg _ = error "captureArg called on non capture"
10384
104−-- TODO: remove, unnecessary indirection
105−type Path ftype = [Segment ftype]
85+type Path f = [Segment f]
10686
107−-- | Type of a 'QueryArg'.
10887data ArgType
10988 = Normal
11089 | Flag
@@ -113,41 +92,18 @@ data ArgType
11392
11493makePrisms ''ArgType
11594
116−-- | Url Query argument.
117−--
118−-- Urls can contain query arguments, which is a list of key-value pairs.
119−-- In a typical url, query arguments look like this:
120−--
121−-- @?foo=bar&alist[]=el1&alist[]=el2&aflag@
122−--
123−-- Each pair can be
124−--
125−-- * @?foo=bar@: a plain key-val pair, either optional or required ('QueryParam')
126−-- * @?aflag@: a flag (no value, implicitly Bool with default `false` if it’s missing) ('QueryFlag')
127−-- * @?alist[]=el1&alist[]=el2@: list of values ('QueryParams')
128−--
129−-- @_queryArgType@ will be set accordingly.
130−--
131−-- For the plain key-val pairs ('QueryParam'), @_queryArgName@’s @ftype@ will be wrapped in a @Maybe@ if the argument is optional.
132−data QueryArg ftype = QueryArg
133− { _queryArgName :: Arg ftype
134− -- ^ Name and foreign type of the argument. Will be wrapped in `Maybe` if the query is optional and in a `[]` if the query is a list
95+data QueryArg f = QueryArg
96+ { _queryArgName :: Arg f
13597 , _queryArgType :: ArgType
136− -- ^ one of normal/plain, list or flag
13798 }
13899 deriving (Data, Eq, Show, Typeable)
139100
140101makeLenses ''QueryArg
141102
142−data HeaderArg ftype =
143− -- | The name of the header and the foreign type of its value.
144− HeaderArg
145− { _headerArg :: Arg ftype }
146− -- | Unused, will never be set.
147− --
148− -- TODO: remove
103+data HeaderArg f = HeaderArg
104+ { _headerArg :: Arg f }
149105 | ReplaceHeaderArg
150− { _headerArg :: Arg ftype
106+ { _headerArg :: Arg f
151107 , _headerPattern :: Text
152108 }
153109 deriving (Data, Eq, Show, Typeable)
@@ -156,71 +112,28 @@ makeLenses ''HeaderArg
156112
157113makePrisms ''HeaderArg
158114
159−-- | Full endpoint url, with all captures and parameters
160−data Url ftype = Url
161− { _path :: Path ftype
162− -- ^ Url path, list of either static segments or captures
163− --
164− -- @"foo\/{id}\/bar"@
165− , _queryStr :: [QueryArg ftype]
166− -- ^ List of query args
167− --
168− -- @"?foo=bar&a=b"@
169− , _frag :: Maybe ftype
170− -- ^ Url fragment.
171− --
172− -- Not sent to the HTTP server, so only useful for frontend matters (e.g. inter-page linking).
173− --
174− -- @#fragmentText@
115+data Url f = Url
116+ { _path :: Path f
117+ , _queryStr :: [QueryArg f]
175118 }
176119 deriving (Data, Eq, Show, Typeable)
177120
178−defUrl :: Url ftype
179−defUrl = Url [] [] Nothing
121+defUrl :: Url f
122+defUrl = Url [] []
180123
181124makeLenses ''Url
182125
183−-- | See documentation of '_reqBodyContentType'
184126data ReqBodyContentType = ReqBodyJSON | ReqBodyMultipart
185127 deriving (Data, Eq, Show, Read)
186128
187−-- | Full description of an endpoint in your API, generated by 'listFromAPI'. It should give you all the information needed to generate foreign language bindings.
188−--
189−-- Every field containing @ftype@ will use the foreign type mapping specified via 'HasForeignType' (see its docstring on how to set that up).
190−--
191−-- See https://docs.servant.dev/en/stable/tutorial/ApiType.html for accessible documentation of the possible content of an endpoint.
192−data Req ftype = Req
193− { _reqUrl :: Url ftype
194− -- ^ Full list of URL segments, including captures
129+data Req f = Req
130+ { _reqUrl :: Url f
195131 , _reqMethod :: HTTP.Method
196− -- ^ @\"GET\"@\/@\"POST\"@\/@\"PUT\"@\/…
197− , _reqHeaders :: [HeaderArg ftype]
198− -- ^ Headers required by this endpoint, with their type
199− , _reqBody :: Maybe ftype
200− -- ^ Foreign type of the expected request body ('ReqBody'), if any
201− , _reqReturnType :: Maybe ftype
202− -- ^ The foreign type of the response, if any
132+ , _reqHeaders :: [HeaderArg f]
133+ , _reqBody :: Maybe f
134+ , _reqReturnType :: Maybe f
203135 , _reqFuncName :: FunctionName
204− -- ^ The URL segments rendered in a way that they can be easily concatenated into a canonical function name
205136 , _reqBodyContentType :: ReqBodyContentType
206− -- ^ The content type the request body is transferred as.
207− --
208− -- This is a severe limitation of @servant-foreign@ currently,
209− -- as we only allow the content type to be `JSON`
210− -- no user-defined content types. ('ReqBodyMultipart' is not
211− -- actually implemented.)
212− --
213− -- Thus, any routes looking like this will work:
214− --
215− -- @"foo" :> Get '[JSON] Foo@
216− --
217− -- while routes like
218− --
219− -- @"foo" :> Get '[MyFancyContentType] Foo@
220− --
221− -- will fail with an error like
222− --
223− -- @• JSON expected in list '[MyFancyContentType]@
224137 }
225138 deriving (Data, Eq, Show, Typeable)
226139
@@ -244,7 +157,7 @@ defReq = Req defUrl "GET" [] Nothing Nothing (FunctionName []) ReqBodyJSON
244157-- >
245158-- > -- Or for example in case of lists
246159-- > instance HasForeignType LangX Text a => HasForeignType LangX Text [a] where
247−-- > typeFor lang ftype _ = "listX of " <> typeFor lang ftype (Proxy :: Proxy a)
160+-- > typeFor lang type _ = "listX of " <> typeFor lang ftype (Proxy :: Proxy a)
248161--
249162-- Finally to generate list of information about all the endpoints for
250163-- an API you create a function of a form:
@@ -264,16 +177,11 @@ defReq = Req defUrl "GET" [] Nothing Nothing (FunctionName []) ReqBodyJSON
264177class HasForeignType lang ftype a where
265178 typeFor :: Proxy lang -> Proxy ftype -> Proxy a -> ftype
266179
267−-- | The language definition without any foreign types. It can be used for dynamic languages which do not /do/ type annotations.
268180data NoTypes
269181
270−-- | Use if the foreign language does not have any types.
271−instance HasForeignType NoTypes NoContent a where
182+instance HasForeignType NoTypes NoContent ftype where
272183 typeFor _ _ _ = NoContent
273184
274−-- | Implementation of the Servant framework types.
275−--
276−-- Relevant instances: Everything containing 'HasForeignType'.
277185class HasForeign lang ftype (api :: *) where
278186 type Foreign ftype api :: *
279187 foreignFor :: Proxy lang -> Proxy ftype -> Proxy api -> Req ftype -> Foreign ftype api
@@ -336,19 +244,6 @@ instance (Elem JSON list, HasForeignType lang ftype a, ReflectMethod method)
336244 method = reflectMethod (Proxy :: Proxy method)
337245 methodLC = toLower $ decodeUtf8 method
338246
339−instance (HasForeignType lang ftype NoContent, ReflectMethod method)
340− => HasForeign lang ftype (NoContentVerb method) where
341− type Foreign ftype (NoContentVerb method) = Req ftype
342−
343− foreignFor lang Proxy Proxy req =
344− req & reqFuncName . _FunctionName %~ (methodLC :)
345− & reqMethod .~ method
346− & reqReturnType .~ Just retType
347− where
348− retType = typeFor lang (Proxy :: Proxy ftype) (Proxy :: Proxy NoContent)
349− method = reflectMethod (Proxy :: Proxy method)
350− methodLC = toLower $ decodeUtf8 method
351−
352247-- | TODO: doesn't taking framing into account.
353248instance (ct ~ JSON, HasForeignType lang ftype a, ReflectMethod method)
354249 => HasForeign lang ftype (Stream method status framing ct a) where
@@ -416,16 +311,6 @@ instance
416311 { _argName = PathSegment str
417312 , _argType = typeFor lang ftype (Proxy :: Proxy Bool) }
418313
419−instance
420− (HasForeignType lang ftype (Maybe a), HasForeign lang ftype api)
421− => HasForeign lang ftype (Fragment a :> api) where
422− type Foreign ftype (Fragment a :> api) = Foreign ftype api
423− foreignFor lang Proxy Proxy req =
424− foreignFor lang (Proxy :: Proxy ftype) (Proxy :: Proxy api) $
425− req & reqUrl . frag .~ Just argT
426− where
427− argT = typeFor lang (Proxy :: Proxy ftype) (Proxy :: Proxy (Maybe a))
428−
429314instance HasForeign lang ftype Raw where
430315 type Foreign ftype Raw = HTTP.Method -> Req ftype
431316
servant-foreign/test/Servant/ForeignSpec.hs+4−7
@@ -11,9 +11,11 @@
1111
1212module Servant.ForeignSpec where
1313
14+import Data.Monoid
15+ ((<>))
1416import Data.Proxy
15−import Servant.Foreign
1617import Servant.Test.ComprehensiveAPI
18+import Servant.Foreign
1719import Servant.Types.SourceT
1820 (SourceT)
1921
@@ -89,7 +91,6 @@ listFromAPISpec = describe "listFromAPI" $ do
8991 { _reqUrl = Url
9092 [ Segment $ Static "test" ]
9193 [ QueryArg (Arg "flag" "boolX") Flag ]
92− Nothing
9394 , _reqMethod = "GET"
9495 , _reqHeaders = [HeaderArg $ Arg "header" "maybe listX of stringX"]
9596 , _reqBody = Nothing
@@ -102,7 +103,6 @@ listFromAPISpec = describe "listFromAPI" $ do
102103 { _reqUrl = Url
103104 [ Segment $ Static "test" ]
104105 [ QueryArg (Arg "param" "maybe intX") Normal ]
105− Nothing
106106 , _reqMethod = "POST"
107107 , _reqHeaders = []
108108 , _reqBody = Just "listX of stringX"
@@ -114,9 +114,8 @@ listFromAPISpec = describe "listFromAPI" $ do
114114 shouldBe putReq $ defReq
115115 { _reqUrl = Url
116116 [ Segment $ Static "test" ]
117− -- Should this be |intX| or |listX of intX| ?
117+ -- Shoud this be |intX| or |listX of intX| ?
118118 [ QueryArg (Arg "params" "listX of intX") List ]
119− Nothing
120119 , _reqMethod = "PUT"
121120 , _reqHeaders = []
122121 , _reqBody = Just "stringX"
@@ -130,7 +129,6 @@ listFromAPISpec = describe "listFromAPI" $ do
130129 [ Segment $ Static "test"
131130 , Segment $ Cap (Arg "id" "intX") ]
132131 []
133− Nothing
134132 , _reqMethod = "DELETE"
135133 , _reqHeaders = []
136134 , _reqBody = Nothing
@@ -144,7 +142,6 @@ listFromAPISpec = describe "listFromAPI" $ do
144142 [ Segment $ Static "test"
145143 , Segment $ Cap (Arg "ids" "listX of intX") ]
146144 []
147− Nothing
148145 , _reqMethod = "GET"
149146 , _reqHeaders = []
150147 , _reqBody = Nothing
servant-http-streams/CHANGELOG.md−91
@@ -1,97 +1,6 @@
11 [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-http-streams/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−0.18.4
5−------
6−
7−### Significant changes
8−
9−- *servant-client* / *servant-client-core* / *servant-http-streams*:
10− Fix erroneous behavior, where only 2XX status codes would be considered
11− successful, irrelevant of the status parameter specified by the verb
12− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
13−
14−0.18.3
15−------
16−
17−### Other changes
18−
19−- Support GHC-9.0.1.
20−- Fix test suite running in CI.
21−- Bump `bytestring` and `hspec` dependencies.
22−
23−0.18.2
24−------
25−
26−### Significant changes
27−
28−- Support `servant-client-core` 0.18.2.
29−
30−0.18.1
31−------
32−
33−### Significant changes
34−
35−- Union verbs
36−
37−### Other changes
38−
39−- Bump "tested-with" ghc versions
40−
41−0.18
42−----
43−
44−### Significant changes
45−
46−- Support for ghc8.8 (#1318, #1326, #1327)
47−
48−
49−0.17
50−----
51−
52−### Significant changes
53−
54−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
55−
56− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
57− The API type changes are usually of the kind
58−
59− ```diff
60− - :<|> PostNoContent '[JSON] NoContent
61− + :<|> PostNoContent
62− ```
63−
64− i.e. one doesn't need to specify the content-type anymore. There is no content.
65−
66−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
67−
68− You can specify a lenient capture as
69−
70− ```haskell
71− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
72− ```
73−
74− which will make the capture always succeed. Handlers will be of the
75− type `Either String CapturedType`, where `Left err` represents
76− the possible parse failure.
77−
78−### Other changes
79−
80−- *servant-client* *servant-client-core* *servant-http-streams* Fix Verb with headers checking content type differently [#1200](https://github.com/haskell-servant/servant/issues/1200) [#1204](https://github.com/haskell-servant/servant/pull/1204)
81−
82− For `Verb`s with response `Headers`, the implementation didn't check
83− for the content-type of the response. Now it does.
84−
85−- *servant-client* *servant-http-streams* `HasClient` instance for `Stream` with `Headers` [#1170](https://github.com/haskell-servant/servant/issues/1170) [#1197](https://github.com/haskell-servant/servant/pull/1197)
86−- *servant-client* Redact the authorization header in Show and exceptions [#1238](https://github.com/haskell-servant/servant/pull/1238)
87−
88−
89−
90−0.16.0.1
91−--------
92−
93−- Allow `base-compat-0.11`
94−
9540.16
965----
976
servant-http-streams/servant-http-streams.cabal+26−22
@@ -1,6 +1,6 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-http-streams
3−version: 0.18.4
3+version: 0.16
44
55synopsis: Automatic derivation of querying functions for servant
66category: Servant, Web
@@ -8,19 +8,23 @@ description:
88 This library lets you derive automatically Haskell functions that
99 let you query each endpoint of a <http://hackage.haskell.org/package/servant servant> webservice.
1010 .
11− See <http://docs.servant.dev/en/stable/tutorial/Client.html the client section of the tutorial>.
11+ See <http://haskell-servant.readthedocs.org/en/stable/tutorial/Client.html the client section of the tutorial>.
1212 .
1313 <https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md CHANGELOG>
1414
15−homepage: http://docs.servant.dev/
15+homepage: http://haskell-servant.readthedocs.org/
1616bug-reports: http://github.com/haskell-servant/servant/issues
17−license: BSD-3-Clause
17+license: BSD3
1818license-file: LICENSE
1919author: Servant Contributors
2020maintainer: haskell-servant-maintainers@googlegroups.com
2121copyright: 2019 Servant Contributors
2222build-type: Simple
23−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
23+tested-with:
24+ GHC ==8.0.2
25+ || ==8.2.2
26+ || ==8.4.4
27+ || ==8.6.3
2428
2529extra-source-files:
2630 CHANGELOG.md
@@ -38,13 +42,13 @@ library
3842 -- Bundled with GHC: Lower bound to not force re-installs
3943 -- text and mtl are bundled starting with GHC-8.4
4044 build-depends:
41− base >= 4.9 && < 4.17
42− , bytestring >= 0.10.8.1 && < 0.12
45+ base >= 4.9 && < 4.13
46+ , bytestring >= 0.10.8.1 && < 0.11
4347 , containers >= 0.5.7.1 && < 0.7
4448 , deepseq >= 1.4.2.0 && < 1.5
4549 , mtl >= 2.2.2 && < 2.3
46− , text >= 1.2.3.0 && < 2.1
47− , time >= 1.6.0.1 && < 1.12
50+ , text >= 1.2.3.0 && < 1.3
51+ , time >= 1.6.0.1 && < 1.9
4852 , transformers >= 0.5.2.0 && < 0.6
4953
5054 if !impl(ghc >= 8.2)
@@ -54,16 +58,16 @@ library
5458 -- Servant dependencies.
5559 -- Strict dependency on `servant-client-core` as we re-export things.
5660 build-depends:
57− servant >= 0.18 && < 0.20
58− , servant-client-core >= 0.18.3 && <0.20
61+ servant == 0.16.*
62+ , servant-client-core >= 0.16 && <0.16.1
5963
6064 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
6165 -- Here can be exceptions if we really need features from the newer versions.
6266 build-depends:
63− base-compat >= 0.10.5 && < 0.13
67+ base-compat >= 0.10.5 && < 0.11
6468 , case-insensitive
6569 , http-streams >= 0.8.6.1 && < 0.9
66− , http-media >= 0.7.1.3 && < 0.9
70+ , http-media >= 0.7.1.3 && < 0.8
6771 , io-streams >= 1.5.0.1 && < 1.6
6872 , http-types >= 0.12.2 && < 0.13
6973 , http-common >= 0.8.2.0 && < 0.9
@@ -72,7 +76,7 @@ library
7276 , monad-control >= 1.0.2.3 && < 1.1
7377 , semigroupoids >= 5.3.1 && < 5.4
7478 , transformers-base >= 0.4.5.2 && < 0.5
75− , transformers-compat >= 0.6.2 && < 0.8
79+ , transformers-compat >= 0.6.2 && < 0.7
7680
7781 hs-source-dirs: src
7882 default-language: Haskell2010
@@ -109,19 +113,19 @@ test-suite spec
109113 , wai
110114 , warp
111115
112− -- Additional dependencies
116+ -- Additonal dependencies
113117 build-depends:
114118 entropy >= 0.4.1.3 && < 0.5
115− , hspec >= 2.6.0 && < 2.10
119+ , hspec >= 2.6.0 && < 2.8
116120 , HUnit >= 1.6.0.0 && < 1.7
117− , network >= 2.8.0.0 && < 3.2
118− , QuickCheck >= 2.12.6.1 && < 2.15
119− , servant == 0.19.*
120− , servant-server == 0.19.*
121+ , network >= 2.8.0.0 && < 3.1
122+ , QuickCheck >= 2.12.6.1 && < 2.13
123+ , servant == 0.16.*
124+ , servant-server == 0.16.*
121125 , tdigest >= 0.2 && < 0.3
122126
123127 build-tool-depends:
124− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
128+ hspec-discover:hspec-discover >= 2.6.0 && < 2.8
125129
126130test-suite readme
127131 type: exitcode-stdio-1.0
servant-http-streams/src/Servant/HttpStreams/Internal.hs+11−18
@@ -18,8 +18,6 @@ import Control.DeepSeq
1818 (NFData, force)
1919import Control.Exception
2020 (IOException, SomeException (..), catch, evaluate, throwIO)
21−import Control.Monad
22− (unless)
2321import Control.Monad.Base
2422 (MonadBase (..))
2523import Control.Monad.Codensity
@@ -27,13 +25,9 @@ import Control.Monad.Codensity
2725import Control.Monad.Error.Class
2826 (MonadError (..))
2927import Control.Monad.IO.Class
30− (MonadIO (..))
28+ (liftIO)
3129import Control.Monad.Reader
32− (MonadReader, ReaderT, ask, runReaderT)
33−import Control.Monad.Trans.Class
34− (lift)
3530import Control.Monad.Trans.Except
36− (ExceptT, runExceptT)
3731import Data.Bifunctor
3832 (bimap, first)
3933import Data.ByteString.Builder
@@ -49,6 +43,8 @@ import Data.Maybe
4943 (maybeToList)
5044import Data.Proxy
5145 (Proxy (..))
46+import Data.Semigroup
47+ ((<>))
5248import Data.Sequence
5349 (fromList)
5450import Data.String
@@ -57,7 +53,7 @@ import GHC.Generics
5753import Network.HTTP.Media
5854 (renderHeader)
5955import Network.HTTP.Types
60− (Status (..), hContentType, http11, renderQuery, statusIsSuccessful)
56+ (Status (..), hContentType, http11, renderQuery)
6157import Servant.Client.Core
6258
6359import qualified Network.Http.Client as Client
@@ -139,7 +135,7 @@ instance Alt ClientM where
139135 a <!> b = a `catchError` \_ -> b
140136
141137instance RunClient ClientM where
142− runRequestAcceptStatus = performRequest
138+ runRequest = performRequest
143139 throwClientError = throwError
144140
145141instance RunStreamingClient ClientM where
@@ -153,20 +149,17 @@ withClientM cm env k =
153149 let Codensity f = runExceptT $ flip runReaderT env $ unClientM cm
154150 in f k
155151
156−performRequest :: Maybe [Status] -> Request -> ClientM Response
157−performRequest acceptStatus req = do
152+performRequest :: Request -> ClientM Response
153+performRequest req = do
158154 ClientEnv burl conn <- ask
159155 let (req', body) = requestToClientRequest burl req
160156 x <- ClientM $ lift $ lift $ Codensity $ \k -> do
161157 Client.sendRequest conn req' body
162158 Client.receiveResponse conn $ \res' body' -> do
163− let status = toEnum $ Client.getStatusCode res'
159+ let sc = Client.getStatusCode res'
164160 lbs <- BSL.fromChunks <$> Streams.toList body'
165161 let res'' = clientResponseToResponse res' lbs
166− goodStatus = case acceptStatus of
167− Nothing -> statusIsSuccessful status
168− Just good -> status `elem` good
169− if goodStatus
162+ if sc >= 200 && sc < 300
170163 then k (Right res'')
171164 else k (Left (mkFailureResponse burl req res''))
172165
@@ -180,8 +173,8 @@ performWithStreamingRequest req k = do
180173 Client.sendRequest conn req' body
181174 Client.receiveResponseRaw conn $ \res' body' -> do
182175 -- check status code
183− let status = toEnum $ Client.getStatusCode res'
184− unless (statusIsSuccessful status) $ do
176+ let sc = Client.getStatusCode res'
177+ unless (sc >= 200 && sc < 300) $ do
185178 lbs <- BSL.fromChunks <$> Streams.toList body'
186179 throwIO $ mkFailureResponse burl req (clientResponseToResponse res' lbs)
187180
servant-http-streams/test/Servant/ClientSpec.hs+8−6
@@ -44,6 +44,8 @@ import Data.Maybe
4444 (isJust)
4545import Data.Monoid ()
4646import Data.Proxy
47+import Data.Semigroup
48+ ((<>))
4749import GHC.Generics
4850 (Generic)
4951import qualified Network.HTTP.Types as HTTP
@@ -75,7 +77,7 @@ _ = client comprehensiveAPIWithoutStreaming
7577
7678spec :: Spec
7779spec = describe "Servant.HttpStreams" $ do
78− successSpec
80+ sucessSpec
7981 failSpec
8082 wrappedApiSpec
8183 basicAuthSpec
@@ -113,7 +115,7 @@ type TestHeaders = '[Header "X-Example1" Int, Header "X-Example2" String]
113115type Api =
114116 Get '[JSON] Person
115117 :<|> "get" :> Get '[JSON] Person
116− :<|> "deleteEmpty" :> DeleteNoContent
118+ :<|> "deleteEmpty" :> DeleteNoContent '[JSON] NoContent
117119 :<|> "capture" :> Capture "name" String :> Get '[JSON,FormUrlEncoded] Person
118120 :<|> "captureAll" :> CaptureAll "names" String :> Get '[JSON] [Person]
119121 :<|> "body" :> ReqBody '[FormUrlEncoded,JSON] Person :> Post '[JSON] Person
@@ -129,7 +131,7 @@ type Api =
129131 ReqBody '[JSON] [(String, [Rational])] :>
130132 Get '[JSON] (String, Maybe Int, Bool, [(String, [Rational])])
131133 :<|> "headers" :> Get '[JSON] (Headers TestHeaders Bool)
132− :<|> "deleteContentType" :> DeleteNoContent
134+ :<|> "deleteContentType" :> DeleteNoContent '[JSON] NoContent
133135 :<|> "redirectWithCookie" :> Raw
134136 :<|> "empty" :> EmptyAPI
135137
@@ -260,8 +262,8 @@ runClientUnsafe x burl = withClientEnvIO burl (runClientMUnsafe x)
260262 where
261263 runClientMUnsafe x env = withClientM x env return
262264
263−successSpec :: Spec
264−successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
265+sucessSpec :: Spec
266+sucessSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
265267 it "Servant.API.Get root" $ \(_, baseUrl) -> do
266268 left show <$> runClient getRoot baseUrl `shouldReturn` Right carol
267269
@@ -480,7 +482,7 @@ startWaiApp app = do
480482 (port, socket) <- openTestSocket
481483 let settings = setPort port $ defaultSettings
482484 thread <- forkIO $ runSettingsSocket settings socket app
483− return (thread, BaseUrl Http "127.0.0.1" port "")
485+ return (thread, BaseUrl Http "localhost" port "")
484486
485487
486488endWaiApp :: (ThreadId, BaseUrl) -> IO ()
servant-machines/servant-machines.cabal+17−12
@@ -1,6 +1,7 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-machines
3−version: 0.15.1
3+version: 0.15
4+x-revision: 1
45
56synopsis: Servant Stream support for machines
67category: Servant, Web, Enumerator
@@ -8,31 +9,35 @@ description: Servant Stream support for machines.
89 .
910 Provides 'ToSourceIO' and 'FromSourceIO' instances for 'MachineT'.
1011
11−homepage: http://docs.servant.dev/
12+homepage: http://haskell-servant.readthedocs.org/
1213bug-reports: http://github.com/haskell-servant/servant/issues
13−license: BSD-3-Clause
14+license: BSD3
1415license-file: LICENSE
1516author: Servant Contributors
1617maintainer: haskell-servant-maintainers@googlegroups.com
1718copyright: 2018-2019 Servant Contributors
1819build-type: Simple
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2
20+tested-with:
21+ GHC ==8.0.2
22+ || ==8.2.2
23+ || ==8.4.4
24+ || ==8.6.3
2025
2126extra-source-files:
2227 CHANGELOG.md
2328
2429source-repository head
2530 type: git
26− location: http://github.com/haskell-servant/servant.git
31+ location: http://github.com/haskell-servant/servant-machines.git
2732
2833library
2934 exposed-modules: Servant.Machines
3035 build-depends:
3136 base >=4.9 && <5
32− , bytestring >=0.10.8.1 && <0.12
33− , machines >=0.6.4 && <0.8
37+ , bytestring >=0.10.8.1 && <0.11
38+ , machines >=0.6.4 && <0.7
3439 , mtl >=2.2.2 && <2.3
35− , servant >=0.15 && <0.20
40+ , servant >=0.15 && <0.17
3641 hs-source-dirs: src
3742 default-language: Haskell2010
3843 ghc-options: -Wall
@@ -51,9 +56,9 @@ test-suite example
5156 , servant
5257 , machines
5358 , servant-machines
54− , servant-server >=0.15 && <0.20
55− , servant-client >=0.15 && <0.20
59+ , servant-server >=0.15 && <0.17
60+ , servant-client >=0.15 && <0.17
5661 , wai >=3.2.1.2 && <3.3
57− , warp >=3.2.25 && <3.4
62+ , warp >=3.2.25 && <3.3
5863 , http-client
5964 default-language: Haskell2010
servant-pipes/CHANGELOG.md−18
@@ -1,21 +1,3 @@
1−0.15.3
2−------
3−
4−### Other changes
5−
6−- Support GHC-9.0.1.
7−- Bump `bytestring` dependency.
8−
9−0.15.2
10−------
11−
12−0.15.1
13−------
14−
15−- `FromSourceIO Proxy` (`ListT`) instance `fail`s in `IO`, not in `m`.
16− This works around `MonadFail` proposal, and makes `servant-pipes`
17− behave like `servant-conduit` and `servant-machines`.
18−
1910.15
202----
213
servant-pipes/example/Main.hs+1−1
@@ -64,7 +64,7 @@ server = fast :<|> slow :<|> readme :<|> proxy
6464
6565 readme = liftIO $ do
6666 putStrLn "/readme"
67− return $ P.withFile "README.md" ReadMode $ \h -> PBS.fromHandle h
67+ return $ P.withFile "README.md" ReadMode PBS.fromHandle
6868
6969 proxy c = liftIO $ do
7070 putStrLn "/proxy"
servant-pipes/servant-pipes.cabal+17−12
@@ -1,6 +1,7 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-pipes
3−version: 0.15.3
3+version: 0.15
4+x-revision: 1
45
56synopsis: Servant Stream support for pipes
67category: Servant, Web, Pipes
@@ -8,33 +9,37 @@ description: Servant Stream support for pipes.
89 .
910 Provides 'ToSourceIO' and 'FromSourceIO' instances for 'Proxy' and 'SafeT'.
1011
11−homepage: http://docs.servant.dev/
12+homepage: http://haskell-servant.readthedocs.org/
1213bug-reports: http://github.com/haskell-servant/servant/issues
13−license: BSD-3-Clause
14+license: BSD3
1415license-file: LICENSE
1516author: Servant Contributors
1617maintainer: haskell-servant-maintainers@googlegroups.com
1718copyright: 2018-2019 Servant Contributors
1819build-type: Simple
19−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2
20+tested-with:
21+ GHC ==8.0.2
22+ || ==8.2.2
23+ || ==8.4.4
24+ || ==8.6.3
2025
2126extra-source-files:
2227 CHANGELOG.md
2328
2429source-repository head
2530 type: git
26− location: http://github.com/haskell-servant/servant.git
31+ location: http://github.com/haskell-servant/servant-pipes.git
2732
2833library
2934 exposed-modules: Servant.Pipes
3035 build-depends:
3136 base >=4.9 && <5
32− , bytestring >=0.10.8.1 && <0.12
37+ , bytestring >=0.10.8.1 && <0.11
3338 , pipes >=4.3.9 && <4.4
3439 , pipes-safe >=2.3.1 && <2.4
3540 , mtl >=2.2.2 && <2.3
3641 , monad-control >=1.0.2.3 && <1.1
37− , servant >=0.15 && <0.20
42+ , servant >=0.15 && <0.17
3843 hs-source-dirs: src
3944 default-language: Haskell2010
4045 ghc-options: -Wall
@@ -51,13 +56,13 @@ test-suite example
5156 , bytestring
5257 , http-media
5358 , servant
54− , pipes
59+ , pipes
5560 , pipes-safe
5661 , servant-pipes
5762 , pipes-bytestring >=2.1.6 && <2.2
58− , servant-server >=0.15 && <0.20
59− , servant-client >=0.15 && <0.20
63+ , servant-server >=0.15 && <0.17
64+ , servant-client >=0.15 && <0.17
6065 , wai >=3.2.1.2 && <3.3
61− , warp >=3.2.25 && <3.4
66+ , warp >=3.2.25 && <3.3
6267 , http-client
6368 default-language: Haskell2010
servant-pipes/src/Servant/Pipes.hs+1−1
@@ -65,7 +65,7 @@ instance (MonadIO m, a' ~ X, a ~ (), b' ~ (), r ~ ())
6565 fromSourceIO src = M $ liftIO $ S.unSourceT src (return . go) where
6666 go :: S.StepT IO b -> Proxy X () () b m ()
6767 go S.Stop = Pure ()
68− go (S.Error err) = M (liftIO (fail err))
68+ go (S.Error err) = M (fail err)
6969 go (S.Skip s) = go s -- drives
7070 go (S.Effect ms) = M (liftIO (fmap go ms))
7171 go (S.Yield x s) = Respond x (const (go s))
servant-server/CHANGELOG.md+2−127
@@ -1,142 +1,17 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-server/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19.1
7−------
8−
9−- Add `MonadFail` instance for `Handler` wrt [#1545](https://github.com/haskell-servant/servant/issues/1545)
10−- Support GHC 9.2 [#1525](https://github.com/haskell-servant/servant/issues/1525)
11−
12−0.19
13−----
14−
15−### Significant changes
16−
17−- Drop support for GHC < 8.6.
18−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
19−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
20− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
21− related to hash collisions.
22−- Add `NamedRoutes` combinator, making support for records first-class in Servant
23− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
24−- Add custom type errors for partially applied combinators
25− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
26− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
27−
28−0.18.3
29−------
30−
31−### Significant changes
32−
33−- Add response header support to UVerb (#1420)
34−
35−### Other changes
36−
37−- Support GHC-9.0.1.
38−- Bump `bytestring`, `hspec` and `base64-bytestring` dependencies.
39−
40−0.18.2
41−------
42−
43−### Significant changes
44−
45−- Support `Fragment` combinator.
46−
47−0.18.1
48−------
49−
50−### Significant changes
51−
52−- Union verbs
53−
54−### Other changes
55−
56−- Bump "tested-with" ghc versions
57−- Allow newer dependencies
58−
59−0.18
60−----
61−
62−### Significant changes
63−
64−- Support for ghc8.8 (#1318, #1326, #1327)
65−
66−- Configurable error messages for automatic errors thrown by servant,
67− like "no route" or "could not parse json body" (#1312, #1326, #1327)
68−
69−
70−0.17
71−----
72−
73−### Significant changes
74−
75−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
76−
77− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
78− The API type changes are usually of the kind
79−
80− ```diff
81− - :<|> PostNoContent '[JSON] NoContent
82− + :<|> PostNoContent
83− ```
84−
85− i.e. one doesn't need to specify the content-type anymore. There is no content.
86−
87−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
88−
89− You can specify a lenient capture as
90−
91− ```haskell
92− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
93− ```
94−
95− which will make the capture always succeed. Handlers will be of the
96− type `Either String CapturedType`, where `Left err` represents
97− the possible parse failure.
98−
99−- *servant-server* use queryString to parse QueryParam, QueryParams and QueryFlag [#1249](https://github.com/haskell-servant/servant/pull/1249) [#1262](https://github.com/haskell-servant/servant/pull/1262)
100−
101− Some APIs need query parameters rewriting, e.g. in order to support
102− for multiple casing (camel, snake, etc) or something to that effect.
103−
104− This could be easily achieved by using WAI Middleware and modifying
105− request's `Query`. But QueryParam, QueryParams and QueryFlag use
106− `rawQueryString`. By using `queryString` rather then `rawQueryString`
107− we can enable such rewritings.
108−
109−- *servant* *servant-server* Make packages `build-type: Simple` [#1263](https://github.com/haskell-servant/servant/pull/1263)
110−
111− We used `build-type: Custom`, but it's problematic e.g.
112− for cross-compiling. The benefit is small, as the doctests
113− can be run other ways too (though not so conveniently).
114−
115−0.16.2
116−------
117−
118−* `singleton-bool-0.1.5` (`SBool` is re-exported)
119− - Add `discreteBool :: Dec (a :~: b)` (GHC-7.8+)
120− - Add `Show`, `Eq`, `Ord` `SBool b` instances.
121−* dependencies update
122−
123−0.16.1
124−------
125−
126−* Use `http-api-data-0.4.1` (a part of its API is re-exported)
127− [#1181](https://github.com/haskell-servant/servant/pull/1181)
128−
12940.16
1305----
1316
1327- Rename `ServantError` to `ClientError`, `ServantErr` to `ServerError`
133− [#1131](https://github.com/haskell-servant/servant/pull/1131)
8+ [#1131](https://github.com/haskell-servant/pull/1131)
1349- *servant-server* Reorder HTTP failure code priorities
13510 [#1103](https://github.com/haskell-servant/servant/pull/1103)
13611- *servant-server* Re-organise internal modules
13712 [#1139](https://github.com/haskell-servant/servant/pull/1139)
13813- Allow `network-3.0`
139− [#1107](https://github.com/haskell-servant/servant/pull/1107)
14+ [#1107](https://github.com/haskell-servant/pull/1107)
14015
141160.15
14217----
servant-server/README.md+1−1
@@ -6,4 +6,4 @@ This library lets you *implement* an HTTP server with handlers for each endpoint
66
77## Getting started
88
9−We've written a [tutorial](http://docs.servant.dev/en/stable/tutorial/index.html) guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.
9+We've written a [tutorial](http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html) guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.
servant-server/Setup.hs+32−1
@@ -1,2 +1,33 @@
1−import Distribution.Simple
1+{-# LANGUAGE CPP #-}
2+{-# OPTIONS_GHC -Wall #-}
3+module Main (main) where
4+
5+#ifndef MIN_VERSION_cabal_doctest
6+#define MIN_VERSION_cabal_doctest(x,y,z) 0
7+#endif
8+
9+#if MIN_VERSION_cabal_doctest(1,0,0)
10+
11+import Distribution.Extra.Doctest ( defaultMainWithDoctests )
12+main :: IO ()
13+main = defaultMainWithDoctests "doctests"
14+
15+#else
16+
17+#ifdef MIN_VERSION_Cabal
18+-- If the macro is defined, we have new cabal-install,
19+-- but for some reason we don't have cabal-doctest in package-db
20+--
21+-- Probably we are running cabal sdist, when otherwise using new-build
22+-- workflow
23+#warning You are configuring this package without cabal-doctest installed. \
24+ The doctests test-suite will not work as a result. \
25+ To fix this, install cabal-doctest before configuring.
26+#endif
27+
28+import Distribution.Simple
29+
30+main :: IO ()
231main = defaultMain
32+
33+#endif
servant-server/example/README.md+1−1
@@ -1,2 +1,2 @@
11- `greet.hs` shows how to write a simple webservice, run it, query it with automatically-derived haskell functions and print the (generated) markdown documentation for the API.
2−- `greet.md` contains the aforementioned generated documentation.
2+- `greet.md` contains the aforementionned generated documentation.
servant-server/example/greet.hs+2−16
@@ -1,6 +1,5 @@
11{-# LANGUAGE DataKinds #-}
22{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE RecordWildCards #-}
43{-# LANGUAGE OverloadedStrings #-}
54{-# LANGUAGE PolyKinds #-}
65{-# LANGUAGE TypeFamilies #-}
@@ -17,7 +16,6 @@ import Network.Wai
1716import Network.Wai.Handler.Warp
1817
1918import Servant
20−import Servant.Server.Generic ()
2119
2220-- * Example
2321
@@ -40,14 +38,6 @@ type TestApi =
4038 -- DELETE /greet/:greetid
4139 :<|> "greet" :> Capture "greetid" Text :> Delete '[JSON] NoContent
4240
43− :<|> NamedRoutes OtherRoutes
44−
45−data OtherRoutes mode = OtherRoutes
46− { version :: mode :- Get '[JSON] Int
47− , bye :: mode :- "bye" :> Capture "name" Text :> Get '[JSON] Text
48− }
49− deriving Generic
50−
5141testApi :: Proxy TestApi
5242testApi = Proxy
5343
@@ -58,13 +48,9 @@ testApi = Proxy
5848--
5949-- Each handler runs in the 'Handler' monad.
6050server :: Server TestApi
61−server = helloH :<|> postGreetH :<|> deleteGreetH :<|> otherRoutes
62− where otherRoutes = OtherRoutes {..}
63−
64− bye name = pure $ "Bye, " <> name <> " !"
65− version = pure 42
51+server = helloH :<|> postGreetH :<|> deleteGreetH
6652
67− helloH name Nothing = helloH name (Just False)
53+ where helloH name Nothing = helloH name (Just False)
6854 helloH name (Just False) = return . Greet $ "Hello, " <> name
6955 helloH name (Just True) = return . Greet . toUpper $ "Hello, " <> name
7056
servant-server/servant-server.cabal+49−32
@@ -1,13 +1,13 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant-server
3−version: 0.19.1
3+version: 0.16
44
55synopsis: A family of combinators for defining webservices APIs and serving them
66category: Servant, Web
77description:
88 A family of combinators for defining webservices APIs and serving them
99 .
10− You can learn about the basics in the <http://docs.servant.dev/en/stable/tutorial/index.html tutorial>.
10+ You can learn about the basics in the <http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html tutorial>.
1111 .
1212 <https://github.com/haskell-servant/servant/blob/master/servant-server/example/greet.hs Here>
1313 is a runnable example, with comments, that defines a dummy API and implements
@@ -15,15 +15,19 @@ description:
1515 .
1616 <https://github.com/haskell-servant/servant/blob/master/servant-server/CHANGELOG.md CHANGELOG>
1717
18−homepage: http://docs.servant.dev/
18+homepage: http://haskell-servant.readthedocs.org/
1919bug-reports: http://github.com/haskell-servant/servant/issues
20−license: BSD-3-Clause
20+license: BSD3
2121license-file: LICENSE
2222author: Servant Contributors
2323maintainer: haskell-servant-maintainers@googlegroups.com
2424copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
25−build-type: Simple
26−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
25+build-type: Custom
26+tested-with:
27+ GHC ==8.0.2
28+ || ==8.2.2
29+ || ==8.4.4
30+ || ==8.6.3
2731
2832extra-source-files:
2933 CHANGELOG.md
@@ -33,6 +37,12 @@ source-repository head
3337 type: git
3438 location: http://github.com/haskell-servant/servant.git
3539
40+custom-setup
41+ setup-depends:
42+ base >= 4 && <5,
43+ Cabal,
44+ cabal-doctest >= 1.0.6 && <1.1
45+
3646library
3747 exposed-modules:
3848 Servant
@@ -44,14 +54,12 @@ library
4454 Servant.Server.Internal.Context
4555 Servant.Server.Internal.Delayed
4656 Servant.Server.Internal.DelayedIO
47− Servant.Server.Internal.ErrorFormatter
4857 Servant.Server.Internal.Handler
49− Servant.Server.Internal.RouteResult
5058 Servant.Server.Internal.Router
59+ Servant.Server.Internal.RouteResult
5160 Servant.Server.Internal.RoutingApplication
5261 Servant.Server.Internal.ServerError
5362 Servant.Server.StaticFiles
54− Servant.Server.UVerb
5563
5664 -- deprecated
5765 exposed-modules:
@@ -60,33 +68,31 @@ library
6068 -- Bundled with GHC: Lower bound to not force re-installs
6169 -- text and mtl are bundled starting with GHC-8.4
6270 build-depends:
63− base >= 4.9 && < 4.17
64− , bytestring >= 0.10.8.1 && < 0.12
65− , constraints >= 0.2 && < 0.14
71+ base >= 4.9 && < 4.13
72+ , bytestring >= 0.10.8.1 && < 0.11
6673 , containers >= 0.5.7.1 && < 0.7
6774 , mtl >= 2.2.2 && < 2.3
68− , text >= 1.2.3.0 && < 2.1
75+ , text >= 1.2.3.0 && < 1.3
6976 , transformers >= 0.5.2.0 && < 0.6
7077 , filepath >= 1.4.1.1 && < 1.5
7178
7279 -- Servant dependencies
7380 -- strict dependency as we re-export 'servant' things.
7481 build-depends:
75− servant >= 0.19 && < 0.20
76− , http-api-data >= 0.4.1 && < 0.4.4
82+ servant >= 0.16 && < 0.17.1
83+ , http-api-data >= 0.4 && < 0.4.1
7784
7885 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
7986 -- Here can be exceptions if we really need features from the newer versions.
8087 build-depends:
81− base-compat >= 0.10.5 && < 0.13
82− , base64-bytestring >= 1.0.0.1 && < 1.3
88+ base-compat >= 0.10.5 && < 0.11
89+ , base64-bytestring >= 1.0.0.1 && < 1.1
8390 , exceptions >= 0.10.0 && < 0.11
84− , http-media >= 0.7.1.3 && < 0.9
91+ , http-media >= 0.7.1.3 && < 0.8
8592 , http-types >= 0.12.2 && < 0.13
8693 , network-uri >= 2.6.1.0 && < 2.8
8794 , monad-control >= 1.0.2.3 && < 1.1
88− , network >= 2.8 && < 3.2
89− , sop-core >= 0.4.0.0 && < 0.6
95+ , network >= 2.8 && < 3.1
9096 , string-conversions >= 0.4.0.1 && < 0.5
9197 , resourcet >= 1.2.2 && < 1.3
9298 , tagged >= 0.8.6 && < 0.9
@@ -97,7 +103,6 @@ library
97103
98104 hs-source-dirs: src
99105 default-language: Haskell2010
100−
101106 ghc-options: -Wall -Wno-redundant-constraints
102107
103108executable greet
@@ -114,8 +119,8 @@ executable greet
114119 , text
115120
116121 build-depends:
117− aeson >= 1.4.1.0 && < 3
118− , warp >= 3.2.25 && < 3.4
122+ aeson >= 1.4.1.0 && < 1.5
123+ , warp >= 3.2.25 && < 3.3
119124
120125test-suite spec
121126 type: exitcode-stdio-1.0
@@ -148,23 +153,35 @@ test-suite spec
148153 , safe
149154 , servant
150155 , servant-server
151− , sop-core
152156 , string-conversions
153157 , text
154158 , transformers
155159 , transformers-compat
156160 , wai
157161
158− -- Additional dependencies
162+ -- Additonal dependencies
159163 build-depends:
160− aeson >= 1.4.1.0 && < 3
164+ aeson >= 1.4.1.0 && < 1.5
161165 , directory >= 1.3.0.0 && < 1.4
162− , hspec >= 2.6.0 && < 2.10
163− , hspec-wai >= 0.10.1 && < 0.12
164− , QuickCheck >= 2.12.6.1 && < 2.15
166+ , hspec >= 2.6.0 && < 2.8
167+ , hspec-wai >= 0.9.0 && < 0.10
168+ , QuickCheck >= 2.12.6.1 && < 2.13
165169 , should-not-typecheck >= 2.1.0 && < 2.2
166170 , temporary >= 1.3 && < 1.4
167− , wai-extra >= 3.0.24.3 && < 3.2
171+ , wai-extra >= 3.0.24.3 && < 3.1
168172
169173 build-tool-depends:
170− hspec-discover:hspec-discover >= 2.6.0 && <2.10
174+ hspec-discover:hspec-discover >= 2.6.0 && <2.8
175+
176+test-suite doctests
177+ build-depends:
178+ base
179+ , servant-server
180+ , doctest >= 0.16.0 && <0.17
181+ type: exitcode-stdio-1.0
182+ main-is: test/doctests.hs
183+ buildable: True
184+ default-language: Haskell2010
185+ ghc-options: -Wall -threaded
186+ if impl(ghc >= 8.2)
187+ x-doctest-options: -fdiagnostics-color=never
servant-server/src/Servant/Server.hs+11−64
@@ -1,10 +1,8 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TypeFamilies #-}
7−{-# LANGUAGE TypeOperators #-}
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE TypeFamilies #-}
86
97-- | This module lets you implement 'Server's for defined APIs. You'll
108-- most likely just need 'serve'.
@@ -12,8 +10,6 @@ module Servant.Server
1210 ( -- * Run a wai application from an API
1311 serve
1412 , serveWithContext
15− , serveWithContextT
16− , ServerContext
1713
1814 , -- * Construct a wai Application from an API
1915 toApplication
@@ -39,8 +35,6 @@ module Servant.Server
3935 -- * Context
4036 , Context(..)
4137 , HasContextEntry(getContextEntry)
42− , type (.++)
43− , (.++)
4438 -- ** NamedContext
4539 , NamedContext(..)
4640 , descendIntoNamedContext
@@ -92,28 +86,9 @@ module Servant.Server
9286 , err504
9387 , err505
9488
95− -- * Formatting of errors from combinators
96− --
97− -- | You can configure how Servant will render errors that occur while parsing the request.
98−
99− , ErrorFormatter
100− , NotFoundErrorFormatter
101− , ErrorFormatters
102−
103− , bodyParserErrorFormatter
104− , urlParseErrorFormatter
105− , headerParseErrorFormatter
106− , notFoundErrorFormatter
107−
108− , DefaultErrorFormatters
109− , defaultErrorFormatters
110−
111− , getAcceptHeader
112−
11389 -- * Re-exports
11490 , Application
11591 , Tagged (..)
116− , module Servant.Server.UVerb
11792
11893 ) where
11994
@@ -126,26 +101,16 @@ import Data.Text
126101import Network.Wai
127102 (Application)
128103import Servant.Server.Internal
129−import Servant.Server.UVerb
130104
131105
132106-- * Implementing Servers
133107
134−-- | Constraints that need to be satisfied on a context for it to be passed to 'serveWithContext'.
135−--
136−-- Typically, this will add default context entries to the context. You shouldn't typically
137−-- need to worry about these constraints, but if you write a helper function that wraps
138−-- 'serveWithContext', you might need to include this constraint.
139−type ServerContext context =
140− ( HasContextEntry (context .++ DefaultErrorFormatters) ErrorFormatters
141− )
142−
143108-- | 'serve' allows you to implement an API and produce a wai 'Application'.
144109--
145110-- Example:
146111--
147112-- > type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
148−-- > :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
113+-- > :<|> "books" :> ReqBody Book :> Post '[JSON] Book -- POST /books
149114-- >
150115-- > server :: Server MyApi
151116-- > server = listAllBooks :<|> postBook
@@ -164,27 +129,10 @@ type ServerContext context =
164129serve :: (HasServer api '[]) => Proxy api -> Server api -> Application
165130serve p = serveWithContext p EmptyContext
166131
167−-- | Like 'serve', but allows you to pass custom context.
168−--
169−-- 'defaultErrorFormatters' will always be appended to the end of the passed context,
170−-- but if you pass your own formatter, it will override the default one.
171−serveWithContext :: ( HasServer api context
172− , ServerContext context
173− )
132+serveWithContext :: (HasServer api context)
174133 => Proxy api -> Context context -> Server api -> Application
175−serveWithContext p context = serveWithContextT p context id
176−
177−-- | A general 'serve' function that allows you to pass a custom context and hoisting function to
178−-- apply on all routes.
179−serveWithContextT ::
180− forall api context m.
181− (HasServer api context, ServerContext context) =>
182− Proxy api -> Context context -> (forall x. m x -> Handler x) -> ServerT api m -> Application
183−serveWithContextT p context toHandler server =
184− toApplication (runRouter format404 (route p context (emptyDelayed router)))
185− where
186− router = Route $ hoistServerWithContext p (Proxy :: Proxy context) toHandler server
187− format404 = notFoundErrorFormatter . getContextEntry . mkContextWithErrorFormatter $ context
134+serveWithContext p context server =
135+ toApplication (runRouter (route p context (emptyDelayed (Route server))))
188136
189137-- | Hoist server implementation.
190138--
@@ -235,7 +183,7 @@ hoistServer p = hoistServerWithContext p (Proxy :: Proxy '[])
235183-- > │ └─ e/
236184-- > │ └─•
237185-- > ├─ b/
238−-- > │ └─ <x::Int>/
186+-- > │ └─ <capture>/
239187-- > │ ├─•
240188-- > │ ┆
241189-- > │ └─•
@@ -252,8 +200,7 @@ hoistServer p = hoistServerWithContext p (Proxy :: Proxy '[])
252200--
253201-- [@─•@] Leaves reflect endpoints.
254202--
255−-- [@\<x::Int\>/@] This is a delayed capture of a single
256−-- path component named @x@, of expected type @Int@.
203+-- [@\<capture\>/@] This is a delayed capture of a path component.
257204--
258205-- [@\<raw\>@] This is a part of the API we do not know anything about.
259206--
servant-server/src/Servant/Server/Generic.hs+20−18
@@ -1,10 +1,12 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE RankNTypes #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE TypeOperators #-}
7−
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE KindSignatures #-}
5+{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE TypeOperators #-}
9+{-# LANGUAGE UndecidableInstances #-}
810-- | @since 0.14.1
911module Servant.Server.Generic (
1012 AsServerT,
@@ -13,17 +15,23 @@ module Servant.Server.Generic (
1315 genericServeT,
1416 genericServeTWithContext,
1517 genericServer,
16− genericServerT
18+ genericServerT,
1719 ) where
1820
1921import Data.Proxy
2022 (Proxy (..))
2123
22−import Servant.Server
2324import Servant.API.Generic
24−import Servant.Server.Internal
25+import Servant.Server
2526
26−-- | Transform a record of routes into a WAI 'Application'.
27+-- | A type that specifies that an API record contains a server implementation.
28+data AsServerT (m :: * -> *)
29+instance GenericMode (AsServerT m) where
30+ type AsServerT m :- api = ServerT api m
31+
32+type AsServer = AsServerT Handler
33+
34+-- | Transform record of routes into a WAI 'Application'.
2735genericServe
2836 :: forall routes.
2937 ( HasServer (ToServantApi routes) '[]
@@ -59,7 +67,6 @@ genericServeTWithContext
5967 ( GenericServant routes (AsServerT m)
6068 , GenericServant routes AsApi
6169 , HasServer (ToServantApi routes) ctx
62− , HasContextEntry (ctx .++ DefaultErrorFormatters) ErrorFormatters
6370 , ServerT (ToServantApi routes) m ~ ToServant routes (AsServerT m)
6471 )
6572 => (forall a. m a -> Handler a) -- ^ 'hoistServer' argument to come back to 'Handler'
@@ -73,20 +80,15 @@ genericServeTWithContext f server ctx =
7380 p = genericApi (Proxy :: Proxy routes)
7481 pctx = Proxy :: Proxy ctx
7582
76−-- | Transform a record of endpoints into a 'Server'.
83+-- | Transform record of endpoints into a 'Server'.
7784genericServer
7885 :: GenericServant routes AsServer
7986 => routes AsServer
8087 -> ToServant routes AsServer
8188genericServer = toServant
8289
83−-- | Transform a record of endpoints into a @'ServerT' m@.
84−--
85−-- You can see an example usage of this function
86−-- <https://docs.servant.dev/en/stable/cookbook/generic/Generic.html#using-generics-together-with-a-custom-monad in the Servant Cookbook>.
8790genericServerT
8891 :: GenericServant routes (AsServerT m)
8992 => routes (AsServerT m)
9093 -> ToServant routes (AsServerT m)
9194genericServerT = toServant
92−
servant-server/src/Servant/Server/Internal.hs+105−233
@@ -1,29 +1,29 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
1+{-# LANGUAGE CPP #-}
22{-# LANGUAGE ConstraintKinds #-}
33{-# LANGUAGE DataKinds #-}
44{-# LANGUAGE DeriveDataTypeable #-}
55{-# LANGUAGE FlexibleContexts #-}
66{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE InstanceSigs #-}
87{-# LANGUAGE MultiParamTypeClasses #-}
98{-# LANGUAGE OverloadedStrings #-}
109{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE QuantifiedConstraints #-}
1210{-# LANGUAGE RankNTypes #-}
1311{-# LANGUAGE ScopedTypeVariables #-}
1412{-# LANGUAGE TupleSections #-}
15−{-# LANGUAGE TypeApplications #-}
1613{-# LANGUAGE TypeFamilies #-}
1714{-# LANGUAGE TypeOperators #-}
1815{-# LANGUAGE UndecidableInstances #-}
1916
17+#if MIN_VERSION_base(4,9,0) && __GLASGOW_HASKELL__ >= 802
18+#define HAS_TYPE_ERROR
19+#endif
20+
2021module Servant.Server.Internal
2122 ( module Servant.Server.Internal
2223 , module Servant.Server.Internal.BasicAuth
2324 , module Servant.Server.Internal.Context
2425 , module Servant.Server.Internal.Delayed
2526 , module Servant.Server.Internal.DelayedIO
26− , module Servant.Server.Internal.ErrorFormatter
2727 , module Servant.Server.Internal.Handler
2828 , module Servant.Server.Internal.Router
2929 , module Servant.Server.Internal.RouteResult
@@ -41,11 +41,12 @@ import qualified Data.ByteString as B
4141import qualified Data.ByteString.Builder as BB
4242import qualified Data.ByteString.Char8 as BC8
4343import qualified Data.ByteString.Lazy as BL
44−import Data.Constraint (Constraint, Dict(..))
4544import Data.Either
4645 (partitionEithers)
4746import Data.Maybe
4847 (fromMaybe, isNothing, mapMaybe, maybeToList)
48+import Data.Semigroup
49+ ((<>))
4950import Data.String
5051 (IsString (..))
5152import Data.String.Conversions
@@ -54,9 +55,8 @@ import Data.Tagged
5455 (Tagged (..), retag, untag)
5556import qualified Data.Text as T
5657import Data.Typeable
57−import GHC.Generics
5858import GHC.TypeLits
59− (KnownNat, KnownSymbol, TypeError, symbolVal)
59+ (KnownNat, KnownSymbol, natVal, symbolVal)
6060import qualified Network.HTTP.Media as NHM
6161import Network.HTTP.Types hiding
6262 (Header, ResponseHeaders)
@@ -64,52 +64,45 @@ import Network.Socket
6464 (SockAddr)
6565import Network.Wai
6666 (Application, Request, httpVersion, isSecure, lazyRequestBody,
67− queryString, remoteHost, getRequestBodyChunk, requestHeaders,
67+ rawQueryString, remoteHost, requestBody, requestHeaders,
6868 requestMethod, responseLBS, responseStream, vault)
6969import Prelude ()
7070import Prelude.Compat
7171import Servant.API
7272 ((:<|>) (..), (:>), Accept (..), BasicAuth, Capture',
73− CaptureAll, Description, EmptyAPI, Fragment,
74− FramingRender (..), FramingUnrender (..), FromSourceIO (..),
75− Header', If, IsSecure (..), NoContentVerb, QueryFlag,
76− QueryParam', QueryParams, Raw, ReflectMethod (reflectMethod),
77− RemoteHost, ReqBody', SBool (..), SBoolI (..), SourceIO,
78− Stream, StreamBody', Summary, ToSourceIO (..), Vault, Verb,
79− WithNamedContext, NamedRoutes)
80−import Servant.API.Generic (GenericMode(..), ToServant, ToServantApi, GServantProduct, toServant, fromServant)
73+ CaptureAll, Description, EmptyAPI, FramingRender (..),
74+ FramingUnrender (..), FromSourceIO (..), Header', If,
75+ IsSecure (..), QueryFlag, QueryParam', QueryParams, Raw,
76+ ReflectMethod (reflectMethod), RemoteHost, ReqBody',
77+ SBool (..), SBoolI (..), SourceIO, Stream, StreamBody',
78+ Summary, ToSourceIO (..), Vault, Verb, WithNamedContext)
8179import Servant.API.ContentTypes
8280 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),
83− AllMime, MimeRender (..), MimeUnrender (..), NoContent,
84− canHandleAcceptH)
81+ AllMime, MimeRender (..), MimeUnrender (..), canHandleAcceptH)
8582import Servant.API.Modifiers
8683 (FoldLenient, FoldRequired, RequestArgument,
8784 unfoldRequestArgument)
8885import Servant.API.ResponseHeaders
8986 (GetHeaders, Headers, getHeaders, getResponse)
90−import Servant.API.Status
91− (statusFromNat)
9287import qualified Servant.Types.SourceT as S
93−import Servant.API.TypeErrors
9488import Web.HttpApiData
95− (FromHttpApiData, parseHeader, parseQueryParam, parseUrlPiece,
96− parseUrlPieces)
89+ (FromHttpApiData, parseHeader, parseQueryParam,
90+ parseUrlPieceMaybe, parseUrlPieces)
9791
9892import Servant.Server.Internal.BasicAuth
9993import Servant.Server.Internal.Context
10094import Servant.Server.Internal.Delayed
10195import Servant.Server.Internal.DelayedIO
102−import Servant.Server.Internal.ErrorFormatter
10396import Servant.Server.Internal.Handler
10497import Servant.Server.Internal.Router
10598import Servant.Server.Internal.RouteResult
10699import Servant.Server.Internal.RoutingApplication
107100import Servant.Server.Internal.ServerError
108101
102+#ifdef HAS_TYPE_ERROR
109103import GHC.TypeLits
110104 (ErrorMessage (..), TypeError)
111−import Servant.API.TypeLevel
112− (AtLeastOneFragment, FragmentUnique)
105+#endif
113106
114107class HasServer api context where
115108 type ServerT api (m :: * -> *) :: *
@@ -173,31 +166,22 @@ instance (HasServer a context, HasServer b context) => HasServer (a :<|> b) cont
173166-- > server = getBook
174167-- > where getBook :: Text -> Handler Book
175168-- > getBook isbn = ...
176−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
177− , HasServer api context, SBoolI (FoldLenient mods)
178− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
179− )
169+instance (KnownSymbol capture, FromHttpApiData a, HasServer api context)
180170 => HasServer (Capture' mods capture a :> api) context where
181171
182172 type ServerT (Capture' mods capture a :> api) m =
183− If (FoldLenient mods) (Either String a) a -> ServerT api m
173+ a -> ServerT api m
184174
185175 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
186176
187177 route Proxy context d =
188− CaptureRouter [hint] $
178+ CaptureRouter $
189179 route (Proxy :: Proxy api)
190180 context
191− (addCapture d $ \ txt -> withRequest $ \ request ->
192− case ( sbool :: SBool (FoldLenient mods)
193− , parseUrlPiece txt :: Either T.Text a) of
194− (SFalse, Left e) -> delayedFail $ formatError rep request $ cs e
195− (SFalse, Right v) -> return v
196− (STrue, piece) -> return $ (either (Left . cs) Right) piece)
197− where
198− rep = typeRep (Proxy :: Proxy Capture')
199− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
200− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy a))
181+ (addCapture d $ \ txt -> case parseUrlPieceMaybe txt of
182+ Nothing -> delayedFail err400
183+ Just v -> return v
184+ )
201185
202186-- | If you use 'CaptureAll' in one of the endpoints for your API,
203187-- this automatically requires your server-side handler to be a
@@ -216,10 +200,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
216200-- > server = getSourceFile
217201-- > where getSourceFile :: [Text] -> Handler Book
218202-- > getSourceFile pathSegments = ...
219−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
220− , HasServer api context
221− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
222− )
203+instance (KnownSymbol capture, FromHttpApiData a, HasServer api context)
223204 => HasServer (CaptureAll capture a :> api) context where
224205
225206 type ServerT (CaptureAll capture a :> api) m =
@@ -228,18 +209,14 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
228209 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
229210
230211 route Proxy context d =
231− CaptureAllRouter [hint] $
212+ CaptureAllRouter $
232213 route (Proxy :: Proxy api)
233214 context
234− (addCapture d $ \ txts -> withRequest $ \ request ->
235− case parseUrlPieces txts of
236− Left e -> delayedFail $ formatError rep request $ cs e
237− Right v -> return v
215+ (addCapture d $ \ txts -> case parseUrlPieces txts of
216+ Left _ -> delayedFail err400
217+ Right v -> return v
238218 )
239− where
240− rep = typeRep (Proxy :: Proxy CaptureAll)
241− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
242− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy [a]))
219+
243220
244221allowedMethodHead :: Method -> Request -> Bool
245222allowedMethodHead method request = method == methodGet && requestMethod request == methodHead
@@ -259,10 +236,10 @@ methodCheck method request
259236-- body check is no longer an option. However, we now run the accept
260237-- check before the body check and can therefore afford to make it
261238-- recoverable.
262−acceptCheck :: (AllMime list) => Proxy list -> AcceptHeader -> DelayedIO ()
239+acceptCheck :: (AllMime list) => Proxy list -> B.ByteString -> DelayedIO ()
263240acceptCheck proxy accH
264− | canHandleAcceptH proxy accH = return ()
265− | otherwise = delayedFail err406
241+ | canHandleAcceptH proxy (AcceptHeader accH) = return ()
242+ | otherwise = delayedFail err406
266243
267244methodRouter :: (AllCTRender ctypes a)
268245 => (b -> ([(HeaderName, B.ByteString)], a))
@@ -272,28 +249,17 @@ methodRouter :: (AllCTRender ctypes a)
272249methodRouter splitHeaders method proxy status action = leafRouter route'
273250 where
274251 route' env request respond =
275− let accH = getAcceptHeader request
252+ let accH = fromMaybe ct_wildcard $ lookup hAccept $ requestHeaders request
276253 in runAction (action `addMethodCheck` methodCheck method request
277254 `addAcceptCheck` acceptCheck proxy accH
278255 ) env request respond $ \ output -> do
279256 let (headers, b) = splitHeaders output
280− case handleAcceptH proxy accH b of
257+ case handleAcceptH proxy (AcceptHeader accH) b of
281258 Nothing -> FailFatal err406 -- this should not happen (checked before), so we make it fatal if it does
282259 Just (contentT, body) ->
283260 let bdy = if allowedMethodHead method request then "" else body
284261 in Route $ responseLBS status ((hContentType, cs contentT) : headers) bdy
285262
286−noContentRouter :: Method
287− -> Status
288− -> Delayed env (Handler b)
289− -> Router env
290−noContentRouter method status action = leafRouter route'
291− where
292− route' env request respond =
293− runAction (action `addMethodCheck` methodCheck method request)
294− env request respond $ \ _output ->
295− Route $ responseLBS status [] ""
296−
297263instance {-# OVERLAPPABLE #-}
298264 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
299265 ) => HasServer (Verb method status ctypes a) context where
@@ -303,7 +269,7 @@ instance {-# OVERLAPPABLE #-}
303269
304270 route Proxy _ = methodRouter ([],) method (Proxy :: Proxy ctypes) status
305271 where method = reflectMethod (Proxy :: Proxy method)
306− status = statusFromNat (Proxy :: Proxy status)
272+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
307273
308274instance {-# OVERLAPPING #-}
309275 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
@@ -315,16 +281,8 @@ instance {-# OVERLAPPING #-}
315281
316282 route Proxy _ = methodRouter (\x -> (getHeaders x, getResponse x)) method (Proxy :: Proxy ctypes) status
317283 where method = reflectMethod (Proxy :: Proxy method)
318− status = statusFromNat (Proxy :: Proxy status)
319−
320−instance (ReflectMethod method) =>
321− HasServer (NoContentVerb method) context where
284+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
322285
323− type ServerT (NoContentVerb method) m = m NoContent
324− hoistServerWithContext _ _ nt s = nt s
325−
326− route Proxy _ = noContentRouter method status204
327− where method = reflectMethod (Proxy :: Proxy method)
328286
329287instance {-# OVERLAPPABLE #-}
330288 ( MimeRender ctype chunk, ReflectMethod method, KnownNat status,
@@ -336,7 +294,7 @@ instance {-# OVERLAPPABLE #-}
336294
337295 route Proxy _ = streamRouter ([],) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
338296 where method = reflectMethod (Proxy :: Proxy method)
339− status = statusFromNat (Proxy :: Proxy status)
297+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
340298
341299
342300instance {-# OVERLAPPING #-}
@@ -350,7 +308,7 @@ instance {-# OVERLAPPING #-}
350308
351309 route Proxy _ = streamRouter (\x -> (getHeaders x, getResponse x)) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
352310 where method = reflectMethod (Proxy :: Proxy method)
353− status = statusFromNat (Proxy :: Proxy status)
311+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
354312
355313
356314streamRouter :: forall ctype a c chunk env framing. (MimeRender ctype chunk, FramingRender framing, ToSourceIO chunk a) =>
@@ -362,7 +320,7 @@ streamRouter :: forall ctype a c chunk env framing. (MimeRender ctype chunk, Fra
362320 -> Delayed env (Handler c)
363321 -> Router env
364322streamRouter splitHeaders method status framingproxy ctypeproxy action = leafRouter $ \env request respond ->
365− let AcceptHeader accH = getAcceptHeader request
323+ let accH = fromMaybe ct_wildcard $ lookup hAccept $ requestHeaders request
366324 cmediatype = NHM.matchAccept [contentType ctypeproxy] accH
367325 accCheck = when (isNothing cmediatype) $ delayedFail err406
368326 contentHeader = (hContentType, NHM.renderHeader . maybeToList $ cmediatype)
@@ -407,7 +365,6 @@ streamRouter splitHeaders method status framingproxy ctypeproxy action = leafRou
407365instance
408366 (KnownSymbol sym, FromHttpApiData a, HasServer api context
409367 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
410− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
411368 )
412369 => HasServer (Header' mods sym a :> api) context where
413370------
@@ -419,9 +376,6 @@ instance
419376 route Proxy context subserver = route (Proxy :: Proxy api) context $
420377 subserver `addHeaderCheck` withRequest headerCheck
421378 where
422− rep = typeRep (Proxy :: Proxy Header')
423− formatError = headerParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
424−
425379 headerName :: IsString n => n
426380 headerName = fromString $ symbolVal (Proxy :: Proxy sym)
427381
@@ -432,13 +386,15 @@ instance
432386 mev :: Maybe (Either T.Text a)
433387 mev = fmap parseHeader $ lookup headerName (requestHeaders req)
434388
435− errReq = delayedFailFatal $ formatError rep req
436− $ "Header " <> headerName <> " is required"
389+ errReq = delayedFailFatal err400
390+ { errBody = "Header " <> headerName <> " is required"
391+ }
437392
438− errSt e = delayedFailFatal $ formatError rep req
439− $ cs $ "Error parsing header "
440− <> headerName
441− <> " failed: " <> e
393+ errSt e = delayedFailFatal err400
394+ { errBody = cs $ "Error parsing header "
395+ <> headerName
396+ <> " failed: " <> e
397+ }
442398
443399-- | If you use @'QueryParam' "author" Text@ in one of the endpoints for your API,
444400-- this automatically requires your server-side handler to be a function
@@ -464,7 +420,6 @@ instance
464420instance
465421 ( KnownSymbol sym, FromHttpApiData a, HasServer api context
466422 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
467− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
468423 )
469424 => HasServer (QueryParam' mods sym a :> api) context where
470425------
@@ -474,12 +429,9 @@ instance
474429 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
475430
476431 route Proxy context subserver =
477− let querytext = queryToQueryText . queryString
432+ let querytext req = parseQueryText $ rawQueryString req
478433 paramname = cs $ symbolVal (Proxy :: Proxy sym)
479434
480− rep = typeRep (Proxy :: Proxy QueryParam')
481− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
482−
483435 parseParam :: Request -> DelayedIO (RequestArgument mods a)
484436 parseParam req =
485437 unfoldRequestArgument (Proxy :: Proxy mods) errReq errSt mev
@@ -487,12 +439,14 @@ instance
487439 mev :: Maybe (Either T.Text a)
488440 mev = fmap parseQueryParam $ join $ lookup paramname $ querytext req
489441
490− errReq = delayedFailFatal $ formatError rep req
491− $ cs $ "Query parameter " <> paramname <> " is required"
442+ errReq = delayedFailFatal err400
443+ { errBody = cs $ "Query parameter " <> paramname <> " is required"
444+ }
492445
493− errSt e = delayedFailFatal $ formatError rep req
494− $ cs $ "Error parsing query parameter "
495− <> paramname <> " failed: " <> e
446+ errSt e = delayedFailFatal err400
447+ { errBody = cs $ "Error parsing query parameter "
448+ <> paramname <> " failed: " <> e
449+ }
496450
497451 delayed = addParameterCheck subserver . withRequest $ \req ->
498452 parseParam req
@@ -518,8 +472,7 @@ instance
518472-- > server = getBooksBy
519473-- > where getBooksBy :: [Text] -> Handler [Book]
520474-- > getBooksBy authors = ...return all books by these authors...
521−instance (KnownSymbol sym, FromHttpApiData a, HasServer api context
522− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters)
475+instance (KnownSymbol sym, FromHttpApiData a, HasServer api context)
523476 => HasServer (QueryParams sym a :> api) context where
524477
525478 type ServerT (QueryParams sym a :> api) m =
@@ -530,23 +483,21 @@ instance (KnownSymbol sym, FromHttpApiData a, HasServer api context
530483 route Proxy context subserver = route (Proxy :: Proxy api) context $
531484 subserver `addParameterCheck` withRequest paramsCheck
532485 where
533− rep = typeRep (Proxy :: Proxy QueryParams)
534− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
535−
536486 paramname = cs $ symbolVal (Proxy :: Proxy sym)
537487 paramsCheck req =
538488 case partitionEithers $ fmap parseQueryParam params of
539489 ([], parsed) -> return parsed
540− (errs, _) -> delayedFailFatal $ formatError rep req
541− $ cs $ "Error parsing query parameter(s) "
542− <> paramname <> " failed: "
543− <> T.intercalate ", " errs
490+ (errs, _) -> delayedFailFatal err400
491+ { errBody = cs $ "Error parsing query parameter(s) "
492+ <> paramname <> " failed: "
493+ <> T.intercalate ", " errs
494+ }
544495 where
545496 params :: [T.Text]
546497 params = mapMaybe snd
547498 . filter (looksLikeParam . fst)
548− . queryToQueryText
549− . queryString
499+ . parseQueryText
500+ . rawQueryString
550501 $ req
551502
552503 looksLikeParam name = name == paramname || name == (paramname <> "[]")
@@ -572,7 +523,7 @@ instance (KnownSymbol sym, HasServer api context)
572523 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
573524
574525 route Proxy context subserver =
575− let querytext = queryToQueryText . queryString
526+ let querytext r = parseQueryText $ rawQueryString r
576527 param r = case lookup paramname (querytext r) of
577528 Just Nothing -> True -- param is there, with no value
578529 Just (Just v) -> examine v -- param with a value
@@ -614,7 +565,7 @@ instance HasServer Raw context where
614565-- The @Content-Type@ header is inspected, and the list provided is used to
615566-- attempt deserialization. If the request does not have a @Content-Type@
616567-- header, it is treated as @application/octet-stream@ (as specified in
617−-- [RFC 7231 section 3.1.1.5](http://tools.ietf.org/html/rfc7231#section-3.1.1.5)).
568+-- <http://tools.ietf.org/html/rfc7231#section-3.1.1.5 RFC7231>.
618569-- This lets servant worry about extracting it from the request and turning
619570-- it into a value of the type you specify.
620571--
@@ -630,7 +581,6 @@ instance HasServer Raw context where
630581-- > where postBook :: Book -> Handler Book
631582-- > postBook book = ...insert into your db...
632583instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods)
633− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
634584 ) => HasServer (ReqBody' mods list a :> api) context where
635585
636586 type ServerT (ReqBody' mods list a :> api) m =
@@ -642,9 +592,6 @@ instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods
642592 = route (Proxy :: Proxy api) context $
643593 addBodyCheck subserver ctCheck bodyCheck
644594 where
645− rep = typeRep (Proxy :: Proxy ReqBody')
646− formatError = bodyParserErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
647−
648595 -- Content-Type check, we only lookup we can try to parse the request body
649596 ctCheck = withRequest $ \ request -> do
650597 -- See HTTP RFC 2616, section 7.2.1
@@ -663,7 +610,7 @@ instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods
663610 case sbool :: SBool (FoldLenient mods) of
664611 STrue -> return mrqbody
665612 SFalse -> case mrqbody of
666− Left e -> delayedFailFatal $ formatError rep request e
613+ Left e -> delayedFailFatal err400 { errBody = cs e }
667614 Right v -> return v
668615
669616instance
@@ -686,7 +633,7 @@ instance
686633 bodyCheck fromRS = withRequest $ \req -> do
687634 let mimeUnrender' = mimeUnrender (Proxy :: Proxy ctype) :: BL.ByteString -> Either String chunk
688635 let framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender' :: SourceIO B.ByteString -> SourceIO chunk
689− let body = getRequestBodyChunk req
636+ let body = requestBody req
690637 let rs = S.fromAction B.null body
691638 let rs' = fromRS $ framingUnrender' rs
692639 return rs'
@@ -755,12 +702,12 @@ data EmptyServer = EmptyServer deriving (Typeable, Eq, Show, Bounded, Enum)
755702emptyServer :: ServerT EmptyAPI m
756703emptyServer = Tagged EmptyServer
757704
758−-- | The server for an `EmptyAPI` is `emptyServer`.
705+-- | The server for an `EmptyAPI` is `emptyAPIServer`.
759706--
760707-- > type MyApi = "nothing" :> EmptyApi
761708-- >
762709-- > server :: Server MyApi
763−-- > server = emptyServer
710+-- > server = emptyAPIServer
764711instance HasServer EmptyAPI context where
765712 type ServerT EmptyAPI m = Tagged m EmptyServer
766713
@@ -789,10 +736,7 @@ instance ( KnownSymbol realm
789736-- * helpers
790737
791738ct_wildcard :: B.ByteString
792−ct_wildcard = "*" <> "/" <> "*"
793−
794−getAcceptHeader :: Request -> AcceptHeader
795−getAcceptHeader = AcceptHeader . fromMaybe ct_wildcard . lookup hAccept . requestHeaders
739+ct_wildcard = "*" <> "/" <> "*" -- Because CPP
796740
797741-- * General Authentication
798742
@@ -817,15 +761,39 @@ instance (HasContextEntry context (NamedContext name subContext), HasServer subA
817761 hoistServerWithContext _ _ nt s = hoistServerWithContext (Proxy :: Proxy subApi) (Proxy :: Proxy subContext) nt s
818762
819763-------------------------------------------------------------------------------
820−-- Custom type errors
764+-- TypeError helpers
821765-------------------------------------------------------------------------------
822766
823−-- Erroring instance for 'HasServer' when a combinator is not fully applied
824−instance TypeError (PartialApplication HasServer arr) => HasServer ((arr :: a -> b) :> sub) context
767+#ifdef HAS_TYPE_ERROR
768+-- | This instance catches mistakes when there are non-saturated
769+-- type applications on LHS of ':>'.
770+--
771+-- >>> serve (Proxy :: Proxy (Capture "foo" :> Get '[JSON] Int)) (error "...")
772+-- ...
773+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
774+-- ...Maybe you haven't applied enough arguments to
775+-- ...Capture' '[] "foo"
776+-- ...
777+--
778+-- >>> undefined :: Server (Capture "foo" :> Get '[JSON] Int)
779+-- ...
780+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
781+-- ...Maybe you haven't applied enough arguments to
782+-- ...Capture' '[] "foo"
783+-- ...
784+--
785+instance TypeError (HasServerArrowKindError arr) => HasServer ((arr :: k -> l) :> api) context
825786 where
826− type ServerT (arr :> sub) _ = TypeError (PartialApplication (HasServer :: * -> [*] -> Constraint) arr)
827− route = error "unreachable"
828− hoistServerWithContext _ _ _ _ = error "unreachable"
787+ type ServerT (arr :> api) m = TypeError (HasServerArrowKindError arr)
788+ -- it doens't really matter what sub route we peak
789+ route _ _ _ = error "servant-server panic: impossible happened in HasServer (arr :> api)"
790+ hoistServerWithContext _ _ _ = id
791+
792+-- Cannot have TypeError here, otherwise use of this symbol will error :)
793+type HasServerArrowKindError arr =
794+ 'Text "Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'."
795+ ':$$: 'Text "Maybe you haven't applied enough arguments to"
796+ ':$$: 'ShowType arr
829797
830798-- | This instance prevents from accidentally using '->' instead of ':>'
831799--
@@ -859,103 +827,7 @@ type HasServerArrowTypeError a b =
859827 ':$$: 'ShowType a
860828 ':$$: 'Text "and"
861829 ':$$: 'ShowType b
862−
863−-- Erroring instances for 'HasServer' for unknown API combinators
864−
865−-- XXX: This omits the @context@ parameter, e.g.:
866−--
867−-- "There is no instance for HasServer (Bool :> …)". Do we care ?
868−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub HasServer ty) => HasServer (ty :> sub) context
869−
870−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceFor (HasServer api context)) => HasServer api context
871−
872−-- | Ignore @'Fragment'@ in server handlers.
873−-- See <https://ietf.org/rfc/rfc2616.html#section-15.1.3> for more details.
874−--
875−-- Example:
876−--
877−-- > type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book]
878−-- >
879−-- > server :: Server MyApi
880−-- > server = getBooks
881−-- > where getBooks :: Handler [Book]
882−-- > getBooks = ...return all books...
883−instance (AtLeastOneFragment api, FragmentUnique (Fragment a1 :> api), HasServer api context)
884− => HasServer (Fragment a1 :> api) context where
885− type ServerT (Fragment a1 :> api) m = ServerT api m
886−
887− route _ = route (Proxy :: Proxy api)
888−
889− hoistServerWithContext _ = hoistServerWithContext (Proxy :: Proxy api)
830+#endif
890831
891832-- $setup
892833-- >>> import Servant
893−
894−-- | A type that specifies that an API record contains a server implementation.
895−data AsServerT (m :: * -> *)
896−instance GenericMode (AsServerT m) where
897− type AsServerT m :- api = ServerT api m
898−
899−type AsServer = AsServerT Handler
900−
901−
902−-- | Set of constraints required to convert to / from vanilla server types.
903−type GServerConstraints api m =
904− ( ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
905− , GServantProduct (Rep (api (AsServerT m)))
906− )
907−
908−-- | This class is a necessary evil: in the implementation of 'HasServer' for
909−-- @'NamedRoutes' api@, we essentially need the quantified constraint @forall
910−-- m. 'GServerConstraints' m@ to hold.
911−--
912−-- We cannot require do that directly as the definition of 'GServerConstraints'
913−-- contains type family applications ('Rep' and 'ServerT'). The trick is to hide
914−-- those type family applications behind a typeclass providing evidence for
915−-- @'GServerConstraints' api m@ in the form of a dictionary, and require that
916−-- @forall m. 'GServer' api m@ instead.
917−--
918−-- Users shouldn't have to worry about this class, as the only possible instance
919−-- is provided in this module for all record APIs.
920−
921−class GServer (api :: * -> *) (m :: * -> *) where
922− gServerProof :: Dict (GServerConstraints api m)
923−
924−instance
925− ( ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
926− , GServantProduct (Rep (api (AsServerT m)))
927− ) => GServer api m where
928− gServerProof = Dict
929−
930−instance
931− ( HasServer (ToServantApi api) context
932− , forall m. Generic (api (AsServerT m))
933− , forall m. GServer api m
934− ) => HasServer (NamedRoutes api) context where
935−
936− type ServerT (NamedRoutes api) m = api (AsServerT m)
937−
938− route
939− :: Proxy (NamedRoutes api)
940− -> Context context
941− -> Delayed env (api (AsServerT Handler))
942− -> Router env
943− route _ ctx delayed =
944− case gServerProof @api @Handler of
945− Dict -> route (Proxy @(ToServantApi api)) ctx (toServant <$> delayed)
946−
947− hoistServerWithContext
948− :: forall m n. Proxy (NamedRoutes api)
949− -> Proxy context
950− -> (forall x. m x -> n x)
951− -> api (AsServerT m)
952− -> api (AsServerT n)
953− hoistServerWithContext _ pctx nat server =
954− case (gServerProof @api @m, gServerProof @api @n) of
955− (Dict, Dict) ->
956− fromServant servantSrvN
957− where
958− servantSrvM :: ServerT (ToServantApi api) m =
959− toServant server
960− servantSrvN :: ServerT (ToServantApi api) n =
961− hoistServerWithContext (Proxy @(ToServantApi api)) pctx nat servantSrvM
servant-server/src/Servant/Server/Internal/BasicAuth.hs+3−1
@@ -12,6 +12,8 @@ import Control.Monad.Trans
1212import qualified Data.ByteString as BS
1313import Data.ByteString.Base64
1414 (decodeLenient)
15+import Data.Monoid
16+ ((<>))
1517import Data.Typeable
1618 (Typeable)
1719import Data.Word8
@@ -30,7 +32,7 @@ import Servant.Server.Internal.ServerError
3032-- * Basic Auth
3133
3234-- | servant-server's current implementation of basic authentication is not
33−-- immune to certain kinds of timing attacks. Decoding payloads does not take
35+-- immune to certian kinds of timing attacks. Decoding payloads does not take
3436-- a fixed amount of time.
3537
3638-- | The result of authentication/authorization
servant-server/src/Servant/Server/Internal/Context.hs+9−24
@@ -1,12 +1,11 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE KindSignatures #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE TypeOperators #-}
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE KindSignatures #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeOperators #-}
109
1110module Servant.Server.Internal.Context where
1211
@@ -21,7 +20,7 @@ import GHC.TypeLits
2120--
2221-- If you are using combinators that require a non-empty 'Context' you have to
2322-- use 'Servant.Server.serveWithContext' and pass it a 'Context' that contains all
24−-- the values your combinators need. A 'Context' is essentially a heterogeneous
23+-- the values your combinators need. A 'Context' is essentially a heterogenous
2524-- list and accessing the elements is being done by type (see 'getContextEntry').
2625-- The parameter of the type 'Context' is a type-level list reflecting the types
2726-- of the contained context entries. To create a 'Context' with entries, use the
@@ -46,20 +45,6 @@ instance Eq (Context '[]) where
4645instance (Eq a, Eq (Context as)) => Eq (Context (a ': as)) where
4746 x1 :. y1 == x2 :. y2 = x1 == x2 && y1 == y2
4847
49−-- | Append two type-level lists.
50−--
51−-- Hint: import it as
52−--
53−-- > import Servant.Server (type (.++))
54−type family (.++) (l1 :: [*]) (l2 :: [*]) where
55− '[] .++ a = a
56− (a ': as) .++ b = a ': (as .++ b)
57−
58−-- | Append two contexts.
59−(.++) :: Context l1 -> Context l2 -> Context (l1 .++ l2)
60−EmptyContext .++ a = a
61−(a :. as) .++ b = a :. (as .++ b)
62−
6348-- | This class is used to access context entries in 'Context's. 'getContextEntry'
6449-- returns the first value where the type matches:
6550--
servant-server/src/Servant/Server/Internal/Delayed.hs+1−1
@@ -268,5 +268,5 @@ runAction action env req respond k = runResourceT $
268268~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
269269
270270Due to GHC issue <https://ghc.haskell.org/trac/ghc/ticket/2595 2595>, we cannot
271−do the more succinct thing - just update the records we actually change.
271+do the more succint thing - just update the records we actually change.
272272-}
servant-server/src/Servant/Server/Internal/DelayedIO.hs+5−4
@@ -12,19 +12,20 @@ import Control.Monad.Reader
1212import Control.Monad.Trans
1313 (MonadIO (..), MonadTrans (..))
1414import Control.Monad.Trans.Control
15− (MonadBaseControl (..))
15+ (ComposeSt, MonadBaseControl (..), MonadTransControl (..),
16+ defaultLiftBaseWith, defaultRestoreM)
1617import Control.Monad.Trans.Resource
1718 (MonadResource (..), ResourceT, runInternalState,
18− transResourceT, withInternalState)
19+ runResourceT, transResourceT, withInternalState)
1920import Network.Wai
20− (Request)
21+ (Application, Request, Response, ResponseReceived)
2122
2223import Servant.Server.Internal.RouteResult
2324import Servant.Server.Internal.ServerError
2425
2526-- | Computations used in a 'Delayed' can depend on the
2627-- incoming 'Request', may perform 'IO', and result in a
27−-- 'RouteResult', meaning they can either succeed, fail
28+-- 'RouteResult', meaning they can either suceed, fail
2829-- (with the possibility to recover), or fail fatally.
2930--
3031newtype DelayedIO a = DelayedIO { runDelayedIO' :: ReaderT Request (ResourceT (RouteResultT IO)) a }
servant-server/src/Servant/Server/Internal/ErrorFormatter.hsdeleted−87
@@ -1,87 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE PolyKinds #-}
3−{-# LANGUAGE RankNTypes #-}
4−{-# LANGUAGE TypeOperators #-}
5−
6−module Servant.Server.Internal.ErrorFormatter
7− ( ErrorFormatters(..)
8− , ErrorFormatter
9− , NotFoundErrorFormatter
10−
11− , DefaultErrorFormatters
12− , defaultErrorFormatters
13−
14− , MkContextWithErrorFormatter
15− , mkContextWithErrorFormatter
16− ) where
17−
18−import Data.String.Conversions
19− (cs)
20−import Data.Typeable
21−import Network.Wai.Internal
22− (Request)
23−
24−import Servant.API
25− (Capture, ReqBody)
26−import Servant.Server.Internal.Context
27−import Servant.Server.Internal.ServerError
28−
29−-- | 'Context' that contains default error formatters.
30−type DefaultErrorFormatters = '[ErrorFormatters]
31−
32−-- | A collection of error formatters for different situations.
33−--
34−-- If you need to override one of them, use 'defaultErrorFormatters' with record update syntax.
35−data ErrorFormatters = ErrorFormatters
36− { -- | Format error from parsing the request body.
37− bodyParserErrorFormatter :: ErrorFormatter
38− -- | Format error from parsing url parts or query parameters.
39− , urlParseErrorFormatter :: ErrorFormatter
40− -- | Format error from parsing request headers.
41− , headerParseErrorFormatter :: ErrorFormatter
42− -- | Format error for not found URLs.
43− , notFoundErrorFormatter :: NotFoundErrorFormatter
44− }
45−
46−-- | Default formatters will just return HTTP 400 status code with error
47−-- message as response body.
48−defaultErrorFormatters :: ErrorFormatters
49−defaultErrorFormatters = ErrorFormatters
50− { bodyParserErrorFormatter = err400Formatter
51− , urlParseErrorFormatter = err400Formatter
52− , headerParseErrorFormatter = err400Formatter
53− , notFoundErrorFormatter = const err404
54− }
55−
56−-- | A custom formatter for errors produced by parsing combinators like
57−-- 'ReqBody' or 'Capture'.
58−--
59−-- A 'TypeRep' argument described the concrete combinator that raised
60−-- the error, allowing formatter to customize the message for different
61−-- combinators.
62−--
63−-- A full 'Request' is also passed so that the formatter can react to @Accept@ header,
64−-- for example.
65−type ErrorFormatter = TypeRep -> Request -> String -> ServerError
66−
67−-- | This formatter does not get neither 'TypeRep' nor error message.
68−type NotFoundErrorFormatter = Request -> ServerError
69−
70−type MkContextWithErrorFormatter (ctx :: [*]) = ctx .++ DefaultErrorFormatters
71−
72−mkContextWithErrorFormatter :: forall (ctx :: [*]). Context ctx -> Context (MkContextWithErrorFormatter ctx)
73−mkContextWithErrorFormatter ctx = ctx .++ (defaultErrorFormatters :. EmptyContext)
74−
75−-- Internal
76−
77−err400Formatter :: ErrorFormatter
78−err400Formatter _ _ e = err400 { errBody = cs e }
79−
80−-- These definitions suppress "unused import" warning.
81−-- The imorts are needed for Haddock to correctly link to them.
82−_RB :: Proxy ReqBody
83−_RB = Proxy
84−_C :: Proxy Capture
85−_C = Proxy
86−_CT :: Proxy Context
87−_CT = Proxy
servant-server/src/Servant/Server/Internal/Handler.hs+2−7
@@ -13,19 +13,17 @@ import Control.Monad.Base
1313import Control.Monad.Catch
1414 (MonadCatch, MonadMask, MonadThrow)
1515import Control.Monad.Error.Class
16− (MonadError, throwError)
16+ (MonadError)
1717import Control.Monad.IO.Class
1818 (MonadIO)
1919import Control.Monad.Trans.Control
2020 (MonadBaseControl (..))
2121import Control.Monad.Trans.Except
2222 (ExceptT, runExceptT)
23−import Data.String
24− (fromString)
2523import GHC.Generics
2624 (Generic)
2725import Servant.Server.Internal.ServerError
28− (ServerError, errBody, err500)
26+ (ServerError)
2927
3028newtype Handler a = Handler { runHandler' :: ExceptT ServerError IO a }
3129 deriving
@@ -34,9 +32,6 @@ newtype Handler a = Handler { runHandler' :: ExceptT ServerError IO a }
3432 , MonadThrow, MonadCatch, MonadMask
3533 )
3634
37−instance MonadFail Handler where
38− fail str = throwError err500 { errBody = fromString str }
39−
4035instance MonadBase IO Handler where
4136 liftBase = Handler . liftBase
4237
servant-server/src/Servant/Server/Internal/Router.hs+32−50
@@ -9,37 +9,20 @@ import Prelude.Compat
99
1010import Data.Function
1111 (on)
12−import Data.List
13− (nub)
1412import Data.Map
1513 (Map)
1614import qualified Data.Map as M
1715import Data.Text
1816 (Text)
1917import qualified Data.Text as T
20−import Data.Typeable
21− (TypeRep)
2218import Network.Wai
2319 (Response, pathInfo)
24−import Servant.Server.Internal.ErrorFormatter
25−import Servant.Server.Internal.RouteResult
2620import Servant.Server.Internal.RoutingApplication
21+import Servant.Server.Internal.RouteResult
2722import Servant.Server.Internal.ServerError
2823
2924type Router env = Router' env RoutingApplication
3025
31−data CaptureHint = CaptureHint
32− { captureName :: Text
33− , captureType :: TypeRep
34− }
35− deriving (Show, Eq)
36−
37−toCaptureTag :: CaptureHint -> Text
38−toCaptureTag hint = captureName hint <> "::" <> (T.pack . show) (captureType hint)
39−
40−toCaptureTags :: [CaptureHint] -> Text
41−toCaptureTags hints = "<" <> T.intercalate "|" (map toCaptureTag hints) <> ">"
42−
4326-- | Internal representation of a router.
4427--
4528-- The first argument describes an environment type that is
@@ -52,10 +35,10 @@ data Router' env a =
5235 -- ^ the map contains routers for subpaths (first path component used
5336 -- for lookup and removed afterwards), the list contains handlers
5437 -- for the empty path, to be tried in order
55− | CaptureRouter [CaptureHint] (Router' (Text, env) a)
38+ | CaptureRouter (Router' (Text, env) a)
5639 -- ^ first path component is passed to the child router in its
5740 -- environment and removed afterwards
58− | CaptureAllRouter [CaptureHint] (Router' ([Text], env) a)
41+ | CaptureAllRouter (Router' ([Text], env) a)
5942 -- ^ all path components are passed to the child router in its
6043 -- environment and are removed afterwards
6144 | RawRouter (env -> a)
@@ -85,8 +68,8 @@ leafRouter l = StaticRouter M.empty [l]
8568choice :: Router' env a -> Router' env a -> Router' env a
8669choice (StaticRouter table1 ls1) (StaticRouter table2 ls2) =
8770 StaticRouter (M.unionWith choice table1 table2) (ls1 ++ ls2)
88−choice (CaptureRouter hints1 router1) (CaptureRouter hints2 router2) =
89− CaptureRouter (nub $ hints1 ++ hints2) (choice router1 router2)
71+choice (CaptureRouter router1) (CaptureRouter router2) =
72+ CaptureRouter (choice router1 router2)
9073choice router1 (Choice router2 router3) = Choice (choice router1 router2) router3
9174choice router1 router2 = Choice router1 router2
9275
@@ -100,7 +83,7 @@ choice router1 router2 = Choice router1 router2
10083--
10184data RouterStructure =
10285 StaticRouterStructure (Map Text RouterStructure) Int
103− | CaptureRouterStructure [CaptureHint] RouterStructure
86+ | CaptureRouterStructure RouterStructure
10487 | RawRouterStructure
10588 | ChoiceStructure RouterStructure RouterStructure
10689 deriving (Eq, Show)
@@ -114,11 +97,11 @@ data RouterStructure =
11497routerStructure :: Router' env a -> RouterStructure
11598routerStructure (StaticRouter m ls) =
11699 StaticRouterStructure (fmap routerStructure m) (length ls)
117−routerStructure (CaptureRouter hints router) =
118− CaptureRouterStructure hints $
100+routerStructure (CaptureRouter router) =
101+ CaptureRouterStructure $
119102 routerStructure router
120−routerStructure (CaptureAllRouter hints router) =
121− CaptureRouterStructure hints $
103+routerStructure (CaptureAllRouter router) =
104+ CaptureRouterStructure $
122105 routerStructure router
123106routerStructure (RawRouter _) =
124107 RawRouterStructure
@@ -130,8 +113,8 @@ routerStructure (Choice r1 r2) =
130113-- | Compare the structure of two routers.
131114--
132115sameStructure :: Router' env a -> Router' env b -> Bool
133−sameStructure router1 router2 =
134− routerStructure router1 == routerStructure router2
116+sameStructure r1 r2 =
117+ routerStructure r1 == routerStructure r2
135118
136119-- | Provide a textual representation of the
137120-- structure of a router.
@@ -142,8 +125,7 @@ routerLayout router =
142125 where
143126 mkRouterLayout :: Bool -> RouterStructure -> [Text]
144127 mkRouterLayout c (StaticRouterStructure m n) = mkSubTrees c (M.toList m) n
145− mkRouterLayout c (CaptureRouterStructure hints r) =
146− mkSubTree c (toCaptureTags hints) (mkRouterLayout False r)
128+ mkRouterLayout c (CaptureRouterStructure r) = mkSubTree c "<capture>" (mkRouterLayout False r)
147129 mkRouterLayout c RawRouterStructure =
148130 if c then ["├─ <raw>"] else ["└─ <raw>"]
149131 mkRouterLayout c (ChoiceStructure r1 r2) =
@@ -171,52 +153,52 @@ tweakResponse :: (RouteResult Response -> RouteResult Response) -> Router env ->
171153tweakResponse f = fmap (\a -> \req cont -> a req (cont . f))
172154
173155-- | Interpret a router as an application.
174−runRouter :: NotFoundErrorFormatter -> Router () -> RoutingApplication
175−runRouter fmt r = runRouterEnv fmt r ()
156+runRouter :: Router () -> RoutingApplication
157+runRouter r = runRouterEnv r ()
176158
177−runRouterEnv :: NotFoundErrorFormatter -> Router env -> env -> RoutingApplication
178−runRouterEnv fmt router env request respond =
159+runRouterEnv :: Router env -> env -> RoutingApplication
160+runRouterEnv router env request respond =
179161 case router of
180162 StaticRouter table ls ->
181163 case pathInfo request of
182− [] -> runChoice fmt ls env request respond
164+ [] -> runChoice ls env request respond
183165 -- This case is to handle trailing slashes.
184− [""] -> runChoice fmt ls env request respond
166+ [""] -> runChoice ls env request respond
185167 first : rest | Just router' <- M.lookup first table
186168 -> let request' = request { pathInfo = rest }
187− in runRouterEnv fmt router' env request' respond
188− _ -> respond $ Fail $ fmt request
189− CaptureRouter _ router' ->
169+ in runRouterEnv router' env request' respond
170+ _ -> respond $ Fail err404
171+ CaptureRouter router' ->
190172 case pathInfo request of
191− [] -> respond $ Fail $ fmt request
173+ [] -> respond $ Fail err404
192174 -- This case is to handle trailing slashes.
193− [""] -> respond $ Fail $ fmt request
175+ [""] -> respond $ Fail err404
194176 first : rest
195177 -> let request' = request { pathInfo = rest }
196− in runRouterEnv fmt router' (first, env) request' respond
197− CaptureAllRouter _ router' ->
178+ in runRouterEnv router' (first, env) request' respond
179+ CaptureAllRouter router' ->
198180 let segments = pathInfo request
199181 request' = request { pathInfo = [] }
200− in runRouterEnv fmt router' (segments, env) request' respond
182+ in runRouterEnv router' (segments, env) request' respond
201183 RawRouter app ->
202184 app env request respond
203185 Choice r1 r2 ->
204− runChoice fmt [runRouterEnv fmt r1, runRouterEnv fmt r2] env request respond
186+ runChoice [runRouterEnv r1, runRouterEnv r2] env request respond
205187
206188-- | Try a list of routing applications in order.
207189-- We stop as soon as one fails fatally or succeeds.
208190-- If all fail normally, we pick the "best" error.
209191--
210−runChoice :: NotFoundErrorFormatter -> [env -> RoutingApplication] -> env -> RoutingApplication
211−runChoice fmt ls =
192+runChoice :: [env -> RoutingApplication] -> env -> RoutingApplication
193+runChoice ls =
212194 case ls of
213− [] -> \ _ request respond -> respond (Fail $ fmt request)
195+ [] -> \ _ _ respond -> respond (Fail err404)
214196 [r] -> r
215197 (r : rs) ->
216198 \ env request respond ->
217199 r env request $ \ response1 ->
218200 case response1 of
219− Fail _ -> runChoice fmt rs env request $ \ response2 ->
201+ Fail _ -> runChoice rs env request $ \ response2 ->
220202 respond $ highestPri response1 response2
221203 _ -> respond response1
222204 where
servant-server/src/Servant/Server/Internal/ServerError.hs+1−1
@@ -187,7 +187,7 @@ err403 = ServerError { errHTTPCode = 403
187187-- Example:
188188--
189189-- > failingHandler :: Handler ()
190−-- > failingHandler = throwError $ err404 { errBody = "Are you lost?" }
190+-- > failingHandler = throwError $ err404 { errBody = "(╯°□°）╯︵ ┻━┻)." }
191191--
192192err404 :: ServerError
193193err404 = ServerError { errHTTPCode = 404
servant-server/src/Servant/Server/UVerb.hsdeleted−116
@@ -1,116 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE InstanceSigs #-}
6−{-# LANGUAGE KindSignatures #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE RankNTypes #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeApplications #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−
16−{-# OPTIONS_GHC -Wno-orphans #-}
17−{-# OPTIONS_GHC -Wno-redundant-constraints #-}
18−
19−module Servant.Server.UVerb
20− ( respond,
21− IsServerResource,
22− )
23−where
24−
25−import qualified Data.ByteString as B
26−import Data.Proxy (Proxy (Proxy))
27−import Data.SOP (I (I))
28−import Data.SOP.Constraint (All, And)
29−import Data.String.Conversions (LBS, cs)
30−import Network.HTTP.Types (Status, HeaderName, hContentType)
31−import Network.Wai (responseLBS, Request)
32−import Servant.API (ReflectMethod, reflectMethod)
33−import Servant.API.ContentTypes (AllCTRender (handleAcceptH), AllMime)
34−import Servant.API.ResponseHeaders (GetHeaders (..), Headers (..))
35−import Servant.API.UVerb (HasStatus, IsMember, Statuses, UVerb, Union, Unique, WithStatus (..), foldMapUnion, inject, statusOf)
36−import Servant.Server.Internal (Context, Delayed, Handler, HasServer (..), RouteResult (FailFatal, Route), Router, Server, ServerT, acceptCheck, addAcceptCheck, addMethodCheck, allowedMethodHead, err406, getAcceptHeader, leafRouter, methodCheck, runAction)
37−
38−
39−-- | 'return' for 'UVerb' handlers. Takes a value of any of the members of the open union,
40−-- and will construct a union value in an 'Applicative' (eg. 'Server').
41−respond ::
42− forall (x :: *) (xs :: [*]) (f :: * -> *).
43− (Applicative f, HasStatus x, IsMember x xs) =>
44− x ->
45− f (Union xs)
46−respond = pure . inject . I
47−
48−class IsServerResource (cts :: [*]) a where
49− resourceResponse :: Request -> Proxy cts -> a -> Maybe (LBS, LBS)
50− resourceHeaders :: Proxy cts -> a -> [(HeaderName, B.ByteString)]
51−
52−instance {-# OVERLAPPABLE #-} AllCTRender cts a
53− => IsServerResource cts a where
54− resourceResponse request p res = handleAcceptH p (getAcceptHeader request) res
55− resourceHeaders _ _ = []
56−
57−instance {-# OVERLAPPING #-} (IsServerResource cts a, GetHeaders (Headers h a))
58− => IsServerResource cts (Headers h a) where
59− resourceResponse request p res = resourceResponse request p (getResponse res)
60− resourceHeaders cts res = getHeaders res ++ resourceHeaders cts (getResponse res)
61−
62−instance {-# OVERLAPPING #-} IsServerResource cts a
63− => IsServerResource cts (WithStatus n a) where
64− resourceResponse request p (WithStatus x) = resourceResponse request p x
65− resourceHeaders cts (WithStatus x) = resourceHeaders cts x
66−
67−encodeResource :: forall a cts . (IsServerResource cts a, HasStatus a)
68− => Request -> Proxy cts -> a
69− -> (Status, Maybe (LBS, LBS), [(HeaderName, B.ByteString)])
70−encodeResource request cts res = (statusOf (Proxy @a),
71− resourceResponse request cts res,
72− resourceHeaders cts res)
73−
74−type IsServerResourceWithStatus cts = IsServerResource cts `And` HasStatus
75−
76−instance
77− ( ReflectMethod method,
78− AllMime contentTypes,
79− All (IsServerResourceWithStatus contentTypes) as,
80− Unique (Statuses as) -- for consistency with servant-swagger (server would work fine
81− -- without; client is a bit of a corner case, because it dispatches
82− -- the parser based on the status code. with this uniqueness
83− -- constraint it won't have to run more than one parser in weird
84− -- corner cases.
85− ) =>
86− HasServer (UVerb method contentTypes as) context
87− where
88− type ServerT (UVerb method contentTypes as) m = m (Union as)
89−
90− hoistServerWithContext _ _ nt s = nt s
91−
92− route ::
93− forall env.
94− Proxy (UVerb method contentTypes as) ->
95− Context context ->
96− Delayed env (Server (UVerb method contentTypes as)) ->
97− Router env
98− route _proxy _ctx action = leafRouter route'
99− where
100− method = reflectMethod (Proxy @method)
101− route' env request cont = do
102− let action' :: Delayed env (Handler (Union as))
103− action' =
104− action
105− `addMethodCheck` methodCheck method request
106− `addAcceptCheck` acceptCheck (Proxy @contentTypes) (getAcceptHeader request)
107−
108− runAction action' env request cont $ \(output :: Union as) -> do
109− let cts = Proxy @contentTypes
110− pickResource :: Union as -> (Status, Maybe (LBS, LBS), [(HeaderName, B.ByteString)])
111− pickResource = foldMapUnion (Proxy @(IsServerResourceWithStatus contentTypes)) (encodeResource request cts)
112− case pickResource output of
113− (_, Nothing, _) -> FailFatal err406 -- this should not happen (checked before), so we make it fatal if it does
114− (status, Just (contentT, body), headers) ->
115− let bdy = if allowedMethodHead method request then "" else body
116− in Route $ responseLBS status ((hContentType, cs contentT) : headers) bdy
servant-server/test/Servant/Server/ErrorSpec.hs+2−58
@@ -12,9 +12,9 @@ import Data.Aeson
1212 (encode)
1313import qualified Data.ByteString.Char8 as BC
1414import qualified Data.ByteString.Lazy.Char8 as BCL
15+import Data.Monoid
16+ ((<>))
1517import Data.Proxy
16−import Data.String.Conversions
17− (cs)
1818import Network.HTTP.Types
1919 (hAccept, hAuthorization, hContentType, methodGet, methodPost,
2020 methodPut)
@@ -31,7 +31,6 @@ spec = describe "HTTP Errors" $ do
3131 prioErrorsSpec
3232 errorRetrySpec
3333 errorChoiceSpec
34− customFormattersSpec
3534
3635-- * Auth machinery (reused throughout)
3736
@@ -294,61 +293,6 @@ errorChoiceSpec = describe "Multiple handlers return errors"
294293 `shouldRespondWith` 415
295294
296295
297−-- }}}
298−------------------------------------------------------------------------------
299−-- * Custom errors {{{
300−
301−customFormatter :: ErrorFormatter
302−customFormatter _ _ err = err400 { errBody = "CUSTOM! " <> cs err }
303−
304−customFormatters :: ErrorFormatters
305−customFormatters = defaultErrorFormatters
306− { bodyParserErrorFormatter = customFormatter
307− , urlParseErrorFormatter = customFormatter
308− , notFoundErrorFormatter = const $ err404 { errBody = "CUSTOM! Not Found" }
309− }
310−
311−type CustomFormatterAPI
312− = "query" :> QueryParam' '[Required, Strict] "param" Int :> Get '[PlainText] String
313− :<|> "capture" :> Capture "cap" Bool :> Get '[PlainText] String
314− :<|> "body" :> ReqBody '[JSON] Int :> Post '[PlainText] String
315−
316−customFormatterAPI :: Proxy CustomFormatterAPI
317−customFormatterAPI = Proxy
318−
319−customFormatterServer :: Server CustomFormatterAPI
320−customFormatterServer = (\_ -> return "query")
321− :<|> (\_ -> return "capture")
322− :<|> (\_ -> return "body")
323−
324−customFormattersSpec :: Spec
325−customFormattersSpec = describe "Custom errors from combinators"
326− $ with (return $ serveWithContext customFormatterAPI (customFormatters :. EmptyContext) customFormatterServer) $ do
327−
328− let startsWithCustom = ResponseMatcher
329− { matchStatus = 400
330− , matchHeaders = []
331− , matchBody = MatchBody $ \_ body -> if "CUSTOM!" `BCL.isPrefixOf` body
332− then Nothing
333− else Just $ show body <> " does not start with \"CUSTOM!\""
334− }
335−
336− it "formats query parse error" $ do
337− request methodGet "query?param=false" [] ""
338− `shouldRespondWith` startsWithCustom
339−
340− it "formats query parse error with missing param" $ do
341− request methodGet "query" [] ""
342− `shouldRespondWith` startsWithCustom
343−
344− it "formats capture parse error" $ do
345− request methodGet "capture/42" [] ""
346− `shouldRespondWith` startsWithCustom
347−
348− it "formats body parse error" $ do
349− request methodPost "body" [(hContentType, "application/json")] "foo"
350− `shouldRespondWith` startsWithCustom
351−
352296-- }}}
353297------------------------------------------------------------------------------
354298-- * Instances {{{
servant-server/test/Servant/Server/Internal/ContextSpec.hs+1−1
@@ -1,5 +1,5 @@
11{-# LANGUAGE DataKinds #-}
2−{-# OPTIONS_GHC -fdefer-type-errors -Wwarn -Wno-deferred-type-errors #-}
2+{-# OPTIONS_GHC -fdefer-type-errors -Wwarn #-}
33module Servant.Server.Internal.ContextSpec (spec) where
44
55import Data.Proxy
servant-server/test/Servant/Server/Internal/RoutingApplicationSpec.hs+2−2
@@ -11,7 +11,7 @@ module Servant.Server.Internal.RoutingApplicationSpec (spec) where
1111import Prelude ()
1212import Prelude.Compat
1313
14−import Control.Exception hiding
14+import Control.Exception hiding
1515 (Handler)
1616import Control.Monad.IO.Class
1717import Control.Monad.Trans.Resource
@@ -28,7 +28,7 @@ import Test.Hspec
2828import Test.Hspec.Wai
2929 (request, shouldRespondWith, with)
3030
31−import qualified Data.Text as T
31+import qualified Data.Text as T
3232
3333import System.IO.Unsafe
3434 (unsafePerformIO)
servant-server/test/Servant/Server/RouterSpec.hs+8−129
@@ -9,9 +9,7 @@ import Control.Monad
99import Data.Proxy
1010 (Proxy (..))
1111import Data.Text
12− (Text, unpack)
13−import Data.Typeable
14− (typeRep)
12+ (unpack)
1513import Network.HTTP.Types
1614 (Status (..))
1715import Network.Wai
@@ -29,13 +27,12 @@ spec :: Spec
2927spec = describe "Servant.Server.Internal.Router" $ do
3028 routerSpec
3129 distributivitySpec
32− serverLayoutSpec
3330
3431routerSpec :: Spec
3532routerSpec = do
3633 describe "tweakResponse" $ do
3734 let app' :: Application
38− app' = toApplication $ runRouter (const err404) router'
35+ app' = toApplication $ runRouter router'
3936
4037 router', router :: Router ()
4138 router' = tweakResponse (fmap twk) router
@@ -51,10 +48,10 @@ routerSpec = do
5148
5249 describe "runRouter" $ do
5350 let toApp :: Router () -> Application
54− toApp = toApplication . runRouter (const err404)
51+ toApp = toApplication . runRouter
5552
5653 cap :: Router ()
57− cap = CaptureRouter [hint] $
54+ cap = CaptureRouter $
5855 let delayed = addCapture (emptyDelayed $ Route pure) (const $ delayedFail err400)
5956 in leafRouter
6057 $ \env req res ->
@@ -62,9 +59,6 @@ routerSpec = do
6259 . const
6360 $ Route success
6461
65− hint :: CaptureHint
66− hint = CaptureHint "anything" $ typeRep (Proxy :: Proxy ())
67−
6862 router :: Router ()
6963 router = leafRouter (\_ _ res -> res $ Route success)
7064 `Choice` cap
@@ -104,30 +98,12 @@ distributivitySpec =
10498 it "properly handles mixing static paths at different levels" $ do
10599 level `shouldHaveSameStructureAs` levelRef
106100
107−serverLayoutSpec :: Spec
108−serverLayoutSpec =
109− describe "serverLayout" $ do
110− it "correctly represents the example API" $ do
111− exampleLayout `shouldHaveLayout` expectedExampleLayout
112− it "aggregates capture hints when different" $ do
113− captureDifferentTypes `shouldHaveLayout` expectedCaptureDifferentTypes
114− it "nubs capture hints when equal" $ do
115− captureSameType `shouldHaveLayout` expectedCaptureSameType
116− it "properly displays CaptureAll hints" $ do
117− captureAllLayout `shouldHaveLayout` expectedCaptureAllLayout
118−
119101shouldHaveSameStructureAs ::
120102 (HasServer api1 '[], HasServer api2 '[]) => Proxy api1 -> Proxy api2 -> Expectation
121103shouldHaveSameStructureAs p1 p2 =
122104 unless (sameStructure (makeTrivialRouter p1) (makeTrivialRouter p2)) $
123105 expectationFailure ("expected:\n" ++ unpack (layout p2) ++ "\nbut got:\n" ++ unpack (layout p1))
124106
125−shouldHaveLayout ::
126− (HasServer api '[]) => Proxy api -> Text -> Expectation
127−shouldHaveLayout p l =
128− unless (routerLayout (makeTrivialRouter p) == l) $
129− expectationFailure ("expected:\n" ++ unpack l ++ "\nbut got:\n" ++ unpack (layout p))
130−
131107makeTrivialRouter :: (HasServer layout '[]) => Proxy layout -> Router ()
132108makeTrivialRouter p =
133109 route p EmptyContext (emptyDelayed (FailFatal err501))
@@ -168,12 +144,12 @@ staticRef = Proxy
168144-- structure:
169145
170146type Dynamic =
171− "a" :> Capture "foo" Int :> "b" :> End
172− :<|> "a" :> Capture "foo" Int :> "c" :> End
173− :<|> "a" :> Capture "foo" Int :> "d" :> End
147+ "a" :> Capture "foo" Int :> "b" :> End
148+ :<|> "a" :> Capture "bar" Bool :> "c" :> End
149+ :<|> "a" :> Capture "baz" Char :> "d" :> End
174150
175151type DynamicRef =
176− "a" :> Capture "foo" Int :>
152+ "a" :> Capture "anything" () :>
177153 ("b" :> End :<|> "c" :> End :<|> "d" :> End)
178154
179155dynamic :: Proxy Dynamic
@@ -363,100 +339,3 @@ level = Proxy
363339
364340levelRef :: Proxy LevelRef
365341levelRef = Proxy
366−
367−-- The example API for the 'layout' function.
368−-- Should get factorized by the 'choice' smart constructor.
369−type ExampleLayout =
370− "a" :> "d" :> Get '[JSON] NoContent
371− :<|> "b" :> Capture "x" Int :> Get '[JSON] Bool
372− :<|> "c" :> Put '[JSON] Bool
373− :<|> "a" :> "e" :> Get '[JSON] Int
374− :<|> "b" :> Capture "x" Int :> Put '[JSON] Bool
375− :<|> Raw
376−
377−exampleLayout :: Proxy ExampleLayout
378−exampleLayout = Proxy
379−
380−-- The expected representation of the example API layout
381−--
382−expectedExampleLayout :: Text
383−expectedExampleLayout =
384− "/\n\
385− \├─ a/\n\
386− \│ ├─ d/\n\
387− \│ │ └─•\n\
388− \│ └─ e/\n\
389− \│ └─•\n\
390− \├─ b/\n\
391− \│ └─ <x::Int>/\n\
392− \│ ├─•\n\
393− \│ ┆\n\
394− \│ └─•\n\
395− \├─ c/\n\
396− \│ └─•\n\
397− \┆\n\
398− \└─ <raw>\n"
399−
400−-- A capture API with all capture types being the same
401−--
402−type CaptureSameType =
403− "a" :> Capture "foo" Int :> "b" :> End
404− :<|> "a" :> Capture "foo" Int :> "c" :> End
405− :<|> "a" :> Capture "foo" Int :> "d" :> End
406−
407−captureSameType :: Proxy CaptureSameType
408−captureSameType = Proxy
409−
410−-- The expected representation of the CaptureSameType API layout.
411−--
412−expectedCaptureSameType :: Text
413−expectedCaptureSameType =
414− "/\n\
415− \└─ a/\n\
416− \ └─ <foo::Int>/\n\
417− \ ├─ b/\n\
418− \ │ └─•\n\
419− \ ├─ c/\n\
420− \ │ └─•\n\
421− \ └─ d/\n\
422− \ └─•\n"
423−
424−-- A capture API capturing different types
425−--
426−type CaptureDifferentTypes =
427− "a" :> Capture "foo" Int :> "b" :> End
428− :<|> "a" :> Capture "bar" Bool :> "c" :> End
429− :<|> "a" :> Capture "baz" Char :> "d" :> End
430−
431−captureDifferentTypes :: Proxy CaptureDifferentTypes
432−captureDifferentTypes = Proxy
433−
434−-- The expected representation of the CaptureDifferentTypes API layout.
435−--
436−expectedCaptureDifferentTypes :: Text
437−expectedCaptureDifferentTypes =
438− "/\n\
439− \└─ a/\n\
440− \ └─ <foo::Int|bar::Bool|baz::Char>/\n\
441− \ ├─ b/\n\
442− \ │ └─•\n\
443− \ ├─ c/\n\
444− \ │ └─•\n\
445− \ └─ d/\n\
446− \ └─•\n"
447−
448−-- An API with a CaptureAll part
449−
450−type CaptureAllLayout = "a" :> CaptureAll "foos" Int :> End
451−
452−captureAllLayout :: Proxy CaptureAllLayout
453−captureAllLayout = Proxy
454−
455−-- The expected representation of the CaptureAllLayout API.
456−--
457−expectedCaptureAllLayout :: Text
458−expectedCaptureAllLayout =
459− "/\n\
460− \└─ a/\n\
461− \ └─ <foos::[Int]>/\n\
462− \ └─•\n"
servant-server/test/Servant/ServerSpec.hs+127−292
@@ -1,13 +1,13 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE PolyKinds #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE TypeOperators #-}
10−{-# LANGUAGE TypeApplications #-}
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE DeriveGeneric #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE PolyKinds #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE TypeOperators #-}
10+{-# LANGUAGE TypeSynonymInstances #-}
1111{-# OPTIONS_GHC -freduction-depth=100 #-}
1212
1313module Servant.ServerSpec where
@@ -25,8 +25,6 @@ import qualified Data.ByteString as BS
2525import qualified Data.ByteString.Base64 as Base64
2626import Data.Char
2727 (toUpper)
28−import Data.Maybe
29− (fromMaybe)
3028import Data.Proxy
3129 (Proxy (Proxy))
3230import Data.String
@@ -37,28 +35,26 @@ import qualified Data.Text as T
3735import GHC.Generics
3836 (Generic)
3937import Network.HTTP.Types
40− (QueryItem, Status (..), hAccept, hContentType, imATeapot418,
38+ (Status (..), hAccept, hContentType, imATeapot418,
4139 methodDelete, methodGet, methodHead, methodPatch, methodPost,
4240 methodPut, ok200, parseQuery)
4341import Network.Wai
44− (Application, Middleware, Request, pathInfo, queryString,
45− rawQueryString, requestHeaders, responseLBS)
42+ (Application, Request, pathInfo, queryString, rawQueryString,
43+ requestHeaders, responseLBS)
4644import Network.Wai.Test
4745 (defaultRequest, request, runSession, simpleBody,
4846 simpleHeaders, simpleStatus)
4947import Servant.API
5048 ((:<|>) (..), (:>), AuthProtect, BasicAuth,
51− BasicAuthData (BasicAuthData), Capture, Capture', CaptureAll,
52− Delete, EmptyAPI, Fragment, Get, HasStatus (StatusOf), Header,
53− Headers, HttpVersion, IsSecure (..), JSON, Lenient,
54− NoContent (..), NoContentVerb, NoFraming, OctetStream, Patch,
49+ BasicAuthData (BasicAuthData), Capture, CaptureAll, Delete,
50+ EmptyAPI, Get, Header, Headers, HttpVersion, IsSecure (..),
51+ JSON, NoContent (..), NoFraming, OctetStream, Patch,
5552 PlainText, Post, Put, QueryFlag, QueryParam, QueryParams, Raw,
56− RemoteHost, ReqBody, SourceIO, StdMethod (..), Stream, Strict,
57− UVerb, Union, Verb, WithStatus (..), addHeader)
53+ RemoteHost, ReqBody, SourceIO, StdMethod (..), Stream, Verb,
54+ addHeader)
5855import Servant.Server
5956 (Context ((:.), EmptyContext), Handler, Server, Tagged (..),
60− emptyServer, err401, err403, err404, respond, serve,
61− serveWithContext)
57+ emptyServer, err401, err403, err404, serve, serveWithContext)
6258import Servant.Test.ComprehensiveAPI
6359import qualified Servant.Types.SourceT as S
6460import Test.Hspec
@@ -89,17 +85,14 @@ comprehensiveApiContext = NamedContext EmptyContext :. EmptyContext
8985spec :: Spec
9086spec = do
9187 verbSpec
92− uverbSpec
9388 captureSpec
9489 captureAllSpec
9590 queryParamSpec
96− fragmentSpec
9791 reqBodySpec
9892 headerSpec
9993 rawSpec
10094 alternativeSpec
10195 responseHeadersSpec
102− uverbResponseHeadersSpec
10396 miscCombinatorSpec
10497 basicAuthSpec
10598 genAuthSpec
@@ -110,7 +103,7 @@ spec = do
110103
111104type VerbApi method status
112105 = Verb method status '[JSON] Person
113− :<|> "noContent" :> NoContentVerb method
106+ :<|> "noContent" :> Verb method status '[JSON] NoContent
114107 :<|> "header" :> Verb method status '[JSON] (Headers '[Header "H" Int] Person)
115108 :<|> "headerNC" :> Verb method status '[JSON] (Headers '[Header "H" Int] NoContent)
116109 :<|> "accept" :> ( Verb method status '[JSON] Person
@@ -147,7 +140,7 @@ verbSpec = describe "Servant.API.Verb" $ do
147140
148141 it "returns no content on NoContent" $ do
149142 response <- THW.request method "/noContent" [] ""
150− liftIO $ statusCode (simpleStatus response) `shouldBe` 204
143+ liftIO $ statusCode (simpleStatus response) `shouldBe` status
151144 liftIO $ simpleBody response `shouldBe` ""
152145
153146 -- HEAD should not return body
@@ -211,27 +204,13 @@ verbSpec = describe "Servant.API.Verb" $ do
211204------------------------------------------------------------------------------
212205
213206type CaptureApi = Capture "legs" Integer :> Get '[JSON] Animal
214− :<|> "ears" :> Capture' '[Lenient] "ears" Integer :> Get '[JSON] Animal
215− :<|> "eyes" :> Capture' '[Strict] "eyes" Integer :> Get '[JSON] Animal
216207captureApi :: Proxy CaptureApi
217208captureApi = Proxy
218−
219−captureServer :: Server CaptureApi
220−captureServer = getLegs :<|> getEars :<|> getEyes
221− where getLegs :: Integer -> Handler Animal
222− getLegs legs = case legs of
223− 4 -> return jerry
224− 2 -> return tweety
225− _ -> throwError err404
226−
227− getEars :: Either String Integer -> Handler Animal
228− getEars (Left _) = return chimera -- ignore integer parse error, return weird animal
229− getEars (Right 2) = return jerry
230− getEars (Right _) = throwError err404
231−
232− getEyes :: Integer -> Handler Animal
233− getEyes 2 = return jerry
234− getEyes _ = throwError err404
209+captureServer :: Integer -> Handler Animal
210+captureServer legs = case legs of
211+ 4 -> return jerry
212+ 2 -> return tweety
213+ _ -> throwError err404
235214
236215captureSpec :: Spec
237216captureSpec = do
@@ -245,21 +224,10 @@ captureSpec = do
245224 it "returns 400 if the decoding fails" $ do
246225 get "/notAnInt" `shouldRespondWith` 400
247226
248− it "returns an animal if eyes or ears are 2" $ do
249− get "/ears/2" `shouldRespondWith` 200
250− get "/eyes/2" `shouldRespondWith` 200
251−
252− it "returns a weird animal on Lenient Capture" $ do
253− response <- get "/ears/bla"
254− liftIO $ decode' (simpleBody response) `shouldBe` Just chimera
255−
256− it "returns 400 if parsing integer fails on Strict Capture" $ do
257− get "/eyes/bla" `shouldRespondWith` 400
258−
259227 with (return (serve
260228 (Proxy :: Proxy (Capture "captured" String :> Raw))
261− (\ "captured" -> Tagged $ \request_ sendResponse ->
262− sendResponse $ responseLBS ok200 [] (cs $ show $ pathInfo request_)))) $ do
229+ (\ "captured" -> Tagged $ \request_ respond ->
230+ respond $ responseLBS ok200 [] (cs $ show $ pathInfo request_)))) $ do
263231 it "strips the captured path snippet from pathInfo" $ do
264232 get "/captured/foo" `shouldRespondWith` (fromString (show ["foo" :: String]))
265233
@@ -310,8 +278,8 @@ captureAllSpec = do
310278
311279 with (return (serve
312280 (Proxy :: Proxy (CaptureAll "segments" String :> Raw))
313− (\ _captured -> Tagged $ \request_ sendResponse ->
314− sendResponse $ responseLBS ok200 [] (cs $ show $ pathInfo request_)))) $ do
281+ (\ _captured -> Tagged $ \request_ respond ->
282+ respond $ responseLBS ok200 [] (cs $ show $ pathInfo request_)))) $ do
315283 it "consumes everything from pathInfo" $ do
316284 get "/captured/foo/bar/baz" `shouldRespondWith` (fromString (show ([] :: [Int])))
317285
@@ -346,154 +314,117 @@ qpServer = queryParamServer :<|> qpNames :<|> qpCapitalize :<|> qpAge :<|> qpAge
346314 queryParamServer (Just name_) = return alice{name = name_}
347315 queryParamServer Nothing = return alice
348316
349−
350−
351317queryParamSpec :: Spec
352318queryParamSpec = do
353− let mkRequest params pinfo = Network.Wai.Test.request defaultRequest
354− { rawQueryString = params
355− , queryString = parseQuery params
356− , pathInfo = pinfo
357− }
358−
359319 describe "Servant.API.QueryParam" $ do
360320 it "allows retrieving simple GET parameters" $
361− flip runSession (serve queryParamApi qpServer) $ do
362− response1 <- mkRequest "?name=bob" []
363− liftIO $ decode' (simpleBody response1) `shouldBe` Just alice
364− { name = "bob"
365− }
321+ (flip runSession) (serve queryParamApi qpServer) $ do
322+ let params1 = "?name=bob"
323+ response1 <- Network.Wai.Test.request defaultRequest{
324+ rawQueryString = params1,
325+ queryString = parseQuery params1
326+ }
327+ liftIO $ do
328+ decode' (simpleBody response1) `shouldBe` Just alice{
329+ name = "bob"
330+ }
366331
367332 it "allows retrieving lists in GET parameters" $
368− flip runSession (serve queryParamApi qpServer) $ do
369− response2 <- mkRequest "?names[]=bob&names[]=john" ["a"]
370− liftIO $ decode' (simpleBody response2) `shouldBe` Just alice
371− { name = "john"
372− }
333+ (flip runSession) (serve queryParamApi qpServer) $ do
334+ let params2 = "?names[]=bob&names[]=john"
335+ response2 <- Network.Wai.Test.request defaultRequest{
336+ rawQueryString = params2,
337+ queryString = parseQuery params2,
338+ pathInfo = ["a"]
339+ }
340+ liftIO $
341+ decode' (simpleBody response2) `shouldBe` Just alice{
342+ name = "john"
343+ }
373344
374345 it "parses a query parameter" $
375− flip runSession (serve queryParamApi qpServer) $ do
376− response <- mkRequest "?age=55" ["param"]
377− liftIO $ decode' (simpleBody response) `shouldBe` Just alice
378− { age = 55
379− }
346+ (flip runSession) (serve queryParamApi qpServer) $ do
347+ let params = "?age=55"
348+ response <- Network.Wai.Test.request defaultRequest{
349+ rawQueryString = params,
350+ queryString = parseQuery params,
351+ pathInfo = ["param"]
352+ }
353+ liftIO $
354+ decode' (simpleBody response) `shouldBe` Just alice{
355+ age = 55
356+ }
380357
381358 it "generates an error on query parameter parse failure" $
382− flip runSession (serve queryParamApi qpServer) $ do
383− response <- mkRequest "?age=foo" ["param"]
359+ (flip runSession) (serve queryParamApi qpServer) $ do
360+ let params = "?age=foo"
361+ response <- Network.Wai.Test.request defaultRequest{
362+ rawQueryString = params,
363+ queryString = parseQuery params,
364+ pathInfo = ["param"]
365+ }
384366 liftIO $ statusCode (simpleStatus response) `shouldBe` 400
385367 return ()
386368
387369 it "parses multiple query parameters" $
388− flip runSession (serve queryParamApi qpServer) $ do
389− response <- mkRequest "?ages=10&ages=22" ["multiparam"]
390− liftIO $ decode' (simpleBody response) `shouldBe` Just alice
391− { age = 32
392− }
370+ (flip runSession) (serve queryParamApi qpServer) $ do
371+ let params = "?ages=10&ages=22"
372+ response <- Network.Wai.Test.request defaultRequest{
373+ rawQueryString = params,
374+ queryString = parseQuery params,
375+ pathInfo = ["multiparam"]
376+ }
377+ liftIO $
378+ decode' (simpleBody response) `shouldBe` Just alice{
379+ age = 32
380+ }
393381
394382 it "generates an error on parse failures of multiple parameters" $
395− flip runSession (serve queryParamApi qpServer) $ do
396− response <- mkRequest "?ages=2&ages=foo" ["multiparam"]
383+ (flip runSession) (serve queryParamApi qpServer) $ do
384+ let params = "?ages=2&ages=foo"
385+ response <- Network.Wai.Test.request defaultRequest{
386+ rawQueryString = params,
387+ queryString = parseQuery params,
388+ pathInfo = ["multiparam"]
389+ }
397390 liftIO $ statusCode (simpleStatus response) `shouldBe` 400
398391 return ()
399392
400− it "allows retrieving value-less GET parameters" $
401− flip runSession (serve queryParamApi qpServer) $ do
402− response3 <- mkRequest "?capitalize" ["b"]
403− liftIO $ decode' (simpleBody response3) `shouldBe` Just alice
404− { name = "ALICE"
405− }
406−
407− response3' <- mkRequest "?capitalize=" ["b"]
408− liftIO $ decode' (simpleBody response3') `shouldBe` Just alice
409− { name = "ALICE"
410− }
411−
412− response3'' <- mkRequest "?unknown=" ["b"]
413− liftIO $ decode' (simpleBody response3'') `shouldBe` Just alice
414− { name = "Alice"
415− }
416−
417− describe "Uses queryString instead of rawQueryString" $ do
418− -- test query parameters rewriter
419− let queryRewriter :: Middleware
420− queryRewriter app req = app req
421− { queryString = fmap rewrite $ queryString req
422− }
423− where
424− rewrite :: QueryItem -> QueryItem
425− rewrite (k, v) = (fromMaybe k (BS.stripPrefix "person_" k), v)
426−
427− let app = queryRewriter $ serve queryParamApi qpServer
428−
429− it "allows rewriting for simple GET/query parameters" $
430− flip runSession app $ do
431− response1 <- mkRequest "?person_name=bob" []
432− liftIO $ decode' (simpleBody response1) `shouldBe` Just alice
433− { name = "bob"
434− }
435−
436− it "allows rewriting for lists in GET parameters" $
437− flip runSession app $ do
438− response2 <- mkRequest "?person_names[]=bob&person_names[]=john" ["a"]
439− liftIO $ decode' (simpleBody response2) `shouldBe` Just alice
440− { name = "john"
441− }
442−
443− it "allows rewriting when parsing multiple query parameters" $
444− flip runSession app $ do
445− response <- mkRequest "?person_ages=10&person_ages=22" ["multiparam"]
446− liftIO $ decode' (simpleBody response) `shouldBe` Just alice
447− { age = 32
448− }
449−
450− it "allows retrieving value-less GET parameters" $
451− flip runSession app $ do
452− response3 <- mkRequest "?person_capitalize" ["b"]
453− liftIO $ decode' (simpleBody response3) `shouldBe` Just alice
454− { name = "ALICE"
455− }
456−
457− response3' <- mkRequest "?person_capitalize=" ["b"]
458− liftIO $ decode' (simpleBody response3') `shouldBe` Just alice
459− { name = "ALICE"
460− }
461−
462− response3'' <- mkRequest "?person_unknown=" ["b"]
463− liftIO $ decode' (simpleBody response3'') `shouldBe` Just alice
464− { name = "Alice"
465− }
466−
467−-- }}}
468−------------------------------------------------------------------------------
469−-- * fragmentSpec {{{
470−------------------------------------------------------------------------------
471−
472−type FragmentApi = "name" :> Fragment String :> Get '[JSON] Person
473− :<|> "age" :> Fragment Integer :> Get '[JSON] Person
474393
475−fragmentApi :: Proxy FragmentApi
476−fragmentApi = Proxy
477−
478−fragServer :: Server FragmentApi
479−fragServer = fragmentServer :<|> fragAge
480− where
481− fragmentServer = return alice
482− fragAge = return alice
483−
484−fragmentSpec :: Spec
485−fragmentSpec = do
486− let mkRequest params pinfo = Network.Wai.Test.request defaultRequest
487− { rawQueryString = params
488− , queryString = parseQuery params
489− , pathInfo = pinfo
490− }
491−
492− describe "Servant.API.Fragment" $ do
493− it "ignores fragment even if it is present in query" $ do
494− flip runSession (serve fragmentApi fragServer) $ do
495− response1 <- mkRequest "#Alice" ["name"]
496− liftIO $ decode' (simpleBody response1) `shouldBe` Just alice
394+ it "allows retrieving value-less GET parameters" $
395+ (flip runSession) (serve queryParamApi qpServer) $ do
396+ let params3 = "?capitalize"
397+ response3 <- Network.Wai.Test.request defaultRequest{
398+ rawQueryString = params3,
399+ queryString = parseQuery params3,
400+ pathInfo = ["b"]
401+ }
402+ liftIO $
403+ decode' (simpleBody response3) `shouldBe` Just alice{
404+ name = "ALICE"
405+ }
406+
407+ let params3' = "?capitalize="
408+ response3' <- Network.Wai.Test.request defaultRequest{
409+ rawQueryString = params3',
410+ queryString = parseQuery params3',
411+ pathInfo = ["b"]
412+ }
413+ liftIO $
414+ decode' (simpleBody response3') `shouldBe` Just alice{
415+ name = "ALICE"
416+ }
417+
418+ let params3'' = "?unknown="
419+ response3'' <- Network.Wai.Test.request defaultRequest{
420+ rawQueryString = params3'',
421+ queryString = parseQuery params3'',
422+ pathInfo = ["b"]
423+ }
424+ liftIO $
425+ decode' (simpleBody response3'') `shouldBe` Just alice{
426+ name = "Alice"
427+ }
497428
498429-- }}}
499430------------------------------------------------------------------------------
@@ -580,15 +511,15 @@ rawApi :: Proxy RawApi
580511rawApi = Proxy
581512
582513rawApplication :: Show a => (Request -> a) -> Tagged m Application
583−rawApplication f = Tagged $ \request_ sendResponse ->
584− sendResponse $ responseLBS ok200 []
514+rawApplication f = Tagged $ \request_ respond ->
515+ respond $ responseLBS ok200 []
585516 (cs $ show $ f request_)
586517
587518rawSpec :: Spec
588519rawSpec = do
589520 describe "Servant.API.Raw" $ do
590521 it "runs applications" $ do
591− flip runSession (serve rawApi (rawApplication (const (42 :: Integer)))) $ do
522+ (flip runSession) (serve rawApi (rawApplication (const (42 :: Integer)))) $ do
592523 response <- Network.Wai.Test.request defaultRequest{
593524 pathInfo = ["foo"]
594525 }
@@ -596,7 +527,7 @@ rawSpec = do
596527 simpleBody response `shouldBe` "42"
597528
598529 it "gets the pathInfo modified" $ do
599− flip runSession (serve rawApi (rawApplication pathInfo)) $ do
530+ (flip runSession) (serve rawApi (rawApplication pathInfo)) $ do
600531 response <- Network.Wai.Test.request defaultRequest{
601532 pathInfo = ["foo", "bar"]
602533 }
@@ -686,31 +617,6 @@ responseHeadersSpec = describe "ResponseHeaders" $ do
686617 THW.request method "" [(hAccept, "crazy/mime")] ""
687618 `shouldRespondWith` 406
688619
689−-- }}}
690−------------------------------------------------------------------------------
691−-- * uverbResponseHeaderSpec {{{
692−------------------------------------------------------------------------------
693−type UVerbHeaderResponse = '[
694− WithStatus 200 (Headers '[Header "H1" Int] String),
695− WithStatus 404 String ]
696−
697−type UVerbResponseHeadersApi =
698− Capture "ok" Bool :> UVerb 'GET '[JSON] UVerbHeaderResponse
699−
700−uverbResponseHeadersServer :: Server UVerbResponseHeadersApi
701−uverbResponseHeadersServer True = respond . WithStatus @200 . addHeader @"H1" (5 :: Int) $ ("foo" :: String)
702−uverbResponseHeadersServer False = respond . WithStatus @404 $ ("bar" :: String)
703−
704−uverbResponseHeadersSpec :: Spec
705−uverbResponseHeadersSpec = describe "UVerbResponseHeaders" $ do
706− with (return $ serve (Proxy :: Proxy UVerbResponseHeadersApi) uverbResponseHeadersServer) $ do
707−
708− it "includes the headers in the response" $
709− THW.request methodGet "/true" [] ""
710− `shouldRespondWith` "\"foo\"" { matchHeaders = ["H1" <:> "5"]
711− , matchStatus = 200
712− }
713−
714620-- }}}
715621------------------------------------------------------------------------------
716622-- * miscCombinatorSpec {{{
@@ -767,7 +673,7 @@ basicAuthApi = Proxy
767673basicAuthServer :: Server BasicAuthAPI
768674basicAuthServer =
769675 const (return jerry) :<|>
770− (Tagged $ \ _ sendResponse -> sendResponse $ responseLBS imATeapot418 [] "")
676+ (Tagged $ \ _ respond -> respond $ responseLBS imATeapot418 [] "")
771677
772678basicAuthContext :: Context '[ BasicAuthCheck () ]
773679basicAuthContext =
@@ -812,7 +718,7 @@ genAuthApi = Proxy
812718
813719genAuthServer :: Server GenAuthAPI
814720genAuthServer = const (return tweety)
815− :<|> (Tagged $ \ _ sendResponse -> sendResponse $ responseLBS imATeapot418 [] "")
721+ :<|> (Tagged $ \ _ respond -> respond $ responseLBS imATeapot418 [] "")
816722
817723type instance AuthServerData (AuthProtect "auth") = ()
818724
@@ -842,73 +748,6 @@ genAuthSpec = do
842748 it "plays nice with subsequent Raw endpoints" $ do
843749 get "/foo" `shouldRespondWith` 418
844750
845−-- }}}
846−------------------------------------------------------------------------------
847−-- * UVerb {{{
848−------------------------------------------------------------------------------
849−
850−newtype PersonResponse = PersonResponse Person
851− deriving Generic
852−instance ToJSON PersonResponse
853−instance HasStatus PersonResponse where
854− type StatusOf PersonResponse = 200
855−
856−newtype RedirectResponse = RedirectResponse String
857− deriving Generic
858−instance ToJSON RedirectResponse
859−instance HasStatus RedirectResponse where
860− type StatusOf RedirectResponse = 301
861−
862−newtype AnimalResponse = AnimalResponse Animal
863− deriving Generic
864−instance ToJSON AnimalResponse
865−instance HasStatus AnimalResponse where
866− type StatusOf AnimalResponse = 203
867−
868−
869−type UVerbApi
870− = "person" :> Capture "shouldRedirect" Bool :> UVerb 'GET '[JSON] '[PersonResponse, RedirectResponse]
871− :<|> "animal" :> UVerb 'GET '[JSON] '[AnimalResponse]
872−
873−uverbSpec :: Spec
874−uverbSpec = describe "Servant.API.UVerb " $ do
875− let
876− joe = Person "joe" 42
877− mouse = Animal "Mouse" 7
878−
879− personHandler
880− :: Bool
881− -> Handler (Union '[PersonResponse
882− ,RedirectResponse])
883− personHandler True = respond $ RedirectResponse "over there!"
884− personHandler False = respond $ PersonResponse joe
885−
886− animalHandler = respond $ AnimalResponse mouse
887−
888− server :: Server UVerbApi
889− server = personHandler :<|> animalHandler
890−
891− with (pure $ serve (Proxy :: Proxy UVerbApi) server) $ do
892− context "A route returning either 301/String or 200/Person" $ do
893− context "when requesting the person" $ do
894− let theRequest = THW.get "/person/false"
895− it "returns status 200" $
896− theRequest `shouldRespondWith` 200
897− it "returns a person" $ do
898− response <- theRequest
899− liftIO $ decode' (simpleBody response) `shouldBe` Just joe
900− context "requesting the redirect" $
901− it "returns a message and status 301" $
902− THW.get "/person/true"
903− `shouldRespondWith` "\"over there!\"" {matchStatus = 301}
904− context "a route with a single response type" $ do
905− let theRequest = THW.get "/animal"
906− it "should return the defined status code" $
907− theRequest `shouldRespondWith` 203
908− it "should return the expected response" $ do
909− response <- theRequest
910− liftIO $ decode' (simpleBody response) `shouldBe` Just mouse
911−
912751-- }}}
913752------------------------------------------------------------------------------
914753-- * Test data types {{{
@@ -941,10 +780,6 @@ jerry = Animal "Mouse" 4
941780tweety :: Animal
942781tweety = Animal "Bird" 2
943782
944−-- weird animal with non-integer amount of ears
945−chimera :: Animal
946−chimera = Animal "Chimera" (-1)
947−
948783beholder :: Animal
949784beholder = Animal "Beholder" 0
950785-- }}}
servant-server/test/doctests.hsnew file+27
@@ -0,0 +1,27 @@
1+-----------------------------------------------------------------------------
2+-- |
3+-- Module : Main (doctests)
4+-- Copyright : (C) 2012-14 Edward Kmett
5+-- License : BSD-style (see the file LICENSE)
6+-- Maintainer : Edward Kmett <ekmett@gmail.com>
7+-- Stability : provisional
8+-- Portability : portable
9+--
10+-- This module provides doctests for a project based on the actual versions
11+-- of the packages it was built with. It requires a corresponding Setup.lhs
12+-- to be added to the project
13+-----------------------------------------------------------------------------
14+module Main where
15+
16+import Build_doctests
17+ (flags, module_sources, pkgs)
18+import Data.Foldable
19+ (traverse_)
20+import Test.DocTest
21+
22+main :: IO ()
23+main = do
24+ traverse_ putStrLn args
25+ doctest args
26+ where
27+ args = flags ++ pkgs ++ module_sources
servant-swagger/CHANGELOG.mddeleted−143
@@ -1,143 +0,0 @@
1−1.1.9
2−-------
3−
4−* Support `servant-0.18`
5−
6−1.1.8
7−-------
8−
9−* Support `servant-0.17`
10−
11−1.1.7.1
12−-------
13−
14−* Support `swagger2-2.4`
15−
16−1.1.7
17−-----
18−
19−* Support servant-0.15
20− - support for 'Stream' and 'StreamBody' combinators
21− - orphan 'ToSchema (SourceT m a)' instance
22−* Fix BodyTypes to work with generalized ReqBody'
23− [#88](https://github.com/haskell-servant/servant-swagger/pull/88)
24−
25−1.1.6
26−-----
27−
28−* Fixes:
29− * `validateEveryToJSON` now prints validation errors
30−
31−* Notes:
32− * GHC-8.6 compatible release
33−
34−1.1.5
35−-----
36−
37−* Notes:
38− * `servant-0.13` compatible release
39− * Drops compatibility with previous `servant` versions.
40−
41−1.1.4
42−-----
43−
44−* Notes:
45− * `servant-0.12` compatible release
46−
47−1.1.3.1
48−---
49−
50−* Notes:
51− * GHC-8.2 compatible release
52−
53−1.1.3
54−---
55−
56−* Notes:
57− * `servant-0.11` compatible release
58−
59−1.1.2.1
60−---
61−
62−* Notes:
63− * `servant-0.10` compatible release
64−
65−1.1.2
66−---
67−
68−* Minor fixes:
69− * Support for aeson-1, insert-ordered-containers-0.2
70− * CaptureAll instance
71−
72−1.1.1
73−---
74−
75−* Minor fixes:
76− * Fix `unused-imports` and `unused-foralls` warnings;
77− * Fix tests to match `swagger2-2.1.1` (add `example` property for `UTCTime` schema).
78−
79−1.1
80−---
81−
82−* Breaking changes:
83− * Requires `swagger2 >= 2.1`
84− * Requires `servant >= 0.5`
85−
86−* Notes:
87− * GHC-8.0 compatible release
88−
89−1.0.3
90−---
91−
92−* Fixes:
93− * Improve compile-time performance of `BodyTypes` even further (see [18e0d95](https://github.com/haskell-servant/servant-swagger/commit/18e0d95ef6fe9076dd9621cb515d8d1a189f71d3))!
94−
95−1.0.2
96−---
97−
98−* Minor changes:
99− * Add GHC 7.8 support (see [#26](https://github.com/haskell-servant/servant-swagger/pull/26)).
100−
101−* Fixes:
102− * Improve compile-time performance of `BodyTypes` (see [#25](https://github.com/haskell-servant/servant-swagger/issues/25)).
103−
104−1.0.1
105−---
106−
107−* Fixes:
108− * Stop using `Data.Swagger.Internal`;
109− * Documentation fixes (links to examples).
110−
111−1.0
112−---
113−
114−* Major changes (see [#24](https://github.com/haskell-servant/servant-swagger/pull/24)):
115− * Switch to `swagger2-2.*`;
116− * Add automatic `ToJSON`/`ToSchema` validation tests;
117− * Add great documentation;
118− * Export some type-level functions for servant API.
119−
120−* Minor changes:
121− * Rework Todo API example;
122− * Stop exporting `ToResponseHeader`, `AllAccept` and `AllToResponseHeader` (see [bd50db4](https://github.com/haskell-servant/servant-swagger/commit/bd50db48ca6a106e4366560ded70932d409de1e2));
123− * Change maintainer, update authors/copyrights (see [1a62681](https://github.com/haskell-servant/servant-swagger/commit/1a6268101dc826a92c42e832e402e251c0d32147));
124− * Include changelog and example files into `extra-source-files`.
125−
126−0.1.2
127−---
128−
129−* Fixes:
130− * Fix default spec for `ReqBody` param to be required (see [#22](https://github.com/haskell-servant/servant-swagger/issues/22));
131− * Set version bounds for `swagger2`.
132−
133−0.1.1
134−---
135−
136−* Fixes:
137− * Fix `subOperations` to filter endpoints also by method (see [#18](https://github.com/haskell-servant/servant-swagger/issues/18));
138− * Fix response schema in `ToSwagger` instance for `Header` (see [b59e557](https://github.com/haskell-servant/servant-swagger/commit/b59e557a05bc2669332c52b397879e7598747b82)).
139−
140−0.1
141−---
142−* Major changes
143− * Use `swagger2` for data model (see [#9](https://github.com/dmjio/servant-swagger/pull/9)); this changes almost everything.
servant-swagger/LICENSEdeleted−28
@@ -1,28 +0,0 @@
1−Copyright (c) 2015-2016, Servant contributors
2−All rights reserved.
3−
4−Redistribution and use in source and binary forms, with or without
5−modification, are permitted provided that the following conditions are met:
6−
7−* Redistributions of source code must retain the above copyright notice, this
8− list of conditions and the following disclaimer.
9−
10−* Redistributions in binary form must reproduce the above copyright notice,
11− this list of conditions and the following disclaimer in the documentation
12− and/or other materials provided with the distribution.
13−
14−* Neither the name of servant-swagger nor the names of its
15− contributors may be used to endorse or promote products derived from
16− this software without specific prior written permission.
17−
18−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19−AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20−IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21−DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22−FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23−DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24−SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25−CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26−OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28−
servant-swagger/README.mddeleted−46
@@ -1,46 +0,0 @@
1−# servant-swagger
2−
3−[![Hackage](https://img.shields.io/hackage/v/servant-swagger.svg)](http://hackage.haskell.org/package/servant-swagger)
4−[![Stackage LTS](http://stackage.org/package/servant-swagger/badge/lts)](http://stackage.org/lts/package/servant-swagger)
5−[![Stackage Nightly](http://stackage.org/package/servant-swagger/badge/nightly)](http://stackage.org/nightly/package/servant-swagger)
6−
7−Swagger 2.0 conforming json for [servant](https://github.com/haskell-servant/servant) APIs.
8−
9−![servant-swagger robot](http://s16.postimg.org/rndz1wbyt/servant.png)
10−
11−### Motivation
12−
13−Swagger is a project used to describe and document RESTful APIs.
14−Unlike Servant it is language-agnostic and thus is quite popular among developers
15−in different languages. It also exists for a longer time and has more tools to work with.
16−
17−This package provides means to generate Swagger specification for a Servant API
18−and also to partially test whether API conforms with its specification.
19−
20−Generated Swagger specification then can be used for many things such as
21−- displaying interactive documentation using [Swagger UI](http://swagger.io/swagger-ui/);
22−- generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/);
23−- and [many others](http://swagger.io/open-source-integrations/).
24−
25−### Usage
26−
27−Please refer to [haddock documentation](http://hackage.haskell.org/package/servant/servant-swagger).
28−
29−Some examples can be found in [`example/` directory](/example).
30−
31−### Try it out
32−
33−All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).
34−
35−Ready-to-use specification can be served as JSON and interactive API documentation
36−can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).
37−
38−Many Swagger tools, including server and client code generation for many languages, can be found on
39−[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).
40−
41−### Contributing
42−
43−We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
44−
45−Please report bugs via the [github issue tracker](https://github.com/haskell-servant/servant/issues).
46−
servant-swagger/Setup.hsdeleted−33
@@ -1,33 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# OPTIONS_GHC -Wall #-}
3−module Main (main) where
4−
5−#ifndef MIN_VERSION_cabal_doctest
6−#define MIN_VERSION_cabal_doctest(x,y,z) 0
7−#endif
8−
9−#if MIN_VERSION_cabal_doctest(1,0,0)
10−
11−import Distribution.Extra.Doctest ( defaultMainWithDoctests )
12−main :: IO ()
13−main = defaultMainWithDoctests "doctests"
14−
15−#else
16−
17−#ifdef MIN_VERSION_Cabal
18−-- If the macro is defined, we have new cabal-install,
19−-- but for some reason we don't have cabal-doctest in package-db
20−--
21−-- Probably we are running cabal sdist, when otherwise using new-build
22−-- workflow
23−#warning You are configuring this package without cabal-doctest installed. \
24− The doctests test-suite will not work as a result. \
25− To fix this, install cabal-doctest before configuring.
26−#endif
27−
28−import Distribution.Simple
29−
30−main :: IO ()
31−main = defaultMain
32−
33−#endif
servant-swagger/example/LICENSEdeleted−28
@@ -1,28 +0,0 @@
1−Copyright (c) 2015-2016, Servant contributors
2−All rights reserved.
3−
4−Redistribution and use in source and binary forms, with or without
5−modification, are permitted provided that the following conditions are met:
6−
7−* Redistributions of source code must retain the above copyright notice, this
8− list of conditions and the following disclaimer.
9−
10−* Redistributions in binary form must reproduce the above copyright notice,
11− this list of conditions and the following disclaimer in the documentation
12− and/or other materials provided with the distribution.
13−
14−* Neither the name of servant-swagger nor the names of its
15− contributors may be used to endorse or promote products derived from
16− this software without specific prior written permission.
17−
18−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19−AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20−IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21−DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22−FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23−DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24−SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25−CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26−OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28−
servant-swagger/example/example.cabaldeleted−62
@@ -1,62 +0,0 @@
1−cabal-version: 2.2
2−name: example
3−version: 1.0
4−synopsis: servant-swagger demonstration
5−description: servant-swagger demonstration
6−license: BSD-3-Clause
7−license-file: LICENSE
8−author: David Johnson, Nickolay Kudasov
9−maintainer: nickolay.kudasov@gmail.com
10−copyright: (c) 2015-2016, Servant contributors
11−category: Web
12−build-type: Simple
13−data-files:
14− swagger.json
15−
16−library
17− ghc-options: -Wall
18− hs-source-dirs: src/
19− exposed-modules:
20− Todo
21− build-depends: base
22− , aeson
23− , aeson-pretty
24− , bytestring
25− , lens
26− , servant
27− , servant-server
28− , servant-swagger
29− , swagger2
30− , text
31− , time
32− default-language: Haskell2010
33−
34−executable swagger-server
35− ghc-options: -Wall
36− hs-source-dirs: server/
37− main-is: Main.hs
38− build-depends: base
39− , example
40− , servant-server
41− , warp
42− default-language: Haskell2010
43−
44−test-suite swagger-server-spec
45− ghc-options: -Wall
46− type: exitcode-stdio-1.0
47− hs-source-dirs: test
48− main-is: Spec.hs
49− other-modules:
50− TodoSpec
51− Paths_example
52− build-depends: base == 4.*
53− , base-compat >= 0.6.0
54− , aeson >=0.11.2.0
55− , bytestring
56− , example
57− , hspec
58− , servant-swagger
59− , QuickCheck
60− , quickcheck-instances
61− default-language: Haskell2010
62−
servant-swagger/example/server/Main.hsdeleted−11
@@ -1,11 +0,0 @@
1−module Main where
2−
3−import Network.Wai.Handler.Warp
4−import Servant
5−import Todo
6−
7−main :: IO ()
8−main = do
9− putStrLn "Running on port 8000"
10− run 8000 $ serve (Proxy :: Proxy API) server
11−
servant-swagger/example/src/Todo.hsdeleted−73
@@ -1,73 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveGeneric #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE TypeOperators #-}
7−module Todo where
8−
9−import Control.Lens
10−import Data.Aeson
11−import Data.Aeson.Encode.Pretty (encodePretty)
12−import qualified Data.ByteString.Lazy.Char8 as BL8
13−import Data.Proxy
14−import Data.Swagger
15−import Data.Text (Text)
16−import Data.Time (UTCTime (..), fromGregorian)
17−import Data.Typeable (Typeable)
18−import GHC.Generics
19−import Servant
20−import Servant.Swagger
21−
22−todoAPI :: Proxy TodoAPI
23−todoAPI = Proxy
24−
25−-- | The API of a Todo service.
26−type TodoAPI
27− = "todo" :> Get '[JSON] [Todo]
28− :<|> "todo" :> ReqBody '[JSON] Todo :> Post '[JSON] TodoId
29− :<|> "todo" :> Capture "id" TodoId :> Get '[JSON] Todo
30− :<|> "todo" :> Capture "id" TodoId :> ReqBody '[JSON] Todo :> Put '[JSON] TodoId
31−
32−-- | API for serving @swagger.json@.
33−type SwaggerAPI = "swagger.json" :> Get '[JSON] Swagger
34−
35−-- | Combined API of a Todo service with Swagger documentation.
36−type API = SwaggerAPI :<|> TodoAPI
37−
38−-- | A single Todo entry.
39−data Todo = Todo
40− { created :: UTCTime -- ^ Creation datetime.
41− , summary :: Text -- ^ Task summary.
42− } deriving (Show, Generic, Typeable)
43−
44−-- | A unique Todo entry ID.
45−newtype TodoId = TodoId Int
46− deriving (Show, Generic, Typeable, ToJSON, FromHttpApiData)
47−
48−instance ToJSON Todo
49−instance FromJSON Todo
50−
51−instance ToSchema Todo where
52− declareNamedSchema proxy = genericDeclareNamedSchema defaultSchemaOptions proxy
53− & mapped.schema.description ?~ "This is some real Todo right here"
54− & mapped.schema.example ?~ toJSON (Todo (UTCTime (fromGregorian 2015 12 31) 0) "get milk")
55−
56−instance ToParamSchema TodoId
57−instance ToSchema TodoId
58−
59−-- | Swagger spec for Todo API.
60−todoSwagger :: Swagger
61−todoSwagger = toSwagger todoAPI
62− & info.title .~ "Todo API"
63− & info.version .~ "1.0"
64− & info.description ?~ "This is an API that tests swagger integration"
65− & info.license ?~ ("MIT" & url ?~ URL "http://mit.com")
66−
67−-- | Combined server of a Todo service with Swagger documentation.
68−server :: Server API
69−server = return todoSwagger :<|> error "not implemented"
70−
71−-- | Output generated @swagger.json@ file for the @'TodoAPI'@.
72−writeSwaggerJSON :: IO ()
73−writeSwaggerJSON = BL8.writeFile "example/swagger.json" (encodePretty todoSwagger)
servant-swagger/example/swagger.jsondeleted−158
@@ -1,158 +0,0 @@
1−{
2− "swagger": "2.0",
3− "info": {
4− "version": "1.0",
5− "title": "Todo API",
6− "license": {
7− "url": "http://mit.com",
8− "name": "MIT"
9− },
10− "description": "This is an API that tests swagger integration"
11− },
12− "definitions": {
13− "Todo": {
14− "example": {
15− "summary": "get milk",
16− "created": "2015-12-31T00:00:00Z"
17− },
18− "required": [
19− "created",
20− "summary"
21− ],
22− "type": "object",
23− "description": "This is some real Todo right here",
24− "properties": {
25− "summary": {
26− "type": "string"
27− },
28− "created": {
29− "$ref": "#/definitions/UTCTime"
30− }
31− }
32− },
33− "UTCTime": {
34− "example": "2016-07-22T00:00:00Z",
35− "format": "yyyy-mm-ddThh:MM:ssZ",
36− "type": "string"
37− },
38− "TodoId": {
39− "maximum": 9223372036854775807,
40− "minimum": -9223372036854775808,
41− "type": "integer"
42− }
43− },
44− "paths": {
45− "/todo/{id}": {
46− "get": {
47− "responses": {
48− "400": {
49− "description": "Invalid `id`"
50− },
51− "200": {
52− "schema": {
53− "$ref": "#/definitions/Todo"
54− },
55− "description": ""
56− }
57− },
58− "produces": [
59− "application/json;charset=utf-8"
60− ],
61− "parameters": [
62− {
63− "maximum": 9223372036854775807,
64− "minimum": -9223372036854775808,
65− "required": true,
66− "in": "path",
67− "name": "id",
68− "type": "integer"
69− }
70− ]
71− },
72− "put": {
73− "consumes": [
74− "application/json;charset=utf-8"
75− ],
76− "responses": {
77− "400": {
78− "description": "Invalid `body` or `id`"
79− },
80− "200": {
81− "schema": {
82− "$ref": "#/definitions/TodoId"
83− },
84− "description": ""
85− }
86− },
87− "produces": [
88− "application/json;charset=utf-8"
89− ],
90− "parameters": [
91− {
92− "maximum": 9223372036854775807,
93− "minimum": -9223372036854775808,
94− "required": true,
95− "in": "path",
96− "name": "id",
97− "type": "integer"
98− },
99− {
100− "required": true,
101− "schema": {
102− "$ref": "#/definitions/Todo"
103− },
104− "in": "body",
105− "name": "body"
106− }
107− ]
108− }
109− },
110− "/todo": {
111− "post": {
112− "consumes": [
113− "application/json;charset=utf-8"
114− ],
115− "responses": {
116− "400": {
117− "description": "Invalid `body`"
118− },
119− "200": {
120− "schema": {
121− "$ref": "#/definitions/TodoId"
122− },
123− "description": ""
124− }
125− },
126− "produces": [
127− "application/json;charset=utf-8"
128− ],
129− "parameters": [
130− {
131− "required": true,
132− "schema": {
133− "$ref": "#/definitions/Todo"
134− },
135− "in": "body",
136− "name": "body"
137− }
138− ]
139− },
140− "get": {
141− "responses": {
142− "200": {
143− "schema": {
144− "items": {
145− "$ref": "#/definitions/Todo"
146− },
147− "type": "array"
148− },
149− "description": ""
150− }
151− },
152− "produces": [
153− "application/json;charset=utf-8"
154− ]
155− }
156− }
157− }
158−}
servant-swagger/example/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-swagger/example/test/TodoSpec.hsdeleted−28
@@ -1,28 +0,0 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−module TodoSpec where
3−
4−import Prelude ()
5−import Prelude.Compat
6−
7−import Data.Aeson
8−import qualified Data.ByteString.Lazy.Char8 as BL8
9−import Paths_example
10−import Servant.Swagger.Test
11−import Test.Hspec
12−import Test.QuickCheck
13−import Test.QuickCheck.Instances ()
14−import Todo
15−
16−spec :: Spec
17−spec = describe "Swagger" $ do
18− context "ToJSON matches ToSchema" $ validateEveryToJSON todoAPI
19− it "swagger.json is up-to-date" $ do
20− path <- getDataFileName "swagger.json"
21− swag <- eitherDecode <$> BL8.readFile path
22− swag `shouldBe` Right todoSwagger
23−
24−instance Arbitrary Todo where
25− arbitrary = Todo <$> arbitrary <*> arbitrary
26−
27−instance Arbitrary TodoId where
28− arbitrary = TodoId <$> arbitrary
servant-swagger/servant-swagger.cabaldeleted−127
@@ -1,127 +0,0 @@
1−cabal-version: 2.2
2−name: servant-swagger
3−version: 1.1.11
4−synopsis: Generate a Swagger/OpenAPI/OAS 2.0 specification for your servant API.
5−description:
6− Swagger is a project used to describe and document RESTful APIs. The core of the
7− project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
8− This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is
9− quite popular among developers in different languages. It has also existed for a longer time
10− and has more helpful tooling.
11− .
12− This package provides means to generate a Swagger/OAS specification for a Servant API
13− and also to partially test whether an API conforms with its specification.
14− .
15− Generated Swagger specification then can be used for many things such as
16− .
17− * displaying interactive documentation using [Swagger UI](http://swagger.io/swagger-ui/);
18− .
19− * generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/);
20− .
21− * and [many others](http://swagger.io/open-source-integrations/).
22−homepage: https://github.com/haskell-servant/servant/tree/master/servant-swagger#readme
23−bug-reports: https://github.com/haskell-servant/servant/issues
24−license: BSD-3-Clause
25−license-file: LICENSE
26−author: Servant Contributors
27−maintainer: haskell-servant-maintainers@googlegroups.com
28−copyright: (c) 2015-2018, Servant contributors
29−category: Web, Servant, Swagger
30−build-type: Custom
31−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2
32−
33−extra-source-files:
34− README.md
35− , CHANGELOG.md
36− , example/server/*.hs
37− , example/src/*.hs
38− , example/test/*.hs
39− , example/*.cabal
40− , example/swagger.json
41− , example/LICENSE
42−extra-doc-files:
43− example/src/*.hs
44− , example/test/*.hs
45−
46−source-repository head
47− type: git
48− location: https://github.com/haskell-servant/servant.git
49−
50−custom-setup
51− setup-depends:
52− base >=4.9 && <5,
53− Cabal >= 1.24,
54− cabal-doctest >=1.0.6 && <1.1
55−
56−library
57− ghc-options: -Wall
58− exposed-modules:
59− Servant.Swagger
60− Servant.Swagger.Test
61− Servant.Swagger.TypeLevel
62−
63− -- Internal modules
64− Servant.Swagger.Internal
65− Servant.Swagger.Internal.Orphans
66− Servant.Swagger.Internal.Test
67− Servant.Swagger.Internal.TypeLevel
68− Servant.Swagger.Internal.TypeLevel.API
69− Servant.Swagger.Internal.TypeLevel.Every
70− Servant.Swagger.Internal.TypeLevel.TMap
71− hs-source-dirs: src
72− build-depends: aeson >=1.4.2.0 && <3
73− , aeson-pretty >=0.8.7 && <0.9
74− , base >=4.9.1.0 && <5
75− , base-compat >=0.10.5 && <0.13
76− , bytestring >=0.10.8.1 && <0.12
77− , http-media >=0.7.1.3 && <0.9
78− , insert-ordered-containers >=0.2.1.0 && <0.3
79− , lens >=4.17 && <6
80− , servant >=0.18.2 && <0.20
81− , singleton-bool >=0.1.4 && <0.2
82− , swagger2 >=2.3.0.1 && <3
83− , text >=1.2.3.0 && <2.1
84− , unordered-containers >=0.2.9.0 && <0.3
85−
86− , hspec
87− , QuickCheck
88− default-language: Haskell2010
89−
90−test-suite doctests
91− ghc-options: -Wall
92− build-depends:
93− base,
94− directory >= 1.0,
95− doctest >= 0.17 && <0.21,
96− servant,
97− QuickCheck,
98− filepath
99− default-language: Haskell2010
100− hs-source-dirs: test
101− main-is: doctests.hs
102− type: exitcode-stdio-1.0
103−
104−test-suite spec
105− ghc-options: -Wall
106− type: exitcode-stdio-1.0
107− hs-source-dirs: test
108− main-is: Spec.hs
109− build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.10
110− build-depends: base
111− , base-compat
112− , aeson >=1.4.2.0 && <3
113− , hspec >=2.6.0 && <2.10
114− , QuickCheck
115− , lens
116− , lens-aeson >=1.0.2 && <1.3
117− , servant
118− , servant-swagger
119− , swagger2
120− , text
121− , template-haskell
122− , utf8-string >=1.0.1.1 && <1.1
123− , time
124− , vector
125− other-modules:
126− Servant.SwaggerSpec
127− default-language: Haskell2010
servant-swagger/src/Servant/Swagger.hsdeleted−188
@@ -1,188 +0,0 @@
1−-- |
2−-- Module: Servant.Swagger
3−-- License: BSD3
4−-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5−-- Stability: experimental
6−--
7−-- This module provides means to generate and manipulate
8−-- Swagger specification for servant APIs.
9−--
10−-- Swagger is a project used to describe and document RESTful APIs.
11−--
12−-- The Swagger specification defines a set of files required to describe such an API.
13−-- These files can then be used by the Swagger-UI project to display the API
14−-- and Swagger-Codegen to generate clients in various languages.
15−-- Additional utilities can also take advantage of the resulting files, such as testing tools.
16−--
17−-- For more information see <http://swagger.io/ Swagger documentation>.
18−module Servant.Swagger (
19− -- * How to use this library
20− -- $howto
21−
22− -- ** Generate @'Swagger'@
23− -- $generate
24−
25− -- ** Annotate
26− -- $annotate
27−
28− -- ** Test
29− -- $test
30−
31− -- ** Serve
32− -- $serve
33−
34− -- * @'HasSwagger'@ class
35− HasSwagger(..),
36−
37− -- * Manipulation
38− subOperations,
39−
40− -- * Testing
41− validateEveryToJSON,
42− validateEveryToJSONWithPatternChecker,
43−) where
44−
45−import Servant.Swagger.Internal
46−import Servant.Swagger.Test
47−import Servant.Swagger.Internal.Orphans ()
48−
49−-- $setup
50−-- >>> import Control.Applicative
51−-- >>> import Control.Lens
52−-- >>> import Data.Aeson
53−-- >>> import Data.Aeson.Encode.Pretty
54−-- >>> import Data.Swagger
55−-- >>> import Data.Typeable
56−-- >>> import GHC.Generics
57−-- >>> import Servant.API
58−-- >>> import System.Environment
59−-- >>> import Test.Hspec
60−-- >>> import Test.QuickCheck
61−-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8
62−-- >>> :set -XDataKinds
63−-- >>> :set -XDeriveDataTypeable
64−-- >>> :set -XDeriveGeneric
65−-- >>> :set -XGeneralizedNewtypeDeriving
66−-- >>> :set -XOverloadedStrings
67−-- >>> :set -XTypeOperators
68−-- >>> setEnv "HSPEC_COLOR" "no"
69−-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)
70−-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)
71−-- >>> instance ToJSON User
72−-- >>> instance ToSchema User
73−-- >>> instance ToSchema UserId
74−-- >>> instance ToParamSchema UserId
75−-- >>> type GetUsers = Get '[JSON] [User]
76−-- >>> type GetUser = Capture "user_id" UserId :> Get '[JSON] User
77−-- >>> type PostUser = ReqBody '[JSON] User :> Post '[JSON] UserId
78−-- >>> type UserAPI = GetUsers :<|> GetUser :<|> PostUser
79−-- >>> orderedKeys = encodePretty' (defConfig { confCompare = compare, confIndent = Spaces 0 })
80−
81−-- $howto
82−--
83−-- This section explains how to use this library to generate Swagger specification,
84−-- modify it and run automatic tests for a servant API.
85−--
86−-- For the purposes of this section we will use this servant API:
87−--
88−-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)
89−-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)
90−-- >>> instance ToJSON User
91−-- >>> instance ToSchema User
92−-- >>> instance ToSchema UserId
93−-- >>> instance ToParamSchema UserId
94−-- >>> type GetUsers = Get '[JSON] [User]
95−-- >>> type GetUser = Capture "user_id" UserId :> Get '[JSON] User
96−-- >>> type PostUser = ReqBody '[JSON] User :> Post '[JSON] UserId
97−-- >>> type UserAPI = GetUsers :<|> GetUser :<|> PostUser
98−--
99−-- Here we define a user API with three endpoints. @GetUsers@ endpoint returns a list of all users.
100−-- @GetUser@ returns a user given his\/her ID. @PostUser@ creates a new user and returns his\/her ID.
101−
102−-- $generate
103−-- In order to generate @'Swagger'@ specification for a servant API, just use @'toSwagger'@:
104−--
105−-- >>> BSL8.putStrLn . orderedKeys $ toSwagger (Proxy :: Proxy UserAPI)
106−-- {"definitions":{"User":{"properties":{"age":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"name":{"type":"string"}},"required":["name","age"],"type":"object"},"UserId":{"type":"integer"}},"info":{"title":"","version":""},"paths":{"/":{"get":{"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"items":{"$ref":"#/definitions/User"},"type":"array"}}}},"post":{"consumes":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/UserId"}},"400":{"description":"Invalid `body`"}}}},"/{user_id}":{"get":{"parameters":[{"in":"path","name":"user_id","required":true,"type":"integer"}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Invalid `user_id`"}}}}},"swagger":"2.0"}
107−--
108−-- By default @'toSwagger'@ will generate specification for all API routes, parameters, headers, responses and data schemas.
109−--
110−-- For some parameters it will also add 400 responses with a description mentioning parameter name.
111−--
112−-- Data schemas come from @'ToParamSchema'@ and @'ToSchema'@ classes.
113−
114−-- $annotate
115−-- While initially generated @'Swagger'@ looks good, it lacks some information it can't get from a servant API.
116−--
117−-- We can add this information using field lenses from @"Data.Swagger"@:
118−--
119−-- >>> :{
120−-- BSL8.putStrLn $ orderedKeys $ toSwagger (Proxy :: Proxy UserAPI)
121−-- & info.title .~ "User API"
122−-- & info.version .~ "1.0"
123−-- & info.description ?~ "This is an API for the Users service"
124−-- & info.license ?~ "MIT"
125−-- & host ?~ "example.com"
126−-- :}
127−-- {"definitions":{"User":{"properties":{"age":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"name":{"type":"string"}},"required":["name","age"],"type":"object"},"UserId":{"type":"integer"}},"host":"example.com","info":{"description":"This is an API for the Users service","license":{"name":"MIT"},"title":"User API","version":"1.0"},"paths":{"/":{"get":{"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"items":{"$ref":"#/definitions/User"},"type":"array"}}}},"post":{"consumes":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/UserId"}},"400":{"description":"Invalid `body`"}}}},"/{user_id}":{"get":{"parameters":[{"in":"path","name":"user_id","required":true,"type":"integer"}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Invalid `user_id`"}}}}},"swagger":"2.0"}
128−--
129−-- It is also useful to annotate or modify certain endpoints.
130−-- @'subOperations'@ provides a convenient way to zoom into a part of an API.
131−--
132−-- @'subOperations' sub api@ traverses all operations of the @api@ which are also present in @sub@.
133−-- Furthermore, @sub@ is required to be an exact sub API of @api. Otherwise it will not typecheck.
134−--
135−-- @"Data.Swagger.Operation"@ provides some useful helpers that can be used with @'subOperations'@.
136−-- One example is applying tags to certain endpoints:
137−--
138−-- >>> let getOps = subOperations (Proxy :: Proxy (GetUsers :<|> GetUser)) (Proxy :: Proxy UserAPI)
139−-- >>> let postOps = subOperations (Proxy :: Proxy PostUser) (Proxy :: Proxy UserAPI)
140−-- >>> :{
141−-- BSL8.putStrLn $ orderedKeys $ toSwagger (Proxy :: Proxy UserAPI)
142−-- & applyTagsFor getOps ["get" & description ?~ "GET operations"]
143−-- & applyTagsFor postOps ["post" & description ?~ "POST operations"]
144−-- :}
145−-- {"definitions":{"User":{"properties":{"age":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"name":{"type":"string"}},"required":["name","age"],"type":"object"},"UserId":{"type":"integer"}},"info":{"title":"","version":""},"paths":{"/":{"get":{"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"items":{"$ref":"#/definitions/User"},"type":"array"}}},"tags":["get"]},"post":{"consumes":["application/json;charset=utf-8"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/User"}}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/UserId"}},"400":{"description":"Invalid `body`"}},"tags":["post"]}},"/{user_id}":{"get":{"parameters":[{"in":"path","name":"user_id","required":true,"type":"integer"}],"produces":["application/json;charset=utf-8"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Invalid `user_id`"}},"tags":["get"]}}},"swagger":"2.0","tags":[{"description":"GET operations","name":"get"},{"description":"POST operations","name":"post"}]}
146−--
147−-- This applies @\"get\"@ tag to the @GET@ endpoints and @\"post\"@ tag to the @POST@ endpoint of the User API.
148−
149−-- $test
150−-- Automatic generation of data schemas uses @'ToSchema'@ instances for the types
151−-- used in a servant API. But to encode/decode actual data servant uses different classes.
152−-- For instance in @UserAPI@ @User@ is always encoded/decoded using @'ToJSON'@ and @'FromJSON'@ instances.
153−--
154−-- To be sure your Haskell server/client handles data properly you need to check
155−-- that @'ToJSON'@ instance always generates values that satisfy schema produced
156−-- by @'ToSchema'@ instance.
157−--
158−-- With @'validateEveryToJSON'@ it is possible to test all those instances automatically,
159−-- without having to write down every type:
160−--
161−-- >>> instance Arbitrary User where arbitrary = User <$> arbitrary <*> arbitrary
162−-- >>> instance Arbitrary UserId where arbitrary = UserId <$> arbitrary
163−-- >>> hspec $ validateEveryToJSON (Proxy :: Proxy UserAPI)
164−-- <BLANKLINE>
165−-- [User]...
166−-- ...
167−-- User...
168−-- ...
169−-- UserId...
170−-- ...
171−-- Finished in ... seconds
172−-- 3 examples, 0 failures
173−--
174−-- Although servant is great, chances are that your API clients don't use Haskell.
175−-- In many cases @swagger.json@ serves as a specification, not a Haskell type.
176−--
177−-- In this cases it is a good idea to store generated and annotated @'Swagger'@ in a @swagger.json@ file
178−-- under a version control system (such as Git, Subversion, Mercurial, etc.).
179−--
180−-- It is also recommended to version API based on changes to the @swagger.json@ rather than changes
181−-- to the Haskell API.
182−--
183−-- See <example/test/TodoSpec.hs TodoSpec.hs> for an example of a complete test suite for a swagger specification.
184−
185−-- $serve
186−-- If you're implementing a server for an API, you might also want to serve its @'Swagger'@ specification.
187−--
188−-- See <example/src/Todo.hs Todo.hs> for an example of a server.
servant-swagger/src/Servant/Swagger/Internal.hsdeleted−488
@@ -1,488 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE OverloadedLists #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE RankNTypes #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE TypeFamilies #-}
13−#if __GLASGOW_HASKELL__ >= 806
14−{-# LANGUAGE UndecidableInstances #-}
15−#endif
16−module Servant.Swagger.Internal where
17−
18−import Prelude ()
19−import Prelude.Compat
20−
21−import Control.Applicative ((<|>))
22−import Control.Lens
23−import Data.Aeson
24−import Data.HashMap.Strict.InsOrd (InsOrdHashMap)
25−import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
26−import Data.Foldable (toList)
27−import Data.Proxy
28−import Data.Typeable
29−import Data.Singletons.Bool
30−import Data.Swagger hiding (Header)
31−import qualified Data.Swagger as Swagger
32−import Data.Swagger.Declare
33−import Data.Text (Text)
34−import qualified Data.Text as Text
35−import GHC.Generics (D1, Meta(..), Rep)
36−import GHC.TypeLits
37−import Network.HTTP.Media (MediaType)
38−import Servant.API
39−import Servant.API.Description (FoldDescription,
40− reflectDescription)
41−import Servant.API.Generic (ToServantApi, AsApi)
42−import Servant.API.Modifiers (FoldRequired)
43−
44−import Servant.Swagger.Internal.TypeLevel.API
45−
46−-- | Generate a Swagger specification for a servant API.
47−--
48−-- To generate Swagger specification, your data types need
49−-- @'ToParamSchema'@ and/or @'ToSchema'@ instances.
50−--
51−-- @'ToParamSchema'@ is used for @'Capture'@, @'QueryParam'@ and @'Header'@.
52−-- @'ToSchema'@ is used for @'ReqBody'@ and response data types.
53−--
54−-- You can easily derive those instances via @Generic@.
55−-- For more information, refer to <http://hackage.haskell.org/package/swagger2/docs/Data-Swagger.html swagger2 documentation>.
56−--
57−-- Example:
58−--
59−-- @
60−-- newtype Username = Username String deriving (Generic, ToText)
61−--
62−-- instance ToParamSchema Username
63−--
64−-- data User = User
65−-- { username :: Username
66−-- , fullname :: String
67−-- } deriving (Generic)
68−--
69−-- instance ToJSON User
70−-- instance ToSchema User
71−--
72−-- type MyAPI = QueryParam "username" Username :> Get '[JSON] User
73−--
74−-- mySwagger :: Swagger
75−-- mySwagger = toSwagger (Proxy :: Proxy MyAPI)
76−-- @
77−class HasSwagger api where
78− -- | Generate a Swagger specification for a servant API.
79− toSwagger :: Proxy api -> Swagger
80−
81−instance HasSwagger Raw where
82− toSwagger _ = mempty & paths . at "/" ?~ mempty
83−
84−instance HasSwagger EmptyAPI where
85− toSwagger _ = mempty
86−
87−-- | All operations of sub API.
88−-- This is similar to @'operationsOf'@ but ensures that operations
89−-- indeed belong to the API at compile time.
90−subOperations :: (IsSubAPI sub api, HasSwagger sub) =>
91− Proxy sub -- ^ Part of a servant API.
92− -> Proxy api -- ^ The whole servant API.
93− -> Traversal' Swagger Operation
94−subOperations sub _ = operationsOf (toSwagger sub)
95−
96−-- | Make a singleton Swagger spec (with only one endpoint).
97−-- For endpoints with no content see 'mkEndpointNoContent'.
98−mkEndpoint :: forall a cs hs proxy method status.
99− (ToSchema a, AllAccept cs, AllToResponseHeader hs, SwaggerMethod method, KnownNat status)
100− => FilePath -- ^ Endpoint path.
101− -> proxy (Verb method status cs (Headers hs a)) -- ^ Method, content-types, headers and response.
102− -> Swagger
103−mkEndpoint path proxy
104− = mkEndpointWithSchemaRef (Just ref) path proxy
105− & definitions .~ defs
106− where
107− (defs, ref) = runDeclare (declareSchemaRef (Proxy :: Proxy a)) mempty
108−
109−-- | Make a singletone 'Swagger' spec (with only one endpoint) and with no content schema.
110−mkEndpointNoContent :: forall nocontent cs hs proxy method status.
111− (AllAccept cs, AllToResponseHeader hs, SwaggerMethod method, KnownNat status)
112− => FilePath -- ^ Endpoint path.
113− -> proxy (Verb method status cs (Headers hs nocontent)) -- ^ Method, content-types, headers and response.
114− -> Swagger
115−mkEndpointNoContent path proxy
116− = mkEndpointWithSchemaRef Nothing path proxy
117−
118−-- | Like @'mkEndpoint'@ but with explicit schema reference.
119−-- Unlike @'mkEndpoint'@ this function does not update @'definitions'@.
120−mkEndpointWithSchemaRef :: forall cs hs proxy method status a.
121− (AllAccept cs, AllToResponseHeader hs, SwaggerMethod method, KnownNat status)
122− => Maybe (Referenced Schema)
123− -> FilePath
124− -> proxy (Verb method status cs (Headers hs a))
125− -> Swagger
126−mkEndpointWithSchemaRef mref path _ = mempty
127− & paths.at path ?~
128− (mempty & method ?~ (mempty
129− & produces ?~ MimeList responseContentTypes
130− & at code ?~ Inline (mempty
131− & schema .~ mref
132− & headers .~ responseHeaders)))
133− where
134− method = swaggerMethod (Proxy :: Proxy method)
135− code = fromIntegral (natVal (Proxy :: Proxy status))
136− responseContentTypes = allContentType (Proxy :: Proxy cs)
137− responseHeaders = toAllResponseHeaders (Proxy :: Proxy hs)
138−
139−mkEndpointNoContentVerb :: forall proxy method.
140− (SwaggerMethod method)
141− => FilePath -- ^ Endpoint path.
142− -> proxy (NoContentVerb method) -- ^ Method
143− -> Swagger
144−mkEndpointNoContentVerb path _ = mempty
145− & paths.at path ?~
146− (mempty & method ?~ (mempty
147− & at code ?~ Inline mempty))
148− where
149− method = swaggerMethod (Proxy :: Proxy method)
150− code = 204 -- hardcoded in servant-server
151−
152−-- | Add parameter to every operation in the spec.
153−addParam :: Param -> Swagger -> Swagger
154−addParam param = allOperations.parameters %~ (Inline param :)
155−
156−-- | Add a tag to every operation in the spec.
157−addTag :: Text -> Swagger -> Swagger
158−addTag tag = allOperations.tags %~ ([tag] <>)
159−
160−-- | Add accepted content types to every operation in the spec.
161−addConsumes :: [MediaType] -> Swagger -> Swagger
162−addConsumes cs = allOperations.consumes %~ (<> Just (MimeList cs))
163−
164−-- | Format given text as inline code in Markdown.
165−markdownCode :: Text -> Text
166−markdownCode s = "`" <> s <> "`"
167−
168−addDefaultResponse400 :: ParamName -> Swagger -> Swagger
169−addDefaultResponse400 pname = setResponseWith (\old _new -> alter400 old) 400 (return response400)
170− where
171− sname = markdownCode pname
172− description400 = "Invalid " <> sname
173− alter400 = description %~ (<> (" or " <> sname))
174− response400 = mempty & description .~ description400
175−
176−-- | Methods, available for Swagger.
177−class SwaggerMethod method where
178− swaggerMethod :: proxy method -> Lens' PathItem (Maybe Operation)
179−
180−instance SwaggerMethod 'GET where swaggerMethod _ = get
181−instance SwaggerMethod 'PUT where swaggerMethod _ = put
182−instance SwaggerMethod 'POST where swaggerMethod _ = post
183−instance SwaggerMethod 'DELETE where swaggerMethod _ = delete
184−instance SwaggerMethod 'OPTIONS where swaggerMethod _ = options
185−instance SwaggerMethod 'HEAD where swaggerMethod _ = head_
186−instance SwaggerMethod 'PATCH where swaggerMethod _ = patch
187−
188−instance HasSwagger (UVerb method cs '[]) where
189− toSwagger _ = mempty
190−
191−-- | @since <TODO>
192−instance
193− {-# OVERLAPPABLE #-}
194− ( ToSchema a,
195− HasStatus a,
196− AllAccept cs,
197− SwaggerMethod method,
198− HasSwagger (UVerb method cs as)
199− ) =>
200− HasSwagger (UVerb method cs (a ': as))
201− where
202− toSwagger _ =
203− toSwagger (Proxy :: Proxy (Verb method (StatusOf a) cs a))
204− `combineSwagger` toSwagger (Proxy :: Proxy (UVerb method cs as))
205−
206−-- ATTENTION: do not remove this instance!
207−-- A similar instance above will always use the more general
208−-- polymorphic -- HasSwagger instance and will result in a type error
209−-- since 'NoContent' does not have a 'ToSchema' instance.
210−instance
211− ( KnownNat status,
212− AllAccept cs,
213− SwaggerMethod method,
214− HasSwagger (UVerb method cs as)
215− ) =>
216− HasSwagger (UVerb method cs (WithStatus status NoContent ': as))
217− where
218− toSwagger _ =
219− toSwagger (Proxy :: Proxy (Verb method status cs NoContent))
220− `combineSwagger` toSwagger (Proxy :: Proxy (UVerb method cs as))
221−
222−
223−-- workaround for https://github.com/GetShopTV/swagger2/issues/218
224−-- We'd like to juse use (<>) but the instances are wrong
225−combinePathItem :: PathItem -> PathItem -> PathItem
226−combinePathItem s t = PathItem
227− { _pathItemGet = _pathItemGet s <> _pathItemGet t
228− , _pathItemPut = _pathItemPut s <> _pathItemPut t
229− , _pathItemPost = _pathItemPost s <> _pathItemPost t
230− , _pathItemDelete = _pathItemDelete s <> _pathItemDelete t
231− , _pathItemOptions = _pathItemOptions s <> _pathItemOptions t
232− , _pathItemHead = _pathItemHead s <> _pathItemHead t
233− , _pathItemPatch = _pathItemPatch s <> _pathItemPatch t
234− , _pathItemParameters = _pathItemParameters s <> _pathItemParameters t
235− }
236−
237−combineSwagger :: Swagger -> Swagger -> Swagger
238−combineSwagger s t = Swagger
239− { _swaggerInfo = _swaggerInfo s <> _swaggerInfo t
240− , _swaggerHost = _swaggerHost s <|> _swaggerHost t
241− , _swaggerBasePath = _swaggerBasePath s <|> _swaggerBasePath t
242− , _swaggerSchemes = _swaggerSchemes s <> _swaggerSchemes t
243− , _swaggerConsumes = _swaggerConsumes s <> _swaggerConsumes t
244− , _swaggerProduces = _swaggerProduces s <> _swaggerProduces t
245− , _swaggerPaths = InsOrdHashMap.unionWith combinePathItem (_swaggerPaths s) (_swaggerPaths t)
246− , _swaggerDefinitions = _swaggerDefinitions s <> _swaggerDefinitions t
247− , _swaggerParameters = _swaggerParameters s <> _swaggerParameters t
248− , _swaggerResponses = _swaggerResponses s <> _swaggerResponses t
249− , _swaggerSecurityDefinitions = _swaggerSecurityDefinitions s <> _swaggerSecurityDefinitions t
250− , _swaggerSecurity = _swaggerSecurity s <> _swaggerSecurity t
251− , _swaggerTags = _swaggerTags s <> _swaggerTags t
252− , _swaggerExternalDocs = _swaggerExternalDocs s <|> _swaggerExternalDocs t
253− }
254−
255−instance {-# OVERLAPPABLE #-} (ToSchema a, AllAccept cs, KnownNat status, SwaggerMethod method) => HasSwagger (Verb method status cs a) where
256− toSwagger _ = toSwagger (Proxy :: Proxy (Verb method status cs (Headers '[] a)))
257−
258−-- | @since 1.1.7
259−instance (ToSchema a, Accept ct, KnownNat status, SwaggerMethod method) => HasSwagger (Stream method status fr ct a) where
260− toSwagger _ = toSwagger (Proxy :: Proxy (Verb method status '[ct] (Headers '[] a)))
261−
262−instance {-# OVERLAPPABLE #-} (ToSchema a, AllAccept cs, AllToResponseHeader hs, KnownNat status, SwaggerMethod method)
263− => HasSwagger (Verb method status cs (Headers hs a)) where
264− toSwagger = mkEndpoint "/"
265−
266−-- ATTENTION: do not remove this instance!
267−-- A similar instance above will always use the more general
268−-- polymorphic -- HasSwagger instance and will result in a type error
269−-- since 'NoContent' does not have a 'ToSchema' instance.
270−instance (AllAccept cs, KnownNat status, SwaggerMethod method) => HasSwagger (Verb method status cs NoContent) where
271− toSwagger _ = toSwagger (Proxy :: Proxy (Verb method status cs (Headers '[] NoContent)))
272−
273−instance (AllAccept cs, AllToResponseHeader hs, KnownNat status, SwaggerMethod method)
274− => HasSwagger (Verb method status cs (Headers hs NoContent)) where
275− toSwagger = mkEndpointNoContent "/"
276−
277−instance (SwaggerMethod method) => HasSwagger (NoContentVerb method) where
278− toSwagger = mkEndpointNoContentVerb "/"
279−
280−instance (HasSwagger a, HasSwagger b) => HasSwagger (a :<|> b) where
281− toSwagger _ = toSwagger (Proxy :: Proxy a) <> toSwagger (Proxy :: Proxy b)
282−
283−-- | @'Vault'@ combinator does not change our specification at all.
284−instance (HasSwagger sub) => HasSwagger (Vault :> sub) where
285− toSwagger _ = toSwagger (Proxy :: Proxy sub)
286−
287−-- | @'IsSecure'@ combinator does not change our specification at all.
288−instance (HasSwagger sub) => HasSwagger (IsSecure :> sub) where
289− toSwagger _ = toSwagger (Proxy :: Proxy sub)
290−
291−-- | @'RemoteHost'@ combinator does not change our specification at all.
292−instance (HasSwagger sub) => HasSwagger (RemoteHost :> sub) where
293− toSwagger _ = toSwagger (Proxy :: Proxy sub)
294−
295−-- | @'Fragment'@ combinator does not change our specification at all.
296−instance HasSwagger sub => HasSwagger (Fragment a :> sub) where
297− toSwagger _ = toSwagger (Proxy :: Proxy sub)
298−
299−-- | @'HttpVersion'@ combinator does not change our specification at all.
300−instance (HasSwagger sub) => HasSwagger (HttpVersion :> sub) where
301− toSwagger _ = toSwagger (Proxy :: Proxy sub)
302−
303−-- | @'WithNamedContext'@ combinator does not change our specification at all.
304−instance (HasSwagger sub) => HasSwagger (WithNamedContext x c sub) where
305− toSwagger _ = toSwagger (Proxy :: Proxy sub)
306−
307−instance (KnownSymbol sym, HasSwagger sub) => HasSwagger (sym :> sub) where
308− toSwagger _ = prependPath piece (toSwagger (Proxy :: Proxy sub))
309− where
310− piece = symbolVal (Proxy :: Proxy sym)
311−
312−instance (KnownSymbol sym, Typeable a, ToParamSchema a, HasSwagger sub, KnownSymbol (FoldDescription mods)) => HasSwagger (Capture' mods sym a :> sub) where
313− toSwagger _ = toSwagger (Proxy :: Proxy sub)
314− & addParam param
315− & prependPath capture
316− & addDefaultResponse400 tname
317− where
318− symbol = symbolVal (Proxy :: Proxy sym)
319− pname = if symbol == ""
320− then camelTo2 '-' . tyConName . typeRepTyCon $ typeRep (Proxy :: Proxy a)
321− else symbol
322− tname = Text.pack pname
323− transDesc "" = Nothing
324− transDesc desc = Just (Text.pack desc)
325− capture = "{" <> pname <> "}"
326− param = mempty
327− & name .~ tname
328− & description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
329− & required ?~ True
330− & schema .~ ParamOther (mempty
331− & in_ .~ ParamPath
332− & paramSchema .~ toParamSchema (Proxy :: Proxy a))
333−
334−-- | Swagger Spec doesn't have a notion of CaptureAll, this instance is the best effort.
335−instance (KnownSymbol sym, Typeable a, ToParamSchema a, HasSwagger sub) => HasSwagger (CaptureAll sym a :> sub) where
336− toSwagger _ = toSwagger (Proxy :: Proxy (Capture sym a :> sub))
337−
338−instance (KnownSymbol desc, HasSwagger api) => HasSwagger (Description desc :> api) where
339− toSwagger _ = toSwagger (Proxy :: Proxy api)
340− & allOperations.description %~ (Just (Text.pack (symbolVal (Proxy :: Proxy desc))) <>)
341−
342−instance (KnownSymbol desc, HasSwagger api) => HasSwagger (Summary desc :> api) where
343− toSwagger _ = toSwagger (Proxy :: Proxy api)
344− & allOperations.summary %~ (Just (Text.pack (symbolVal (Proxy :: Proxy desc))) <>)
345−
346−instance (KnownSymbol sym, ToParamSchema a, HasSwagger sub, SBoolI (FoldRequired mods), KnownSymbol (FoldDescription mods)) => HasSwagger (QueryParam' mods sym a :> sub) where
347− toSwagger _ = toSwagger (Proxy :: Proxy sub)
348− & addParam param
349− & addDefaultResponse400 tname
350− where
351− tname = Text.pack (symbolVal (Proxy :: Proxy sym))
352− transDesc "" = Nothing
353− transDesc desc = Just (Text.pack desc)
354− param = mempty
355− & name .~ tname
356− & description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
357− & required ?~ reflectBool (Proxy :: Proxy (FoldRequired mods))
358− & schema .~ ParamOther sch
359− sch = mempty
360− & in_ .~ ParamQuery
361− & paramSchema .~ toParamSchema (Proxy :: Proxy a)
362−
363−instance (KnownSymbol sym, ToParamSchema a, HasSwagger sub) => HasSwagger (QueryParams sym a :> sub) where
364− toSwagger _ = toSwagger (Proxy :: Proxy sub)
365− & addParam param
366− & addDefaultResponse400 tname
367− where
368− tname = Text.pack (symbolVal (Proxy :: Proxy sym))
369− param = mempty
370− & name .~ tname
371− & schema .~ ParamOther sch
372− sch = mempty
373− & in_ .~ ParamQuery
374− & paramSchema .~ pschema
375− pschema = mempty
376−#if MIN_VERSION_swagger2(2,4,0)
377− & type_ ?~ SwaggerArray
378−#else
379− & type_ .~ SwaggerArray
380−#endif
381− & items ?~ SwaggerItemsPrimitive (Just CollectionMulti) (toParamSchema (Proxy :: Proxy a))
382−
383−instance (KnownSymbol sym, HasSwagger sub) => HasSwagger (QueryFlag sym :> sub) where
384− toSwagger _ = toSwagger (Proxy :: Proxy sub)
385− & addParam param
386− & addDefaultResponse400 tname
387− where
388− tname = Text.pack (symbolVal (Proxy :: Proxy sym))
389− param = mempty
390− & name .~ tname
391− & schema .~ ParamOther (mempty
392− & in_ .~ ParamQuery
393− & allowEmptyValue ?~ True
394− & paramSchema .~ (toParamSchema (Proxy :: Proxy Bool)
395− & default_ ?~ toJSON False))
396−
397−instance (KnownSymbol sym, ToParamSchema a, HasSwagger sub, SBoolI (FoldRequired mods), KnownSymbol (FoldDescription mods)) => HasSwagger (Header' mods sym a :> sub) where
398− toSwagger _ = toSwagger (Proxy :: Proxy sub)
399− & addParam param
400− & addDefaultResponse400 tname
401− where
402− tname = Text.pack (symbolVal (Proxy :: Proxy sym))
403− transDesc "" = Nothing
404− transDesc desc = Just (Text.pack desc)
405− param = mempty
406− & name .~ tname
407− & description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
408− & required ?~ reflectBool (Proxy :: Proxy (FoldRequired mods))
409− & schema .~ ParamOther (mempty
410− & in_ .~ ParamHeader
411− & paramSchema .~ toParamSchema (Proxy :: Proxy a))
412−
413−instance (ToSchema a, AllAccept cs, HasSwagger sub, KnownSymbol (FoldDescription mods)) => HasSwagger (ReqBody' mods cs a :> sub) where
414− toSwagger _ = toSwagger (Proxy :: Proxy sub)
415− & addParam param
416− & addConsumes (allContentType (Proxy :: Proxy cs))
417− & addDefaultResponse400 tname
418− & definitions %~ (<> defs)
419− where
420− tname = "body"
421− transDesc "" = Nothing
422− transDesc desc = Just (Text.pack desc)
423− (defs, ref) = runDeclare (declareSchemaRef (Proxy :: Proxy a)) mempty
424− param = mempty
425− & name .~ tname
426− & description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
427− & required ?~ True
428− & schema .~ ParamBody ref
429−
430−-- | This instance is an approximation.
431−--
432−-- @since 1.1.7
433−instance (ToSchema a, Accept ct, HasSwagger sub, KnownSymbol (FoldDescription mods)) => HasSwagger (StreamBody' mods fr ct a :> sub) where
434− toSwagger _ = toSwagger (Proxy :: Proxy sub)
435− & addParam param
436− & addConsumes (toList (contentTypes (Proxy :: Proxy ct)))
437− & addDefaultResponse400 tname
438− & definitions %~ (<> defs)
439− where
440− tname = "body"
441− transDesc "" = Nothing
442− transDesc desc = Just (Text.pack desc)
443− (defs, ref) = runDeclare (declareSchemaRef (Proxy :: Proxy a)) mempty
444− param = mempty
445− & name .~ tname
446− & description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
447− & required ?~ True
448− & schema .~ ParamBody ref
449−
450−instance (HasSwagger (ToServantApi routes), KnownSymbol datatypeName, Rep (routes AsApi) ~ D1 ('MetaData datatypeName moduleName packageName isNewtype) f) => HasSwagger (NamedRoutes routes) where
451− toSwagger _ = addTag (Text.pack $ symbolVal (Proxy :: Proxy datatypeName)) (toSwagger (Proxy :: Proxy (ToServantApi routes)))
452−
453−-- =======================================================================
454−-- Below are the definitions that should be in Servant.API.ContentTypes
455−-- =======================================================================
456−
457−class AllAccept cs where
458− allContentType :: Proxy cs -> [MediaType]
459−
460−instance AllAccept '[] where
461− allContentType _ = []
462−
463−instance (Accept c, AllAccept cs) => AllAccept (c ': cs) where
464− allContentType _ = contentType (Proxy :: Proxy c) : allContentType (Proxy :: Proxy cs)
465−
466−class ToResponseHeader h where
467− toResponseHeader :: Proxy h -> (HeaderName, Swagger.Header)
468−
469−instance (KnownSymbol sym, ToParamSchema a) => ToResponseHeader (Header sym a) where
470− toResponseHeader _ = (hname, Swagger.Header Nothing hschema)
471− where
472− hname = Text.pack (symbolVal (Proxy :: Proxy sym))
473− hschema = toParamSchema (Proxy :: Proxy a)
474−
475−class AllToResponseHeader hs where
476− toAllResponseHeaders :: Proxy hs -> InsOrdHashMap HeaderName Swagger.Header
477−
478−instance AllToResponseHeader '[] where
479− toAllResponseHeaders _ = mempty
480−
481−instance (ToResponseHeader h, AllToResponseHeader hs) => AllToResponseHeader (h ': hs) where
482− toAllResponseHeaders _ = InsOrdHashMap.insert headerName headerBS hdrs
483− where
484− (headerName, headerBS) = toResponseHeader (Proxy :: Proxy h)
485− hdrs = toAllResponseHeaders (Proxy :: Proxy hs)
486−
487−instance AllToResponseHeader hs => AllToResponseHeader (HList hs) where
488− toAllResponseHeaders _ = toAllResponseHeaders (Proxy :: Proxy hs)
servant-swagger/src/Servant/Swagger/Internal/Orphans.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE StandaloneDeriving #-}
6−module Servant.Swagger.Internal.Orphans where
7−
8−import Data.Proxy
9− (Proxy (..))
10−import Data.Swagger
11−import Servant.Types.SourceT
12− (SourceT)
13−#if MIN_VERSION_GLASGOW_HASKELL(8,8,1,0)
14−import Servant.API (WithStatus(..))
15−#endif
16−
17−-- | Pretend that 'SourceT m a' is '[a]'.
18−--
19−-- @since 1.1.7
20−--
21−instance ToSchema a => ToSchema (SourceT m a) where
22− declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [a])
23−
24−#if MIN_VERSION_GLASGOW_HASKELL(8,8,1,0)
25−-- @since 1.1.11
26−deriving instance ToSchema a => ToSchema (WithStatus s a)
27−#endif
servant-swagger/src/Servant/Swagger/Internal/Test.hsdeleted−207
@@ -1,207 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TypeOperators #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−module Servant.Swagger.Internal.Test where
9−
10−import Data.Aeson (ToJSON (..))
11−import Data.Aeson.Encode.Pretty (encodePretty', defConfig,
12− confCompare)
13−import Data.Swagger (Pattern, ToSchema,
14− toSchema)
15−import Data.Swagger.Schema.Validation
16−import Data.Text (Text)
17−import qualified Data.Text.Lazy as TL
18−import qualified Data.Text.Lazy.Encoding as TL
19−import Data.Typeable
20−import Test.Hspec
21−import Test.Hspec.QuickCheck
22−import Test.QuickCheck (Arbitrary, Property,
23− counterexample, property)
24−
25−import Servant.API
26−import Servant.Swagger.Internal.TypeLevel
27−
28−-- $setup
29−-- >>> import Control.Applicative
30−-- >>> import GHC.Generics
31−-- >>> import Test.QuickCheck
32−-- >>> import System.Environment (setEnv)
33−-- >>> :set -XDeriveGeneric
34−-- >>> :set -XGeneralizedNewtypeDeriving
35−-- >>> :set -XDataKinds
36−-- >>> :set -XTypeOperators
37−-- >>> setEnv "HSPEC_COLOR" "no"
38−
39−-- | Verify that every type used with @'JSON'@ content type in a servant API
40−-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.
41−--
42−-- /NOTE:/ @'validateEveryToJSON'@ does not perform string pattern validation.
43−-- See @'validateEveryToJSONWithPatternChecker'@.
44−--
45−-- @'validateEveryToJSON'@ will produce one @'prop'@ specification for every type in the API.
46−-- Each type only gets one test, even if it occurs multiple times in the API.
47−--
48−-- >>> data User = User { name :: String, age :: Maybe Int } deriving (Show, Generic, Typeable)
49−-- >>> newtype UserId = UserId String deriving (Show, Generic, Typeable, ToJSON, Arbitrary)
50−-- >>> instance ToJSON User
51−-- >>> instance ToSchema User
52−-- >>> instance ToSchema UserId
53−-- >>> instance Arbitrary User where arbitrary = User <$> arbitrary <*> arbitrary
54−-- >>> type UserAPI = (Capture "user_id" UserId :> Get '[JSON] User) :<|> (ReqBody '[JSON] User :> Post '[JSON] UserId)
55−--
56−-- >>> hspec $ context "ToJSON matches ToSchema" $ validateEveryToJSON (Proxy :: Proxy UserAPI)
57−-- <BLANKLINE>
58−-- ToJSON matches ToSchema...
59−-- User...
60−-- ...
61−-- UserId...
62−-- ...
63−-- Finished in ... seconds
64−-- 2 examples, 0 failures
65−--
66−-- For the test to compile all body types should have the following instances:
67−--
68−-- * @'ToJSON'@ and @'ToSchema'@ are used to perform the validation;
69−-- * @'Typeable'@ is used to name the test for each type;
70−-- * @'Show'@ is used to display value for which @'ToJSON'@ does not satisfy @'ToSchema'@.
71−-- * @'Arbitrary'@ is used to arbitrarily generate values.
72−--
73−-- If any of the instances is missing, you'll get a descriptive type error:
74−--
75−-- >>> data Contact = Contact { fullname :: String, phone :: Integer } deriving (Show, Generic)
76−-- >>> instance ToJSON Contact
77−-- >>> instance ToSchema Contact
78−-- >>> type ContactAPI = Get '[JSON] Contact
79−-- >>> hspec $ validateEveryToJSON (Proxy :: Proxy ContactAPI)
80−-- ...
81−-- ...No instance for (Arbitrary Contact)
82−-- ... arising from a use of ‘validateEveryToJSON’
83−-- ...
84−validateEveryToJSON
85− :: forall proxy api .
86− TMap (Every [Typeable, Show, Arbitrary, ToJSON, ToSchema])
87− (BodyTypes JSON api)
88− => proxy api -- ^ Servant API.
89− -> Spec
90−validateEveryToJSON _ = props
91− (Proxy :: Proxy [ToJSON, ToSchema])
92− (maybeCounterExample . prettyValidateWith validateToJSON)
93− (Proxy :: Proxy (BodyTypes JSON api))
94−
95−-- | Verify that every type used with @'JSON'@ content type in a servant API
96−-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSONWithPatternChecker'@.
97−--
98−-- For validation without patterns see @'validateEveryToJSON'@.
99−validateEveryToJSONWithPatternChecker :: forall proxy api. TMap (Every [Typeable, Show, Arbitrary, ToJSON, ToSchema]) (BodyTypes JSON api) =>
100− (Pattern -> Text -> Bool) -- ^ @'Pattern'@ checker.
101− -> proxy api -- ^ Servant API.
102− -> Spec
103−validateEveryToJSONWithPatternChecker checker _ = props
104− (Proxy :: Proxy [ToJSON, ToSchema])
105− (maybeCounterExample . prettyValidateWith (validateToJSONWithPatternChecker checker))
106− (Proxy :: Proxy (BodyTypes JSON api))
107−
108−-- * QuickCheck-related stuff
109−
110−-- | Construct property tests for each type in a list.
111−-- The name for each property is the name of the corresponding type.
112−--
113−-- >>> :{
114−-- hspec $
115−-- context "read . show == id" $
116−-- props
117−-- (Proxy :: Proxy [Eq, Show, Read])
118−-- (\x -> read (show x) === x)
119−-- (Proxy :: Proxy [Bool, Int, String])
120−-- :}
121−-- <BLANKLINE>
122−-- read . show == id
123−-- Bool...
124−-- ...
125−-- Int...
126−-- ...
127−-- [Char]...
128−-- ...
129−-- Finished in ... seconds
130−-- 3 examples, 0 failures
131−props :: forall p p'' cs xs. TMap (Every (Typeable ': Show ': Arbitrary ': cs)) xs =>
132− p cs -- ^ A list of constraints.
133− -> (forall x. EveryTF cs x => x -> Property) -- ^ Property predicate.
134− -> p'' xs -- ^ A list of types.
135− -> Spec
136−props _ f px = sequence_ specs
137− where
138− specs :: [Spec]
139− specs = tmapEvery (Proxy :: Proxy (Typeable ': Show ': Arbitrary ': cs)) aprop px
140−
141− aprop :: forall p' a. (EveryTF cs a, Typeable a, Show a, Arbitrary a) => p' a -> Spec
142− aprop _ = prop (show (typeOf (undefined :: a))) (f :: a -> Property)
143−
144−-- | Pretty print validation errors
145−-- together with actual JSON and Swagger Schema
146−-- (using 'encodePretty').
147−--
148−-- >>> import Data.Aeson
149−-- >>> import Data.Foldable (traverse_)
150−-- >>> data Person = Person { name :: String, phone :: Integer } deriving (Generic)
151−-- >>> instance ToJSON Person where toJSON p = object [ "name" .= name p ]
152−-- >>> instance ToSchema Person
153−-- >>> let person = Person { name = "John", phone = 123456 }
154−-- >>> traverse_ putStrLn $ prettyValidateWith validateToJSON person
155−-- Validation against the schema fails:
156−-- * property "phone" is required, but not found in "{\"name\":\"John\"}"
157−-- <BLANKLINE>
158−-- JSON value:
159−-- {
160−-- "name": "John"
161−-- }
162−-- <BLANKLINE>
163−-- Swagger Schema:
164−-- {
165−-- "properties": {
166−-- "name": {
167−-- "type": "string"
168−-- },
169−-- "phone": {
170−-- "type": "integer"
171−-- }
172−-- },
173−-- "required": [
174−-- "name",
175−-- "phone"
176−-- ],
177−-- "type": "object"
178−-- }
179−-- <BLANKLINE>
180−--
181−-- FIXME: this belongs in "Data.Swagger.Schema.Validation" (in @swagger2@).
182−prettyValidateWith
183− :: forall a. (ToJSON a, ToSchema a)
184− => (a -> [ValidationError]) -> a -> Maybe String
185−prettyValidateWith f x =
186− case f x of
187− [] -> Nothing
188− errors -> Just $ unlines
189− [ "Validation against the schema fails:"
190− , unlines (map (" * " ++) errors)
191− , "JSON value:"
192− , ppJSONString json
193− , ""
194− , "Swagger Schema:"
195− , ppJSONString (toJSON schema)
196− ]
197− where
198− ppJSONString = TL.unpack . TL.decodeUtf8 . encodePretty' ppCfg
199− ppCfg = defConfig { confCompare = compare }
200−
201− json = toJSON x
202− schema = toSchema (Proxy :: Proxy a)
203−
204−-- | Provide a counterexample if there is any.
205−maybeCounterExample :: Maybe String -> Property
206−maybeCounterExample Nothing = property True
207−maybeCounterExample (Just s) = counterexample s (property False)
servant-swagger/src/Servant/Swagger/Internal/TypeLevel.hsdeleted−9
@@ -1,9 +0,0 @@
1−module Servant.Swagger.Internal.TypeLevel (
2− module Servant.Swagger.Internal.TypeLevel.API,
3− module Servant.Swagger.Internal.TypeLevel.Every,
4− module Servant.Swagger.Internal.TypeLevel.TMap,
5−) where
6−
7−import Servant.Swagger.Internal.TypeLevel.API
8−import Servant.Swagger.Internal.TypeLevel.Every
9−import Servant.Swagger.Internal.TypeLevel.TMap
servant-swagger/src/Servant/Swagger/Internal/TypeLevel/API.hsdeleted−86
@@ -1,86 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE KindSignatures #-}
4−{-# LANGUAGE PolyKinds #-}
5−{-# LANGUAGE TypeFamilies #-}
6−{-# LANGUAGE TypeOperators #-}
7−{-# LANGUAGE UndecidableInstances #-}
8−module Servant.Swagger.Internal.TypeLevel.API where
9−
10−import GHC.Exts (Constraint)
11−import Servant.API
12−
13−-- | Build a list of endpoints from an API.
14−type family EndpointsList api where
15− EndpointsList (a :<|> b) = AppendList (EndpointsList a) (EndpointsList b)
16− EndpointsList (e :> a) = MapSub e (EndpointsList a)
17− EndpointsList a = '[a]
18−
19−-- | Check whether @sub@ is a sub API of @api@.
20−type family IsSubAPI sub api :: Constraint where
21− IsSubAPI sub api = AllIsElem (EndpointsList sub) api
22−
23−-- | Check that every element of @xs@ is an endpoint of @api@.
24−type family AllIsElem xs api :: Constraint where
25− AllIsElem '[] api = ()
26− AllIsElem (x ': xs) api = (IsIn x api, AllIsElem xs api)
27−
28−-- | Apply @(e :>)@ to every API in @xs@.
29−type family MapSub e xs where
30− MapSub e '[] = '[]
31− MapSub e (x ': xs) = (e :> x) ': MapSub e xs
32−
33−-- | Append two type-level lists.
34−type family AppendList xs ys where
35− AppendList '[] ys = ys
36− AppendList (x ': xs) ys = x ': AppendList xs ys
37−
38−type family Or (a :: Constraint) (b :: Constraint) :: Constraint where
39− Or () b = ()
40− Or a () = ()
41−
42−type family IsIn sub api :: Constraint where
43− IsIn e (a :<|> b) = Or (IsIn e a) (IsIn e b)
44− IsIn (e :> a) (e :> b) = IsIn a b
45− IsIn e e = ()
46−
47−-- | Check whether a type is a member of a list of types.
48−-- This is a type-level analogue of @'elem'@.
49−type family Elem x xs where
50− Elem x '[] = 'False
51− Elem x (x ': xs) = 'True
52− Elem x (y ': xs) = Elem x xs
53−
54−-- | Remove duplicates from a type-level list.
55−type family Nub xs where
56− Nub '[] = '[]
57− Nub (x ': xs) = x ': Nub (Remove x xs)
58−
59−-- | Remove element from a type-level list.
60−type family Remove x xs where
61− Remove x '[] = '[]
62− Remove x (x ': ys) = Remove x ys
63− Remove x (y ': ys) = y ': Remove x ys
64−
65−-- | Extract a list of unique "body" types for a specific content-type from a servant API.
66−type BodyTypes c api = Nub (BodyTypes' c api)
67−
68−-- | @'AddBodyType' c cs a as@ adds type @a@ to the list @as@
69−-- only if @c@ is in @cs@.
70−type AddBodyType c cs a as = If (Elem c cs) (a ': as) as
71−
72−-- | Extract a list of "body" types for a specific content-type from a servant API.
73−-- To extract unique types see @'BodyTypes'@.
74−--
75−-- @'NoContent'@ is removed from the list and not tested. (This allows for leaving the body
76−-- completely empty on responses to requests that only accept 'application/json', while
77−-- setting the content-type in the response accordingly.)
78−type family BodyTypes' c api :: [*] where
79− BodyTypes' c (Verb verb b cs (Headers hdrs a)) = AddBodyType c cs a '[]
80− BodyTypes' c (Verb verb b cs NoContent) = '[]
81− BodyTypes' c (Verb verb b cs a) = AddBodyType c cs a '[]
82− BodyTypes' c (ReqBody' mods cs a :> api) = AddBodyType c cs a (BodyTypes' c api)
83− BodyTypes' c (e :> api) = BodyTypes' c api
84− BodyTypes' c (a :<|> b) = AppendList (BodyTypes' c a) (BodyTypes' c b)
85− BodyTypes' c api = '[]
86−
servant-swagger/src/Servant/Swagger/Internal/TypeLevel/Every.hsdeleted−63
@@ -1,63 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE InstanceSigs #-}
8−{-# LANGUAGE KindSignatures #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE RankNTypes #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TypeFamilies #-}
14−{-# LANGUAGE TypeOperators #-}
15−{-# LANGUAGE UndecidableInstances #-}
16−#if __GLASGOW_HASKELL__ >= 800
17−{-# LANGUAGE UndecidableSuperClasses #-}
18−#endif
19−module Servant.Swagger.Internal.TypeLevel.Every where
20−
21−import Data.Proxy
22−import GHC.Exts (Constraint)
23−
24−import Servant.Swagger.Internal.TypeLevel.TMap
25−
26−-- $setup
27−-- >>> :set -XDataKinds
28−-- >>> :set -XFlexibleContexts
29−-- >>> :set -XGADTs
30−-- >>> :set -XRankNTypes
31−-- >>> :set -XScopedTypeVariables
32−-- >>> import GHC.TypeLits
33−-- >>> import Data.List
34−
35−-- | Apply multiple constraint constructors to a type.
36−--
37−-- @
38−-- EveryTF '[Show, Read] a ~ (Show a, Read a)
39−-- @
40−--
41−-- Note that since this is a type family, you have to alway fully apply @'EveryTF'@.
42−--
43−-- For partial application of multiple constraint constructors see @'Every'@.
44−type family EveryTF cs x :: Constraint where
45− EveryTF '[] x = ()
46− EveryTF (c ': cs) x = (c x, EveryTF cs x)
47−
48−-- | Apply multiple constraint constructors to a type as a class.
49−--
50−-- This is different from @'EveryTF'@ in that it allows partial application.
51−class EveryTF cs x => Every (cs :: [* -> Constraint]) (x :: *) where
52−
53−instance Every '[] x where
54−instance (c x, Every cs x) => Every (c ': cs) x where
55−
56−-- | Like @'tmap'@, but uses @'Every'@ for multiple constraints.
57−--
58−-- >>> let zero :: forall p a. (Show a, Num a) => p a -> String; zero _ = show (0 :: a)
59−-- >>> tmapEvery (Proxy :: Proxy [Show, Num]) zero (Proxy :: Proxy [Int, Float]) :: [String]
60−-- ["0","0.0"]
61−tmapEvery :: forall a cs p p'' xs. (TMap (Every cs) xs) =>
62− p cs -> (forall x p'. Every cs x => p' x -> a) -> p'' xs -> [a]
63−tmapEvery _ = tmap (Proxy :: Proxy (Every cs))
servant-swagger/src/Servant/Swagger/Internal/TypeLevel/TMap.hsdeleted−37
@@ -1,37 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE KindSignatures #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE PolyKinds #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TypeOperators #-}
10−{-# LANGUAGE UndecidableInstances #-}
11−module Servant.Swagger.Internal.TypeLevel.TMap where
12−
13−import Data.Proxy
14−import GHC.Exts (Constraint)
15−
16−-- $setup
17−-- >>> :set -XDataKinds
18−-- >>> :set -XFlexibleContexts
19−-- >>> :set -XGADTs
20−-- >>> :set -XRankNTypes
21−-- >>> :set -XScopedTypeVariables
22−-- >>> import GHC.TypeLits
23−-- >>> import Data.List
24−
25−-- | Map a list of constrained types to a list of values.
26−--
27−-- >>> tmap (Proxy :: Proxy KnownSymbol) symbolVal (Proxy :: Proxy ["hello", "world"])
28−-- ["hello","world"]
29−class TMap (q :: k -> Constraint) (xs :: [k]) where
30− tmap :: p q -> (forall x p'. q x => p' x -> a) -> p'' xs -> [a]
31−
32−instance TMap q '[] where
33− tmap _ _ _ = []
34−
35−instance (q x, TMap q xs) => TMap q (x ': xs) where
36− tmap q f _ = f (Proxy :: Proxy x) : tmap q f (Proxy :: Proxy xs)
37−
servant-swagger/src/Servant/Swagger/Test.hsdeleted−13
@@ -1,13 +0,0 @@
1−-- |
2−-- Module: Servant.Swagger.Test
3−-- License: BSD3
4−-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5−-- Stability: experimental
6−--
7−-- Automatic tests for servant API against Swagger spec.
8−module Servant.Swagger.Test (
9− validateEveryToJSON,
10− validateEveryToJSONWithPatternChecker,
11−) where
12−
13−import Servant.Swagger.Internal.Test
servant-swagger/src/Servant/Swagger/TypeLevel.hsdeleted−15
@@ -1,15 +0,0 @@
1−-- |
2−-- Module: Servant.Swagger.TypeLevel
3−-- License: BSD3
4−-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
5−-- Stability: experimental
6−--
7−-- Useful type families for servant APIs.
8−module Servant.Swagger.TypeLevel (
9− IsSubAPI,
10− EndpointsList,
11− BodyTypes,
12−) where
13−
14−import Servant.Swagger.Internal.TypeLevel
15−
servant-swagger/test/Servant/SwaggerSpec.hsdeleted−489
@@ -1,489 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE QuasiQuotes #-}
7−{-# LANGUAGE TypeFamilies #-}
8−{-# LANGUAGE TypeOperators #-}
9−{-# LANGUAGE PackageImports #-}
10−module Servant.SwaggerSpec where
11−
12−import Control.Lens
13−import Data.Aeson (ToJSON(toJSON), Value, genericToJSON)
14−import Data.Aeson.QQ.Simple
15−import qualified Data.Aeson.Types as JSON
16−import Data.Char (toLower)
17−import Data.Int (Int64)
18−import Data.Proxy
19−import Data.Swagger
20−import Data.Text (Text)
21−import Data.Time
22−import GHC.Generics
23−import Servant.API
24−import Servant.Swagger
25−import Servant.Test.ComprehensiveAPI (comprehensiveAPI)
26−import Test.Hspec hiding (example)
27−
28−#if !MIN_VERSION_swagger2(2,4,0)
29−import Data.Aeson.Lens (key, _Array)
30−import qualified Data.Vector as V
31−#endif
32−
33−checkAPI :: HasSwagger api => Proxy api -> Value -> IO ()
34−checkAPI proxy = checkSwagger (toSwagger proxy)
35−
36−checkSwagger :: Swagger -> Value -> IO ()
37−checkSwagger swag js = toJSON swag `shouldBe` js
38−
39−spec :: Spec
40−spec = describe "HasSwagger" $ do
41− it "Todo API" $ checkAPI (Proxy :: Proxy TodoAPI) todoAPI
42− it "Hackage API (with tags)" $ checkSwagger hackageSwaggerWithTags hackageAPI
43− it "GetPost API (test subOperations)" $ checkSwagger getPostSwagger getPostAPI
44− it "UVerb API" $ checkSwagger uverbSwagger uverbAPI
45− it "Comprehensive API" $ do
46− let _x = toSwagger comprehensiveAPI
47− True `shouldBe` True -- type-level test
48−
49−main :: IO ()
50−main = hspec spec
51−
52−-- =======================================================================
53−-- Todo API
54−-- =======================================================================
55−
56−data Todo = Todo
57− { created :: UTCTime
58− , title :: String
59− , summary :: Maybe String
60− } deriving (Generic)
61−
62−instance ToJSON Todo
63−instance ToSchema Todo
64−
65−newtype TodoId = TodoId String deriving (Generic)
66−instance ToParamSchema TodoId
67−
68−type TodoAPI = "todo" :> Capture "id" TodoId :> Get '[JSON] Todo
69−
70−todoAPI :: Value
71−todoAPI = [aesonQQ|
72−{
73− "swagger":"2.0",
74− "info":
75− {
76− "title": "",
77− "version": ""
78− },
79− "definitions":
80− {
81− "Todo":
82− {
83− "type": "object",
84− "required": [ "created", "title" ],
85− "properties":
86− {
87− "created": { "$ref": "#/definitions/UTCTime" },
88− "title": { "type": "string" },
89− "summary": { "type": "string" }
90− }
91− },
92− "UTCTime":
93− {
94− "type": "string",
95− "format": "yyyy-mm-ddThh:MM:ssZ",
96− "example": "2016-07-22T00:00:00Z"
97− }
98− },
99− "paths":
100− {
101− "/todo/{id}":
102− {
103− "get":
104− {
105− "responses":
106− {
107− "200":
108− {
109− "schema": { "$ref":"#/definitions/Todo" },
110− "description": ""
111− },
112− "400": { "description": "Invalid `id`" }
113− },
114− "produces": [ "application/json;charset=utf-8" ],
115− "parameters":
116− [
117− {
118− "required": true,
119− "in": "path",
120− "name": "id",
121− "type": "string"
122− }
123− ]
124− }
125− }
126− }
127−}
128−|]
129−
130−-- =======================================================================
131−-- Hackage API
132−-- =======================================================================
133−
134−type HackageAPI
135− = HackageUserAPI
136− :<|> HackagePackagesAPI
137−
138−type HackageUserAPI =
139− "users" :> Get '[JSON] [UserSummary]
140− :<|> "user" :> Capture "username" Username :> Get '[JSON] UserDetailed
141−
142−type HackagePackagesAPI
143− = "packages" :> Get '[JSON] [Package]
144−
145−type Username = Text
146−
147−data UserSummary = UserSummary
148− { summaryUsername :: Username
149− , summaryUserid :: Int64 -- Word64 would make sense too
150− } deriving (Eq, Show, Generic)
151−
152−lowerCutPrefix :: String -> String -> String
153−lowerCutPrefix s = map toLower . drop (length s)
154−
155−instance ToJSON UserSummary where
156− toJSON = genericToJSON JSON.defaultOptions { JSON.fieldLabelModifier = lowerCutPrefix "summary" }
157−
158−instance ToSchema UserSummary where
159− declareNamedSchema proxy = genericDeclareNamedSchema defaultSchemaOptions { fieldLabelModifier = lowerCutPrefix "summary" } proxy
160− & mapped.schema.example ?~ toJSON UserSummary
161− { summaryUsername = "JohnDoe"
162− , summaryUserid = 123 }
163−
164−type Group = Text
165−
166−data UserDetailed = UserDetailed
167− { username :: Username
168− , userid :: Int64
169− , groups :: [Group]
170− } deriving (Eq, Show, Generic)
171−instance ToSchema UserDetailed
172−
173−newtype Package = Package { packageName :: Text }
174− deriving (Eq, Show, Generic)
175−instance ToSchema Package
176−
177−hackageSwaggerWithTags :: Swagger
178−hackageSwaggerWithTags = toSwagger (Proxy :: Proxy HackageAPI)
179− & host ?~ Host "hackage.haskell.org" Nothing
180− & applyTagsFor usersOps ["users" & description ?~ "Operations about user"]
181− & applyTagsFor packagesOps ["packages" & description ?~ "Query packages"]
182− where
183− usersOps, packagesOps :: Traversal' Swagger Operation
184− usersOps = subOperations (Proxy :: Proxy HackageUserAPI) (Proxy :: Proxy HackageAPI)
185− packagesOps = subOperations (Proxy :: Proxy HackagePackagesAPI) (Proxy :: Proxy HackageAPI)
186−
187−hackageAPI :: Value
188−hackageAPI = modifyValue [aesonQQ|
189−{
190− "swagger":"2.0",
191− "host":"hackage.haskell.org",
192− "info":{
193− "version":"",
194− "title":""
195− },
196− "definitions":{
197− "UserDetailed":{
198− "required":[
199− "username",
200− "userid",
201− "groups"
202− ],
203− "type":"object",
204− "properties":{
205− "groups":{
206− "items":{
207− "type":"string"
208− },
209− "type":"array"
210− },
211− "username":{
212− "type":"string"
213− },
214− "userid":{
215− "maximum":9223372036854775807,
216− "minimum":-9223372036854775808,
217− "type":"integer",
218− "format":"int64"
219− }
220− }
221− },
222− "Package":{
223− "required":[
224− "packageName"
225− ],
226− "type":"object",
227− "properties":{
228− "packageName":{
229− "type":"string"
230− }
231− }
232− },
233− "UserSummary":{
234− "required":[
235− "username",
236− "userid"
237− ],
238− "type":"object",
239− "properties":{
240− "username":{
241− "type":"string"
242− },
243− "userid":{
244− "maximum":9223372036854775807,
245− "minimum":-9223372036854775808,
246− "type":"integer",
247− "format":"int64"
248− }
249− },
250− "example":{
251− "username": "JohnDoe",
252− "userid": 123
253− }
254− }
255− },
256− "paths":{
257− "/users":{
258− "get":{
259− "responses":{
260− "200":{
261− "schema":{
262− "items":{
263− "$ref":"#/definitions/UserSummary"
264− },
265− "type":"array"
266− },
267− "description":""
268− }
269− },
270− "produces":[
271− "application/json;charset=utf-8"
272− ],
273− "tags":[
274− "users"
275− ]
276− }
277− },
278− "/packages":{
279− "get":{
280− "responses":{
281− "200":{
282− "schema":{
283− "items":{
284− "$ref":"#/definitions/Package"
285− },
286− "type":"array"
287− },
288− "description":""
289− }
290− },
291− "produces":[
292− "application/json;charset=utf-8"
293− ],
294− "tags":[
295− "packages"
296− ]
297− }
298− },
299− "/user/{username}":{
300− "get":{
301− "responses":{
302− "400":{
303− "description":"Invalid `username`"
304− },
305− "200":{
306− "schema":{
307− "$ref":"#/definitions/UserDetailed"
308− },
309− "description":""
310− }
311− },
312− "produces":[
313− "application/json;charset=utf-8"
314− ],
315− "parameters":[
316− {
317− "required":true,
318− "in":"path",
319− "name":"username",
320− "type":"string"
321− }
322− ],
323− "tags":[
324− "users"
325− ]
326− }
327− }
328− },
329− "tags":[
330− {
331− "name":"users",
332− "description":"Operations about user"
333− },
334− {
335− "name":"packages",
336− "description":"Query packages"
337− }
338− ]
339−}
340−|]
341− where
342− modifyValue :: Value -> Value
343−#if MIN_VERSION_swagger2(2,4,0)
344− modifyValue = id
345−#else
346− -- swagger2-2.4 preserves order of tags
347− -- swagger2-2.3 used Set, so they are ordered
348− -- packages comes before users.
349− -- We simply reverse, not properly sort here for simplicity: 2 elements.
350− modifyValue = over (key "tags" . _Array) V.reverse
351−#endif
352−
353−
354−-- =======================================================================
355−-- Get/Post API (test for subOperations)
356−-- =======================================================================
357−
358−type GetPostAPI = Get '[JSON] String :<|> Post '[JSON] String
359−
360−getPostSwagger :: Swagger
361−getPostSwagger = toSwagger (Proxy :: Proxy GetPostAPI)
362− & applyTagsFor getOps ["get" & description ?~ "GET operations"]
363− where
364− getOps :: Traversal' Swagger Operation
365− getOps = subOperations (Proxy :: Proxy (Get '[JSON] String)) (Proxy :: Proxy GetPostAPI)
366−
367−getPostAPI :: Value
368−getPostAPI = [aesonQQ|
369−{
370− "swagger":"2.0",
371− "info":{
372− "version":"",
373− "title":""
374− },
375− "paths":{
376− "/":{
377− "post":{
378− "responses":{
379− "200":{
380− "schema":{
381− "type":"string"
382− },
383− "description":""
384− }
385− },
386− "produces":[ "application/json;charset=utf-8" ]
387− },
388− "get":{
389− "responses":{
390− "200":{
391− "schema":{
392− "type":"string"
393− },
394− "description":""
395− }
396− },
397− "produces":[ "application/json;charset=utf-8" ],
398− "tags":[ "get" ]
399− }
400− }
401− },
402− "tags":[
403− {
404− "name":"get",
405− "description":"GET operations"
406− }
407− ]
408−}
409−|]
410−
411−-- =======================================================================
412−-- UVerb API
413−-- =======================================================================
414−
415−data Lunch = Lunch {name :: String}
416− deriving (Eq, Show, Generic)
417−
418−instance ToSchema Lunch
419−
420−instance HasStatus Lunch where
421− type StatusOf Lunch = 200
422−
423−data NoLunch = NoLunch
424− deriving (Eq, Show, Generic)
425−
426−instance ToSchema NoLunch
427−
428−instance HasStatus NoLunch where
429− type StatusOf NoLunch = 404
430−
431−type UVerbAPI2 =
432− "lunch" :> UVerb 'GET '[JSON] '[Lunch, NoLunch]
433−
434−uverbSwagger :: Swagger
435−uverbSwagger = toSwagger (Proxy :: Proxy UVerbAPI2)
436−
437−uverbAPI :: Value
438−uverbAPI =
439− [aesonQQ|
440− {
441− "swagger": "2.0",
442− "info": {
443− "version": "",
444− "title": ""
445− },
446− "definitions": {
447− "Lunch": {
448− "required": [
449− "name"
450− ],
451− "type": "object",
452− "properties": {
453− "name": {
454− "type": "string"
455− }
456− }
457− },
458− "NoLunch": {
459− "type": "string",
460− "enum": [
461− "NoLunch"
462− ]
463− }
464− },
465− "paths": {
466− "/lunch": {
467− "get": {
468− "responses": {
469− "404": {
470− "schema": {
471− "$ref": "#/definitions/NoLunch"
472− },
473− "description": ""
474− },
475− "200": {
476− "schema": {
477− "$ref": "#/definitions/Lunch"
478− },
479− "description": ""
480− }
481− },
482− "produces": [
483− "application/json;charset=utf-8"
484− ]
485− }
486− }
487− }
488−}
489−|]
servant-swagger/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
servant-swagger/test/doctests.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Main where
2−
3−import Build_doctests (flags, pkgs, module_sources)
4−import Data.Foldable (traverse_)
5−import Test.DocTest
6−
7−main :: IO ()
8−main = do
9− traverse_ putStrLn args
10− doctest args
11− where
12− args = flags ++ pkgs ++ module_sources
servant/CHANGELOG.md+15−309
@@ -1,299 +1,5 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
22
3−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
4−
5−0.19
6−----
7−
8−### Significant changes
9−
10−- Drop support for GHC < 8.6.
11−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
12−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
13− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
14− related to hash collisions.
15−- Add `NamedRoutes` combinator, making support for records first-class in Servant
16− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
17−
18− Users can now directly mark part as an API as defined by a record, instead of
19− using `(:<|>)` to combine routes. Concretely, the anonymous:
20−
21− ```haskell
22− type API =
23− "version" :> Get '[JSON] String :<|>
24− "products" :> Get '[JSON] [Product]
25− ```
26−
27− can be replaced with the explicitly-named:
28−
29− ```haskell
30− type API = NamedRoutes NamedAPI
31− data NamedAPI mode = NamedAPI
32− { version :: mode :- "version" :> Get '[JSON] String
33− , products :: mode :- "products" :> Get '[JSON] [Product]
34− }
35− ```
36−
37− `NamedRoutes` builds upon `servant-generic`, but improves usability by freeing
38− users from the need to perform `toServant` / `fromServant` conversions
39− manually. Serving `NamedRoutes NamedAPI` is now done directly by providing a
40− record of handlers, and servant generates clients directly as records as well.
41− In particular, it makes it much more practical to work with nested hierarchies
42− of named routes.
43−
44− Two convenience functions, `(//)` and `(/:)`, have been added to make the
45− usage of named route hierarchies more pleasant:
46−
47− ```haskell
48− rootClient :: RootApi (AsClientT ClientM)
49− rootClient = client (Proxy @API)
50−
51− helloClient :: String -> ClientM String
52− helloClient name = rootClient // hello /: name
53−
54− endpointClient :: ClientM Person
55− endpointClient = rootClient // subApi /: "foobar123" // endpoint
56−
57− type Api = NamedRoutes RootApi
58−
59− data RootApi mode = RootApi
60− { subApi :: mode :- Capture "token" String :> NamedRoutes SubApi
61− , hello :: mode :- Capture "name" String :> Get '[JSON] String
62− , …
63− } deriving Generic
64−
65− data SubApi mode = SubApi
66− { endpoint :: mode :- Get '[JSON] Person
67− , …
68− } deriving Generic
69− ```
70−
71−- Add custom type errors for partially applied combinators
72− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
73− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
74−
75− For example, forgetting to document the expected type for a query parameter,
76− as in:
77−
78− ``` haskell
79− type API = QueryParam "param" :> Get '[JSON] NoContent
80− ```
81−
82− will raise to the following error when trying to serve the API:
83−
84− ```
85− • There is no instance for HasServer (QueryParam'
86− '[Optional, Strict] "param" :> ...)
87− QueryParam' '[Optional, Strict] "1" expects 1 more arguments
88− ```
89−
90− As a consequence of this change, unsaturated types are now forbidden before `(:>)`.
91−
92−- Add a `HeadNoContent` verb ([#1502](https://github.com/haskell-servant/servant/pull/1502)).
93−
94−- *servant-client* / *servant-client-core* / *servant-http-streams*:
95− Fix erroneous behavior, where only 2XX status codes would be considered
96− successful, irrelevant of the status parameter specified by the verb
97− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
98−
99−- *servant-client* / *servant-client-core*: Fix `Show` instance for
100− `Servant.Client.Core.Request`.
101−
102−
103−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
104− in Query parameters.
105− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
106−
107−- *servant-docs*: Generate sample cURL requests
108− ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
109−
110− Breaking change: requires sample header values to be supplied with `headers`.
111−
112−### Other changes
113−
114−- Various bit rotten cookbooks have been updated and re-introduced on
115− [docs.servant.dev](https://docs.servant.dev).
116−
117−- Various version bumps.
118−
119−0.18.3
120−------
121−
122−### Significant changes
123−
124−- Add response header support to UVerb (#1420).
125−- Use Capture Description if available (#1423).
126−
127−### Other changes
128−
129−- Support GHC-9.0.1.
130−- Bump `bytestring`, `attoparsec`, `hspec` and `singleton-bool` dependencies.
131−
132−0.18.2
133−------
134−
135−### Significant changes
136−
137−- Introduce `Fragment` combinator.
138−- Fix `MimeRender` and `MimeUnrender` instances for `WithStatus`.
139−
140−0.18.1
141−------
142−
143−### Significant changes
144−
145−- Union verbs
146−
147−### Other changes
148−
149−- Bump "tested-with" ghc versions
150−- Allow newer dependencies
151−
152−0.18
153−----
154−
155−### Significant changes
156−
157−- Support for ghc8.8 (#1318, #1326, #1327)
158−
159−- Configurable error messages for automatic errors thrown by servant,
160− like "no route" or "could not parse json body" (#1312, #1326, #1327)
161−
162−### Other changes
163−
164−- Witness that a type-level natural number corresponds to a HTTP
165− status code (#1310)
166−
167−- Improve haddocs (#1279)
168−
169−- Dependency management (#1269, #1293, #1286, #1287)
170−
171−
172−0.17
173−----
174−
175−### Significant changes
176−
177−- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228)
178−
179− The `NoContent` API endpoints should now use `NoContentVerb` combinator.
180− The API type changes are usually of the kind
181−
182− ```diff
183− - :<|> PostNoContent '[JSON] NoContent
184− + :<|> PostNoContent
185− ```
186−
187− i.e. one doesn't need to specify the content-type anymore. There is no content.
188−
189−- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156)
190−
191− You can specify a lenient capture as
192−
193− ```haskell
194− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
195− ```
196−
197− which will make the capture always succeed. Handlers will be of the
198− type `Either String CapturedType`, where `Left err` represents
199− the possible parse failure.
200−
201−- *servant-client* Added a function to create Client.Request in ClientEnv [#1213](https://github.com/haskell-servant/servant/pull/1213) [#1255](https://github.com/haskell-servant/servant/pull/1255)
202−
203− The new member `makeClientRequest` of `ClientEnv` is used to create
204− `http-client` `Request` from `servant-client-core` `Request`.
205− This functionality can be used for example to set
206− dynamic timeouts for each request.
207−
208−- *servant-server* use queryString to parse QueryParam, QueryParams and QueryFlag [#1249](https://github.com/haskell-servant/servant/pull/1249) [#1262](https://github.com/haskell-servant/servant/pull/1262)
209−
210− Some APIs need query parameters rewriting, e.g. in order to support
211− for multiple casing (camel, snake, etc) or something to that effect.
212−
213− This could be easily achieved by using WAI Middleware and modifying
214− request's `Query`. But QueryParam, QueryParams and QueryFlag use
215− `rawQueryString`. By using `queryString` rather then `rawQueryString`
216− we can enable such rewritings.
217−
218−- *servant* *servant-server* Make packages `build-type: Simple` [#1263](https://github.com/haskell-servant/servant/pull/1263)
219−
220− We used `build-type: Custom`, but it's problematic e.g.
221− for cross-compiling. The benefit is small, as the doctests
222− can be run other ways too (though not so conveniently).
223−
224−- *servant* Remove deprecated modules [1268#](https://github.com/haskell-servant/servant/pull/1268)
225−
226− - `Servant.Utils.Links` is `Servant.Links`
227− - `Servant.API.Internal.Test.ComprehensiveAPI` is `Servant.Test.ComprehensiveAPI`
228−
229−### Other changes
230−
231−- *servant-client* *servant-client-core* *servant-http-streams* Fix Verb with headers checking content type differently [#1200](https://github.com/haskell-servant/servant/issues/1200) [#1204](https://github.com/haskell-servant/servant/pull/1204)
232−
233− For `Verb`s with response `Headers`, the implementation didn't check
234− for the content-type of the response. Now it does.
235−
236−- *servant-docs* Merge documentation from duplicate routes [#1240](https://github.com/haskell-servant/servant/issues/1240) [#1241](https://github.com/haskell-servant/servant/pull/1241)
237−
238− Servant supports defining the same route multiple times with different
239− content-types and result-types, but servant-docs was only documenting
240− the first of copy of such duplicated routes. It now combines the
241− documentation from all the copies.
242−
243− Unfortunately, it is not yet possible for the documentation to specify
244− multiple status codes.
245−
246−- Add sponsorship button [#1190](https://github.com/haskell-servant/servant/pull/1190)
247−
248− [Well-Typed](https://www.well-typed.com/) is a consultancy which could help you with `servant` issues
249− (See consultancies section on https://www.servant.dev/).
250−
251−- Try changelog-d for changelog management [#1230](https://github.com/haskell-servant/servant/pull/1230)
252−
253− Check the [CONTRIBUTING.md](https://github.com/haskell-servant/servant/blob/master/CONTRIBUTING.md) for details
254−
255−- CI and testing tweaks. [#1154](https://github.com/haskell-servant/servant/pull/1154) [#1157](https://github.com/haskell-servant/servant/pull/1157) [#1182](https://github.com/haskell-servant/servant/pull/1182) [#1214](https://github.com/haskell-servant/servant/pull/1214) [#1229](https://github.com/haskell-servant/servant/pull/1229) [#1233](https://github.com/haskell-servant/servant/pull/1233) [#1242](https://github.com/haskell-servant/servant/pull/1242) [#1247](https://github.com/haskell-servant/servant/pull/1247) [#1250](https://github.com/haskell-servant/servant/pull/1250) [#1258](https://github.com/haskell-servant/servant/pull/1258)
256−
257− We are experiencing some bitrotting of cookbook recipe dependencies,
258− therefore some of them aren't build as part of our CI anymore.
259−
260−- New cookbook recipes [#1088](https://github.com/haskell-servant/servant/pull/1088) [#1171](https://github.com/haskell-servant/servant/pull/1171) [#1198](https://github.com/haskell-servant/servant/pull/1198)
261−
262− - [OIDC Recipe](#TODO)
263− - [MySQL Recipe](#TODO)
264−
265−- *servant-jsaddle* Progress on servant-jsaddle [#1216](https://github.com/haskell-servant/servant/pull/1216)
266−- *servant-docs* Prevent race-conditions in testing [#1194](https://github.com/haskell-servant/servant/pull/1194)
267−- *servant-client* *servant-http-streams* `HasClient` instance for `Stream` with `Headers` [#1170](https://github.com/haskell-servant/servant/issues/1170) [#1197](https://github.com/haskell-servant/servant/pull/1197)
268−- *servant* Remove unused extensions from cabal file [#1201](https://github.com/haskell-servant/servant/pull/1201)
269−- *servant-client* Redact the authorization header in Show and exceptions [#1238](https://github.com/haskell-servant/servant/pull/1238)
270−- Dependency upgrades [#1173](https://github.com/haskell-servant/servant/pull/1173) [#1181](https://github.com/haskell-servant/servant/pull/1181) [#1183](https://github.com/haskell-servant/servant/pull/1183) [#1188](https://github.com/haskell-servant/servant/pull/1188) [#1224](https://github.com/haskell-servant/servant/pull/1224) [#1245](https://github.com/haskell-servant/servant/pull/1245) [#1257](https://github.com/haskell-servant/servant/pull/1257)
271−- Documentation updates [#1162](https://github.com/haskell-servant/servant/pull/1162) [#1174](https://github.com/haskell-servant/servant/pull/1174) [#1175](https://github.com/haskell-servant/servant/pull/1175) [#1234](https://github.com/haskell-servant/servant/pull/1234) [#1244](https://github.com/haskell-servant/servant/pull/1244) [#1247](https://github.com/haskell-servant/servant/pull/1247)
272−
273−
274−0.16.2
275−------
276−
277−* `singleton-bool-0.1.5` (`SBool` is re-exported)
278− - Add `discreteBool :: Dec (a :~: b)` (GHC-7.8+)
279− - Add `Show`, `Eq`, `Ord` `SBool b` instances.
280−* dependencies update
281−
282−0.16.1
283−------
284−
285−* Add `Semigroup` and `Monoid` `SourceT` instances
286− [#1158](https://github.com/haskell-servant/servant/pull/1158)
287− [#1159](https://github.com/haskell-servant/servant/pull/1159)
288−* Use `http-api-data-0.4.1`
289− [#1181](https://github.com/haskell-servant/servant/pull/1181)
290−* Allow newer dependencies
291−
292−0.16.0.1
293−--------
294−
295−- Make tests work with `http-media-0.8`
296−
29730.16
2984----
2995
@@ -497,18 +203,18 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
497203 [#985](https://github.com/haskell-servant/servant/pull/985)
498204
499205- *Documentation* Tutorial and new recipes
500− - [Using free client](https://docs.servant.dev/en/latest/cookbook/using-free-client/UsingFreeClient.html)
206+ - [Using free client](https://haskell-servant.readthedocs.io/en/latest/cookbook/using-free-client/UsingFreeClient.html)
501207 [#1005](https://github.com/haskell-servant/servant/pull/1005)
502− - [Generating mock curl calls](https://docs.servant.dev/en/latest/cookbook/curl-mock/CurlMock.html)
208+ - [Generating mock curl calls](https://haskell-servant.readthedocs.io/en/latest/cookbook/curl-mock/CurlMock.html)
503209 [#1033](https://github.com/haskell-servant/servant/pull/1033)
504− - [Error logging with Sentry](https://docs.servant.dev/en/latest/cookbook/sentry/Sentry.html)
210+ - [Error logging with Sentry](https://haskell-servant.readthedocs.io/en/latest/cookbook/sentry/Sentry.html)
505211 [#987](https://github.com/haskell-servant/servant/pull/987)
506− - [Hoist Server With Context for Custom Monads](https://docs.servant.dev/en/latest/cookbook/hoist-server-with-context/HoistServerWithContext.html)
212+ - [Hoist Server With Context for Custom Monads](https://haskell-servant.readthedocs.io/en/latest/cookbook/hoist-server-with-context/HoistServerWithContext.html)
507213 [#1044](https://github.com/haskell-servant/servant/pull/1044)
508− - [How To Test Servant Applications](https://docs.servant.dev/en/latest/cookbook/testing/Testing.html)
214+ - [How To Test Servant Applications](https://haskell-servant.readthedocs.io/en/latest/cookbook/testing/Testing.html)
509215 [#1050](https://github.com/haskell-servant/servant/pull/1050)
510216 - `genericServeT`: using custom monad with `Servant.API.Generic`
511− in [Using generics](https://docs.servant.dev/en/latest/cookbook/generic/Generic.html)
217+ in [Using generics](https://haskell-servant.readthedocs.io/en/latest/cookbook/generic/Generic.html)
512218 [#1058](https://github.com/haskell-servant/servant/pull/1058)
513219 - Tutorial
514220 [#974](https://github.com/haskell-servant/servant/pull/974)
@@ -574,9 +280,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
574280
575281- *servant-client-core* Add `hoistClient` to `HasClient`.
576282 Just like `hoistServer` allows us to change the monad in which request handlers
577− of a web application live, we also have `hoistClient` for changing the monad
283+ of a web application live in, we also have `hoistClient` for changing the monad
578284 in which *client functions* live.
579− Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
285+ Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in).
580286 ([#936](https://github.com/haskell-servant/servant/pull/936))
581287
582288 iF you have own combinators, you'll need to define a new method of
@@ -623,10 +329,10 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
623329- Added tests or enabled tests
624330 ([#975](https://github.com/haskell-servant/servant/pull/975))
625331
626−- Add [pagination cookbook recipe](https://docs.servant.dev/en/release-0.14/cookbook/pagination/Pagination.html)
332+- Add [pagination cookbook recipe](https://haskell-servant.readthedocs.io/en/release-0.14/cookbook/pagination/Pagination.html)
627333 ([#946](https://github.com/haskell-servant/servant/pull/946))
628334
629−- Add [`servant-flatten` "spice" to the structuring api recipe](https://docs.servant.dev/en/release-0.14/cookbook/structuring-apis/StructuringApis.html)
335+- Add [`servant-flatten` "spice" to the structuring api recipe](https://haskell-servant.readthedocs.io/en/release-0.14/cookbook/structuring-apis/StructuringApis.html)
630336 ([#929](https://github.com/haskell-servant/servant/pull/929))
631337
632338- Dependency updates
@@ -676,9 +382,9 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
676382 ```
677383
678384 See tutorial for more details
679− - [A web API as a type - StreamGet and StreamPost](http://docs.servant.dev/en/release-0.13/tutorial/ApiType.html#streamget-and-streampost)
680− - [Serving an API - streaming endpoints](http://docs.servant.dev/en/release-0.13/tutorial/Server.html#streaming-endpoints)
681− - [Querying an API - Querying Streaming APIs](http://docs.servant.dev/en/release-0.13/tutorial/Client.html#querying-streaming-apis)
385+ - [A web API as a type - StreamGet and StreamPost](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/ApiType.html#streamget-and-streampost)
386+ - [Serving an API - streaming endpoints](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/Server.html#streaming-endpoints)
387+ - [Querying an API - Querying Streaming APIs](http://haskell-servant.readthedocs.io/en/release-0.13/tutorial/Client.html#querying-streaming-apis)
682388
683389- *servant* Add `Servant.API.Modifiers`
684390 ([#873](https://github.com/haskell-servant/servant/pull/873)
@@ -709,7 +415,7 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
709415 ([#893](https://github.com/haskell-servant/servant/pull/893))
710416
711417- *Cookbook* example projects at
712− http://docs.servant.dev/en/master/cookbook/index.html
418+ http://haskell-servant.readthedocs.io/en/master/cookbook/index.html
713419 ([#867](https://github.com/haskell-servant/servant/pull/867)
714420 [#892](https://github.com/haskell-servant/servant/pull/882))
715421
@@ -781,7 +487,7 @@ Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/
781487
782488 `enter` isn't exported from `Servant` module anymore. You can change
783489 `enter` to `hoistServer` in a straight forward way.
784− Unwrap natural transformation and add an api type `Proxy`:
490+ Unwrap natural transformation and add a api type `Proxy`:
785491
786492 ```diff
787493 -server = enter (NT nt) impl
servant/Setup.hs+32−1
@@ -1,2 +1,33 @@
1−import Distribution.Simple
1+{-# LANGUAGE CPP #-}
2+{-# OPTIONS_GHC -Wall #-}
3+module Main (main) where
4+
5+#ifndef MIN_VERSION_cabal_doctest
6+#define MIN_VERSION_cabal_doctest(x,y,z) 0
7+#endif
8+
9+#if MIN_VERSION_cabal_doctest(1,0,0)
10+
11+import Distribution.Extra.Doctest ( defaultMainWithDoctests )
12+main :: IO ()
13+main = defaultMainWithDoctests "doctests"
14+
15+#else
16+
17+#ifdef MIN_VERSION_Cabal
18+-- If the macro is defined, we have new cabal-install,
19+-- but for some reason we don't have cabal-doctest in package-db
20+--
21+-- Probably we are running cabal sdist, when otherwise using new-build
22+-- workflow
23+#warning You are configuring this package without cabal-doctest installed. \
24+ The doctests test-suite will not work as a result. \
25+ To fix this, install cabal-doctest before configuring.
26+#endif
27+
28+import Distribution.Simple
29+
30+main :: IO ()
231main = defaultMain
32+
33+#endif
servant/servant.cabal+63−40
@@ -1,27 +1,30 @@
1−cabal-version: 2.2
1+cabal-version: >=1.10
22name: servant
3−version: 0.19
3+version: 0.16
44
55synopsis: A family of combinators for defining webservices APIs
66category: Servant, Web
77description:
88 A family of combinators for defining webservices APIs and serving them
99 .
10− You can learn about the basics in the <http://docs.servant.dev/en/stable/tutorial/index.html tutorial>.
10+ You can learn about the basics in the <http://haskell-servant.readthedocs.org/en/stable/tutorial/index.html tutorial>.
1111 .
1212 <https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md CHANGELOG>
1313
14−homepage: http://docs.servant.dev/
14+homepage: http://haskell-servant.readthedocs.org/
1515bug-reports: http://github.com/haskell-servant/servant/issues
16−license: BSD-3-Clause
16+license: BSD3
1717license-file: LICENSE
1818author: Servant Contributors
1919maintainer: haskell-servant-maintainers@googlegroups.com
2020copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors
21−build-type: Simple
21+build-type: Custom
2222
23−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1
24− , GHCJS ==8.6.0.1
23+tested-with:
24+ GHC ==8.0.2
25+ || ==8.2.2
26+ || ==8.4.4
27+ || ==8.6.3
2528
2629extra-source-files:
2730 CHANGELOG.md
@@ -30,6 +33,12 @@ source-repository head
3033 type: git
3134 location: http://github.com/haskell-servant/servant.git
3235
36+custom-setup
37+ setup-depends:
38+ base >= 4 && <5,
39+ Cabal,
40+ cabal-doctest >= 1.0.6 && <1.1
41+
3342library
3443 exposed-modules:
3544 Servant.API
@@ -40,25 +49,19 @@ library
4049 Servant.API.Description
4150 Servant.API.Empty
4251 Servant.API.Experimental.Auth
43− Servant.API.Fragment
4452 Servant.API.Generic
4553 Servant.API.Header
4654 Servant.API.HttpVersion
4755 Servant.API.IsSecure
4856 Servant.API.Modifiers
49− Servant.API.NamedRoutes
5057 Servant.API.QueryParam
5158 Servant.API.Raw
5259 Servant.API.RemoteHost
5360 Servant.API.ReqBody
5461 Servant.API.ResponseHeaders
55− Servant.API.Status
5662 Servant.API.Stream
5763 Servant.API.Sub
58− Servant.API.TypeErrors
5964 Servant.API.TypeLevel
60− Servant.API.UVerb
61− Servant.API.UVerb.Union
6265 Servant.API.Vault
6366 Servant.API.Verbs
6467 Servant.API.WithNamedContext
@@ -75,68 +78,69 @@ library
7578 exposed-modules:
7679 Servant.Links
7780
81+ -- Deprecated modules, to be removed in late 2019
82+ exposed-modules:
83+ Servant.Utils.Links
84+ Servant.API.Internal.Test.ComprehensiveAPI
85+
7886 -- Bundled with GHC: Lower bound to not force re-installs
7987 -- text and mtl are bundled starting with GHC-8.4
8088 --
8189 -- note: mtl lower bound is so low because of GHC-7.8
8290 build-depends:
83− base >= 4.9 && < 4.17
84− , bytestring >= 0.10.8.1 && < 0.12
85− , constraints >= 0.2
91+ base >= 4.9 && < 4.13
92+ , bytestring >= 0.10.8.1 && < 0.11
8693 , mtl >= 2.2.2 && < 2.3
87− , sop-core >= 0.4.0.0 && < 0.6
8894 , transformers >= 0.5.2.0 && < 0.6
89− , text >= 1.2.3.0 && < 2.1
95+ , text >= 1.2.3.0 && < 1.3
9096
9197
9298 -- We depend (heavily) on the API of these packages:
9399 -- i.e. re-export, or allow using without direct dependency
94100 build-depends:
95− http-api-data >= 0.4.1 && < 0.4.4
96− , singleton-bool >= 0.1.4 && < 0.1.7
101+ http-api-data >= 0.4 && < 0.4.1
102+ , singleton-bool >= 0.1.4 && < 0.1.5
97103
98104 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
99105 -- Here can be exceptions if we really need features from the newer versions.
100106 build-depends:
101− base-compat >= 0.10.5 && < 0.13
102− , aeson >= 1.4.1.0 && < 3
103− , attoparsec >= 0.13.2.2 && < 0.15
107+ base-compat >= 0.10.5 && < 0.11
108+ , aeson >= 1.4.1.0 && < 1.5
109+ , attoparsec >= 0.13.2.2 && < 0.14
104110 , bifunctors >= 5.5.3 && < 5.6
105111 , case-insensitive >= 1.2.0.11 && < 1.3
106112 , deepseq >= 1.4.2.0 && < 1.5
107− , http-media >= 0.7.1.3 && < 0.9
113+ , http-media >= 0.7.1.3 && < 0.8
108114 , http-types >= 0.12.2 && < 0.13
109− , mmorph >= 1.1.2 && < 1.3
115+ , mmorph >= 1.1.2 && < 1.2
110116 , network-uri >= 2.6.1.0 && < 2.7
111− , QuickCheck >= 2.12.6.1 && < 2.15
117+ , QuickCheck >= 2.12.6.1 && <2.13
112118 , string-conversions >= 0.4.0.1 && < 0.5
113119 , tagged >= 0.8.6 && < 0.9
114120 , vault >= 0.3.1.2 && < 0.4
115121
116122 hs-source-dirs: src
117123 default-language: Haskell2010
118− other-extensions: AllowAmbiguousTypes
119− , CPP
124+ other-extensions: CPP
120125 , ConstraintKinds
121126 , DataKinds
122127 , DeriveDataTypeable
123− , DeriveGeneric
124− , ExplicitNamespaces
125− , FlexibleContexts
126128 , FlexibleInstances
127129 , FunctionalDependencies
128130 , GADTs
129131 , KindSignatures
130132 , MultiParamTypeClasses
133+ , OverlappingInstances
131134 , OverloadedStrings
132135 , PolyKinds
133− , RankNTypes
136+ , QuasiQuotes
137+ , RecordWildCards
134138 , ScopedTypeVariables
135− , TupleSections
139+ , TemplateHaskell
136140 , TypeFamilies
137141 , TypeOperators
142+ , TypeSynonymInstances
138143 , UndecidableInstances
139−
140144 ghc-options: -Wall -Wno-redundant-constraints
141145
142146test-suite spec
@@ -157,18 +161,37 @@ test-suite spec
157161 , base-compat
158162 , aeson
159163 , bytestring
160− , http-media
161164 , mtl
162165 , servant
163166 , string-conversions
164167 , text
165168 , transformers
166169
167− -- Additional dependencies
170+ -- Additonal dependencies
168171 build-depends:
169− hspec >= 2.6.0 && < 2.10
170− , QuickCheck >= 2.12.6.1 && < 2.15
172+ hspec >= 2.6.0 && < 2.8
173+ , QuickCheck >= 2.12.6.1 && < 2.13
171174 , quickcheck-instances >= 0.3.19 && < 0.4
172175
173176 build-tool-depends:
174− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
177+ hspec-discover:hspec-discover >= 2.6.0 && < 2.8
178+
179+test-suite doctests
180+ build-depends:
181+ base
182+ , servant
183+ , doctest >= 0.16.0 && <0.17
184+
185+ -- We test Links failure with doctest, so we need extra dependencies
186+ build-depends:
187+ hspec >= 2.6.0 && < 2.8
188+
189+ type: exitcode-stdio-1.0
190+ main-is: test/doctests.hs
191+ buildable: True
192+ default-language: Haskell2010
193+ ghc-options: -Wall -threaded
194+ if impl(ghc >= 8.2)
195+ x-doctest-options: -fdiagnostics-color=never
196+ x-doctest-source-dirs: test
197+ x-doctest-modules: Servant.LinksSpec
servant/src/Servant/API.hs+4−21
@@ -19,8 +19,6 @@ module Servant.API (
1919 -- | Retrieving the HTTP version of the request
2020 module Servant.API.QueryParam,
2121 -- | Retrieving parameters from the query string of the 'URI': @'QueryParam'@
22− module Servant.API.Fragment,
23− -- | Documenting the fragment of the 'URI': @'Fragment'@
2422 module Servant.API.ReqBody,
2523 -- | Accessing the request body as a JSON-encoded type: @'ReqBody'@
2624 module Servant.API.RemoteHost,
@@ -34,11 +32,6 @@ module Servant.API (
3432
3533 -- * Actual endpoints, distinguished by HTTP method
3634 module Servant.API.Verbs,
37− module Servant.API.UVerb,
38−
39− -- * Sub-APIs defined as records of routes
40− module Servant.API.NamedRoutes,
41− module Servant.API.Generic,
4235
4336 -- * Streaming endpoints, distinguished by HTTP method
4437 module Servant.API.Stream,
@@ -99,13 +92,8 @@ import Servant.API.Empty
9992 (EmptyAPI (..))
10093import Servant.API.Experimental.Auth
10194 (AuthProtect)
102−import Servant.API.Fragment
103− (Fragment)
10495import Servant.API.Header
10596 (Header, Header')
106−import Servant.API.Generic
107− (GenericMode ((:-)), AsApi, ToServant, ToServantApi, GServantProduct,
108− GenericServant, fromServant, toServant, genericApi)
10997import Servant.API.HttpVersion
11098 (HttpVersion (..))
11199import Servant.API.IsSecure
@@ -132,21 +120,16 @@ import Servant.API.Stream
132120 ToSourceIO (..))
133121import Servant.API.Sub
134122 ((:>))
135−import Servant.API.UVerb
136− (HasStatus, IsMember, StatusOf, Statuses, UVerb, Union,
137− Unique, WithStatus (..), inject, statusOf)
138123import Servant.API.Vault
139124 (Vault)
140−import Servant.API.NamedRoutes
141− (NamedRoutes)
142125import Servant.API.Verbs
143126 (Delete, DeleteAccepted, DeleteNoContent,
144127 DeleteNonAuthoritative, Get, GetAccepted, GetNoContent,
145128 GetNonAuthoritative, GetPartialContent, GetResetContent,
146− NoContentVerb, Patch, PatchAccepted, PatchNoContent,
147− PatchNonAuthoritative, Post, PostAccepted, PostCreated,
148− PostNoContent, PostNonAuthoritative, PostResetContent, Put,
149− PutAccepted, PutCreated, PutNoContent, PutNonAuthoritative,
129+ Patch, PatchAccepted, PatchNoContent, PatchNonAuthoritative,
130+ Post, PostAccepted, PostCreated, PostNoContent,
131+ PostNonAuthoritative, PostResetContent, Put, PutAccepted,
132+ PutCreated, PutNoContent, PutNonAuthoritative,
150133 ReflectMethod (reflectMethod), StdMethod (..), Verb)
151134import Servant.API.WithNamedContext
152135 (WithNamedContext)
servant/src/Servant/API/Alternative.hs+2
@@ -16,6 +16,8 @@ import Data.Bifunctor
1616 (Bifunctor (..))
1717import Data.Bitraversable
1818 (Bitraversable (..))
19+import Data.Semigroup
20+ (Semigroup (..))
1921import Data.Typeable
2022 (Typeable)
2123import Prelude ()
servant/src/Servant/API/ContentTypes.hs+3−3
@@ -2,7 +2,6 @@
22{-# LANGUAGE DataKinds #-}
33{-# LANGUAGE DeriveDataTypeable #-}
44{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE FlexibleContexts #-}
65{-# LANGUAGE FlexibleInstances #-}
76{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE OverloadedStrings #-}
@@ -21,7 +20,7 @@
2120--
2221-- Content-Types are used in `ReqBody` and the method combinators:
2322--
24−-- >>> type MyEndpoint = ReqBody '[JSON, PlainText] Book :> Put '[JSON, PlainText] Book
23+-- >>> type MyEndpoint = ReqBody '[JSON, PlainText] Book :> Get '[JSON, PlainText] Book
2524--
2625-- Meaning the endpoint accepts requests of Content-Type @application/json@
2726-- or @text/plain;charset-utf8@, and returns data in either one of those
@@ -295,7 +294,7 @@ instance {-# OVERLAPPABLE #-}
295294-- then this would be taken care of. However there is no more specific instance
296295-- between that and 'MimeRender JSON a', so we do this instead
297296instance {-# OVERLAPPING #-} ( Accept ctyp ) => AllMimeRender '[ctyp] NoContent where
298− allMimeRender _ NoContent = map (, "") $ NE.toList $ contentTypes pctyp
297+ allMimeRender _ _ = map (, "") $ NE.toList $ contentTypes pctyp
299298 where
300299 pctyp = Proxy :: Proxy ctyp
301300
@@ -420,6 +419,7 @@ instance MimeUnrender OctetStream BS.ByteString where
420419 mimeUnrender _ = Right . toStrict
421420
422421
422+
423423-- $setup
424424-- >>> :set -XFlexibleInstances
425425-- >>> :set -XMultiParamTypeClasses
servant/src/Servant/API/Description.hs+2−2
@@ -39,14 +39,14 @@ data Summary (sym :: Symbol)
3939--type MyApi = Description
4040-- "This comment is visible in multiple Servant interpretations \
4141-- \and can be really long if necessary. \
42−-- \Haskell multiline String support is not perfect \
42+-- \Haskell multiline support is not perfect \
4343-- \but it's still very readable."
4444-- :> Get '[JSON] Book
4545-- :}
4646data Description (sym :: Symbol)
4747 deriving (Typeable)
4848
49−-- | Fold list of modifiers to extract description as a type-level String.
49+-- | Fold modifier list to decide whether argument should be parsed strictly or leniently.
5050--
5151-- >>> :kind! FoldDescription '[]
5252-- FoldDescription '[] :: Symbol
servant/src/Servant/API/Fragment.hsdeleted−25
@@ -1,25 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE PolyKinds #-}
4−{-# LANGUAGE TypeOperators #-}
5−{-# OPTIONS_HADDOCK not-home #-}
6−module Servant.API.Fragment (Fragment) where
7−
8−import Data.Typeable
9− (Typeable)
10−
11−-- | Document the URI fragment in API. Useful in combination with 'Link'.
12−--
13−-- Example:
14−--
15−-- >>> -- /post#TRACKING
16−-- >>> type MyApi = "post" :> Fragment Text :> Get '[JSON] Tracking
17−data Fragment (a :: *)
18− deriving Typeable
19−
20−-- $setup
21−-- >>> import Servant.API
22−-- >>> import Data.Aeson
23−-- >>> import Data.Text
24−-- >>> data Tracking
25−-- >>> instance ToJSON Tracking where { toJSON = undefined }
servant/src/Servant/API/Header.hs+1−1
@@ -23,7 +23,7 @@ import Servant.API.Modifiers
2323-- >>> type MyApi = "view-my-referer" :> Header "from" Referer :> Get '[JSON] Referer
2424type Header = Header' '[Optional, Strict]
2525
26−data Header' (mods :: [*]) (sym :: Symbol) (a :: *)
26+data Header' (mods :: [*]) (sym :: Symbol) a
2727 deriving Typeable
2828
2929-- $setup
servant/src/Servant/API/Internal/Test/ComprehensiveAPI.hsnew file+6
@@ -0,0 +1,6 @@
1+module Servant.API.Internal.Test.ComprehensiveAPI
2+ {-# DEPRECATED "Use Servant.TestComprehensiveAPI" #-}
3+ ( module Servant.Test.ComprehensiveAPI )
4+ where
5+
6+import Servant.Test.ComprehensiveAPI
servant/src/Servant/API/Modifiers.hs+2
@@ -131,6 +131,8 @@ type RequestArgument mods a =
131131 (If (FoldLenient mods) (Either Text a) a)
132132 (Maybe (If (FoldLenient mods) (Either Text a) a))
133133
134+
135+
134136-- | Unfold a value into a 'RequestArgument'.
135137unfoldRequestArgument
136138 :: forall mods m a. (Monad m, SBoolI (FoldRequired mods), SBoolI (FoldLenient mods))
servant/src/Servant/API/NamedRoutes.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE KindSignatures #-}
2−{-# OPTIONS_HADDOCK not-home #-}
3−
4−module Servant.API.NamedRoutes (
5− -- * NamedRoutes combinator
6− NamedRoutes
7− ) where
8−
9−-- | Combinator for embedding a record of named routes into a Servant API type.
10−data NamedRoutes (api :: * -> *)
servant/src/Servant/API/Raw.hs+2−3
@@ -11,7 +11,6 @@ import Data.Typeable
1111-- a modified (stripped) 'pathInfo' if the 'Application' is being routed with 'Servant.API.Sub.:>'.
1212--
1313-- In addition to just letting you plug in your existing WAI 'Application's,
14−-- this can also be used with functions from
15−-- <https://hackage.haskell.org/package/servant-server/docs/Servant-Server-StaticFiles.html Servant.Server.StaticFiles>
16−-- to serve static files stored in a particular directory on your filesystem
14+-- this can also be used with <https://hackage.haskell.org/package/servant-server/docs/Servant-Utils-StaticFiles.html#v:serveDirectory serveDirectory> to serve
15+-- static files stored in a particular directory on your filesystem
1716data Raw deriving Typeable
servant/src/Servant/API/ResponseHeaders.hs+9−7
@@ -3,8 +3,10 @@
33{-# LANGUAGE DeriveFunctor #-}
44{-# LANGUAGE FlexibleContexts #-}
55{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
76{-# LANGUAGE FunctionalDependencies #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE KindSignatures #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
810{-# LANGUAGE PolyKinds #-}
911{-# LANGUAGE ScopedTypeVariables #-}
1012{-# LANGUAGE TypeFamilies #-}
@@ -93,7 +95,7 @@ type family HeaderValMap (f :: * -> *) (xs :: [*]) where
9395
9496class BuildHeadersTo hs where
9597 buildHeadersTo :: [HTTP.Header] -> HList hs
96− -- ^ Note: if there are multiple occurrences of a header in the argument,
98+ -- ^ Note: if there are multiple occurences of a header in the argument,
9799 -- the values are interspersed with commas before deserialization (see
98100 -- <http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2 RFC2616 Sec 4.2>)
99101
@@ -112,7 +114,7 @@ instance {-# OVERLAPPABLE #-} ( FromHttpApiData v, BuildHeadersTo xs, KnownSymbo
112114 `HCons` buildHeadersTo headers
113115 Right h -> Header h `HCons` buildHeadersTo headers
114116
115−-- * Getting headers
117+-- * Getting
116118
117119class GetHeaders ls where
118120 getHeaders :: ls -> [HTTP.Header]
@@ -153,20 +155,20 @@ instance (KnownSymbol h, GetHeadersFromHList rest, ToHttpApiData v)
153155 where
154156 getHeaders' hs = getHeadersFromHList $ getHeadersHList hs
155157
156−-- * Adding headers
158+-- * Adding
157159
158160-- We need all these fundeps to save type inference
159161class AddHeader h v orig new
160162 | h v orig -> new, new -> h, new -> v, new -> orig where
161163 addOptionalHeader :: ResponseHeader h v -> orig -> new -- ^ N.B.: The same header can't be added multiple times
162164
163−-- In this instance, we add a Header on top of something that is already decorated with some headers
165+
164166instance {-# OVERLAPPING #-} ( KnownSymbol h, ToHttpApiData v )
165167 => AddHeader h v (Headers (fst ': rest) a) (Headers (Header h v ': fst ': rest) a) where
166168 addOptionalHeader hdr (Headers resp heads) = Headers resp (HCons hdr heads)
167169
168−-- In this instance, 'a' parameter is decorated with a Header.
169−instance {-# OVERLAPPABLE #-} ( KnownSymbol h, ToHttpApiData v , new ~ Headers '[Header h v] a)
170+instance {-# OVERLAPPABLE #-} ( KnownSymbol h, ToHttpApiData v
171+ , new ~ (Headers '[Header h v] a) )
170172 => AddHeader h v a new where
171173 addOptionalHeader hdr resp = Headers resp (HCons hdr HNil)
172174
servant/src/Servant/API/Status.hsdeleted−160
@@ -1,160 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−-- Flexible instances is necessary on GHC 8.4 and earlier
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−module Servant.API.Status where
6−
7−import GHC.TypeLits (KnownNat, natVal)
8−import Network.HTTP.Types.Status
9−
10−-- | Retrieve a known or unknown Status from a KnownNat
11−statusFromNat :: forall a proxy. KnownNat a => proxy a -> Status
12−statusFromNat = toEnum . fromInteger . natVal
13−
14−-- | Witness that a type-level natural number corresponds to a HTTP status code
15−class KnownNat n => KnownStatus n where
16− statusVal :: proxy n -> Status
17−
18−instance KnownStatus 100 where
19− statusVal _ = status100
20−
21−instance KnownStatus 101 where
22− statusVal _ = status101
23−
24−instance KnownStatus 200 where
25− statusVal _ = status200
26−
27−instance KnownStatus 201 where
28− statusVal _ = status201
29−
30−instance KnownStatus 202 where
31− statusVal _ = status202
32−
33−instance KnownStatus 203 where
34− statusVal _ = status203
35−
36−instance KnownStatus 204 where
37− statusVal _ = status204
38−
39−instance KnownStatus 205 where
40− statusVal _ = status205
41−
42−instance KnownStatus 206 where
43− statusVal _ = status206
44−
45−instance KnownStatus 300 where
46− statusVal _ = status300
47−
48−instance KnownStatus 301 where
49− statusVal _ = status301
50−
51−instance KnownStatus 302 where
52− statusVal _ = status302
53−
54−instance KnownStatus 303 where
55− statusVal _ = status303
56−
57−instance KnownStatus 304 where
58− statusVal _ = status304
59−
60−instance KnownStatus 305 where
61− statusVal _ = status305
62−
63−instance KnownStatus 307 where
64− statusVal _ = status307
65−
66−instance KnownStatus 308 where
67− statusVal _ = status308
68−
69−instance KnownStatus 400 where
70− statusVal _ = status400
71−
72−instance KnownStatus 401 where
73− statusVal _ = status401
74−
75−instance KnownStatus 402 where
76− statusVal _ = status402
77−
78−instance KnownStatus 403 where
79− statusVal _ = status403
80−
81−instance KnownStatus 404 where
82− statusVal _ = status404
83−
84−instance KnownStatus 405 where
85− statusVal _ = status405
86−
87−instance KnownStatus 406 where
88− statusVal _ = status406
89−
90−instance KnownStatus 407 where
91− statusVal _ = status407
92−
93−instance KnownStatus 408 where
94− statusVal _ = status408
95−
96−instance KnownStatus 409 where
97− statusVal _ = status409
98−
99−instance KnownStatus 410 where
100− statusVal _ = status410
101−
102−instance KnownStatus 411 where
103− statusVal _ = status411
104−
105−instance KnownStatus 412 where
106− statusVal _ = status412
107−
108−instance KnownStatus 413 where
109− statusVal _ = status413
110−
111−instance KnownStatus 414 where
112− statusVal _ = status414
113−
114−instance KnownStatus 415 where
115− statusVal _ = status415
116−
117−instance KnownStatus 416 where
118− statusVal _ = status416
119−
120−instance KnownStatus 417 where
121− statusVal _ = status417
122−
123−instance KnownStatus 418 where
124− statusVal _ = status418
125−
126−instance KnownStatus 422 where
127− statusVal _ = status422
128−
129−instance KnownStatus 426 where
130− statusVal _ = status426
131−
132−instance KnownStatus 428 where
133− statusVal _ = status428
134−
135−instance KnownStatus 429 where
136− statusVal _ = status429
137−
138−instance KnownStatus 431 where
139− statusVal _ = status431
140−
141−instance KnownStatus 500 where
142− statusVal _ = status500
143−
144−instance KnownStatus 501 where
145− statusVal _ = status501
146−
147−instance KnownStatus 502 where
148− statusVal _ = status502
149−
150−instance KnownStatus 503 where
151− statusVal _ = status503
152−
153−instance KnownStatus 504 where
154− statusVal _ = status504
155−
156−instance KnownStatus 505 where
157− statusVal _ = status505
158−
159−instance KnownStatus 511 where
160− statusVal _ = status511
servant/src/Servant/API/Stream.hs+2
@@ -47,6 +47,8 @@ import qualified Data.ByteString.Lazy as LBS
4747import qualified Data.ByteString.Lazy.Char8 as LBS8
4848import Data.List.NonEmpty
4949 (NonEmpty (..))
50+import Data.Monoid
51+ ((<>))
5052import Data.Proxy
5153 (Proxy)
5254import Data.Typeable
servant/src/Servant/API/TypeErrors.hsdeleted−40
@@ -1,40 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE PolyKinds #-}
3−{-# LANGUAGE TypeFamilies #-}
4−{-# LANGUAGE TypeOperators #-}
5−{-# LANGUAGE UndecidableInstances #-}
6−
7−-- | This module defines the error messages used in type-level errors.
8−-- Type-level errors can signal non-existing instances, for instance when
9−-- a combinator is not applied to the correct number of arguments.
10−
11−module Servant.API.TypeErrors (
12− PartialApplication,
13− NoInstanceFor,
14− NoInstanceForSub,
15−) where
16−
17−import Data.Kind
18−import GHC.TypeLits
19−
20−-- | No instance exists for @tycls (expr :> ...)@ because
21−-- @expr@ is not recognised.
22−type NoInstanceForSub (tycls :: k) (expr :: k') =
23− Text "There is no instance for " :<>: ShowType tycls
24− :<>: Text " (" :<>: ShowType expr :<>: Text " :> ...)"
25−
26−-- | No instance exists for @expr@.
27−type NoInstanceFor (expr :: k) =
28− Text "There is no instance for " :<>: ShowType expr
29−
30−-- | No instance exists for @tycls (expr :> ...)@ because @expr@ is not fully saturated.
31−type PartialApplication (tycls :: k) (expr :: k') =
32− NoInstanceForSub tycls expr
33− :$$: ShowType expr :<>: Text " expects " :<>: ShowType (Arity expr) :<>: Text " more arguments"
34−
35−-- The arity of a combinator, i.e. the number of required arguments.
36−type Arity (ty :: k) = Arity' k
37−
38−type family Arity' (ty :: k) :: Nat where
39− Arity' (_ -> ty) = 1 + Arity' ty
40− Arity' _ = 0
servant/src/Servant/API/TypeLevel.hs+10−60
@@ -1,16 +1,12 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE KindSignatures #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE PolyKinds #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
11−{-# LANGUAGE RankNTypes #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−{-# LANGUAGE UndecidableSuperClasses #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE KindSignatures #-}
5+{-# LANGUAGE MultiParamTypeClasses #-}
6+{-# LANGUAGE PolyKinds #-}
7+{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE TypeOperators #-}
9+{-# LANGUAGE UndecidableInstances #-}
1410
1511{-|
1612This module collects utilities for manipulating @servant@ API types. The
@@ -45,9 +41,6 @@ module Servant.API.TypeLevel (
4541 -- ** Logic
4642 Or,
4743 And,
48− -- ** Fragment
49− FragmentUnique,
50− AtLeastOneFragment
5144 ) where
5245
5346
@@ -57,7 +50,6 @@ import Servant.API.Alternative
5750 (type (:<|>))
5851import Servant.API.Capture
5952 (Capture, CaptureAll)
60−import Servant.API.Fragment
6153import Servant.API.Header
6254 (Header)
6355import Servant.API.QueryParam
@@ -68,8 +60,6 @@ import Servant.API.Sub
6860 (type (:>))
6961import Servant.API.Verbs
7062 (Verb)
71−import Servant.API.UVerb
72− (UVerb)
7363import GHC.TypeLits
7464 (ErrorMessage (..), TypeError)
7565
@@ -138,7 +128,6 @@ type family IsElem endpoint api :: Constraint where
138128 IsElem sa (QueryParam x y :> sb) = IsElem sa sb
139129 IsElem sa (QueryParams x y :> sb) = IsElem sa sb
140130 IsElem sa (QueryFlag x :> sb) = IsElem sa sb
141− IsElem sa (Fragment x :> sb) = IsElem sa sb
142131 IsElem (Verb m s ct typ) (Verb m s ct' typ)
143132 = IsSubList ct ct'
144133 IsElem e e = ()
@@ -189,7 +178,7 @@ type family IsStrictSubAPI sub api :: Constraint where
189178
190179-- | Check that every element of @xs@ is an endpoint of @api@ (using @'IsIn'@).
191180--
192−-- >>> ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
181+-- ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
193182-- OK
194183type family AllIsIn xs api :: Constraint where
195184 AllIsIn '[] api = ()
@@ -252,43 +241,6 @@ We might try to factor these our more cleanly, but the type synonyms and type
252241families are not evaluated (see https://ghc.haskell.org/trac/ghc/ticket/12048).
253242-}
254243
255−-- ** Fragment
256−
257−class FragmentUnique api => AtLeastOneFragment api
258−
259−-- | If fragment appeared in API endpoint twice, compile-time error would be raised.
260−--
261−-- >>> -- type FailAPI = Fragment Bool :> Fragment Int :> Get '[JSON] NoContent
262−-- >>> instance AtLeastOneFragment FailAPI
263−-- ...
264−-- ...Only one Fragment allowed per endpoint in api...
265−-- ...
266−-- ...In the instance declaration for...
267−instance AtLeastOneFragment (Verb m s ct typ)
268−
269−instance AtLeastOneFragment (UVerb m cts as)
270−
271−instance AtLeastOneFragment (Fragment a)
272−
273−type family FragmentUnique api :: Constraint where
274− FragmentUnique (sa :<|> sb) = And (FragmentUnique sa) (FragmentUnique sb)
275− FragmentUnique (Fragment a :> sa) = FragmentNotIn sa (Fragment a :> sa)
276− FragmentUnique (x :> sa) = FragmentUnique sa
277− FragmentUnique (Fragment a) = ()
278− FragmentUnique x = ()
279−
280−type family FragmentNotIn api orig :: Constraint where
281− FragmentNotIn (sa :<|> sb) orig =
282− And (FragmentNotIn sa orig) (FragmentNotIn sb orig)
283− FragmentNotIn (Fragment c :> sa) orig = TypeError (NotUniqueFragmentInApi orig)
284− FragmentNotIn (x :> sa) orig = FragmentNotIn sa orig
285− FragmentNotIn (Fragment c) orig = TypeError (NotUniqueFragmentInApi orig)
286− FragmentNotIn x orig = ()
287−
288−type NotUniqueFragmentInApi api =
289− 'Text "Only one Fragment allowed per endpoint in api ‘"
290− ':<>: 'ShowType api
291− ':<>: 'Text "’."
292244
293245-- $setup
294246--
@@ -296,7 +248,6 @@ type NotUniqueFragmentInApi api =
296248--
297249-- >>> :set -XPolyKinds
298250-- >>> :set -XGADTs
299−-- >>> :set -XTypeSynonymInstances -XFlexibleInstances
300251-- >>> import Data.Proxy
301252-- >>> import Data.Type.Equality
302253-- >>> import Servant.API
@@ -304,5 +255,4 @@ type NotUniqueFragmentInApi api =
304255-- >>> instance Show (OK ctx) where show _ = "OK"
305256-- >>> let ok :: ctx => Proxy ctx -> OK ctx; ok _ = OK
306257-- >>> type SampleAPI = "hello" :> Get '[JSON] Int :<|> "bye" :> Capture "name" String :> Post '[JSON, PlainText] Bool
307−-- >>> type FailAPI = Fragment Bool :> Fragment Int :> Get '[JSON] NoContent
308258-- >>> let sampleAPI = Proxy :: Proxy SampleAPI
servant/src/Servant/API/UVerb.hsdeleted−124
@@ -1,124 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE FlexibleContexts #-}
6−{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE RankNTypes #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
14−
15−-- | An alternative to 'Verb' for end-points that respond with a resource value of any of an
16−-- open union of types, and specific status codes for each type in this union. (`UVerb` is
17−-- short for `UnionVerb`)
18−--
19−-- This can be used for returning (rather than throwing) exceptions in a server as in, say
20−-- @'[Report, WaiError]@; or responding with either a 303 forward with a location header, or
21−-- 201 created with a different body type, depending on the circumstances. (All of this can
22−-- be done with vanilla servant-server by throwing exceptions, but it can't be represented in
23−-- the API types without something like `UVerb`.)
24−--
25−-- See <https://docs.servant.dev/en/stable/cookbook/uverb/UVerb.html> for a working example.
26−module Servant.API.UVerb
27− ( UVerb,
28− HasStatus (StatusOf),
29− statusOf,
30− HasStatuses (Statuses, statuses),
31− WithStatus (..),
32− module Servant.API.UVerb.Union,
33− )
34−where
35−
36−import Data.Proxy (Proxy (Proxy))
37−import GHC.TypeLits (Nat)
38−import Network.HTTP.Types (Status, StdMethod)
39−import Servant.API.ContentTypes (JSON, PlainText, FormUrlEncoded, OctetStream, NoContent, MimeRender(mimeRender), MimeUnrender(mimeUnrender))
40−import Servant.API.Status (KnownStatus, statusVal)
41−import Servant.API.UVerb.Union
42−
43−class KnownStatus (StatusOf a) => HasStatus (a :: *) where
44− type StatusOf (a :: *) :: Nat
45−
46−statusOf :: forall a proxy. HasStatus a => proxy a -> Status
47−statusOf = const (statusVal (Proxy :: Proxy (StatusOf a)))
48−
49−-- | If an API can respond with 'NoContent' we assume that this will happen
50−-- with the status code 204 No Content. If this needs to be overridden,
51−-- 'WithStatus' can be used.
52−instance HasStatus NoContent where
53− type StatusOf NoContent = 204
54−
55−class HasStatuses (as :: [*]) where
56− type Statuses (as :: [*]) :: [Nat]
57− statuses :: Proxy as -> [Status]
58−
59−instance HasStatuses '[] where
60− type Statuses '[] = '[]
61− statuses _ = []
62−
63−instance (HasStatus a, HasStatuses as) => HasStatuses (a ': as) where
64− type Statuses (a ': as) = StatusOf a ': Statuses as
65− statuses _ = statusOf (Proxy :: Proxy a) : statuses (Proxy :: Proxy as)
66−
67−-- | A simple newtype wrapper that pairs a type with its status code. It
68−-- implements all the content types that Servant ships with by default.
69−newtype WithStatus (k :: Nat) a = WithStatus a
70− deriving (Eq, Show)
71−
72−-- | an instance of this typeclass assigns a HTTP status code to a return type
73−--
74−-- Example:
75−--
76−-- @
77−-- data NotFoundError = NotFoundError String
78−--
79−-- instance HasStatus NotFoundError where
80−-- type StatusOf NotFoundError = 404
81−-- @
82−--
83−-- You can also use the convience newtype wrapper 'WithStatus' if you want to
84−-- avoid writing a 'HasStatus' instance manually. It also has the benefit of
85−-- showing the status code in the type; which might aid in readability.
86−instance KnownStatus n => HasStatus (WithStatus n a) where
87− type StatusOf (WithStatus n a) = n
88−
89−
90−-- | A variant of 'Verb' that can have any of a number of response values and status codes.
91−--
92−-- FUTUREWORK: it would be nice to make 'Verb' a special case of 'UVerb', and only write
93−-- instances for 'HasServer' etc. for the latter, getting them for the former for free.
94−-- Something like:
95−--
96−-- @type Verb method statusCode contentTypes a = UVerb method contentTypes [WithStatus statusCode a]@
97−--
98−-- Backwards compatibility is tricky, though: this type alias would mean people would have to
99−-- use 'respond' instead of 'pure' or 'return', so all old handlers would have to be rewritten.
100−data UVerb (method :: StdMethod) (contentTypes :: [*]) (as :: [*])
101−
102−instance {-# OVERLAPPING #-} MimeRender JSON a => MimeRender JSON (WithStatus _status a) where
103− mimeRender contentTypeProxy (WithStatus a) = mimeRender contentTypeProxy a
104−
105−instance {-# OVERLAPPING #-} MimeRender PlainText a => MimeRender PlainText (WithStatus _status a) where
106− mimeRender contentTypeProxy (WithStatus a) = mimeRender contentTypeProxy a
107−
108−instance {-# OVERLAPPING #-} MimeRender FormUrlEncoded a => MimeRender FormUrlEncoded (WithStatus _status a) where
109− mimeRender contentTypeProxy (WithStatus a) = mimeRender contentTypeProxy a
110−
111−instance {-# OVERLAPPING #-} MimeRender OctetStream a => MimeRender OctetStream (WithStatus _status a) where
112− mimeRender contentTypeProxy (WithStatus a) = mimeRender contentTypeProxy a
113−
114−instance {-# OVERLAPPING #-} MimeUnrender JSON a => MimeUnrender JSON (WithStatus _status a) where
115− mimeUnrender contentTypeProxy input = WithStatus <$> mimeUnrender contentTypeProxy input
116−
117−instance {-# OVERLAPPING #-} MimeUnrender PlainText a => MimeUnrender PlainText (WithStatus _status a) where
118− mimeUnrender contentTypeProxy input = WithStatus <$> mimeUnrender contentTypeProxy input
119−
120−instance {-# OVERLAPPING #-} MimeUnrender FormUrlEncoded a => MimeUnrender FormUrlEncoded (WithStatus _status a) where
121− mimeUnrender contentTypeProxy input = WithStatus <$> mimeUnrender contentTypeProxy input
122−
123−instance {-# OVERLAPPING #-} MimeUnrender OctetStream a => MimeUnrender OctetStream (WithStatus _status a) where
124− mimeUnrender contentTypeProxy input = WithStatus <$> mimeUnrender contentTypeProxy input
servant/src/Servant/API/UVerb/Union.hsdeleted−147
@@ -1,147 +0,0 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE ExplicitNamespaces #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE KindSignatures #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE RankNTypes #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−
14−{-
15−
16−Copyright Dennis Gosnell (c) 2017-2018
17−
18−All rights reserved.
19−
20−Redistribution and use in source and binary forms, with or without
21−modification, are permitted provided that the following conditions are met:
22−
23− * Redistributions of source code must retain the above copyright
24− notice, this list of conditions and the following disclaimer.
25−
26− * Redistributions in binary form must reproduce the above
27− copyright notice, this list of conditions and the following
28− disclaimer in the documentation and/or other materials provided
29− with the distribution.
30−
31− * Neither the name of Author name here nor the names of other
32− contributors may be used to endorse or promote products derived
33− from this software without specific prior written permission.
34−
35−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46−
47−-}
48−
49−-- | Type-level code for implementing and using 'UVerb'. Heavily inspired by
50−-- [world-peace](https://github.com/cdepillabout/world-peace).
51−module Servant.API.UVerb.Union
52−( IsMember
53−, Unique
54−, Union
55−, inject
56−, eject
57−, foldMapUnion
58−, matchUnion
59−)
60−where
61−
62−import Data.Proxy (Proxy)
63−import Data.SOP.BasicFunctors (I, unI)
64−import Data.SOP.Constraint
65−import Data.SOP.NS
66−import Data.Type.Bool (If)
67−import Data.Type.Equality (type (==))
68−import GHC.TypeLits
69−
70−type Union = NS I
71−
72−-- | Convenience function to apply a function to an unknown union element using a type class.
73−-- All elements of the union must have instances in the type class, and the function is
74−-- applied unconditionally.
75−--
76−-- See also: 'matchUnion'.
77−foldMapUnion ::
78− forall (c :: * -> Constraint) (a :: *) (as :: [*]).
79− All c as =>
80− Proxy c ->
81− (forall x. c x => x -> a) ->
82− Union as ->
83− a
84−foldMapUnion proxy go = cfoldMap_NS proxy (go . unI)
85−
86−-- | Convenience function to extract a union element using 'cast', ie. return the value if the
87−-- selected type happens to be the actual type of the union in this value, or 'Nothing'
88−-- otherwise.
89−--
90−-- See also: 'foldMapUnion'.
91−matchUnion :: forall (a :: *) (as :: [*]). (IsMember a as) => Union as -> Maybe a
92−matchUnion = fmap unI . eject
93−
94−-- * Stuff stolen from 'Data.WorldPeace" but for generics-sop
95−
96−-- (this could to go sop-core, except it's probably too specialized to the servant use-case.)
97−
98−type IsMember (a :: u) (as :: [u]) = (Unique as, CheckElemIsMember a as, UElem a as)
99−
100−class UElem x xs where
101− inject :: f x -> NS f xs
102− eject :: NS f xs -> Maybe (f x)
103−
104−instance {-# OVERLAPPING #-} UElem x (x ': xs) where
105− inject = Z
106− eject (Z x) = Just x
107− eject _ = Nothing
108−
109−instance {-# OVERLAPPING #-} UElem x xs => UElem x (x' ': xs) where
110− inject = S . inject
111− eject (Z _) = Nothing
112− eject (S ns) = eject ns
113−
114−-- | Check whether @a@ is in list. This will throw nice errors if the element is not in the
115−-- list, or if there is a duplicate in the list.
116−type family CheckElemIsMember (a :: k) (as :: [k]) :: Constraint where
117− CheckElemIsMember a as =
118− If (Elem a as) (() :: Constraint) (TypeError (NoElementError a as))
119−
120−type NoElementError (r :: k) (rs :: [k]) =
121− 'Text "Expected one of:"
122− ':$$: 'Text " " ':<>: 'ShowType rs
123− ':$$: 'Text "But got:"
124− ':$$: 'Text " " ':<>: 'ShowType r
125−
126−type DuplicateElementError (rs :: [k]) =
127− 'Text "Duplicate element in list:"
128− ':$$: 'Text " " ':<>: 'ShowType rs
129−
130−type family Elem (x :: k) (xs :: [k]) :: Bool where
131− Elem _ '[] = 'False
132− Elem x (x' ': xs) =
133− If (x == x') 'True (Elem x xs)
134−
135−type family Unique xs :: Constraint where
136− Unique xs = If (Nubbed xs == 'True) (() :: Constraint) (TypeError (DuplicateElementError xs))
137−
138−type family Nubbed xs :: Bool where
139− Nubbed '[] = 'True
140− Nubbed (x ': xs) = If (Elem x xs) 'False (Nubbed xs)
141−
142−_testNubbed :: ( ( Nubbed '[Bool, Int, Int] ~ 'False
143− , Nubbed '[Int, Int, Bool] ~ 'False
144− , Nubbed '[Int, Bool] ~ 'True
145− )
146− => a) -> a
147−_testNubbed a = a
servant/src/Servant/API/Verbs.hs+6−13
@@ -29,12 +29,6 @@ import Network.HTTP.Types.Method
2929data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [*]) (a :: *)
3030 deriving (Typeable, Generic)
3131
32−-- | @NoContentVerb@ is a specific type to represent 'NoContent' responses.
33−-- It does not require either a list of content types (because there's
34−-- no content) or a status code (because it should always be 204).
35−data NoContentVerb (method :: k1)
36− deriving (Typeable, Generic)
37−
3832-- * 200 responses
3933--
4034-- The 200 response is the workhorse of web servers, but also fairly generic.
@@ -119,17 +113,16 @@ type PutNonAuthoritative = Verb 'PUT 203
119113-- If the document view should be reset, use @205 Reset Content@.
120114
121115-- | 'GET' with 204 status code.
122−type GetNoContent = NoContentVerb 'GET
116+type GetNoContent = Verb 'GET 204
123117-- | 'POST' with 204 status code.
124−type PostNoContent = NoContentVerb 'POST
118+type PostNoContent = Verb 'POST 204
125119-- | 'DELETE' with 204 status code.
126−type DeleteNoContent = NoContentVerb 'DELETE
120+type DeleteNoContent = Verb 'DELETE 204
127121-- | 'PATCH' with 204 status code.
128−type PatchNoContent = NoContentVerb 'PATCH
122+type PatchNoContent = Verb 'PATCH 204
129123-- | 'PUT' with 204 status code.
130−type PutNoContent = NoContentVerb 'PUT
131−-- | 'HEAD' with 204 status code.
132−type HeadNoContent = NoContentVerb 'HEAD
124+type PutNoContent = Verb 'PUT 204
125+
133126
134127-- ** 205 Reset Content
135128--
servant/src/Servant/Links.hs+13−94
@@ -1,18 +1,13 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
21{-# LANGUAGE ConstraintKinds #-}
32{-# LANGUAGE DataKinds #-}
43{-# LANGUAGE FlexibleContexts #-}
54{-# LANGUAGE FlexibleInstances #-}
65{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE InstanceSigs #-}
86{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE QuantifiedConstraints #-}
107{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeApplications #-}
128{-# LANGUAGE TypeFamilies #-}
139{-# LANGUAGE TypeOperators #-}
1410{-# LANGUAGE UndecidableInstances #-}
15−
1611{-# OPTIONS_HADDOCK not-home #-}
1712
1813-- | Type safe generation of internal links.
@@ -22,7 +17,6 @@
2217-- >>> :set -XDataKinds -XTypeFamilies -XTypeOperators
2318-- >>> import Servant.API
2419-- >>> import Servant.Links
25−-- >>> import Web.HttpApiData (toUrlPiece)
2620-- >>> import Data.Proxy
2721-- >>>
2822-- >>> type Hello = "hello" :> Get '[JSON] Int
@@ -60,7 +54,7 @@
6054-- >>> toUrlPiece $ safeLink api without
6155-- "bye"
6256--
63−-- If you would like to create a helper for generating links only within that API,
57+-- If you would like create a helper for generating links only within that API,
6458-- you can partially apply safeLink if you specify a correct type signature
6559-- like so:
6660--
@@ -71,7 +65,7 @@
7165-- >>> apiLink = safeLink api
7266-- >>> :}
7367--
74−-- `safeLink'` allows you to specialise the output:
68+-- `safeLink'` allows to make specialise the output:
7569--
7670-- >>> safeLink' toUrlPiece api without
7771-- "bye"
@@ -126,13 +120,13 @@ module Servant.Links (
126120 , Param (..)
127121 , linkSegments
128122 , linkQueryParams
129− , linkFragment
130123) where
131124
132125import Data.List
133−import Data.Constraint
134126import Data.Proxy
135127 (Proxy (..))
128+import Data.Semigroup
129+ ((<>))
136130import Data.Singletons.Bool
137131 (SBool (..), SBoolI (..))
138132import qualified Data.Text as Text
@@ -140,7 +134,7 @@ import qualified Data.Text.Encoding as TE
140134import Data.Type.Bool
141135 (If)
142136import GHC.TypeLits
143− (KnownSymbol, TypeError, symbolVal)
137+ (KnownSymbol, symbolVal)
144138import Network.URI
145139 (URI (..), escapeURIString, isUnreserved)
146140import Prelude ()
@@ -158,8 +152,6 @@ import Servant.API.Empty
158152 (EmptyAPI (..))
159153import Servant.API.Experimental.Auth
160154 (AuthProtect)
161−import Servant.API.Fragment
162− (Fragment)
163155import Servant.API.Generic
164156import Servant.API.Header
165157 (Header')
@@ -169,8 +161,6 @@ import Servant.API.IsSecure
169161 (IsSecure)
170162import Servant.API.Modifiers
171163 (FoldRequired)
172−import Servant.API.NamedRoutes
173− (NamedRoutes)
174164import Servant.API.QueryParam
175165 (QueryFlag, QueryParam', QueryParams)
176166import Servant.API.Raw
@@ -183,13 +173,11 @@ import Servant.API.Stream
183173 (Stream, StreamBody')
184174import Servant.API.Sub
185175 (type (:>))
186−import Servant.API.TypeErrors
187176import Servant.API.TypeLevel
188−import Servant.API.UVerb
189177import Servant.API.Vault
190178 (Vault)
191179import Servant.API.Verbs
192− (Verb, NoContentVerb)
180+ (Verb)
193181import Servant.API.WithNamedContext
194182 (WithNamedContext)
195183import Web.HttpApiData
@@ -200,13 +188,10 @@ import Web.HttpApiData
200188data Link = Link
201189 { _segments :: [Escaped]
202190 , _queryParams :: [Param]
203− , _fragment :: Fragment'
204191 } deriving Show
205192
206193newtype Escaped = Escaped String
207194
208−type Fragment' = Maybe String
209−
210195escaped :: String -> Escaped
211196escaped = Escaped . escapeURIString isUnreserved
212197
@@ -223,14 +208,11 @@ linkSegments = map getEscaped . _segments
223208linkQueryParams :: Link -> [Param]
224209linkQueryParams = _queryParams
225210
226−linkFragment :: Link -> Fragment'
227−linkFragment = _fragment
228−
229211instance ToHttpApiData Link where
230212 toHeader = TE.encodeUtf8 . toUrlPiece
231213 toUrlPiece l =
232214 let uri = linkURI l
233− in Text.pack $ uriPath uri ++ uriQuery uri ++ uriFragment uri
215+ in Text.pack $ uriPath uri ++ uriQuery uri
234216
235217-- | Query parameter.
236218data Param
@@ -246,9 +228,6 @@ addQueryParam :: Param -> Link -> Link
246228addQueryParam qp l =
247229 l { _queryParams = _queryParams l <> [qp] }
248230
249−addFragment :: Fragment' -> Link -> Link
250−addFragment fr l = l { _fragment = fr }
251−
252231-- | Transform 'Link' into 'URI'.
253232--
254233-- >>> type API = "something" :> Get '[JSON] Int
@@ -266,7 +245,7 @@ addFragment fr l = l { _fragment = fr }
266245-- >>> type SomeRoute = "abc" :> Capture "email" String :> Put '[JSON] ()
267246-- >>> let someRoute = Proxy :: Proxy SomeRoute
268247-- >>> safeLink someRoute someRoute "test@example.com"
269−-- Link {_segments = ["abc","test%40example.com"], _queryParams = [], _fragment = Nothing}
248+-- Link {_segments = ["abc","test%40example.com"], _queryParams = []}
270249--
271250-- >>> linkURI $ safeLink someRoute someRoute "test@example.com"
272251-- abc/test%40example.com
@@ -290,12 +269,11 @@ data LinkArrayElementStyle
290269-- sum?x=1&x=2&x=3
291270--
292271linkURI' :: LinkArrayElementStyle -> Link -> URI
293−linkURI' addBrackets (Link segments q_params mfragment) =
272+linkURI' addBrackets (Link segments q_params) =
294273 URI mempty -- No scheme (relative)
295274 Nothing -- Or authority (relative)
296275 (intercalate "/" $ map getEscaped segments)
297− (makeQueries q_params)
298− (makeFragment mfragment)
276+ (makeQueries q_params) mempty
299277 where
300278 makeQueries :: [Param] -> String
301279 makeQueries [] = ""
@@ -307,10 +285,6 @@ linkURI' addBrackets (Link segments q_params mfragment) =
307285 makeQuery (SingleParam k v) = escape k <> "=" <> escape (Text.unpack v)
308286 makeQuery (FlagParam k) = escape k
309287
310− makeFragment :: Fragment' -> String
311− makeFragment Nothing = ""
312− makeFragment (Just fr) = "#" <> escape fr
313−
314288 style = case addBrackets of
315289 LinkArrayElementBracket -> "[]="
316290 LinkArrayElementPlain -> "="
@@ -336,7 +310,7 @@ safeLink'
336310 -> Proxy api -- ^ The whole API that this endpoint is a part of
337311 -> Proxy endpoint -- ^ The API endpoint you would like to point to
338312 -> MkLink endpoint a
339−safeLink' toA _ endpoint = toLink toA endpoint (Link mempty mempty mempty)
313+safeLink' toA _ endpoint = toLink toA endpoint (Link mempty mempty)
340314
341315-- | Create all links in an API.
342316--
@@ -367,7 +341,7 @@ allLinks'
367341 => (Link -> a)
368342 -> Proxy api
369343 -> MkLink api a
370−allLinks' toA api = toLink toA api (Link mempty mempty mempty)
344+allLinks' toA api = toLink toA api (Link mempty mempty)
371345
372346-------------------------------------------------------------------------------
373347-- Generics
@@ -572,10 +546,6 @@ instance HasLink (Verb m s ct a) where
572546 type MkLink (Verb m s ct a) r = r
573547 toLink toA _ = toA
574548
575−instance HasLink (NoContentVerb m) where
576− type MkLink (NoContentVerb m) r = r
577− toLink toA _ = toA
578−
579549instance HasLink Raw where
580550 type MkLink Raw a = a
581551 toLink toA _ = toA
@@ -584,52 +554,12 @@ instance HasLink (Stream m status fr ct a) where
584554 type MkLink (Stream m status fr ct a) r = r
585555 toLink toA _ = toA
586556
587−-- UVerb instances
588−instance HasLink (UVerb m ct a) where
589− type MkLink (UVerb m ct a) r = r
590− toLink toA _ = toA
591−-- Instance for NamedRoutes combinator
592−
593−type GLinkConstraints routes a =
594− ( MkLink (ToServant routes AsApi) a ~ ToServant routes (AsLink a)
595− , GenericServant routes (AsLink a)
596− )
597−
598−class GLink (routes :: * -> *) (a :: *) where
599− gLinkProof :: Dict (GLinkConstraints routes a)
600−
601−instance GLinkConstraints routes a => GLink routes a where
602− gLinkProof = Dict
603−
604−instance
605− ( HasLink (ToServantApi routes)
606− , forall a. GLink routes a
607− ) => HasLink (NamedRoutes routes) where
608−
609− type MkLink (NamedRoutes routes) a = routes (AsLink a)
610−
611− toLink
612− :: forall a. (Link -> a)
613− -> Proxy (NamedRoutes routes)
614− -> Link
615− -> routes (AsLink a)
616−
617− toLink toA _ l = case gLinkProof @routes @a of
618− Dict -> fromServant $ toLink toA (Proxy @(ToServantApi routes)) l
619−
620557-- AuthProtext instances
621558instance HasLink sub => HasLink (AuthProtect tag :> sub) where
622559 type MkLink (AuthProtect tag :> sub) a = MkLink sub a
623560 toLink = simpleToLink (Proxy :: Proxy sub)
624561
625−instance (HasLink sub, ToHttpApiData v)
626− => HasLink (Fragment v :> sub) where
627− type MkLink (Fragment v :> sub) a = v -> MkLink sub a
628− toLink toA _ l mv =
629− toLink toA (Proxy :: Proxy sub) $
630− addFragment ((Just . Text.unpack . toQueryParam) mv) l
631−
632−-- | Helper for implementing 'toLink' for combinators not affecting link
562+-- | Helper for implemneting 'toLink' for combinators not affecting link
633563-- structure.
634564simpleToLink
635565 :: forall sub a combinator.
@@ -645,14 +575,3 @@ simpleToLink _ toA _ = toLink toA (Proxy :: Proxy sub)
645575-- $setup
646576-- >>> import Servant.API
647577-- >>> import Data.Text (Text)
648−
649−-- Erroring instance for 'HasLink' when a combinator is not fully applied
650−instance TypeError (PartialApplication HasLink arr) => HasLink ((arr :: a -> b) :> sub)
651− where
652− type MkLink (arr :> sub) _ = TypeError (PartialApplication (HasLink :: * -> Constraint) arr)
653− toLink = error "unreachable"
654−
655−-- Erroring instances for 'HasLink' for unknown API combinators
656−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub HasLink ty) => HasLink (ty :> sub)
657−
658−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceFor (HasLink api)) => HasLink api
servant/src/Servant/Test/ComprehensiveAPI.hs+2−4
@@ -48,8 +48,7 @@ comprehensiveAPIWithoutStreaming = Proxy
4848type ComprehensiveAPIWithoutStreamingOrRaw' endpoint =
4949 GET
5050 :<|> "get-int" :> Get '[JSON] Int
51− :<|> "capture" :> Capture' '[Description "example description"] "bar" Int :> GET
52− :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET
51+ :<|> "capture" :> Capture' '[Description "example description"] "foo" Int :> GET
5352 :<|> "header" :> Header "foo" Int :> GET
5453 :<|> "header-lenient" :> Header' '[Required, Lenient] "bar" Int :> GET
5554 :<|> "http-version" :> HttpVersion :> GET
@@ -64,14 +63,13 @@ type ComprehensiveAPIWithoutStreamingOrRaw' endpoint =
6463 :<|> "res-headers" :> Get '[JSON] (Headers '[Header "foo" Int] NoContent)
6564 :<|> "foo" :> GET
6665 :<|> "vault" :> Vault :> GET
67− :<|> "post-no-content" :> PostNoContent
66+ :<|> "post-no-content" :> Verb 'POST 204 '[JSON] NoContent
6867 :<|> "post-int" :> Verb 'POST 204 '[JSON] Int
6968 :<|> "named-context" :> WithNamedContext "foo" '[] GET
7069 :<|> "capture-all" :> CaptureAll "foo" Int :> GET
7170 :<|> "summary" :> Summary "foo" :> GET
7271 :<|> "description" :> Description "foo" :> GET
7372 :<|> "alternative" :> ("left" :> GET :<|> "right" :> GET)
74− :<|> "fragment" :> Fragment Int :> GET
7573 :<|> endpoint
7674
7775type ComprehensiveAPIWithoutStreamingOrRaw = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint
servant/src/Servant/Types/SourceT.hs+1−33
@@ -89,21 +89,6 @@ instance MFunctor SourceT where
8989 hoist f (SourceT m) = SourceT $ \k -> k $
9090 Effect $ f $ fmap (hoist f) $ m return
9191
92−-- | >>> source "xy" <> source "z" :: SourceT Identity Char
93−-- fromStepT (Effect (Identity (Yield 'x' (Yield 'y' (Yield 'z' Stop)))))
94−--
95−instance Functor m => Semigroup (SourceT m a) where
96− SourceT withL <> SourceT withR = SourceT $ \ret ->
97− withL $ \l ->
98− withR $ \r ->
99− ret $ l <> r
100−
101−-- | >>> mempty :: SourceT Maybe Int
102−-- fromStepT (Effect (Just Stop))
103−instance Functor m => Monoid (SourceT m a) where
104− mempty = fromStepT mempty
105− mappend = (<>)
106−
10792-- | Doesn't generate 'Error' constructors. 'SourceT' doesn't shrink.
10893instance (QC.Arbitrary a, Monad m) => QC.Arbitrary (SourceT m a) where
10994 arbitrary = fromStepT <$> QC.arbitrary
@@ -165,23 +150,6 @@ instance MFunctor StepT where
165150 go (Yield x s) = Yield x (go s)
166151 go (Effect ms) = Effect (f (fmap go ms))
167152
168−instance Functor m => Semigroup (StepT m a) where
169− Stop <> r = r
170− Error err <> _ = Error err
171− Skip s <> r = Skip (s <> r)
172− Yield x s <> r = Yield x (s <> r)
173− Effect ms <> r = Effect ((<> r) <$> ms)
174−
175−-- | >>> mempty :: StepT [] Int
176−-- Stop
177−--
178−-- >>> mempty :: StepT Identity Int
179−-- Stop
180−--
181−instance Functor m => Monoid (StepT m a) where
182− mempty = Stop
183− mappend = (<>)
184−
185153-- | Doesn't generate 'Error' constructors.
186154instance (QC.Arbitrary a, Monad m) => QC.Arbitrary (StepT m a) where
187155 arbitrary = QC.sized arb where
@@ -319,7 +287,7 @@ fromActionStep stop action = loop where
319287-- | Read file.
320288--
321289-- >>> foreach fail BS.putStr (readFile "servant.cabal")
322−-- cabal-version: 2.2
290+-- cabal-version: >=1.10
323291-- name: servant
324292-- ...
325293--
servant/src/Servant/Utils/Links.hsnew file+6
@@ -0,0 +1,6 @@
1+module Servant.Utils.Links
2+ {-# DEPRECATED "Use Servant.Links." #-}
3+ ( module Servant.Links )
4+ where
5+
6+import Servant.Links
servant/test/Servant/API/ContentTypesSpec.hs+5−29
@@ -1,4 +1,3 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE DataKinds #-}
32{-# LANGUAGE DeriveGeneric #-}
43{-# LANGUAGE MultiParamTypeClasses #-}
@@ -21,7 +20,7 @@ import Data.Either
2120import Data.Function
2221 (on)
2322import Data.List
24− (sortBy)
23+ (maximumBy)
2524import qualified Data.List.NonEmpty as NE
2625import Data.Maybe
2726 (fromJust, isJust, isNothing)
@@ -33,8 +32,6 @@ import Data.String.Conversions
3332import qualified Data.Text as TextS
3433import qualified Data.Text.Encoding as TextSE
3534import qualified Data.Text.Lazy as TextL
36−import Control.Exception
37− (evaluate)
3835import GHC.Generics
3936import Test.Hspec
4037import Test.QuickCheck
@@ -80,15 +77,6 @@ spec = describe "Servant.API.ContentTypes" $ do
8077 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do
8178 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)
8279
83− describe "The NoContent Content-Type type" $ do
84− let p = Proxy :: Proxy '[JSON]
85−
86− it "does not render any content" $
87− allMimeRender p NoContent `shouldSatisfy` (all (BSL8.null . snd))
88−
89− it "evaluates the NoContent value" $
90− evaluate (allMimeRender p (undefined :: NoContent)) `shouldThrow` anyErrorCall
91−
9280 describe "The PlainText Content-Type type" $ do
9381 let p = Proxy :: Proxy PlainText
9482
@@ -146,29 +134,17 @@ spec = describe "Servant.API.ContentTypes" $ do
146134 == Just ("application/json;charset=utf-8", encode x)
147135
148136 it "respects the Accept spec ordering" $ do
149− let highest a b c = last $ sortBy (compare `on` snd)
150−-- when qualities are same, http-media-0.8 picks first; 0.7 last.
151−#if MIN_VERSION_http_media(0,8,0)
152− [ ("text/plain;charset=utf-8", c)
153− , ("application/json;charset=utf-8", b)
154− , ("application/octet-stream", a)
155− ]
156−#else
137+ let highest a b c = maximumBy (compare `on` snd)
157138 [ ("application/octet-stream", a)
158139 , ("application/json;charset=utf-8", b)
159140 , ("text/plain;charset=utf-8", c)
160141 ]
161−#endif
162142 let acceptH a b c = addToAccept (Proxy :: Proxy OctetStream) a $
163− addToAccept (Proxy :: Proxy JSON) b $
164− addToAccept (Proxy :: Proxy PlainText ) c $
165− ""
143+ addToAccept (Proxy :: Proxy JSON) b $
144+ addToAccept (Proxy :: Proxy PlainText ) c ""
166145 let val a b c i = handleAcceptH (Proxy :: Proxy '[OctetStream, JSON, PlainText])
167146 (acceptH a b c) (i :: Int)
168− property $ \a b c i ->
169− let acc = acceptH a b c
170− in counterexample (show acc) $
171− fst (fromJust $ val a b c i) === fst (highest a b c)
147+ property $ \a b c i -> fst (fromJust $ val a b c i) == fst (highest a b c)
172148
173149 describe "handleCTypeH" $ do
174150
servant/test/Servant/API/StreamSpec.hs+1−1
@@ -90,7 +90,7 @@ runRenderFrames :: (SourceT Identity a -> SourceT Identity LBS.ByteString) -> [a
9090runRenderFrames f = fmap mconcat . runExcept . runSourceT . f . source
9191
9292runUnrenderFrames :: (SourceT Identity b -> SourceT Identity a) -> [b] -> [Either String a]
93−runUnrenderFrames f = go . Effect . (\x -> unSourceT x return) . f . source where
93+runUnrenderFrames f = go . Effect . flip unSourceT return . f . source where
9494 go :: StepT Identity a -> [Either String a]
9595 go Stop = []
9696 go (Error err) = [Left err]
servant/test/Servant/LinksSpec.hs+1−18
@@ -13,9 +13,9 @@ import Test.Hspec
1313 (Expectation, Spec, describe, it, shouldBe)
1414
1515import Servant.API
16−import Servant.Links
1716import Servant.Test.ComprehensiveAPI
1817 (comprehensiveAPIWithoutRaw)
18+import Servant.Links
1919
2020type TestApi =
2121 -- Capture and query params
@@ -26,12 +26,6 @@ type TestApi =
2626 -- Flags
2727 :<|> "balls" :> QueryFlag "bouncy" :> QueryFlag "fast" :> Delete '[JSON] NoContent
2828
29− -- Fragment
30− :<|> "say" :> Fragment String :> Get '[JSON] NoContent
31−
32− -- UVerb
33− :<|> "uverb-example" :> UVerb 'GET '[JSON] '[WithStatus 200 NoContent]
34−
3529 -- All of the verbs
3630 :<|> "get" :> Get '[JSON] NoContent
3731 :<|> "put" :> Put '[JSON] NoContent
@@ -76,20 +70,12 @@ spec = describe "Servant.Links" $ do
7670 ["roads", "lead", "to", "rome"]
7771 `shouldBeLink` "all/roads/lead/to/rome"
7872
79− it "generated correct links for UVerbs" $ do
80− apiLink (Proxy :: Proxy ("uverb-example" :> UVerb 'GET '[JSON] '[WithStatus 200 NoContent]))
81− `shouldBeLink` "uverb-example"
82−
8373 it "generates correct links for query flags" $ do
8474 let l1 = Proxy :: Proxy ("balls" :> QueryFlag "bouncy"
8575 :> QueryFlag "fast" :> Delete '[JSON] NoContent)
8676 apiLink l1 True True `shouldBeLink` "balls?bouncy&fast"
8777 apiLink l1 False True `shouldBeLink` "balls?fast"
8878
89− it "generates correct link for fragment" $ do
90− let l1 = Proxy :: Proxy ("say" :> Fragment String :> Get '[JSON] NoContent)
91− apiLink l1 "something" `shouldBeLink` "say#something"
92−
9379 it "generates correct links for all of the verbs" $ do
9480 apiLink (Proxy :: Proxy ("get" :> Get '[JSON] NoContent)) `shouldBeLink` "get"
9581 apiLink (Proxy :: Proxy ("put" :> Put '[JSON] NoContent)) `shouldBeLink` "put"
@@ -106,9 +92,6 @@ spec = describe "Servant.Links" $ do
10692 let firstLink :<|> _ = allLinks comprehensiveAPIWithoutRaw
10793 firstLink `shouldBeLink` ""
10894
109−-- The doctests below aren't run on CI, setting that up is tricky.
110−-- They are run by makefile rule, however.
111−
11295-- |
11396-- Before https://github.com/CRogers/should-not-typecheck/issues/5 is fixed,
11497-- we'll just use doctest
servant/test/doctests.hsnew file+27
@@ -0,0 +1,27 @@
1+-----------------------------------------------------------------------------
2+-- |
3+-- Module : Main (doctests)
4+-- Copyright : (C) 2012-14 Edward Kmett
5+-- License : BSD-style (see the file LICENSE)
6+-- Maintainer : Edward Kmett <ekmett@gmail.com>
7+-- Stability : provisional
8+-- Portability : portable
9+--
10+-- This module provides doctests for a project based on the actual versions
11+-- of the packages it was built with. It requires a corresponding Setup.lhs
12+-- to be added to the project
13+-----------------------------------------------------------------------------
14+module Main where
15+
16+import Build_doctests
17+ (flags, module_sources, pkgs)
18+import Data.Foldable
19+ (traverse_)
20+import Test.DocTest
21+
22+main :: IO ()
23+main = do
24+ traverse_ putStrLn args
25+ doctest args
26+ where
27+ args = flags ++ pkgs ++ module_sources
stack.yaml+17−5
@@ -1,20 +1,32 @@
1−resolver: lts-18.5
1+# Let's try to keep resolver at the first day of the month
2+resolver: nightly-2018-09-28 # Last nightly with GHC-8.4.3
23packages:
3−- servant-client-core/
44- servant-client/
5+- servant-client-core/
56- servant-docs/
67- servant-foreign/
7−- servant-http-streams/
88- servant-server/
99- servant/
1010
1111- servant-conduit
1212- servant-machines/
1313- servant-pipes/
14−- servant-swagger/
1514
1615# allow-newer: true # ignores all bounds, that's a sledgehammer
1716# - doc/tutorial/
1817
1918extra-deps:
20−- hspec-wai-0.10.1
19+- base-compat-0.10.5
20+- conduit-1.3.1
21+- hspec-2.6.0
22+- hspec-core-2.6.0
23+- hspec-discover-2.6.0
24+- http-api-data-0.4
25+- http-media-0.7.1.3
26+- network-2.8.0.0
27+- pipes-safe-2.3.1
28+- QuickCheck-2.12.6.1
29+- resourcet-1.2.2
30+- sop-core-0.4.0.0
31+- wai-extra-3.0.24.3
32+- tasty-1.1.0.4
stack.yaml.lockdeleted−19
@@ -1,19 +0,0 @@
1−# This file was autogenerated by Stack.
2−# You should not edit this file by hand.
3−# For more information, please see the documentation at:
4−# https://docs.haskellstack.org/en/stable/lock_files
5−
6−packages:
7−- completed:
8− hackage: hspec-wai-0.10.1@sha256:56dd9ec1d56f47ef1946f71f7cbf070e4c285f718cac1b158400ae5e7172ef47,2290
9− pantry-tree:
10− size: 809
11− sha256: 17af1c2e709cd84bfda066b9ebb04cdde7f92660c51a1f7401a1e9f766524e93
12− original:
13− hackage: hspec-wai-0.10.1
14−snapshots:
15−- completed:
16− size: 585817
17− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/5.yaml
18− sha256: 22d24d0dacad9c1450b9a174c28d203f9bb482a2a8da9710a2f2a9f4afee2887
19− original: lts-18.5