This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/README.md

289 lines
9.4 KiB
Markdown
Raw Normal View History

2018-03-07 17:17:26 +01:00
**mastodon-cpp** is a C++ wrapper for the Mastodon API.
2018-04-03 00:52:23 +02:00
The library takes care of the network stuff. You submit a query and get the raw
JSON. You can then put that JSON into easy to use classes.
2018-01-06 21:33:52 +01:00
2018-06-04 21:06:05 +02:00
[TODO-list](https://schlomp.space/tastytea/mastodon-cpp/milestones)
2018-03-18 14:02:53 +01:00
2018-03-18 01:43:09 +01:00
# 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/](https://doc.schlomp.space/mastodon-cpp/annotated.html).
2018-06-04 21:06:05 +02:00
There are [examples](https://schlomp.space/tastytea/mastodon-cpp/src/branch/master/examples) in `examples/`.
2018-03-18 01:43:09 +01:00
## Upgrading from below 0.13.0
2018-04-19 00:26:23 +02:00
* You have to recompile all applications linking against this library.
* We use a mutex now to guard the string that is being written to. You can get a reference to it with `Mastodon::API::http::get_mutex()` (see examples 9 and 13 for more info). This is only relevant for streams.
## Upgrading from below 0.10.0
2018-04-19 00:26:23 +02:00
`Mastodon::API::get`, `::get_stream`, `::post`, `::put` and `::del` don't take
2018-04-19 15:20:41 +02:00
`std::string` as parameter to API-calls anymore, only `parametermap`s. The old behaviour is
2018-04-19 00:26:23 +02:00
still supported but is deprecated and will be removed in version 1.0.0.
## Upgrading from below 0.7.0
2018-04-10 10:44:46 +02:00
Your projects will break, sorry. Here are the important changes:
* The header location has changed. They are now in `mastodon-cpp/`.
* Specific network error messages have been replaced by 15, "Network error".
You can get the exceptions from curlpp with `Mastodon::API::exceptions(true)`.
2018-03-18 01:43:09 +01:00
## Most basic example
```C++
#include <iostream>
#include <string>
#include <mastodon-cpp/mastodon-cpp.hpp>
2018-03-18 01:43:09 +01:00
int main()
{
Mastodon::API masto("social.example.com", "auth_token");
std::string answer;
masto.get(Mastodon::API::v1::accounts_verify_credentials, answer);
std::cout << answer << '\n';
}
```
2018-04-01 05:03:35 +02:00
## Another simple example
Using the `Easy`-class.
2018-04-01 05:03:35 +02:00
```C++
#include <iostream>
#include <string>
#include <vector>
#include <mastodon-cpp/mastodon-cpp.hpp>
#include <mastodon-cpp/easy/all.hpp>
using Mastodon::Easy;
int main()
{
Easy masto("social.example", "");
std::string answer;
masto.get(Mastodon::API::v1::timelines_public, answer);
for (const std::string &str : Easy::json_array_to_vector(answer))
{
Easy::Status status(str);
std::cout << " " << status.account().acct() << " wrote:\n";
std::cout << status.content() << '\n';
}
}
```
2018-03-18 01:43:09 +01:00
## Compiling your project
2018-03-26 01:14:59 +02:00
A project consisting of one file can be compiled as follows:
2018-03-18 01:43:09 +01:00
2018-06-08 00:44:11 +02:00
```SH
g++ -std=c++14 -lmastodon-cpp example.cpp
```
2018-03-18 01:43:09 +01:00
## Error codes
mastodon-cpp will never use error codes below 11, except 0.
2018-04-10 10:44:46 +02:00
| Code | Explanation |
| --------: |:---------------------------------|
| 0 | No error |
| 11 | Invalid call |
| 12 | Not implemented |
| 13 | URL changed (HTTP 301 or 308) |
| 14 | Aborted by user |
| 15 | Network error (curlpp exception) |
| 100 - 999 | HTTP status codes |
| 65535 | Unknown error |
If you use a debug build, you get more verbose error messages. Errors 20-25 are no longer in use (since 0.8.9).
2018-03-18 01:43:09 +01:00
## Useful links
* [Mastodon API reference](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
* [Mastodon streaming API reference](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md)
2018-01-06 21:33:52 +01:00
# Install
2018-03-18 01:32:54 +01:00
## Packages
Every [release](https://schlomp.space/tastytea/mastodon-cpp/releases) includes
2018-03-18 01:32:54 +01:00
packages for the package managers of Gentoo, Debian and Red Hat.
### Gentoo
2018-03-26 01:14:59 +02:00
Put the ebuild into your [local overlay](https://wiki.gentoo.org/wiki/Custom_repository) and run `ebuild <ebuild path> manifest`.
2018-03-18 01:32:54 +01:00
Install with `emerge mastodon-cpp`.
2018-05-08 07:51:50 +02:00
Or [add my repository](https://wiki.gentoo.org/wiki/Eselect/Repository) and
install it from there.
2018-06-07 23:11:08 +02:00
```SH
2018-06-07 23:12:54 +02:00
eselect repository add tastytea git https://schlomp.space/tastytea/overlay.git
2018-06-07 23:11:08 +02:00
echo 'dev-cpp/mastodon-cpp ~amd64' >> /etc/portage/package.keywords/mastodon-cpp
emaint sync -r tastytea
emerge -a dev-cpp/mastodon-cpp
```
2018-05-08 07:51:50 +02:00
2018-03-18 01:32:54 +01:00
### DEB and RPM
Prebuilt DEB and RPM packages for x86_64(amd64) are provided with each release.
These packages are automatically built and not tested.
Install with `dpkg -i` or `rpm -i`, respectively.
2018-06-08 00:44:11 +02:00
To use the DEB package on stretch, you will need [libcurlpp0](https://packages.debian.org/libcurlpp0) from buster or jessie.
2018-03-18 01:32:54 +01:00
## From source
### Dependencies
2018-03-26 01:14:59 +02:00
* Tested OS: Linux
* C++ compiler (tested: gcc 6.4 / 5.4, clang 5.0)
* [cmake](https://cmake.org/) (tested: 3.9.6)
2018-03-26 01:14:59 +02:00
* [libcurl](https://curl.haxx.se/) (tested: 7.58.0 / 7.35.0)
* [curlpp](http://www.curlpp.org/) (tested: 0.8.1 / 0.7.3)
* Optional
* Easy interface & Examples: [jsoncpp](https://github.com/open-source-parsers/jsoncpp) (tested: 1.8.1 / 1.7.2)
* Documentation: [doxygen](https://www.stack.nl/~dimitri/doxygen/) (tested: 1.8.13)
* DEB package: [dpkg](https://packages.qa.debian.org/dpkg) (tested: 1.19.0.5)
2018-03-12 11:48:41 +01:00
* RPM package: [rpm](http://www.rpm.org) (tested: 4.11.0.1)
2018-01-06 21:33:52 +01:00
2018-03-18 01:32:54 +01:00
### Get sourcecode
2018-03-18 01:32:54 +01:00
#### Release
Download the current release at [schlomp.space](https://schlomp.space/tastytea/mastodon-cpp/releases).
2018-03-18 01:32:54 +01:00
#### Development version
2018-03-12 09:18:49 +01:00
[![Build Status](https://travis-ci.org/tastytea/mastodon-cpp.svg?branch=master)](https://travis-ci.org/tastytea/mastodon-cpp)
2018-06-07 23:23:39 +02:00
```SH
git clone https://schlomp.space/tastytea/mastodon-cpp.git
```
2018-01-06 21:33:52 +01:00
2018-03-18 01:32:54 +01:00
### Compile
2018-06-07 23:11:08 +02:00
```SH
mkdir build
cd build/
cmake ..
make
```
2018-01-06 21:33:52 +01:00
cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
* `-DWITHOUT_EASY=ON` to not build the Easy abstractions and to get rid of the jsoncpp-dependency (not recommended)
* `-DWITH_EXAMPLES=ON` if you want to compile the examples
* `-DWITH_TESTS=ON` if you want to compile the tests
* `-DWITH_DOC=ON` if you want to compile the HTML reference
* `-DWITH_DEB=ON` if you want to be able to generate a deb-package
* `-DWITH_RPM=ON` if you want to be able to generate an rpm-package
You can run the tests with `ctest ..` inside the build directory.
2018-03-26 01:14:59 +02:00
To install, run `make install`.
2018-03-18 01:32:54 +01:00
### Packages
2018-03-18 01:32:54 +01:00
#### Gentoo
2018-03-26 01:14:59 +02:00
Put the ebuild from `packages/gentoo` into your [local overlay](https://wiki.gentoo.org/wiki/Custom_repository) and rename it to match the desired version or use the live-ebuild (`mastodon-cpp-9999.ebuild`) to install the development version.
2018-03-18 01:32:54 +01:00
#### 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.
2018-03-18 01:32:54 +01:00
#### Other
2018-03-18 01:32:54 +01:00
Run `make package` from the build directory to generate a tar.gz archive.
# Status of implementation
2018-06-11 01:39:19 +02:00
Feature complete as of Mastodon 2.4.1
2018-01-09 22:12:11 +01:00
* [x] GET /api/v1/accounts/:id
* [x] GET /api/v1/accounts/verify_credentials
* [x] PATCH /api/v1/accounts/update_credentials
2018-01-09 22:12:11 +01:00
* [x] GET /api/v1/accounts/:id/followers
* [x] GET /api/v1/accounts/:id/following
* [x] GET /api/v1/accounts/:id/statuses
* [x] POST /api/v1/accounts/:id/follow
* [x] POST /api/v1/accounts/:id/unfollow
* [x] POST /api/v1/accounts/:id/block
* [x] POST /api/v1/accounts/:id/unblock
* [x] POST /api/v1/accounts/:id/mute
* [x] POST /api/v1/accounts/:id/unmute
2018-01-09 22:12:11 +01:00
* [x] GET /api/v1/accounts/relationships
* [x] GET /api/v1/accounts/search
* [x] POST /api/v1/apps
* [x] GET /api/v1/blocks
* [x] GET /api/v1/domain_blocks
* [x] POST /api/v1/domain_blocks
* [x] DELETE /api/v1/domain_blocks
* [x] GET /api/v1/favourites
* [x] GET /api/v1/follow_requests
* [x] POST /api/v1/follow_requests/:id/authorize
* [x] POST /api/v1/follow_requests/:id/reject
* [x] POST /api/v1/follows
* [x] GET /api/v1/instance
* [x] GET /api/v1/custom_emojis
* [x] GET /api/v1/lists
* [x] GET /api/v1/accounts/:id/lists
* [x] GET /api/v1/lists/:id/accounts
* [x] GET /api/v1/lists/:id
* [x] POST /api/v1/lists
* [x] PUT /api/v1/lists/:id
* [x] DELETE /api/v1/lists/:id
* [x] POST /api/v1/lists/:id/accounts
* [x] DELETE /api/v1/lists/:id/accounts
* [x] POST /api/v1/media
* [x] PUT /api/v1/media/:id
* [x] GET /api/v1/mutes
* [x] GET /api/v1/notifications
* [x] GET /api/v1/notifications/:id
* [x] POST /api/v1/notifications/clear
* [x] POST /api/v1/notifications/dismiss
* [x] GET /api/v1/reports
* [x] POST /api/v1/reports
* [x] GET /api/v1/search
* [x] GET /api/v1/statuses/:id
* [x] GET /api/v1/statuses/:id/context
* [x] GET /api/v1/statuses/:id/card
* [x] GET /api/v1/statuses/:id/reblogged_by
* [x] GET /api/v1/statuses/:id/favourited_by
* [x] POST /api/v1/statuses
* [x] DELETE /api/v1/statuses/:id
* [x] POST /api/v1/statuses/:id/reblog
* [x] POST /api/v1/statuses/:id/unreblog
* [x] POST /api/v1/statuses/:id/favourite
* [x] POST /api/v1/statuses/:id/unfavourite
* [x] POST /api/v1/statuses/:id/pin
* [x] POST /api/v1/statuses/:id/unpin
* [x] POST /api/v1/statuses/:id/mute
* [x] POST /api/v1/statuses/:id/unmute
* [x] GET /api/v1/timelines/home
* [x] GET /api/v1/timelines/public
* [x] GET /api/v1/timelines/tag/:hashtag
* [x] GET /api/v1/timelines/list/:list_id
2018-02-26 07:57:30 +01:00
* [x] GET /api/v1/streaming/user
* [x] GET /api/v1/streaming/public
* [x] GET /api/v1/streaming/public/local
* [x] GET /api/v1/streaming/hashtag
* [x] GET /api/v1/streaming/list
2018-05-22 23:49:31 +02:00
* [x] POST /api/v1/push/subscription
* [x] GET /api/v1/push/subscription
* [x] PUT /api/v1/push/subscription
* [x] DELETE /api/v1/push/subscription
2018-06-11 01:39:19 +02:00
* [x] GET /api/v2/search
2018-02-11 22:41:47 +01:00
2018-01-06 21:33:52 +01:00
# Copyright
2018-06-07 23:23:39 +02:00
```PLAIN
2018-06-07 23:11:08 +02:00
Copyright © 2018 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.
```