mate

README

Mate 🧉

Mate is a simple, lightweight, fast an zero-dependency web server with batteries included http server.

Getting Started 🚀

Installation 📦

go get github.com/damianpumar/mate

Usage 🏃‍♀️

package main

import (
	"errors"
	"flag"
	"time"

	"github.com/damianpumar/mate"
	"github.com/damianpumar/mate/database"
)

type Example struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

var (
	port = flag.String("port", "8080", "Port to listen on")
)

func main() {
	flag.Parse()

	server := mate.New()

	db := database.Connect()

	cookie := mate.NewSecureCookie("my-secret")

	server.Get("/cookie", mate.LoggingMiddleware(func(c *mate.Context) {
		if err := cookie.SetEncryptedCookie(c.Response, "session", "user12345", 30*time.Second); err != nil {

			c.Error(500, err)

			return
		}

		c.Text(200, "Cookie set")
	}))

	server.Get("/read-cookie", mate.LoggingMiddleware(func(c *mate.Context) {
		value, err := cookie.GetEncryptedCookie(c.Request.Request, "session")

		if err != nil {
			c.Error(500, err)

			return
		}

		c.Text(200, value)
	}))

	server.Get("/delete-cookie", mate.LoggingMiddleware(func(c *mate.Context) {
		cookie.ClearCookie(c.Response, "session")
		c.Response.Text(200, "Cookie deleted")
	}))

	server.Get("/", mate.LoggingMiddleware(func(c *mate.Context) {
		data := db.Select("users")

		c.JSON(200, data)
	}))

	server.Get("/{id}", func(c *mate.Context) {
		id := c.GetPathValue("id")

		data, ok := db.SelectById("users", id)

		if !ok {
			c.Error(404, errors.New("User not found"))
		}

		c.JSON(200, data)
	})

	server.Post("/", func(c *mate.Context) {
		data := Example{}

		c.BindBody(&data)

		db.Insert("users", data)

		c.JSON(200, data)
	})

	server.Put("/{id}", func(c *mate.Context) {
		id := c.GetPathValue("id")

		data := Example{}

		c.BindBody(&data)

		if ok := db.Update("users", id, data); !ok {
			c.Status(404)

			return
		}

		c.JSON(200, data)
	})

	server.Delete("/{id}", func(c *mate.Context) {
		id := c.GetPathValue("id")

		if ok := db.Delete("users", id); !ok {
			c.Status(404)

			return
		}

		c.Text(200, "Deleted")
	})

	server.Group("/hello", func(g *mate.Group) {
		g.Get("/world", func(c *mate.Context) {
			c.Text(200, "Hello, World!")
		})
	})

	server.Get("/template", func(c *mate.Context) {
		c.Render(200, "index.html", &Example{
			Id:   "1",
			Name: "Damián",
		})
	})

	server.Folder("/static", "./static")
	server.File("/json", "./static/hello.json")

	server.Start(*port)
}

Running the server 🚀

go run main.go

License 📄

MIT

Documentation

Index

• type Context
  • func NewContext(w http.ResponseWriter, r *http.Request) *Context
  • func (c *Context) BindBody(data interface{}) error
  • func (c *Context) Error(status int, err error)
  • func (c *Context) GetPathValue(key string) string
  • func (c *Context) GetQueryParam(key string) string
  • func (c *Context) JSON(status int, data interface{})
  • func (c *Context) Render(status int, template string, data interface{})
  • func (c *Context) Status(status int)
  • func (c *Context) Text(status int, text string)
• type Group
  • func (g *Group) Delete(path string, handler HandlerFunc)
  • func (g *Group) File(path string, file string)
  • func (g *Group) Folder(path string, dir string)
  • func (g *Group) Get(path string, handler HandlerFunc)
  • func (g *Group) Patch(path string, handler HandlerFunc)
  • func (g *Group) Post(path string, handler HandlerFunc)
  • func (g *Group) Put(path string, handler HandlerFunc)
• type HandlerFunc
  • func LoggingMiddleware(next HandlerFunc) HandlerFunc
• type Middleware
• type Request
  • func (r *Request) BindBody(data interface{}) error
  • func (r *Request) GetPathValue(key string) string
  • func (r *Request) GetQueryParam(key string) string
• type Response
  • func (r *Response) Error(status int, err error)
  • func (r *Response) JSON(status int, data interface{})
  • func (r *Response) Render(status int, file string, data interface{})
  • func (r *Response) Status(status int)
  • func (r *Response) Text(status int, message string)
• type Router
  • func NewRouter() *Router
  • func (r *Router) Delete(path string, handler func(c *Context))
  • func (r *Router) File(path string, file string)
  • func (r *Router) Folder(path string, dir string)
  • func (r *Router) Get(path string, handler func(c *Context))
  • func (r *Router) Patch(path string, handler func(c *Context))
  • func (r *Router) Post(path string, handler func(c *Context))
  • func (r *Router) Put(path string, handler func(c *Context))
  • func (s *Router) Routes() *http.ServeMux
  • func (r *Router) ServeHTTP(res http.ResponseWriter, req *http.Request)
