Skip to content
This repository has been archived by the owner on Mar 6, 2020. It is now read-only.

Commit

Permalink
fixed file inclusion into docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@musketyr
musketyr committed Jan 9, 2020
1 parent f04f2f3 commit 56951b8
Show file tree
Hide file tree
Showing 10 changed files with 256 additions and 202 deletions.
103 changes: 1 addition & 102 deletions docs/guide/src/docs/asciidoc/aws.adoc
View file
Expand Up @@ -35,108 +35,7 @@ In this documentation, the high-level approaches will be discussed first before

=== Installation

[source,indent=0,role="primary",subs='verbatim,attributes']
.Gradle
----
compile 'com.agorapulse:micronaut-aws-sdk:{project-version}'
// only required for DynamoDB and Kinesis integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-dynamodb', version: '{aws-sdk-version}'
// only required for DynamoDB Accelerator (DAX) integration
compile group: 'com.amazonaws', name: 'amazon-dax-client', version: '1.0.202017.0'
// only required for Kinesis integration
compile group: 'com.amazonaws', name: 'amazon-kinesis-client', version: '1.9.3'
compile group: 'com.amazonaws', name: 'aws-java-sdk-kinesis', version: '{aws-sdk-version}'
// only required for S3 integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-s3', version: '{aws-sdk-version}'
// only required for SES integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-ses', version: '{aws-sdk-version}'
// only required for SNS integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-sns', version: '{aws-sdk-version}'
// only required for SQS integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-sqs', version: '{aws-sdk-version}'
// only required for STS integration
compile group: 'com.amazonaws', name: 'aws-java-sdk-sts', version: '{aws-sdk-version}'
----

[source,xml,indent=0,role="secondary",subs='verbatim,attributes']
.Maven
----
<dependency>
<groupId>com.agorapulse</groupId>
<artifactId>micronaut-aws-sdk</artifactId>
<version>{project-version}</version>
</dependency>
<!-- only required for DynamoDB and Kinesis integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for DynamoDB Accelerator (DAX) integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>amazon-dax-client</artifactId>
<version>1.0.202017.0</version>
</dependency>
<!-- only required for Kinesis integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>amazon-kinesis-client</artifactId>
<version>1.9.3</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-kinesis</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for S3 integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-s3</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for SES integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-ses</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for SNS integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-sns</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for SQS integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-sqs</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
<!-- only required for STS integration -->
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-sts</artifactId>
<version>{aws-sdk-version}</version>
</dependency>
----
Since `1.2.8` see the particular subprojects for installation instruction.

include::{includedir}/dynamodb.adoc[]

Expand Down
102 changes: 60 additions & 42 deletions docs/guide/src/docs/asciidoc/dynamodb.adoc
View file

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/guide/src/docs/asciidoc/index.adoc
View file
Expand Up @@ -20,7 +20,8 @@ image::https://coveralls.io/repos/github/{project-slug}/badge.svg?branch=master[
Set of useful libraries for http://micronaut.io[Micronaut]. All the libraries are available in https://bintray.com/bintray/jcenter[JCenter Maven repository].

* <<AWS SDK for Micronaut>> - integration for <<DynamoDB>>, <<Kinesis>>, <<Simple Storage Service (S3)>>, <<Simple Email Service (SES)>>, <<Simple Notification Service (SNS)>>, <<Simple Queue Service (SQS)>> and <<WebSockets for API Gateway>>
* <<Micronaut for API Gateway Proxy>> - develop API Gateway Proxy Lambda functions using Micronaut HTTP server capabilities
* <<Micronaut for API Gateway Proxy>> - develop API Gateway Proxy Lambda functions using Micronaut HTTP server capabilities (currently superseded by
the official library)

include::{includedir}/aws.adoc[]

Expand Down
60 changes: 44 additions & 16 deletions docs/guide/src/docs/asciidoc/kinesis.adoc
View file
Expand Up @@ -8,6 +8,34 @@ This library provides three approaches to work with Kinesis streams:
2. High-level <<Listening with `@KinesisListener`>>
3. Middle-level <<Kinesis Service>>
==== Installation

[source,indent=0,role="primary",subs='verbatim,attributes']
.Gradle
----
// for Kinesis client
compile 'com.agorapulse:micronaut-aws-sdk-kinesis:{project-version}'
// for Kinesis worker
compile 'com.agorapulse:micronaut-aws-sdk-kinesis-worker:{project-version}'
----

[source,xml,indent=0,role="secondary",subs='verbatim,attributes']
.Maven
----
<!-- for Kinesis client -->
<dependency>
<groupId>com.agorapulse</groupId>
<artifactId>micronaut-aws-sdk-kinesis</artifactId>
<version>{project-version}</version>
</dependency>
<!-- for Kinesis worker -->
<dependency>
<groupId>com.agorapulse</groupId>
<artifactId>micronaut-aws-sdk-kinesis-worker</artifactId>
<version>{project-version}</version>
</dependency>
----

==== Configuration

