Adjust publish for nexus

Author: marcelkliemannel

build.gradle.kts

@@ -1,21 +1,52 @@
 plugins {
   `java-library`
   kotlin("jvm") version "1.3.41"
+  id("org.jetbrains.dokka") version "0.9.18"
 
   signing
   `maven-publish`
   id("de.marcphilipp.nexus-publish") version "0.2.0"
 }
 
 group = "dev.turingcomplete"
-version = "1.1.0"
+version = "2.0.0"
 
 tasks.withType<Wrapper> {
   gradleVersion = "5.5.1"
 }
 
 repositories {
+  mavenLocal()
   mavenCentral()
+  jcenter()
+}
+
+tasks {
+  val sourcesJar by creating(Jar::class) {
+    group = "build"
+    archiveClassifier.set("sources")
+    from(sourceSets["main"].allSource)
+  }
+
+  val testsJar by creating(Jar::class) {
+    dependsOn(JavaPlugin.TEST_CLASSES_TASK_NAME)
+    group = "build"
+    archiveClassifier.set("tests")
+    from(sourceSets["test"].output)
+  }
+
+  val dokkaJar by creating(Jar::class) {
+    dependsOn("dokka")
+    group = "build"
+    archiveClassifier.set("javadoc")
+    from(getByPath("dokka").outputs)
+  }
+
+  artifacts {
+    add("archives", sourcesJar)
+    add("archives", testsJar)
+    add("archives", dokkaJar)
+  }
 }
 
 configure<JavaPluginExtension> {
@@ -41,23 +72,32 @@ publishing {
   publications {
     create<MavenPublication>(project.name) {
       from(components["java"])
+      setArtifacts(configurations.archives.get().allArtifacts)
     }
   }
 }
 
-/*
-  signing.keyId=
-  signing.password=
-  signing.secretKeyRingFile=
+/**
+ * See https://docs.gradle.org/current/userguide/signing_plugin.html#sec:signatory_credentials
  */
 signing {
   sign(publishing.publications[project.name])
 }
 
-/*
-  nexusUsername=
-  nexusPassword=
+gradle.taskGraph.whenReady {
+  if (allTasks.any { it is Sign }) {
+    extra["signing.keyId"] = ""
+    extra["signing.password"] = ""
+    extra["signing.secretKeyRingFile"] = ""
+  }
+}
+
+/**
+ * see https://github.com/marcphilipp/nexus-publish-plugin/blob/master/README.md
  */
+ext["serverUrl"] = "https://oss.sonatype.org/service/local/staging/deploy/maven2"
+ext["nexusUsername"] = ""
+ext["nexusPassword"] = ""
 
 configure<PublishingExtension> {
   publications {

src/main/kotlin/dev/turingcomplete/kotlinonetimepassword/GoogleAuthenticator.kt

@@ -10,7 +10,7 @@ import java.util.concurrent.TimeUnit
  * SHA1; time step: 30 seconds and code digits: 6.
  *
  * @param base32secret the shared secret <b>that must already be Base32-encoded</b>
- *                     (use [Base32.encode]).
+ *                     (use [org.apache.commons.codec.binary.BaseNCodec.encode(byte[])]).
  */
 class GoogleAuthenticator(base32secret: String) {
   private val timeBasedOneTimePasswordGenerator: TimeBasedOneTimePasswordGenerator

src/main/kotlin/dev/turingcomplete/kotlinonetimepassword/HmacAlgorithm.kt

@@ -1,12 +1,24 @@
 package dev.turingcomplete.kotlinonetimepassword
 
 /**
- * Available "keyed-hash message authentication code" algorithms.
+ * Available "keyed-hash message authentication code" (HMAC) algorithms.
+ * See: https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#Mac
  *
+ * @property macAlgorithmName the name of the algorithm used for
+ *                            [javax.crypto.Mac.getInstance(java.lang.String)]
  * @property hashBytes the length of the returned hash produced by the algorithm.
  */
 enum class HmacAlgorithm(val macAlgorithmName: String, val hashBytes: Int) {
+  /**
+   * SHA1 HMAC with a hash of 20-bytes
+   */
   SHA1("HmacSHA1", 20),
+  /**
+   * SHA256 HMAC with a hash of 32-bytes
+   */
   SHA256("HmacSHA256", 32),
+  /**
+   * SHA512 HMAC with a hash of 64-bytes
+   */
   SHA512("HmacSHA512", 64);
 }