keycheck

Documentation

Index

• Constants
• Variables
• type APIKeyCheckHandler
• type APIKeyCheckMiddleware
  • func NewAPIKeyCheckMiddleware(url string) *APIKeyCheckMiddleware
  • func (s *APIKeyCheckMiddleware) Handler() martini.Handler
• type ClientDoer
• type KeyChecker
  • func New(url string) KeyChecker

Constants

const (
	//AuthFailStatus - failure status code
	AuthFailStatus = 403
	//AuthSuccessStatus - success status code
	AuthSuccessStatus = 200
	//KeyLength - valid length of a api-key
	KeyLength = 36
)

Variables

var (
	//AuthFailureResponse - failure response for invalid key
	AuthFailureResponse = []byte(`{"error": "no valid key found"}`)
)

var (
	HeaderKeyName = "X-API-KEY"
)

Types

type APIKeyCheckHandler

type APIKeyCheckHandler func(log *log.Logger, res http.ResponseWriter, req *http.Request)

APIKeyCheckHandler - type of our handler function

type APIKeyCheckMiddleware

type APIKeyCheckMiddleware struct {
	Keycheck KeyChecker
}

APIKeyCheckMiddleware - our middleware struct

func NewAPIKeyCheckMiddleware

func NewAPIKeyCheckMiddleware(url string) *APIKeyCheckMiddleware

NewAPIKeyCheckMiddleware - creates a new instance of our middleware

func (*APIKeyCheckMiddleware) Handler

func (s *APIKeyCheckMiddleware) Handler() martini.Handler

Handler - returns the handler function as a martini.Handler type

type ClientDoer

type ClientDoer interface {
	Do(req *http.Request) (resp *http.Response, err error)
}

ClientDoer - an interface for a http Client.Do

type KeyChecker

type KeyChecker interface {
	SetClient(ClientDoer)
	Check(string) (res *http.Response, err error)
}

KeyChecker - an interface for something that can check a key

func New

func New(url string) KeyChecker

New - a new keychecker targetted at the given url