https://github.com/ginolatorilla/splitwisecpp
A native C++ API for the Splitwise App
https://github.com/ginolatorilla/splitwisecpp
api api-rest cpp splitwise splitwise-api
Last synced: 4 months ago
JSON representation
A native C++ API for the Splitwise App
- Host: GitHub
- URL: https://github.com/ginolatorilla/splitwisecpp
- Owner: ginolatorilla
- License: mit
- Created: 2020-05-08T11:30:56.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T20:53:16.000Z (almost 3 years ago)
- Last Synced: 2025-01-13T02:27:03.792Z (5 months ago)
- Topics: api, api-rest, cpp, splitwise, splitwise-api
- Language: C++
- Homepage:
- Size: 147 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Splitwise C++ API
[](https://github.com/ginolatorilla/splitwisecpp/actions?query=branch%3Amaster)
[](https://codecov.io/gh/ginolatorilla/splitwisecpp)
A native C++ API for [the Splitwise App](https://www.splitwise.com/). Written in C++14.
Tested in Linux.
:warning: This library is in beta phase. All APIs are implemented but corner-cases might not be tested.
**Use at your own risk.** :warning:
## Quick Start
```cpp
#include
#include
#include
int main()
{
splitwisecpp::Config config;
config.consumer_key = "your_consumer_key";
config.consumer_secret = "your_consumer_secret";
config.oauth1_token = "your_oauth1_token";
config.oauth1_token_secret = "your_oauth1_token_secret";
splitwisecpp::Splitwise splitwise(config);
splitwisecpp::ApiResponse the_user = splitwise.get_current_user();
assert(spliwisecpp::ErrorCodes::NoError = the_user.error);
std::cout << the_user.json["user"]["first_name"] << std::endl;
}
```
## Requirements
- [libcurl](https://curl.haxx.se/libcurl/)
- [jsoncpp](https://github.com/open-source-parsers/jsoncpp)
- Includes [liboauthcpp](https://github.com/sirikata/liboauthcpp)
Additional components if you want to develop this:
- C++ compiler that supports C++14 (preferably `gcc` or `clang`)
- CMake
- [gcovr](https://gcovr.com/en/stable/), for code coverage
- [clang-format](https://clang.llvm.org/docs/ClangFormat.html), for code formatting
- [clang-tidy](https://clang.llvm.org/extra/clang-tidy/), for static analysis
- Python 3.6
- Python Jinja2
GTest will be automatically downloaded from GitHub if you don't have it pre-installed.
## Features
- Authentication using OAuth1 tokens.
Please read the Splitwise [docs](http://dev.splitwise.com/#authentication) to learn more.
- (As of 26 May 2020) Implemented all the APIs described in
Splitwise's [developer documentation](http://dev.splitwise.com/).
- Exports public types from `jsoncpp`
## Limitations
- Thread-unsafe. The `splitwisecpp::Splitwise` class must be instantiated in one thread.
## Backlog
- [ ] Allow C linkage
- [ ] Allow replacement of libcurl via plugins
- [ ] Support OAuth2
- [ ] Support for Windows (ie Win32)
- [ ] Extra tools for:
- [ ] OAuth1 generation
- [ ] Command line interface
- [ ] API documentation
## For Developers
Add new API methods in `src/api_method_descriptors.yaml` (the schema is in the comments).
Then run `tools/generate_cpp_api_from_descriptor` to generate interfaces and implementation code.
You may use `pipenv` to install a virtual environment.