Merge pull request #455 from atsign-foundation/update_otp_syntax

feat: Add put operation to OTP syntax for SPP
atsign-foundation · Nov 23, 2023 · 8ad9acd · 8ad9acd
2 parents 4cbec2a + 8dd298e
commit 8ad9acd
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/packages/at_commons/CHANGELOG.md b/packages/at_commons/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## 4.0.0
 - fix: Improved regex for Reserved keys (Internal keys used by the server)
+- fix: Add "put" operation to OTP verb to store semi-permanent pass codes
 ## 3.0.58
 - fix: Deprecate encryptedDefaultEncryptedPrivateKey in EnrollParams and introduce encryptedDefaultEncryptedPrivateKey for readability
 - fix: Replace encryptedDefaultEncryptedPrivateKey with encryptedDefaultEncryptionPrivateKey in EnrollVerbBuilder

diff --git a/packages/at_commons/lib/src/verb/syntax.dart b/packages/at_commons/lib/src/verb/syntax.dart
@@ -129,7 +129,7 @@ class VerbSyntax {
   static const enroll =
       // The non-capturing group (?::)? matches ":" if the operation is request|approve|deny|revoke
       r'^enroll:(?<operation>(?:list$|(request|approve|deny|revoke|update)))(?::)?(?<enrollParams>.+)?$';
-  static const otp = r'^otp:(?<operation>get)(:(?:ttl:(?<ttl>\d+)))?$';
+  static const otp = r'^otp:(?<operation>get|put)(:(?<otp>(?<=put:)\w{6,}))?(:(?:ttl:(?<ttl>\d+)))?$';
   static const keys = r'^keys:((?<operation>put|get|delete):?)'
       r'(?:(?<visibility>public|private|self):?)?'
       r'(?:namespace:(?<namespace>[a-zA-Z0-9_]+):?)?'

diff --git a/packages/at_commons/test/otp_verb_test.dart b/packages/at_commons/test/otp_verb_test.dart
@@ -21,4 +21,32 @@ void main() {
       expect(verbParams['otp'], null);
     });
   });
+
+  group('A group of test to verify otp:put regex', () {
+    test('A test to verify otp:put accepts alphanumeric characters', () {
+      Map<dynamic, dynamic> verbParams =
+          getVerbParams(VerbSyntax.otp, 'otp:put:abc123');
+      expect(verbParams[AtConstants.operation], 'put');
+      expect(verbParams['otp'], 'abc123');
+      expect(verbParams['ttl'], null);
+    });
+
+    test(
+        'A test to verify otp:put throws error if otp is not 6 character length',
+        () {
+      expect(
+          () => getVerbParams(VerbSyntax.otp, 'otp:put:abc12'),
+          throwsA(predicate((dynamic e) =>
+              e is InvalidSyntaxException &&
+              e.message == 'command does not match the regex')));
+    });
+
+    test('A test to verify otp:put with ttl', () {
+      Map<dynamic, dynamic> verbParams =
+          getVerbParams(VerbSyntax.otp, 'otp:put:abc123:ttl:123');
+      expect(verbParams[AtConstants.operation], 'put');
+      expect(verbParams['otp'], 'abc123');
+      expect(verbParams['ttl'], '123');
+    });
+  });
 }