C++ wrapper for the Mastodon API.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
 
tastytea a86cd8eaa0
Added support for clang++ 5/6.
1 year ago
examples Added comment to example02. 1 year ago
src Added support for /api/v1/apps/verify_credentials. 1 year ago
tests Added tests for /api/v1/accounts/:id/unblock. 1 year ago
.drone.yml Added support for clang++ 5/6. 1 year ago
.gitignore Updated .gitignore, deleted build.sh. 1 year ago
CMakeLists.txt Put http_error_code in return_base. 1 year ago
CONTRIBUTING.md Updated fediverse address. 1 year ago
Doxyfile fixed doxygen recipe 2 years ago
ISSUE_TEMPLATE.md reduced issue template 2 years ago
LICENSE initial commit 2 years ago
README.md Added support for clang++ 5/6. 1 year ago
build_doc.sh Parameter support, added documentation. 2 years ago
packages.CMakeLists.txt Changed CMAKE_PROJECT_NAME to PROJECT_NAME. 1 year ago
tests.CMakeLists.txt Changed CMAKE_PROJECT_NAME to PROJECT_NAME. 1 year ago

README.md

mastodon-cpp is a C++ wrapper for the Mastodon API. You submit an API call and get the raw JSON or easy to use abstractions.

The ABI will be unstable in versions < 1.0.0

Usage

The HTML reference can be generated with build_doc.sh, if doxygen is installed. It is also available at doc.schlomp.space/mastodon-cpp/. There are examples in examples/.

Most basic example

#include <iostream>
#include <mastodon-cpp/mastodon-cpp.hpp>

int main()
{
    Mastodon::API masto("social.example.com", "auth_token");
    std::cout << masto.get(Mastodon::API::v1::accounts_verify_credentials);
    std::cout << std::endl;
}

Another simple example

Using the Easy interface.

#include <iostream>
#include <string>
#include <mastodon-cpp/mastodon-cpp.hpp>
#include <mastodon-cpp/easy/all.hpp>

using Mastodon;

int main()
{
    Easy::API masto("social.example", "");
    return_call ret = masto.get(API::v1::timelines_public);

    for (const std::string &str : Easy::json_array_to_vector(ret.answer))
    {
        Easy::Status status(str);
        std::cout << "  " << status.account().acct() << " wrote:\n";
        std::cout << status.content() << '\n';
    }
}

Compiling your project

A project consisting of one file can be compiled as follows:

g++ -std=c++14 -lmastodon-cpp example.cpp

List of types

Learn more at https://doc.schlomp.space/mastodon-cpp/namespaceMastodon.html and https://doc.schlomp.space/mastodon-cpp/namespaceMastodon_1_1Easy.html.

Return types

  • Mastodon::return_call: Contains the response from Mastodon::API calls.
  • Mastodon::Easy::return_entity: Contains the response from Mastodon::Easy::API calls that return a single Mastodon::Easy::Entity.
  • Mastodon::Easy::return_entities_vector: Contains the response from Mastodon::Easy::API calls that return multiple Mastodon::Easy::Entity.

Other types

  • Mastodon::param: A single parameter to an Mastodon::API call. Normally you don’t need this.
  • Mastodon::parameters: All parameters to an Mastodon::API call.
  • Mastodon::http_method: HTTP method of an Mastodon::API call.
  • Mastodon::Easy::event_type: Event types returned in streams.
  • Mastodon::Easy::visibility_type: Describes the visibility of a post.
  • Mastodon::Easy::attachment_type: Describes the type of attachment.
  • Mastodon::Easy::card_type: Describes the type of card.
  • Mastodon::Easy::notification_type: The type of the notification.
  • Mastodon::Easy::stream_event: Type and data of an events returned in streams.
  • Mastodon::Easy::alert_type: Type for a single alert.
  • Mastodon::Easy::alerts: Vector of Mastodon::Easy::alert_type, used for push subscriptions.
  • Mastodon::Easy::time: Type for time, can be converted to time_point and string.

Error codes

Code Explanation
0 No error
22 Invalid argument
78 URL changed (HTTP 301 or 308)
110 Connection timed out
111 Connection refused (check http_error_code)
113 No route to host / Could not resolve host
192 curlpp runtime error
193 curlpp logic error
255 Unknown error

If you use a debug build, you get more verbose error messages.

Install

Upgrading from versions below 0.100.0

Starting with version 0.100.0, large parts of the library have been rewritten. Upgrading from previous versions will require extensive code changes. You can keep using the old version, it is archived in the branch pre-0.100.0. It will receive bug-fixes for a while but no new features.

Packages

Every release includes packages for the package managers of Debian and Red Hat. Gentoo packages are available in my overlay.

Gentoo

Add my repository and install it from there.

eselect repository enable tastytea
echo 'dev-cpp/mastodon-cpp ~amd64' >> /etc/portage/package.accept_keywords/mastodon-cpp
emaint sync -r tastytea
emerge -a dev-cpp/mastodon-cpp

DEB and RPM

Prebuilt DEB and RPM packages for x86_64(amd64) are provided with each release. .deb packages are built on Debian stretch and .rpm packages are built on CentOS 7. These packages are automatically built and not tested.

To use the DEB.deb package on Debian stretch, you will need libcurlpp0 from sid.

To use the .rpm package on CentOS 7, you will need libcurlpp from EPEL 6.

From source

Dependencies

  • Tested OS: Linux
  • C++ compiler (tested: gcc 6/7/8, clang 5/6)
  • cmake (at least: 3.6)
  • pkgconfig (tested: 0.29 / 0.27)
  • curlpp (tested: 0.8)
  • Optional
    • Easy interface & Examples: jsoncpp (tested: 1.8 / 1.7)
    • Documentation: doxygen (tested: 1.8)
    • DEB package: dpkg (tested: 1.18)
    • RPM package: rpm-build (tested: 4.11)
    • Tests: catch (tested: 2.5 / 1.2)

Get sourcecode

Release

Download the current release at schlomp.space.

Development version

git clone https://schlomp.space/tastytea/mastodon-cpp.git

Compile

mkdir build
cd build/
cmake ..
cmake --build . -- -j$(nproc --ignore=1)

cmake options:

  • -DCMAKE_BUILD_TYPE=Debug for a debug build
  • -DWITH_EASY=NO to not build the Easy abstractions and to get rid of the jsoncpp-dependency (not recommended)
  • -DWITH_EXAMPLES=YES if you want to compile the examples
  • -DWITH_TESTS=YES if you want to compile the tests
  • -DWITH_DOC=NO if you don’t want to compile the HTML reference
  • One of:
    • -DWITH_DEB=YES if you want to be able to generate a deb-package
    • -DWITH_RPM=YES if you want to be able to generate an rpm-package

Install with make install.

Tests

You can run the tests with ctest inside the build directory. You need to set the environment variable MASTODON_CPP_ACCESS_TOKEN to an access token with the scopes read, write and follow for some tests. You can select the instance to use with MASTODON_CPP_INSTANCE, the default is likeable.space. You can select the user ID with MASTODON_CPP_USER_ID, the default is 9hnrrVPriLiLVAhfVo.

Packages

DEB and RPM

Compile with -DWITH_DEB=ON or -DWITH_RPM=ON. Run make package from the build directory to generate a DEB/RPM package.

Other

Run make package from the build directory to generate a tar.gz archive.

Status of implementation

Feature complete as of Mastodon 2.6.1

Glitch-Soc support

Copyright

Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>.
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.