horned_worm

An easy functional Web app micro framework
README

A functional Web app server.

Greatly inspired by Suave.IO and GIRAFFE of F#, this is OCaml implementation.

Web Parts

path

let app =
  path "/hello"
  >=> text "hello, world"

path_ci

let app =
  path_ci "/hello"
  >=> text "hello, world"

path_starts

 let app =
   path_starts "/hello/"
   >=> text "hello, world"

path_starts_ci

let app =
  path_starts_ci "/hello/"
  >=> text "hello, world"

path_regex

let app =
  path_regex "/hello/wo{3}rld"
  >=> text "hello, world"

path_scanf

let app =
  path_scanf "/%d/%d" begin fun x y ->
    text @@ Printf.sprintf "hello, %d" (x + y)
  end

meth

let app =
  meth `GET
  >=> text "hello, world"

filter_p

let app =
  filter_p (fun ctx -> true)
  >=> text "text."

path_p

let app =
  path_p (fun path -> true)
  >=> text "text."

choose

let app =
  choose
    [ meth `GET
      >=> choose
        [ path "/a" >=> text "hello, GET a"
        ; path "/b" >=> text "hello, GET b"
        ]
    ; meth `POST >=> text "hello, POST"
    ]

log

let app =
  log Logs.err (fun ctx m -> m "error message.")
  >=> text "text."

set_mime_type

let app =
  set_mime_type "text/plain; charset=utf-8"
  >=> text "text."

set_status

let app =
  set_status `Bad_request
  >=> text "text."

set_header

let app =
  set_header "x-test" "my test header"
  >=> text "text."

set_header_unless_exists

let app =
  set_header_unless_exists "x-test" "my test header"
  >=> text "text."

add_header

 let app =
   add_header "x-test" "my test header"
   >=> text "text."

use_cookie

let app =
  use_cookie
  >=> text "text."

set_cookie

let app =
  set_cookie "key" "value"
  >=> text "text."

browse

let app =
  browse "/etc"

browse_file

let app =
  browse_file "/etc" "/hosts"

text

let app =
  text "hello, world."

texts

let app =
  texts [ "hello"
        ; ", world."
        ]

json

let app =
  json (`Assoc [ "hello", `String "world"
               ; "key", `Int 1 ])

respond_string

let app =
  respond_string "string"

respond_strings

let app =
  respond_strings [ "string"; "string" ]

respond_file

let app =
  respond_file "/etc/hosts"

simple_cors

let app =
  simple_cors
  >=> text "text."

secure_headers

let app =
  secure_headers
  >=> text "text."

web_server

  • Web_part.t Web app

  • int Listening port

run_web_server

  • app Web_part.t

Simple Web_part.t runner.

Compose your own parts

let yourapp : Web_part.t =
  fun next ctx ->
    (* your work here *)
    if (* should continue *) then
      let modified_ctx = ctx in
      begin
        set_header "a" "b" >=>
        set_header "x" "y"
      end next modified_ctx
    else
      Web_part.fail

How to start

Example:

open Core
open Async
open Horned_worm

let app =
  choose
    [ meth `GET >=> choose
        [ path "/" >=> text "hello, world"
        ; path "/cookie" >=> use_cookie >=> begin
            let key = "test" in
            fun next ctx ->
              let v = Option.value Http_context.(cookie ctx ~key)
                  ~default:"hello cookie" in
              begin
                set_cookie key (v ^ "!") >=>
                text v
              end next ctx
          end
        ; path_scanf "/%d/%d" begin fun x y ->
            text (sprintf "%d + %d = %d" x y (x + y))
          end
        ; path_scanf "/json/%s" begin fun s ->
            json (`Assoc ["hello", `String s])
          end
        ]
    ; meth `POST >=> path "/" >=> text "hello, POST"
    ]

let () =
  run_web_server app

Install

opam install horned_worm

Status

  • alpha

Todo:

  • more predefined Web parts.

  • needs query parm receiver.

  • builtin websocket supports.

Install
Published
07 Nov 2020
Authors
Maintainers
Sources
0.3.7.tar.gz
md5=a0a9d03f4c93bf60e54bdc7911d11c8f
sha512=6ea1b1f65ae05d53d8ba722cc668ef351705f74b7b825ee9a91a06c581d6927d9a8354347fbd117c6cf7d54f7d5df39318258f9c6328c3d66c219403bfd9341c
Dependencies
dune
>= "1.0.1"
yojson
>= "1.6.0"
re
>= "1.7.3"
logs
>= "0.6.2"
cohttp-async
>= "1.0.2" & < "3.0.0"
async
>= "v0.11.0" & < "v0.13.0"
ocaml
>= "4.03.0"
Reverse Dependencies