Freego

FreeStuff API Go Wrapper.

Description

Freego is a go package that wrapps the FreeStuff API.

Usage

Prerequisites

• Go 1.22.3 or later
• A FreeStuff API key.

Installation

First, ensure you have the Freego package installed.

go get github.com/eoussama/freego

Environment Variables

The Freego package can be configured using environment variables. Create a .env file after the .env.example file or set the following variables in your environment:

FREEGO_WEBHOOK_PORT=
FREEGO_WEBHOOK_ROUTE=
FREEGO_WEBHOOK_SECRET=
FREEGO_FREESTUFF_API_KEY=

Example

package main

import (
	"fmt"

	"github.com/eoussama/freego"
	"github.com/eoussama/freego/src/enums"
	"github.com/eoussama/freego/src/models"
)

func main() {

	config := freego.Config(&models.Options{FreestuffPartner: false})

	client, err := freego.Init(config)
	if err != nil {
		panic(fmt.Sprintf("[Init Error] %s", err))
	}

	// Pining the API
	resp_ping, err := client.Ping()
	if err != nil {
		panic(fmt.Sprintf("[Ping Error] %s", err))
	}

	// Fetching all games
	resp_games_all, err := client.GetGames(enums.FilterAll)
	if err != nil {
		panic(fmt.Sprintf("[All Games Error] %s", err))
	}

	// Fetching the free games
	resp_games_free, err := client.GetGames(enums.FilterFree)
	if err != nil {
		panic(fmt.Sprintf("[Free Games Error] %s", err))
	}

	// Fetching the approved games
	resp_games_approved, err := client.GetGames(enums.FilterApproved)
	if err != nil {
		panic(fmt.Sprintf("[Approved Games Error] %s", err))
	}

	// Fetching game info for the fetched free games, which localizations for french and german
	resp_game_info, err := client.GetGameInfo(resp_games_free, []string{"fr-FR", "de-DE"})
	if err != nil {
		panic(fmt.Sprintf("[Game Info Error] %s", err))
	}

	fmt.Println("ping:", resp_ping)
	fmt.Println("all games:", len(resp_games_all))
	fmt.Println("free games:", len(resp_games_free))
	fmt.Println("approved games:", len(resp_games_approved))

	for i, game_info := range resp_game_info {
		fmt.Println("game details info", i, ":", game_info)
	}

	// Event subscription
	go func() {
		err = client.On(enums.EventFreeGames, func(e *models.Event, err error) {
			if err != nil {
				panic(fmt.Sprintf("[On Free Games Error] %s", err))
			}

			fmt.Println("on free games", e.Data)
		})

		if err != nil {
			panic(fmt.Sprintf("[On Free Games Error] %s", err))
		}
	}()
	select {}
}

Testing

Webhook

For local testing, the project comes with a Docker image that's already set up with smee for convenient event reception.

./smee.sh <smee_url> <local_port>