Merge pull request #42 from ulule/feat/gomod

Add go module
ulule · Nov 5, 2018 · 14a36fd · 14a36fd
2 parents d40ef3e + 1026e04
commit 14a36fd
Show file tree

Hide file tree

Showing 28 changed files with 147 additions and 186 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -21,10 +21,12 @@ jobs:
           name: Run tests
           command: scripts/go-wrapper scripts/test
           environment:
+            GO111MODULE: on
             REDIS_DISABLE_BOOTSTRAP: false
             REDIS_URI: redis://localhost:26379/1
 
       - run:
           name: Run linters
           command: scripts/go-wrapper scripts/lint
-          no_output_timeout: 10m
+          environment:
+            GO111MODULE: on
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
diff --git a/Makefile b/Makefile
@@ -1,9 +1,6 @@
-.PHONY: test
+.PHONY: test lint
 
-cleandb:
-	@(redis-cli KEYS "limitertests:*" | xargs redis-cli DEL)
-
-test: cleandb
+test:
 	@(scripts/test)
 
 lint:

diff --git a/drivers/middleware/gin/middleware.go b/drivers/middleware/gin/middleware.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 
-	"github.com/ulule/limiter"
+	"github.com/ulule/limiter/v3"
 )
 
 // Middleware is the middleware for basic http.Handler.

diff --git a/drivers/middleware/gin/middleware_test.go b/drivers/middleware/gin/middleware_test.go
@@ -11,9 +11,9 @@ import (
 	libgin "github.com/gin-gonic/gin"
 	"github.com/stretchr/testify/require"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/middleware/gin"
-	"github.com/ulule/limiter/drivers/store/memory"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/middleware/gin"
+	"github.com/ulule/limiter/v3/drivers/store/memory"
 )
 
 func TestHTTPMiddleware(t *testing.T) {

diff --git a/drivers/middleware/stdlib/middleware.go b/drivers/middleware/stdlib/middleware.go
@@ -4,7 +4,7 @@ import (
 	"net/http"
 	"strconv"
 
-	"github.com/ulule/limiter"
+	"github.com/ulule/limiter/v3"
 )
 
 // Middleware is the middleware for basic http.Handler.

diff --git a/drivers/middleware/stdlib/middleware_test.go b/drivers/middleware/stdlib/middleware_test.go
@@ -9,9 +9,9 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/middleware/stdlib"
-	"github.com/ulule/limiter/drivers/store/memory"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/middleware/stdlib"
+	"github.com/ulule/limiter/v3/drivers/store/memory"
 )
 
 func TestHTTPMiddleware(t *testing.T) {

diff --git a/drivers/store/common/context.go b/drivers/store/common/context.go
@@ -3,7 +3,7 @@ package common
 import (
 	"time"
 
-	"github.com/ulule/limiter"
+	"github.com/ulule/limiter/v3"
 )
 
 // GetContextFromState generate a new limiter.Context from given state.

diff --git a/drivers/store/memory/cache_test.go b/drivers/store/memory/cache_test.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/ulule/limiter/drivers/store/memory"
+	"github.com/ulule/limiter/v3/drivers/store/memory"
 )
 
 func TestCacheIncrementSequential(t *testing.T) {

diff --git a/drivers/store/memory/store.go b/drivers/store/memory/store.go
@@ -5,8 +5,8 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/store/common"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/store/common"
 )
 
 // Store is the in-memory store.

