App\Services\ApolearnService

Complexity

Total Complexity

31

Size/Duplication

Total Lines	241
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	updateUser()	0	19	3
A	__construct()	0	4	1
A	authenticate()	0	10	1
A	createUser()	0	34	4
A	createCourse()	0	34	2
B	updateCourse()	0	49	9
A	removeStudent()	0	7	1
A	addTeacher()	0	18	3
A	removeTeacher()	0	11	1
A	enrollStudent()	0	17	3
A	actionSucceeded()	0	3	3

<?php

namespace App\Services;

use App\Interfaces\LMSInterface;
use App\Models\Course;
use App\Models\Student;
use App\Models\User;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;

class ApolearnService implements LMSInterface
{
    public string $apiKey;

    private string $token;

    public function __construct()
    {
        $this->apiKey = config('lms.apolearn.api_key');
        $this->token = $this->authenticate();
    }

    public function authenticate(): string
    {
        Log::info('launching API');
        $response = Http::post(config('lms.apolearn.url').'/auth.gettoken', [
            'api_key' => $this->apiKey,
            'username' => config('lms.apolearn.username'),
            'password' => config('lms.apolearn.password'),
        ]);

        return $response['result'] ?? '';
    }

    public function createUser(User $user, ?string $password = null): void
    {
        Log::info('checking if user exists for local ID '.$user->id);
        // first check if the user already exists (email)
        $response = Http::get(config('lms.apolearn.url')."/users/getbyemail/$user->email", [
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        // if the user exists, just update their ID
        if ($this->actionSucceeded($response)) {
            Log::info('user found, saving their LMS ID to our DB');
            $user->update(['lms_id' => $response->json()['result']['user']['id']]);
        } else {
            // otherwise create them
            Log::info('user not found, creating them on the remote API now');
            $data = [
                'firstname' => $user->firstname,
                'lastname' => $user->lastname,
                'email' => $user->email,
                'auth_token' => $this->token,
                'api_key' => $this->apiKey,
            ];

            if ($password !== '') {
                $data = Arr::add($data, 'password', $password);
            }

            $response = Http::post(config('lms.apolearn.url').'/users', $data);

            if ($this->actionSucceeded($response)) {
                $user->update(['lms_id' => $response->json()['result']['id']]);
            } else {
                Log::error($response->json());

$response->json() of type array is incompatible with the type string expected by parameter $message of Illuminate\Support\Facades\Log::error().

            }
        }
    }

    public function updateUser(User $user, string $password = null): void
    {
        // if the user has no remote id, create them
        if ($user->lms_id == null) {
            $this->createUser($user);
        } else {
            $data = [
                'firstname' => $user->firstname,
                'lastname' => $user->lastname,
                'email' => $user->email,
                'auth_token' => $this->token,
                'api_key' => $this->apiKey,
            ];

            if ($password !== '') {
                $data = Arr::add($data, 'password', $password);
            }

            $response = Http::put(config('lms.apolearn.url').'/users/'.$user->lms_id, $data);

The assignment to $response is dead and can be removed.

        }
    }

    public function createCourse(Course $course): void
    {
        // first check if the course already has an ID (meaning it exists on the remote lms)
        if ($course->lms_id) {
            abort(422, 'This course already exists on the remote platform');
        }

        Log::info('pushing local course '.$course->id.' to API');
        $response = Http::post(config('lms.apolearn.url').'/classrooms', [
            'name' => $course->name,
            'shortname' => $course->shortname,
            'description' => $course->description,
            'start_date' => strtotime($course->start_date),
            'end_date' => strtotime($course->end_date),
            'category_id' => $course->rhythm->lms_id ?? config('lms.apolearn.default_category_id'),
            'level_id' => $course->level->lms_id ?? config('lms.apolearn.default_level_id'),
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        $courseId = $response->json()['result']['id'];

        // store the course ID in our database
        $course->update(['lms_id' => $courseId]);

        // assign an admin to the new class
        $response = Http::post(config('lms.apolearn.url')."/classrooms/addadmin/$courseId", [

The assignment to $response is dead and can be removed.

            'user_id' => config('lms.apolearn.admin_user_id'),
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        // and a teacher
        $this->addTeacher($course);
    }

    public function updateCourse(Course $course): void
    {
        if (! $course->lms_id) {
            $this->createCourse($course);
        }

        Log::info('updating course with locale ID'.$course->id);
        $response = Http::put(config('lms.apolearn.url')."/classrooms/$course->lms_id", [

The assignment to $response is dead and can be removed.

            'name' => $course->name,
            'shortname' => $course->shortname,
            'description' => $course->description,
            'start_date' => strtotime($course->start_date),
            'end_date' => strtotime($course->end_date),
            'category_id' => $course->rhythm->lms_id ?? config('lms.apolearn.default_category_id'),
            'level_id' => $course->level->lms_id ?? config('lms.apolearn.default_level_id'),
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        Log::info('updating the course teacher');
        // ensure the teacher is up to date
        $response = Http::get(config('lms.apolearn.url')."/classrooms/teachers/$course->lms_id", [
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        if ($this->actionSucceeded($response)) {
            $teachers = collect($response->json()['result']['users']);
            Log::info('found these teachers IDs on LMS:'.implode(', ', $teachers->pluck('id')->toArray()));

            // if the course has no teacher, stop
            if (! $course->teacher) {
                Log::alert('The course has no teacher on local system, removing all teachers from remote');
                foreach ($teachers as $teacher) {
                    $this->removeTeacher($course->lms_id, $teacher['id']);
                }
            } else {
                // check if remote course teachers are still valid
                foreach ($teachers as $teacher) {
                    Log::info('comparing '.$teacher['id'].' and '.$course->teacher->user->lms_id);
                    if ($teacher['id'] !== $course->teacher->user->lms_id) {
                        Log::info('Removing teacher '.$teacher['id'].' from course');
                        $this->removeTeacher($course->lms_id, $teacher['id']);
                    }
                }

                if (! $course->teacher->user->lms_id || ! $teachers->contains('id', $course->teacher->user->lms_id)) {
                    Log::info('the course teacher has changed, need to update it');
                    $this->addTeacher($course);
                }
            }
        }
    }

    public function enrollStudent(Course $course, Student $student): void
    {
        if (! $course->lms_id) {
            abort(404, 'This course is not synced with external LMS');
        }

        $courseId = $course->lms_id;

        // if the student is not synced with the LMS, create them
        if (! $student->user->lms_id) {
            $this->createUser($student->user);
        }

        $response = Http::post(config('lms.apolearn.url')."/classrooms/addstudent/$courseId", [

The assignment to $response is dead and can be removed.

            'user_id' => $student->user->lms_id,
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);
    }

    protected function actionSucceeded(Response $response): bool
    {
        return $response->ok() && array_key_exists('result', $response->json()) && $response->json()['result']['success'] == true;
    }

    protected function addTeacher(Course $course): void
    {
        Log::info('adding teacher');

        // only process if the course has a teacher
        if ($course->teacher_id) {
            // if the teacher doesn't exist on LMS, create them
            if (! $course->teacher->user->lms_id) {
                Log::info('creating user now');
                $this->createUser($course->teacher->user);
            }

            // then sync to API
            Log::info('pushing course user to API');
            $response = Http::post(config('lms.apolearn.url')."/classrooms/addteacher/$course->lms_id", [

The assignment to $response is dead and can be removed.

                'user_id' => $course->teacher->user->lms_id,
                'auth_token' => $this->token,
                'api_key' => $this->apiKey,
            ]);
        }
    }

    protected function removeTeacher($courseId, $teacherId): void
    {
        Log::info('Removing teacher '.$teacherId.' from course '.$courseId);
        $response = Http::put(config('lms.apolearn.url')."/classrooms/removeteacher/$courseId", [

The assignment to $response is dead and can be removed.

            'user_id' => $teacherId,
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);

        Log::info('and removing them again as students');
        $this->removeStudent($courseId, $teacherId);
    }

    public function removeStudent($courseId, $userId): void
    {
        Log::info('removing user id '.$userId.' from course '.$courseId);
        $response = Http::put(config('lms.apolearn.url')."/classrooms/removestudent/$courseId", [

The assignment to $response is dead and can be removed.

            'user_id' => $userId,
            'auth_token' => $this->token,
            'api_key' => $this->apiKey,
        ]);
    }
}