hotsaucejake / laravel-sleeper
An API wrapper for the fantasy sleeper app
v1.0.0
2022-12-15 17:54 UTC
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.5
- illuminate/contracts: ^9.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0
- orchestra/testbench: ^7.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpunit/phpunit: ^9.5
- vlucas/phpdotenv: ^5.5
This package is auto-updated.
Last update: 2024-05-09 19:41:41 UTC
README
Installation
You can install the package via composer:
composer require hotsaucejake/laravel-sleeper
Usage
use HOTSAUCEJAKE\LaravelSleeper\Facades\LaravelSleeper; /** * ==================================== * User * ==================================== */ LaravelSleeper::getUserByName('SLEEPER_USERNAME'); LaravelSleeper::getUserById('SLEEPER_USER_ID'); /** * ==================================== * Avatars * ==================================== */ LaravelSleeper::showAvatar('SLEEPER_AVATAR_ID'); LaravelSleeper::showAvatarThumbnail('SLEEPER_AVATAR_ID'); /** * ==================================== * Leagues * ==================================== */ LaravelSleeper::getAllLeaguesForUser('SLEEPER_USER_ID', 2022); LaravelSleeper::getLeague('SLEEPER_LEAGUE_ID'); LaravelSleeper::getLeagueRosters('SLEEPER_LEAGUE_ID'); LaravelSleeper::getLeagueUsers('SLEEPER_LEAGUE_ID'); LaravelSleeper::getLeagueMatchups('SLEEPER_LEAGUE_ID', 1); LaravelSleeper::getLeaguePlayoffWinnersBracket('SLEEPER_LEAGUE_ID'); LaravelSleeper::getLeaguePlayoffLosersBracket('SLEEPER_LEAGUE_ID'); LaravelSleeper::getLeagueTransactions('SLEEPER_LEAGUE_ID', 1); LaravelSleeper::getLeagueTradedPicks('SLEEPER_LEAGUE_ID'); LaravelSleeper::getSportState(); /** * ==================================== * Drafts * ==================================== */ LaravelSleeper::getDraftsForUser('SLEEPER_USER_ID', 2022); LaravelSleeper::getLeagueDrafts('SLEEPER_LEAGUE_ID'); LaravelSleeper::getSpecificDraft('SLEEPER_DRAFT_ID'); LaravelSleeper::getDraftPicks('SLEEPER_DRAFT_ID'); LaravelSleeper::getDraftTradedPicks('SLEEPER_DRAFT_ID'); /** * ==================================== * Players * ==================================== */ LaravelSleeper::getAllPlayers(); LaravelSleeper::getTrendingPlayers('add'); LaravelSleeper::getTrendingPlayers('drop');
Testing
In order to run the package tests you must create an .env
file from the .env.example
file. Tests will use the live endpoints. Since it's under the API rate limit, it's ok for now. I don't think this package will get any bigger than it already is so no need for mocks, etc...
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.