Made validate function public

README.md

@@ -124,6 +124,7 @@ The library used [`java.util.logging`](https://docs.oracle.com/javase/8/docs/api
 with(poster.logger) {
     addHandler(ConsoleHandler().apply { level = Level.FINE })
     level = Level.FINE
+    useParentHandlers = false
 }
 ```
 
@@ -135,6 +136,7 @@ consoleHandler.setLevel(Level.FINE);
 final Logger logger = poster.getLogger();
 logger.addHandler(consoleHandler);
 logger.setLevel(Level.FINE);
+logger.setUseParentHandlers(false);
 ```
 
 or using a logging properties file.

examples/bld/.idea/app.iml

@@ -10,6 +10,7 @@
       <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/resources" type="java-test-resource" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/kotlin" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/src/main/kotlin" isTestSource="false" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />

examples/bld/src/main/java/net/thauvin/erik/pinboard/samples/JavaExample.java

@@ -29,6 +29,7 @@ public class JavaExample {
         logger.setLevel(Level.FINE);
         logger.setUseParentHandlers(false);
 
+        if (poster.validate()) {
             // Add Pin
             if (poster.addPin(new PinConfig.Builder()
                     .url(url)
@@ -45,3 +46,4 @@ public class JavaExample {
             }
         }
     }
+}

examples/bld/src/main/kotlin/net/thauvin/erik/pinboard/samples/KotlinExample.kt

@@ -20,8 +20,10 @@ fun main(args: Array<String>) {
     with(poster.logger) {
         addHandler(ConsoleHandler().apply { level = Level.FINE })
         level = Level.FINE
+        useParentHandlers = false
     }
 
+    if (poster.validate()) {
         // Add Pin
         if (poster.addPin(url, "Testing", "Extended test", tags = arrayOf("test", "kotlin"))) {
             println("Added: $url")
@@ -32,3 +34,4 @@ fun main(args: Array<String>) {
             println("Deleted: $url")
         }
     }
+}

examples/gradle/java/src/main/java/net/thauvin/erik/pinboard/samples/JavaExample.java

@@ -29,6 +29,7 @@ public class JavaExample {
         logger.setLevel(Level.FINE);
         logger.setUseParentHandlers(false);
 
+        if (poster.validate()) {
             // Add Pin
             if (poster.addPin(new PinConfig.Builder()
                     .url(url)
@@ -45,3 +46,4 @@ public class JavaExample {
             }
         }
     }
+}

examples/gradle/kotlin/src/main/kotlin/net/thauvin/erik/pinboard/samples/KotlinExample.kt

@@ -20,8 +20,10 @@ fun main(args: Array<String>) {
     with(poster.logger) {
         addHandler(ConsoleHandler().apply { level = Level.FINE })
         level = Level.FINE
+        useParentHandlers = false
     }
 
+    if (poster.validate()) {
         // Add Pin
         if (poster.addPin(url, "Testing", "Extended test", tags = arrayOf("test", "kotlin"))) {
             println("Added: $url")
@@ -32,3 +34,4 @@ fun main(args: Array<String>) {
             println("Deleted: $url")
         }
     }
+}

src/bld/java/net/thauvin/erik/pinboard/PinboardPosterBuild.java

@@ -55,7 +55,7 @@ import static rife.bld.dependencies.Scope.test;
 
 public class PinboardPosterBuild extends Project {
     public PinboardPosterBuild() {
-        pkg = "net.thauvin.erik.pinboard";
+        pkg = "net.thauvin.erik";
         name = "pinboard-poster";
         version = version(1, 1, 1, "SNAPSHOT");
 
@@ -82,7 +82,7 @@ public class PinboardPosterBuild extends Project {
                         : repository(SONATYPE_RELEASES_LEGACY.location())
                         .withCredentials(property("sonatype.user"), property("sonatype.password")))
                 .info()
-                .groupId("net.thauvin.erik")
+                .groupId(pkg)
                 .artifactId(name)
                 .description("A small library for posting to Pinboard")
                 .url("https://github.com/ethauvin/" + name)

src/main/kotlin/net/thauvin/erik/pinboard/PinConfig.kt

@@ -35,6 +35,8 @@ import java.time.ZonedDateTime
 
 /**
  * Provides a builder to add a pin.
+ *
+ * Supports of all the [Pinboard API Parameters](https://pinboard.in/api/#posts_add).
  */
 class PinConfig private constructor(
     val url: String,

src/main/kotlin/net/thauvin/erik/pinboard/PinboardPoster.kt

@@ -65,7 +65,7 @@ object Constants {
  *
  * @constructor Creates a new instance.
  *
- * @author [Erik C. Thauvin](https://erik.thauvin.net/)
+ * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
  */
 open class PinboardPoster() {
     /**
@@ -135,9 +135,7 @@ open class PinboardPoster() {
     }
 
     /**
-     * Adds a bookmark to Pinboard
+     * Adds a bookmark to Pinboard using a [PinConfig] builder.
-     *
-     * This method supports of all the [Pinboard API Parameters](https://pinboard.in/api/#posts_add).
      */
     fun addPin(config: PinConfig): Boolean {
         return addPin(
@@ -293,7 +291,10 @@ open class PinboardPoster() {
         return false
     }
 
-    private fun validate(): Boolean {
+    /**
+     * Ensures that the API token and end point are valid.
+     */
+    fun validate(): Boolean {
         var isValid = true
         if (!apiToken.contains(':')) {
             logger.severe("Please specify a valid API token. (eg. user:TOKEN)")

src/test/kotlin/net/thauvin/erik/pinboard/PinboardPosterTest.kt

@@ -66,6 +66,8 @@ class PinboardPosterTest {
         if (!isCi) {
             poster.logger.level = Level.FINE
         }
+        assertTrue(poster.validate(), "validate()")
+
         assertTrue(poster.addPin(url, desc), "addPin($url, $desc)")
 
         assertTrue(poster.deletePin(url), "deletePin($url)")
@@ -78,6 +80,8 @@ class PinboardPosterTest {
             poster.logger.level = Level.FINE
         }
 
+        assertTrue(poster.validate(), "validate()")
+
         var config = PinConfig.Builder().url(url).description(desc).extended("extra")
 
         assertTrue(poster.addPin(config.build()), "apiToken: ${Constants.ENV_API_TOKEN}")
@@ -120,6 +124,8 @@ class PinboardPosterTest {
             poster.logger.level = Level.FINE
         }
 
+        assertTrue(poster.validate(), "validate()")
+
         poster.apiEndPoint = ""
         assertFalse(poster.deletePin(url), "apiEndPoint: <blank>")