Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdzombak/a2-foia-rss
Feed generator for Ann Arbor's online FOIA database
https://github.com/cdzombak/a2-foia-rss
ann-arbor foia rss
Last synced: about 1 month ago
JSON representation
Feed generator for Ann Arbor's online FOIA database
- Host: GitHub
- URL: https://github.com/cdzombak/a2-foia-rss
- Owner: cdzombak
- License: mit
- Created: 2018-08-10T02:07:38.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:29:54.000Z (about 2 months ago)
- Last Synced: 2024-10-29T21:37:47.708Z (about 2 months ago)
- Topics: ann-arbor, foia, rss
- Language: Ruby
- Homepage: https://www.dzombak.com/local/feed/a2-foia.rss
- Size: 61.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ann Arbor FOIA RSS/JSON Feed
Generates an RSS feed and a [JSON feed](https://jsonfeed.org) from Ann Arbor's public [FOIA request database](https://www.a2gov.org/departments/city-clerk/Pages/FOIA-Requests.aspx).
## Subscribing to the feed
Add [`https://www.dzombak.com/local/feed/a2-foia.rss`](https://www.dzombak.com/local/feed/a2-foia.rss) to your feed reader of choice.
(Or use [`https://www.dzombak.com/local/feed/a2-foia.json`](https://www.dzombak.com/local/feed/a2-foia.json) if you prefer a [JSON Feed](https://jsonfeed.org).)
## Deployment (Docker)
Pre-built Docker images are available for linux/amd64, linux/arm64, and linux/386; see [Docker Hub](https://hub.docker.com/repository/docker/cdzombak/a2-foia-rss/general) or [GHCR](https://github.com/cdzombak/a2-foia-rss/pkgs/container/a2-foia-rss) for details. This is the preferred deployment method, as it avoids the need to deal with Ruby versions or building Nokogiri.
Run the image like the following:
```shell
docker run --rm \
-v /srv/a2-foia-public:/app/public \
--user=www-data:www-data \
cdzombak/a2-foia-rss:1
```
Schedule it periodically with a crontab entry like:
```text
*/30 * * * * docker run --rm -v /srv/a2-foia-public:/app/public --user=www-data:www-data cdzombak/a2-foia-rss:main
```
Or, using [runner](https://github.com/cdzombak/runner) to retry in case of errors and suppress output on successful runs:
```text
*/30 * * * * runner -retries 2 -job-name "A2 FOIA RSS Feed" -- docker run --rm -v /srv/a2-foia-public:/app/public --user=www-data:www-data cdzombak/a2-foia-rss:main
```
## Deployment (local Ruby)
1. Clone the repo and change to the `a2-foia-rss` directory
1. `bundle install --path Vendor/bundle`
1. Refer to [the Nokogiri docs](http://www.nokogiri.org/tutorials/installing_nokogiri.html) to troubleshoot installation.
1. Schedule periodically via cron, with something like:
```text
0 * * * * cd /home/cdzombak/scripts/a2-foia-rss && /usr/local/bin/bundle exec /usr/bin/ruby build_rss.rb`
```
## Author & Contributors
Author: [Chris Dzombak](https://www.dzombak.com) ([GitHub @cdzombak](https://www.github.com/cdzombak))
Thank you to the contributors who have helped keep this running reliably:
- [Andy Blyler](https://github.com/ablyler)
## License
MIT; see `LICENSE` in this repository.