Type-checked Compojure Routes
Clojure
Switch branches/tags
Nothing to show
Latest commit 0f6a93d Nov 6, 2012 @gregspurrier Fix type: s/401/400/.
Permalink
Failed to load latest commit information.
doc
src/checked_route
test/checked_route
.gitignore
HISTORY.md
LICENSE.txt
README.md
project.clj

README.md

checked-route

checked-route allows you to check--e.g., against a schema defined with clj-schema--Compojure route parameters before handing them over to the route's body. Any check failures result in a 400 error being returned to the caller.

For example, consider this Compojure route that expects two parameters, bar and baz:

(POST "/foo" [bar baz] (do-something bar baz))

If bar and baz have check functions check-bar and check-baz, respectively, that return nil on success and error message(s) on failure, then you can use a checked route to enforce them:

(require '[checked-route.route :as checked])
(checked/POST "/foo" [^{:check check-bar} bar ^{:check check-baz} baz]
  (do-something bar baz))

The checked-route.route namespace provides checked versions of Compojure's route macros (GET, PUT, etc.). If no metadata is associated with a checked route's arguments, then the route will have the same behavior as its unchecked equivalent. Adding metadata tags, such as :check, to an argument enables checking of that argument. See the "Recognized Metadata" section below for the supported tags.

Installation via Leiningen

To use checked-route in your project, add the following to the :dependencies section of your project.clj file:

[checked-route "0.1.1"]

Recognized Metadata

The following fields in an argument's metadata affect the checking process:

  • :check -- a function of one argument that will be used to check the route argument. It should return nil when the argument is valid and an error result to return to the caller otherwise. If you are using clj-schema, you can use something like (partial validation-errors my-schema). Defaults to accepting anything.
  • :pre-check-xform -- a function of one argument that will be used to transform its value before checking is performed. Defaults to identity.
  • :pre-check-xform -- a function of one argument that will be used to transform its value after successful checking is performed. Defaults to identity.
  • :required -- whether the parameter is required. Defaults to false.

If pre- or post-check transform functions are provided, the argument's binding for the body of the route will reflect these transformations.

License

Copyright (c) 2012 Greg Spurrier

Decomatic is distributed under the MIT license. Please see LICENSE.txt for the details.