mastodonpp/include/connection.hpp

194 lines
4.9 KiB
C++
Raw Normal View History

2020-01-03 12:42:10 +01:00
/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_CONNECTION_HPP
#define MASTODONPP_CONNECTION_HPP
2020-01-03 12:42:10 +01:00
#include "answer.hpp"
#include "api.hpp"
#include "curl_wrapper.hpp"
2020-01-03 12:42:10 +01:00
#include "instance.hpp"
#include <string>
2020-01-05 10:35:38 +01:00
#include <string_view>
2020-01-08 12:56:16 +01:00
#include <variant>
#include <vector>
2020-01-03 12:42:10 +01:00
namespace mastodonpp
{
using std::string;
2020-01-05 10:35:38 +01:00
using std::string_view;
2020-01-08 12:56:16 +01:00
using std::variant;
using std::vector;
2020-01-08 12:56:16 +01:00
/*!
* @brief An endpoint. Either API::endpoint_type or `std::string_view`.
*
* @since 0.1.0
*/
using endpoint_variant = variant<API::endpoint_type,string_view>;
/*!
* @brief A stream event.
*
* @since 0.1.0
*
* @headerfile connection.hpp mastodonpp/connection.hpp
*/
struct event_type
{
/*!
* @brief The type of the event.
*
* Can be: update, notification, delete or filters_changed. For
* more information consult [the Mastodon documentation]
* (https://docs.joinmastodon.org/methods/timelines/streaming/
* #event-types-a-idevent-typesa).
*/
string type;
//! The payload.
string data;
};
2020-01-03 13:05:00 +01:00
/*!
* @brief Represents a connection to an instance. Used for requests.
2020-01-03 13:05:00 +01:00
*
* @since 0.1.0
2020-01-04 12:04:47 +01:00
*
* @headerfile connection.hpp mastodonpp/connection.hpp
2020-01-03 13:05:00 +01:00
*/
class Connection : public CURLWrapper
2020-01-03 12:42:10 +01:00
{
public:
2020-01-03 13:05:00 +01:00
/*!
* @brief Construct a new Connection object.
2020-01-03 13:05:00 +01:00
*
* @param instance An Instance with the access data.
*
* @since 0.1.0
*/
explicit Connection(Instance &instance);
2020-01-03 12:42:10 +01:00
/*!
2020-01-08 12:56:16 +01:00
* @brief Make a HTTP GET call with parameters.
*
* Example:
* @code
* auto answer{connection.get(mastodonpp::API::v1::accounts_id_followers,
* {
* {"id", "12"},
* {"limit", "10"}
* })};
* @endcode
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
2020-01-08 12:56:16 +01:00
* @param parameters A map of parameters.
*
*
* @since 0.1.0
*/
2020-01-04 13:31:22 +01:00
[[nodiscard]]
2020-01-08 12:56:16 +01:00
answer_type get(const endpoint_variant &endpoint,
const parametermap &parameters);
/*!
* @brief Make a HTTP GET call.
2020-01-08 17:20:44 +01:00
*
2020-01-08 12:56:16 +01:00
* Example:
* @code
* auto answer{connection.get("/api/v1/instance")};
* @endcode
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
*
* @since 0.1.0
*/
[[nodiscard]]
2020-01-08 12:56:16 +01:00
inline answer_type get(const endpoint_variant &endpoint)
{
return get(endpoint, {});
}
2020-01-10 13:08:55 +01:00
/*!
* @brief Make a HTTP POST call with parameters.
*
* Example:
* @code
* auto answer{connection.post(
* mastodonpp::API::v1::statuses,
* {
* {"status", "How is the wheather?"},
* {"poll[options]", vector<string_view>{"Nice", "not nice"}},
* {"poll[expires_in]", to_string(poll_seconds)}
* })};
* @endcode
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
* @param parameters A map of parameters.
*
*
* @since 0.1.0
*/
[[nodiscard]]
answer_type post(const endpoint_variant &endpoint,
const parametermap &parameters);
/*!
* @brief Make a HTTP POST call.
*
* @param endpoint Endpoint as API::endpoint_type or `std::string_view`.
*
* @since 0.1.0
*/
[[nodiscard]]
inline answer_type post(const endpoint_variant &endpoint)
{
return post(endpoint, {});
}
2020-01-08 21:27:27 +01:00
/*!
* @brief Copy new stream contents and delete the original.
*
* Note that the last event is not necessarily complete, it could happen
* that you are calling this function mid-transfer. You have to check the
* data integrity yourself.
2020-01-08 21:27:27 +01:00
*
* Using get_new_events() instead is recommended.
*
2020-01-08 21:27:27 +01:00
* @since 0.1.0
*/
string get_new_stream_contents();
/*!
* @brief Get new stream events.
*
* @since 0.1.0
*/
vector<event_type> get_new_events();
2020-01-03 12:42:10 +01:00
private:
Instance &_instance;
2020-01-05 10:35:38 +01:00
const string_view _baseuri;
2020-01-10 13:08:55 +01:00
string endpoint_to_uri(const endpoint_variant &endpoint) const;
2020-01-03 12:42:10 +01:00
};
} // namespace mastodonpp
#endif // MASTODONPP_CONNECTION_HPP