equinox

Equinox

This shouldn't be used in any production environment, this is just a practice tool for me to learn CI/CD using Github Actions and tests in golang.

I was recommended Alex Pliutau's video on youtube and got curious about learning other things, I decided to make a client for the Riot Games API since I am more familiar with it.

I am avoiding using other packages like resty instead of the net/http package go provides to improve my golang knowledge, currently just using testify for tests.

Example

package main

import (
	"fmt"

	"github.com/Kyagara/equinox"
	"github.com/Kyagara/equinox/api"
)

func main() {
	// For custom configurations, you can use NewClientWithConfig(),
	// you will need to provide an api.EquinoxConfig{} object
	client, err := equinox.NewClient("RIOT_API_KEY")

	if err != nil {
		fmt.Println("error creating client,", err)
		return
	}

	// Get Free Champion rotation
	champions, err := client.LOL.Champion.FreeRotation(api.LOLRegionBR1)

	if err != nil {
		fmt.Println("error retrieving champions,", err)
		return
	}

	fmt.Printf("%+v\n", champions)
}

TODO

Improve tests

I am not sure if tests are 'good enough', I am just checking if errors are Nil and the response is NotNil using testify.

Sometimes an endpoint method might return a valid 404 error, for example, getting an active game by a summoner's ID, this might not find a game for a valid summoner, returning a 404. I am unsure what the best solution for this problem might be.

Improve Requests api

At the moment GET and other methods needs to go through the same function, InternalClient.Do(). It would be better to have specific functions for each http method.

Improve Logging

I don't believe the current logging and 'debugging mode' is done right or that its 'done' at all to be honest, there might be places where I should be logging something but I am not.