andmos / bikeshareclient Goto Github PK

5.0 4.0 1.0 263 KB

C# client for General Bikeshare Feed Specification (GBFS)

License: MIT License

C# 99.10% Dockerfile 0.90%

gbfs bikeshare-systems bikeshare netstandard

bikeshareclient's Introduction

BikeshareClient

Dotnet client for the General Bikeshare Feed Specification (GBFS). Mainly used against Urban Infrastructure Partner, with Trondheim City Bike and Bergen City Bike.

For all available GBFS systems, see the system overview from the GBFS project.

Supports the required fields in the GBFS standard for now.

Basic Usage

// Create the client from a GBFS API URL.
IBikeshareClient client = new Client("http://gbfs.urbansharing.com/trondheim/gbfs.json");

// Or with an existing HTTPClient
IBikeshareClient client = new Client("http://gbfs.urbansharing.com/trondheim/gbfs.json", httpClient);

// All available stations, containing name, id, lat, long, address and capacity
var stations = await client.GetStationsAsync();

// All stations status, containing number of bikes and docks available, is renting, is returning etc.
var statuses = await client.GetStationsStatusAsync();

A simple dotnet-script test script for the client can be seen here.

Microsoft.Extensions.DependencyInjection integration

BikeshareClient can be registered to IServiceCollection by referencing the BikeshareClient.DependencyInjection NuGet package:

using BikeshareClient.DependencyInjection;
using Microsoft.Extensions.DependencyInjection;

services.AddBikeshareClient("http://gbfs.urbansharing.com/trondheim/gbfs.json");

Build and testscript

Simple build:

docker run --rm -it -v $(pwd):/app mcr.microsoft.com/dotnet/sdk:7.0 dotnet pack app/src/BikeshareClient -o /app

Run test script:

docker run --rm -it -v $(pwd)/src/TestScript/:/scripts  andmos/dotnet-script main.csx "Skansen"

GBFS is a standard backed by the North American Bike Share Association (NABSA).

bikeshareclient's People

Contributors

Stargazers

Watchers

Forkers

ericsellers

bikeshareclient's Issues

Improve documentation in README

Some example code in the README demonstrating how to use the client would be nice.

Even if it is as simple as creating a client and providing a url 😅

Better error if manditory APIs is not implementet

If any mandatory endpoints is not implemented (like bike_status) And the consumer calls the method for that endpoint, throw better exception.

Implement versioning field

After GBFS update: MobilityData/gbfs@44c8688

MobilityData/gbfs#188

Use JSONConverter from int to bool

is_installed, is_renting, is_returning etc. Can be converted from int to bool for better flow.

Handle GBFS.json

The GBFS standard has a GBFS.json file that returns available feeds. The client should use this file, not just baseurl.

Add sourcelinker for better debugging

https://github.com/dotnet/sourcelink

Add codecoverage

We need to mesure code coverage.

Create Microsoft.Extensions.DependencyInjection extention for client

It would be great to publish an BikeshareClient.Aspnet or something that implements

    public static class ServiceCollectionExtensions
    {
        public static IHttpClientBuilder AddBikeshareClient(this IServiceCollection services)
            => services.AddHttpClient<IClient, BikeshareClient>();
    }

As long as the client has a HTTPClient this should be rather straight forward.

Improve debug experience for users

Annotate the model types so that debugging is easier. The name of the class is of little use while debugging a list.

API doc

Publish Nuget package

Publish NuGet package to nuget.org

Use `.codecov.yml` file for codecov, makes it checked in.

Example:

coverage:
  status:
    project:
      default:
        # basic
        target: auto
        threshold: 0%

ignore:
  - test      # - tests

Add README to NuGet package to be complient with NuGet.org best practices

https://learn.microsoft.com/en-us/nuget/create-packages/package-authoring-best-practices#readme

Dependabot couldn't find a <anything>.(cs|vb|fs)proj for this project

Dependabot couldn't find a .(cs|vb|fs)proj for this project.

Dependabot requires a .(cs|vb|fs)proj to evaluate your project's current .NET dependencies. It had expected to find one at the path: /<anything>.(cs|vb|fs)proj.

If this isn't a .NET project, or if it is a library, you may wish to disable updates for it from within Dependabot.

View the update logs.

Make DTOs and model objects truly readonly

Rewrite xUnit tests to remove warnings

After upgrading xUnit package, a couple of warnings shows up. The tests should be rewritten anyways, since some of the assert-usage is pointless in the first place.

TestBikeShareClient.cs(246,13): warning xUnit2002: Do not use Assert.NotNull() on value type 'DateTime'. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(258,13): warning xUnit2002: Do not use Assert.NotNull() on value type 'DateTime'. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(261,13): warning xUnit2002: Do not use Assert.NotNull() on value type 'int'. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(263,13): warning xUnit2002: Do not use Assert.NotNull() on value type 'int'. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(265,13): warning xUnit2002: Do not use Assert.NotNull() on value type 'int'. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(221,13): warning xUnit2012: Do not use Enumerable.Any() to check if a value exists in a collection. [/app/TestBikeshareClient/TestBikeshareClient.csproj]
TestBikeShareClient.cs(235,13): warning xUnit2012: Do not use Enumerable.Any() to check if a value exists in a collection. [/app/TestBikeshareClient/TestBikeshareClient.csproj]

Change boolean from 1/0 to true/false

Can be supported without a breaking changes, support both formats etc.