Add MIXUpdateSubscription Element, its Parser and Serializer

Updates MIXJoin Element list of subscriptions to an unordered_set. Remove redundant MIXSubscribe Element. License: This patch is BSD-licensed, see Documentation/Licenses/BSD-simplified.txt for details. Test-Information: Added tests for MIXUpdateSubscription Parser and Serializer based on examples in XEP 0369, which passes. Tested on Ubuntu 16.04 LTS. Change-Id: Ied06269cf329b4fdffdde4ace67ebffa4089fbde
author: Tarun Gupta <tarun1995gupta@gmail.com> 2017-07-07 21:09:17 (GMT)
committer: Tobias Markmann <tm@ayena.de> 2017-07-18 15:05:09 (GMT)
commit: f0db4d39912e773208e9db2a3da3b68ac92ba17b (patch)
tree: cb6a455ba7b21d2218b3f9f2040af3bf30a39004 /Swiften/Serializer
parent: f21c9448c5187493fd08574962d88c2db1405512 (diff)
download: swift-f0db4d39912e773208e9db2a3da3b68ac92ba17b.zip
swift-f0db4d39912e773208e9db2a3da3b68ac92ba17b.tar.bz2
7 files changed, 118 insertions, 91 deletions
diff --git a/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp b/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
index d1b2e97..428ce76 100644
--- a/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
+++ b/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
@@ -47,6 +47,7 @@
 #include <Swiften/Serializer/PayloadSerializers/MAMResultSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXDestroySerializer.h>
