0.7.0

.github/workflows/publish-release.yml

@@ -35,4 +35,4 @@ jobs:
           REPOSILITE_SECRET: ${{ secrets.REPOSILITE_SECRET }}
           GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
           GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
-        run: ./gradlew publishAllPublicationsToTimeMatesReleasesRepository publishPlugins --no-daemon -Pversion=${{ env.LIB_VERSION }} -Pgradle.publish.key=${{ env.GRADLE_PUBLISH_KEY }} -Pgradle.publish.secret=${{ env.GRADLE_PUBLISH_SECRET }}
+        run: ./gradlew publishAllPublicationsToTimeMatesReleasesRepository --no-daemon -Pversion=${{ env.LIB_VERSION }} -Pgradle.publish.key=${{ env.GRADLE_PUBLISH_KEY }} -Pgradle.publish.secret=${{ env.GRADLE_PUBLISH_SECRET }}

README.md

@@ -1,89 +1,29 @@
-![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmaven.timemates.org%2Freleases%2Forg%2Ftimemates%2Frsproto%2Fclient-core%2Fmaven-metadata.xml)
-![GitHub issues](https://img.shields.io/github/issues/timemates/rsproto)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/timemates/rsproto)
-![GitHub License](https://img.shields.io/github/license/timemates/rsproto)
-# RSProto
-RSProto is a framework that designed to provide ability to expose your API as RPC Services. It facilitates the creation of gRPC-like services from .proto files through code generation. The framework also provides essential core components for both server and client.
+![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmaven.timemates.org%2Freleases%2Forg%2Ftimemates%2Frrpc-kotlin%2Fclient-core%2Fmaven-metadata.xml)
+![GitHub issues](https://img.shields.io/github/issues/timemates/rrpc-kotlin)
+![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/timemates/rrpc-kotlin)
+![GitHub License](https://img.shields.io/github/license/timemates/rrpc-kotlin)
+# rRPC Kotlin
+
+rRPC is a framework designed to provide an ability to expose your API as RPC Services.
+It facilitates the creation of gRPC-like services from .proto files through code generation.
+The framework also provides essential core components for both server and client.
 
 > **Warning** <br>
-> This project is experimental, be ready for bugs and possible changes.
+Under prototyping, currently unavailable to use.
 
 ## Features
 - **Gradle Plugin**: `.proto` to RSocket code generator (both client and server).
 - **Server Core** (JVM only): Interceptors, Instances API and bridge between Ktor and library.
 - **Client Core** (JVM, Web, iOS): Metadata and basic interface-markers.
 
-> **Known issues** <br>
-> As RSocket does not natively support client-only streaming – it's not supported by the
-> code-generator.
-
-## Getting Started
-First of all, you should have the following repository:
-```kotlin
-repositories {
-    maven("https://maven.timemates.org/releases")
-}
-```
-
-### Core components
-Before using builtin generation from `.proto` to RSocket services, you should add the following dependencies:
-```kotlin
-dependencies {
-    // for server
-    implementation("org.timemates.rsproto:server-core:$version")
-    // for client
-    commonMainImplementation("org.timemates.rsproto:client-core:$version")
-
-    // for server & client
-    commonMainImplementation("org.timemates.rsproto:common-core:$version")
-}
-```
-#### Server initialization
-To configure your server, you can use ready-to-use build-bridges between Ktor and RSProto:
-```kotlin
-fun Application.configureServer() {
-    routing {
-        rSocketServer("/rsocket") {
-            interceptor(MyInterceptor())
-            service(MyService())
-
-            instances {
-                protobuf { 
-                    encodeDefaults = true
-                }
-            }
-        }
-    }
-}
-```
-#### Client initialization
-Clients are generated by the code-generation Gradle plugin. To use them you need instance of `rsocket` and `protobuf`:
-```kotlin
-val apiService = TestServiceApi(rsocket, protobuf)
-apiService.sayHello()
-```
+## Documentation
 
-### Code-generation plugin
-To implement code-generation plugin in your buildscript, add the following:
-```kotlin
-plugins {
-    id("org.timemates.rsproto") version "$version"
-}
-```
-And use it inside your buildscript:
-```kotlin
-rsproto {
-    protoSourcePath.set("src/main/proto")
-    generationOutputPath.set("generated/proto-generator/src/commonMain")
-    clientGeneration.set(true)
-    serverGeneration.set(true)
-}
-```
+You can learn more about the library in official documentation – [https://rrpc.timemates.org](https://rrpc.timemates.org/section-starting-page.html).
 
 ## Feedback
 
 For bugs, questions and discussions please use
-the [GitHub Issues](https://github.com/timemates/rsproto/issues).
+the [GitHub Issues](https://github.com/timemates/rrpc-kotlin/issues).
 
 ## License
 

build-conventions/src/main/kotlin/jvm-library-convention.gradle.kts

@@ -1,4 +1,8 @@
 plugins {
     id("jvm-convention")
     id("library-convention")
+}
+
+kotlin {
+    explicitApi()
 }

build-conventions/src/main/kotlin/library-convention.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 
 mavenPublishing {
     pom {
-        url.set("https://github.com/timemates/rsproto")
+        url.set("https://github.com/RRpc/rrpc-kotlin")
         inceptionYear.set("2023")
 
         licenses {
@@ -24,29 +24,37 @@ mavenPublishing {
         }
 
         scm {
-            url.set("https://github.com/timemates/rsproto")
-            connection.set("scm:git:git://github.com/timemates/rsproto.git")
-            developerConnection.set("scm:git:ssh://[email protected]/timemates/rsproto.git")
+            url.set("https://github.com/RRpc/rrpc-kotlin")
+            connection.set("scm:git:git://github.com/RRpc/rrpc-kotlin.git")
+            developerConnection.set("scm:git:ssh://[email protected]/RRpc/rrpc-kotlin.git")
         }
 
         issueManagement {
             system.set("GitHub Issues")
-            url.set("https://github.com/timemates/rsproto/issues")
+            url.set("https://github.com/RRpc/rrpc-kotlin/issues")
         }
     }
 }
 
 publishing {
     repositories {
-        maven {
-            name = "timeMatesReleases"
+        if (project.hasProperty("publish-reposilite")) {
+            maven {
+                val isDev = version.toString().contains("dev")
 
-            url = uri("https://maven.timemates.org/releases")
+                name = if (isDev) "timeMatesDev" else "timeMatesReleases"
+                url = if (isDev) uri("https://maven.timemates.org/dev") else uri("https://maven.timemates.org/releases")
 
-            credentials {
-                username = System.getenv("REPOSILITE_USER")
-                password = System.getenv("REPOSILITE_SECRET")
+                credentials {
+                    username = System.getenv("REPOSILITE_USER")
+                    password = System.getenv("REPOSILITE_SECRET")
+                }
             }
+        } else {
+            logger.log(
+                LogLevel.INFO,
+                "Publishing is disabled: publish-locally or publish-reposilite parameter should be used to specify publication destination."
+            )
         }
     }
 }

build-conventions/src/main/kotlin/multiplatform-convention.gradle.kts

@@ -1,8 +1,15 @@
+import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
+
 plugins {
     kotlin("multiplatform")
 }
 
 kotlin {
     jvm()
     jvmToolchain(11)
+
+    @OptIn(ExperimentalKotlinGradlePluginApi::class)
+    compilerOptions {
+        optIn.add("kotlinx.serialization.ExperimentalSerializationApi")
+    }
 }

build.gradle.kts

@@ -1,3 +1,4 @@
 plugins {
     id(libs.plugins.conventions.multiplatform.library.get().pluginId) apply false
-}
+    alias(libs.plugins.kotlinx.serialization) apply false
+}

client/core/build.gradle.kts

@@ -0,0 +1,46 @@
+plugins {
+    id(libs.plugins.conventions.multiplatform.library.get().pluginId)
+    alias(libs.plugins.kotlinx.serialization)
+}
+
+group = "org.timemates.rrpc"
+version = System.getenv("LIB_VERSION") ?: "SNAPSHOT"
+
+dependencies {
+    dependencies {
+        // -- Project --
+        commonMainImplementation(projects.common.core)
+
+        // -- RSocket --
+        commonMainApi(libs.rsocket.client)
+
+        // -- Test --
+        jvmTestImplementation(libs.kotlin.test)
+        jvmTestImplementation(libs.mockk)
+    }
+
+}
+
+kotlin {
+    jvm()
+//    js(IR) {
+//        browser()
+//        nodejs()
+//    }
+//    iosArm64()
+//    iosX64()
+//    iosSimulatorArm64()
+}
+
+mavenPublishing {
+    coordinates(
+        groupId = "org.timemates.rrpc",
+        artifactId = "client-core",
+        version = System.getenv("LIB_VERSION") ?: return@mavenPublishing,
+    )
+
+    pom {
+        name.set("RRpc Client Core")
+        description.set("Multiplatform Kotlin core library for RRpc clients.")
+    }
+}