diff --git a/.github/workflows/samples-compilation.yaml b/.github/workflows/samples-compilation.yaml index f279134a8..3d5c2c25e 100644 --- a/.github/workflows/samples-compilation.yaml +++ b/.github/workflows/samples-compilation.yaml @@ -1,4 +1,4 @@ -name: Snippets Compilation +name: Examples Compilation on: [push] diff --git a/examples/compile.sh b/examples/compile.sh index 7b868c724..f167ffde7 100755 --- a/examples/compile.sh +++ b/examples/compile.sh @@ -1,3 +1,4 @@ #!/bin/sh (cd snippets && ./compile.sh) || exit 1 +(cd webhooks && ./compile.sh) || exit 1 diff --git a/examples/webhooks/.mvn/wrapper/maven-wrapper.properties b/examples/webhooks/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..d58dfb70b --- /dev/null +++ b/examples/webhooks/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip diff --git a/examples/webhooks/README.md b/examples/webhooks/README.md new file mode 100644 index 000000000..3f2626fd5 --- /dev/null +++ b/examples/webhooks/README.md @@ -0,0 +1,79 @@ +# Backend application built using Sinch Java SDK to handle incoming webhooks + +This directory contains a server application based onto [Sinch SDK java](https://github.com/sinch/sinch-sdk-java) + +## Requirements + +- JDK 21 or later (Sinch SDK Java is requiring java 8 only but client application can use latest available version) +- [Maven](https://maven.apache.org/) +- [SpringBoot](https://spring.io/projects/spring-boot) +- [Sinch account](https://dashboard.sinch.com) +- [ngrok](https://ngrok.com/docs) + +## Configuration + +### Configure application settings + +com.mycompany.app.Application settings are using the `SpringBoot` configuration file: [`application.yaml`](src/main/resources/application.yaml) file and enable to configure: + +#### Sinch credentials +Located in `credentials` section (*you can find all of the credentials you need on your [Sinch dashboard](https://dashboard.sinch.com)*): +- `project-id`: YOUR_project_id +- `key-id`: YOUR_access_key_id +- `key-secret`: YOUR_access_key_secret + +#### Server port +Default: 8090 + +Located in `server` section: +- port: The port to be used to listen to incoming requests. Default: 8090 + +## Usage + +### Start server +1. Edit configuration file + + See above for Configuration paragraph + +2. Start server locally. + + Compile and run the application as server locally. + ```bash + ./mvnw clean spring-boot:run + ``` +### EndPoints +When server is online, declared controllers will respond to following endpoints + +| Service | Endpoint | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| [Conversation](https://developers.sinch.com/docs/conversation/callbacks) | /ConversationEvent | +| [Numbers](https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks/#tag/Numbers-Callbacks/operation/ImportedNumberService_EventsCallback) | /NumbersEvent | +| [SMS](https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/section/Callbacks) | /SmsEvent | +| [Verification](https://developers.sinch.com/docs/verification/api-reference/verification/tag/Verification-callbacks/) | /VerificationEvent | +| [Voice](https://developers.sinch.com/docs/voice/api-reference/voice/tag/Callbacks/) | /VoiceEvent | + +## Use ngrok to forward request to local server + +Forwarding request to same `8090` port used above: + +*Note: The `8090` value is coming from default config and can be changed (see [Server port](#Server port) configuration section)* + +```bash +ngrok http 8090 +``` + +ngrok output will contains output like: +``` +ngrok (Ctrl+C to quit) + +... +Forwarding https://0e64-78-117-86-140.ngrok-free.app -> http://localhost:8090 + +``` +The line +``` +Forwarding https://0e64-78-117-86-140.ngrok-free.app -> http://localhost:8090 +``` +Contains `https://0e64-78-117-86-140.ngrok-free.app` value. + +This value must be used to configure callback's URL from your [Sinch dashboard](https://dashboard.sinch.com/sms/api/services) \ No newline at end of file diff --git a/examples/webhooks/compile.sh b/examples/webhooks/compile.sh new file mode 100755 index 000000000..c121b1334 --- /dev/null +++ b/examples/webhooks/compile.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +mvn clean spotless:apply || exit 1 + +./mvnw clean compile || exit 1 diff --git a/examples/webhooks/mvnw b/examples/webhooks/mvnw new file mode 100755 index 000000000..19529ddf8 --- /dev/null +++ b/examples/webhooks/mvnw @@ -0,0 +1,259 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.2 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/examples/webhooks/mvnw.cmd b/examples/webhooks/mvnw.cmd new file mode 100644 index 000000000..b150b91ed --- /dev/null +++ b/examples/webhooks/mvnw.cmd @@ -0,0 +1,149 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.2 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' +$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/examples/webhooks/pom.xml b/examples/webhooks/pom.xml new file mode 100644 index 000000000..0179203e8 --- /dev/null +++ b/examples/webhooks/pom.xml @@ -0,0 +1,90 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 4.0.0 + + + + my.company.com + sinch-java-sdk-webhooks-application + 0.0.1-SNAPSHOT + Sinch Java SDK Webhooks Application + + + [1.0.0,) + 21 + + + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.boot + spring-boot-starter-web + + + + com.sinch.sdk + sinch-sdk-java + ${sinch.sdk.java.version} + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + com.diffplug.spotless + spotless-maven-plugin + 2.40.0 + + + + + + **/*.java + + + + 1.22.0 + true + + + + + true + 2 + + + + + + + + + verify + + check + + + + + + + + + diff --git a/examples/webhooks/src/main/java/com/mycompany/app/Application.java b/examples/webhooks/src/main/java/com/mycompany/app/Application.java new file mode 100644 index 000000000..03b399f0f --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/Application.java @@ -0,0 +1,12 @@ +package com.mycompany.app; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/Config.java b/examples/webhooks/src/main/java/com/mycompany/app/Config.java new file mode 100644 index 000000000..427dfb342 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/Config.java @@ -0,0 +1,74 @@ +package com.mycompany.app; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.core.utils.StringUtil; +import com.sinch.sdk.models.Configuration; +import com.sinch.sdk.models.ConversationRegion; +import com.sinch.sdk.models.SMSRegion; +import java.util.logging.Logger; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; + +@org.springframework.context.annotation.Configuration +public class Config { + + private static final Logger LOGGER = Logger.getLogger(Config.class.getName()); + + @Value("${credentials.project-id: }") + String projectId; + + @Value("${credentials.key-id: }") + String keyId; + + @Value("${credentials.key-secret: }") + String keySecret; + + @Value("${credentials.application-api-key: }") + String applicationKey; + + @Value("${credentials.application-api-secret: }") + String applicationSecret; + + @Value("${conversation.region: }") + String conversationRegion; + + @Value("${sms.region: }") + String smsRegion; + + @Bean + public SinchClient sinchClient() { + + Configuration.Builder builder = Configuration.builder(); + + if (!StringUtil.isEmpty(projectId)) { + builder.setProjectId(projectId); + } + + if (!StringUtil.isEmpty(keyId)) { + builder.setKeyId(keyId); + } + if (!StringUtil.isEmpty(keySecret)) { + builder.setKeySecret(keySecret); + } + + if (!StringUtil.isEmpty(applicationKey)) { + builder.setApplicationKey(applicationKey); + } + + if (!StringUtil.isEmpty(applicationSecret)) { + builder.setApplicationSecret(applicationSecret); + } + + if (!StringUtil.isEmpty(conversationRegion)) { + builder.setConversationRegion(ConversationRegion.from(conversationRegion)); + LOGGER.info(String.format("Conversation region: '%s'", conversationRegion)); + } + + if (!StringUtil.isEmpty(smsRegion)) { + builder.setSmsRegion(SMSRegion.from(smsRegion)); + LOGGER.info(String.format("SMS region: '%s'", smsRegion)); + } + + return new SinchClient(builder.build()); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/conversation/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/conversation/Controller.java new file mode 100644 index 000000000..befb0835a --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/conversation/Controller.java @@ -0,0 +1,111 @@ +package com.mycompany.app.conversation; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.domains.conversation.api.v1.WebHooksService; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.ConversationWebhookEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.capability.CapabilityEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.channel.ChannelEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactCreateEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactDeleteEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactIdentitiesDuplicationEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactMergeEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactUpdateEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationDeleteEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationStartEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationStopEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.delivery.EventDeliveryReceiptEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.delivery.MessageDeliveryReceiptEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.inbound.InboundEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.message.MessageInboundEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.message.MessageSubmitEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting.OptInEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting.OptOutEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.record.RecordNotificationEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations.MessageInboundSmartConversationRedactionEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations.SmartConversationsEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.unsupported.UnsupportedCallbackEvent; +import java.util.Map; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController("Conversation") +public class Controller { + + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + + @Value("${conversation.webhooks.secret: }") + private String webhooksSecret; + + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/ConversationEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity ConversationEvent( + @RequestHeader Map headers, @RequestBody String body) { + + WebHooksService webhooks = sinchClient.conversation().v1().webhooks(); + + // set this value to true to validate request from Sinch servers + // see https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks for + // more information + boolean ensureValidAuthentication = false; + if (ensureValidAuthentication) { + // ensure valid authentication to handle request + var validAuth = webhooks.validateAuthenticationHeader(webhooksSecret, headers, body); + + // token validation failed + if (!validAuth) { + throw new ResponseStatusException(HttpStatus.UNAUTHORIZED); + } + } + + // decode the request payload + ConversationWebhookEvent event = webhooks.parseEvent(body); + + // let business layer process the request + switch (event) { + case CapabilityEvent e -> webhooksBusinessLogic.handleCapabilityEvent(e); + case ChannelEvent e -> webhooksBusinessLogic.handleChannelEvent(e); + case ContactCreateEvent e -> webhooksBusinessLogic.handleContactCreateEvent(e); + case ContactDeleteEvent e -> webhooksBusinessLogic.handleContactDeleteEvent(e); + case ContactIdentitiesDuplicationEvent e -> + webhooksBusinessLogic.handleContactIdentitiesDuplicationEvent(e); + case ContactMergeEvent e -> webhooksBusinessLogic.handleContactMergeEvent(e); + case ContactUpdateEvent e -> webhooksBusinessLogic.handleContactUpdateEvent(e); + case ConversationDeleteEvent e -> webhooksBusinessLogic.handleConversationDeleteEvent(e); + case ConversationStartEvent e -> webhooksBusinessLogic.handleConversationStartEvent(e); + case ConversationStopEvent e -> webhooksBusinessLogic.handleConversationStopEvent(e); + case EventDeliveryReceiptEvent e -> webhooksBusinessLogic.handleEventDeliveryReceiptEvent(e); + case InboundEvent e -> webhooksBusinessLogic.handleInboundEvent(e); + case MessageDeliveryReceiptEvent e -> + webhooksBusinessLogic.handleMessageDeliveryReceiptEvent(e); + case MessageInboundEvent e -> webhooksBusinessLogic.handleMessageInboundEvent(e); + case MessageInboundSmartConversationRedactionEvent e -> + webhooksBusinessLogic.handleMessageInboundSmartConversationRedactionEvent(e); + case MessageSubmitEvent e -> webhooksBusinessLogic.handleMessageSubmitEvent(e); + case OptInEvent e -> webhooksBusinessLogic.handleOptInEvent(e); + case OptOutEvent e -> webhooksBusinessLogic.handleOptOutEvent(e); + case RecordNotificationEvent e -> webhooksBusinessLogic.handleRecordNotificationEvent(e); + case SmartConversationsEvent e -> webhooksBusinessLogic.handleSmartConversationsEvent(e); + case UnsupportedCallbackEvent e -> webhooksBusinessLogic.handleUnsupportedCallbackEvent(e); + default -> throw new IllegalStateException("Unexpected value: " + event); + } + + return ResponseEntity.ok().build(); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/conversation/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/conversation/ServerBusinessLogic.java new file mode 100644 index 000000000..f4a8458b3 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/conversation/ServerBusinessLogic.java @@ -0,0 +1,137 @@ +package com.mycompany.app.conversation; + +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.capability.CapabilityEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.channel.ChannelEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactCreateEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactDeleteEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactIdentitiesDuplicationEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactMergeEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact.ContactUpdateEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationDeleteEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationStartEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation.ConversationStopEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.delivery.EventDeliveryReceiptEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.delivery.MessageDeliveryReceiptEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.inbound.InboundEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.message.MessageInboundEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.message.MessageSubmitEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting.OptInEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting.OptOutEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.record.RecordNotificationEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations.MessageInboundSmartConversationRedactionEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations.SmartConversationsEvent; +import com.sinch.sdk.domains.conversation.models.v1.webhooks.events.unsupported.UnsupportedCallbackEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("ConversationServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); + + public void handleCapabilityEvent(CapabilityEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleChannelEvent(ChannelEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleContactCreateEvent(ContactCreateEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleContactDeleteEvent(ContactDeleteEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleContactIdentitiesDuplicationEvent(ContactIdentitiesDuplicationEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleContactMergeEvent(ContactMergeEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleContactUpdateEvent(ContactUpdateEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleConversationDeleteEvent(ConversationDeleteEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleConversationStartEvent(ConversationStartEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleConversationStopEvent(ConversationStopEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleEventDeliveryReceiptEvent(EventDeliveryReceiptEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleInboundEvent(InboundEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleMessageDeliveryReceiptEvent(MessageDeliveryReceiptEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleMessageInboundEvent(MessageInboundEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleMessageInboundSmartConversationRedactionEvent( + MessageInboundSmartConversationRedactionEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleMessageSubmitEvent(MessageSubmitEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleOptInEvent(OptInEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleOptOutEvent(OptOutEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleRecordNotificationEvent(RecordNotificationEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleSmartConversationsEvent(SmartConversationsEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void handleUnsupportedCallbackEvent(UnsupportedCallbackEvent event) { + + LOGGER.info("Handle event: " + event); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/mailgun/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/mailgun/Controller.java new file mode 100644 index 000000000..5049c262b --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/mailgun/Controller.java @@ -0,0 +1,48 @@ +package com.mycompany.app.mailgun; + +import com.sinch.sdk.SinchClient; +import java.util.Map; +import java.util.logging.Logger; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; + +@RestController("MailGun") +public class Controller { + + private static final Logger LOGGER = + Logger.getLogger(com.mycompany.app.verification.Controller.class.getName()); + + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + + /** + * The secret value used for webhook calls validation have to equals to the one configured at + * number property (HmacSecret). + * + * @see update + * function Javadoc + */ + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/MailGunEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity MailGunEvent( + @RequestHeader Map headers, @RequestBody String body) { + + LOGGER.info("Headers: " + headers); + LOGGER.info("Body: " + body); + return ResponseEntity.ok().build(); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/mailgun/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/mailgun/ServerBusinessLogic.java new file mode 100644 index 000000000..7ef0fb9d8 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/mailgun/ServerBusinessLogic.java @@ -0,0 +1,10 @@ +package com.mycompany.app.mailgun; + +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("MailGunServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/numbers/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/numbers/Controller.java new file mode 100644 index 000000000..c6909e966 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/numbers/Controller.java @@ -0,0 +1,78 @@ +package com.mycompany.app.numbers; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.domains.numbers.api.v1.WebHooksService; +import com.sinch.sdk.domains.numbers.models.v1.webhooks.NumberEvent; +import java.util.Map; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController("Numbers") +public class Controller { + + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + + /** + * The secret value used for webhook calls validation have to equals to the one configured at + * number property (HmacSecret). + * + * @see update + * function Javadoc + */ + @Value("${numbers.webhooks.secret: }") + private String webhooksSecret; + + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/NumbersEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity NumbersEvent( + @RequestHeader Map headers, @RequestBody String body) { + + WebHooksService webhooks = sinchClient.numbers().v1().webhooks(); + + // set this value to true to validate request from Sinch servers + // see https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks for + // more information + boolean ensureValidAuthentication = false; + if (ensureValidAuthentication) { + // ensure valid authentication to handle request + var validAuth = + webhooks.validateAuthenticationHeader( + webhooksSecret, + // request headers + headers, + // request payload body + body); + + // token validation failed + if (!validAuth) { + throw new ResponseStatusException(HttpStatus.UNAUTHORIZED); + } + } + + // decode the request payload + NumberEvent event = webhooks.parseEvent(body); + + // let business layer process the request + webhooksBusinessLogic.numbersEvent(event); + + return ResponseEntity.ok().build(); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/numbers/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/numbers/ServerBusinessLogic.java new file mode 100644 index 000000000..773b93310 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/numbers/ServerBusinessLogic.java @@ -0,0 +1,16 @@ +package com.mycompany.app.numbers; + +import com.sinch.sdk.domains.numbers.models.v1.webhooks.NumberEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("NumbersServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); + + public void numbersEvent(NumberEvent event) { + + LOGGER.info("Handle event: " + event); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/sms/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/sms/Controller.java new file mode 100644 index 000000000..a7f75d112 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/sms/Controller.java @@ -0,0 +1,80 @@ +package com.mycompany.app.sms; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.domains.sms.api.v1.WebHooksService; +import com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryReport; +import com.sinch.sdk.domains.sms.models.v1.inbounds.InboundMessage; +import com.sinch.sdk.domains.sms.models.v1.webhooks.SmsEvent; +import java.util.Map; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController("SMS") +public class Controller { + + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + + @Value("${sms.webhooks.secret: }") + private String webhooksSecret; + + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/SmsEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity smsDeliveryEvent( + @RequestHeader Map headers, @RequestBody String body) { + + WebHooksService webhooks = sinchClient.sms().v1().webhooks(); + + // ensure valid authentication to handle request + // See + // https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/section/Callbacks + // Contact your account manager to configure your callback sending headers validation or comment + // following line + // set this value to true to validate request from Sinch servers + // see https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks for + // more information + boolean ensureValidAuthentication = false; + if (ensureValidAuthentication) { + var validAuth = + webhooks.validateAuthenticationHeader( + webhooksSecret, + // request headers + headers, + // request payload body + body); + + // token validation failed + if (!validAuth) { + throw new ResponseStatusException(HttpStatus.UNAUTHORIZED); + } + } + + // decode the request payload + SmsEvent event = webhooks.parseEvent(body); + + // let business layer process the request + switch (event) { + case InboundMessage e -> webhooksBusinessLogic.processInboundEvent(e); + case DeliveryReport e -> webhooksBusinessLogic.processDeliveryReportEvent(e); + default -> throw new IllegalStateException("Unexpected value: " + event); + } + + return ResponseEntity.ok().build(); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/sms/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/sms/ServerBusinessLogic.java new file mode 100644 index 000000000..a8dd2c9b2 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/sms/ServerBusinessLogic.java @@ -0,0 +1,25 @@ +package com.mycompany.app.sms; + +import com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryReport; +import com.sinch.sdk.domains.sms.models.v1.inbounds.InboundMessage; +import com.sinch.sdk.domains.sms.models.v1.webhooks.SmsEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("SMSServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); + + public void processInboundEvent(InboundMessage event) { + trace(event); + } + + public void processDeliveryReportEvent(DeliveryReport event) { + trace(event); + } + + private void trace(SmsEvent event) { + LOGGER.info("Handle event: " + event); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/verification/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/verification/Controller.java new file mode 100644 index 000000000..df997d74c --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/verification/Controller.java @@ -0,0 +1,91 @@ +package com.mycompany.app.verification; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.domains.verification.api.v1.WebHooksService; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEvent; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationResultEvent; +// import com.sinch.sdk.domains.verification.models.v1.webhooks.Veri; +import java.util.Map; +import java.util.logging.Logger; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController("Verification") +public class Controller { + + private static final Logger LOGGER = Logger.getLogger(Controller.class.getName()); + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/VerificationEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity VerificationEvent( + @RequestHeader Map headers, @RequestBody String body) { + + LOGGER.info("event: " + body); + WebHooksService webhooks = sinchClient.verification().v1().webhooks(); + + // ensure valid authentication to handle request + // set this value to true to validate request from Sinch servers + // see + // https://developers.sinch.com/docs/verification/api-reference/authentication/callback-signed-request + // for more information + boolean ensureValidAuthentication = false; + if (ensureValidAuthentication) { + var validAuth = + webhooks.validateAuthenticationHeader( + // The HTTP verb this controller is managing + "POST", + // The URI this controller is managing + "/VerificationEvent", + // request headers + headers, + // request payload body + body); + + // token validation failed + if (!validAuth) { + throw new ResponseStatusException(HttpStatus.UNAUTHORIZED); + } + } + + // decode the request payload + var event = webhooks.parseEvent(body); + + // let business layer process the request + var response = + switch (event) { + case VerificationRequestEvent e -> webhooksBusinessLogic.verificationEvent(e); + case VerificationResultEvent resultEvent -> { + webhooksBusinessLogic.verificationEvent(resultEvent); + yield null; + } + /* case VerificationSmsDeliveredEvent smsEvent -> { + webhooksBusinessLogic.verificationSmsDeliveredEvent(smsEvent); + yield null; + }*/ + default -> throw new IllegalStateException("Unexpected value: " + event); + }; + + var serializedResponse = webhooks.serializeResponse(response); + + LOGGER.finest("JSON response: " + serializedResponse); + + return ResponseEntity.ok().body(serializedResponse); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.java new file mode 100644 index 000000000..b6dde53e3 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.java @@ -0,0 +1,35 @@ +package com.mycompany.app.verification; + +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationEventResponseAction; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEvent; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponseSms; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationResultEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("VerificationServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); + + public VerificationRequestEventResponse verificationEvent(VerificationRequestEvent event) { + + LOGGER.info("Handle event :" + event); + + // add your logic here according to SMS, FlashCall, PhoneCall, ... verification + return VerificationRequestEventResponseSms.builder() + .setAction(VerificationEventResponseAction.ALLOW) + .build(); + } + + public void verificationEvent(VerificationResultEvent event) { + + LOGGER.info("Handle event: " + event); + } + + /* public void verificationSmsDeliveredEvent(VerificationSmsDeliveredEvent event) { + + LOGGER.info("Handle event: " + event); + }*/ +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.xxx b/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.xxx new file mode 100644 index 000000000..354ecf05e --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/verification/ServerBusinessLogic.xxx @@ -0,0 +1,31 @@ +package com.mycompany.app.verification; + +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationEventResponseAction; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEvent; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponseSms; +import com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationResultEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("VerificationServerBusinessLogic") +public class ServerBusinessLogicxxx { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogicxxx.class.getName()); + + public VerificationRequestEventResponse verificationEvent(VerificationRequestEvent event) { + + LOGGER.info("Handle event :" + event); + + // add your logic here according to SMS, FlashCall, PhoneCall, ... verification + return VerificationRequestEventResponseSms.builder() + .setAction(VerificationEventResponseAction.ALLOW) + .setCode("1234") + .build(); + } + + public void verificationEvent(VerificationResultEvent event) { + + LOGGER.info("Handle event: " + event); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/voice/Controller.java b/examples/webhooks/src/main/java/com/mycompany/app/voice/Controller.java new file mode 100644 index 000000000..333250756 --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/voice/Controller.java @@ -0,0 +1,100 @@ +package com.mycompany.app.voice; + +import com.sinch.sdk.SinchClient; +import com.sinch.sdk.domains.voice.api.v1.WebHooksService; +import com.sinch.sdk.domains.voice.models.v1.webhooks.AnsweredCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.DisconnectedCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.IncomingCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.NotificationEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.PromptInputEvent; +import java.util.Map; +import java.util.logging.Logger; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController("Voice") +public class Controller { + + private final SinchClient sinchClient; + private final ServerBusinessLogic webhooksBusinessLogic; + private static final Logger LOGGER = Logger.getLogger(Controller.class.getName()); + + @Autowired + public Controller(SinchClient sinchClient, ServerBusinessLogic webhooksBusinessLogic) { + this.sinchClient = sinchClient; + this.webhooksBusinessLogic = webhooksBusinessLogic; + } + + @PostMapping( + value = "/VoiceEvent", + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + public ResponseEntity VoiceEvent( + @RequestHeader Map headers, @RequestBody String body) { + + WebHooksService webhooks = sinchClient.voice().v1().webhooks(); + + // ensure valid authentication to handle request + // set this value to true to validate request from Sinch servers + // see + // https://developers.sinch.com/docs/voice/api-reference/authentication/callback-signed-request + // for more information + boolean ensureValidAuthentication = false; + if (ensureValidAuthentication) { + // ensure valid authentication to handle request + var validAuth = + webhooks.validateAuthenticationHeader( + // The HTTP verb this controller is managing + "POST", + // The URI this controller is managing + "/VoiceEvent", + // request headers + headers, + // request payload body + body); + + // token validation failed + if (!validAuth) { + throw new ResponseStatusException(HttpStatus.UNAUTHORIZED); + } + } + // decode the payload request + var event = webhooks.parseEvent(body); + + // let business layer process the request + var response = + switch (event) { + case IncomingCallEvent e -> webhooksBusinessLogic.incoming(e); + case AnsweredCallEvent e -> webhooksBusinessLogic.answered(e); + case DisconnectedCallEvent e -> { + webhooksBusinessLogic.disconnect(e); + yield null; + } + case PromptInputEvent e -> { + webhooksBusinessLogic.prompt(e); + yield null; + } + case NotificationEvent e -> { + webhooksBusinessLogic.notify(e); + yield null; + } + default -> throw new IllegalStateException("Unexpected value: " + event); + }; + + String serializedResponse = ""; + if (null != response) { + serializedResponse = webhooks.serializeResponse(response); + } + + LOGGER.finest("JSON response: " + serializedResponse); + + return ResponseEntity.ok().body(serializedResponse); + } +} diff --git a/examples/webhooks/src/main/java/com/mycompany/app/voice/ServerBusinessLogic.java b/examples/webhooks/src/main/java/com/mycompany/app/voice/ServerBusinessLogic.java new file mode 100644 index 000000000..4aedb702f --- /dev/null +++ b/examples/webhooks/src/main/java/com/mycompany/app/voice/ServerBusinessLogic.java @@ -0,0 +1,45 @@ +package com.mycompany.app.voice; + +import com.sinch.sdk.domains.voice.models.v1.svaml.SvamlControl; +import com.sinch.sdk.domains.voice.models.v1.webhooks.AnsweredCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.DisconnectedCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.IncomingCallEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.NotificationEvent; +import com.sinch.sdk.domains.voice.models.v1.webhooks.PromptInputEvent; +import java.util.logging.Logger; +import org.springframework.stereotype.Component; + +@Component("VoiceServerBusinessLogic") +public class ServerBusinessLogic { + + private static final Logger LOGGER = Logger.getLogger(ServerBusinessLogic.class.getName()); + + public SvamlControl incoming(IncomingCallEvent event) { + + LOGGER.info("Handle event :" + event); + + return SvamlControl.builder().build(); + } + + public SvamlControl answered(AnsweredCallEvent event) { + + LOGGER.info("Handle event: " + event); + + return SvamlControl.builder().build(); + } + + public void disconnect(DisconnectedCallEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void prompt(PromptInputEvent event) { + + LOGGER.info("Handle event: " + event); + } + + public void notify(NotificationEvent event) { + + LOGGER.info("Handle event: " + event); + } +} diff --git a/examples/webhooks/src/main/resources/application.yaml b/examples/webhooks/src/main/resources/application.yaml new file mode 100644 index 000000000..7510c5109 --- /dev/null +++ b/examples/webhooks/src/main/resources/application.yaml @@ -0,0 +1,44 @@ +# springboot related config file + +logging: + level: + com: INFO + +server: + port: 8090 + +credentials: + # Java SDK domains supporting unified credentials + # - Numbers + # - SMS: US/EU are the only supported regions with unified credentials + # - Conversation + project-id: + key-id: + key-secret: + + # Application related credentials, used by: + # - Verification + # - Voice + application-api-key: + application-api-secret: + +# Secret value set for Numbers webhooks calls validation +numbers: + webhooks: + secret: + +# Secret value set for Conversation webhooks calls validation +conversation: + # Sets the region for Conversation + # See https://github.com/sinch/sinch-sdk-java/blob/main/client/src/main/com/sinch/sdk/models/ConversationRegion.java for list of supported values + region: + webhooks: + secret: + +sms: + # Sets the region for SMS + # valid values are "us" and "eu" + # See https://github.com/sinch/sinch-sdk-java/blob/main/client/src/main/com/sinch/sdk/models/SMSRegion.java for full list of supported values but with servicePlanID + region: + webhooks: + secret: