Skip to content

Latest commit

 

History

History
238 lines (163 loc) · 7.84 KB

CHANGELOG.md

File metadata and controls

238 lines (163 loc) · 7.84 KB
Raw

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

More infos about this file : http://keepachangelog.com/

[v4.0.0] - 2020.01.22

  • Update dependencies.
  • The cache key is now generated from a given function, as input of DistanceApi.

[v3.0.4] - 2019.11.12

  • Fix for GoogleDistanceProvider: stop adding the traffic duration to the default duration: consider it as a full travel duration value and not only the in-traffic offset.
  • Update dependencies:
    • Monix 3.1.0
    • Squants 1.5.0
    • scalafmt-core 2.2.2
    • scalacheck 1.14.2

[v3.0.3] - 2019.11.06

  • Fix for Google Geoprovider: using address parameter instead of components for postal code geocoding to succeed in some not working cases.
  • Update minor dependencies.

[v3.0.2] - 2019.10.17

  • Fix: the no-cache module was throwing an exception on methods besides cachingF.

[v3.0.1] - 2019.10.09

  • Fix: cache was not read any more on single distance calls.

[v3.0.0] - 2019.09.16

  • Update dependencies
    • cats 2.0.0 : Bring breaking changes. Please refer to the cats' documentation
    • cats-effect 2.0.0
    • circe 0.12.1
    • circe-optics 0.12.0
    • monix 3.0.0 : Used only in tests

[v2.0.0] - 2019.09.05

  • Add Cache methods:
    • caching: like cachingF but with an input value V instead of a wrapped value F[V].
    • get: retrieve the value wrapped as a F[Option[V]].
    • remove: remove a key from the cache, returns F[Unit]. Used in the tests only.
    • removeAll: remove all keys from the cache, returns F[Unit]. Was used before in the tests, but is replaced now with removed.
  • DistanceApi now returns Maps of values Either[E, Distance] (previously Distance) to embed errors related to the distance computation (e.g. no route available). The error type has to be specified and is related to the distance provider. It also supports batched calls for distances (taking as input multiple origins and destinations), and tries to make as few calls as possible, depending on the already cached values. This involves the following changes:
    • Add arguments to DistanceApi
      • Caching[F, Distance] which is an alias for (Distance, Decoder[Distance], Encoder[Distance], Any*) => F[Distance].
      • GetCached[F, Distance] which is an alias for (Decoder[Distance], Any*) => F[Option[Distance]].
    • Remove CachingF[F, Distance] argument from DistanceApi.
    • Add type parameter to DistanceApi: it is now DistanceApi[F[_]: Async: Par, E].
    • Add batchDistances method to DistanceApi and GoogleDistanceProvider.
    • Add Google error type GoogleDistanceProviderError (plus implementations). GoogleDistanceProvider now extends as DistanceProvider[F, GoogleDistanceProviderError].

[v1.1.0] - 2019.08.26

  • Add a function to GoogleGeoApiContext to handle logging of HTTP calls from Google Maps with OkHttpLoggingInterceptor.
  • Complete the Google traffic estimation models with optimistic and pessimistic models. Modify the maybeDepartureTime argument to a Option[TrafficHandling] which is composed of the departure time (Instant) and of the traffic model (TrafficModel), everywhere maybeDepartureTime was used.
  • Add .asGoogle helper method to convert scala-distances types (LatLong, TrafficModel, TravelMode) to Google types.
  • Update some dependencies (notably cats-effect 1.4.0, google-maps-services 0.9.4).

[v1.0.2] - 2019.07.19

  • Fix on the Google Maps response when the departureTime argument was specified: the API response was not properly taken into account.

[v1.0.1] - 2019.06.11

  • DistanceApi now takes an optional argument departureTime which specifies when the vehicle will commit the travel. This is argument is transmitted to Google Maps API to retrieve the time passed in traffic, if specified and available. Warning: specifying this argument results in a API call cost doubled, at the time of writing.

