Skip to content

New API endpoint GET /events. #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jvah wants to merge 1 commit into
base: master
Choose a base branch
from
Open

New API endpoint GET /events. #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,21 @@ To get statistics from an event, perform a GET on `/event/EVENT_NAME`:
- `200` Statistics returned
- `404` The specified event does not exist

#### List of registered events

To get the names of currently registered events, perform a GET on `/events`:

> GET /events HTTP/1.1
>
---
< HTTP/1.1 200 Ok
< Content-Type: application/json
<
< {"events": [
< "EVENT_NAME1",
< "EVENT_NAME2"
< ]}

#### Event Purge

When the application data provider know about a particular event will no longer be available, it can force pushd to forget about it and unsubscribe all current subscribers from it. To purge an event, perform a DELETE on `/event/EVENT_NAME`
Expand Down
8 changes: 7 additions & 1 deletion lib/api.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ filterFields = (params) ->
fields[key] = val for own key, val of params when key in ['proto', 'token', 'lang', 'badge', 'version']
return fields

exports.setupRestApi = (app, createSubscriber, getEventFromId, authorize, testSubscriber, eventPublisher) ->
exports.setupRestApi = (app, createSubscriber, getEventFromId, authorize, testSubscriber, listEvents, eventPublisher) ->
authorize ?= (realm) ->

# subscriber registration
Expand Down Expand Up @@ -171,3 +171,9 @@ exports.setupRestApi = (app, createSubscriber, getEventFromId, authorize, testSu
res.send 204
else
res.send 404

# List of registered events
app.get '/events', authorize('publish'), (req, res) ->
listEvents (events) ->
logger.verbose "Events: " + JSON.stringify events
res.json { events: events }, 200
4 changes: 4 additions & 0 deletions lib/event.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ class Event
OPTION_IGNORE_MESSAGE: 1
name_format: /^[a-zA-Z0-9@:._-]{1,100}$/

listEvents: (redis, cb) ->
redis.smembers 'events', (err, values) ->
cb(values) if cb

constructor: (@redis, @name) ->
throw new Error("Missing redis connection") if not redis?
throw new Error('Invalid event name ' + @name) if not Event::name_format.test @name
Expand Down
5 changes: 4 additions & 1 deletion pushd.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,10 @@ authorize = (realm) ->
else
return (req, res, next) -> next()

require('./lib/api').setupRestApi(app, createSubscriber, getEventFromId, authorize, testSubscriber, eventPublisher)
listEvents = (cb) ->
Event::listEvents(redis, cb)

require('./lib/api').setupRestApi(app, createSubscriber, getEventFromId, authorize, testSubscriber, listEvents, eventPublisher)
if eventSourceEnabled
require('./lib/eventsource').setup(app, authorize, eventPublisher)

Expand Down