Capstan is a Golang web framework that shares some similarities with others in its segment.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Benjamin Shelton 237c9f6ce6 Merge remote-tracking branch 'refs/remotes/origin/master' into master 2 days ago
auth Replaced KeyStar references with cryptohelper, which has been split out 1 week ago
cmd/demos Re-homed project and most declared dependencies. 5 months ago
config KeyStar was moved. 5 months ago
docs Update docs path. 5 months ago
errors Re-homed project and most declared dependencies. 5 months ago
extension Replaced KeyStar references with cryptohelper, which has been split out 1 week ago
fixtures/templates Added zipped fixture. 10 months ago
internal/sys Moved UID checks into an internal package. Not for use outside Capstan. 6 months ago
mappers Re-homed project and most declared dependencies. 5 months ago
middleware Re-homed project and most declared dependencies. 5 months ago
render Added TODO notes for theme support and correct VFS for theming. See 3 months ago
session Replaced KeyStar references with cryptohelper, which has been split out 1 week ago
status Re-homed project and most declared dependencies. 5 months ago
tests Replaced KeyStar references with cryptohelper, which has been split out 1 week ago
utils More contemplation. 3 months ago
vfs Re-homed project and most declared dependencies. 5 months ago
.gitignore Ignore any .pid files generated by test binaries. 8 months ago
LICENSE New year. 6 months ago
Makefile Added integration build tag. 6 months ago
README.md Corrected mistake in README. 5 months ago
api.go Update context API. 5 months ago
application.go Added real IP support. See more. 5 months ago
capstan_test.go Split integration tests into their own files and outside of root. 6 months ago
context.go Okay, the actual underlying mistake was pretty stupid, which made it 2 months ago
extension.go Moved routing files into base package. 6 months ago
funcs.go Actually honor the BasePath configuration. 5 months ago
go.mod Merge remote-tracking branch 'refs/remotes/origin/master' into master 2 days ago
go.sum Dependency updates. 9 months ago
http.go Moved routing files into base package. 6 months ago
netlisten_unix.go Moved routing files into base package. 6 months ago
netlisten_windows.go Moved routing files into base package. 6 months ago
network.go Moved routing files into base package. 6 months ago
network_unix.go Moved routing files into base package. 6 months ago
network_windows.go Moved routing files into base package. 6 months ago
proxy.go Add muxer. 4 months ago
route.go Log context errors if present. 3 months ago
router.go Ignore context errors related to the remote host prematurely closing the 5 months ago
router_bind.go Re-homed project and most declared dependencies. 5 months ago
router_listen.go Re-homed project and most declared dependencies. 5 months ago
router_private.go Moved routing files into base package. 6 months ago
router_trie.go Moved routing files into base package. 6 months ago
router_utils.go Moved routing files into base package. 6 months ago
routergroup.go Actually honor the BasePath configuration. 5 months ago
service.go Moved routing files into base package. 6 months ago
types.go Re-homed project and most declared dependencies. 5 months ago
urls.go Re-homed project and most declared dependencies. 5 months ago
urls_test.go Re-homed project and most declared dependencies. 5 months ago
vfs.go Moved routing files into base package. 6 months ago

README.md

Capstan: A Convenience Glue Framework for Golang

Capstan is a framework that aims to simplify complex use cases that reach beyond basic HTTP handlers, such as dependency management, and reduces the amount of code required as handlers grow and evolve beyond what is possible with the standard library. It provides helpers for common (and not so common) tasks, including graceful shutdowns, rebinding mount points, and more. Capstan uses go-chi for its route muxer. Philosophically, Capstan is inspired in part by Flask and Flask-Classy.

Capstan is not for you if you require handlers that retain compatibility with net/http. Though this could (and arguably should) be rememdied by using the context package, there are no plans currently to reimplement Capstan in this fashion. Be ware! The Capstan API may appear simple at first blush, but it has a depth and complexity that may not be viable for all projects. If you need a simple API server, consider using go-chi directly.

Bear in mind that the project is still very much in its infancy, and APIs are subject to change. There are numerous rough patches and sharp objects in the code.

Features

