Feature/rate limit using bucket4j (#3)

* Rate Limit Spring Boot REST API using Bucket4j

* Rate Limit Spring Boot REST API using Bucket4j

* Added Spring security examples

Author: nilandev

movies-rest-api-monogdb/src/main/resources/application.properties

@@ -1,6 +1,6 @@
 spring.data.mongodb.uri=mongodb://localhost:27017/movies?locale=en
-spring.data.mongodb.username=
-spring.data.mongodb.password=
+spring.data.mongodb.username=root
+spring.data.mongodb.password=Passw0rd
 
 #open API path
 springdoc.api-docs.path=/api-docs

ratelimit-api-using-bucket4j/pom.xml

@@ -1,71 +1,65 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <artifactId>ratelimit-api-using-bucket4j</artifactId>
+    <description>Demo project for Spring Boot</description>
+    <groupId>com.stacktips</groupId>
     <modelVersion>4.0.0</modelVersion>
+    <name>movies-api</name>
+    <version>0.0.1-SNAPSHOT</version>
     <parent>
-        <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.3.2</version>
-        <relativePath/> <!-- lookup parent from repository -->
+        <groupId>org.springframework.boot</groupId>
+        <relativePath/>
+        <version>3.3.2</version> <!-- lookup parent from repository -->
     </parent>
-    <groupId>com.stacktips</groupId>
-    <artifactId>springboot-rest-api-monogdb</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
-    <name>movies-api</name>
-    <description>Demo project for Spring Boot</description>
     <properties>
         <java.version>17</java.version>
     </properties>
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <groupId>org.springframework.boot</groupId>
+            </plugin>
+        </plugins>
+    </build>
     <dependencies>
-        <!-- For java 17+ -->
         <dependency>
-            <groupId>com.bucket4j</groupId>
             <artifactId>bucket4j_jdk17-core</artifactId>
+            <groupId>com.bucket4j</groupId>
             <version>8.13.1</version>
         </dependency>
+
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-data-mongodb</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
+            <groupId>org.springframework.boot</groupId>
         </dependency>
 
         <dependency>
-            <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
+            <groupId>org.springframework.boot</groupId>
             <scope>test</scope>
         </dependency>
 
         <dependency>
-            <groupId>io.rest-assured</groupId>
             <artifactId>rest-assured</artifactId>
-            <version>5.3.1</version>
+            <groupId>io.rest-assured</groupId>
             <scope>test</scope>
+            <version>5.3.1</version>
         </dependency>
-
         <dependency>
-            <groupId>io.rest-assured</groupId>
             <artifactId>json-path</artifactId>
-            <version>5.3.1</version>
+            <groupId>io.rest-assured</groupId>
             <scope>test</scope>
+            <version>5.3.1</version>
         </dependency>
+
         <dependency>
-            <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
+            <groupId>org.projectlombok</groupId>
             <scope>annotationProcessor</scope>
         </dependency>
-
     </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-            </plugin>
-        </plugins>
-    </build>
-
 </project>

ratelimit-api-using-bucket4j/src/main/java/com/stacktips/movies/MyApiApplication.java

@@ -0,0 +1,13 @@
+package com.stacktips.movies;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class MyApiApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(MyApiApplication.class, args);
+    }
+
+}

ratelimit-api-using-bucket4j/src/main/java/com/stacktips/movies/api/GlobalExceptionHandler.java

@@ -0,0 +1,22 @@
+package com.stacktips.movies.api;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Collections;
+import java.util.Map;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping(value = "/hello",
+        produces = {MediaType.APPLICATION_JSON_VALUE})
+public class HelloController {
+
+    @GetMapping
+    public Map<String, String> hello() {
+        return Collections.singletonMap("hello", "world!");
+    }
+}

ratelimit-api-using-bucket4j/src/main/java/com/stacktips/movies/api/HelloController.java

