A simple nodejs web app that polls www.obaranda.com for comic updates and sends push messages via firebase to registered clients. It also exposes a REST API for accessing the comics.
The web app periodically monitors the json feed at www.obaranda.com. An external scheduling service/ cron job is responsible for the timing and should send a POST request to /poll. The request should be authenticated using Basic Authentication with the username and password supplied in the POLL_USERNAME and POLL_PASSWORD environment variables respectively.
The comics data is cached in firebase firestore and a firebase function monitors new additions to firestore and sends push messages using firebase messaging.
You need to have Node JS and Npm installed.
- Clone this repo locally
- Create a
.envfile and add your equivalent of the following variables# Username and password of basic auth for the /poll endpoint POLL_USERNAME=<your_value> POLL_PASSWORD=<your_value> # Url for the obaranda comic json feed. See [blob/master/src/app/poll/index.ts#L142] OBARANDA_FEED_URL=<your_value> # See the firebase admin setup [guide](https://firebase.google.com/docs/admin/setup#initialize_the_app) FIREBASE_DB_URL=<your_value> - Follow the instructions in this link to download a firebase service account key.
Add the json file to your project and edit
service-account-key.tsto export your service account from:toexport default {} as ServiceAccount;
export default require('path/to/service-account.json') as ServiceAccount;
$ npm install
$ npm startIf successful, the app is now available at http://localhost:8080/.
There are no tests (for now). Contributions are welcome.
There is a publicly available API for retrieving comics at https://obaranda-push.herokuapp.com/api/. It is an unauhenticated API with no usage limits (yet) and no versioning scheme.
The API currently supports JSON as the only data format. All requests that return data will return JSON data with a Content-Type header of Content-Type: application/json; charset=utf-8.
Endpoints that return collections will offer basic pagination via limit and offset query parameters.
limitspecifies the number of items to returnoffsetspecifies the 0-based result offset. This is usually the total count of already retrieved items
The API follows the RFC5988 convention of using the Link header to provide URLs for the next and prev page and an X-Total-Count header to provide the total item count for the collection in question. It is recommended to follow this convention than build the pagination URLs manually.
The API uses HTTP status codes to signify errors. HTTP responses with status 4xx signify consumer errors while status 5xx errors are indicative of server failures. It is safe to retry api calls (with exponential backoff) in the case of 5xx errors. Irregardless of the HTTP status code, errors always have a JSON error body like:
{
"name": "Error | <SpecificConstantErrorName>",
"message": "Non-localized best effort text trying to explain the cause of the error"
}GET /comics
returns:
a paginated collection of ComicOverview. The collection is sorted reverse chronologically and there is currently no way to influence the sort order.
query parameters:
limit[integer] See paginationoffset[integer] See pagination
sample success response:
[
{
"page": 24,
"title": "Anti-Artist Block",
"permalink": "http://www.obaranda.com/comic/24",
"pubDate": "2018-03-07 00:00:00",
"previewImg": {
"url": "http://www.obaranda.com/assets/images/comics/201803070150148273161/0001.jpg",
"palette": "#9c7464"
}
},
{
"page": 23,
"title": "Oh, Lagos",
"permalink": "http://www.obaranda.com/comic/23",
"pubDate": "2017-10-23 00:00:00",
"previewImg": {
"url": "http://www.obaranda.com/assets/images/comics/201710231401297524381/Gidi1.jpg",
"palette": "#56819c"
}
}
]GET /comics/{page}
returns:
the Comic at :page.
sample success response:
{
"post": {
"title": "Happy Independence Day, Everyone!",
"body": "This is a comic idea I've had for at least two years now, but sheer laziness has prevented me from sketching it. \r\n\r\nHow's your independence day celebration going? Anyone wearing green and white? "
},
"title": "Something something Tupac",
"page": 22,
"pubDate": "2017-10-01 03:47:25",
"author": {
"name": "Justin Irabor"
},
"url": "http://www.obaranda.com/comic/22-no-change",
"permalink": "http://www.obaranda.com/comic/22",
"images": [
{
"palette": {
"muted": "#867d79",
"vibrant": "#2a9aeb"
},
"alt": "No change",
"url": "http://www.obaranda.com/assets/images/comics/201710010349399949511/No change.jpg",
"size": {
"height": 2380,
"width": 1000
}
}
]
}GET /comics/latest
returns:
the latest Comic.
sample success response:
{
"post": {
"title": "Happy Independence Day, Everyone!",
"body": "This is a comic idea I've had for at least two years now, but sheer laziness has prevented me from sketching it. \r\n\r\nHow's your independence day celebration going? Anyone wearing green and white? "
},
"title": "Something something Tupac",
"page": 22,
"pubDate": "2017-10-01 03:47:25",
"author": {
"name": "Justin Irabor"
},
"url": "http://www.obaranda.com/comic/22-no-change",
"permalink": "http://www.obaranda.com/comic/22",
"images": [
{
"palette": {
"muted": "#867d79",
"vibrant": "#2a9aeb"
},
"alt": "No change",
"url": "http://www.obaranda.com/assets/images/comics/201710010349399949511/No change.jpg",
"size": {
"height": 2380,
"width": 1000
}
}
]
}Efeturi Money (@efemoney).
This project is available under the MIT license. See the LICENSE.md file for more info.