+#include <Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXParticipantSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXRegisterNickSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXCreateSerializer.h>
@@ -172,6 +173,7 @@ FullPayloadSerializerCollection::FullPayloadSerializerCollection() {
     serializers_.push_back(new MIXLeaveSerializer());
     serializers_.push_back(new MIXJoinSerializer());
     serializers_.push_back(new MIXDestroySerializer());
+    serializers_.push_back(new MIXUpdateSubscriptionSerializer());
     serializers_.push_back(new MAMResultSerializer(this));
     serializers_.push_back(new MAMQuerySerializer());
     serializers_.push_back(new MAMFinSerializer());
diff --git a/Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.cpp b/Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.cpp
index cfb4d31..509e41e 100644
--- a/Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.cpp
+++ b/Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.cpp
@@ -7,8 +7,8 @@
 #include <Swiften/Serializer/PayloadSerializers/MIXJoinSerializer.h>
 
 #include <memory>
+#include <string>
 
-#include <Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/FormSerializer.h>
 #include <Swiften/Serializer/XML/XMLElement.h>
 #include <Swiften/Serializer/XML/XMLRawTextNode.h>
@@ -32,9 +32,16 @@ std::string MIXJoinSerializer::serializePayload(std::shared_ptr<MIXJoin> payload
     if (payload->getJID()) {
         element.setAttribute("jid", *payload->getJID());
     }
-    for (const auto& item : payload->getSubscriptions()) {
-        element.addNode(std::make_shared<XMLRawTextNode>(MIXSubscribeSerializer().serialize(item)));
+    auto subscriptionData = payload->getSubscriptions();
+    std::vector<std::string> subscriptions(subscriptionData.begin(), subscriptionData.end());
+    std::sort(subscriptions.begin(), subscriptions.end());
+
+    for (const auto& item : subscriptions) {
+        auto subscribeElement = std::make_shared<XMLElement>("subscribe");
+        subscribeElement->setAttribute("node", item);
+        element.addNode(subscribeElement);
     }
+
     if (payload->getForm()) {
         element.addNode(std::make_shared<XMLRawTextNode>(FormSerializer().serialize(payload->getForm())));
     }
diff --git a/Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.cpp b/Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.cpp
deleted file mode 100644
index 3ce6d89..0000000
--- a/Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.cpp
+++ /dev/null
@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2017 Tarun Gupta
- * Licensed under the simplified BSD license.
- * See Documentation/Licenses/BSD-simplified.txt for more information.
- */
-
-#include <Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.h>
-
-#include <memory>
-
-#include <Swiften/Serializer/XML/XMLElement.h>
-#include <Swiften/Serializer/XML/XMLRawTextNode.h>
-
-using namespace Swift;
-
-MIXSubscribeSerializer::MIXSubscribeSerializer() {
-}
-
-MIXSubscribeSerializer::~MIXSubscribeSerializer() {
-}
-
-std::string MIXSubscribeSerializer::serializePayload(std::shared_ptr<MIXSubscribe> payload) const {
-    if (!payload) {
-        return "";
-    }
-    XMLElement element("subscribe");
-    element.setAttribute("node", payload->getNode());
-    return element.serialize();
-}
diff --git a/Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.cpp b/Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.cpp
new file mode 100644
index 0000000..8e95474
--- /dev/null
+++ b/Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.cpp
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.h>
+
+#include <memory>
+
+#include <Swiften/Serializer/PayloadSerializers/FormSerializer.h>
+#include <Swiften/Serializer/XML/XMLElement.h>
+#include <Swiften/Serializer/XML/XMLRawTextNode.h>
+
+namespace Swift {
+
+MIXUpdateSubscriptionSerializer::MIXUpdateSubscriptionSerializer() {
+}
+
+MIXUpdateSubscriptionSerializer::~MIXUpdateSubscriptionSerializer() {
+}
+
+std::string MIXUpdateSubscriptionSerializer::serializePayload(std::shared_ptr<MIXUpdateSubscription> payload) const {
+    if (!payload) {
+        return "";
+    }
+    XMLElement element("update-subscription", "urn:xmpp:mix:0");
+    if (payload->getJID()) {
+        element.setAttribute("jid", *payload->getJID());
+    }
+    auto subscriptionData = payload->getSubscriptions();
+    std::vector<std::string> subscriptions(subscriptionData.begin(), subscriptionData.end());
+    std::sort(subscriptions.begin(), subscriptions.end());
+
+    for (const auto& item : subscriptions) {
+        auto subscribeElement = std::make_shared<XMLElement>("subscribe");
+        subscribeElement->setAttribute("node", item);
+        element.addNode(subscribeElement);
+    }
+    return element.serialize();
+}
+
+}
diff --git a/Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.h b/Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.h
index a63a2be..ee59bf7 100644
--- a/Swiften/Serializer/PayloadSerializers/MIXSubscribeSerializer.h
+++ b/Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.h
@@ -15,16 +15,16 @@
 #include <memory>
 
 #include <Swiften/Base/API.h>
-#include <Swiften/Elements/MIXSubscribe.h>
+#include <Swiften/Elements/MIXUpdateSubscription.h>
 #include <Swiften/Serializer/GenericPayloadSerializer.h>
 
 namespace Swift {
 
-    class SWIFTEN_API MIXSubscribeSerializer : public GenericPayloadSerializer<MIXSubscribe> {
+    class SWIFTEN_API MIXUpdateSubscriptionSerializer : public GenericPayloadSerializer<MIXUpdateSubscription> {
         public:
-            MIXSubscribeSerializer();
-            virtual ~MIXSubscribeSerializer() override;
+            MIXUpdateSubscriptionSerializer();
+            virtual ~MIXUpdateSubscriptionSerializer();
 
-            virtual std::string serializePayload(std::shared_ptr<MIXSubscribe>) const override;
+            virtual std::string serializePayload(std::shared_ptr<MIXUpdateSubscription>) const override;
     };
 }
diff --git a/Swiften/Serializer/PayloadSerializers/UnitTest/MIXJoinSerializerTest.cpp b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXJoinSerializerTest.cpp
index ff8aa70..2987a20 100644
--- a/Swiften/Serializer/PayloadSerializers/UnitTest/MIXJoinSerializerTest.cpp
+++ b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXJoinSerializerTest.cpp
@@ -16,24 +16,16 @@ TEST(MIXJoinSerializerTest, XEP0369_Example22) {
     auto join = std::make_shared<MIXJoin>();
     join->setChannel(JID("coven@mix.shakespeare.example"));
 
-    std::shared_ptr<MIXSubscribe> node1(new MIXSubscribe());
-    node1->setNode(std::string("urn:xmpp:mix:nodes:messages"));
-    join->addSubscription(node1);
-    std::shared_ptr<MIXSubscribe> node2(new MIXSubscribe());
-    node2->setNode(std::string("urn:xmpp:mix:nodes:presence"));
-    join->addSubscription(node2);
-    std::shared_ptr<MIXSubscribe> node3(new MIXSubscribe());
-    node3->setNode(std::string("urn:xmpp:mix:nodes:participants"));
-    join->addSubscription(node3);
-    std::shared_ptr<MIXSubscribe> node4(new MIXSubscribe());
-    node4->setNode(std::string("urn:xmpp:mix:nodes:config"));
-    join->addSubscription(node4);
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:presence"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:participants"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:config"));
 
     std::string expectedResult = "<join channel=\"coven@mix.shakespeare.example\" xmlns=\"urn:xmpp:mix:0\">"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                 "</join>";
     ASSERT_EQ(expectedResult, testling.serialize(join));
 }
@@ -43,24 +35,16 @@ TEST(MIXJoinSerializerTest, XEP0369_Example23) {
 
     std::shared_ptr<MIXJoin> join(new MIXJoin());
 
-    std::shared_ptr<MIXSubscribe> node1(new MIXSubscribe());
-    node1->setNode(std::string("urn:xmpp:mix:nodes:messages"));
-    join->addSubscription(node1);
-    std::shared_ptr<MIXSubscribe> node2(new MIXSubscribe());
-    node2->setNode(std::string("urn:xmpp:mix:nodes:presence"));
-    join->addSubscription(node2);
-    std::shared_ptr<MIXSubscribe> node3(new MIXSubscribe());
-    node3->setNode(std::string("urn:xmpp:mix:nodes:participants"));
-    join->addSubscription(node3);
-    std::shared_ptr<MIXSubscribe> node4(new MIXSubscribe());
-    node4->setNode(std::string("urn:xmpp:mix:nodes:config"));
-    join->addSubscription(node4);
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:presence"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:participants"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:config"));
 
     std::string expectedResult = "<join xmlns=\"urn:xmpp:mix:0\">"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                 "</join>";
     ASSERT_EQ(expectedResult, testling.serialize(join));
 }
@@ -71,24 +55,16 @@ TEST(MIXJoinSerializerTest, XEP0369_Example24) {
     std::shared_ptr<MIXJoin> join(new MIXJoin());
     join->setJID(JID("123456#coven@mix.shakespeare.example"));
 
-    std::shared_ptr<MIXSubscribe> node1(new MIXSubscribe());
-    node1->setNode(std::string("urn:xmpp:mix:nodes:messages"));
-    join->addSubscription(node1);
-    std::shared_ptr<MIXSubscribe> node2(new MIXSubscribe());
-    node2->setNode(std::string("urn:xmpp:mix:nodes:presence"));
-    join->addSubscription(node2);
-    std::shared_ptr<MIXSubscribe> node3(new MIXSubscribe());
-    node3->setNode(std::string("urn:xmpp:mix:nodes:participants"));
-    join->addSubscription(node3);
-    std::shared_ptr<MIXSubscribe> node4(new MIXSubscribe());
-    node4->setNode(std::string("urn:xmpp:mix:nodes:config"));
-    join->addSubscription(node4);
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:presence"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:participants"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:config"));
 
     std::string expectedResult = "<join jid=\"123456#coven@mix.shakespeare.example\" xmlns=\"urn:xmpp:mix:0\">"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                     "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>"
-                    "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>"
+                    "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>"
                 "</join>";
     ASSERT_EQ(expectedResult, testling.serialize(join));
 }
@@ -98,12 +74,8 @@ TEST(MIXJoinSerializerTest, XEP0369_Example29) {
 
     std::shared_ptr<MIXJoin> join(new MIXJoin());
 
-    std::shared_ptr<MIXSubscribe> node1(new MIXSubscribe());
-    node1->setNode(std::string("urn:xmpp:mix:nodes:messages"));
-    join->addSubscription(node1);
-    std::shared_ptr<MIXSubscribe> node2(new MIXSubscribe());
-    node2->setNode(std::string("urn:xmpp:mix:nodes:presence"));
-    join->addSubscription(node2);
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:presence"));
 
     std::shared_ptr<Form> parameters(std::make_shared<Form>());
     parameters->setType(Form::Type::SubmitType);
@@ -141,12 +113,8 @@ TEST(MIXJoinSerializerTest, XEP0369_Example30) {
     std::shared_ptr<MIXJoin> join(new MIXJoin());
     join->setJID(JID("hag66@shakespeare.example"));
 
-    std::shared_ptr<MIXSubscribe> node1(new MIXSubscribe());
-    node1->setNode(std::string("urn:xmpp:mix:nodes:messages"));
-    join->addSubscription(node1);
-    std::shared_ptr<MIXSubscribe> node2(new MIXSubscribe());
-    node2->setNode(std::string("urn:xmpp:mix:nodes:presence"));
-    join->addSubscription(node2);
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+    join->addSubscription(std::string("urn:xmpp:mix:nodes:presence"));
 
     std::shared_ptr<Form> parameters(std::make_shared<Form>());
     parameters->setType(Form::Type::ResultType);
diff --git a/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUpdateSubscriptionSerializerTest.cpp b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUpdateSubscriptionSerializerTest.cpp
new file mode 100644
index 0000000..3e35a82
--- /dev/null
+++ b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUpdateSubscriptionSerializerTest.cpp
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <gtest/gtest.h>
+
+#include <Swiften/Serializer/PayloadSerializers/MIXUpdateSubscriptionSerializer.h>
+
+using namespace Swift;
+
+TEST(MIXUpdateSubscriptionSerializerTest, XEP0369_Example28) {
+    MIXUpdateSubscriptionSerializer testling;
+
+    auto update = std::make_shared<MIXUpdateSubscription>();
+    update->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+
+    std::string expectedResult = "<update-subscription xmlns=\"urn:xmpp:mix:0\">"
+                                    "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>"
+                                "</update-subscription>";
+    ASSERT_EQ(expectedResult, testling.serialize(update));
+}
+
+TEST(MIXUpdateSubscriptionSerializerTest, XEP0369_Example28WithJID) {
+    MIXUpdateSubscriptionSerializer testling;
+
+    auto update = std::make_shared<MIXUpdateSubscription>();
+    update->setJID(JID("hag66@shakespeare.example"));
+    update->addSubscription(std::string("urn:xmpp:mix:nodes:messages"));
+
+    std::string expectedResult = "<update-subscription jid=\"hag66@shakespeare.example\" xmlns=\"urn:xmpp:mix:0\">"
+                                    "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>"
+                                "</update-subscription>";
+    ASSERT_EQ(expectedResult, testling.serialize(update));
+}
author	Tarun Gupta <tarun1995gupta@gmail.com>	2017-07-07 21:09:17 (GMT)
committer	Tobias Markmann <tm@ayena.de>	2017-07-18 15:05:09 (GMT)
commit	f0db4d39912e773208e9db2a3da3b68ac92ba17b (patch)
tree	cb6a455ba7b21d2218b3f9f2040af3bf30a39004 /Swiften/Serializer
parent	f21c9448c5187493fd08574962d88c2db1405512 (diff)
download	swift-f0db4d39912e773208e9db2a3da3b68ac92ba17b.zip swift-f0db4d39912e773208e9db2a3da3b68ac92ba17b.tar.bz2