@@ -0,0 +1,24 @@
+package com.stacktips.movies.config;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+import java.time.Duration;
+import java.util.Map;
+
+@Data
+@Configuration
+@ConfigurationProperties(prefix = "rate-limiting")
+public class BucketConfig {
+
+    private Map<String, ClientBucketConfig> clients;
+
+    @Data
+    public static class ClientBucketConfig {
+
+        private int capacity;
+        private int refillTokens;
+        private Duration refillDuration;
+    }
+}

ratelimit-api-using-bucket4j/src/main/java/com/stacktips/movies/api/MoviesController.java

@@ -1,5 +1,6 @@
 package com.stacktips.movies.config;
 
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -8,18 +9,19 @@
 public class FilterConfig {
 
 //    @Bean
-//    public FilterRegistrationBean<RateLimitingFilter> RateLimitingFilter() {
+//    public FilterRegistrationBean<RateLimitingFilter> rateLimitingFilter() {
 //        FilterRegistrationBean<RateLimitingFilter> registrationBean = new FilterRegistrationBean<>();
 //        registrationBean.setFilter(new RateLimitingFilter());
-//        registrationBean.addUrlPatterns("/api/1.0/movies/*");
+//        registrationBean.addUrlPatterns("/hello/*");
 //        return registrationBean;
 //    }
 
     @Bean
-    public FilterRegistrationBean<RateLimitingClientFilter> rateLimitingClientFilter() {
+    public FilterRegistrationBean<RateLimitingClientFilter> rateLimitingClientFilter(
+            @Autowired BucketConfig bucketConfig) {
         FilterRegistrationBean<RateLimitingClientFilter> registrationBean = new FilterRegistrationBean<>();
-        registrationBean.setFilter(new RateLimitingClientFilter());
-        registrationBean.addUrlPatterns("/api/1.0/movies/*");
+        registrationBean.setFilter(new RateLimitingClientFilter(bucketConfig));
+        registrationBean.addUrlPatterns("/hello/*");
         return registrationBean;
     }
 }

ratelimit-api-using-bucket4j/src/main/java/com/stacktips/movies/config/BucketConfig.java

@@ -2,33 +2,35 @@
 
 import io.github.bucket4j.Bucket;
 import io.github.bucket4j.ConsumptionProbe;
-import jakarta.servlet.FilterConfig;
 import jakarta.servlet.*;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 
 import java.io.IOException;
-import java.time.Duration;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
 
+@RequiredArgsConstructor
 public class RateLimitingClientFilter implements Filter {
 
+    private final BucketConfig bucketConfig;
+
     private final ConcurrentHashMap<String, Bucket> buckets = new ConcurrentHashMap<>();
 
     @Override
     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
             throws IOException, ServletException {
         HttpServletResponse httpResponse = (HttpServletResponse) response;
         HttpServletRequest httpRequest = (HttpServletRequest) request;
-
-        String apiKey = httpRequest.getHeader("X-API-Key");
+        String apiKey = httpRequest.getHeader("X-Client-ID");
         if (apiKey == null) {
+
             httpResponse.setStatus(HttpStatus.BAD_REQUEST.value());
             httpResponse.setContentType(MediaType.TEXT_PLAIN_VALUE);
-            httpResponse.getWriter().write("Missing X-API-Key header");
+            httpResponse.getWriter().write("Missing X-Client-ID header");
             return;
         }
 
@@ -46,20 +48,16 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
         }
     }
 
-    private Bucket createNewBucket(String apiKey) {
-        return Bucket.builder()
-                .addLimit(limit -> limit.capacity(10)
-                        .refillIntervally(1, Duration.ofMinutes(1)))
-                .build();
-    }
-
-    @Override
-    public void init(FilterConfig filterConfig) {
-
-    }
-
-    @Override
-    public void destroy() {
+    private Bucket createNewBucket(String clientId) {
+        BucketConfig.ClientBucketConfig config = bucketConfig.getClients().get(clientId);
+        if (config == null) {
+            throw new IllegalArgumentException("Unknown client: " + clientId);
+        }
 
+        return Bucket.builder()
+                .addLimit(limit ->
+                        limit.capacity(config.getCapacity())
+                                .refillIntervally(config.getRefillTokens(), config.getRefillDuration())
+                ).build();
     }
 }