nextcloud app that replicates basic gpodder.net api
Go to file
dependabot[bot] 5f376e52a8 Bump phpunit/phpunit from 9.6.8 to 9.6.9
Bumps [phpunit/phpunit](https://github.com/sebastianbergmann/phpunit) from 9.6.8 to 9.6.9.
- [Changelog](https://github.com/sebastianbergmann/phpunit/blob/9.6.9/ChangeLog-9.6.md)
- [Commits](https://github.com/sebastianbergmann/phpunit/compare/9.6.8...9.6.9)

---
updated-dependencies:
- dependency-name: phpunit/phpunit
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-13 14:23:31 +02:00
.github require >= php8.0 2023-03-23 11:12:51 +01:00
appinfo Release 3.8.0 - support Nextcloud 26 (php >= php8.0) 2023-03-23 11:21:01 +01:00
lib this exception will not be thrown anymore 2023-02-24 20:54:19 +01:00
src Apply suggestions from code review 2022-10-28 09:50:44 +02:00
templates/settings Removed old code 2022-10-28 09:50:44 +02:00
tests delete conflicting episode action if current episode actions updates to same episode url 2023-02-24 20:48:53 +01:00
vendor Ran composer update 2022-10-28 09:50:44 +02:00
.eslintrc.js Initial test version 2022-10-28 09:50:44 +02:00
.gitignore Ignore phpunit cache 2022-10-28 09:50:44 +02:00
babel.config.js Initial test version 2022-10-28 09:50:44 +02:00
CHANGELOG.md Release 3.8.0 - support Nextcloud 26 (php >= php8.0) 2023-03-23 11:21:01 +01:00
composer.json require >= php8.0 2023-03-23 11:12:51 +01:00
composer.lock Bump phpunit/phpunit from 9.6.8 to 9.6.9 2023-06-13 14:23:31 +02:00
jsconfig.json Smallfix for TS intellisense 2022-10-28 09:50:44 +02:00
LICENSE Add AGPL 3.0 LICENSE 2022-07-20 20:13:05 +02:00
Makefile ignore releases directory from tarball 2021-08-14 20:15:31 +02:00
package-lock.json Updated npm packages 2022-10-28 09:50:44 +02:00
package.json Updated npm packages 2022-10-28 09:50:44 +02:00
README.md add Podcast Merlin as syncing client 2023-06-05 19:33:56 +02:00
stylelint.config.js Initial test version 2022-10-28 09:50:44 +02:00
webpack.config.js Initial test version 2022-10-28 09:50:44 +02:00

nextcloud-gpodder

Nextcloud app that replicates basic gpodder.net api to sync podcast consumer apps (podcatchers) like AntennaPod.

Clients supporting sync

client support status
AntennaPod Initial purpose for this project, as a synchronization endpoint for this client.
Support is available as of version 2.5.1.
KDE Kasts Supported since version 21.12
Garmin Podcasts Only for compatible Garmin watches, supported since version 3.3.4
Podcast Merlin Full sync support podcast client for Windows

Installation

Either from the official Nextcloud app store (link to app page) or by downloading the latest release and extracting it into your Nextcloud apps/ directory.

API

subscription

  • get subscription changes: GET /index.php/apps/gpoddersync/subscriptions
    • (optional) GET parameter since (UNIX time)
  • upload subscription changes : POST /index.php/apps/gpoddersync/subscription_change/create
    • returns JSON with current timestamp

The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/subscriptions.html

Example requests:

GET /index.php/apps/gpoddersync/subscriptions?since=1633240761

{
  "add": [
    "https://example.com/feed.xml",
    "https://example.org/feed/"
  ],
  "remove": [
    "https://example.net/feed.rss"
  ],
  "timestamp": 1663540502
}
POST /index.php/apps/gpoddersync/subscription_change/create

{
  "add": [
    "https://example.com/feed.xml",
    "https://example.org/feed/"
  ],
  "remove": [
    "https://example.net/feed.rss"
  ]
}

episode action

  • get episode actions: GET /index.php/apps/gpoddersync/episode_action
    • (optional) GET parameter since (UNIX time)
    • fields: podcast, episode, guid, action, timestamp, position, started, total
  • create episode actions: POST /index.php/apps/gpoddersync/episode_action/create
    • fields: podcast, episode, guid, action, timestamp, position, started, total
    • position, started and total are optional, default value is -1
    • guid is also optional, but should be sent if available
    • identification is done by guid, or episode if guid is missing
    • returns JSON with current timestamp

The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/events.html

Example requests:

GET /index.php/apps/gpoddersync/episode_action?since=1633240761

{
    "actions": [
      {
       "podcast": "http://example.com/feed.rss",
       "episode": "http://example.com/files/s01e20.mp3",
       "guid": "s01e20-example-org",
       "action": "PLAY",
       "timestamp": "2009-12-12T09:00:00",
       "started": 15,
       "position": 120,
       "total":  500
      },
      {
       "podcast": "http://example.com/feed.rss",
       "episode": "http://example.com/files/s01e20.mp3",
       "guid": "s01e20-example-org",
       "action": "DOWNLOAD",
       "timestamp": "2009-12-12T09:00:00",
       "started": -1,
       "position": -1,
       "total":  -1
      },
    ],
    "timestamp": 12345
}
POST /index.php/apps/gpoddersync/episode_action/create

[
  {
   "podcast": "http://example.com/feed.rss",
   "episode": "http://example.com/files/s01e20.mp3",
   "guid": "s01e20-example-org",
   "action": "play",
   "timestamp": "2009-12-12T09:00:00",
   "started": 15,
   "position": 120,
   "total":  500
  },
  {
   "podcast": "http://example.org/podcast.php",
   "episode": "http://ftp.example.org/foo.ogg",
   "guid": "foo-bar-123",
   "action": "DOWNLOAD",
   "timestamp": "2009-12-12T09:05:21",
  }
]

Development

Testing

  • mount project into apps-extra of nextcloud environment (https://github.com/juliushaertl/nextcloud-docker-dev)
  • docker-compose exec nextcloud occ app:enable gpoddersync enable app so we have database tables
  • docker-compose exec nextcloud phpunit9 -c apps-extra/nextcloud-gpodder/tests/phpunit.xml