Publishing version 1.0 of Dialog

Author: rekire

.gitignore

@@ -0,0 +1,15 @@
+# IntelliJ project files
+.idea
+!.idea/inspectionProfiles/*
+!.idea/codeStyles/*
+!.idea/kotlinc.xml
+.gradle
+out
+local.properties
+build
+
+# Eclipse project files
+.classpath
+.settings
+.project
+*.iml

.travis.yml

@@ -0,0 +1,22 @@
+language: java
+
+notifications:
+  email: false
+
+script:
+  - ./gradlew test build
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/
+
+jdk:
+    - oraclejdk8
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

LICENSE

@@ -0,0 +1,16 @@
+The MIT license (MIT)
+
+Copyright (c) 2018 REWE Digital GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MAINTAINERS

@@ -0,0 +1,2 @@
+Volkmar Vogel <[email protected]>
+René Kilczan <[email protected]>

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,43 @@
+## Pull Request Template
+
+Please use this to create a roadmap for your project or to track bugs. A pull request template improves development quality and provides a common guideline for contributors to follow. It also enables to you to reference issues and shows others your development progress.
+
+<!--- Provide a general summary of your changes in the Title above -->
+
+### Description
+<!--- Describe your changes in detail -->
+
+### Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+<!--- You can reference to an issue or pr with the #<number> -->
+
+### Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+### How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+<!--- If you already have CI configured you can remove this part -->
+
+### Screenshots (if appropriate):
+
+### Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+### Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have read the **CONTRIBUTING** document.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+<!--- Provide a general summary of your changes in the Title above -->

README.md

@@ -0,0 +1,145 @@
+# Dialog [![Build Status][travis-image]][travis-url] [![Code Coverage][codecov-img]][codecov-url] [![License: MIT][mit-image]][mit-url] [![Stars][star-img]][star-url]
+
+Dialog is a Dialogflow v2 API implementation written in Kotlin. With some great optional extensions you can use to
+write your own voice application fast.
+
+## Top features
+
+- Dialogflow V2 API reference implementation written in Kotlin
+- Interceper API for adding e.g. tracking
+- Spring reference implementation
+- SSML builder for creating rich responses
+- Plugin for Konversation to distinct the dialogs from code
+
+### Dialogflow API v2 Usage
+
+A response with a simple response and a basic card would look like this:
+
+    return handler.responseBuilder
+        .expectUserResponse(true)
+        .withGoogleSimpleResponse(speech)
+        .withGoogleBasicCard(
+            title = "CardTitle",
+            subtitle = "CardSubTitle",
+            formattedText = "CardFormattedText",
+            buttons = mutableListOf(
+                GoogleButton(
+                    title = "ButtonText",
+                    openUrlAction = OpenUrlAction(url = "https://rewe-digital.com/")
+                )
+            )
+        )
+        .withGoogleSimpleResponse(question)
+        .withGoogleSuggestions(*suggestions.orEmpty())
+
+<sup>Example taken from [UiElementsIntentHandler](spring-sample/src/main/kotlin/org/rewedigital/dialog/springsample/intenthandler/UiElementsIntentHandler.kt#L40-L54)</sub>
+
+Here is a list of some selected methods you can use to create the response of your voice application:
+- [`askGoogleForCoarseLocation(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/ask-google-for-coarse-location.md)
+- [`askGoogleForLocation(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/ask-google-for-location.md)
+- [`askGoogleForPreciseLocation(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/ask-google-for-precise-location.md)
+- [`askGoogleForSignIn(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/ask-google-for-sign-in.md)
+- [`expectUserResponse(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/expect-user-response.md)
+- [`withCard(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-card.md)
+- [`withGoogleBasicCard(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-basic-card.md)
+- [`withGoogleCarouselSelect(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-carousel-select.md)
+- [`withGoogleLinkOutSuggestion(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-link-out-suggestion.md)
+- [`withGoogleListSelect(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-list-select.md)
+- [`withGoogleReprompts(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-reprompts.md)
+- [`withGoogleSimpleResponse(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-simple-response.md)
+- [`withGoogleSimpleResponses(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-simple-responses.md)
+- [`withGoogleSuggestions(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-google-suggestions.md)
+- [`withImage(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-image.md)
+- [`withQuickReplies(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-quick-replies.md)
+- [`withText(...)`](docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/with-text.md)
+
+## Dialog Intro
+
+You can use the core library for you own implementation, where you can choose your own application server or your own
+server less hosting. In the end you need to setup your rest endpoints yourself and manage the conversion of the POKOs
+(plain old Kotlin objects).
+
+When you have your request converted to [WebhookRequest] Dialog can handle the request by using the [RequestResolver].
+The constructor expects 4 arguments: `intentHandlers`, `requestInterceptors`, `responseInterceptors` and
+`fallbackAction`. The first three options are lists each of them are explained in more details in the following sections.
+
+### Handling intents
+
+The [DialogflowIntentHandler] is the core where you handle the intents. Each handler can choose independent if it feels
+responsible for the intent. This is very helpful if you have some intents which depends on the current context.
+
+[RequestResolver] will call the function [`canHandleDialogflowIntent(...)`][intent-methods]. When your intent feels
+responsible return `true` then the [`handleDialogflowIntent(...)`][intent-methods] will be called. Please note that
+you define the order of the calls with the order of of the `RequestResolver`'s `intentHandlers`. First come first serve,
+you should avoid that multiple handlers return `true` of the same intent, based your the list implementation the result
+could be random.
+
+As said above the [RequestResolver] will call the [`handleDialogflowIntent(...)`][intent-methods] method if you return
+`true` in the [`canHandleDialogflowIntent`][intent-methods] method. The logic for handling the Intent goes here. To
+create a response use [`input.responseBuilder`][ResponseBuilder].
+
+### Interceptors
+
+You can use the [RequestInterceptor] for tracking. In `onDialogflowRequest()` will get the input where you can grep the
+data you need for analytics.
+
+### FallbackAction
+
+This is a special [DialogflowIntentHandler] which will be invoked when no intent handler will feel responsible for your
+request. Please note that the result of the `canHandle` method will be ignored for the fallback usage.
+
+### Example
+
+    class WelcomeIntentHandler : DialogflowIntentHandler {
+    
+        override fun canHandleDialogflowIntent(handler: DialogflowHandler): Boolean {
+            return handler.action?.equals("input.welcome") ?: false
+        }
+    
+        override fun handleDialogflowIntent(handler: DialogflowHandler): DialogflowResponseBuilder {
+            return handler.responseBuilder.withText("Welcome to Dialog!")
+        }
+    }
+
+
+## Using Dialog with Spring
+
+We have a special plugin for Spring which should make it very easy to implement your own webservice with it. You can use
+the spring-sample project as template for your own project. When you use our plugin you should annotate each intent with
+`@IntentHandler` to make that intent handler to a component which provides you all the advantages of dependency
+injection. The best it that we use it also for discovering your intent handler automatically. For the fallback intent
+you should use the annotation `@FallbackIntentHandler`, if it is missing you service won't start up.
+
+## License
+
+The MIT license (MIT)
+
+Copyright (c) 2018 REWE Digital GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[travis-image]: https://travis-ci.org/rewe-digital-incubator/dialog.svg?branch=master
+[travis-url]: https://travis-ci.org/rewe-digital-incubator/dialog
+[codecov-img]: http://codecov.io/github/rewe-digital-incubator/dialog/coverage.svg?branch=master
+[codecov-url]: http://codecov.io/github/rewe-digital-incubator/dialog?branch=master
+[mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
+[mit-url]: https://opensource.org/licenses/MIT
+[star-img]: https://img.shields.io/github/stars/rewe-digital-incubator/dialog.svg?style=social&label=Star&maxAge=3600
+[star-url]: https://github.com/rewe-digital-incubator/dialog/stargazers
+[WebhookRequest]: core/src/main/kotlin/org/rewedigital/dialog/model/dialogflow/WebhookRequest.kt
+[RequestResolver]: docs/core/org.rewedigital.dialog.resolver/-request-resolver/index.md
+[DialogflowIntentHandler]: docs/core/org.rewedigital.dialog.handler/-dialogflow-intent-handler/index.md
+[intent-methods]: docs/core/org.rewedigital.dialog.handler/-dialogflow-intent-handler/index.md#Functions
+[ResponseBuilder]: docs/core/org.rewedigital.dialog.handler/-dialogflow-response-builder/index.md
+[RequestInterceptor]: docs/core/org.rewedigital.dialog.interceptors/-request-interceptor/index.md

build.gradle

@@ -0,0 +1,36 @@
+apply plugin: 'kotlin'
+apply plugin: 'com.github.ben-manes.versions'
+
+ext {
+    dokka_version = '0.9.17'
+    versions = [:]
+    versions.kotlin = '1.3.11'
+    versions.core = '1.0'
+    versions.ssml = '1.0'
+    versions.ssml_plugin = '1.0'
+    versions.spring_plugin = '1.0'
+    versions.konversation_plugin = '1.0'
+}
+
+buildscript {
+    ext.kotlin_version = '1.3.20'
+    ext.dokka_version = '0.9.17'
+
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+    dependencies {
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath 'com.github.ben-manes:gradle-versions-plugin:0.20.0'
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}"
+    }
+}
+
+allprojects {
+    repositories {
+        mavenLocal()
+        jcenter()
+        maven { url 'https://jitpack.io' }
+    }
+}

core/build.gradle

@@ -0,0 +1,32 @@
+group 'org.rewedigital.voice'
+version rootProject.ext.versions.core
+
+apply plugin: 'kotlin'
+apply plugin: 'maven-publish'
+apply from: '../docu.gradle'
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
+}
+
+publishing.publications {
+    maven(MavenPublication) {
+        artifactId = 'dialog'
+        from components.java
+    }
+}
+
+task sourcesJar(type: Jar, dependsOn: classes) {
+    archiveClassifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    archiveClassifier = 'javadoc'
+    from sourceSets.main.allSource
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}

core/src/main/kotlin/org/rewedigital/dialog/extensions/ListExtensions.kt

@@ -0,0 +1,4 @@
+package org.rewedigital.dialog.extensions
+
+
+internal fun <T> MutableList<T>?.orEmpty() = this ?: mutableListOf()

core/src/main/kotlin/org/rewedigital/dialog/extensions/StringExtensions.kt

@@ -0,0 +1,6 @@
+package org.rewedigital.dialog.extensions
+
+
+private val ssmlRegex = "^(?i)<speak\\b[^>]*>(.*?)</speak>$".toRegex()
+
+internal fun String.isSsml() = ssmlRegex.containsMatchIn(this)