Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthewoden/rss_watcher
Module for watching RSS feeds, and dispatching updates when they change.
https://github.com/matthewoden/rss_watcher
Last synced: about 1 month ago
JSON representation
Module for watching RSS feeds, and dispatching updates when they change.
- Host: GitHub
- URL: https://github.com/matthewoden/rss_watcher
- Owner: matthewoden
- License: mit
- Created: 2019-07-04T16:32:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-12T01:23:42.000Z (over 4 years ago)
- Last Synced: 2024-11-10T21:49:21.018Z (about 2 months ago)
- Language: Elixir
- Homepage: https://hexdocs.pm/rss_watcher/
- Size: 35.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RssWatcher
A small worker that watches a single RSS feed, parses the changes, and dispatches updates.
Online Docs: [https://hexdocs.pm/rss_watcher](https://hexdocs.pm/rss_watcher).
## Installation
### Dependancies
Add the following to your dependencies:
```elixir
{:rss_watcher, "~> 0.1.0"}
```
For _easy mode_, you can use the default adapters to fetch and parse
RSS feeds. Just add the following to your dependancies, and you should be good
to go.
```elixir
{:tesla, "~> 1.2.1"}, # For HTTP requests
{:fiet, "~> 0.2.1"}, # For RSS parsing
{:timex, "~> 3.0"}, # For timestamp parsing
```
And add `Timex` to your list of applications.
```elixir
extra_applications: [ ..., :timex]
```
### Adapters
`RssWatcher.HTTP.Tesla` is provided by default. To use, add the following
dependancies to your dependency list. See module configuration around middleware, and additional
adapter options.
```elixir
{:tesla, "~> 1.2.1"}
```
For RSS parsing, `RssWatcher.Feed.Fiet` is provided by default,
and handles parsing XML and timestamps. To use, add the following dependencies
to your dependency list.
```elixir
{:fiet, "~> 0.2.1"},
{:timex, "~> 3.0"}
```
And add timex to your list of applications.
```elixir
extra_applications: [ ... :timex]
```
## Usage
RssWatcher is a worker, so the recommended usage is to add it as a child
to your supervisor.
### API Example
```elixir
children = [
{RssWatcher,
url: "http://example.com/rss",
callback: {Notifications, broadcast, ["#channel_id"]},
}
]
Supervisor.start_link(children, strategy: :one_for_one))
```
Or, with a dynamic supervisor:
```elixir
children = [
{DynamicSupervisor, strategy: :one_for_one, name: MyApp.RssSupervisor}
]
Supervisor.start_link(children, strategy: :one_for_one)
...
DynamicSupervisor.start_child(
MyApp.RssSupervisor,
{RssWatcher,
url: "http://example.com/rss",
callback: {Notifications, broadcast, ["#channel_id"]}
}
)
```
Each `RssWatcher` worker takes at least a _url_, and a _callback_. Additional
configuration can be provided to use alternate adapters.
### Url
The url should be a string, which resolves to an RSS feed.
### Callback
The callback can be in the form of `{module, function, arguments}`, or
an anonymous/suspended function.
If `{module, function, arguments}` format, the callback will be dispatched with
an additional argument - the parsed XML. Otherwise, the parsed XML will be
the only argument provided. See below for examples.
### Additional Configuration
Additional configuration can be provided to handle dispatching/fetching updates.
- `:refresh_interval` - integer. How often the feed is checked, in seconds. Defautls to `60`.
- `:rss_parser` - Atom/RSS 2.0 parser module. Defaults to `RssWatcher.Feed.Fiet`,
- `:rss_parser_options`- options for the above parser. Defaults to `[]`,
- `:http_client` - HTTP client for fetching updates. Defaults to `RssWatcher.HTTP.Tesla`,
- `:http_client_options` - options for the above client. Default to `[]`. See adapter module for configuration options.
### Examples
```elixir
{RssWatcher,
url: "http://example.com/rss",
callback: {Notifications, broadcast, ["#channel_id"]},
}
{RssWatcher,
url: "http://example.com/rss",
callback: fn xml -> Notifications.broadcast(xml) end,
}
{RssWatcher,
url: "http://example.com/rss",
callback: &Notifications.broadcast/1,
refresh_interval: 60
}
```