Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 4.33 KB

README.md

File metadata and controls

114 lines (82 loc) · 4.33 KB
Raw

Lamassu

CircleCI Quality Gate Status Github Workflow

Mobility aggregation service based on the General Bikeshare Feed Specification (GBFS).

Configuration

resources/feedproviders.yml lists GBFS feeds which will be polled by this application:

    lamassu:
        providers:
          - systemId: mysystem
            operatorId: MFM:Operator:myoperator
            operatorName: My operator
            codespace: MFM
            url: https://myfavoritegbfsfeeed.com/gbfs.json
            language: en

This will use the GBFS auto-discovery at url and poll en language feeds.

NOTE: codespace is relevant when aggregating entities across systems, to avoid conflicts between IDs. Every ID (except systemId, which (by GBFS convention) should already be globally unique) is prefixed by this codespace. At least every operator should be assigned its own unique codespace, assuming operators already maintain data / ID separation accross their feeds. The codespaced operatorId should comply with the following format <codespace>:Operator:<operator>.

Configuring Authentication

Some providers may require authentication, e.g. via bearer token, OAuth2 or custom http-headers.

lamassu:
    providers:
      - systemId: my_oauth2_secured_system
        authentication:
            scheme: OAUTH2_CLIENT_CREDENTIALS_GRANT
            properties:
                tokenUrl: "https://mytokenurl.example/"
                clientId: my-client-id
                clientPassword: my-client-password
                scope: optional-scope
        ...
      - systemId: my_bearer_secured_system
        authentication:
            scheme: BEARER_TOKEN
            properties:
                accessToken: my-access-token
        ...
      - systemId: my_http_headers_secured_system
        authentication:
            scheme: HTTP_HEADERS
            properties:
                x-client-id: my-client-id 
                # you can use a system variable or an environment variable here
                x-api-key: ${my-systemproperty-provided-secret-api-key}
        ...

Note: Keep in mind you should be cautious about storing your credentials in plain text ! Instead of providing credentials in the feedproviders.yml, it might be more appropriate to provide them via ENV variables/system properties.

End-points

/gbfs

List all GBFS feeds available via this API

/gbfs/{system}/{feed}

GBFS feeds for a specific feed system:

E.g.

/gbfs/boltoslo/free_bike_status

will return the free_bike_status feed for Bolt's scooter service in Oslo.

/graphql

GraphQL endpoint targeted at end-user clients. Documentation can be explored at /graphiql.

GBFS v3.0

Please note that GBFS v3.0 is still not official, but is in release candidate mode. The latest release candidate (v3.0-RC2) is expected to become official soon.

Consuming

Lamassu supports consuming v3.x. The version has to be marked in the feedprovider config, e.g.:

- systemId: testozon
  operatorId: OZO:Operator:testozon
  operatorName: Ozon
  url: http://test.com/gbfs
  version: 3.0-RC2
  codespace: OZO
  language: en

Producing

Lamassu produces v3.0-RC2 feeds under a beta-url: /gbfs/v3beta/manifest.json. manifest.json replaces the proprietary system discovery endpoint, which will be deprecated when v3.0 is official. At the same time, the endpoint for v3 will be moved from v3beta to a yet-to-be-determined path.

Development

Requires a locally running redis instance. E.g.:

docker run -p 127.0.0.1:6379:6379 -d redis redis-server

Codestyle

Lamassu uses Prettier Java. Use mvn prettier:write to reformat code before pushing changes. You can also configure your IDE to reformat code when you save a file.