Client.h

#ifndef __HWS_CLIENT_H__
#define __HWS_CLIENT_H__

#include <QObject>
#include <QSettings>
#include <QSharedPointer>
#include <QUrl>
#include <QVariant>

#include "Session.h"
#include "RequestError.h"

namespace hws
{
    class Client : public QObject
    {
    Q_OBJECT

    public:
        // Most of our return results are returned as this consistent format.
        typedef QList<QVariantMap> QVariantMapList;

        // URL parameters must be converted to string values.
        // Note that this API will handle the URI encoding.
        typedef QHash<QString, QString> QStringHash;

        // Initialize a client with a specific HWS url.
        Client(QObject *parent, QUrl url);

        Client(QObject *parent);

        ~Client();

        const QUrl & url() const;

        void setUrl(const QUrl & url);

        bool hasSession() const;

        const Session & session() const;

        void setSession(const Session & session);

        const QString & hwsPrefixPath() const;

        void setHWSPrefixPath(const QString & path);

        const QString & settingsKey() const;

        const QSharedPointer<QSettings> settings() const;

        void setSettings(QSharedPointer<QSettings> settings);

        void addRequestConfig(QString key, QString value);

        void ignoreSslErrors(bool ignore);

    public slots:

        void validateSession();

        void logIn(const QString & user, const QString & password);


        void executeMethod(const QString & method, const QString & path,
                           const QSharedPointer<QStringHash> params = QSharedPointer<QStringHash>(),
                           const QSharedPointer<QByteArray> body = QSharedPointer<QByteArray>());

        void executeMethod(const QString & method, const QString & path,
                           const QSharedPointer<QStringHash> params,
                           const QVariantMap & body);

        void executeMethod(const QString & method, const QString & path,
                           const QSharedPointer<QStringHash> params,
                           const QVariantMapList & body);

    signals:

        void validateSessionDone(RequestErrorPtr error);

        void logInDone(RequestErrorPtr error, SessionPtr session);

        void executeMethodDone(RequestErrorPtr error,
                               const QString & method,
                               const QString & path,
                               const QSharedPointer<QVariantMapList> body);

        // Implementation is hidden using PIMPL technique.
        // I'm hiding the direct include dependencies on Qt5Network and
        // Qt5WebSockets.
    private:
        class Impl;

        class LogInFinished;
        class ExecuteMethodFinished;

        Impl *mImpl;

        // Disabled methods
    private:
        Client(const Client &);

        Client & operator=(const Client &);
    };

    typedef QSharedPointer<Client> ClientPtr;
}

#endif /* __HWS_CLIENT_H__ */