Initial commit

Author: auguwu

.gitignore

@@ -0,0 +1,118 @@
+# 🐻‍❄️🌂 Noelware Analytics for JVM
+> *JVM support for using [Noelware Analytics](https://analytics.noelware.org) for your applications.*
+>
+> <kbd>v0.1-alpha</kbd> | [:scroll: **Documentation**](https://analytics.noelware.org/docs/support/jvm)
+
+**Noelware Analytics for JVM** (`analytics-jvm`) is a library to support client and server support of the Noelware Analytics
+[protocol](https://analytics.noelware.org/docs/protocol) for the JVM with Kotlin support.
+
+The library comes in a form of plugins to plug in external sources to include in your Noelware Analytics instance that can be visualised
+on the web dashboard.
+
+## Usage
+### Client
+You will need the instance service token to use the client for yourself.
+
+```java
+// Add the "org.noelware.analytics:client:<VERSION>" to the project before
+// copying.
+
+import org.noelware.analytics.client.blocking.BlockingAnalyticsClient;
+import org.noelware.analytics.client.responses.ConnectionAckResponse;
+import org.noelware.analytics.client.responses.InstanceStatsResponse;
+import org.noelware.analytics.client.query.QueryBuilder;
+
+// The client also supports asynchronous clients that use the CompletableFuture
+// API. This will only demonstrate the blocking APIs.
+public class Program {
+    public static void main(String[] args) {
+        final BlockingAnalyticsClient client = new BlockingAnalyticsClient.Builder()
+                .setServiceToken("<token from dashboard>")
+                .editChannelBuilder(builder -> {
+                    // builder => the gRPC channel builder
+                    builder.usePlaintext();
+                })
+                .build();
+
+        final ConnectionAckResponse res = client.connect();
+        System.out.println("connected? " + res.connected() ? "yes" : "no");
+
+        final InstanceStatsResponse stats = client.collectStats();
+        System.out.println(stats);
+    }
+}
+```
+
+### Server
+You will still need your instance service token to validate requests from incoming traffic. The service token holds as a way to
+block traffic that isn't from any client that doesn't have the service token available.
+
+```java
+import org.noelware.analytics.server.plugins.jvm.JvmMemoryPoolPlugin;
+import org.noelware.analytics.server.plugins.jvm.JvmThreadsPlugin;
+import org.noelware.analytics.server.AnalyticsServerBuilder;
+import org.noelware.analytics.server.AnalyticsServer;
+
+public class Program {
+    public static void main(String[] args) {
+        final AnalyticsServer server = new AnalyticsServerBuilder()
+                .withPort(55123)
+                .withPlugins(new JvmMemoryPoolPlugin(), new JvmThreadsPlugin())
+                .withServiceToken("<service token from dashboard>")
+                .build();
+        
+        server.runBlocking();
+    }
+}
+```
+
+## Installation
+### Gradle (Groovy)
+```groovy
+repositories {
+    maven 'https://maven.noelware.org'
+    gradlePluginPortal()
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.noelware.analytics:bom:<VERSION>'
+}
+```
+
+### Gradle (Kotlin DSL)
+```kotlin
+repositories {
+    maven("https://maven.noelware.org")
+    gradlePluginPortal()
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.noelware.analytics:bom:<VERSION>")
+}
+```
+
+### Maven
+```xml
+<repositories>
+    <repository>
+        <url>https://maven.noelware.org</url>
+    </repository>
+</repositories>
+
+<dependencies>
+    <dependency>
+        <group>org.noelware.analytics</group>
+        <artifactId>bom</artifactId>
+        <version>{VERSION}</version>
+        <type>pom</type>
+    </dependency>
+</dependencies>
+```
+
+## Contributing
+;-; coming soon! ;-;
+
+## License
+**Noelware Analytics for JVM** (`analytics-jvm`) is released under the **MIT License** by Noelware, with love. :3

LICENSE

@@ -0,0 +1,23 @@
+/*
+ * 🐻‍❄️🌂 analytics-jvm: Client and server implementation of Noelware Analytics in Java, supported for both Java and Kotlin
+ * Copyright (c) 2022 Noelware <[email protected]>
+ *
+ * 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.
+ */
+

README.md

@@ -0,0 +1,22 @@
+/*
+ * 🐻‍❄️🌂 analytics-jvm: Client and server implementation of Noelware Analytics in Java, supported for both Java and Kotlin
+ * Copyright (c) 2022 Noelware <[email protected]>
+ *
+ * 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.
+ */

assets/HEADING

@@ -0,0 +1,42 @@
+/*
+ * 🐻‍❄️🌂 analytics-jvm: Client and server implementation of Noelware Analytics in Java, supported for both Java and Kotlin
+ * Copyright (c) 2022 Noelware <[email protected]>
+ *
+ * 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.
+ */
+
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    maven("https://maven.floofy.dev/repo/releases")
+    gradlePluginPortal()
+    mavenCentral()
+    mavenLocal()
+}
+
+dependencies {
+    implementation("com.diffplug.spotless:spotless-plugin-gradle:6.11.0")
+    implementation("com.google.protobuf:protobuf-gradle-plugin:0.9.1")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.7.20")
+    implementation(kotlin("gradle-plugin", "1.7.10"))
+    implementation("dev.floofy.commons:gradle:2.3.0")
+    implementation(gradleApi())
+}

build.gradle.kts

@@ -0,0 +1,170 @@
+/*
+ * 🐻‍❄️🌂 analytics-jvm: Client and server implementation of Noelware Analytics in Java, supported for both Java and Kotlin
+ * Copyright (c) 2022 Noelware <[email protected]>
+ *
+ * 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.
+ */
+
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.noelware.analytics.gradle.*
+import dev.floofy.utils.gradle.*
+import gradle.kotlin.dsl.accessors._9aab0383dfc03b3173a99d0f5dd3559b.publishing
+import java.io.StringReader
+import java.util.*
+
+plugins {
+    id("com.diffplug.spotless")
+    id("org.jetbrains.dokka")
+    `maven-publish`
+    `java-library`
+    kotlin("jvm")
+}
+
+group = "org.noelware.charted"
+version = "$VERSION"
+
+repositories {
+    maven("https://repo.perfectdreams.net/")
+    mavenCentral()
+    mavenLocal()
+    noelware()
+    noel()
+}
+
+dependencies {
+    api(kotlin("stdlib"))
+}
+
+spotless {
+    kotlin {
+        licenseHeaderFile("${rootProject.projectDir}/assets/HEADING")
+        trimTrailingWhitespace()
+        endWithNewline()
+
+        // We can't use the .editorconfig file, so we'll have to specify it here
+        // issue: https://github.com/diffplug/spotless/issues/142
+        ktlint()
+            .setUseExperimental(true)
+            .editorConfigOverride(mapOf(
+                "indent_size" to "4",
+                "disabled_rules" to "colon-spacing,annotation-spacing,filename,no-wildcard-imports",
+                "ij_kotlin_allow_trailing_comma" to "false",
+                "ktlint_code_style" to "official",
+                "no-unused-imports" to "true",
+                "no-unit-return" to "true",
+                "no-consecutive-blank-lines" to "true",
+                "experimental:fun-keyword-spacing" to "true",
+                "experimental:unnecessary-parentheses-before-trailing-lambda" to "true"
+            ))
+    }
+}
+
+java {
+    sourceCompatibility = JAVA_VERSION
+    targetCompatibility = JAVA_VERSION
+}
+
+val fullPath = path.substring(1).replace(':', '-')
+// transforms ":client" -> "client"
+//
+// for this case, the full jar file will be "analytics-client-{VERSION}.jar"
+// or "analytics-server-{VERSION}.jar"
+
+tasks {
+    withType<Jar> {
+        archiveFileName by "analytics-$fullPath-$VERSION.jar"
+        manifest {
+            attributes(
+                "Implementation-Version" to "$VERSION",
+                "Implementation-Vendor" to "Noelware, LLC. [[email protected]]",
+                "Implementation-Title" to "charted-server"
+            )
+        }
+    }
+
+    withType<KotlinCompile> {
+        kotlinOptions.freeCompilerArgs += "-opt-in=kotlin.RequiresOptIn"
+        kotlinOptions.javaParameters = true
+        kotlinOptions.jvmTarget = JAVA_VERSION.toString()
+    }
+}
+
+// ~+~ setup publishing here ~+~
+// Get the `publishing.properties` file from the `gradle/` directory
+// in the root project.
+val publishingPropsFile = file("${rootProject.projectDir}/gradle/publishing.properties")
+val publishingProps = Properties()
+
+// If the file exists, let's get the input stream
+// and load it.
+if (publishingPropsFile.exists()) {
+    publishingProps.load(publishingPropsFile.inputStream())
+} else {
+    // Check if we do in environment variables
+    val accessKey = System.getenv("NOELWARE_PUBLISHING_ACCESS_KEY") ?: ""
+    val secretKey = System.getenv("NOELWARE_PUBLISHING_SECRET_KEY") ?: ""
+
+    if (accessKey.isNotEmpty() && secretKey.isNotEmpty()) {
+        val data = """
+        |s3.accessKey=$accessKey
+        |s3.secretKey=$secretKey
+        """.trimMargin()
+
+        publishingProps.load(StringReader(data))
+    }
+}
+
+// Check if we have the `NOELWARE_PUBLISHING_ACCESS_KEY` and `NOELWARE_PUBLISHING_SECRET_KEY` environment
+// variables, and if we do, set it in the publishing.properties loader.
+val snapshotRelease: Boolean = run {
+    val env = System.getenv("NOELWARE_PUBLISHING_IS_SNAPSHOT") ?: "false"
+    env == "true"
+}
+
+val sourcesJar by tasks.registering(Jar::class) {
+    archiveClassifier.set("sources")
+    from(sourceSets.main.get().allSource)
+}
+
+val javadocJar by tasks.registering(Jar::class) {
+    group = JavaBasePlugin.DOCUMENTATION_GROUP
+    description = "Assemble Kotlin documentation with Dokka"
+
+    archiveClassifier.set("javadoc")
+    from(tasks.dokkaHtml)
+    dependsOn(tasks.dokkaHtml)
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("analytics") {
+            createPublicationMeta(project, "kotlin", sourcesJar, javadocJar)
+        }
+    }
+
+    repositories {
+        val url = if (snapshotRelease) "s3://maven.noelware.org/snapshots" else "s3://maven.noelware.org"
+        maven(url) {
+            credentials(AwsCredentials::class) {
+                this.accessKey = publishingProps.getProperty("s3.accessKey") ?: ""
+                this.secretKey = publishingProps.getProperty("s3.secretKey") ?: ""
+            }
+        }
+    }
+}