capofcave / lichess4j

♟ A java wrapper for the https://lichess.org/ api

Hi there 👋

I'm Lars, a passionate software developer currently working as a Full Stack Software Engineer at Atruvia AG.

---

• 🔭 I’m currently learning DevOps and programming languages that are not Java
• 🔧 I’m also working on cuberdle, a wordle-inspired Rubik's Cube game written in plain Javascript Typescript.
• 📫 How to reach me:
  • Telegram: @larskecker
  • Email: [email protected]
  • Discord: CapOfCave#5962

---

lichess4j's Issues

Add jitpack instructions to README

The current installation guide is highly impractical. It should be replaced with an alternative using a public package repository like https://jitpack.io/

Specify Codecov requirements

With a test coverage pf almost 100%, codecov will fail as soon as a single instruction is missed in the tests.
A test coverage of 95-99% should be enough and a more reasonable balance of code quality and required resources.

This number should be enforced and displayed through a codecov.yml file

Add end-to-end tests

For each method from the public API, there should be one test case:

• Mock the HTTP request, returning data from a json file that was copyed from the official api docs. (For file reading, the existing FileReaderUtil can be used.)
• call the method that should be tested
• verify that the result equals the result returned from the relevant TestProvider

Create a default value for the Title enum

When mapping an Account without title, null is returned. This should be replaced by the null object Title.NONE.

A generalized solution should be preferred since there will probably be more enums that should have a default value.

Make the API usable without a lichess api token

Many of the features of the lichess api are accessible without authorization
(see https://lichess.org/api#tag/OAuth for a complete list of endpoints that require authorization)

As such, the bearer Token should be nullable. In order to achieve that, any @nonnull annotations should be removed. Additionally, the HttpRequestFactory should not append the Authorization header if the bearerToken is null.