• type SecureCookie
  • func NewSecureCookie(key string) *SecureCookie
  • func (sc *SecureCookie) ClearCookie(w http.ResponseWriter, name string)
  • func (sc *SecureCookie) GetEncryptedCookie(req *http.Request, name string) (string, error)
  • func (sc *SecureCookie) HasCookie(req *http.Request, name string) bool
  • func (sc *SecureCookie) SetEncryptedCookie(w http.ResponseWriter, name, value string, expiry time.Duration) error
• type Server
  • func New() *Server
  • func (s *Server) Delete(path string, handler HandlerFunc)
  • func (s *Server) File(path string, file string)
  • func (s *Server) Folder(path string, dir string)
  • func (s *Server) Get(path string, handler HandlerFunc)
  • func (s *Server) Group(path string, group func(r *Group))
  • func (s *Server) Patch(path string, handler HandlerFunc)
  • func (s *Server) Post(path string, handler HandlerFunc)
  • func (s *Server) Put(path string, handler HandlerFunc)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Start(port string)

Types

type Context

type Context struct {
	Response *Response
	Request  *Request
}

func NewContext

func NewContext(w http.ResponseWriter, r *http.Request) *Context

func (*Context) BindBody

func (c *Context) BindBody(data interface{}) error

func (*Context) Error

func (c *Context) Error(status int, err error)

func (*Context) GetPathValue

func (c *Context) GetPathValue(key string) string

func (*Context) GetQueryParam

func (c *Context) GetQueryParam(key string) string

func (*Context) JSON

func (c *Context) JSON(status int, data interface{})

func (*Context) Render

func (c *Context) Render(status int, template string, data interface{})

func (*Context) Status

func (c *Context) Status(status int)

func (*Context) Text

func (c *Context) Text(status int, text string)

type Group

type Group struct {
	// contains filtered or unexported fields
}

func (*Group) Delete

func (g *Group) Delete(path string, handler HandlerFunc)

func (*Group) File

func (g *Group) File(path string, file string)

func (*Group) Folder

func (g *Group) Folder(path string, dir string)

func (*Group) Get

func (g *Group) Get(path string, handler HandlerFunc)

func (*Group) Patch

func (g *Group) Patch(path string, handler HandlerFunc)

func (*Group) Post

func (g *Group) Post(path string, handler HandlerFunc)

func (*Group) Put

func (g *Group) Put(path string, handler HandlerFunc)

type HandlerFunc

type HandlerFunc func(c *Context)

func LoggingMiddleware

func LoggingMiddleware(next HandlerFunc) HandlerFunc

type Middleware

type Middleware func(HandlerFunc) HandlerFunc

type Request

type Request struct {
	*http.Request
}

func (*Request) BindBody

func (r *Request) BindBody(data interface{}) error

func (*Request) GetPathValue

func (r *Request) GetPathValue(key string) string

func (*Request) GetQueryParam

func (r *Request) GetQueryParam(key string) string

type Response

type Response struct {
	http.ResponseWriter
}

func (*Response) Error

func (r *Response) Error(status int, err error)

func (*Response) JSON

func (r *Response) JSON(status int, data interface{})

func (*Response) Render

func (r *Response) Render(status int, file string, data interface{})

func (*Response) Status

func (r *Response) Status(status int)

func (*Response) Text

func (r *Response) Text(status int, message string)

type Router

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter() *Router

func (*Router) Delete

func (r *Router) Delete(path string, handler func(c *Context))

func (*Router) File

func (r *Router) File(path string, file string)

func (*Router) Folder

func (r *Router) Folder(path string, dir string)

func (*Router) Get

func (r *Router) Get(path string, handler func(c *Context))

func (*Router) Patch

func (r *Router) Patch(path string, handler func(c *Context))

func (*Router) Post

func (r *Router) Post(path string, handler func(c *Context))

func (*Router) Put

func (r *Router) Put(path string, handler func(c *Context))

func (*Router) Routes

func (s *Router) Routes() *http.ServeMux

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(res http.ResponseWriter, req *http.Request)

type SecureCookie

type SecureCookie struct {
	// contains filtered or unexported fields
}

func NewSecureCookie

func NewSecureCookie(key string) *SecureCookie

func (*SecureCookie) ClearCookie

func (sc *SecureCookie) ClearCookie(w http.ResponseWriter, name string)

func (*SecureCookie) GetEncryptedCookie

func (sc *SecureCookie) GetEncryptedCookie(req *http.Request, name string) (string, error)

func (*SecureCookie) HasCookie

func (sc *SecureCookie) HasCookie(req *http.Request, name string) bool

func (*SecureCookie) SetEncryptedCookie

func (sc *SecureCookie) SetEncryptedCookie(w http.ResponseWriter, name, value string, expiry time.Duration) error

type Server

type Server struct {
	// contains filtered or unexported fields
}

func New

func New() *Server

func (*Server) Delete

func (s *Server) Delete(path string, handler HandlerFunc)

func (*Server) File

func (s *Server) File(path string, file string)

func (*Server) Folder

func (s *Server) Folder(path string, dir string)

func (*Server) Get

func (s *Server) Get(path string, handler HandlerFunc)

func (*Server) Group

func (s *Server) Group(path string, group func(r *Group))

func (*Server) Patch

func (s *Server) Patch(path string, handler HandlerFunc)

func (*Server) Post

func (s *Server) Post(path string, handler HandlerFunc)

func (*Server) Put

func (s *Server) Put(path string, handler HandlerFunc)

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Start

func (s *Server) Start(port string)