Added channel:get_messages() endpoint

Author: zeroxs

.gitattributes

@@ -0,0 +1,10 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.c text
+*.h text
+
+# Declare files that will always have CRLF line endings on checkout.
+*.sln text eol=crlf

include/aegis/channel.hpp

@@ -64,6 +64,23 @@ struct edit_message_t
     json _embed;
 };
 
+struct get_messages_t
+{
+    enum class get_messages_type {
+        AROUND,
+        BEFORE,
+        AFTER
+    };
+    get_messages_t & message_id(snowflake param) { _message_id = param; return *this; }
+    get_messages_t & around() { _type = get_messages_type::AROUND; return *this; }
+    get_messages_t & before() { _type = get_messages_type::BEFORE; return *this; }
+    get_messages_t & after() { _type = get_messages_type::AFTER; return *this; }
+    get_messages_t & limit(int16_t param) { _limit = param; return *this; }
+    get_messages_type _type = get_messages_type::AFTER;
+    snowflake _message_id;
+    int16_t _limit;
+};
+
 struct modify_channel_t
 {
     modify_channel_t & name(const std::string & param) { _name = param; return *this; }
@@ -241,6 +258,15 @@ class channel
      */
     AEGIS_DECL aegis::future<gateway::objects::message> get_message(snowflake message_id);
 
+    /// Get multiple messages from this channel
+    /**
+     * @see aegis::get_messages_t
+     * @param obj Struct of the request
+     * @returns aegis::future<gateway::objects::messages>
+     */
+    AEGIS_DECL aegis::future<gateway::objects::messages> get_messages(get_messages_t obj);
+
+
     /// Edit a message in this channel
     /**
      * @param message_id Snowflake of the message to replace. Must be your own message

include/aegis/fwd.hpp

@@ -41,6 +41,7 @@ namespace objects
 {
 struct user;
 class message;
+class messages;
 struct channel;
 struct guild;
 struct emoji;

include/aegis/gateway/objects/messages.hpp

@@ -0,0 +1,147 @@
+//
+// messages.hpp
+// ************
+//
+// Copyright (c) 2020 Sharon Fox (sharon at xandium dot io)
+//
+// Distributed under the MIT License. (See accompanying file LICENSE)
+//
+
+#pragma once
+
+#include "aegis/config.hpp"
+#include "aegis/shards/shard.hpp"
+#include "aegis/rest/rest_reply.hpp"
+#include "aegis/gateway/objects/message.hpp"
+#include <nlohmann/json.hpp>
+
+namespace aegis
+{
+
+namespace gateway
+{
+
+namespace objects
+{
+
+class message;
+
+/// \cond TEMPLATES
+inline void from_json(const nlohmann::json& j, objects::messages& m);
+
+inline void to_json(nlohmann::json& j, const objects::messages& m);
+/// \endcond
+
+/**\todo Needs documentation
+ */
+class messages
+{
+public:
+
+    /// Constructor for the messages array
+    /**
+     * @param _core Pointer of core object
+     */
+    messages(aegis::core * _core) noexcept
+        : _core(_core)
+    {
+    }
+
+    /// Constructor for the message object
+    /**
+     * @param _json JSON string of the message object
+     * @param bot Pointer of core object
+     */
+    messages(const std::string& _json, aegis::core* _core) noexcept
+        : _core(_core)
+    {
+        from_json(nlohmann::json::parse(_json), *this);
+    }
+
+    /// Constructor for the messages object
+    /**
+     * @param _json JSON object of the messages array
+     * @param _core Pointer of core object
+     */
+    messages(const nlohmann::json & _json, aegis::core * _core) noexcept
+        : _core(_core)
+    {
+        from_json(_json, *this);
+    }
+
+    /// Set the guild of the message object. This is mostly an internal function
+    /// though is left public for lower level use
+    /**
+     * @param _guild Pointer of the guild to assign the message to
+     */
+    AEGIS_DECL void set_guild(aegis::guild * _guild)
+    {
+        this->_guild = _guild;
+    }
+
+    messages() = default;
+    messages& operator=(const messages&) = default;
+    messages(const messages&) = default;
+    messages(messages&& msg) = default;
+
+    std::vector<aegis::gateway::objects::message>::iterator begin()
+    {
+        return _messages.begin();
+    }
+
+    std::vector<aegis::gateway::objects::message>::iterator end()
+    {
+        return _messages.end();
+    }
+
+    std::vector<aegis::gateway::objects::message>::reverse_iterator rbegin()
+    {
+        return _messages.rbegin();
+    }
+
+    std::vector<aegis::gateway::objects::message>::reverse_iterator rend()
+    {
+        return _messages.rend();
+    }
+
+    std::vector<aegis::gateway::objects::message> _messages; /**< array of messages */
+
+private:
+    friend inline void from_json(const nlohmann::json& j, objects::messages& m);
+    friend inline void to_json(nlohmann::json& j, const objects::messages& m);
+    friend class aegis::core;
+
+    std::string _content;/**< String of the message contents */
+    aegis::channel * _channel = nullptr;/**< Pointer to the channel this message belongs to */
+    aegis::guild * _guild = nullptr;/**< Pointer to the guild this message belongs to */
+#if !defined(AEGIS_DISABLE_ALL_CACHE)
+    aegis::user * _user = nullptr;/**< Pointer to the author of this message */
+#endif
+    aegis::core * _core = nullptr;
+    snowflake _message_id = 0; /**< snowflake of the message */
+    snowflake _channel_id = 0; /**< snowflake of the channel this message belongs to */
+    snowflake _guild_id = 0; /**< snowflake of the guild this message belongs to */
+    snowflake _author_id = 0; /**< snowflake of the author of this message */
+};
+
+/// \cond TEMPLATES
+inline void from_json(const nlohmann::json& j, objects::messages& m)
+{
+    if (j.size())
+        for (const auto& _message : j)
+            m._messages.push_back(_message);
+}
+
+inline void to_json(nlohmann::json& j, const objects::messages& m)
+{
+    if (!m._messages.empty())
+        for (const auto& _message : m._messages)
+            j.push_back(_message);
+}
+/// \endcond
+
+}
+
+}
+
+}

