Merge pull request #4 from devfullcycle/devin/1739039928-redis-storage

feat: add Redis storage implementation

Author: wesleywillians

.env.example

@@ -0,0 +1,5 @@
+# Redis Configuration
+REDIS_HOST=localhost    # Redis server hostname
+REDIS_PORT=6379        # Redis server port
+REDIS_PASSWORD=        # Optional Redis password
+REDIS_DB=0            # Redis database number (0-15)

README.md

@@ -98,6 +98,54 @@ Retry-After: 60
 }
 ```
 
+## Storage Backends
+
+### Memory Storage (Default)
+The default memory storage is suitable for single-instance deployments. See the Quick Start section for usage.
+
+### Redis Storage
+For distributed environments, Redis storage backend is available. To use Redis:
+
+1. Configure Redis environment variables:
+```bash
+REDIS_HOST=localhost    # Redis server hostname
+REDIS_PORT=6379        # Redis server port
+REDIS_PASSWORD=        # Optional Redis password
+REDIS_DB=0            # Redis database number
+```
+
+2. Example code:
+```go
+package main
+
+import (
+    "github.com/devfullcycle/ratelimiter/middleware"
+    "github.com/devfullcycle/ratelimiter/ratelimiter"
+    "github.com/devfullcycle/ratelimiter/storage"
+)
+
+func main() {
+    // Initialize Redis storage
+    cfg := storage.DefaultRedisConfig()
+    client := storage.NewRedisClient(cfg)
+    store := storage.NewRedisStorage(client)
+
+    // Create rate limiter with Redis storage
+    limiter := ratelimiter.New(store)
+    
+    // ... rest of your application setup
+}
+```
+
+3. Running with Docker Compose:
+```bash
+# Start Redis and the application
+docker compose up -d
+
+# Run the Redis example
+docker compose exec app sh -c "cd /app && go run examples/redis/redis.go"
+```
+
 ## Development and Testing
 
 ### Prerequisites

docker-compose.yaml

@@ -1,8 +1,27 @@
 services:
+  redis:
+    image: redis:7.2
+    ports:
+      - "6379:6379"
+    networks:
+      - ratelimiter
+
   app:
     build: .
     volumes:
       - .:/app
-    network_mode: "host"
     working_dir: /app
     tty: true
+    environment:
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+      - REDIS_DB=0
+    depends_on:
+      - redis
+    networks:
+      - ratelimiter
+
+networks:
+  ratelimiter:
+    driver: bridge

examples/redis/redis.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"log/slog"
+	"net/http"
+	"os"
+
+	"github.com/devfullcycle/ratelimiter/middleware"
+	"github.com/devfullcycle/ratelimiter/ratelimiter"
+	"github.com/devfullcycle/ratelimiter/storage"
+)
+
+func main() {
+	// Initialize logger
+	logger := slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
+		Level: slog.LevelInfo,
+	}))
+
+	// Create Redis storage with default config
+	cfg := storage.DefaultRedisConfig()
+	client := storage.NewRedisClient(cfg)
+	store := storage.NewRedisStorage(client)
+
+	// Create rate limiter with default options
+	limiter := ratelimiter.New(store)
+
+	// Create middleware
+	rateLimitMiddleware := middleware.NewRateLimitMiddleware(limiter, logger)
+
+	// Create a simple handler
+	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "application/json")
+		w.Write([]byte(`{"message": "Hello, World!"}`))
+	})
+
+	// Wrap handler with rate limiting middleware
+	http.Handle("/", rateLimitMiddleware.Handler(handler))
+
+	// Start server
+	logger.Info("starting server on :8080", 
+		"redis_host", cfg.Host,
+		"redis_port", cfg.Port,
+	)
+	if err := http.ListenAndServe(":8080", nil); err != nil {
+		logger.Error("server error", "error", err)
+		os.Exit(1)
+	}
+}

go.mod

@@ -1,3 +1,55 @@
 module github.com/devfullcycle/ratelimiter
 
-go 1.23.6
+go 1.21
+
+require (
+	github.com/redis/go-redis/v9 v9.4.0
+	github.com/testcontainers/testcontainers-go v0.27.0
+)
+
+require (
+	dario.cat/mergo v1.0.0 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.6.1 // indirect
+	github.com/Microsoft/hcsshim v0.11.4 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/containerd/containerd v1.7.11 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/cpuguy83/dockercfg v0.3.1 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+	github.com/docker/distribution v2.8.2+incompatible // indirect
+	github.com/docker/docker v24.0.7+incompatible // indirect
+	github.com/docker/go-connections v0.4.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/uuid v1.4.0 // indirect
+	github.com/klauspost/compress v1.16.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/term v0.5.0 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc5 // indirect
+	github.com/opencontainers/runc v1.1.5 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
+	github.com/shirou/gopsutil/v3 v3.23.11 // indirect
+	github.com/shoenig/go-m1cpu v0.1.6 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
+	golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea // indirect
+	golang.org/x/mod v0.11.0 // indirect
+	golang.org/x/net v0.17.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/tools v0.10.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230711160842-782d3b101e98 // indirect
+	google.golang.org/grpc v1.58.3 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
+)