weberius/kvbradlive

#KVB Rad Live

Dieser Service liest den aktuellen Standort der von den Kölner Verkehrsbetrieben betriebenen Fahrräder unter Aktuelle Standorte Fahrraeder KVB-Rad aus und deserialisisert sie in Java-Objekte. Hierfür wird die Bibliothek FasterXML/jackson-dataformat-xml verwendet.

Zum Betrieb ist eine Postgres + Postgis notwendig. Wenn sich die Position eines Rades gegenüber dem letzten Aufruf geändert hat, wird das Ergebnis in die Datenbank geschrieben.

Installation

Kommandozeile

git clone https://github.com/codeforcologne/kvbradlive.git
cd kvbradlive
mvn clean install

eclipse

Für die Entwicklung in eclipse wird das Projekt über 'Import/Check out Maven Project from SCM' in eclipse importiert. Danach kann mit 'mvn clean install' alle Abhängigkeiten aufgelöst werden.

Mit 'mvn clean install' werden bereits die Konfigurationsdateien 'config.properties' und 'jndi.properties' mit default-Parametern angelegt. Ggf. müssen hier noch Einträge geändert werden. Nach der Änderung ist ein erneutes Bauen der Anwendung notwendig.

Datenbank

Dieser Service unterstellt, dass die Datenbankverbindung per JNDI gesetzt ist. Für den Server bedeutet dies, dass der Container für die Definition der DB-Verbindung zurständig ist. Dafür muss z.B. im Tomcat die Datei context.xml angepasst werden. Folgende Einstellungen müssen eingetragen werden.

Entwicklung

Für die Erreichbarkeit der Datenbank werden zwei Bibliotheken benötigt:

• PostgreSQL JDBC Driver JDBC 4.1
• Postgis JDBC Driver

Für die Übersetzung der Anwendung werden beide jar-Files mit scope 'provided' eingebunden. Für den Betrieb eines Servers z.B. innerhalb einer Entwicklungsumgebung bedeutet das, dass der entsprechende Server die Bibliotheken kennen muss. Hierfür müssen diese heruntergeladen und im tomcat/lib Verzeichnis abgelegt werden. Dann müssen diese unter 'launch configuration/ Classpath' dem Server bekannt gemacht werden.

Connection

Folgende Parameter müssen im Server gesetzt sein, damit die Services die Datenbank erkennen können:

context.xml

<Context>
    <ResourceLink 
         name="jdbc/kvbrad" 
         global="jdbc/kvbrad"
         type="javax.sql.DataSource" />
</Context> 

server.xml

<GlobalNamingResources>
    <Resource 
        name="jdbc/kvbrad"
        auth="Container"
        driverClassName="org.postgresql.Driver"
        maxTotal="25" 
        maxIdle="10"
        username="username"
        password="password"
        type="javax.sql.DataSource"
        url="jdbc:postgresql://localhost:5432/kvbrad"
        validationQuery="select 1"/>

DB-Tabellen

Zur Zeit wird nur eine Tabelle verwendet; DDL:

CREATE TABLE bike (
    uid                          integer,
    name         varchar(256),
    bike         integer DEFAULT 0,
    number       integer NOT NULL,
    modtime      timestamp DEFAULT current_timestamp
);
SELECT AddGeometryColumn ('public','bike','geom',4326,'POINT',2);

Für das Logging der Abfragen wird folgende Tabelle benötigt:

CREATE TABLE kvbradlive (
    numberofinsert      integer,
    modtime      timestamp DEFAULT current_timestamp
);

REST Endpoints

Folgende REST Endpoints stehen zur Verfügung

/kvbradlive/service

/kvbradlive/service/datatable

/kvbradlive/service/bikesmap

/kvbradlive/service/bike/<number>

/kvbradlive/service/allbikeslatestposition/bikeslist

/kvbradlive/service/put

Mit diesem REST-Endpoint wird das Auslesen der Schnittstelle ausgelöst und ggf. die Werte in die Datenbank eingefügt. Vorgehen:

1. AskForNextBikeLife
2. Get the Bikes
3. Insert Bikes to DB; check for existing bike before inserting

/kvbradlive/service/delete

Mit diesem REST-Endpoint werden die Einträge der letzten 30 Tage gelöscht.

Test

Tests mit Datenbank

Da zur Zeit keine Integration Test Stage zur Verfügung steht, sind alle Tests, die eine Datenbank voraussetzt als main codiert. Um eine Datenbankverbindung hierfür zur Verfügung stellen zu können, muss die Datei src/test/resources/jndi.properties.template in src/test/resources/jndi.properties kopiert und die entsprechenden Parameter zur Datenbank gesetzt werden.

