README

A Laravel wrapper for fuitad/gazelle, the PHP client for the Kitsu / Zou production tracker API.

Requirements

• PHP 8.1+
• Laravel 10, 11, or 12

Installation

composer require fuitad/gazelle-laravel-wrapper

The service provider and facade are registered automatically via Laravel's package auto-discovery.

Configuration

Publish the config file:

php artisan vendor:publish --tag=gazelle-config

Then set your values in .env:

GAZELLE_HOST=https://kitsu.example.com/api
GAZELLE_SSL_VERIFY=true
GAZELLE_USE_REFRESH_TOKEN=true

Usage

Via the Facade

use GazelleLaravelWrapper\Facades\Gazelle;

// Authenticate
Gazelle::logIn('user@example.com', 'password');

// List all open projects
$projects = Gazelle::project->allOpenProjects();

// Get all shots for a project
$shots = Gazelle::shot->allShotsForProject($projects[0]);

// Log out
Gazelle::logOut();

Via dependency injection

use Gazelle\Gazelle;

class ProductionController extends Controller
{
    public function __construct(private readonly Gazelle $gazelle) {}

    public function index(): array
    {
        return $this->gazelle->project->allOpenProjects();
    }
}

Using an existing token

Gazelle::setToken('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...');

// Or with a refresh token
Gazelle::setToken([
    'access_token'  => 'eyJ...',
    'refresh_token' => 'eyJ...',
]);

MFA login

// TOTP
Gazelle::logIn('user@example.com', 'password', totp: '123456');

// Email OTP
Gazelle::sendEmailOtp('user@example.com');
Gazelle::logIn('user@example.com', 'password', emailOtp: '654321');

Available Modules

All modules are accessible as properties on the Gazelle instance (or facade):

See the fuitad/gazelle documentation for the full method reference of each module.

Testing

composer install
./vendor/bin/phpunit

License

MIT