Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gravityblast/traffic
Sinatra inspired regexp/pattern mux and web framework for Go [NOT MAINTAINED]
https://github.com/gravityblast/traffic
Last synced: about 10 hours ago
JSON representation
Sinatra inspired regexp/pattern mux and web framework for Go [NOT MAINTAINED]
- Host: GitHub
- URL: https://github.com/gravityblast/traffic
- Owner: gravityblast
- License: mit
- Created: 2013-08-09T15:39:44.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T06:25:14.000Z (about 5 years ago)
- Last Synced: 2024-05-30T00:18:16.127Z (5 months ago)
- Language: Go
- Homepage:
- Size: 146 KB
- Stars: 521
- Watchers: 24
- Forks: 34
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Traffic
[](https://travis-ci.org/pilu/traffic)
Package traffic - a Sinatra inspired regexp/pattern mux for [Go](http://golang.org/ "The Go programming language").
## Installation
go get github.com/pilu/traffic
## Features
* [Regexp routing](https://github.com/pilu/traffic/blob/master/examples/simple/main.go)
* [Before Filters](https://github.com/pilu/traffic/blob/master/examples/before-filter/main.go)
* [Custom not found handler](https://github.com/pilu/traffic/blob/master/examples/not-found/main.go)
* [Middlewares](https://github.com/pilu/traffic/blob/master/examples/middleware/main.go)
* Examples: [Airbrake Middleware](https://github.com/pilu/traffic-airbrake), [Chrome Logger Middleware](https://github.com/pilu/traffic-chromelogger)
* [Templates/Views](https://github.com/pilu/traffic/tree/master/examples/templates)
* [Easy Configuration](https://github.com/pilu/traffic/tree/master/examples/configuration)
## Development Features
* [Shows errors and stacktrace in browser](https://github.com/pilu/traffic/tree/master/examples/show-errors)
* [Serves static files](https://github.com/pilu/traffic/tree/master/examples/static-files)
* Project Generator
`development` is the default environment. The above middlewares are loaded only in `development`.
If you want to run your application in `production`, export `TRAFFIC_ENV` with `production` as value.
```bash
TRAFFIC_ENV=production your-executable-name
```
## Installation
Dowload the `Traffic` code:
```bash
go get github.com/pilu/traffic
```
Build the command line tool:
```bash
go get github.com/pilu/traffic/traffic
```
Create a new project:
```bash
traffic new hello
```
Run your project:
```bash
cd hello
go build && ./hello
```
You can use [Fresh](https://github.com/pilu/fresh) if you want to build and restart your application every time you create/modify/delete a file.
## Example:
The following code is a simple example, the documentation in still in development.
For more examples check the `examples` folder.
```go
package main
import (
"net/http"
"github.com/pilu/traffic"
"fmt"
)
func rootHandler(w traffic.ResponseWriter, r *traffic.Request) {
fmt.Fprint(w, "Hello World\n")
}
func pageHandler(w traffic.ResponseWriter, r *traffic.Request) {
params := r.URL.Query()
fmt.Fprintf(w, "Category ID: %s\n", params.Get("category_id"))
fmt.Fprintf(w, "Page ID: %s\n", params.Get("id"))
}
func main() {
router := traffic.New()
// Routes
router.Get("/", rootHandler)
router.Get("/categories/:category_id/pages/:id", pageHandler)
router.Run()
}
```
## Before Filters
You can also add "before filters" to all your routes or just to some of them:
```go
router := traffic.New()
// Executed before all handlers
router.AddBeforeFilter(checkApiKey).
AddBeforeFilter(addAppNameHeader).
AddBeforeFilter(addTimeHeader)
// Routes
router.Get("/", rootHandler)
router.Get("/categories/:category_id/pages/:id", pageHandler)
// "/private" has one more before filter that checks for a second api key (private_api_key)
router.Get("/private", privatePageHandler).
AddBeforeFilter(checkPrivatePageApiKey)
```
Complete example:
```go
func rootHandler(w traffic.ResponseWriter, r *traffic.Request) {
fmt.Fprint(w, "Hello World\n")
}
func privatePageHandler(w traffic.ResponseWriter, r *traffic.Request) {
fmt.Fprint(w, "Hello Private Page\n")
}
func pageHandler(w traffic.ResponseWriter, r *traffic.Request) {
params := r.URL.Query()
fmt.Fprintf(w, "Category ID: %s\n", params.Get("category_id"))
fmt.Fprintf(w, "Page ID: %s\n", params.Get("id"))
}
func checkApiKey(w traffic.ResponseWriter, r *traffic.Request) {
params := r.URL.Query()
if params.Get("api_key") != "foo" {
w.WriteHeader(http.StatusUnauthorized)
}
}
func checkPrivatePageApiKey(w traffic.ResponseWriter, r *traffic.Request) {
params := r.URL.Query()
if params.Get("private_api_key") != "bar" {
w.WriteHeader(http.StatusUnauthorized)
}
}
func addAppNameHeader(w traffic.ResponseWriter, r *traffic.Request) {
w.Header().Add("X-APP-NAME", "My App")
}
func addTimeHeader(w traffic.ResponseWriter, r *traffic.Request) {
t := fmt.Sprintf("%s", time.Now())
w.Header().Add("X-APP-TIME", t)
}
func main() {
router := traffic.New()
// Routes
router.Get("/", rootHandler)
router.Get("/categories/:category_id/pages/:id", pageHandler)
// "/private" has one more before filter that checks for a second api key (private_api_key)
router.Get("/private", privatePageHandler).
AddBeforeFilter(checkPrivatePageApiKey)
// Executed before all handlers
router.AddBeforeFilter(checkApiKey).
AddBeforeFilter(addAppNameHeader).
AddBeforeFilter(addTimeHeader)
router.Run()
}
```
## Author
* [Andrea Franz](http://gravityblast.com)
## More
* Code:
* Mailing List:
* Chat: