fix: Documentation and linter (#39)

[*] Update README
[*] Tell that the distributed cache is supported in full version
[*] Fix linter errors

Author: darkweak

README.md

@@ -29,7 +29,7 @@ As it's written in go, it can be deployed on any server and thanks to the docker
 It's RFC compatible, supporting Vary, request coalescing and other specifications related to the [RFC-7234](https://tools.ietf.org/html/rfc7234)
 
 ## Disclaimer
-If you need redis or other custom cache providers, you have to use the full-featured version. You can read the documentation, on [the full-featured branch](https://github.com/Darkweak/Souin/tree/full-version) to discover the specific parts.
+If you need redis, olric or other custom cache providers, you have to use the full-featured version. You can read the documentation, on [the full-featured branch](https://github.com/Darkweak/Souin/tree/full-version) to discover the specific parts.
 
 ## Configuration
 The configuration file is stored at `/anywhere/configuration.yml`. You can edit it provided you fill at least the required parameters as shown below.
@@ -135,9 +135,14 @@ See the sequence for the minimal version below
 <img src="docs/plantUML/sequenceDiagram.svg?sanitize=true" alt="Sequence diagram">
 
 ## Cache systems
-The cache system sits on top of two providers at the moment. It provides an in-memory and redis cache systems because setting, getting, updating and deleting keys in Redis is as easy as it gets.  
-In order to do that, Redis needs to be either on the same network as the Souin instance when using docker-compose or over the internet, then it will use by default in-memory to avoid network latency as much as possible. 
-Souin will return at first the in-memory response when it gives a non-empty response, then the redis one will be used with same condition, or fallback to the reverse proxy otherwise.
+Supported providers
+ - [Redis](https://github.com/go-redis/redis)
+ - [Olric](https://github.com/buraksezer/olric)
+
+ The cache system sits on top of three providers at the moment. It provides an in-memory, redis and Olric cache systems because setting, getting, updating and deleting keys in these providers is as easy as it gets.  
+ In order to do that, Redis and Olric providers need to be either on the same network as the Souin instance when using docker-compose or over the internet, then it will use by default in-memory to avoid network latency as much as possible. 
+ Souin will return at first the in-memory response when it gives a non-empty response, then the olric followed by the redis one with same condition, or fallback to the reverse proxy otherwise.
+ Since 1.4.2, Souin supports [Olric](https://github.com/buraksezer/olric) to handle distributed cache.
 
 ### Cache invalidation
 The cache invalidation is build for CRUD requests, if you're doing a GET HTTP request, it will serve the cached response when it exists, otherwise the reverse-proxy response will be served.  
@@ -238,3 +243,4 @@ Thanks to these users for contributing or helping this project in any way
 * [Deuchnord](https://github.com/deuchnord)
 * [Sata51](https://github.com/sata51)
 * [Pierre Diancourt](https://github.com/pierrediancourt)
+* [Burak Sezer](https://github.com/buraksezer)

api/auth/jwt.go

@@ -7,7 +7,8 @@ import (
 	"time"
 )
 
-type jwtProvider struct {
+// JwtProvider is the representation of decoded JWT
+type JwtProvider struct {
 	Username string `json:"username"`
 	jwt.StandardClaims
 }
@@ -43,7 +44,7 @@ func signJWT(security *SecurityAPI, w http.ResponseWriter, r *http.Request) {
 	}
 
 	// Create the JWT claims, which includes the username and expiry time
-	claims := &jwtProvider{
+	claims := &JwtProvider{
 		Username:       creds.Username,
 		StandardClaims: jwt.StandardClaims{},
 	}
@@ -69,7 +70,7 @@ func refresh(security *SecurityAPI, w http.ResponseWriter, r *http.Request) {
 }
 
 // CheckToken will return if token is valid or not
-func CheckToken(security *SecurityAPI, w http.ResponseWriter, r *http.Request) (*jwtProvider, error) {
+func CheckToken(security *SecurityAPI, w http.ResponseWriter, r *http.Request) (*JwtProvider, error) {
 	c, err := r.Cookie(tokenName)
 	if err != nil {
 		if err.Error() == http.ErrNoCookie.Error() {
@@ -80,7 +81,7 @@ func CheckToken(security *SecurityAPI, w http.ResponseWriter, r *http.Request) (
 		return nil, &tokenError{found: true}
 	}
 	tknStr := c.Value
-	claims := &jwtProvider{}
+	claims := &JwtProvider{}
 	tkn, err := jwt.ParseWithClaims(tknStr, claims, func(token *jwt.Token) (interface{}, error) {
 		return security.secret, nil
 	})
@@ -100,7 +101,7 @@ func CheckToken(security *SecurityAPI, w http.ResponseWriter, r *http.Request) (
 	return claims, nil
 }
 
-func setCookie(w http.ResponseWriter, claims *jwtProvider, secret []byte) {
+func setCookie(w http.ResponseWriter, claims *JwtProvider, secret []byte) {
 	expirationTime := time.Now().Add(lifetime)
 	claims.ExpiresAt = expirationTime.Unix()
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)

api/auth/security.go

@@ -15,6 +15,7 @@ type SecurityAPI struct {
 	users    map[string]string
 }
 
+// InitializeSecurity initialize the security endpoints
 func InitializeSecurity(configuration configurationtypes.AbstractConfigurationInterface) *SecurityAPI {
 	basePath := configuration.GetAPI().Security.BasePath
 	enabled := configuration.GetAPI().Security.Enable

cache/keysaver/keySaver.go

@@ -7,7 +7,10 @@ import (
 	"time"
 )
 
+// ADD to add
 const ADD = "add"
+
+// DELETE to delete
 const DELETE = "delete"
 
 type payload struct {

configurationtypes/types.go

@@ -41,19 +41,20 @@ type DefaultCache struct {
 type APIEndpoint struct {
 	BasePath string `yaml:"basepath"`
 	Enable   bool   `yaml:"enable"`
-	Security   bool   `yaml:"security"`
+	Security bool   `yaml:"security"`
 }
 
+// User is the minimal structure to define a user
 type User struct {
 	Username string `yaml:"username"`
 	Password string `yaml:"password"`
 }
 
 // SecurityAPI object contains informations related to the endpoints
 type SecurityAPI struct {
-	BasePath string            `yaml:"basepath"`
-	Enable   bool              `yaml:"enable"`
-	Secret   string            `yaml:"secret"`
+	BasePath string `yaml:"basepath"`
+	Enable   bool   `yaml:"enable"`
+	Secret   string `yaml:"secret"`
 	Users    []User `yaml:"users"`
 }
 

tests/mock.go

@@ -69,10 +69,12 @@ func MockInitializeRegexp(configurationInstance configurationtypes.AbstractConfi
 	return *regexp.MustCompile(u)
 }
 
+// GetTokenName returns the token name
 func GetTokenName() string {
 	return "souin-authorization-token"
 }
 
+// GetValidToken returns a valid token
 func GetValidToken() *http.Cookie {
 	return &http.Cookie{
 		Name: GetTokenName(),