Rewrite Java code to Kotlin

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Describe your changes
+
+## Issue ticket number and link
+
+## Checklist before requesting a review
+
+- [ ] I have resolved any merge conflicts
+- [ ] I have run tests locally and they pass
+- [ ] I have linted and auto-formatted the code
+- [ ] If there is new or changed functionality, I have added/updated the tests
+- [ ] If there is new or changed functionality, I have added/updated the documentation

.github/workflows/main.yml

@@ -0,0 +1,39 @@
+name: Main
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    # https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix
+    strategy:
+      fail-fast: false
+      matrix:
+        # Uncomment ci_node_total and ci_node_index, ONLY if we have multiple tests
+        # and need to run it in parallel
+        # [n] - where the n is a number of parallel jobs you want to run your tests on.
+        # Use a higher number if you have slow tests to split them between more parallel jobs.
+        # Remember to update the value of the `ci_node_index` below to (0..n-1).
+        #ci_node_total: [8]
+        # Indexes for parallel jobs (starting from zero).
+        # E.g. use [0, 1] for 2 parallel jobs, [0, 1, 2] for 3 parallel jobs, etc.
+        #ci_node_index: [0, 1, 2, 3, 4, 5, 6, 7]
+        java-version: ['11', '17', '21']
+
+    env:
+      TZ: "Europe/Ireland"
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'oracle'
+          cache: 'gradle'
+
+      - name: Run tests
+        run: |
+          ./gradlew test

.gitignore

@@ -0,0 +1,104 @@
+# General
+*.log
+*.keystore
+.history/
+*.tgz
+
+# git-secret rules
+.secrets/*.*
+!.secrets/*.secret
+!.secrets/public-keys/
+.gitsecret/keys/random_seed
+.gitsecret/keys/pubring.kbx~
+gradle.properties
+
+.ci/gradle*
+
+# You can put a script which call `yarn prettier-eslint --write` that prettify the file in-place.
+# Keep in mind the hook files are executed by alphabet sequence: so `in_place_prettier_eslint` will be executed before `prettier_eslint`
+buildtools/hooks/pre-commit.d/in_place_prettier_eslint
+
+# Archives / Binaries
+*.jar
+*.zip
+*.tar.gz
+*.so
+*.xcarchive
+
+# MacOS
+.DS_Store
+
+# Build Output
+build/
+out/
+bin/
+codemr/
+
+# JetBrains
+.idea/
+*.iml
+*.ipr
+*.iws
+.mvn/
+.project
+
+# VSCode
+.vscode/
+*.code-workspace
+
+# Eclipse
+.settings/
+.classpath
+
+# Java
+*.hprof
+.gradle/
+!gradle-wrapper.jar
+!gradle-wrapper.properties
+
+
+# Node or NPM or Yarn
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+node_modules/
+.eslintcache
+
+# Jest/Bamboo test results output
+jest.json
+coverage/
+
+# Vagrant
+.vagrant/
+
+# Xcode
+#
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+project.xcworkspace
+**/*.framework/
+
+
+# VIM
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+version.yml
+
+#Andorid
+local.properties
+/examples/src/main/resources/application-local.yml

README.md

@@ -1 +1,38 @@
 # firetail-java-lib
+
+## Building the library
+
+1. In the projects root folder, run `./gradlew build -x test`
+2. Run `./gradlew publishToMavenLocal`
+
+### Springboot configuration
+1. In `build.gradle.kts` (if you are using kotlin configuration), add within `dependencies {}`, the firetail library:
+
+```
+dependencies {
+    implementation("com.github.firetail-io:firetail-java-lib:$version")
+}
+```
+2. Also in `build.gradle.kts` add below the `plugins {}`:
+
+```
+group = "com.github.firetail-io"
+version = "0.0.1-SNAPSHOT"
+```
+
+3. In your springboot project, add `application-local.yml` in `build/resources`
+
+**NOTE: Ensure there is no FIRETAIL_URL and FIRETAIL_API_KEY variable in your environment,**
+        **which will override your yaml file configuration**
+
+```yaml
+firetail:
+  apikey: "PS-02....441b09761c3"
+  url: "https://your-apiapi.logging.eu-north-west-99.sandbox.firetail.app"
+  ## Cache control before dispatching logs to API
+  buffer:
+    # Millis
+    interval: 100000
+    # Max capacity
+    capacity: 5
+```

build.gradle.kts

