willis84 / socialite-ravelry

dev-main 2026-09-13 03:37 UTC

Requires

• php: ^8.3
• guzzlehttp/guzzle: ^7.10|^8.2
• illuminate/support: ^13.0
• laravel/socialite: ^5.31

Requires (Dev)

• laravel/pint: ^1.32

MIT

• oauth2
• laravel
• socialite
• ravelry

Published on Packagist.org on 2026-09-13 03:38 UTC

README

Installation

Requires Laravel 13 and PHP 8.3 or later.

composer require willis84/socialite-ravelry

Add your Ravelry credentials to your config/services.php array / .env file

    'ravelry' => [
        'client_id' => env('RAVELRY_CLIENT_ID'),
        'client_secret' => env('RAVELRY_CLIENT_SECRET'),
        'redirect' => env('RAVELRY_REDIRECT_URI'),
    ],

Add the service provider to your bootstrap/providers.php file

return [
    // ...
    SocialiteRavelry\ServiceProvider::class
];

Use the driver as follows

$socialite = Socialite::driver('ravelry');

// get the redirect request to authenticate
$socialite->scopes(['offline'])->redirect();

// get the user when the user has approved your connection
$user = $socialite->user();

// refresh the oauth2 token, fetch the refresh token from your database
$socialite->scopes(['offline'])->refreshToken($refreshToken);

Please note, Ravelry does not provide the users email address, and in order to get the refresh token you will need to request the offline scope. Pass additional scopes as separate array entries: $socialite->scopes(['offline', 'patternstore-read']).

Many thanks to Cassidy at Ravelry for all her help in understanding the Ravelry Oauth2 flow.

Ravelry API documentation can be found at www.ravelry.com/api