static factory methods are now on the generator classes instead of the builder classes

Author: BastiaanJansen

README.md

@@ -30,23 +30,23 @@ The following features are supported:
 <dependency>
     <groupId>com.github.bastiaanjansen</groupId>
     <artifactId>otp-java</artifactId>
-    <version>1.2.4</version>
+    <version>1.3.0</version>
 </dependency>
 ```
 
 ### Gradle
 ```gradle
-implementation 'com.github.bastiaanjansen:otp-java:1.2.4'
+implementation 'com.github.bastiaanjansen:otp-java:1.3.0'
 ```
 
 ### Scala SBT
 ```scala
-libraryDependencies += "com.github.bastiaanjansen" % "otp-java" % "1.2.4"
+libraryDependencies += "com.github.bastiaanjansen" % "otp-java" % "1.3.0"
 ```
 
 ### Apache Ivy
 ```xml
-<dependency org="com.github.bastiaanjansen" name="otp-java" rev="1.2.4" />
+<dependency org="com.github.bastiaanjansen" name="otp-java" rev="1.3.0" />
 ```
 
 Or you can download the source from the [GitHub releases page](https://github.com/BastiaanJansen/OTP-Java/releases).
@@ -83,7 +83,7 @@ byte[] secret = SecretGenerator.generate(512);
 It is also possible to create a HOTPGenerator instance based on an OTPAuth URI. When algorithm or digits are not specified, the default values will be used.
 ```java
 URI uri = new URI("otpauth://hotp/issuer?secret=ABCDEFGHIJKLMNOP&algorithm=SHA1&digits=6&counter=8237");
-HOTPGenerator hotp = HOTPGenerator.Builder.fromURI(uri);
+HOTPGenerator hotp = HOTPGenerator.fromURI(uri);
 ```
 
 Get information about the generator:
@@ -131,7 +131,7 @@ TOTPGenerator totp = builder.build();
 Or create a `TOTPGenerator` instance from an OTPAuth URI:
 ```java
 URI uri = new URI("otpauth://totp/issuer?secret=ABCDEFGHIJKLMNOP&algorithm=SHA1&digits=6&period=30");
