From 616925ebbb8e916119f8dbee0c1f0cb97b14a68b Mon Sep 17 00:00:00 2001
From: isanae <14251494+isanae@users.noreply.github.com>
Date: Fri, 14 Jun 2019 01:38:07 -0400
Subject: moved api user account classes to their own files api label in status
 bar:  - now shows when not logged in  - changed some of the colour thresholds
 to correspond to real throttling numbers make sure the api key is also
 cleared from the access manager when clearing from the settings removed
 unused bool m_ValidateAttempted in NXMAccessManager update the window title
 and status bar api label with correct values on startup, which fixes
 incorrect values when "restarting" MO after changing nexus settings

---
 src/apiuseraccount.h | 129 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 129 insertions(+)
 create mode 100644 src/apiuseraccount.h

(limited to 'src/apiuseraccount.h')

diff --git a/src/apiuseraccount.h b/src/apiuseraccount.h
new file mode 100644
index 00000000..8a238d71
--- /dev/null
+++ b/src/apiuseraccount.h
@@ -0,0 +1,129 @@
+#ifndef APIUSERACCOUNT_H
+#define APIUSERACCOUNT_H
+
+#include <QString>
+
+/**
+* represents user account types on a mod provider website such as nexus
+*/
+enum class APIUserAccountTypes
+{
+  // not logged in
+  None = 0,
+
+  // regular account
+  Regular,
+
+  // premium account
+  Premium
+};
+
+
+/**
+* current limits imposed on the user account
+**/
+struct APILimits
+{
+  // maximum number of requests per day
+  int maxDailyRequests = 0;
+
+  // remaining number of requests today
+  int remainingDailyRequests = 0;
+
+  // maximum number of requests per hour
+  int maxHourlyRequests = 0;
+
+  // remaining number of requests this hour
+  int remainingHourlyRequests = 0;
+};
+
+
+/**
+* API statistics
+*/
+struct APIStats
+{
+  // number of API requests currently queued
+  int requestsQueued = 0;
+};
+
+
+/**
+* represents a user account on the mod provier website
+*/
+class APIUserAccount
+{
+public:
+  // when the number of remanining requests is under this number, further
+  // requests will be throttled by avoiding non-critical ones
+  static const int ThrottleThreshold = 200;
+
+  APIUserAccount();
+
+  /**
+  * user id
+  */
+  const QString& id() const;
+
+  /**
+  * user name
+  */
+  const QString& name() const;
+
+  /**
+  * account type
+  */
+  APIUserAccountTypes type() const;
+
+  /**
+  * current API limits
+  */
+  const APILimits& limits() const;
+
+
+  /**
+  * sets the user id
+  */
+  APIUserAccount& id(const QString& id);
+
+  /**
+  * sets the user name
+  **/
+  APIUserAccount& name(const QString& name);
+
+  /**
+  * sets the acount type
+  */
+  APIUserAccount& type(APIUserAccountTypes type);
+
+  /**
+  * sets the current limits
+  */
+  APIUserAccount& limits(const APILimits& limits);
+
+
+  /**
+  * returns the number of remaining requests
+  */
+  int remainingRequests() const;
+
+  /**
+  * whether the number of remaining requests is low enough that further
+  * requests should be throttled
+  */
+  bool shouldThrottle() const;
+
+  /**
+  * true if all the remaining requests have been used and the API will refuse
+  * further requests
+  */
+  bool exhausted() const;
+
+private:
+  QString m_id, m_name;
+  APIUserAccountTypes m_type;
+  APILimits m_limits;
+  APIStats m_stats;
+};
+
+#endif // APIUSERACCOUNT_H
-- 
cgit v1.3.1