scriptotek / bibrex

app/Http/Controllers/WebhooksController.php

<?php

namespace App\Http\Controllers;

use App\Alma\AlmaUsers;
use App\User;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Arr;
use Scriptotek\Alma\Client;

class WebhooksController extends Controller
{
    /**
     * Alma webhooks challenge handler.
     *
     * @param Request $request
     * @return Response
     */
    public function challenge(Request $request)
    {
        return response()->json([

The expression return response()->json(array('challenge' => $request->query('challenge'))) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

            'challenge' => $request->query('challenge'),
        ]);
    }

    /**
     * Alma webhooks router.
     *
     * @param Client $almaClient
     * @param Request $request
     * @return Response
     */
    public function handle(Client $almaClient, AlmaUsers $almaUsers, Request $request)
    {
        $secret = config('services.alma.webhook_secret');
        $eventType = $request->input('action');
        $hash = $request->header('X-Exl-Signature');

        $expectedHash = base64_encode(
            hash_hmac('sha256', $request->getContent(), $secret, true)
        );

        if (!hash_equals($hash, $expectedHash)) {

It seems like $hash can also be of type array; however, parameter $known_string of hash_equals() does only seem to accept string, maybe add an additional type check?

            \Log::warning(
                "Ignoring Alma '{$eventType}' event due to invalid signature. " .
                "Expected '{$expectedHash}', got '{$hash}'."
            );

            return response()->json(['errorMessage' => 'Invalid Signature'], 401);

The expression return response()->json(array('errorMessage' => 'Invalid Signature'), 401) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

        }

        switch ($eventType) {
            case 'USER':
                return $this->handleUserUpdate($almaClient, $almaUsers, $request);

            default:
                return response('No handler for this webhook event type.', 202);
        }
    }

    /**
     * Handler for the Alma user webhook.
     *
     * @param Client $almaClient
     * @param AlmaUsers $almaUsers
     * @param Request $request
     * @return Response
     */
    protected function handleUserUpdate(Client $almaClient, AlmaUsers $almaUsers, Request $request)
    {
        $data = $request->input('webhook_user');
        $primaryId = Arr::get($data, 'user.primary_id');

        if ($data['method'] == 'UPDATE') {
            $almaClientUser = \Scriptotek\Alma\Users\User::make($almaClient, $primaryId)
                ->init(json_decode(json_encode($data['user'])));

            $almaUser = new \App\Alma\User($almaClientUser);

            $localUser = $almaUsers->findLocalUserFromAlmaUser($almaUser);

            if (is_null($localUser)) {
                \Log::debug('Ignorerer Alma-brukeroppdateringsvarsel for bruker som ikke er i Bibrex.');
            } else {
                $almaUsers->updateLocalUserFromAlmaUser($localUser, $almaUser);
                if ($localUser->isDirty()) {
                    $localUser->save();
                    \Log::info(sprintf(
                        'Oppdaterte brukeren <a href="%s">%s</a> fra Alma.',
                        action('UsersController@getShow', $localUser->id),
                        $localUser->name
                    ));
                }
            }
        } elseif ($data['method'] == 'DELETE') {
            $localUser = User::where('alma_primary_id', '=', $primaryId)->first();
            if (is_null($localUser)) {
                \Log::debug('Ignorerer Alma-brukeroppdateringsvarsel for bruker som ikke er i Bibrex.');
            } else {
                \Log::warning(sprintf(
                    'Tips fra Alma: Brukeren <a href="%s">%s</a> har blitt slettet i Alma. Hva gjør vi? Tja, vet ikke.',
                    action('UsersController@getShow', $localUser->id),
                    $localUser->name
                ));
            }
        }

        // Say yo to Alma
        return response('Yo Alma!', 200);
    }
}