The Spock package

[Tags:bsd3, library, test]

This toolbox provides everything you need to get a quick start into web hacking with haskell:

A tutorial is available at spock.li Full documenation is availale here


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.0.1, 0.4.1.0, 0.4.2.0, 0.4.2.1, 0.4.2.2, 0.4.2.3, 0.4.2.4, 0.4.3.0, 0.4.3.1, 0.4.3.2, 0.4.3.3, 0.4.3.4, 0.4.3.5, 0.4.4.0, 0.4.4.1, 0.5.0.0, 0.5.0.1, 0.5.1.0, 0.6.0.0, 0.6.1.0, 0.6.1.1, 0.6.1.2, 0.6.1.3, 0.6.2.0, 0.6.2.1, 0.6.2.2, 0.6.2.3, 0.6.3.0, 0.6.4.0, 0.6.5.0, 0.6.6.0, 0.6.6.1, 0.7.0.0, 0.7.1.0, 0.7.2.0, 0.7.3.0, 0.7.4.0, 0.7.5.0, 0.7.5.1, 0.7.5.2, 0.7.6.0, 0.7.7.0, 0.7.8.0, 0.7.9.0, 0.7.10.0, 0.7.11.0, 0.7.12.0, 0.8.0.0, 0.8.1.0, 0.9.0.0, 0.9.0.1, 0.10.0.0, 0.10.0.1, 0.11.0.0 (info)
Dependencies base (==4.*), base64-bytestring (>=1.0), bytestring (>=0.10), containers (>=0.5), cryptonite (>=0.6), focus (>=0.1), hashable (>=1.2), http-types (>=0.8), hvect (>=0.3), list-t (>=0.4), monad-control (>=1.0), mtl (>=2.1), reroute (>=0.3.1), resource-pool (>=0.2), resourcet (>=0.4), Spock-core (>=0.11), stm (>=2.4), stm-containers (>=0.2), text (>=0.11.3.1), time (>=1.4), transformers (>=0.3), transformers-base (>=0.4), unordered-containers (>=0.2), vault (>=0.3), wai (>=3.0) [details]
License BSD3
Copyright (c) 2013 - 2016 Alexander Thiemann
Author Alexander Thiemann <mail@athiemann.net>
Maintainer Alexander Thiemann <mail@athiemann.net>
Stability Unknown
Category Web
Home page https://www.spock.li
Bug tracker https://github.com/agrafix/Spock/issues
Source repository head: git clone https://github.com/agrafix/Spock
Uploaded Thu Aug 25 15:37:54 UTC 2016 by AlexanderThiemann
Updated Fri Sep 2 22:17:36 UTC 2016 by AlexanderThiemann to revision 1
Distributions LTSHaskell:0.11.0.0, NixOS:0.11.0.0, Stackage:0.11.0.0, Tumbleweed:0.11.0.0
Downloads 12883 total (327 in the last 30 days)
Votes
4 []
Status Docs available [build log]
Last success reported on 2016-10-25 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for Spock

Readme for Spock-0.11.0.0

Spock

Build Status Hackage

Intro

Hackage: Spock Stackage: Spock

Another Haskell web framework for rapid development

Library Usage Example

{-# LANGUAGE OverloadedStrings #-}
import Web.Spock

import qualified Data.Text as T

main =
    runSpock 3000 $ spockT id $
    do get ("echo" <//> var) $ \something ->
        text $ T.concat ["Echo: ", something]

Install

  • Using cabal: cabal install Spock
  • Using Stack: stack install Spock
  • From Source (cabal): git clone https://github.com/agrafix/Spock.git && cd Spock && cabal install
  • From Source (stack): git clone https://github.com/agrafix/Spock.git && cd Spock && stack build

Mailing list

Please join our mailing list at haskell-spock@googlegroups.com

Features

Another Haskell web framework for rapid development: This toolbox provides everything you need to get a quick start into web hacking with haskell:

  • fast typesafe routing
  • middleware
  • json
  • sessions
  • cookies
  • database helper
  • csrf-protection
  • typesafe contexts

Important Links

Talks

Candy

Extensions

The following Spock extensions exist:

Works well with Spock

SSL / HTTPS

If you'd like to use your application via HTTPS, there are two options:

  • Use nginx/haproxy/... as reverse proxy in front of the Spock application.
  • Convert the Spock application to a wai-application using the spockAsApp. Then use the warp-tls package to run it.

Benchmarks

See the Spock-bench repository to reproduce.

| Framework | GHC | Version | simple route | route with one param | deeply nested route | |-----------|--------|----------|---------------------------|---------------------------|---------------------| | Spock | 7.10.2 | 0.11.0.0 | 69243 | 65835 | 64763 | | scotty | 7.10.2 | 0.10.2 | 66441 | 65357 | 9542 | | snap | 7.10.2 | 0.9.8.0 | 39964 | 35566 | 38356 | | fn | 7.10.2 | 0.2.0.2 | 63083 | 63183 | 22346 | | servant | 7.10.2 | 0.7 | 66041 | 65590 | 64606 |

Example Projects

Notes

Since version 0.11.0.0 Spock drops simple routing in favor of typesafe routing and drops safe actions in favor of the "usual" way of csrf protection with a token.

Since version 0.7.0.0 Spock supports typesafe routing. If you wish to continue using the untyped version of Spock you can Use Web.Spock.Simple. The implementation of the routing is implemented in a separate haskell package called reroute.

Since version 0.5.0.0 Spock is no longer built on top of scotty. The design and interface is still influenced by scotty, but the internal implementation differs from scotty's.

Thanks to

  • Tim Baumann Github (lot's of help with typesafe routing)
  • Tom Nielsen Github (much feedback and small improvements)
  • ... and all other awesome contributors!

Hacking

Pull requests are welcome! Please consider creating an issue beforehand, so we can discuss what you would like to do. Code should be written in a consistent style throughout the project. Avoid whitespace that is sensible to conflicts. (E.g. alignment of = signs in functions definitions) Note that by sending a pull request you agree that your contribution can be released under the BSD3 License as part of the Spock package or related packages.

Misc

Supported GHC Versions

  • 7.8.4
  • 7.10.2
  • 8.0

License

Released under the BSD3 license. (c) 2013 - 2016 Alexander Thiemann