feat: rename voter to vote

Author: null8626

README.md

@@ -323,31 +323,31 @@ try {
 }
 ```
 
-### Getting your bot's voters
+### Getting your bot's votes
 
 #### With C++17 callbacks
 
 ```cpp
 // First page
-client.get_voters([](const auto& result) {
+client.get_votes([](const auto& result) {
   try {
-    auto voters = result.get();
+    auto votes = result.get();
 
-    for (auto& voter: voters) {
-      std::cout << voter.username << std::endl;
+    for (auto& vote: votes) {
+      std::cout << vote.username << std::endl;
     }
   } catch (const std::exception& exc) {
     std::cerr << "error: " << exc.what() << std::endl;
   }
 });
 
 // Subsequent pages
-client.get_voters(2, [](const auto& result) {
+client.get_votes(2, [](const auto& result) {
   try {
-    auto voters = result.get();
+    auto votes = result.get();
 
-    for (auto& voter: voters) {
-      std::cout << voter.username << std::endl;
+    for (auto& vote: votes) {
+      std::cout << vote.username << std::endl;
     }
   } catch (const std::exception& exc) {
     std::cerr << "error: " << exc.what() << std::endl;
@@ -360,21 +360,21 @@ client.get_voters(2, [](const auto& result) {
 ```cpp
 // First page
 try {
-  const auto voters = co_await client.co_get_voters();
+  const auto votes = co_await client.co_get_votes();
 
-  for (const auto& voter: voters) {
-    std::cout << voter.username << std::endl;
+  for (const auto& vote: votes) {
+    std::cout << vote.username << std::endl;
   }
 } catch (const std::exception& exc) {
   std::cerr << "error: " << exc.what() << std::endl;
 }
 
 // Subsequent pages
 try {
-  const auto voters = co_await client.co_get_voters(2);
+  const auto votes = co_await client.co_get_votes(2);
 
-  for (const auto& voter: voters) {
-    std::cout << voter.username << std::endl;
+  for (const auto& vote: votes) {
+    std::cout << vote.username << std::endl;
   }
 } catch (const std::exception& exc) {
   std::cerr << "error: " << exc.what() << std::endl;

include/topgg/client.h

@@ -35,12 +35,12 @@ namespace topgg {
   using get_server_count_completion_event = std::function<void(const result<std::optional<size_t>>&)>;
 
   /**
-   * @brief The callback function to call when get_voters completes.
+   * @brief The callback function to call when get_votes completes.
    *
-   * @see topgg::client::get_voters
+   * @see topgg::client::get_votes
    * @since 2.0.0
    */
-  using get_voters_completion_event = std::function<void(const result<std::vector<voter>>&)>;
+  using get_votes_completion_event = std::function<void(const result<std::vector<vote>>&)>;
 
   /**
    * @brief The callback function to call when has_voted completes.
@@ -326,73 +326,73 @@ namespace topgg {
 #endif
 
     /**
-     * @brief Fetches your Discord bot's recent 100 unique voters.
+     * @brief Fetches your Discord bot's recent 100 unique votes.
      *
      * Example:
      *
      * ```cpp
      * dpp::cluster bot{"your bot token"};
      * topgg::client client{bot, "your top.gg token"};
      *
-     * client.get_voters(1, [](const auto& result) {
+     * client.get_votes(1, [](const auto& result) {
      *   try {
-     *     auto voters = result.get();
+     *     auto votes = result.get();
      *
-     *     for (auto& voter: voters) {
-     *       std::cout << voter.username << std::endl;
+     *     for (auto& vote: votes) {
+     *       std::cout << vote.username << std::endl;
      *     }
      *   } catch (const std::exception& exc) {
      *     std::cerr << "error: " << exc.what() << std::endl;
      *   }
      * });
      * ```
      *
-     * @param page The page number. Each page can only have at most 100 voters.
-     * @param callback The callback function to call when get_voters completes.
-     * @note For its C++20 coroutine counterpart, see co_get_voters.
+     * @param page The page number. Each page can only have at most 100 votes.
+     * @param callback The callback function to call when get_votes completes.
+     * @note For its C++20 coroutine counterpart, see co_get_votes.
      * @see topgg::result
-     * @see topgg::voter
+     * @see topgg::vote
      * @see topgg::client::start_autoposter
-     * @see topgg::client::co_get_voters
+     * @see topgg::client::co_get_votes
      * @since 2.0.0
      */
-    void get_voters(size_t page, const get_voters_completion_event& callback);
+    void get_votes(size_t page, const get_votes_completion_event& callback);
 
     /**
-     * @brief Fetches your Discord bot's recent 100 unique voters.
+     * @brief Fetches your Discord bot's recent 100 unique votes.
      *
      * Example:
      *
      * ```cpp
      * dpp::cluster bot{"your bot token"};
      * topgg::client client{bot, "your top.gg token"};
      *
-     * client.get_voters([](const auto& result) {
+     * client.get_votes([](const auto& result) {
      *   try {
-     *     auto voters = result.get();
+     *     auto votes = result.get();
      *
-     *     for (auto& voter: voters) {
-     *       std::cout << voter.username << std::endl;
+     *     for (auto& vote: votes) {
+     *       std::cout << vote.username << std::endl;
      *     }
      *   } catch (const std::exception& exc) {
      *     std::cerr << "error: " << exc.what() << std::endl;
      *   }
      * });
      * ```
      *
-     * @param callback The callback function to call when get_voters completes.
-     * @note For its C++20 coroutine counterpart, see co_get_voters.
+     * @param callback The callback function to call when get_votes completes.
+     * @note For its C++20 coroutine counterpart, see co_get_votes.
      * @see topgg::result
-     * @see topgg::voter
+     * @see topgg::vote
      * @see topgg::client::start_autoposter
-     * @see topgg::client::co_get_voters
+     * @see topgg::client::co_get_votes
      * @since 2.0.0
      */
-    void get_voters(const get_voters_completion_event& callback);
+    void get_votes(const get_votes_completion_event& callback);
 
 #ifdef DPP_CORO
     /**
-     * @brief Fetches your Discord bot's recent 100 unique voters through a C++20 coroutine.
+     * @brief Fetches your Discord bot's recent 100 unique votes through a C++20 coroutine.
      *
      * Example:
      *
@@ -401,30 +401,30 @@ namespace topgg {
      * topgg::client client{bot, "your top.gg token"};
      *
      * try {
-     *   const auto voters = co_await client.co_get_voters();
+     *   const auto votes = co_await client.co_get_votes();
      *
-     *   for (const auto& voter: voters) {
-     *     std::cout << voter.username << std::endl;
+     *   for (const auto& vote: votes) {
+     *     std::cout << vote.username << std::endl;
      *   }
      * } catch (const std::exception& exc) {
      *   std::cerr << "error: " << exc.what() << std::endl;
      * }
      * ```
      *
-     * @param page The page number. Each page can only have at most 100 voters. Defaults to 1.
+     * @param page The page number. Each page can only have at most 100 votes. Defaults to 1.
      * @throw topgg::internal_server_error Unexpected error from Top.gg's end.
      * @throw topgg::invalid_token Invalid API token.
      * @throw topgg::ratelimited Ratelimited from sending more requests.
      * @throw dpp::http_error An unexpected HTTP exception has occured.
-     * @return co_await to retrieve a vector of topgg::voter if successful
-     * @note For its C++17 callback-based counterpart, see get_voters.
+     * @return co_await to retrieve a vector of topgg::vote if successful
+     * @note For its C++17 callback-based counterpart, see get_votes.
      * @see topgg::async_result
-     * @see topgg::voter
+     * @see topgg::vote
      * @see topgg::client::start_autoposter
-     * @see topgg::client::get_voters
+     * @see topgg::client::get_votes
      * @since 2.0.0
      */
-    topgg::async_result<std::vector<voter>> co_get_voters(size_t page = 1);
+    topgg::async_result<std::vector<vote>> co_get_votes(size_t page = 1);
 #endif
 
     /**

include/topgg/models.h

@@ -47,17 +47,17 @@ namespace topgg {
   class client;
 
   /**
-   * @brief A Top.gg voter.
+   * @brief A Top.gg vote.
    *
-   * @see topgg::client::get_voters
+   * @see topgg::client::get_votes
    * @see topgg::client::start_autoposter
    * @since 2.0.0
    */
-  class TOPGG_EXPORT voter {
-    voter(const dpp::json& j);
+  class TOPGG_EXPORT vote {
+    vote(const dpp::json& j);
 
   public:
-    voter() = delete;
+    vote() = delete;
 
     /**
      * @brief This voter's Discord ID.

src/client.cpp

@@ -167,29 +167,29 @@ topgg::async_result<std::optional<size_t>> client::co_get_server_count() {
 }
 #endif
 
-void client::get_voters(size_t page, const topgg::get_voters_completion_event& callback) {
+void client::get_votes(size_t page, const topgg::get_votes_completion_event& callback) {
   if (page < 1) {
     page = 1;
   }
 
-  basic_request<std::vector<topgg::voter>>("/bots/" + m_id + "/votes?page=" + std::to_string(page), callback, [](const auto& j) {
-    std::vector<topgg::voter> voters{};
+  basic_request<std::vector<topgg::vote>>("/bots/" + m_id + "/votes?page=" + std::to_string(page), callback, [](const auto& j) {
+    std::vector<topgg::vote> votes{};
 
     for (const auto& part: j) {
-      voters.push_back(topgg::voter{part});
+      votes.push_back(topgg::vote{part});
     }
 
-    return voters;
+    return votes;
   });
 }
 
-void client::get_voters(const topgg::get_voters_completion_event& callback) {
-  get_voters(1, callback);
+void client::get_votes(const topgg::get_votes_completion_event& callback) {
+  get_votes(1, callback);
 }
 
 #ifdef DPP_CORO
-topgg::async_result<std::vector<topgg::voter>> client::co_get_voters(size_t page) {
-  return topgg::async_result<std::vector<topgg::voter>>{[this, page]<typename C>(C&& cc) { return get_voters(page, std::forward<C>(cc)); }};
+topgg::async_result<std::vector<topgg::vote>> client::co_get_votes(size_t page) {
+  return topgg::async_result<std::vector<topgg::vote>>{[this, page]<typename C>(C&& cc) { return get_votes(page, std::forward<C>(cc)); }};
 }
 #endif
 

src/models.cpp

@@ -72,7 +72,7 @@ static void strptime(const char* s, const char* f, tm* t) {
 
 using topgg::bot;
 using topgg::bot_query;
-using topgg::voter;
+using topgg::vote;
 
 static time_t timestamp_from_id(const dpp::snowflake& id) {
   return static_cast<time_t>(((id >> 22) / 1000) + 1420070400);
@@ -185,7 +185,7 @@ dpp::async<std::vector<topgg::bot>> bot_query::co_send() {
 }
 #endif
 
-voter::voter(const dpp::json& j) {
+vote::vote(const dpp::json& j) {
   id = _TOPGG_SNOWFLAKE_FROM_JSON(j, id);
 
   _TOPGG_DESERIALIZE(j, username, std::string);

tests/test_api.cpp

@@ -88,9 +88,9 @@ int main() {
   client.get_server_count(TEST_RESULT_CALLBACK());
 
   ACQUIRE_TEST_THREAD();
-  std::cout << "get_voters ";
+  std::cout << "get_votes ";
 
-  client.get_voters(TEST_RESULT_CALLBACK());
+  client.get_votes(TEST_RESULT_CALLBACK());
 
   ACQUIRE_TEST_THREAD();
   std::cout << "is_weekend ";