include/aegis/impl/channel.cpp

@@ -18,6 +18,7 @@
 #include "aegis/rest/rest_reply.hpp"
 #include "aegis/ratelimit/ratelimit.hpp"
 #include "aegis/gateway/objects/message.hpp"
+#include "aegis/gateway/objects/messages.hpp"
 
 namespace aegis
 {
@@ -177,6 +178,37 @@ AEGIS_DECL aegis::future<gateway::objects::message> channel::get_message(snowfla
     return _ratelimit.post_task<gateway::objects::message>({ _endpoint, rest::Get });
 }
 
+AEGIS_DECL aegis::future<gateway::objects::messages> channel::get_messages(get_messages_t obj)
+{
+#if !defined(AEGIS_DISABLE_ALL_CACHE)
+    if (_guild && !perms().can_read_history())
+        return aegis::make_exception_future<gateway::objects::messages>(error::no_permission);
+#endif
+
+    std::shared_lock<shared_mutex> l(_m);
+
+    std::string type_, query_params{ "?" }, limit;
+
+    if (obj._limit >= 1 && obj._limit <= 100)
+        limit = fmt::format("&limit={}", obj._limit);
+
+    switch (obj._type)
+    {
+        case get_messages_t::get_messages_type::AFTER:
+            query_params += fmt::format("after={}{}", obj._message_id, limit);
+            break;
+        case get_messages_t::get_messages_type::AROUND:
+            query_params += fmt::format("after={}{}", obj._message_id, limit);
+            break;
+        case get_messages_t::get_messages_type::BEFORE:
+            query_params += fmt::format("after={}{}", obj._message_id, limit);
+            break;
+    }
+
+    std::string _endpoint = fmt::format("/channels/{}/messages", channel_id);
+    return _ratelimit.post_task<gateway::objects::messages>({ _endpoint, rest::Get, {}, {}, {}, {}, query_params });
+}
+
 AEGIS_DECL aegis::future<aegis::gateway::objects::message> channel::create_message(create_message_t obj)
 {
     if (obj._file.has_value())