Collator
Collator fetches information, organises it and serves it up when required.
This server listens on specific URLs for requests for news feeds and other information. When a feed is requested, it checks for cached information then delivers it as JSON, fetching from the upstream URL beforehand if required.
Data is plain JSON by default.
Valid URL arguments are, in order:
http://[server]/[api-version]/[feed-name]
- API version: required, currently "v1".
- Feed name: required.
Usage
Give me the Ministerial Media Statements feed:
curl http://[server]/v1/statements/ministerials
Test instance
A test instance of this app is running on Heroku at:
https://collator-tool.herokuapp.com/
TODO
- Support feed pagination for asking for more data.
- Build a live train departure times feed from the Transperth website (with x-ray?).
- Add a unified feed endpoint with sorting via query string parameters.
- Supply other information.
- Add caching of information.
- Build a Ministerials feed from the Media Statements website.
ENHANCEMENTS
- Convert to use Memcached or Redis for caching backend..
- Support / convert to GraphQL
License
This information collator thingy is released under the Apache 2.0 License (see the license file) and is copyright Drew Robinson, 2017.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.