Merge lp:~mikemc/ubuntuone-credentials/add-examplecode into lp:ubuntuone-credentials

[Mike McCracken]

- Add minimal Qt/C++ example app and README describing how to use libubuntuoneauth to access creds and sign API requests.

- Add minimal Qt/C++ example app and README describing how to use libubuntuoneauth to access creds and sign API requests.

[Roberto Alsina (ralsina)]

It looks clean and understandable to me

review: Approve

[Alejandro J. Cura (alecu)]

+1

review: Approve

=== modified file 'libubuntuoneauth/CMakeLists.txt'
--- libubuntuoneauth/CMakeLists.txt	2013-08-20 15:58:32 +0000
+++ libubuntuoneauth/CMakeLists.txt	2013-09-02 23:59:34 +0000
@@ -49,3 +49,4 @@
 )
 
 add_subdirectory(tests)
+add_subdirectory(examples)
\ No newline at end of file

=== added directory 'libubuntuoneauth/examples'
=== added file 'libubuntuoneauth/examples/CMakeLists.txt'
--- libubuntuoneauth/examples/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ libubuntuoneauth/examples/CMakeLists.txt	2013-09-02 23:59:34 +0000
@@ -0,0 +1,31 @@
+SET (EXAMPLES_TARGET ubuntuoneauth-examples)
+
+SET (SIGNING_EXE "signing-example")
+
+# Qt5 bits
+SET (CMAKE_INCLUDE_CURRENT_DIR ON)
+SET (CMAKE_AUTOMOC ON)
+find_package(Qt5Core REQUIRED)
+
+FILE (GLOB SIGNING_SOURCES signing*.cpp)
+FILE (GLOB SIGNING_HEADERS signing*.h)
+
+add_executable (${SIGNING_EXE}
+  ${SIGNING_SOURCES}
+  ${SIGNING_HEADERS})
+qt5_use_modules (${SIGNING_EXE} DBus Network)
+
+target_link_libraries (${SIGNING_EXE}
+  -Wl,-rpath,${CMAKE_BINARY_DIR}/libubuntuoneauth
+  -L${CMAKE_BINARY_DIR}/libubuntuoneauth
+  ${AUTH_LIB_NAME})
+
+add_custom_target(examples-valgrind
+    COMMAND "valgrind --tool=memcheck ${CMAKE_CURRENT_BINARY_DIR}/${SIGNING_EXE}"
+    DEPENDS ${SIGNING_EXE}
+)
+
+add_custom_target(examples-valgrind-leaks
+    COMMAND "valgrind --tool=memcheck --track-origins=yes --num-callers=40 --leak-resolution=high --leak-check=full ${CMAKE_CURRENT_BINARY_DIR}/${SIGNING_EXE}"
+    DEPENDS ${SIGNING_EXE}
+)

=== added file 'libubuntuoneauth/examples/README'
--- libubuntuoneauth/examples/README	1970-01-01 00:00:00 +0000
+++ libubuntuoneauth/examples/README	2013-09-02 23:59:34 +0000
@@ -0,0 +1,26 @@
+libubuntuoneauth/examples
+
+This directory contains example code for accessing a user's ubuntuone
+credentials and signing URLs using them in Qt/C++ code.
+
+The basic flow is to use an SSOService object to get the credentials,
+by calling getCredentials. It will respond with either
+credentialsNotFound or credentialsFound. The credentialsFound signal
+has a Token object that has a signURL method that takes a URL and HTTP
+scheme, and returns a properly signed OAuth header string. This string
+can then be used with the usual Qt network stack.
+
+The file signing-main.cpp has a minimal Qt application that attempts
+to get credentials from the online accounts DB and use them to sign a
+request for account info from the one.ubuntu.com account API.
+
+Run it with U1_DEBUG=1 in the environment to see the output.
+
+If you have valid credentials, it will print a bunch of progress info
+followed by a JSON dict with some
+account info.
+
+If you don't have valid credentials, it will simply mention that.
+
+To get valid credentials for testing, use the ubuntuone-music-login
+app from the music-login directory at the top level of this project.

