Formatted, renamed sample middleware

zetaab · Aug 14, 2014 · 1c94a09 · 1c94a09
1 parent 65694e4
commit 1c94a09
Show file tree

Hide file tree

Showing 13 changed files with 34 additions and 37 deletions.
diff --git a/api_definition_manager.go b/api_definition_manager.go
@@ -27,14 +27,14 @@ type APIDefinition struct {
 		AllowedAuthorizeTypes  []osin.AuthorizeRequestType `bson:"allowed_authorize_types" json:"allowed_authorize_types"`
 		AuthorizeLoginRedirect string                      `bson:"auth_login_redirect" json:"auth_login_redirect"`
 	} `bson:"oauth_meta" json:"oauth_meta"`
-	UseBasicAuth         bool                 `bson:"use_basic_auth" json:"use_basic_auth"`
-	NotificationsDetails NotificationsManager `bson:"notifications" json:"notifications"`
-	EnableSignatureChecking bool `bson:"enable_signature_checking" json:"enable_signature_checking"`
-	VersionDefinition    struct {
+	UseBasicAuth            bool                 `bson:"use_basic_auth" json:"use_basic_auth"`
+	NotificationsDetails    NotificationsManager `bson:"notifications" json:"notifications"`
+	EnableSignatureChecking bool                 `bson:"enable_signature_checking" json:"enable_signature_checking"`
+	VersionDefinition       struct {
 		Location string `bson:"location" json:"location"`
 		Key      string `bson:"key" json:"key"`
 	} `bson:"definition" json:"definition"`
-	VersionData             struct {
+	VersionData struct {
 		NotVersioned bool                   `bson:"not_versioned" json:"not_versioned"`
 		Versions     map[string]VersionInfo `bson:"versions" json:"versions"`
 	} `bson:"version_data" json:"version_data"`
@@ -43,7 +43,7 @@ type APIDefinition struct {
 		TargetURL       string `bson:"target_url" json:"target_url"`
 		StripListenPath bool   `bson:"strip_listen_path" json:"strip_listen_path"`
 	} `bson:"proxy" json:"proxy"`
-	Active bool `bson:"active" json:"active"`
+	Active  bool                   `bson:"active" json:"active"`
 	RawData map[string]interface{} `bson:"raw_data,omitempty" json:"raw_data,omitempty"` // Not used in actual configuration, loaded by config for plugable arc
 }
 

diff --git a/api_definition_test.go b/api_definition_test.go
@@ -1,11 +1,11 @@
 package main
 
 import (
-	"testing"
-	"net/url"
-	"net/http"
 	"encoding/json"
 	"io/ioutil"
+	"net/http"
+	"net/url"
+	"testing"
 )
 
 var sampleDefiniton string = `
@@ -125,7 +125,6 @@ var nonExpiringMultiDef string = `
 
 `
 
-
 func createDefinitionFromString(defStr string) APISpec {
 	var thisLoader = APIDefinitionLoader{}
 
@@ -147,7 +146,6 @@ func writeDefToFile(configStruct APIDefinition) {
 	}
 }
 
-
 func TestExpiredRequest(t *testing.T) {
 	uri := "/v1/bananaphone"
 	method := "GET"
@@ -186,7 +184,7 @@ func TestNotVersioned(t *testing.T) {
 	thisSpec := createDefinitionFromString(nonExpiringDef)
 	thisSpec.VersionData.NotVersioned = true
 
-//	writeDefToFile(thisSpec.APIDefinition)
+	//	writeDefToFile(thisSpec.APIDefinition)
 
 	ok, status := thisSpec.IsRequestValid(req)
 	if ok != true {
@@ -376,7 +374,6 @@ func TestIgnored(t *testing.T) {
 	}
 }
 
-
 func TestBlacklistLinksMulti(t *testing.T) {
 	uri := "v1/disallowed/blacklist/literal"
 	method := "GET"

diff --git a/gateway_test.go b/gateway_test.go
@@ -2,13 +2,13 @@ package main
 
 import (
 	"encoding/json"
+	"github.com/justinas/alice"
 	"net/http"
 	"net/http/httptest"
 	"net/http/httputil"
 	"net/url"
 	"testing"
 	"time"
-	"github.com/justinas/alice"
 )
 
 func createThrottledSession() SessionState {
@@ -102,7 +102,6 @@ func createNonVersionedDefinition() APISpec {
 
 }
 
-
 func TestThrottling(t *testing.T) {
 	spec := createNonVersionedDefinition()
 	thisSession := createThrottledSession()
@@ -122,7 +121,6 @@ func TestThrottling(t *testing.T) {
 	chain := getChain(spec)
 	chain.ServeHTTP(recorder, req)
 
-
 	if recorder.Code != 200 {
 		t.Error("Initial request failed with non-200 code: \n", recorder.Code)
 	}

diff --git a/middleware.go b/middleware.go
@@ -7,7 +7,7 @@ import ()
 type TykMiddlewareImplementation interface {
 	New()
 	GetConfig() (interface{}, error)
-	ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) // Handles request
+	ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) // Handles request
 }
 
 // Generic middleware caller to make extension easier

diff --git a/middleware_access_rights.go b/middleware_access_rights.go
@@ -3,9 +3,9 @@ package main
 import "net/http"
 
 import (
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
-	"errors"
 )
 
 // AccessRightsCheck is a midleware that will check if the key bing used to access the API has
@@ -24,7 +24,7 @@ func (a *AccessRightsCheck) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (a *AccessRightsCheck) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (a *AccessRightsCheck) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	accessingVersion := a.Spec.getVersionFromRequest(r)
 	thisSessionState := context.Get(r, SessionData).(SessionState)
 	authHeaderValue := context.Get(r, AuthHeaderValue)
@@ -75,7 +75,6 @@ func (a *AccessRightsCheck) ProcessRequest(w http.ResponseWriter, r *http.Reques
 	return nil, 200
 }
 
-
 //// New creates a new HttpHandler for the alice middleware package
 //func (a AccessRightsCheck) New() func(http.Handler) http.Handler {
 //	aliceHandler := func(h http.Handler) http.Handler {

diff --git a/middleware_auth_key.go b/middleware_auth_key.go
@@ -3,10 +3,10 @@ package main
 import "net/http"
 
 import (
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
 	"github.com/mitchellh/mapstructure"
-	"errors"
 )
 
 // KeyExists will check if the key being used to access the API is in the request data,
@@ -36,7 +36,7 @@ func (k *AuthKey) GetConfig() (interface{}, error) {
 	return thisModuleConfig, nil
 }
 
-func (k *AuthKey) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (k *AuthKey) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	var thisConfig AuthKeyConfiguration
 	thisConfig = configuration.(AuthKeyConfiguration)
 

diff --git a/middleware_basic_auth_check.go b/middleware_basic_auth_check.go
@@ -4,10 +4,10 @@ import "net/http"
 
 import (
 	"encoding/base64"
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
 	"strings"
-	"errors"
 )
 
 // BasicAuthKeyIsValid uses a username instead of
@@ -24,7 +24,7 @@ func (k *BasicAuthKeyIsValid) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (k *BasicAuthKeyIsValid) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (k *BasicAuthKeyIsValid) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	authHeaderValue := r.Header.Get("Authorization")
 	if authHeaderValue == "" {
 		// No header value, fail

diff --git a/middleware_check_HMAC_signature.go b/middleware_check_HMAC_signature.go
@@ -6,14 +6,14 @@ import (
 	"crypto/hmac"
 	"crypto/sha1"
 	"encoding/base64"
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
 	"math"
 	"net/url"
 	"sort"
 	"strings"
 	"time"
-	"errors"
 )
 
 // Test key: 53ac07777cbb8c2d530000021a42331a43bd45555d5c923bdb36fc8a
@@ -45,7 +45,7 @@ func (hm *HMACMiddleware) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (hm *HMACMiddleware) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (hm *HMACMiddleware) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	log.Debug("HMAC middleware activated")
 
 	authHeaderValue := r.Header.Get("Authorization")

diff --git a/middleware_key_expired_check.go b/middleware_key_expired_check.go
@@ -3,9 +3,9 @@ package main
 import "net/http"
 
 import (
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
-	"errors"
 )
 
 // KeyExpired middleware will check if the requesting key is expired or not. It makes use of the authManager to do so.
@@ -22,7 +22,7 @@ func (k *KeyExpired) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (k *KeyExpired) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (k *KeyExpired) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	thisSessionState := context.Get(r, SessionData).(SessionState)
 	authHeaderValue := context.Get(r, AuthHeaderValue).(string)
 	keyExpired := authManager.IsKeyExpired(&thisSessionState)

diff --git a/middleware_oauth2_key_exists.go b/middleware_oauth2_key_exists.go
@@ -3,10 +3,10 @@ package main
 import "net/http"
 
 import (
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
 	"strings"
-	"errors"
 )
 
 // Oauth2KeyExists will check if the key being used to access the API is in the request data,
@@ -24,13 +24,13 @@ func (k *Oauth2KeyExists) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (k *Oauth2KeyExists) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (k *Oauth2KeyExists) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 
 	// We're using OAuth, start checking for access keys
 	authHeaderValue := r.Header.Get("Authorization")
 	parts := strings.Split(authHeaderValue, " ")
 	if len(parts) < 2 {
-			log.WithFields(logrus.Fields{
+		log.WithFields(logrus.Fields{
 			"path":   r.URL.Path,
 			"origin": r.RemoteAddr,
 		}).Info("Attempted access with malformed header, no auth header found.")

diff --git a/middleware_rate_limiting.go b/middleware_rate_limiting.go
@@ -3,9 +3,9 @@ package main
 import "net/http"
 
 import (
+	"errors"
 	"github.com/Sirupsen/logrus"
 	"github.com/gorilla/context"
-	"errors"
 )
 
 // RateLimitAndQuotaCheck will check the incomming request and key whether it is within it's quota and
@@ -23,7 +23,7 @@ func (k *RateLimitAndQuotaCheck) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (k *RateLimitAndQuotaCheck) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (k *RateLimitAndQuotaCheck) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	sessionLimiter := SessionLimiter{}
 	thisSessionState := context.Get(r, SessionData).(SessionState)
 	authHeaderValue := context.Get(r, AuthHeaderValue).(string)
@@ -51,7 +51,7 @@ func (k *RateLimitAndQuotaCheck) ProcessRequest(w http.ResponseWriter, r *http.R
 				"origin": r.RemoteAddr,
 				"key":    authHeaderValue,
 			}).Info("Key quota limit exceeded.")
-			return  errors.New("Quota exceeded"), 403
+			return errors.New("Quota exceeded"), 403
 		}
 		// Other reason? Still not allowed
 		return errors.New("Access denied"), 403

diff --git a/middleware_sample.go b/middleware_sample.go
@@ -1,11 +1,14 @@
 package main
 
 import (
-	"net/http"
 	"errors"
 	"github.com/mitchellh/mapstructure"
+	"net/http"
 )
 
+// It's very easy to create custom middleware
+// TODO: Write the docs around this
+
 // ModifiedMiddleware is a sample custom middleware component, must inherit TykMiddleware
 // so you have access to spec and definition data
 type ModifiedMiddleware struct {
@@ -33,7 +36,7 @@ func (m *ModifiedMiddleware) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (m *ModifiedMiddleware) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (m *ModifiedMiddleware) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	var thisConfig ModifiedMiddlewareConfig
 	thisConfig = configuration.(ModifiedMiddlewareConfig)
 	log.Info("Custom configuration: ", thisConfig.CustomConfigVar)

diff --git a/middleware_version_check.go b/middleware_version_check.go
@@ -20,7 +20,7 @@ func (v *VersionCheck) GetConfig() (interface{}, error) {
 }
 
 // ProcessRequest will run any checks on the request on the way through the system, return an error to have the chain fail
-func (v *VersionCheck) ProcessRequest(w http.ResponseWriter, r *http.Request,  configuration interface{}) (error, int) {
+func (v *VersionCheck) ProcessRequest(w http.ResponseWriter, r *http.Request, configuration interface{}) (error, int) {
 	// Check versioning, blacklist, whitelist and ignored status
 	requestValid, stat := v.TykMiddleware.Spec.IsRequestValid(r)
 	if requestValid == false {