-TOTPGenerator totp = TOTPGenerator.Builder.fromURI(uri);
+TOTPGenerator totp = TOTPGenerator.fromURI(uri);
 ```
 
 Get information about the generator:

pom.xml

@@ -10,7 +10,7 @@
 
     <groupId>com.github.bastiaanjansen</groupId>
     <artifactId>otp-java</artifactId>
-    <version>1.2.4</version>
+    <version>1.3.0</version>
 
     <name>OTP-Java</name>
     <description>A small and easy-to-use one-time password generator for Java according to RFC 4226 (HOTP) and RFC 6238 (TOTP).</description>

src/main/java/com/bastiaanjansen/otp/HOTPGenerator.java

@@ -4,8 +4,10 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.time.Duration;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
 
 /**
  * Generates counter-based one-time passwords
@@ -20,6 +22,47 @@ private HOTPGenerator(final HOTPGenerator.Builder builder) {
         super(builder);
     }
 
+    /**
+     * Build a TOTPGenerator from an OTPAuth URI
+     *
+     * @param uri OTPAuth URI
+     * @return HOTPGenerator
+     * @throws URISyntaxException when URI cannot be parsed
+     */
+    public static HOTPGenerator fromURI(final URI uri) throws URISyntaxException {
+        Map<String, String> query = URIHelper.queryItems(uri);
+
+        byte[] secret = Optional.ofNullable(query.get(URIHelper.SECRET))
+                .map(String::getBytes)
+                .orElseThrow(() -> new IllegalArgumentException("Secret query parameter must be set"));
+
+        Builder builder = new Builder(secret);
+
+        try {
+            Optional.ofNullable(query.get(URIHelper.DIGITS))
+                    .map(Integer::valueOf)
+                    .ifPresent(builder::withPasswordLength);
+            Optional.ofNullable(query.get(URIHelper.ALGORITHM))
+                    .map(String::toUpperCase)
+                    .map(HMACAlgorithm::valueOf)
+                    .ifPresent(builder::withAlgorithm);
+        } catch (Exception e) {
+            throw new URISyntaxException(uri.toString(), "URI could not be parsed");
+        }
+
+        return builder.build();
+    }
+
+    /**
+     * Create a HOTPGenerator with default values
+     *
+     * @param secret used to generate hash
+     * @return a HOTPGenerator with default values
+     */
+    public static HOTPGenerator withDefaultValues(final byte[] secret) {
+        return new HOTPGenerator.Builder(secret).build();
+    }
+
     /**
      * Generate a counter-based one-time password
      * @param counter how many times time interval has passed since 1970
@@ -62,15 +105,11 @@ public URI getURI(final int counter, final String issuer, final String account)
      * @author Bastiaan Jansen
      * @see HOTPGenerator
      */
-    public static class Builder extends OTPGenerator.Builder<Builder, HOTPGenerator> {
+    public static class Builder extends OTPGenerator.Builder<HOTPGenerator, Builder> {
         public Builder(final byte[] secret) {
             super(secret);
         }
 
-        private Builder(final URI uri) throws URISyntaxException {
-            super(uri);
-        }
-
         @Override
         protected Builder getBuilder() {
             return this;
@@ -85,26 +124,5 @@ protected Builder getBuilder() {
         public HOTPGenerator build() {
             return new HOTPGenerator(this);
         }
-
-        /**
-         * Build a TOTPGenerator from an OTPAuth URI
-         *
-         * @param uri OTPAuth URI
-         * @return HOTPGenerator
-         * @throws URISyntaxException when URI cannot be parsed
-         */
-        public static HOTPGenerator fromURI(final URI uri) throws URISyntaxException {
-            return new HOTPGenerator.Builder(uri).build();
-        }
-
-        /**
-         * Create a HOTPGenerator with default values
-         *
-         * @param secret used to generate hash
-         * @return a HOTPGenerator with default values
-         */
-        public static HOTPGenerator withDefaultValues(final byte[] secret) {
-            return new HOTPGenerator.Builder(secret).build();
-        }
     }
 }

src/main/java/com/bastiaanjansen/otp/OTPGenerator.java

@@ -10,6 +10,7 @@
 import java.nio.charset.StandardCharsets;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
+import java.time.Duration;
 import java.util.Map;
 import java.util.Optional;
 
@@ -71,26 +72,6 @@ protected OTPGenerator(final Builder<?, ?> builder) {
         this(builder.passwordLength, builder.algorithm, builder.secret);
     }
 
-    protected OTPGenerator(final URI uri) throws URISyntaxException {
-        Map<String, String> query = URIHelper.queryItems(uri);
-
-        this.secret = Optional.ofNullable(query.get(URIHelper.SECRET))
-                .map(String::getBytes)
-                .orElseThrow(() -> new IllegalArgumentException("Secret query parameter must be set"));
-
-        try {
-            this.passwordLength = Optional.ofNullable(query.get(URIHelper.DIGITS))
-                    .map(Integer::valueOf)
-                    .orElse(DEFAULT_PASSWORD_LENGTH);
-            this.algorithm = Optional.ofNullable(query.get(URIHelper.ALGORITHM))
-                    .map(String::toUpperCase)
-                    .map(HMACAlgorithm::valueOf)
-                    .orElse(DEFAULT_HMAC_ALGORITHM);
-        } catch (Exception e) {
-            throw new URISyntaxException(uri.toString(), "URI could not be parsed");
-        }
-    }
-
     public int getPasswordLength() {
         return passwordLength;
     }
@@ -278,7 +259,7 @@ private boolean validatePasswordLength(final int passwordLength) {
      * @author Bastiaan Jansen
      * @param <B> concrete builder class
      */
-    protected abstract static class Builder<B, G> {
+    protected abstract static class Builder<T extends OTPGenerator, B extends Builder<T, B>> {
         /**
          * Number of digits for generated code in range 6...8, defaults to 6
          */
@@ -300,26 +281,6 @@ public Builder(final byte[] secret) {
             this.algorithm = DEFAULT_HMAC_ALGORITHM;
         }
 
-        public Builder(final URI uri) throws URISyntaxException {
-            Map<String, String> query = URIHelper.queryItems(uri);
-
-            this.secret = Optional.ofNullable(query.get(URIHelper.SECRET))
-                    .map(String::getBytes)
-                    .orElseThrow(() -> new IllegalArgumentException("Secret query parameter must be set"));
-
-            try {
-                this.passwordLength = Optional.ofNullable(query.get(URIHelper.DIGITS))
-                        .map(Integer::valueOf)
-                        .orElse(DEFAULT_PASSWORD_LENGTH);
-                this.algorithm = Optional.ofNullable(query.get(URIHelper.ALGORITHM))
-                        .map(String::toUpperCase)
-                        .map(HMACAlgorithm::valueOf)
-                        .orElse(DEFAULT_HMAC_ALGORITHM);
-            } catch (Exception e) {
-                throw new URISyntaxException(uri.toString(), "URI could not be parsed");
-            }
-        }
-
         /**
          * Change password length of code
          *
@@ -344,6 +305,6 @@ public B withAlgorithm(final HMACAlgorithm algorithm) {
 
         protected abstract B getBuilder();
 
-        public abstract G build();
+        public abstract T build();
     }
 }

src/main/java/com/bastiaanjansen/otp/TOTPGenerator.java

@@ -31,27 +31,54 @@ public final class TOTPGenerator extends OTPGenerator {
      */
     private final Duration period;
 
-    private TOTPGenerator(final TOTPGenerator.Builder builder) {
+    private TOTPGenerator(final Builder builder) {
         super(builder);
         this.period = builder.period;
     }
 
-    private TOTPGenerator(final URI uri) throws URISyntaxException {
-        super(uri);
+    /**
+     * Build a TOTPGenerator from an OTPAuth URI
+     *
+     * @param uri OTPAuth URI
+     * @return TOTPGenerator
+     * @throws URISyntaxException when URI cannot be parsed
+     */
+    public static TOTPGenerator fromURI(URI uri) throws URISyntaxException {
         Map<String, String> query = URIHelper.queryItems(uri);
 
-        try {
-            this.period = Optional.ofNullable(query.get(URIHelper.PERIOD))
-                    .map(Long::parseLong).map(Duration::ofSeconds)
-                    .orElse(DEFAULT_PERIOD);
+        byte[] secret = Optional.ofNullable(query.get(URIHelper.SECRET))
+                .map(String::getBytes)
+                .orElseThrow(() -> new IllegalArgumentException("Secret query parameter must be set"));
+
+        Builder builder = new Builder(secret);
 
+        try {
+            Optional.ofNullable(query.get(URIHelper.PERIOD))
+                    .map(Long::parseLong)
+                    .map(Duration::ofSeconds)
+                    .ifPresent(builder::withPeriod);
+            Optional.ofNullable(query.get(URIHelper.DIGITS))
+                    .map(Integer::valueOf)
+                    .ifPresent(builder::withPasswordLength);
+            Optional.ofNullable(query.get(URIHelper.ALGORITHM))
+                    .map(String::toUpperCase)
+                    .map(HMACAlgorithm::valueOf)
+                    .ifPresent(builder::withAlgorithm);
         } catch (Exception e) {
             throw new URISyntaxException(uri.toString(), "URI could not be parsed");
         }
+
+        return builder.build();
     }
 
-    public static TOTPGenerator fromURI(URI uri) throws URISyntaxException {
-        return new TOTPGenerator(uri);
+    /**
+     * Create a TOTPGenerator with default values
+     *
+     * @param secret used to generate hash
+     * @return a TOTPGenerator with default values
+     */
+    public static TOTPGenerator withDefaultValues(final byte[] secret) {
+        return new TOTPGenerator.Builder(secret).build();
     }
 
     /**
@@ -192,7 +219,7 @@ private boolean validateTime(final long time) {
      * @author Bastiaan Jansen
      * @see TOTPGenerator
      */
-    public static class Builder extends OTPGenerator.Builder<Builder, TOTPGenerator>  {
+    public static class Builder extends OTPGenerator.Builder<TOTPGenerator, Builder>  {
         /**
          * Time interval between new codes
          */
@@ -234,26 +261,5 @@ public TOTPGenerator build() {
         protected Builder getBuilder() {
             return this;
         }
-
-        /**
-         * Build a TOTPGenerator from an OTPAuth URI
-         *
-         * @param uri OTPAuth URI
-         * @return TOTPGenerator
-         * @throws URISyntaxException when URI cannot be parsed
-         */
-//        public static TOTPGenerator fromURI(final URI uri) throws URISyntaxException {
-//            return new TOTPGenerator.Builder(uri).build();
-//        }
-
-        /**
-         * Create a TOTPGenerator with default values
-         *
-         * @param secret used to generate hash
-         * @return a TOTPGenerator with default values
-         */
-        public static TOTPGenerator withDefaultValues(final byte[] secret) {
-            return new TOTPGenerator.Builder(secret).build();
-        }
     }
 }