Merge pull request #1 from launchdarkly/eb/initial

initial version of Java DynamoDB store

Author: eli-darkly

.circleci/config.yml

@@ -0,0 +1,27 @@
+version: 2
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - build
+
+jobs:
+  build:
+    docker:
+      - image: circleci/java
+      - image: amazon/dynamodb-local
+    steps:
+      - checkout
+      - run: cp gradle.properties.example gradle.properties
+      - run: ./gradlew test
+      - run:
+          name: Save test results
+          command: |
+            mkdir -p ~/junit/;
+            find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} ~/junit/ \;
+          when: always
+      - store_test_results:
+          path: ~/junit
+      - store_artifacts:
+          path: ~/junit

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+All notable changes to the LaunchDarkly Java SDK DynamoDB integration will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
+
+## [1.0.0] - 2018-12-10
+
+Initial release.

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+Contributing to this library
+============================
+
+The source code for this library is [here](https://github.com/launchdarkly/java-dynamodb-store). We encourage pull-requests and other contributions from the community. Since this library is meant to be used in conjunction with the LaunchDarkly Java SDK, you may want to look at the [Java SDK source code](https://github.com/launchdarkly/java-client) and our [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide).

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -0,0 +1,96 @@
+LaunchDarkly SDK for Java - DynamoDB integration
+================================================
+
+[![Circle CI](https://circleci.com/gh/launchdarkly/java-dynamodb-store.svg?style=shield)](https://circleci.com/gh/launchdarkly/java-dynamodb-store)
+[![Javadocs](http://javadoc.io/badge/com.launchdarkly/launchdarkly-client.svg)](http://javadoc.io/doc/com.launchdarkly/launchdarkly-client-dynamodb-store)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Flaunchdarkly%2Fjava-dynamodb-store.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Flaunchdarkly%2Fjava-dynamodb-store?ref=badge_shield)
+
+This library provides a DynamoDB-backed persistence mechanism (feature store) for the [LaunchDarkly Java SDK](https://github.com/launchdarkly/java-client), replacing the default in-memory feature store.
+
+The minimum version of the LaunchDarkly Java SDK for use with this library is 4.6.0. It is compatible with Java 7 and above.
+
+It uses version 1.11 of the AWS SDK for Java; a future release will use version 2.x.
+
+For more information, see also: [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+
+Quick setup
+-----------
+
+This assumes that you have already installed the LaunchDarkly Java SDK.
+
+0. Add this library to your project:
+
+        <dependency>
+          <groupId>com.launchdarkly</groupId>
+          <artifactId>launchdarkly-client-dynamodb-store</artifactId>
+          <version>1.0.0</version>
+        </dependency>
+
+1. If you do not already have the AWS SDK in your project, add the DynamoDB part of it. (This needs to be added separately, rather than being included in the LaunchDarkly jar, because AWS classes are exposed in the public interface.)
+
+        <dependency>
+          <groupId>com.amazonaws</groupId>
+          <artifactId>com.amazonaws:aws-java-sdk-dynamodb</artifactId>
+          <version>1.11.327</version>
+        </dependency>
+
+2. Import the LaunchDarkly package and the package for this library:
+
+        import com.launchdarkly.client.*;
+        import com.launchdarkly.client.dynamodb.*;
+
+3. When configuring your SDK client, add the DynamoDB feature store:
+
+        DynamoDbFeatureStoreBuilder store = DatabaseComponents.dynamoDbFeatureStore("my-table-name")
+            .caching(FeatureStoreCaching.enabled().ttlSeconds(30));
+        
+        LDConfig config = new LDConfig.Builder()
+            .featureStoreFactory(store)
+            .build();
+        
+        LDClient client = new LDClient("YOUR SDK KEY", config);
+
+The specified table must already exist in DynamoDB. It must have a partition key called "namespace" and a sort key called "key".
+
+By default, the DynamoDB client will try to get your AWS credentials and region name from environment variables and/or local configuration files, as described in the AWS SDK documentation. There are methods in `DynamoDBFeatureStoreBuilder` for changing the configuration options. Alternatively, if you already have a fully configured DynamoDB client object, you can tell LaunchDarkly to use that:
+
+        DynamoDbFeatureStoreBuilder store = DatabaseComponents.dynamoDbFeatureStore("my-table-name")
+            .existingClient(myDynamoDbClientInstance);
+
+Caching behavior
+----------------
+
+To reduce traffic to DynamoDB, there is an optional in-memory cache that retains the last known data for a configurable amount of time. This is on by default; to turn it off (and guarantee that the latest feature flag data will always be retrieved from DynamoDB for every flag evaluation), configure the store as follows:
+
+        DynamoDbFeatureStoreBuilder store = DatabaseComponents.dynamoDbFeatureStore("my-table-name")
+            .caching(FeatureStoreCaching.disabled());
+
+For other ways to control the behavior of the cache, see `DynamoDbFeatureStoreBuilder.caching()`.
+
+About LaunchDarkly
+-----------
+
+* LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
+    * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+    * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+    * Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+    * Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+* LaunchDarkly provides feature flag SDKs for
+    * [Java](http://docs.launchdarkly.com/docs/java-sdk-reference "Java SDK")
+    * [JavaScript](http://docs.launchdarkly.com/docs/js-sdk-reference "LaunchDarkly JavaScript SDK")
+    * [PHP](http://docs.launchdarkly.com/docs/php-sdk-reference "LaunchDarkly PHP SDK")
+    * [Python](http://docs.launchdarkly.com/docs/python-sdk-reference "LaunchDarkly Python SDK")
+    * [Go](http://docs.launchdarkly.com/docs/go-sdk-reference "LaunchDarkly Go SDK")
+    * [Node.JS](http://docs.launchdarkly.com/docs/node-sdk-reference "LaunchDarkly Node SDK")
+    * [Electron](http://docs.launchdarkly.com/docs/electron-sdk-reference "LaunchDarkly Electron SDK")
+    * [.NET](http://docs.launchdarkly.com/docs/dotnet-sdk-reference "LaunchDarkly .Net SDK")
+    * [Ruby](http://docs.launchdarkly.com/docs/ruby-sdk-reference "LaunchDarkly Ruby SDK")
+    * [iOS](http://docs.launchdarkly.com/docs/ios-sdk-reference "LaunchDarkly iOS SDK")
+    * [Android](http://docs.launchdarkly.com/docs/android-sdk-reference "LaunchDarkly Android SDK")
+* Explore LaunchDarkly
+    * [launchdarkly.com](http://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
+    * [docs.launchdarkly.com](http://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDKs
+    * [apidocs.launchdarkly.com](http://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
+    * [blog.launchdarkly.com](http://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
+    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies
+

build.gradle

@@ -0,0 +1,193 @@
+apply plugin: 'java'
+apply plugin: 'maven-publish'
+apply plugin: 'signing'
+apply plugin: 'idea'
+apply plugin: 'com.github.johnrengelman.shadow'
+apply plugin: 'io.codearte.nexus-staging'
+
+import com.github.jengelman.gradle.plugins.shadow.tasks.ConfigureShadowRelocation
+
+configurations.all {
+    // check for updates every build for dependencies with: 'changing: true'
+    resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
+}
+
+repositories {
+    mavenLocal()
+    // Before LaunchDarkly release artifacts get synced to Maven Central they are here along with snapshots:
+    maven { url "https://oss.sonatype.org/content/groups/public/" }
+    mavenCentral()
+}
+
+allprojects {
+    group = 'com.launchdarkly'
+    version = "${version}"
+    sourceCompatibility = 1.7
+    targetCompatibility = 1.7
+}
+
+ext {
+    sdkBasePackage = "com.launchdarkly.client.dynamodb"
+    sdkBaseName = "launchdarkly-client-dynamodb-store"
+}
+
+ext.libraries = [:]
+
+// Add dependencies to "libraries.internal" that are not exposed in our public API. These
+// will be embedded with shaded names in the uberjar.
+libraries.internal = [
+    "com.google.guava:guava:19.0"
+]
+
+// Add dependencies to "libraries.external" that are exposed in our public API, or that have
+// global state that must be shared between the SDK and the caller. These are not embedded
+// in the uberjar; the caller must provide them on the classpath at runtime.
+libraries.external = [
+    "com.launchdarkly:launchdarkly-client:4.6.0-SNAPSHOT",
+    "com.amazonaws:aws-java-sdk-dynamodb:1.11.327",
+    "org.slf4j:slf4j-api:1.7.21"
+]
+
+// Add dependencies to "libraries.test" that are used only in unit tests.
+libraries.test = [
+    "org.hamcrest:hamcrest-all:1.3",
+    "junit:junit:4.12",
+    "ch.qos.logback:logback-classic:1.1.7",
+    "com.launchdarkly:launchdarkly-client:4.6.0-SNAPSHOT:test" // our unit tests use helper classes from the SDK
+]
+
+dependencies {
+    implementation libraries.internal
+    compileClasspath libraries.external
+    runtime libraries.internal
+    testImplementation libraries.test, libraries.internal, libraries.external
+
+    // Unlike what the name might suggest, the "shadow" configuration specifies dependencies that
+    // should *not* be shaded by the Shadow plugin when we build our shaded jars.
+    shadow libraries.external
+}
+
+buildscript {
+    repositories {
+        jcenter()
+        mavenCentral()
+        mavenLocal()
+    }
+    dependencies {
+        classpath 'org.ajoberstar:gradle-git:1.5.0-rc.1'
+        classpath 'com.github.jengelman.gradle.plugins:shadow:2.0.4'
+        classpath "io.codearte.gradle.nexus:gradle-nexus-staging-plugin:0.8.0"
+    }
+}
+
+task sourcesJar(type: Jar, dependsOn: classes) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier = 'javadoc'
+    from javadoc.destinationDir
+}
+
+shadowJar {
+    baseName = sdkBaseName
+    
+    // No classifier means that the shaded jar becomes the default artifact
+    classifier = ''
+
+    manifest {
+        attributes("Implementation-Version": version)
+    }
+}
+
+task relocateShadowJar(type: ConfigureShadowRelocation) {
+    target = tasks.shadowJar
+    prefix = "com.launchdarkly.shaded"
+}
+
+tasks.shadowJar.dependsOn tasks.relocateShadowJar
+
+artifacts {
+    archives sourcesJar, javadocJar, shadowJar
+}
+
+test {
+    testLogging {
+        events "passed", "skipped", "failed", "standardOut", "standardError"
+        showStandardStreams = true
+        exceptionFormat = 'full'
+    }
+}
+
+idea {
+    module {
+        downloadJavadoc = true
+        downloadSources = true
+    }
+}
+
+nexusStaging {
+    packageGroup = "com.launchdarkly"
+}
+
+def pomConfig = {
+    name 'LaunchDarkly Java SDK DynamoDB integration'
+    packaging 'jar'
+    url 'https://github.com/launchdarkly/java-dynamodb-store'
+
+    licenses {
+        license {
+            name 'The Apache License, Version 2.0'
+            url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+        }
+    }
+
+    developers {
+        developer {
+            id 'jkodumal'
+            name 'John Kodumal'
+            email 'john@launchdarkly.com'
+        }
+    }
+
+    scm {
+        connection 'scm:git:git://github.com/launchdarkly/java-dynamodb-store.git'
+        developerConnection 'scm:git:ssh:git@github.com:launchdarkly/java-dynamodb-store.git'
+        url 'https://github.com/launchdarkly/java-dynamodb-store'
+    }
+}
+
+publishing {
+    publications {
+        shadow(MavenPublication) { publication ->
+            project.shadow.component(publication)
+
+            artifactId = sdkBaseName
+            artifact sourcesJar
+            artifact javadocJar
+            
+            pom.withXml {
+                def root = asNode()
+                root.appendNode('description', 'DynamoDB-backed feature store for the LaunchDarkly Java SDK')
+                asNode().children().last() + pomConfig
+            }
+        }
+    }
+    repositories {
+        mavenLocal()
+        maven {
+            def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
+            def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
+            url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
+            credentials {
+                username ossrhUsername
+                password ossrhPassword
+            }
+        }
+    }
+}
+
+signing {
+    sign publishing.publications.shadow
+}

gradle.properties

@@ -0,0 +1,3 @@
+version=1.0.0-SNAPSHOT
+ossrhUsername=
+ossrhPassword=

gradle.properties.example

@@ -0,0 +1,7 @@
+githubUser = YOUR_GITHUB_USERNAME
+githubPassword = YOUR_GITHUB_PASSWORD
+signing.keyId = 5669D902
+signing.password = SIGNING_PASSWORD
+signing.secretKeyRingFile = SECRET_RING_FILE
+ossrhUsername = launchdarkly
+ossrhPassword = OSSHR_PASSWORD

gradle/wrapper/gradle-wrapper.jar

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