compress-php

Libreria PHP di HiWay Media per l'API Compress (https://api-compress.hiway.media/api/v4.0): encoding video (upload → VOD), restreamer live (HLS/push/pull), categorie, eventi e credenziali S3 per cliente.

⚠️ Stato: work in progress — non usabile

Questo repo è oggi uno scheletro: non c'è client HTTP, nessun endpoint è implementato, il codice presente non è PHP valido e il pacchetto non è su Packagist. L'implementazione di riferimento funzionante è il SDK Go compress-go.

Stato dettagliato, difetti e ordine di lavoro: docs/status.md.

Documentazione

docs/README.md	indice della documentazione
docs/status.md	stato reale del repo e parità con compress-go
docs/architecture.md	layer, autenticazione, flusso di upload
docs/endpoints.md	catalogo degli endpoint dell'API Compress v4.0
docs/api-reference.md	superficie pubblica attesa del SDK PHP
docs/development.md	setup, test, CI, rilasci

Installazione

Non ancora su Packagist — va aggiunto il repository VCS:

{
    "repositories": [
        { "type": "vcs", "url": "https://github.com/HiWay-Media/compress-php" }
    ],
    "require": { "compress-php/compress": "dev-main" }
}

Uso (API di destinazione, non ancora implementata)

use HiWay\Compress\Compress;

$compress = new Compress(
    customerName: getenv('COMPRESS_CUSTOMER_NAME'),
    apiKey:       getenv('COMPRESS_API_KEY'),
    debug:        false,
);

$categories  = $compress->getCategories();
$restreamers = $compress->getRestreamers(0, 20);

Firme complete in docs/api-reference.md.

Contribuire

1. Branch di feature o bugfix.
2. Il porting parte sempre dal corrispettivo in compress-go (fonte di verità dell'API).
3. Test PHPUnit con HTTP mockato — mai chiamate all'API di produzione.
4. Riga nel CHANGELOG.md e documentazione aggiornata nello stesso commit.

Regole operative complete — anche per gli agent AI — in AGENTS.md e CLAUDE.md.

Licenza

MIT — vedi LICENSE.