Merge pull request #219 from dearrudam/issue-380

Added documentation about the DynamoDB module

Author: otaviojava

CHANGELOG.adoc

@@ -15,6 +15,7 @@ and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Version
 - Define container nomenclature to integrate test
 - Update package name convention to `org.jnosql.databases.[DATABASE].[LAYER]`
 - Integrate the mapping layer on this repository
+- Upgrade the AWS SDK for DynamoDB to version 2.20.65;
 
 === Fixed
 

README.adoc

@@ -516,6 +516,62 @@ jnosql.couchdb.username=admin
 jnosql.couchdb.password=password
 ----
 
+== DynamoDB
+
+image::https://user-images.githubusercontent.com/6509926/70553550-f033b980-1b40-11ea-9192-759b3b1053b3.png[Redis Project,align="center" width=50%,height=50%]
+
+https://aws.amazon.com/dynamodb/[Amazon DynamoDB] is a fully managed, serverless, key-value NoSQL database designed to run high-performance applications at any scale. DynamoDB offers built-in security, continuous backups, automated multi-Region replication, in-memory caching, and data import and export tools.
+
+This driver provides support for the *Key-Value* NoSQL API.
+
+=== How To Install
+
+You can use either the Maven or Gradle dependencies:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.eclipse.jnosql.databases</groupId>
+  <artifactId>jnosql-dynamodb</artifactId>
+  <version>1.0.0-b6</version>
+</dependency>
+----
+
+=== Configuration
+
+This API provides the ```DynamoDBConfigurations``` class to programmatically establish the credentials.
+Please note that you can establish properties using the https://microprofile.io/microprofile-config/[MicroProfile Config] specification.
+
+[cols="DynamoDB"]
+|===
+|Configuration property |Description
+
+|`jnosql.dynamodb.endpoint`
+|DynamoDB’s URL
+
+|`jnosql.dynamodb.region`
+|Configure the region with which the application should communicate.
+
+|`jnosql.dynamodb.profile`
+| Define the name of the profile that should be used by this credentials provider.
+
+|`jnosql.dynamodb.awsaccesskey`
+|The AWS access key, used to identify the user interacting with AWS.
+
+|`jnosql.dynamodb.secretaccess`
+|The AWS secret access key, used to authenticate the user interacting with AWS.
+
+
+|===
+
+This is an example using DynamoDB's Key-Value API with MicroProfile Config.
+
+[source,properties]
+----
+jnosql.keyvalue.provider=org.eclipse.jnosql.databases.dynamodb.communication.DynamoDBKeyValueConfiguration
+jnosql.keyvalue.database=heroes
+----
+
 == Elasticsearch
 
 image::https://jnosql.github.io/img/logos/elastic.svg[Elasticsearch Project,align="center"width=25%,height=25%]
@@ -1155,6 +1211,7 @@ jnosql.document.provider=org.eclipse.jnosql.databases.ravendb.communication.Rave
 jnosql.document.database=heroes
 ----
 
+
 == Redis
 
 image::https://jnosql.github.io/img/logos/redis.png[Redis Project,align="center" width=25%,height=25%]

jnosql-dynamodb/Dockerfile

@@ -1,8 +1,7 @@
 AWS_ACCESS_KEY_ID=$(aws --profile default configure get aws_access_key_id)
 AWS_SECRET_ACCESS_KEY=$(aws --profile default configure get aws_secret_access_key)
 
-docker build -t my_app .
 docker run -it --rm  -p 8000:8000 \
    -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
    -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
-   my_app
+   amazon/dynamodb-local

jnosql-dynamodb/dynamoDockerRun.sh

@@ -18,8 +18,12 @@
         <version>1.0.0-SNAPSHOT</version>
     </parent>
 
-
     <artifactId>jnosql-dynamodb</artifactId>
+    <description>The Eclipse JNoSQL layer implementation AWS DynamoDB</description>
+
+    <properties>
+        <dynamodb.version>2.20.65</dynamodb.version>
+    </properties>
 
     <dependencies>
         <dependency>
@@ -38,7 +42,7 @@
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>dynamodb</artifactId>
-            <version>2.15.40</version>
+            <version>${dynamodb.version}</version>
         </dependency>
         <dependency>
             <groupId>org.testcontainers</groupId>

jnosql-dynamodb/pom.xml

@@ -39,11 +39,11 @@
 
 @EnabledIfSystemProperty(named = NAMED, matches = MATCHES)
 public class DynamoDBKeyValueEntityManagerTest {
-	
-	private BucketManager keyValueEntityManager;
+
+    private BucketManager keyValueEntityManager;
 
     private BucketManagerFactory keyValueEntityManagerFactory;
-    
+
     private DynamoDBKeyValueConfiguration configuration;
 
     private User userOtavio = new User("otavio");
@@ -54,7 +54,7 @@ public class DynamoDBKeyValueEntityManagerTest {
 
     @BeforeEach
     public void init() {
-        keyValueEntityManagerFactory = DynamoDBTestUtils.get();
+        keyValueEntityManagerFactory = DynamoDBTestUtils.INSTANCE.get();
         keyValueEntityManager = keyValueEntityManagerFactory.apply("users-entity");
     }
 
@@ -115,10 +115,10 @@ public void shouldRemoveMultiKey() {
         Iterable<Value> users = values;
         assertEquals(0L, StreamSupport.stream(keyValueEntityManager.get(keys).spliterator(), false).count());
     }
-    
+
     @AfterAll
     public static void shutDown() {
-    	DynamoDBTestUtils.shutDown();
+        DynamoDBTestUtils.INSTANCE.shutDown();
     }
 
 }

jnosql-dynamodb/src/test/java/org/eclipse/jnosql/databases/dynamodb/communication/DynamoDBKeyValueEntityManagerTest.java

@@ -17,29 +17,29 @@
 import org.eclipse.jnosql.communication.Settings;
 import org.eclipse.jnosql.communication.keyvalue.BucketManagerFactory;
 import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.containers.wait.strategy.WaitStrategy;
 
-public class DynamoDBTestUtils {
+import java.util.function.Supplier;
 
-    private static GenericContainer dynamodb =
-            new GenericContainer("amazon/dynamodb-local:latest")
-                    .withExposedPorts(8000)
-                    .withEnv("AWS_ACCESS_KEY_ID", "aws --profile default configure get aws_access_key_id")
-                    .withEnv("AWS_SECRET_ACCESS_KEY", "aws --profile default configure get aws_secret_access_key");
-    //.withCommand("--rm");
+public enum DynamoDBTestUtils implements Supplier<BucketManagerFactory> {
 
-    // .waitingFor(Wait.forHttp("/")
-    //       .forStatusCode(200));
+    INSTANCE;
 
+    private final GenericContainer dynamodb =
+            new GenericContainer("amazon/dynamodb-local:latest")
+                    .withExposedPorts(8000)
+                    .waitingFor(Wait.defaultWaitStrategy());
 
-    public static BucketManagerFactory get() {
+    public BucketManagerFactory get() {
         dynamodb.start();
         DynamoDBKeyValueConfiguration configuration = new DynamoDBKeyValueConfiguration();
         String endpoint = "http://" + dynamodb.getHost() + ":" + dynamodb.getFirstMappedPort();
         return configuration.apply(Settings.builder()
                 .put(DynamoDBConfigurations.ENDPOINT, endpoint).build());
     }
 
-    public static void shutDown() {
+    public void shutDown() {
         dynamodb.close();
     }
 }