[go: up one dir, main page]

Skip to content

voc/eventkalender

Repository files navigation

eventkalender

Small sinatra web application to serve feeds for c3voc events.
Eventkalender is tested against Ruby 2.5.7 and 2.6.5. Build Status Inline docs

Usage

Supported feed formats:

  • ical → /events.ical
  • atom → /events.atom
  • json → /events.json
  • txt → /events.txt

Filter

To filter for past or upcoming events, following keywords (e.g. /events.txt?filter=past) can be used:

  • past
  • upcoming
  • today
  • year (e.g. 2013)
  • all (default)

A filter for live streaming is also available (/events.txt?streaming=true).

Example output

JSON /events.json?filter=past&streaming=true:

{
  "voc_events": {
    "FOSSGIS 2014": {
      "name": "FOSSGIS 2014",
      "short_name": "fossgis2014",
      "location": "Berlin",
      "start_date": "2014-03-19",
      "end_date": "2014-03-21",
      "description": "http://www.fossgis.de/konferenz/2014",
      "voc_wiki_path": "/wiki/fossgis2014",
      "streaming": true
    }
  }
  "voc_events_count": {
    "all": 1,
    "with_streaming": 1,
    "without_streaming": 0,
    "undefined_streaming": 0
  }
}

TXT /events.txt?filter=upcoming&streaming=false:

Hackover 14 - Hannover
24.10.2014 - 26.10.2014

Install

Clone repository.

 git clone https://github.com/voc/eventkalender;
 cd eventkalender

Install dependencies.

 bundle install

Test installation and run application with puma.

 ruby webapp.rb

Docker

Docker image builds are created with github actions after every push.

Local builds can be created with:

docker build -t eventkalender .

Deployment

It is highly recommended to deploy this application with passenger or comparable webservers.

License

Copyright (c) 2014, c3voc
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.