-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from NipunaRanasinghe/main
Include zendesk examples to the gradle build
- Loading branch information
Showing
6 changed files
with
212 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Examples | ||
|
|
||
| The `ballerinax/zendesk` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-zendesk/tree/main/examples), covering use cases like cache management, session management, and rate limiting. | ||
|
|
||
| 1. [Multi channel support integration](https://github.com/ballerina-platform/module-ballerinax-zendesk/tree/main/examples/multi-channel-support-integration) - Integrate Zendesk with multiple customer support channels to streamline ticket management. | ||
|
|
||
| 2. [Customer satisfaction survey analysis](https://github.com/ballerina-platform/module-ballerinax-zendesk/tree/main/examples/customer-satisfaction-survey-analysis) - Analyze customer satisfaction survey responses to improve support services. | ||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. Generate Zendesk credentials to authenticate the connector as described in the [Setup guide](https://central.ballerina.io/ballerinax/zendesk/latest#setup-guide). | ||
|
|
||
| 2. For each example, create a `Config.toml` file the related configuration. Here's an example of how your `Config.toml` file should look: | ||
|
|
||
| ```toml | ||
| username="<username>" | ||
| password="<password>" | ||
| ``` | ||
|
|
||
| ## Running an Example | ||
|
|
||
| Execute the following commands to build an example from the source: | ||
|
|
||
| * To build an example: | ||
|
|
||
| ```bash | ||
| bal build | ||
| ``` | ||
|
|
||
| * To run an example: | ||
|
|
||
| ```bash | ||
| bal run | ||
| ``` | ||
|
|
||
| ## Building the Examples with the Local Module | ||
|
|
||
| **Warning**: Due to the absence of support for reading local repositories for single Ballerina files, the Bala of the module is manually written to the central repository as a workaround. Consequently, the bash script may modify your local Ballerina repositories. | ||
|
|
||
| Execute the following commands to build all the examples against the changes you have made to the module locally: | ||
|
|
||
| * To build all the examples: | ||
|
|
||
| ```bash | ||
| ./build.sh build | ||
| ``` | ||
|
|
||
| * To run all the examples: | ||
|
|
||
| ```bash | ||
| ./build.sh run | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. 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. | ||
| */ | ||
|
|
||
| import org.apache.tools.ant.taskdefs.condition.Os | ||
|
|
||
| apply plugin: 'java' | ||
|
|
||
| def graalvmFlag = "" | ||
|
|
||
| task testExamples { | ||
| if (project.hasProperty("balGraalVMTest")) { | ||
| graalvmFlag = "--graalvm" | ||
| } | ||
| doLast { | ||
| try { | ||
| exec { | ||
| workingDir project.projectDir | ||
| println("Working dir: ${workingDir}") | ||
| if (Os.isFamily(Os.FAMILY_WINDOWS)) { | ||
| commandLine 'cmd', "/c", "chmod +x ./build.sh && ./build.sh run && exit %%ERRORLEVEL%%" | ||
| } else { | ||
| commandLine 'sh', "-c", "chmod +x ./build.sh && ./build.sh run" | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| println("Example Build failed: " + e.message) | ||
| throw e | ||
| } | ||
| } | ||
| } | ||
|
|
||
| task buildExamples { | ||
| gradle.taskGraph.whenReady { graph -> | ||
| if (graph.hasTask(":zendesk-examples:test")) { | ||
| buildExamples.enabled = false | ||
| } else { | ||
| testExamples.enabled = false | ||
| } | ||
| } | ||
| doLast { | ||
| try { | ||
| exec { | ||
| workingDir project.projectDir | ||
| println("Working dir: ${workingDir}") | ||
| if (Os.isFamily(Os.FAMILY_WINDOWS)) { | ||
| commandLine 'cmd', "/c", "chmod +x ./build.sh && ./build.sh build && exit %%ERRORLEVEL%%" | ||
| } else { | ||
| commandLine 'sh', "-c", "chmod +x ./build.sh && ./build.sh build" | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| println("Example Build failed: " + e.message) | ||
| throw e | ||
| } | ||
| } | ||
| } | ||
|
|
||
| buildExamples.dependsOn ":zendesk-ballerina:build" | ||
| testExamples.dependsOn ":zendesk-ballerina:build" | ||
|
|
||
| // TODO: Enable the examples build once https://github.com/ballerina-platform/ballerina-library/issues/6135 is fixed | ||
| // test.dependsOn testExamples | ||
| // build.dependsOn buildExamples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| #!/bin/bash | ||
|
|
||
| BAL_EXAMPLES_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| BAL_CENTRAL_DIR="$HOME/.ballerina/repositories/central.ballerina.io" | ||
| BAL_HOME_DIR="$BAL_EXAMPLES_DIR/../ballerina" | ||
|
|
||
| set -e | ||
|
|
||
| case "$1" in | ||
| build) | ||
| BAL_CMD="build" | ||
| ;; | ||
| run) | ||
| BAL_CMD="run" | ||
| ;; | ||
| *) | ||
| echo "Invalid command provided: '$1'. Please provide 'build' or 'run' as the command." | ||
| exit 1 | ||
| ;; | ||
| esac | ||
|
|
||
| # Read Ballerina package name | ||
| BAL_PACKAGE_NAME=$(awk -F'"' '/^name/ {print $2}' "$BAL_HOME_DIR/Ballerina.toml") | ||
|
|
||
| # Push the package to the local repository | ||
| cd "$BAL_HOME_DIR" && | ||
| bal pack && | ||
| bal push --repository=local | ||
|
|
||
| # Remove the cache directories in the repositories | ||
| cacheDirs=$(ls -d $BAL_CENTRAL_DIR/cache-* 2>/dev/null) || true | ||
| for dir in "${cacheDirs[@]}"; do | ||
| [ -d "$dir" ] && rm -r "$dir" | ||
| done | ||
| echo "Successfully cleaned the cache directories" | ||
|
|
||
| # Create the package directory in the central repository, this will not be present if no modules are pulled | ||
| mkdir -p "$BAL_CENTRAL_DIR/bala/ballerinax/$BAL_PACKAGE_NAME" | ||
|
|
||
| # Update the central repository | ||
| BAL_DESTINATION_DIR="$HOME/.ballerina/repositories/central.ballerina.io/bala/ballerinax/$BAL_PACKAGE_NAME" | ||
| BAL_SOURCE_DIR="$HOME/.ballerina/repositories/local/bala/ballerinax/$BAL_PACKAGE_NAME" | ||
| [ -d "$BAL_DESTINATION_DIR" ] && rm -r "$BAL_DESTINATION_DIR" | ||
| [ -d "$BAL_SOURCE_DIR" ] && cp -r "$BAL_SOURCE_DIR" "$BAL_DESTINATION_DIR" | ||
| echo "Successfully updated the local central repositories" | ||
|
|
||
| echo "$BAL_DESTINATION_DIR" | ||
| echo "$BAL_SOURCE_DIR" | ||
|
|
||
| # Loop through examples in the examples directory | ||
| cd "$BAL_EXAMPLES_DIR" | ||
| for dir in $(find "$BAL_EXAMPLES_DIR" -type d -maxdepth 1 -mindepth 1); do | ||
| # Skip the build directory | ||
| if [[ "$dir" == *build ]]; then | ||
| continue | ||
| fi | ||
| (cd "$dir" && bal "$BAL_CMD" --offline && cd ..); | ||
| done | ||
|
|
||
| # Remove generated JAR files | ||
| find "$BAL_HOME_DIR" -maxdepth 1 -type f -name "*.jar" | while read -r JAR_FILE; do | ||
| rm "$JAR_FILE" | ||
| done |