fixes #14 on github. adds event retention feature

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.0.6
+
+- [#14](https://github.com/konsultaner/connectanum-dart/issues/14) add support for event retention
+- added some more code comments
+
 ### 1.0.5
 
 - [#13](https://github.com/konsultaner/connectanum-dart/issues/13) changed meta dependency to match latest flutter dependencies 

lib/src/message/abort.dart

@@ -1,10 +1,13 @@
 import 'message_types.dart';
 import 'abstract_message.dart';
 
+/// The WAMP Abort massage
 class Abort extends AbstractMessage {
   Message message;
   String reason;
 
+  /// Creates a WAMP Abort message with a [reason] why something was aborted and an
+  /// optional [message] to describe the issue
   Abort(this.reason, {String message}) {
     id = MessageTypes.CODE_ABORT;
     if (message != null) {
@@ -13,6 +16,7 @@ class Abort extends AbstractMessage {
   }
 }
 
+/// The message structure defined by the WAMP-Protocol
 class Message {
   String message;
 

lib/src/message/abstract_message.dart

@@ -1,3 +1,5 @@
+/// all WAMP messages have an id, this abstract message provides this default
+/// existing field
 abstract class AbstractMessage {
   int id;
 }

lib/src/message/authenticate.dart

@@ -1,14 +1,20 @@
 import 'abstract_message.dart';
 import 'message_types.dart';
 
+/// The WAMP Authenticate massage
 class Authenticate extends AbstractMessage {
   String signature;
   Map<String, Object> extra;
 
+  /// Creates a WAMP Authentication message with a [signature] that was
+  /// cryptographically created by an authentication method of this package
   Authenticate({this.signature}) {
     id = MessageTypes.CODE_AUTHENTICATE;
   }
 
+  /// A factory that creates an instance of a WAMP Authenticate massage by
+  /// passing in a [signature] that was
+  /// cryptographically created by an authentication method of this package
   factory Authenticate.signature(String signature) {
     final authenticate = Authenticate();
     authenticate.signature = signature;

lib/src/message/call.dart

@@ -1,11 +1,15 @@
 import 'abstract_message_with_payload.dart';
 import 'message_types.dart';
 
+/// The WAMP Call massage
 class Call extends AbstractMessageWithPayload {
   int requestId;
   CallOptions options;
   String procedure;
 
+  /// Creates a WAMP Call message with a [requestId] that is kind of like a
+  /// transaction identifier and a [procedure] that was registered to the router
+  /// before. The [options] field may be passed to configure the call
   Call(this.requestId, this.procedure,
       {this.options,
       List<Object> arguments,

lib/src/message/cancel.dart

@@ -1,12 +1,15 @@
 import 'abstract_message.dart';
 import 'message_types.dart';
 
+/// The WAMP Call massage
 class Cancel extends AbstractMessage {
   @override
   int id;
   int requestId;
   CancelOptions options;
 
+  /// Creates a WAMP Cancel message with the canceled calls [requestId] and
+  /// some optional [options] to configure the cancel behavior
   Cancel(this.requestId, {this.options}) {
     id = MessageTypes.CODE_CANCEL;
   }

lib/src/message/challenge.dart

@@ -1,10 +1,14 @@
 import 'abstract_message.dart';
 import 'message_types.dart';
 
+/// The WAMP Challenge massage
 class Challenge extends AbstractMessage {
   String authMethod;
   Extra extra;
 
+  /// Creates a WAMP Challenge message that is returned by the router to
+  /// challenge the client with a given [authMethod] and some [extra]
+  /// authentication data
   Challenge(this.authMethod, this.extra) {
     id = MessageTypes.CODE_CHALLENGE;
   }

lib/src/message/error.dart

@@ -1,6 +1,7 @@
 import 'abstract_message_with_payload.dart';
 import 'message_types.dart';
 
+/// The WAMP Error massage
 class Error extends AbstractMessageWithPayload {
   static final String ERROR_INVOCATION_CANCELED =
       'wamp.error.invocation_canceled';

lib/src/message/publish.dart

@@ -33,6 +33,9 @@ class PublishOptions {
   // publisher_identification == true
   bool disclose_me;
 
+  // event_retention == true
+  bool retain;
+
   PublishOptions(
       {this.acknowledge,
       this.exclude,
@@ -42,5 +45,6 @@ class PublishOptions {
       this.eligible_authid,
       this.eligible_authrole,
       this.exclude_me,
-      this.disclose_me});
+      this.disclose_me,
+      this.retain});
 }

lib/src/message/subscribe.dart

@@ -18,6 +18,7 @@ class SubscribeOptions {
 
   String match;
   String meta_topic;
+  bool get_retained;
 
-  SubscribeOptions({this.match, this.meta_topic});
+  SubscribeOptions({this.match, this.meta_topic, this.get_retained});
 }

lib/src/serializer/json/serializer.dart

@@ -372,6 +372,10 @@ class Serializer extends AbstractSerializer {
   String _serializeSubscribeOptions(SubscribeOptions options) {
     var jsonOptions = [];
     if (options != null) {
+      if (options.get_retained != null) {
+        jsonOptions
+            .add('"get_retained":${options.get_retained ? "true" : "false"}');
+      }
       if (options.match != null) {
         jsonOptions.add('"match":"${options.match}"');
       }
@@ -433,6 +437,10 @@ class Serializer extends AbstractSerializer {
   String _serializePublish(PublishOptions options) {
     var jsonDetails = [];
     if (options != null) {
+      if (options.retain != null) {
+        jsonDetails
+            .add('"retain":${options.retain ? "true" : "false"}');
+      }
       if (options.disclose_me != null) {
         jsonDetails
             .add('"disclose_me":${options.disclose_me ? "true" : "false"}');

pubspec.yaml

@@ -1,6 +1,6 @@
 name: connectanum
 homepage: https://github.com/konsultaner/connectanum-dart
-version: 1.0.5
+version: 1.0.6
 description: >-
   This is a WAMP client (Web Application Messaging Protocol) implementation for the dart language and flutter projects.
 dependencies:

test/serializer/json/serializer_test.dart

@@ -201,10 +201,11 @@ void main() {
           serializer.serializeToString(Subscribe(
               713845233, 'com.myapp.mytopic1',
               options: SubscribeOptions(
+                  get_retained: true,
                   match: SubscribeOptions.MATCH_WILDCARD,
                   meta_topic: 'topic'))),
           equals(
-              '[32,713845233,{"match":"wildcard","meta_topic":"topic"},"com.myapp.mytopic1"]'));
+              '[32,713845233,{"get_retained":true,"match":"wildcard","meta_topic":"topic"},"com.myapp.mytopic1"]'));
     });
     test('Unsubscribe', () {
       expect(serializer.serializeToString(Unsubscribe(85346237, 5512315355)),
@@ -222,6 +223,7 @@ void main() {
       expect(
           serializer.serializeToString(Publish(239714735, 'com.myapp.mytopic1',
               options: PublishOptions(
+                  retain: true,
                   disclose_me: true,
                   acknowledge: true,
                   exclude_me: true,
@@ -232,7 +234,7 @@ void main() {
                   exclude_authid: ['bbb'],
                   exclude_authrole: ['admin']))),
           equals(
-              '[16,239714735,{"disclose_me":true,"acknowledge":true,"exclude_me":true,"exclude":[2],"exclude_authid":["bbb"],"exclude_authrole":["admin"],"eligible":[1],"eligible_authid":["aaa"],"eligible_authrole":["role"]},"com.myapp.mytopic1"]'));
+              '[16,239714735,{"retain":true,"disclose_me":true,"acknowledge":true,"exclude_me":true,"exclude":[2],"exclude_authid":["bbb"],"exclude_authrole":["admin"],"eligible":[1],"eligible_authid":["aaa"],"eligible_authrole":["role"]},"com.myapp.mytopic1"]'));
       expect(
           serializer.serializeToString(Publish(239714735, 'com.myapp.mytopic1',
               arguments: ['Hello, world!'])),