[v1.0.0] - 2019.06.04

Breaking changes:

  • Rename package to com.colisweb.distances.
  • DistanceApi[F] now takes as inputs distance and caching functions instead of provider instances.

Others

  • Update dependencies (cats-effect 1.3.0, circe 0.11.0)

[v1.0.0-RC6] - 2018.11.23

(versions v1.0.0-RC[3,4,5] are corrupted. Do not use them)

Breaking changes:

  • Modularize the lib
Intro

The lib is now composed of 3 parts:

  • the core
  • the providers
  • the caches
Providers

Providers have 2 roles:

  • Compute distances between Gps points
  • Geocode addresses

A prodider implementation can choose to implement only one of these 2 concers.

Fow now, we propose only one provider implementation, based on Google APIs, which addresses the 2 concerns.

Caches

We propose 3 cache implementations:

  • One "distributed" cache, based on Redis
  • One in memory cache, based on Caffeine
  • One which doesn't cache anything.

Others:

  • Google API calls should be cancelable
  • Improve GoogleDistanceProvider code, error handling and error reporting
  • Improve GoogleGeoProvider code, error handling and error reporting
  • Update dependencies (Monix 3.0.0-RC2, Cats 1.4.0, Cats-Effect 1.0.0)
  • Replace sbt-release-early by sbt-release

[v1.0.0-RC2] - 2018.05.16

Breaking changes:

  • Fix english naming: Ambigue -> Ambiguous

Others:

  • DistanceApi#distances method should also accept Arrays
  • Some small optimisations

[v1.0.0-RC1] - 2018.05.14

Breaking changes:

  • New API
  • The API is now generalized for any effect system that implements the cats-effect Async and Parallel typeclasses

Others:

  • Use sbt-tpolecat plugin instead of our manually defined scalac options
  • Change used scalafmt plugin
  • Update Scala 2.12 version

[v0.5.3] - 2018.04.26

  • Update Scala 2.12 version
  • Update dependencies

[v0.5.2] - 2018.02.14

  • Improve how GoogleGeocoder.geocodeNonAmbigueAddressT retrieves geocoding

WARNING: Read the method documentation before using it !

  • Add tests for GoogleGeocoder.geocodeNonAmbigueAddressT

[v0.5.1] - 2018.02.12

  • [HOTFIX] The new Distance API implementation was bugged
  • Add some tests for the Distance API

[v0.5.0] - 2018.02.12

  • Use the global monix Scheduler instead of our own badly crafted one
  • Update libs
  • Add the possibility to geocode non ambigue addresses
  • Handle travel modes

[v0.4.0] - 2018.01.19

  • Distance ordering should not be hard coded

[v0.3.1] - 2018.01.19

  • Small optimisation: Do not call the geocoder if origin == destination

[v0.3.0] - 2018.01.18

  • Simplify types thanks to type aliases
  • Small optimization: Small optimization: if origin == destination, immediately return a distance to 0
  • Small optimisation: Call the geocoder only once if origin == destination

[v0.2.3] - 2018.01.18

  • FIX: Distances should be compared by their durations and not by their lenghts
  • Improve scalacOptions config
  • Update dependencies

[v0.2.2] - 2017.12.12

  • Add the possibility to tune the database used in Redis without any password

[v0.2.1] - 2017.12.12

  • Add the possibility to tune the database used in Redis

[v0.2.0] - 2017.12.12

  • Simplify the use of the library
  • Add the possibility to use a Redis protected by password
  • Add the possibility to tune the connection and the read timeouts of the Google Geo API client

[v0.1.3] - 2017.12.12

  • Try fix build

[v0.1.2] - 2017.12.12

  • Try fix build by adding scmInfo

[v0.1.1] - 2017.12.12

  • Try fix build

[v0.1.0] - 2017.12.03

  • Configure Codecov
  • Configure sbt-release-early, Travis and Bintray intergration
  • Open source the library