made classes final and removed otp constructors, using builders is now obligated

Author: BastiaanJansen

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

@@ -13,21 +13,11 @@
  * @author Bastiaan Jansen
  * @see OTPGenerator
  */
-public class HOTPGenerator extends OTPGenerator {
+public final class HOTPGenerator extends OTPGenerator {
     private final static String OTP_TYPE = "hotp";
 
-    /**
-     * Constructs generator with custom password length
-     * @param passwordLength number of digits for generated code in range 6...8
-     * @param algorithm HMAC hash algorithm used to hash data
-     * @param secret used to generate hash
-     */
-    public HOTPGenerator(final int passwordLength, final HMACAlgorithm algorithm, final byte[] secret) {
-        super(passwordLength, algorithm, secret);
-    }
-
     private HOTPGenerator(final HOTPGenerator.Builder builder) {
-        super(builder.getPasswordLength(), builder.getAlgorithm(), builder.getSecret());
+        super(builder);
     }
 
     /**

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

@@ -20,7 +20,7 @@
  *
  * @author Bastiaan Jansen
  */
-public class OTPGenerator {
+class OTPGenerator {
     private final static String URL_SCHEME = "otpauth";
 
     /**
@@ -57,6 +57,10 @@ protected OTPGenerator(final int passwordLength, final HMACAlgorithm algorithm,
         this.secret = secret;
     }
 
+    protected OTPGenerator(final Builder<?, ?> builder) {
+        this(builder.getPasswordLength(), builder.getAlgorithm(), builder.getSecret());
+    }
+
     public int getPasswordLength() {
         return passwordLength;
     }
@@ -248,27 +252,27 @@ protected abstract static class Builder<B, G> {
         /**
          * Number of digits for generated code in range 6...8, defaults to 6
          */
-        protected int passwordLength;
+        private int passwordLength;
 
         /**
          * Hashing algorithm used to generate code, defaults to SHA1
          */
-        protected HMACAlgorithm algorithm;
+        private HMACAlgorithm algorithm;
 
         /**
          * Secret key used to generate the code, this should be a base32 string
          */
-        protected byte[] secret;
+        private final byte[] secret;
 
         /**
          * Default value for password length
          */
-        public static final int DEFAULT_PASSWORD_LENGTH = 6;
+        private static final int DEFAULT_PASSWORD_LENGTH = 6;
 
         /**
          * Default value for HMAC Algorithm
          */
-        public static final HMACAlgorithm DEFAULT_HMAC_ALGORITHM = HMACAlgorithm.SHA1;
+        private static final HMACAlgorithm DEFAULT_HMAC_ALGORITHM = HMACAlgorithm.SHA1;
 
         public Builder(final byte[] secret) {
             this.secret = secret;

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

@@ -18,32 +18,16 @@
  * @author Bastiaan Jansen
  * @see OTPGenerator
  */
-public class TOTPGenerator extends OTPGenerator {
+public final class TOTPGenerator extends OTPGenerator {
     private final static String OTP_TYPE = "totp";
 
     /**
      * Time interval between new codes
      */
     private final Duration period;
 
-    /**
-     * Constructs generator with custom password length, time interval and hashing algorithm
-     *
-     * @param passwordLength number of digits for generated code in range 6...8
-     * @param period time interval between new codes
-     * @param algorithm HMAC hash algorithm used to hash data
-     * @param secret used to generate hash
-     */
-    public TOTPGenerator(final int passwordLength, final Duration period, final HMACAlgorithm algorithm, final byte[] secret) {
-        super(passwordLength, algorithm, secret);
-
-        if (period.getSeconds() < 1) throw new IllegalArgumentException("Period must be at least 1 second");
-
-        this.period = period;
-    }
-
     private TOTPGenerator(final TOTPGenerator.Builder builder) {
-        super(builder.getPasswordLength(), builder.getAlgorithm(), builder.getSecret());
+        super(builder);
         this.period = builder.getPeriod();
     }
 
@@ -194,7 +178,7 @@ public static class Builder extends OTPGenerator.Builder<Builder, TOTPGenerator>
         /**
          * Default time interval for a time-based one-time password
          */
-        public static final Duration DEFAULT_PERIOD = Duration.ofSeconds(30);
+        private static final Duration DEFAULT_PERIOD = Duration.ofSeconds(30);
 
         /**
          * Constructs a TOTPGenerator builder

src/test/java/com/bastiaanjansen/otp/HOTPGeneratorTest.java

@@ -15,17 +15,17 @@ class HOTPGeneratorTest {
 
     private final String secret = "vv3kox7uqj4kyakohmzpph3us4cjimh6f3zknb5c2oobq6v2kiyhm27q";
 
-    @Test
-    void constructor_instanceOfHOTPGenerator() {
-        HOTPGenerator generator = new HOTPGenerator(6, HMACAlgorithm.SHA1, secret.getBytes());
-
-        assertThat(generator, instanceOf(HOTPGenerator.class));
-    }
-
-    @Test
-    void constructorWithInvalidPasswordLength_throwsIllegalArgumentException() {
-        assertThrows(IllegalArgumentException.class, () -> new HOTPGenerator(5, HMACAlgorithm.SHA1, secret.getBytes()));
-    }
+//    @Test
+//    void constructor_instanceOfHOTPGenerator() {
+//        HOTPGenerator generator = new HOTPGenerator(6, HMACAlgorithm.SHA1, secret.getBytes());
+//
+//        assertThat(generator, instanceOf(HOTPGenerator.class));
+//    }
+//
+//    @Test
+//    void constructorWithInvalidPasswordLength_throwsIllegalArgumentException() {
+//        assertThrows(IllegalArgumentException.class, () -> new HOTPGenerator(5, HMACAlgorithm.SHA1, secret.getBytes()));
+//    }
 
     @Test
     void generateWithSixDigits() {

src/test/java/com/bastiaanjansen/otp/TOTPGeneratorTest.java

@@ -20,15 +20,24 @@ class TOTPGeneratorTest {
     private final String secret = "vv3kox7uqj4kyakohmzpph3us4cjimh6f3zknb5c2oobq6v2kiyhm27q";
 
     @Test
-    void constructor_instanceOfTOTPGenerator() {
-        TOTPGenerator generator = new TOTPGenerator(6, Duration.ofSeconds(30), HMACAlgorithm.SHA1, secret.getBytes());
+    void builderWithInvalidPasswordLength_throwsIllegalArgumentException() {
+        assertThrows(IllegalArgumentException.class, () -> new TOTPGenerator.Builder(secret.getBytes()).withPasswordLength(5).build());
+    }
+
+    @Test
+    void builderWithoutPeriod_defaultPeriod() {
+        TOTPGenerator generator = new TOTPGenerator.Builder(secret.getBytes()).build();
+        Duration expected = Duration.ofSeconds(30);
 
-        assertThat(generator, instanceOf(TOTPGenerator.class));
+        assertThat(generator.getPeriod(), is(expected));
     }
 
     @Test
-    void constructorWithInvalidPasswordLength_throwsIllegalArgumentException() {
-        assertThrows(IllegalArgumentException.class, () -> new TOTPGenerator(5, Duration.ofSeconds(30), HMACAlgorithm.SHA1, secret.getBytes()));
+    void builderWithoutAlgorithm_defaultAlgorithm() {
+        TOTPGenerator generator = new TOTPGenerator.Builder(secret.getBytes()).build();
+        HMACAlgorithm expected = HMACAlgorithm.SHA1;
+
+        assertThat(generator.getAlgorithm(), is(expected));
     }
 
     @Test