api

type API ¶

type API struct {
	Database db.Database

	List      PolicyList
	DontScan  map[string]bool
	Emailer   EmailSender
	Templates map[string]*template.Template
	// contains filtered or unexported fields
}

API is the HTTP API that this service provides. All requests respond with an response JSON, with fields:

{
    status_code // HTTP status code of request
    message // Any error message accompanying the status_code. If 200, empty.
    response // Response data (as JSON) from this request.
}

Any POST request accepts either URL query parameters or data value parameters, and prefers the latter if both are present.

func (api *API) ParseTemplates(dir string)

func (api *API) RegisterHandlers(mux *http.ServeMux) http.Handler

type EmailSender ¶

type EmailSender interface {
	// SendValidation sends a validation e-mail for a particular domain,
	// with a particular validation token.
	SendValidation(*models.Domain, string) error
}

EmailSender interface wraps a back-end that can send e-mails.

type PolicyList ¶

type PolicyList interface {
	HasDomain(string) bool
	Raw() policy.List
}

PolicyList interface wraps a policy-list like structure. The most important query you can perform is to fetch the policy for a particular domain.