By default, only `aws.kinesis.application.name` and `aws.kinesis.listener.stream` are required if you decide to use `@KinesisListener`.
Expand All @@ -16,7 +44,7 @@ Otherwise you need no configuration at all but some of the configuration may be
[source,yaml,indent=0,options="nowrap"]
.application.yml
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/resources/application-docs-kinesis.yml[]
include::{root-dir}/subprojects/micronaut-aws-sdk-test/src/test/resources/application-docs-kinesis.yml[]
----
<1> You can specify the default stream for https://agorapulse.github.io/micronaut-libraries/docs/javadoc/micronaut-aws-sdk/com/agorapulse/micronaut/aws/kinesis/KinesisService.html[KinesisService] and `@KinesisClient`
<2> You can define multiple configurations
Expand All @@ -39,8 +67,8 @@ The following example shows many of available method signatures for publishing r
[source,java,indent=0,options="nowrap"]
.Publishing String Records
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=string]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=string]
}
----
<1> `@KinesisClient` annotation makes the interface a Kinesis client
Expand All @@ -54,8 +82,8 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,options="nowrap"]
.Publishing Byte Array Records
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=bytes]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=bytes]
}
----
<1> `@KinesisClient` annotation makes the interface a Kinesis client
Expand All @@ -68,8 +96,8 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,options="nowrap"]
.Publishing Plain Old Java Objects
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=pogo]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=pogo]
}
----
<1> `@KinesisClient` annotation makes the interface a Kinesis client
Expand All @@ -81,8 +109,8 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,options="nowrap"]
.Publishing Events
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=events]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/DefaultClient.java[tags=events]
}
----
<1> `@KinesisClient` annotation makes the interface a Kinesis client
Expand Down Expand Up @@ -111,7 +139,7 @@ then the method will be triggered with the new records in the stream.
source,java,indent=0,options="nowrap"]
.Publishing Events
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisListenerTester.java[tags=all]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisListenerTester.java[tags=all]
----
<1> `@KinesisListener` method must be declared in a bean, e.g. `@Singleton`
<2> You can listen to just plain string records
Expand Down Expand Up @@ -172,11 +200,11 @@ Then you can setup your tests like this:
[source,groovy,indent=0,role="primary"]
.Groovy
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisAnnotationsSpec.groovy[tags=testcontainers-header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisAnnotationsSpec.groovy[tags=testcontainers-header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisAnnotationsSpec.groovy[tags=testcontainers-setup]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisAnnotationsSpec.groovy[tags=testcontainers-setup]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisAnnotationsSpec.groovy[tags=testcontainers-test]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisAnnotationsSpec.groovy[tags=testcontainers-test]
}
----
Expand All @@ -195,11 +223,11 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,role="secondary"]
.Java
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisTest.java[tags=testcontainers-header]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisTest.java[tags=testcontainers-header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisTest.java[tags=testcontainers-setup]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisTest.java[tags=testcontainers-setup]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/KinesisTest.java[tags=testcontainers-test]
include::{root-dir}/subprojects/micronaut-aws-sdk-kinesis-worker/src/test/groovy/com/agorapulse/micronaut/aws/kinesis/worker/KinesisTest.java[tags=testcontainers-test]
}
----
Expand Down
42 changes: 30 additions & 12 deletions docs/guide/src/docs/asciidoc/s3.adoc
View file
Expand Up @@ -4,6 +4,24 @@

This library provides basic support for Amazon S3 using <<Simple Storage Service>>

==== Installation

[source,indent=0,role="primary",subs='verbatim,attributes']
.Gradle
----
compile 'com.agorapulse:micronaut-aws-sdk-s3:{project-version}'
----

[source,xml,indent=0,role="secondary",subs='verbatim,attributes']
.Maven
----
<dependency>
<groupId>com.agorapulse</groupId>
<artifactId>micronaut-aws-sdk-s3</artifactId>
<version>{project-version}</version>
</dependency>
----

==== Configuration

You can store the name of the bucket in the configuration using `aws.s3.bucket` property. You can create additional configurations
Expand All @@ -13,7 +31,7 @@ by providing 'aws.s3.buckets' configuration map.
[source,yaml,indent=0,options="nowrap"]
.application.yml
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/resources/application-docs-s3.yml[]
include::{root-dir}/subprojects/micronaut-aws-sdk-test/src/test/resources/application-docs-s3.yml[]
----
<1> You can define default bucket for the service
<2> You can define multiple configurations
Expand All @@ -31,15 +49,15 @@ Following example shows some of the most common use cases for working with S3 bu
[source,java,indent=0,options="nowrap"]
.Creating Bucket
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=create-bucket]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=create-bucket]
----
<1> Create new bucket of given name
<2> The bucket is present within the list of all bucket names

[source,java,indent=0,options="nowrap"]
.Upload File
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=store-file]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=store-file]
----
<1> Upload file
<2> File is uploaded
Expand All @@ -48,39 +66,39 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,options="nowrap"]
.Upload from `InputStream`
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=store-input-stream]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=store-input-stream]
----
<1> Upload data from stream
<2> Stream is uploaded

[source,java,indent=0,options="nowrap"]
.Generate URL
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=generate-url]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=generate-url]
----
<1> Generate presigned URL
<2> Downloaded content corresponds with the expected content

[source,java,indent=0,options="nowrap"]
.Download File
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=download-file]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=download-file]
----
<1> Prepare a destination file
<2> Download the file locally

[source,java,indent=0,options="nowrap"]
.Delete File
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=delete-file]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=delete-file]
----
<1> Delete file
<2> The file is no longer present

[source,java,indent=0,options="nowrap"]
.Delete Bucket
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=delete-bucket]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=delete-bucket]
----
<1> Delete bucket
<2> The Bucket is no longer present
Expand Down Expand Up @@ -123,8 +141,8 @@ Then you can setup your tests like this:
[source,groovy,indent=0,role="primary"]
.Groovy
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceSpec.groovy[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceSpec.groovy[tags=setup]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceSpec.groovy[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceSpec.groovy[tags=setup]
// test methods
Expand All @@ -141,9 +159,9 @@ include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse
[source,java,indent=0,role="secondary"]
.Java
----
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=header]
include::{root-dir}/subprojects/micronaut-aws-sdk/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=setup]
include::{root-dir}/subprojects/micronaut-aws-sdk-s3/src/test/groovy/com/agorapulse/micronaut/aws/s3/SimpleStorageServiceTest.java[tags=setup]
// test methods
Expand Down

0 comments on commit 56951b8

Please sign in to comment.