diff --git a/drivers/store/memory/store_test.go b/drivers/store/memory/store_test.go
@@ -4,9 +4,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/store/memory"
-	"github.com/ulule/limiter/drivers/store/tests"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/store/memory"
+	"github.com/ulule/limiter/v3/drivers/store/tests"
 )
 
 func TestMemoryStoreSequentialAccess(t *testing.T) {

diff --git a/drivers/store/redis/store.go b/drivers/store/redis/store.go
@@ -8,8 +8,8 @@ import (
 	libredis "github.com/go-redis/redis"
 	"github.com/pkg/errors"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/store/common"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/store/common"
 )
 
 // Client is an interface thats allows to use a redis cluster or a redis single client seamlessly.

diff --git a/drivers/store/redis/store_test.go b/drivers/store/redis/store_test.go
@@ -7,9 +7,9 @@ import (
 	libredis "github.com/go-redis/redis"
 	"github.com/stretchr/testify/require"
 
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/store/redis"
-	"github.com/ulule/limiter/drivers/store/tests"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/store/redis"
+	"github.com/ulule/limiter/v3/drivers/store/tests"
 )
 
 func TestRedisStoreSequentialAccess(t *testing.T) {

diff --git a/drivers/store/tests/tests.go b/drivers/store/tests/tests.go
@@ -9,7 +9,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/ulule/limiter"
+	"github.com/ulule/limiter/v3"
 )
 
 // TestStoreSequentialAccess verify that store works as expected with a sequential access.

diff --git a/examples/beego/main.go b/examples/beego/main.go
@@ -1,17 +1,19 @@
 package main
+
 /*
-More comprehensive example: 
+More comprehensive example:
 https://gist.github.com/gadelkareem/5a087bfda1f673241d0ac65759156cfd
 */
 import (
 	"github.com/astaxie/beego"
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/store/memory"
 	"github.com/astaxie/beego/context"
+	"github.com/astaxie/beego/logs"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/store/memory"
+	"net"
 	"net/http"
 	"strconv"
 	"strings"
-	"github.com/astaxie/beego/logs"
 )
 
 type rateLimiter struct {
@@ -47,15 +49,16 @@ func main() {
 func rateLimit(r *rateLimiter, ctx *context.Context) {
 	var (
 		limiterCtx limiter.Context
+		ip         net.IP
 		err        error
 		req        = ctx.Request
 	)
 
-	ip := limiter.GetIP(req, false)
-
 	if strings.HasPrefix(ctx.Input.URL(), "/login") {
+		ip = r.loginLimiter.GetIP(req)
 		limiterCtx, err = r.loginLimiter.Get(req.Context(), ip.String())
 	} else {
+		ip = r.generalLimiter.GetIP(req)
 		limiterCtx, err = r.generalLimiter.Get(req.Context(), ip.String())
 	}
 	if err != nil {

diff --git a/examples/chi/main.go b/examples/chi/main.go
@@ -7,9 +7,9 @@ import (
 
 	"github.com/go-chi/chi"
 	redis "github.com/go-redis/redis"
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/middleware/stdlib"
-	sredis "github.com/ulule/limiter/drivers/store/redis"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/middleware/stdlib"
+	sredis "github.com/ulule/limiter/v3/drivers/store/redis"
 )
 
 func main() {
@@ -40,7 +40,7 @@ func main() {
 	}
 
 	// Create a new middleware with the limiter instance.
-	middleware := stdlib.NewMiddleware(limiter.New(store, rate), stdlib.WithForwardHeader(true))
+	middleware := stdlib.NewMiddleware(limiter.New(store, rate, limiter.WithTrustForwardHeader(true)))
 
 	// Launch a simple chi server.
 	router := chi.NewRouter()

diff --git a/examples/gin/main.go b/examples/gin/main.go
@@ -6,9 +6,9 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/go-redis/redis"
-	"github.com/ulule/limiter"
-	mgin "github.com/ulule/limiter/drivers/middleware/gin"
-	sredis "github.com/ulule/limiter/drivers/store/redis"
+	"github.com/ulule/limiter/v3"
+	mgin "github.com/ulule/limiter/v3/drivers/middleware/gin"
+	sredis "github.com/ulule/limiter/v3/drivers/store/redis"
 )
 
 func main() {

diff --git a/examples/http/main.go b/examples/http/main.go
@@ -6,9 +6,9 @@ import (
 	"net/http"
 
 	redis "github.com/go-redis/redis"
-	"github.com/ulule/limiter"
-	"github.com/ulule/limiter/drivers/middleware/stdlib"
-	sredis "github.com/ulule/limiter/drivers/store/redis"
+	"github.com/ulule/limiter/v3"
+	"github.com/ulule/limiter/v3/drivers/middleware/stdlib"
+	sredis "github.com/ulule/limiter/v3/drivers/store/redis"
 )
 
 func main() {
@@ -39,7 +39,7 @@ func main() {
 	}
 
 	// Create a new middleware with the limiter instance.
-	middleware := stdlib.NewMiddleware(limiter.New(store, rate), stdlib.WithForwardHeader(true))
+	middleware := stdlib.NewMiddleware(limiter.New(store, rate, limiter.WithTrustForwardHeader(true)))
 
 	// Launch a simple server.
 	http.Handle("/", middleware.Handler(http.HandlerFunc(index)))

diff --git a/go.mod b/go.mod
@@ -0,0 +1,23 @@
+module github.com/ulule/limiter/v3
+
+require (
+	github.com/astaxie/beego v1.10.0
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gin-contrib/sse v0.0.0-20170109093832-22d885f9ecc7 // indirect
+	github.com/gin-gonic/gin v1.3.0
+	github.com/go-chi/chi v3.3.3+incompatible
+	github.com/go-redis/redis v6.14.0+incompatible
+	github.com/json-iterator/go v0.0.0-20180806060727-1624edc4454b // indirect
+	github.com/mattn/go-isatty v0.0.3 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 // indirect
+	github.com/onsi/gomega v1.4.2 // indirect
+	github.com/pkg/errors v0.8.0
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.2.2
+	github.com/ugorji/go v1.1.1 // indirect
+	golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac // indirect
+	golang.org/x/net v0.0.0-20181011144130-49bb7cea24b1 // indirect
+	gopkg.in/go-playground/assert.v1 v1.2.1 // indirect
+	gopkg.in/go-playground/validator.v8 v8.18.2 // indirect
+)