=== added file 'libubuntuoneauth/examples/signing-main.cpp'
--- libubuntuoneauth/examples/signing-main.cpp	1970-01-01 00:00:00 +0000
+++ libubuntuoneauth/examples/signing-main.cpp	2013-09-02 23:59:34 +0000
@@ -0,0 +1,121 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#include <QCoreApplication>
+#include <QDebug>
+#include <QObject>
+#include <QString>
+#include <QTimer> 
+
+#include "ssoservice.h"
+#include "token.h"
+
+#include "signing.h"
+
+namespace UbuntuOne {
+
+    SigningExample::SigningExample(QObject *parent) :
+        QObject(parent)
+    {
+        QObject::connect(&service, SIGNAL(credentialsFound(const Token&)),
+                         this, SLOT(handleCredentialsFound(Token)));
+        QObject::connect(&service, SIGNAL(credentialsNotFound()),
+                         this, SLOT(handleCredentialsNotFound()));
+        QObject::connect(&nam, SIGNAL(finished(QNetworkReply*)),
+                         this, SLOT(handleNetworkFinished(QNetworkReply*)));
+
+    }
+
+    SigningExample::~SigningExample(){
+    }
+
+    void SigningExample::doExample()
+    {
+        service.getCredentials();
+    }
+
+    void SigningExample::handleCredentialsFound(Token token)
+    {
+        qDebug() << "Credentials found, signing url.";
+
+        QString url = "https://one.ubuntu.com/api/account/";
+        QString authHeader = token.signUrl(url, QStringLiteral("GET"));
+
+        qDebug() << "URL Signed, authHeader is:" << authHeader;
+
+        QNetworkRequest req;
+        req.setRawHeader(QStringLiteral("Authorization").toUtf8(),
+                          authHeader.toUtf8());
+        req.setUrl(url);
+        nam.get(req);
+    }
+ 
+    void SigningExample::handleCredentialsNotFound()
+    {
+        qDebug() << "No credentials were found.";
+    }
+
+    void SigningExample::handleNetworkFinished(QNetworkReply *reply)
+    {
+        QVariant statusAttr = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute);
+        if(!statusAttr.isValid()) {
+            qDebug() << "Invalid HTTP response.";
+            return;
+        }
+
+        int status = statusAttr.toInt();
+        qDebug() << "HTTP Status " << status;
+
+        if (status != 200){
+            qDebug() << reply->rawHeaderPairs();
+        }
+
+        qDebug() << reply->readAll();
+        
+        emit finished();
+    }
+
+} // namespace UbuntuOne
+
+
+int main(int argc, char *argv[])
+{
+
+    QCoreApplication a(argc, argv);
+    
+    UbuntuOne::SigningExample *example = new UbuntuOne::SigningExample(&a);
+
+    QObject::connect(example, SIGNAL(finished()), &a, SLOT(quit()));
+
+    QTimer::singleShot(0, example, SLOT(doExample()));
+
+    return a.exec();
+}
+
+

=== added file 'libubuntuoneauth/examples/signing.h'
--- libubuntuoneauth/examples/signing.h	1970-01-01 00:00:00 +0000
+++ libubuntuoneauth/examples/signing.h	2013-09-02 23:59:34 +0000
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#ifndef _SIGNING_H_
+#define _SIGNING_H_
+
+#include <QDebug>
+#include <QNetworkReply>
+#include <QObject>
+#include <QString>
+
+#include "ssoservice.h"
+#include "token.h"
+#include "requests.h"
+#include "errormessages.h"
+
+namespace UbuntuOne {
+
+class SigningExample : public QObject
+{
+    Q_OBJECT
+
+public:
+
+    explicit SigningExample(QObject *parent = 0);
+    ~SigningExample();
+
+public slots:
+
+    void doExample();
+
+signals:
+
+    void finished();
+
+private slots:
+
+    void handleCredentialsFound(Token token);
+    void handleCredentialsNotFound();
+    void handleNetworkFinished(QNetworkReply *reply);
+
+private:
+
+    SSOService service;
+    QNetworkAccessManager nam;
+
+};
+
+}
+#endif /* _SIGNING_H_ */