https://github.com/johnjohndoe/engelsystem

A Kotlin library containing a parser and models for the Engelsystem.
https://github.com/johnjohndoe/engelsystem

37c3 38c3 ccc cccamp19 cccamp23 datenspuren divoc easterhegg engelsystem fossgis froscon gpn hackover kotlin moshi mozfest mrmcd parser rc3 sigint

Last synced: 2 months ago
JSON representation

A Kotlin library containing a parser and models for the Engelsystem.

• Host: GitHub
• URL: https://github.com/johnjohndoe/engelsystem
• Owner: johnjohndoe
• License: apache-2.0
• Created: 2019-08-11T17:27:08.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-12T20:58:35.000Z (7 months ago)
• Last Synced: 2025-03-24T18:21:15.518Z (3 months ago)
• Topics: 37c3, 38c3, ccc, cccamp19, cccamp23, datenspuren, divoc, easterhegg, engelsystem, fossgis, froscon, gpn, hackover, kotlin, moshi, mozfest, mrmcd, parser, rc3, sigint
• Language: Kotlin
• Homepage: https://github.com/johnjohndoe/engelsystem
• Size: 467 KB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://app.travis-ci.com/johnjohndoe/engelsystem.svg?branch=master)](https://app.travis-ci.com/johnjohndoe/engelsystem) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/info.metadude.kotlin.library.engelsystem/engelsystem-base/badge.svg)](https://maven-badges.herokuapp.com/maven-central/info.metadude.kotlin.library.engelsystem/engelsystem-base) [![JitPack](https://jitpack.io/v/johnjohndoe/engelsystem.svg)][jitpack-engelsystem] [![Apache License](http://img.shields.io/badge/license-Apache%20License%202.0-lightgrey.svg)](http://choosealicense.com/licenses/apache-2.0/)

# Engelsystem library

![Engelsystem logo](gfx/engelsystem-logo.png "Engelsystem logo")

A Kotlin library containing a parser and models for the Engelsystem:

* https://engelsystem.de

## Usage

```kotlin

val engelsystemApi: EngelsystemApi = ApiModule

engelsystemApi.provideEngelsystemService(BASE_URL, okHttpClient)

         .getShifts(URL_PART_PATH, API_KEY)

```

### Time stamps

The API response contains time stamps and a corresponding time zone offset.

When the properties of the `Shift` model are read then these two information are joined.

## Gradle build

To deploy the library to your local Maven repository run the following task:

```bash

$ ./gradlew publishToMavenLocal

```

Then, to use the library in your project add the following to

your top level `build.gradle`:

```groovy

allprojects {

    repositories {

        mavenLocal()

    }

}

```

and to your application module `build.gradle`:

```groovy

dependencies {

    implementation "info.metadude.kotlin.library.engelsystem:engelsystem-base:$version"

}

```

Alternatively, you can use [JitPack][jitpack-engelsystem] to fetch and

build the sources directly from this repository.

## Tests

Run the following command to execute all tests:

```groovy

$ ./gradlew clean test

```

## Author

* [Tobias Preuss][tobias-preuss]

## License

    Copyright 2019-2024 Tobias Preuss

    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.

[jitpack-engelsystem]: https://jitpack.io/#johnjohndoe/engelsystem

[tobias-preuss]: https://github.com/johnjohndoe