sncf.SncfOpenDataClient.kt Maven / Gradle / Ivy

Go to download
/*
 *  This file is part of the tock-bot-open-data distribution.
 *  (https://github.com/theopenconversationkit/tock-bot-open-data)
 *  Copyright (c) 2017 VSCT.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see .
 */

package ai.tock.bot.open.data.client.sncf

import com.fasterxml.jackson.databind.module.SimpleModule
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer
import ai.tock.bot.open.data.OpenDataConfiguration
import ai.tock.bot.open.data.client.sncf.model.Journey
import ai.tock.bot.open.data.client.sncf.model.Place
import ai.tock.bot.open.data.client.sncf.model.PlaceValue
import ai.tock.bot.open.data.client.sncf.model.SncfPlace
import ai.tock.bot.open.data.client.sncf.model.StationStop
import ai.tock.bot.open.data.client.sncf.model.VehicleJourney
import ai.tock.shared.addJacksonConverter
import ai.tock.shared.create
import ai.tock.shared.jackson.addDeserializer
import ai.tock.shared.jackson.addSerializer
import ai.tock.shared.jackson.mapper
import ai.tock.shared.retrofitBuilderWithTimeoutAndLogger
import mu.KotlinLogging
import okhttp3.Credentials
import okhttp3.Interceptor
import java.time.LocalDateTime
import java.time.format.DateTimeFormatter


/**
 *
 */
object SncfOpenDataClient {

    private val logger = KotlinLogging.logger {}
    private val dateFormat = DateTimeFormatter.ofPattern("yyyyMMdd'T'HHmmss")

    private val api: SncfOpenDataApi =
        retrofitBuilderWithTimeoutAndLogger(
            30000,
            logger,
            interceptors = listOf(Interceptor { chain ->
                chain.proceed(
                    chain.request()
                        .newBuilder()
                        .header("Authorization", Credentials.basic(OpenDataConfiguration.sncfApiUser, ""))
                        .build()
                )
            })
        )
            .baseUrl("https://api.sncf.com/v1/coverage/sncf/")
            .addJacksonConverter(
                mapper.copy().registerModule(
                    SimpleModule()
                        .addDeserializer(LocalDateTime::class, LocalDateTimeDeserializer(dateFormat))
                        .addSerializer(LocalDateTime::class, LocalDateTimeSerializer(dateFormat))
                )
            )
            .build()
            .create()

    fun findPlace(name: String): PlaceValue? {
        return bestPlaceMatch(name)?.let { PlaceValue(it) }
    }

    fun places(query: String): List {
        return api.places(query).execute().body()?.places ?: emptyList()
    }

    fun bestPlaceMatch(query: String): SncfPlace? {
        val p = places(query)/*.sortedByDescending { it.quality }*/.firstOrNull()
        return if (p != null && p.embeddedType != "stop_area") {
            api.placesNearby(p.id)
                .execute()
                .body()
                ?.places
                ?.run {
                    firstOrNull { it.embeddedType == "stop_area" }
                            ?: firstOrNull()
                }
        } else {
            p
        }
    }

    fun journey(from: Place, to: Place, datetime: LocalDateTime): List {
        return api.journeys(from.id, to.id, dateFormat.format(datetime)).execute().body()?.journeys ?: emptyList()
    }

    fun departures(from: Place, datetime: LocalDateTime): List {
        return api
            .departures(from.id, dateFormat.format(datetime))
            .execute()
            .body()
            ?.departures
                ?: emptyList()
    }

    fun arrivals(from: Place, datetime: LocalDateTime): List {
        return api
            .arrivals(from.id, dateFormat.format(datetime))
            .execute()
            .body()
            ?.arrivals
                ?: emptyList()
    }

    fun vehicleJourney(id: String): VehicleJourney? {
        return api.vehicleJourneys(id).execute().body()?.vehicleJourney?.firstOrNull()
    }
}