Up version

Author: marcosbarbero

.ci/deploy.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+mvn -pl '!spring-cloud-zuul-ratelimit-coverage' clean deploy -Pdeploy-parent -fn

README.md

@@ -25,7 +25,7 @@ Add the dependency on pom.xml
 <dependency>
     <groupId>com.marcosbarbero.cloud</groupId>
     <artifactId>spring-cloud-zuul-ratelimit</artifactId>
-    <version>1.3.4.RELEASE</version>
+    <version>1.4.0.RELEASE</version>
 </dependency>
 ```
 
@@ -137,9 +137,13 @@ Policy properties:
 
 Further Customization
 ---
+This section details how to add custom implementations 
 
-If your application needs to control the key strategy beyond the options offered by the type property then you can 
-supply a custom `RateLimitKeyGenerator` implementation adding further qualifiers or something entirely different:
+### Key Generator
+
+If the application needs to control the key strategy beyond the options offered by the type property then it can 
+be done just by creating a custom `RateLimitKeyGenerator` implementation adding further qualifiers or something 
+entirely different:
 
 ```java
   @Bean
@@ -153,6 +157,36 @@ supply a custom `RateLimitKeyGenerator` implementation adding further qualifiers
   }
 ```
 
+### Error Handling
+This framework uses some 3rd party applications to store and control the rate limit access, as it does not has control
+over those applications and they can fail once a while the framework itself handles the failure in the class 
+`DefaultRateLimiterErrorHandler` just by adding some error logs.  
+
+If there is a need to handle the errors differently, it can be achieved just by defining a custom `RateLimiterErrorHandler`
+bean, e.g:
+
+```java
+  @Bean
+  public RateLimiterErrorHandler rateLimitErrorHandler() {
+    return new DefaultRateLimiterErrorHandler() {
+        @Override
+        public void handleSaveError(String key, Exception e) {
+            // custom code
+        }
+        
+        @Override
+        public void handleFetchError(String key, Exception e) {
+            // custom code
+        }
+        
+        @Override
+        public void handleError(String msg, Exception e) {
+            // custom code
+        }
+    }
+  }
+```
+
 Contributing
 ---
 Spring Cloud Zuul Rate Limit is released under the non-restrictive Apache 2.0 license, and follows a very 

pom.xml

@@ -19,7 +19,7 @@
         ]]>
     </description>
     <url>https://github.com/marcosbarbero/spring-cloud-zuul-ratelimit</url>
-    <version>1.3.4.RELEASE</version>
+    <version>1.4.0.RELEASE</version>
 
     <licenses>
         <license>
@@ -34,7 +34,7 @@
         <maven.compiler.source>1.8</maven.compiler.source>
         <java.version>1.8</java.version>
         <nexus-staging-maven-plugin.version>1.6.3</nexus-staging-maven-plugin.version>
-        <global.version>1.3.4.RELEASE</global.version>
+        <global.version>1.4.0.RELEASE</global.version>
         <jacoco.version>0.7.9</jacoco.version>
         <jacoco.it.execution.data.file>
             ${project.build.directory}/coverage-reports/jacoco.exec

spring-cloud-starter-zuul-ratelimit/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
         <groupId>com.marcosbarbero.cloud</groupId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>..</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

spring-cloud-zuul-ratelimit-core/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.marcosbarbero.cloud</groupId>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>..</relativePath>
     </parent>
 

spring-cloud-zuul-ratelimit-coverage/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
         <groupId>com.marcosbarbero.cloud</groupId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

spring-cloud-zuul-ratelimit-dependencies/pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>com.marcosbarbero.cloud</groupId>
     <artifactId>spring-cloud-zuul-ratelimit-dependencies</artifactId>
-    <version>1.3.4.RELEASE</version>
+    <version>1.4.0.RELEASE</version>
     <packaging>pom</packaging>
     <url>https://github.com/marcosbarbero/spring-cloud-zuul-ratelimit</url>
 

spring-cloud-zuul-ratelimit-tests/consul/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
         <groupId>com.marcosbarbero.cloud</groupId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

spring-cloud-zuul-ratelimit-tests/inmemory/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
         <groupId>com.marcosbarbero.cloud</groupId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 

spring-cloud-zuul-ratelimit-tests/redis/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>spring-cloud-zuul-ratelimit-parent</artifactId>
         <groupId>com.marcosbarbero.cloud</groupId>
-        <version>1.3.4.RELEASE</version>
+        <version>1.4.0.RELEASE</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>