@@ -0,0 +1,89 @@
+plugins {
+    `java-library`
+    // application
+    `maven-publish`
+    signing
+    // Not possible to set the version for a plugin from a variable.
+    kotlin("plugin.spring") version "1.8.21"
+    kotlin("jvm") version "1.8.21"
+    id("io.spring.dependency-management") version "1.1.2"
+}
+
+buildscript {
+    val kotlinVersion = "1.8.21"
+    dependencies {
+        classpath("org.jetbrains.kotlin:kotlin-noarg:$kotlinVersion")
+        classpath("org.jmailen.gradle:kotlinter-gradle:3.14.0")
+    }
+}
+
+repositories {
+    mavenLocal()
+    maven {
+        url = uri("https://repo.maven.apache.org/maven2/")
+    }
+    mavenCentral()
+}
+
+group = "com.github.firetail-io"
+version = "0.0.1-SNAPSHOT"
+description = "firetail-java-lib"
+
+// java.sourceCompatibility = JavaVersion.VERSION_1_8
+
+dependencies {
+    // Dependencies are transitively imported from spring-boot-dependencies
+    implementation(
+        platform("org.springframework.boot:spring-boot-dependencies:3.1.5"),
+    )
+    implementation("org.jetbrains.kotlin:kotlin-stdlib")
+    api("com.fasterxml.jackson.module:jackson-module-kotlin")
+    api("org.slf4j:slf4j-api")
+    api("ch.qos.logback:logback-classic")
+    compileOnly("org.yaml:snakeyaml:2.2")
+    compileOnly("org.springframework.boot:spring-boot-autoconfigure")
+    compileOnly("org.springframework:spring-context")
+    compileOnly("org.springframework:spring-web")
+    compileOnly("org.springframework:spring-webmvc")
+    testImplementation(kotlin("test"))
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    // javax vs. jakarta - Spring boot 3x uses jakarta. Need a version of this for < 3x for
+    // older SB apps
+    compileOnly("jakarta.annotation:jakarta.annotation-api")
+    compileOnly("jakarta.servlet:jakarta.servlet-api:5.0.0")
+    testImplementation("org.springframework.cloud:spring-cloud-contract-wiremock:4.0.4")
+    testImplementation("jakarta.servlet:jakarta.servlet-api")
+    // end javax vs. jakarta
+    testImplementation("org.springframework:spring-webmvc")
+    testImplementation("org.assertj:assertj-core")
+    testImplementation("org.mockito.kotlin:mockito-kotlin:5.0.0")
+}
+
+signing {
+    setRequired {
+        // signing is only required if the artifacts are to be published
+        gradle.taskGraph.allTasks.any { it is PublishToMavenRepository }
+    }
+    if (project.hasProperty("signJar") && project.property("signJar") == "true") {
+        val signingKey: String? by project
+        val signingPassword: String? by project
+        useInMemoryPgpKeys(signingKey, signingPassword)
+        sign(configurations["archives"])
+    }
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("jar") {
+            artifact(tasks.named("jar"))
+        }
+    }
+}
+
+kotlin {
+    jvmToolchain(17)
+}
+
+tasks.test { // See 5️⃣
+    useJUnitPlatform() // JUnitPlatform for tests. See 6️⃣
+}

examples/.gitignore

@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

examples/README.md

@@ -0,0 +1,41 @@
+## Spring Boot Demo
+
+Requires Java 17
+
+You will require an `application-local.yml` file. It will look something like this:
+
+```yaml
+firetail:
+  apikey: "PS-02....441b09761c3"
+  url: "https://your-apiapi.logging.eu-north-west-99.sandbox.firetail.app"
+  ## Cache control before dispatching logs to API
+  buffer:
+    # Millis
+    interval: 100000
+    # Max capacity
+    capacity: 5
+
+```
+
+Firstly, build the Firetail-Java-Library
+
+```bash
+# Build the firetail library
+cd ..
+./gradlew build publishToMavenLocal
+# Run the example
+cd examples
+./gradlew bootRun
+# By default, you'll want to hit this endpoint 5 times before the logs are dispatched
+# Otherwise hit it < 5 and wait for 10 seconds
+curl http://localhost:8080/hello
+```
+
+You can then login to the [FireTail app](https://www.sandbox.firetail.app/) and see your logs
+
+## Open API documentation
+
+This example uses OpenAPI v3
+
+ 1. http://localhost:8080/api-docs
+ 2. http://localhost:8080/swagger-ui.html

examples/build.gradle.kts

@@ -0,0 +1,31 @@
+plugins {
+    id("org.springframework.boot") version "3.1.3"
+    id("io.spring.dependency-management") version "1.1.2"
+    kotlin("jvm") version "1.6.10"
+}
+
+group = "com.github.firetail-io"
+version = "0.0.1-SNAPSHOT"
+
+repositories {
+    mavenLocal()
+    maven {
+        url = uri("https://repo.maven.apache.org/maven2/")
+    }
+    mavenCentral()
+}
+
+dependencies {
+    implementation(
+        platform("org.springframework.boot:spring-boot-dependencies:3.1.5"),
+    )
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0")
+    implementation("org.springframework.boot:spring-boot-starter")
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("com.github.firetail-io:firetail-java-lib:$version")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+}
+
+tasks.named<org.springframework.boot.gradle.tasks.run.BootRun>("bootRun") {
+    args("--spring.profiles.active=local")
+}