andmos / bikeshareclient Goto Github PK

https://github.com/dotnet/sourcelink

Example:

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

ignore:
  - test      # - tests

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

public Client(string gbfsBaseUrl, HTTPClient httpClient = null) or something to avoid breaking changes in the client.

There is no description on the NuGet package. Let's add one.

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

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.

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

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

We need to mesure code coverage.

Need to update the BikeStatus model to support is_reserved and is_disabled.

https://github.com/NABSA/gbfs/blob/v2.0/gbfs.md

See if

Change boolean from 1/0 to true/false

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

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]

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.

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

Publish NuGet package to nuget.org

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 😅

The default dependabot "happy path" takes one csproj. Create a config also including the test-project.

After GBFS update: MobilityData/gbfs@44c8688

MobilityData/gbfs#188