diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..9f2f5fb --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,47 @@ +plugins { + kotlin("jvm") version "2.0.21" + `maven-publish` +} + +group = "xyz.r0r5chach" +version = "1.0.0" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation(kotlin("test")) + + // Coroutines + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.9.0") + + // Retrofit + val retrofitVersion = "2.11.0" + implementation("com.squareup.retrofit2:retrofit:$retrofitVersion") + + // Jackson + implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.15.2") + implementation("com.squareup.retrofit2:converter-jackson:$retrofitVersion") +} + +tasks.test { + useJUnitPlatform() +} +kotlin { + jvmToolchain(17) +} + +java { + withSourcesJar() + withJavadocJar() +} + +publishing { + publications { + create("maven") { + from(components["java"]) + artifactId = "radikle" + } + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..7fc6f1f --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +kotlin.code.style=official diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..62ec0c2 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Fri Nov 22 12:44:59 GMT 2024 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..8ec14e9 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,10 @@ +pluginManagement { + plugins { + kotlin("jvm") version "2.0.21" + } +} +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} +rootProject.name = "radikle" + diff --git a/src/main/kotlin/RadicleApi.kt b/src/main/kotlin/RadicleApi.kt new file mode 100644 index 0000000..5d894cf --- /dev/null +++ b/src/main/kotlin/RadicleApi.kt @@ -0,0 +1,25 @@ +package xyz.r0r5chach + +import com.fasterxml.jackson.databind.DeserializationFeature +import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper +import retrofit2.Retrofit +import retrofit2.converter.jackson.JacksonConverterFactory + +class RadicleApi(val baseUrl: String) { + fun v1(): RadicleV1Service = builder() + .baseUrl(baseUrl) + .build().create(RadicleV1Service::class.java) + + companion object { + const val V1 = "/api/v1" + + private fun builder(): Retrofit.Builder { + val objectMapper = jacksonObjectMapper().apply { + configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) + } + return Retrofit.Builder() + .addConverterFactory(JacksonConverterFactory.create(objectMapper)) + } + + } +} \ No newline at end of file diff --git a/src/main/kotlin/RadicleV1Service.kt b/src/main/kotlin/RadicleV1Service.kt new file mode 100644 index 0000000..efb5f1b --- /dev/null +++ b/src/main/kotlin/RadicleV1Service.kt @@ -0,0 +1,72 @@ +package xyz.r0r5chach + +import retrofit2.http.GET +import retrofit2.http.Path +import xyz.r0r5chach.RadicleApi.Companion.V1 +import xyz.r0r5chach.entities.ApiIndex +import xyz.r0r5chach.entities.ApiInfo +import xyz.r0r5chach.entities.NodeByIdInfo +import xyz.r0r5chach.entities.NodeInfo +import xyz.r0r5chach.entities.Repo +import xyz.r0r5chach.entities.Root +import xyz.r0r5chach.entities.Stats + +interface RadicleV1Service { + @GET("/") + suspend fun getRoot(): Root + + @GET("/api") + suspend fun getApi(): ApiIndex + + @GET("/raw/{rid}/head/{path}") + suspend fun getFileByCanonicalHead( + @Path("rid") rid: String, + @Path("path") path: String + ) //TODO: IO Types + + @GET("/raw/{rid}/blobs/{oid}") + suspend fun getFileByOID( + @Path("rid") rid: String, + @Path("oid") oid: String + ) //TODO: IO Types + + @GET("/{rid}/{request}") + suspend fun getGit( + @Path("rid") rid: String, + @Path("request") request: String + ) //TODO: IO Types + + @GET("/raw/{rid}/{sha}/{path}") + suspend fun getFileByCommit( + @Path("rid") rid: String, + @Path("sha") sha: String, + @Path("path") path: String + ) //TODO: IO Types + + @GET(V1) + suspend fun getInfo(): ApiInfo + + @GET("$V1/repos") + suspend fun getRepos(): List + + @GET("$V1/repos/{rid}") + suspend fun getRepo( + @Path("rid") rid: String + ): Repo + + @GET("$V1/node") + suspend fun getNode(): NodeInfo + + @GET("$V1/nodes/{nid}") + suspend fun getNodeById( + @Path("nid") nid: String + ): NodeByIdInfo + + @GET("$V1/delegates/{did}/repos") + suspend fun getDelegateRepos( + @Path("did") did: String + ): List + + @GET("$V1/stats") + suspend fun getStats(): Stats +} \ No newline at end of file diff --git a/src/main/kotlin/entities/Api.kt b/src/main/kotlin/entities/Api.kt new file mode 100644 index 0000000..a1034a1 --- /dev/null +++ b/src/main/kotlin/entities/Api.kt @@ -0,0 +1,33 @@ +package xyz.r0r5chach.entities + +data class ApiIndex( + val path: String, + val links: List +) + +data class Route( + val href: String, + val rel: String, + val type: String +) + +data class Root( + val welcome: String, + val path: String, + val links: List +) + +data class ApiInfo( + val message: String, + val service: String, + val version: String, + val apiVersion: String, + val nid: String, + val path: String, + val links: List +) + +data class Stats( + val repos: ReposStats +) + diff --git a/src/main/kotlin/entities/Node.kt b/src/main/kotlin/entities/Node.kt new file mode 100644 index 0000000..30f8285 --- /dev/null +++ b/src/main/kotlin/entities/Node.kt @@ -0,0 +1,73 @@ +package xyz.r0r5chach.entities + +data class NodeInfo( + val id: String, + val agent: String, + val config: Config, + val state: String +) + +data class NodeByIdInfo( + val alias: String, + val did: String, + val ssh: Ssh +) + +data class Ssh( + val full: String, + val hash: String +) + +data class Config( + val alias: String, + val listen: List, //TODO: Find out what is listed in this list + val peers: PeersConfig, + val connect: List, + val externalAddresses: List, + val network: String, + val log: String, + val relay: String, + val limits: LimitsConfig, + val workers: Int, + val seedingPolicy: SeedingPolicyConfig, + val state: String? +) + +data class PeersConfig( + val type: String +) + +data class LimitsConfig( + val routingMaxSize: Int, + val routingMaxAge: Int, + val gossipMaxAge: Int, + val fetchConcurrency: Int, + val maxOpenFiles: Int, + val rate: LimitsRateConfig, + val connection: LimitsConnectionConfig +) + +data class LimitsRateConfig( + val inbound: LimitsRateInboundConfig, + val outbound: LimitsRateOutboundConfig +) + +data class LimitsRateInboundConfig( + val fillRate: Float, + val capacity: Int +) + +data class LimitsRateOutboundConfig( + val fillRate: Float, + val capacity: Int +) + +data class LimitsConnectionConfig( + val inbound: Int, + val outbound: Int +) + +data class SeedingPolicyConfig( + val default: String, + val scope: String? +) \ No newline at end of file diff --git a/src/main/kotlin/entities/Repo.kt b/src/main/kotlin/entities/Repo.kt new file mode 100644 index 0000000..8dc9b72 --- /dev/null +++ b/src/main/kotlin/entities/Repo.kt @@ -0,0 +1,59 @@ +package xyz.r0r5chach.entities + +import com.fasterxml.jackson.annotation.JsonProperty + +data class Repo( + val payloads: Payloads, + val delegates: List, + val threshold: Int, + val visibility: Visibility, + val rid: String, + val seeding: Int +) //TODO: Define object correctly + +data class Payloads( + @JsonProperty("xyz.radicle.project") + val project: Project +) + +data class Project ( + val data: Data, + val meta: Meta +) + +data class Data( + val defaultBranch: String, + val description: String, + val name: String +) + +data class Meta( + val head: String, + val issues: Issues, + val patches: Patches +) + +data class Issues( + val open: Int, + val closed: Int +) + +data class Patches( + val open: Int, + val draft: Int, + val archived: Int, + val merged: Int +) + +data class Delegate( + val id: String, + val alias: String +) + +data class Visibility( + val type: String +) + +data class ReposStats( + val total: Int +) \ No newline at end of file diff --git a/src/test/kotlin/RadicleV1ServiceTest.kt b/src/test/kotlin/RadicleV1ServiceTest.kt new file mode 100644 index 0000000..bce4c69 --- /dev/null +++ b/src/test/kotlin/RadicleV1ServiceTest.kt @@ -0,0 +1,75 @@ +import kotlinx.coroutines.runBlocking +import xyz.r0r5chach.RadicleApi +import kotlin.test.Test +import kotlin.test.assertEquals + +class RadicleV1ServiceTest { + private val api = RadicleApi("http://localhost:8080").v1() + + @Test + fun `getRoot should return Root with certain path`() = runBlocking { + val expectedResult = "/" + val observedResult = api.getRoot().path + assertEquals(expectedResult, observedResult) + } + + @Test + fun `getApi should should return ApiIndex with certain path`() = runBlocking { + val expectedResult = "/api" + val observedResult = api.getApi().path + assertEquals(expectedResult, observedResult) + } + + @Test + fun `getInfo should return ApiInfo with certain path`() = runBlocking { + val expectedResult = "/api/v1" + val observedResult = api.getInfo().path + assertEquals(expectedResult, observedResult) + } + + @Test + fun `getRepos should return an empty Repo list`() = runBlocking { + val observedResult = api.getRepos() + assert(observedResult.isEmpty()) + } + + @Test + fun `getRepo should return Repo with same rid as passed (when correct)`() = runBlocking { + val rid = "rad:zv1hL9eQ1kiu4GZyQGuq3dqCJedS" + val observedResult = api.getRepo("rad:zv1hL9eQ1kiu4GZyQGuq3dqCJedS").rid + assertEquals(rid, observedResult) + } + + @Test + fun `getNode should return NodeInfo with certain agent`() = runBlocking { + val expectedResult = "/radicle:1.0.0/" + val observedResult = api.getNode().agent + assertEquals(expectedResult, observedResult) + } + + @Test + fun `getNodeById should return NodeByIdInfo with certain alias when correct nid is passed`() = runBlocking { + val expectedResult = "seed.r0r-5chach.xyz" + val observedResult = api.getNodeById("z6Mkq4dM3pJ3RA1NCW4Pgsdxc2cLWUT8foM7NtmAhKcLv6Rd").alias + assertEquals(expectedResult, observedResult) + } + + @Test + fun `getDelegateRepos should return empty Repo list when a correct did is passed`() = runBlocking { + val observedResult = api.getDelegateRepos("did:key:z6Mkq4dM3pJ3RA1NCW4Pgsdxc2cLWUT8foM7NtmAhKcLv6Rd") + assert(observedResult.isEmpty()) + } + + @Test + fun `getStats should return Stats with certain number of repos`() = runBlocking { + val expectedResult = 1 + val observedResult = api.getStats().repos.total + assertEquals(expectedResult, observedResult) + } + + //TODO: Testing + // getFileByCanonicalHead + // getFileByOID + // getGit + // getFileByCommit +} \ No newline at end of file