Repository files navigation

The New Motion implementation of common endpoints of the OCPI protocol.

Seehttp://github.com/ocpi/ocpi

To make clear when the parameters are about the application making use of the application or the party the application isconnecting to they are referred as:our/us ortheirs/them

See the example app in the example folder. You can run it with sbt by typingproject example followed byrun.Once running you can make version requests with

curl -X GET -H "Authorization: Token abc" "http://localhost:8080/example/versions"

You can use either Circe (recommended) or Spray-Json for (de)serialization of JSON

In build.sbt

libraryDependencies += "com.thenewmotion.ocpi" %% s"ocpi-msgs-circe" % "<version>"

Then in the route or client you want to use

import com.thenewmotion.ocpi.msgs.circe.v2_1.protocol._

In build.sbt

libraryDependencies += "com.thenewmotion.ocpi" %% s"ocpi-msgs-spray-json" % "<version>"

Then in the route or client you want to use

import com.thenewmotion.ocpi.msgs.sprayjson.v2_1.protocol._

To be able to pass IO as the effect type, import marshaller instances for it:

import com.thenewmotion.ocpi.common.HktMarshallableInstances._

Migrate effect type to cats-effect IO.At the core, we still use akka-http for routes and clients so we need the typical akka implicits.Stream sources are also still using akka-stream.But at the interface to the backend services implemented by the calling application code, IO (or ZIO) can beused to model effect types.

In the following phases, we should migrate further to http4s, sttp (?) and fs2.

• allow passing of page limit from client code
• increase unmarshalling timeout to handle higher page sizes
• handle omitted.data field (when a list is expected but its empty)

• fix parsing of time without leading zeros; 2nd try

• Don't log credentials during registration
• fix parsing of time without leading zeros
• handle missingtwentyfourseven field inhours object

Redact auth header before logging request

Update to Circe 0.12.3

Update dependencies

Bugfix so that users of the CommandClient do not need to provide a JSON deserializer that can handle Either

• Make commands module compatible with OCPI 2.1.1-d2

• Pass the requester's globalPartyId to MspTokenService methods
• Stop passing the ExecutionContext from Routes into Services in some cases

• Require non empty ids
• Improved Generic merging or patches using Shapeless
• Validation for Latitude and Longitude

• Tokens Client for CPO Tokens module
• Don't include akka-http-spray-json anymore, as spray json is optional

• Many of the modules have a method such as createOrUpdate*, this method used to take both an id from the urland an object.Now, they only take an object, and the validation that the id of the url and and the id fromthe object are validated by the library
• Remove the id fields from the Patch object, as the id cannot be changed

• Added Sessions module
• When using a route or a client, you will need to import the Circe or Spray Json modules, as above
• You no longer need to usenew to create a route, each one has a companion object, and then the route can beused directly instead of having to use the.route method. See the ExampleApp.
• Many of the services previously had methods returningFuture[Either[SessionError, Boolean]] whereaRight(true) meant the record has been updated and aRight(false) meant it was updated. This hasbeen replaced byRight(Created) andRight(Updated)