From 4134fa4133aedc824bcedc11402805773a2c6144 Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Fri, 22 Jul 2016 18:15:43 +0900
Subject: Introduced LogoutJob

The job calls the /logout endpoint of CS API that invalidates the passed
access_token; a respective Connection::logout() method and
Connection::loggedOut() signal are added for use in clients.
---
 CMakeLists.txt     |  1 +
 connection.cpp     |  8 ++++++++
 connection.h       |  6 +++++-
 jobs/logoutjob.cpp | 35 +++++++++++++++++++++++++++++++++++
 jobs/logoutjob.h   | 34 ++++++++++++++++++++++++++++++++++
 5 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 jobs/logoutjob.cpp
 create mode 100644 jobs/logoutjob.h

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 8b077275..3745f3c2 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -78,6 +78,7 @@ set(libqmatrixclient_SRCS
    jobs/roommessagesjob.cpp
    jobs/syncjob.cpp
    jobs/mediathumbnailjob.cpp
+   jobs/logoutjob.cpp
     )
 # Add bundled KCoreAddons sources if we haven't found the system sources
 # or if we ignore them
diff --git a/connection.cpp b/connection.cpp
index 8d916280..9664521c 100644
--- a/connection.cpp
+++ b/connection.cpp
@@ -23,6 +23,7 @@
 #include "events/event.h"
 #include "room.h"
 #include "jobs/passwordlogin.h"
+#include "jobs/logoutjob.h"
 #include "jobs/geteventsjob.h"
 #include "jobs/postmessagejob.h"
 #include "jobs/postreceiptjob.h"
@@ -98,6 +99,13 @@ void Connection::reconnect()
     loginJob->start();
 }
 
+void Connection::logout()
+{
+    auto job = new LogoutJob(d->data);
+    connect( job, &LogoutJob::success, this, &Connection::loggedOut);
+    job->start();
+}
+
 SyncJob* Connection::sync(int timeout)
 {
     QString filter = "{\"room\": { \"timeline\": { \"limit\": 100 } } }";
diff --git a/connection.h b/connection.h
index 452db198..f3a15cba 100644
--- a/connection.h
+++ b/connection.h
@@ -48,6 +48,8 @@ namespace QMatrixClient
             Q_INVOKABLE virtual void connectToServer( QString user, QString password );
             Q_INVOKABLE virtual void connectWithToken( QString userId, QString token );
             Q_INVOKABLE virtual void reconnect();
+            Q_INVOKABLE virtual void logout();
+
             Q_INVOKABLE virtual SyncJob* sync(int timeout=-1);
             Q_INVOKABLE virtual void postMessage( Room* room, QString type, QString message );
             Q_INVOKABLE virtual PostReceiptJob* postReceipt( Room* room, Event* event );
@@ -63,9 +65,11 @@ namespace QMatrixClient
             Q_INVOKABLE virtual QString token();
 
         signals:
+            void resolved();
             void connected();
             void reconnected();
-            void resolved();
+            void loggedOut();
+
             void syncDone();
             void newRoom(Room* room);
             void joinedRoom(Room* room);
diff --git a/jobs/logoutjob.cpp b/jobs/logoutjob.cpp
new file mode 100644
index 00000000..88767e4c
--- /dev/null
+++ b/jobs/logoutjob.cpp
@@ -0,0 +1,35 @@
+/******************************************************************************
+ * Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#include "logoutjob.h"
+
+using namespace QMatrixClient;
+
+LogoutJob::LogoutJob(ConnectionData* connection)
+    : BaseJob(connection, JobHttpType::PostJob, "LogoutJob")
+{
+}
+
+LogoutJob::~LogoutJob()
+{
+}
+
+QString LogoutJob::apiPath() const
+{
+    return "/_matrix/client/r0/logout";
+}
diff --git a/jobs/logoutjob.h b/jobs/logoutjob.h
new file mode 100644
index 00000000..faa1e2cb
--- /dev/null
+++ b/jobs/logoutjob.h
@@ -0,0 +1,34 @@
+/******************************************************************************
+ * Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#pragma once
+
+#include "basejob.h"
+
+namespace QMatrixClient
+{
+    class LogoutJob: public BaseJob
+    {
+        public:
+            LogoutJob(ConnectionData* connection);
+            virtual ~LogoutJob();
+
+        protected:
+            QString apiPath() const override;
+    };
+}
-- 
cgit v1.2.3