podsync 0.1.3

A server to sync podcasts with, mirroring the gpodder API. Designed for use with AntennaPod
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# podsync

A HTTP server for syncing podcast app state, mirroring the [gpodder API]. Designed for use with [AntennaPod]'s [sync service].

[gpodder API]: https://github.com/gpodder/mygpo/blob/80c41dc0c9a58dc0e85f6ef56662cdfd0d6e3b16/doc/api/reference/events.rst
[AntennaPod]: https://github.com/AntennaPod/AntennaPod
[sync service]: https://github.com/AntennaPod/AntennaPod/blob/24d1a06662c8eec31f3a4c3ebdcd3aea759fb63a/core/src/main/java/de/danoeh/antennapod/core/sync/SyncService.java

# Endpoints

podsync doesn't cover the [full gpodder API], just enough to get AntennaPod to work:

- auth:
	- `POST api/2/auth/{username}/login.json`
	- `POST api/2/auth/{username}/logout.json`
- devices:
	- `GET api/2/devices/{username}.json`
	- `POST api/2/devices/{username}/{device}.json`
- subscriptions:
	- `GET api/2/subscriptions/{username}/{device}.json`
	- `POST api/2/subscriptions/{username}/{device}.json`
- episodes:
	- `GET api/2/episodes/{username}.json`
	- `POST api/2/episodes/{username}.json`

[full gpodder API]: https://github.com/gpodder/mygpo/tree/80c41dc0c9a58dc0e85f6ef56662cdfd0d6e3b16/doc/api/reference

# Logging

podsync uses the `RUST_LOG` environment variable for logging. To generate logs similar to a webserver:
```sh
export RUST_LOG=podsync=info

# or for debugging:
export RUST_LOG=podsync=trace

# for warp/endpoint output:
export RUST_LOG=podsync=info,warp=info
```

See the [log crate] for more details

[log crate]: https://crates.io/crates/log

# Building

podsync uses sqlx in [offline mode] for builds (see [`build.rs`](./build.rs) for more).

To update the schema:
```sh
export DATABASE_URL=sqlite://pod.sql
cargo install sqlx-cli
cargo sqlx prepare -- --tests
git commit -m 'Update sqlx snapshot' sqlx-data.json
```

[offline mode]: https://docs.rs/sqlx/latest/sqlx/macro.query.html#offline-mode-requires-the-offline-feature