GitHubApiHelper.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/InternetHelper.h"
 
namespace Mantid {
namespace Kernel {
 
namespace  {
 const static std::string DEFAULT_GITHUB_TOKEN("unsetunsetunsetunsetunsetunsetunsetunset");
}
 
class MANTID_KERNEL_DLL GitHubApiHelper : public InternetHelper {
public:
  GitHubApiHelper();
  GitHubApiHelper(const Kernel::ProxyInfo &proxy);
  virtual ~GitHubApiHelper() = default;
 
  void reset() override;
  bool isAuthenticated();
  std::string getRateLimitDescription();
 
protected:
  virtual void processResponseHeaders(const Poco::Net::HTTPResponse &res) override;
  virtual InternetHelper::HTTPStatus sendRequestAndProcess(Poco::Net::HTTPClientSession &session,
    Poco::URI &uri, std::ostream &responseStream) override;
private:
  InternetHelper::HTTPStatus processAnonymousRequest(Poco::URI &uri, std::ostream &responseStream);
  void addAuthenticationToken();
  std::string m_api_token;
};
 
} // namespace Kernel
} // namespace Mantid