Beim ersten auschecken und mit Aufruf von 'mvn clean install' wird die Datei jndi.properties.template in jndi.properties umgesetzt. Vorausgesetzt die Datenbank ist über localhost erreichbar und kennt das Schema 'kvbrad' bzw. den User 'kvbrad/kvbrad' kann direkt mit der Datenbank verbunden werden.

License

Dieses Werk ist lizenziert unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz.

kvbradlive's Issues

Neuer Endpoint: /kvbradlive/service/bikesmap/bike/(number)

Es wird ein neuer endpoint benötigt, der in Abhängigkeit von der Bike-Number die Koordinaten eines Fahrrades zurückgibt.

Informationen zum letzten Abspeichern der Fahrräder speichern

Es soll eine Möglichkeit geschaffen werden, dass Informationen zum Abspeichern der Bike-Daten erfasst werden. Dafür wird folgende Tabelle angelegt:

    CREATE TABLE kvbradlive (
        numberofinsert      integer,
        modtime      timestamp DEFAULT current_timestamp
    );

Außerdem wird ein REST-Endpoint implementiert, der es ermöglicht diese Informationen für die Darstellung auf der Oberfläche auszulesen.

Link auf nextlevel api ändern

Bisher wurden die Fahrraddaten über die URL
http://nextbike.net/maps/nextbike-live.xml?city=14
bezogen. Das ändert sich nun. Die URL lautet nun:
http://api.nextbike.net/maps/nextbike-live.xml?city=14

Nextlevel Link auf Fahrraddaten in config.properties auslagern

Zur Zeit wird der Link auf die Fahrraddaten von nextbike noch im Source-Code gesetzt. Das muss geändert werden. Der Linke sollte in der anzulegenden config.properties abgelegt werden.

Ignore Properties

In unregelmäßigen Abständen wird die Schnittstelle zu nextbike geändert. Dadurch fällt der Service aus. Das Verhalten kann verbessert werden, indem die Klassen für die Json Properties folgend annotiert werden:

@JsonIgnoreProperties(ignoreUnknown = true)

neue Felder in der Schnittstelle von nextbike

In der Schnittstelle sind im Bereich Place die Felder address und free_racks hinzugekommen. Diese müssen berücksichtigt werden.

Service für den letzten Standort der Fahrräder

Es soll ein Service implementiert werden, der aus der Datenbank den letzten Standort der Fahrräder ermittelt. Damit sollen alle Fahrräder mit ihren letzten Standorten angezeigt werden. Die Abfrage würde dafür über die bike - Tabelle gruppieren und den letzten Standort inklusive Adresse zur Verfügung stellen.

expand interface /allbikeslatestposition/bikeslist for boundingbox

Es soll möglich sein, der Schnittstelle '/allbikeslatestposition/bikeslist' eine BoundingBox zu übergeben.

Schnittstelle seitens nextbike geändert

Die Adresse http://api.nextbike.net/maps/nextbike-live.xml?city=14 liefert nun auch die Felder show_bike_types="1" und show_free_racks="1". Außerdem wird nicht nur city=14, also Köln zurückgeliefert, sondern auch Polen als zusätzliches "Country". Diese Änderungen müssen berücksichtigt werden.

Add missing fields

Interface to nextbike has changed. Please add

• booked_bikes
• set_point_bikes
• available_bikes

Funktion zum Löschen alter Informationen

Es soll eine Funktion implementiert werden, die alte Daten aus dem System entfernt. Diese Funktion soll über einen REST-Endpunkt aufgerufen werden können. Daten, die gelöscht werden sollen, werden anhand der Spalte modtime identifiziert. Das Datum bis zu dem die Daten gelöscht werden können, wird in Tagen in der Konfiguration eingestellt.

add Class Bike

Es wurde eine neue Auszeichnung 'bike' zu 'place' hinzugefügt. Für diese soll eine passende Klasse erstellt werden.

Bsp.:

<place uid="610147" lat="50.9893007" lng="6.9079576" bike="1" name="BIKE 21653" bikes="1" free_racks="0" bike_numbers="21653" bike_types="{"15":1}" place_type="12">
  <bike number="21653" bike_type="15" active="1" state="ok" electric_lock="1"/>
</place>

Attribute prüfen

Die Schnittstelle von nextBike ist steten Änderungen unterworfen. Dies bildet sich in der Klassen-Struktur ab. Es wurden bisher immer alle möglichen Attribute berücksichtigt. Mit #11 Ignore Properties ist dies nicht mehr notwendig. Hierdurch können die Klassen auf die für die Applikation notwendigen Attribute gekürzt werden.