Merge pull request #14 from ericdallo/support-yaml-and-map

Support yaml and binding Map in POJO

Author: ericdallo

README.md

@@ -30,7 +30,7 @@ _Maven_:
 
 - Adding this annotation to any spring managed bean
 ```java
-@S3PropertiesLocation("my-bucket/my-folder/my-properties.properties")
+@S3PropertiesLocation("my-bucket/my-folder/my-properties.yaml")
 ```
 - Using a specific profile to only load properties if the app is running with that profile
 ```java
@@ -39,10 +39,113 @@ _Maven_:
 - Load from a System env variable
 ```java
 @S3PropertiesLocation(value = "${AWS_S3_LOCATION}", profiles = "developer")
-or
+// or
 @S3PropertiesLocation(value = "${AWS_S3_BUCKET}/application/my.properties", profiles = "developer")
 ```
 
+### Binding properties to a POJO
+You can bind the externally loaded properties to a POJO as well.
+
+For e.g., if you have a YAML file as
+```yaml
+zuul:
+  routes:
+    query1:
+      path: /api/apps/test1/query/**
+      stripPrefix: false
+      url: "https://test.url.com/query1"
+    query2:
+      path: /api/apps/test2/query/**
+      stripPrefix: false
+      url: "https://test.url.com/query2"
+    index1:
+      path: /api/apps/*/index/**
+      stripPrefix: false
+      url: "https://test.url.com/index"
+```
+Then you can bind the properties to a POJO using ConfigurationProperties:
+```java
+@Component
+@ConfigurationProperties("zuul")
+public class RouteConfig {
+    private Map<String, Map<String, String>> routes = new HashMap<>();
+
+    public void setRoutes(Map<String, Map<String, String>> routes) {
+        this.routes = routes;
+    }
+
+    public Map<String, Map<String, String>> getRoutes() {
+        return routes;
+    }
+}
+
+// or
+
+@Component
+@ConfigurationProperties("zuul")
+public class RouteConfig {
+    private Map<String, Route> routes;
+
+    public void setRoutes(Map<String, Route> routes) {
+        this.routes = routes;
+    }
+
+    public Map<String, Route> getRoutes() {
+        return routes;
+    }
+
+    public static class Route {
+        private String path;
+        private boolean stripPrefix;
+        String url;
+
+        public String getPath() {
+            return path;
+        }
+
+        public void setPath(String path) {
+            this.path = path;
+        }
+
+        public boolean isStripPrefix() {
+            return stripPrefix;
+        }
+
+        public void setStripPrefix(boolean stripPrefix) {
+            this.stripPrefix = stripPrefix;
+        }
+
+        public String getUrl() {
+            return url;
+        }
+
+        public void setUrl(String url) {
+            this.url = url;
+        }
+
+        @Override
+        public String toString() {
+            try {
+                return new ObjectMapper().writeValueAsString(this);
+            } catch (JsonProcessingException e) {
+                e.printStackTrace();
+            }
+            return this.toString();
+        }
+    }
+
+    @Override
+    public String toString() {
+        try {
+            return new ObjectMapper().writeValueAsString(this);
+        } catch (JsonProcessingException e) {
+            e.printStackTrace();
+        }
+        return this.toString();
+    }
+}
+```
+
 ### Refreshing properties in runtime
 
 You can force your application to load properties from S3 again without restart. _S3 Properties Loader_ uses a [Spring Cloud](http://projects.spring.io/spring-cloud/) feature that allows the spring beans annotated with `@RefreshScope` to reload properties.

build.gradle

@@ -1,30 +1,19 @@
-apply plugin: 'java'
-apply plugin: 'eclipse'
-apply plugin: 'application'
-apply plugin: 'net.researchgate.release'
-apply plugin: 'maven-publish'
-apply plugin: 'maven'
-apply plugin: 'signing'
-apply plugin: 'com.jfrog.bintray'
+plugins {
+    id 'java'
+    id 'eclipse'
+    id 'application'
+    id 'net.researchgate.release' version '2.6.0'
+    id 'maven-publish'
+    id 'maven'
+    id 'signing'
+    id 'com.jfrog.bintray' version '1.8.5'
+}
 
 compileJava.options.encoding = 'UTF-8'
 
 group = 'com.spring.loader'
 archivesBaseName = 's3-loader'
 
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-        jcenter()
-    }
-
-    dependencies {
-        classpath 'net.researchgate:gradle-release:2.3.5'
-        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7'
-    }
-}
-
 eclipse {
     classpath {
         downloadJavadoc = true
@@ -33,12 +22,12 @@ eclipse {
 }
 
 release {
-  failOnCommitNeeded = false
-  failOnPublishNeeded = true
-  failOnSnapshotDependencies = true
-  failOnUnversionedFiles = true
-  failOnUpdateNeeded = true
-  revertOnFail = true
+    failOnCommitNeeded = false
+    failOnPublishNeeded = true
+    failOnSnapshotDependencies = true
+    failOnUnversionedFiles = true
+    failOnUpdateNeeded = true
+    revertOnFail = true
 }
 
 afterReleaseBuild.dependsOn publish
@@ -61,25 +50,32 @@ repositories {
 }
 
 dependencies {
-    compile "org.springframework:spring-context:4.3.4.RELEASE"
-    compile "org.springframework.cloud:spring-cloud-aws-core:1.1.3.RELEASE"
-    compile "org.springframework.cloud:spring-cloud-context:1.1.8.RELEASE"
-    
-    testCompile "junit:junit:4.12"
-    testCompile "org.mockito:mockito-core:1.10.19"
-    testCompile "org.assertj:assertj-core:1.0.0"
-    testCompile "org.powermock:powermock-api-mockito:1.6.6"
-    testCompile "org.powermock:powermock-module-junit4:1.6.6"
+    implementation "org.springframework:spring-context:5.3.0"
+    implementation "org.springframework.cloud:spring-cloud-aws-core:2.2.4.RELEASE"
+    implementation "org.springframework.cloud:spring-cloud-context:2.2.5.RELEASE"
+
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
+
+    testImplementation "org.assertj:assertj-core:3.18.0"
+    testImplementation "org.mockito:mockito-inline:3.6.0"
+    testImplementation "org.mockito:mockito-junit-jupiter:3.6.0"
+    testRuntimeOnly "org.yaml:snakeyaml:1.27"
 }
 
 task sourcesJar(type: Jar) {
     from sourceSets.main.allSource
-    classifier = 'sources'
+    archiveClassifier = 'sources'
 }
 
 artifacts {
     archives jar
     archives sourcesJar
 }
 
+// Make all tests use JUnit 5
+tasks.withType(Test) {
+    useJUnitPlatform()
+}
+
 mainClassName = ''

gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists