maksatsaparbekov / kuleshov-auth
A Laravel package for integrating with external authentication services.
Requires
- awobaz/compoships: ^2.2
README
Пакет для Laravel, предназначенный для интеграции с внешними сервисами аутентификации, обеспечивающий бесперебойную синхронизацию с системами третьих сторон для входа в систему и регистрации пользователей, используя специальные токены для безопасного доступа.
Установка
Через Composer:
composer require maksatsaparbekov/kuleshov-auth:dev-main
php artisan vendor:publish --provider="Maksatsaparbekov\KuleshovAuth\KuleshovAuthServiceProvider" --tag=config --force
в вашем локальном каталоге config будет создан файл kuleshov-auth.php. Вы можете изменять параметры конфигурации в этом файле для настройки поведения пакета KuleshovAuth в соответствии с вашими требованиями.
Файл конфигурации содержит следующие ключевые параметры:
url - URL-адрес, который используется пакетом для выполнения внешних запросов. По умолчанию установлено значение https://example.com. security_key - Ключ безопасности, используемый для подписи запросов или для других целей безопасности. Значение по умолчанию - your-security-key. policies - Здесь вы можете указать классы политик, которые будут использоваться для авторизации действий в вашем приложении. chat_room - Укажите свой собственный класс политики для чат-комнат. observers - В этом разделе вы можете указать наблюдателей (observers), которые будут реагировать на различные события в приложении. chat_room_message - Укажите свой класс наблюдателя для сообщений в чат-комнатах. routes - Настройки, связанные с маршрутизацией, включая промежуточное ПО (middleware), применяемое к маршрутам пакета. middleware - Массив промежуточного ПО, которое будет применяться к маршрутам. По умолчанию включает auth.access_token и resolveModel.
Установите детали вашего сервиса третьей стороны в вашем .env:
KULESHOV_AUTH_URL=https://example.com/api KULESHOV_AUTH_SECURITY_KEY=SECURITY
##Использование Чтобы избежать конфликтов с трейтом HasApiTokens Sanctum в вашей модели User при интеграции с пакетом Kuleshov Auth, вы можете просто закомментировать или удалить трейт HasApiTokens, если он не нужен для функциональности вашего приложения. Вместо этого вы будете использовать трейт AuthService, предоставляемый Kuleshov Auth, для обработки аутентификации. Для использования AuthService в вашей модели User:
use Maksatsaparbekov\KuleshovAuth\Traits\AuthService;
class User extends Authenticatable { // use HasApiTokens use AuthService; }
Миграции
Выполните миграции для создания необходимых таблиц:
php artisan migrate
Последний шаг - использование событий модели Eloquent:
используйте
$user = User::where('phone', $phone)->first(); $user->update([ 'password' => Hash::make($password), ]);
вместо использования метода update напрямую на результате запроса: $user = User::where('phone', $phone)->update([ 'password' => Hash::make($password), ]);
Этот подход предпочтительнее, так как он позволяет сначала извлечь экземпляр модели, а затем обновить его. Это важно, потому что таким образом запускаются события модели Eloquent, такие как saving, saved, updating, и updated, что не происходит при использовании второго подхода.
Chats
Если вы хотите получить более подробную документацию, вы можете сгенерировать документацию Swagger для вашего проекта. Установите (composer require "darkaonline/l5-swagger") и настройте согласно документации. Откройте файл l5-swagger.php и добавьте следующие строки:
'annotations' => [
base_path('vendor/maksatsaparbekov/kuleshov-auth/src/Http/Controllers'), // добавьте это
base_path('vendor/maksatsaparbekov/kuleshov-auth/src/Models'), // добавьте это],
use Chattable; <-добавьте это внутри модели
Модель, к которой вы применяете трейт, должна быть логически способна участвовать в обмене сообщениями.
Например, модель Application может быть чатабельной.
Этот подход позволяет модели заранее загружать связанные данные,
такие как чат-комнаты, используя метод Eloquent Laravel with().
Например, Model::with('chatRooms') извлекает список всех чат-комнат, связанных с моделью, в то время как Model::with('senderChatRoom') получает чат-комнату, созданную аутентифицированным пользователем для данной модели.
Метод getTitleAttribute
Этот метод возвращает название чата.
Описание
Метод getTitleAttribute используется для получения названия чата из модели chattable. Если у вас есть собственный атрибут car_title, он будет использоваться для возврата названия чата. В противном случае будет использован атрибут по умолчанию.
Пример использования
public function getTitleAttribute() { if ($this->chattable->car_title){ return $this->chattable->car_title; } return $this->chattable?->car_title; }
Метод getTitleAttribute
Этот метод возвращает название чата.
Описание
Метод getTitleAttribute используется для получения названия чата из модели chattable. Если у вас есть собственный атрибут car_title, он будет использоваться для возврата названия чата. В противном случае будет использован атрибут по умолчанию.
Пример использования
public function getTitleAttribute() { if ($this->chattable->car_title){ return $this->chattable->car_title; } return $this->chattable?->car_title; }
Затем выполните команду: php artisan l5-swagger:generate Эта команда сгенерирует документацию для вас. Подробнее можно узнать на странице L5 Swagger на GitHub https://github.com/DarkaOnLine/L5-Swagger
Kuleshov Auth
A Laravel package for integrating with external authentication services, providing seamless synchronization with third-party systems for user login and registration, leveraging custom tokens for secure access.
Installation
Via Composer:
composer require maksatsaparbekov/kuleshov-auth:dev-main
Configuration
php artisan vendor:publish --provider="Maksatsaparbekov\KuleshovAuth\KuleshovAuthServiceProvider" --tag="config" php artisan vendor:publish --tag=kuleshov-auth-policies
Set your third-party service details in your .env: AUTH_SERVICE_URL=https://example.com/api PROJECT_SECURITY_KEY=SECURITY
To use the AuthService in your User model:
use Maksatsaparbekov\KuleshovAuth\Traits\UserTrait;
class User extends Authenticatable { use AuthService; }
Migrations
Run the migrations to create necessary tables:
php artisan migrate
last thing is to fire eloquent model events use:
$user = User::where('phone', $phone)->first(); $user->update([ 'password' => Hash::make($password), ]); rather then $user = User::where('phone', $phone)->update([ 'password' => Hash::make($password), ]);