Destroy a list of go lint errors.

Author: aarondl

README.md

@@ -48,10 +48,10 @@ The amount of code necessary to start and configure authboss is fairly minimal,
 your storer, cookie storer, session storer, xsrf maker implementations.
 
 ```go
-authboss.Cfg = authboss.NewConfig()
-// Do all configuration here
-authboss.MountPath = "/authboss"
-authboss.LogWriter = os.Stdout
+// Do all configuration here (authboss.Cfg is a global
+// config created automatically at runtime)
+authboss.Cfg.MountPath = "/authboss"
+authboss.Cfg.LogWriter = os.Stdout
 
 if err := authboss.Init(); err != nil {
 	// Handle error, don't let program continue to run
@@ -413,4 +413,4 @@ Recover Email (txt)       | recover_email.txt.tpl
 - [Login](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/login.html.tpl)
 - [Recover](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/recover.html.tpl)
 - [Recover New Password](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/recover_complete.html.tpl)
-- [Register](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/register.html.tpl)
+- [Register](https://github.com/go-authboss/authboss-sample/blob/master/ab_views/register.html.tpl)

auth/auth.go

@@ -22,13 +22,15 @@ func init() {
 	authboss.RegisterModule("auth", &Auth{})
 }
 
+// Auth module
 type Auth struct {
 	templates render.Templates
 }
 
+// Initialize module
 func (a *Auth) Initialize() (err error) {
 	if authboss.Cfg.Storer == nil {
-		return errors.New("auth: Need a Storer.")
+		return errors.New("auth: Need a Storer")
 	}
 
 	if len(authboss.Cfg.XSRFName) == 0 {
@@ -47,13 +49,15 @@ func (a *Auth) Initialize() (err error) {
 	return nil
 }
 
+// Routes for the module
 func (a *Auth) Routes() authboss.RouteTable {
 	return authboss.RouteTable{
 		"/login":  a.loginHandlerFunc,
 		"/logout": a.logoutHandlerFunc,
 	}
 }
 
+// Storage requirements
 func (a *Auth) Storage() authboss.StorageOptions {
 	return authboss.StorageOptions{
 		authboss.Cfg.PrimaryID: authboss.String,

callbacks.go

@@ -82,6 +82,7 @@ type Callbacks struct {
 }
 
 // NewCallbacks creates a new set of before and after callbacks.
+// Called only by authboss internals and for testing.
 func NewCallbacks() *Callbacks {
 	return &Callbacks{
 		make(map[Event][]Before),

client_storer.go

@@ -5,7 +5,7 @@ import "net/http"
 const (
 	// SessionKey is the primarily used key by authboss.
 	SessionKey = "uid"
-	// HalfAuthKey is used for sessions that have been authenticated by
+	// SessionHalfAuthKey is used for sessions that have been authenticated by
 	// the remember module. This serves as a way to force full authentication
 	// by denying half-authed users acccess to sensitive areas.
 	SessionHalfAuthKey = "halfauth"

config.go

@@ -119,6 +119,8 @@ type Config struct {
 
 // NewConfig creates a config full of healthy default values.
 // Notable exceptions to default values are the Storers.
+// This method is called automatically on startup and is set to authboss.Cfg
+// so implementers need not call it. Primarily exported for testing.
 func NewConfig() *Config {
 	return &Config{
 		MountPath:  "/",

confirm/confirm.go

@@ -15,6 +15,7 @@ import (
 	"gopkg.in/authboss.v0/internal/render"
 )
 
+// Storer and FormValue constants
 const (
 	StoreConfirmToken = "confirm_token"
 	StoreConfirmed    = "confirmed"
@@ -43,16 +44,18 @@ func init() {
 	authboss.RegisterModule("confirm", &Confirm{})
 }
 
+// Confirm module
 type Confirm struct {
 	emailHTMLTemplates render.Templates
 	emailTextTemplates render.Templates
 }
 
+// Initialize the module
 func (c *Confirm) Initialize() (err error) {
 	var ok bool
 	storer, ok := authboss.Cfg.Storer.(ConfirmStorer)
 	if storer == nil || !ok {
-		return errors.New("confirm: Need a ConfirmStorer.")
+		return errors.New("confirm: Need a ConfirmStorer")
 	}
 
 	c.emailHTMLTemplates, err = render.LoadTemplates(authboss.Cfg.LayoutHTMLEmail, authboss.Cfg.ViewsPath, tplConfirmHTML)
@@ -64,27 +67,29 @@ func (c *Confirm) Initialize() (err error) {
 		return err
 	}
 
-	authboss.Cfg.Callbacks.Before(authboss.EventGet, c.BeforeGet)
-	authboss.Cfg.Callbacks.Before(authboss.EventAuth, c.BeforeGet)
-	authboss.Cfg.Callbacks.After(authboss.EventRegister, c.AfterRegister)
+	authboss.Cfg.Callbacks.Before(authboss.EventGet, c.beforeGet)
+	authboss.Cfg.Callbacks.Before(authboss.EventAuth, c.beforeGet)
+	authboss.Cfg.Callbacks.After(authboss.EventRegister, c.afterRegister)
 
 	return nil
 }
 
+// Routes for the module
 func (c *Confirm) Routes() authboss.RouteTable {
 	return authboss.RouteTable{
 		"/confirm": c.confirmHandler,
 	}
 }
 
+// Storage requirements
 func (c *Confirm) Storage() authboss.StorageOptions {
 	return authboss.StorageOptions{
 		StoreConfirmToken: authboss.String,
 		StoreConfirmed:    authboss.Bool,
 	}
 }
 
-func (c *Confirm) BeforeGet(ctx *authboss.Context) (authboss.Interrupt, error) {
+func (c *Confirm) beforeGet(ctx *authboss.Context) (authboss.Interrupt, error) {
 	if confirmed, err := ctx.User.BoolErr(StoreConfirmed); err != nil {
 		return authboss.InterruptNone, err
 	} else if !confirmed {
@@ -95,7 +100,7 @@ func (c *Confirm) BeforeGet(ctx *authboss.Context) (authboss.Interrupt, error) {
 }
 
 // AfterRegister ensures the account is not activated.
-func (c *Confirm) AfterRegister(ctx *authboss.Context) error {
+func (c *Confirm) afterRegister(ctx *authboss.Context) error {
 	if ctx.User == nil {
 		return errUserMissing
 	}

confirm/confirm_test.go

@@ -73,15 +73,15 @@ func TestConfirm_BeforeGet(t *testing.T) {
 	c := setup()
 	ctx := authboss.NewContext()
 
-	if _, err := c.BeforeGet(ctx); err == nil {
+	if _, err := c.beforeGet(ctx); err == nil {
 		t.Error("Should stop the get due to attribute missing:", err)
 	}
 
 	ctx.User = authboss.Attributes{
 		StoreConfirmed: false,
 	}
 
-	if interrupt, err := c.BeforeGet(ctx); interrupt != authboss.InterruptAccountNotConfirmed {
+	if interrupt, err := c.beforeGet(ctx); interrupt != authboss.InterruptAccountNotConfirmed {
 		t.Error("Should stop the get due to non-confirm:", interrupt)
 	} else if err != nil {
 		t.Error(err)
@@ -91,7 +91,7 @@ func TestConfirm_BeforeGet(t *testing.T) {
 		StoreConfirmed: true,
 	}
 
-	if interrupt, err := c.BeforeGet(ctx); interrupt != authboss.InterruptNone || err != nil {
+	if interrupt, err := c.beforeGet(ctx); interrupt != authboss.InterruptNone || err != nil {
 		t.Error(interrupt, err)
 	}
 }
@@ -111,18 +111,18 @@ func TestConfirm_AfterRegister(t *testing.T) {
 		sentEmail = true
 	}
 
-	if err := c.AfterRegister(ctx); err != errUserMissing {
+	if err := c.afterRegister(ctx); err != errUserMissing {
 		t.Error("Expected it to die with user error:", err)
 	}
 
 	ctx.User = authboss.Attributes{authboss.Cfg.PrimaryID: "username"}
-	if err := c.AfterRegister(ctx); err == nil || err.(authboss.AttributeErr).Name != "email" {
+	if err := c.afterRegister(ctx); err == nil || err.(authboss.AttributeErr).Name != "email" {
 		t.Error("Expected it to die with e-mail address error:", err)
 	}
 
 	ctx.User[authboss.StoreEmail] = "a@a.com"
 	log.Reset()
-	c.AfterRegister(ctx)
+	c.afterRegister(ctx)
 	if str := log.String(); !strings.Contains(str, "Subject: Confirm New Account") {
 		t.Error("Expected it to send an e-mail:", str)
 	}

context.go

@@ -9,6 +9,7 @@ import (
 	"time"
 )
 
+// FormValue constants
 var (
 	FormValueRedirect    = "redir"
 	FormValueOAuth2State = "state"
@@ -26,6 +27,7 @@ type Context struct {
 	formValues     map[string][]string
 }
 
+// NewContext is exported for testing modules.
 func NewContext() *Context {
 	return &Context{}
 }
@@ -76,7 +78,7 @@ func (c *Context) FirstPostFormValue(key string) (string, bool) {
 	return val[0], ok
 }
 
-// FirstFormValueErrr gets the first form value from a context created with a request
+// FirstFormValueErr gets the first form value from a context created with a request
 // and additionally returns an error not a bool if it's not found.
 func (c *Context) FirstFormValueErr(key string) (string, error) {
 	val, ok := c.formValues[key]
@@ -88,7 +90,7 @@ func (c *Context) FirstFormValueErr(key string) (string, error) {
 	return val[0], nil
 }
 
-// FirstPostFormValue gets the first form value from a context created with a request.
+// FirstPostFormValueErr gets the first form value from a context created with a request.
 func (c *Context) FirstPostFormValueErr(key string) (string, error) {
 	val, ok := c.postFormValues[key]
 

errors.go

@@ -10,7 +10,9 @@ type AttributeErr struct {
 	GotKind  string
 }
 
-func MakeAttributeErr(name string, kind DataType, val interface{}) AttributeErr {
+// NewAttributeErr creates a new attribute err type. Useful for when you want
+// to have a type mismatch error.
+func NewAttributeErr(name string, kind DataType, val interface{}) AttributeErr {
 	return AttributeErr{
 		Name:     name,
 		WantKind: kind,

errors_test.go

@@ -7,7 +7,7 @@ import (
 
 func TestAttributeErr(t *testing.T) {
 	estr := "Failed to retrieve database attribute, type was wrong: lol (want: String, got: int)"
-	if str := MakeAttributeErr("lol", String, 5).Error(); str != estr {
+	if str := NewAttributeErr("lol", String, 5).Error(); str != estr {
 		t.Error("Error was wrong:", str)
 	}