README

Laravel integration for SpurRoute — webhook ingest, retry, replay and fan-out infrastructure.

Status: early scaffold. The client surface is a stub today; the real API (ingest, retry, replay, fan-out) is being filled in. The package is installable, auto-discoverable and ready to grow.

Requirements

• PHP ^8.2
• Laravel ^12.0 or ^13.0

Installation

composer require spurroute/laravel

The service provider and the SpurRoute facade are registered automatically via Laravel package discovery.

Configuration

Publish the configuration file:

php artisan vendor:publish --tag="spurroute-config"

This creates config/spurroute.php. Set your credentials in .env:

SPURROUTE_API_KEY=your-api-key
# Optional — defaults to https://spurroute.dev
SPURROUTE_BASE_URL=https://spurroute.dev

Usage

The client is currently a stub. ping() is a placeholder that always returns true; real endpoints are coming.

Resolve the client from the container:

use SpurRoute\Laravel\SpurRoute;

$spurroute = app(SpurRoute::class);

$spurroute->ping(); // true (stub)

Or use the facade:

use SpurRoute\Laravel\Facades\SpurRoute;

SpurRoute::ping(); // true (stub)

You may also type-hint SpurRoute\Laravel\SpurRoute anywhere the container resolves dependencies (controllers, jobs, commands, …).

Testing

composer test

Code style

This package uses Laravel Pint:

composer lint    # check only
composer format  # apply fixes

License

The MIT License (MIT). See LICENSE for details.