Capstan's implementation comprises these features (and some anti-features):

  • Controller-centric MVC. At present, it's largely “VC” as there is no defined model implementation. Capstan is very much “bring your own model.”
  • Requests are designed to call method-named functions per controller per path. This means that individual functions are named after and define an HTTP verb, such as Get or Post. Controllers therefore should be highly focused to a single endpoint. (This isn't strictly necessary; see below.)
  • Custom methods can be defined by implementing either the Binder interface, MapperHandler interface (work-in-progress), or by naming functions according to the pattern <Method><Name><SlashState>. This will become clearer later in the documentation once it's written.
  • Multiple renderers are supported through the Templater interface. We primarily encourage the use of pongo2 but provide wrappers for Go's built in template rendering library. (Note: Using anything but pongo2 may limit features available to templates, and using multiple template types in a single project will present unique challenges and difficulties that, while not insurmountable, are unnecessary and will be frought with sleepless nights.)
  • Renderers may be defined globally or per-controller. If a renderer is defined globally, all controller bindings that don't define a renderer will use the global one by default.
  • Capstan's pongo2 wrappers can make use of our VFS layer that integrates with Embedder for embedding assets into the compiled binary. The template engine is therefore capable of reading templates and other assets directly from disk or the binary itself. ZIP files are also supported. When combined with VFS, it's possible to layer reads from multiple sources (e.g. the binary, a ZIP file, or the file system).
  • Built-in TLS configuration helpers are provided. ACME support is a work in progress which will allow use of services like Let's Encrypt directly.
  • Capstan can listen on Unix sockets for use with local front end proxies like nginx or HAProxy.
  • Supports remapping endpoints (called “rebinding” in Capstan parlance) without restarting the service. Endpoints may be deleted (Router.Unmount) or renamed (Router.ReplacePath).
  • Optional websocket endpoint handlers as part of the controller semantics.
  • Graceful shutdown and in-place replacement/restart for seamless upgrades. Not presently supported on Windows.
  • URL mapper that exposes URL resolution for templates. In pongo2, this is provided via the functions url() and external(). URLs are typically mapped as [<prefix>.]<name>.<suffix>; for example, if you have a controller IndexController and were accessing its Get method, you would retrieve the mapped URL by calling url("IndexController:get"). Custom url() binding is provided by Router.ManualBind. The <prefix> is dictated by router groups or through manual declaration at controller bind time. Naming conflicts can be resolved during controller initialization manually, by providing a symbolic name for the controller, or automatically through a numeric suffix (e.g. IndexController2).
  • Trailing slashes can be controlled via the ?, ! or + syntax. ? indicates a trailing slash is optional. ! indicates a trailing slash must not be provided (and a 404 is generated). + indicates a trailing slash is mandatory for subroute declarations (but is typically unnecessary). Otherwise, if a route is declared with a trailing slash it is considered mandatory and requests made without the trailing slash will result in a 404. Optional slashes (indicated by a trailing ?) can either have a slash-provided or slash-absent default state; if a ? is immediately preceded by a slash, e.g. /?, a redirection route will be created that directs requests minus the trailing slash to a route that has the trailing slash appended. Likewise, if there is no slash preceding the ?, the redirection route will direct requests with a trailing / to the route without it. You should use optional slash routes sparingly.
  • Typed route variables. This requires a syntax differing slightly from go-chi. Type enforcement is not presently implemented (but likely will be). We use < and > to delineate route variables and deliberately introduce incompatibilities with go-chi to prevent confusion. Variable types are declared with a :<type> suffix, e.g. /path/<name:string>, which would create a parameterized variable of the name name and type string. Regex is passed through to go-chi.
  • Route groups wrap go-chi's groups and provide methods namespacing them from other routes both for url() template function(s) and for isolation.
  • Supports any middleware supported by go-chi and provides slight modifications for middleware supplied by go-chi (such as supporting the NO_COLOR envvar for go-chi's logger).
  • Supports before and after response bindings for cases where middleware may be too low level and where the route context needs to be fully configured prior to or after handling the endpoint.
  • Custom error page support, with context helpers.
  • Extension support that includes a few out-of-the-box extensions, such as CSRF protection and session management. Authentication support is forthcoming.
  • Limited support for privilege reduction; e.g., setting Capstan's RunAs configuration option and running initially as the root user will provoke Capstan into first binding to its configured ports then dropping privileges. This is useful for listening on lower ports, such as port 80 and 443, and although Capstan is fully capable of doing so, it is advisable to use reverse proxies in front of a Capstan application.
  • Open port scanner for automatically picking open ports. Useful for writing installers that need to find a free port in order to start a visual browser-based installer.
  • Additional utilities. See the utils subpackage.

Sample Application

package main

import (
    "git.destrealm.org/go/capstan"
)

type IndexController struct {
    capstan.BaseController
    Server capstan.Server `inject:"app"`
}

func (c *IndexController) Index(ctx capstan.Context) error {
    return ctx.Write([]byte("Hello! Listening on address: "+c.Server.Config().ListenAddress))
}

func main() {
    app := capstan.New(&capstan.ServerConfig{
        ListenAddress: ":8080",
    })

    app.Bind(&IndexController{
        BaseController: capstan.BaseController{
            Path: "/",
        },
    })

    app.Listen()
}