Create a virtual meeting plugin

📂server
 └📂integrations
   └📂virtualmeeting
     └📂kakapo
       ├📂classes
       │ ├📂providers
       │ │ └📄meeting.php
       │ └📄token.php
       ├📂db
       │ ├📄install.xml
       │ └📄upgrade.php
       ├📂lang
       │ └📂en
       │   └📄virtualmeeting_kakapo.php
       ├📂tests
       │ └📄meeting_test.php
       ├📄lib.php
       └📄version.php

public function is_available(): bool;

public function create_service_provider(client $client): provider;

public function create_setting_page(string $section, string $displayname, bool $fulltree, bool $hidden): ?admin_settingpage;

public function create_auth_service_provider(client $client): auth_provider;

public function create_meeting(meeting_edit_dto $meeting): void;

public function update_meeting(meeting_edit_dto $meeting): void;

public function delete_meeting(meeting_dto $meeting): void;

public function get_join_url(meeting_dto $meeting): string;

public function get_info(meeting_dto $meeting, string $what): string;

public function get_authentication_endpoint(): string;

public function get_profile(user $user, bool $update): array;

public function authorise(user $user, string $method, array $headers, string $body, array $query_get, array $query_post): void;

// e.g. https://your.site/integrations/virtualmeeting/auth_callback.php/kakapo
$url = $CFG->wwwroot . '/integrations/virtualmeeting/auth_callback.php/(plugin name)';

use totara_core\http\client;
use totara_core\virtualmeeting\plugin\factory\factory;
use totara_core\virtualmeeting\plugin\provider\provider;

class virtualmeeting_kakapo_factory implements factory {
  public static function is_available(): bool { // validate plugin settings
    $apikey = get_config('virtualmeeting_kakapo', 'api_key');
    $apisecret = get_config('virtualmeeting_kakapo', 'api_secret');
    return $apikey && $apisecret;
  }

  public function create_service_provider(client $client): provider { // virtual meeting provider
    return new virtualmeeting_kakapo\providers\meeting($client);
  }

  public function create_setting_page(string $section, string $displayname, bool $fulltree, bool $hidden): ?admin_settingpage { // admin page
    $page = new admin_settingpage($section, $displayname, 'moodle/site:config', $hidden);
    if ($fulltree) {
      $page->add(new admin_setting_heading('virtualmeeting_kakapo/header',
        'App credentials',
        'You need the premium subscription of Kakapo Virtual Meeting.'));
      $page->add(new admin_setting_configtext('virtualmeeting_kakapo/api_key', 'API key', 'Enter your API key.', ''));
      $page->add(new admin_setting_configpasswordunmask('virtualmeeting_kakapo/api_secret', 'API secret', 'Enter your API secret.', ''));
    }
    return $page;
  }
}

$plugin->version  = 2020122500;       // The current module version (Date: YYYYMMDDXX).
$plugin->requires = 2017111309;       // Requires this Totara version.
$plugin->component = 'virtualmeeting_kakapo'; // To check on upgrade, that module sits in correct place

namespace virtualmeeting_kakapo\providers;
use DateTime;
use totara_core\http\client;
use totara_core\http\request;
use totara_core\virtualmeeting\dto\meeting_dto;
use totara_core\virtualmeeting\dto\meeting_edit_dto;
use totara_core\virtualmeeting\exception\not_implemented_exception;
use totara_core\virtualmeeting\plugin\provider\provider;
use virtualmeeting_kakapo\token;

class meeting implements provider {
  /** @var client */
  private $client;

  public function __construct(client $client) {
    $this->client = $client; // save the http client instance for later use
  }

  public function create_meeting(meeting_edit_dto $meeting): void {
    $request = request::post( // create a POST request that sends JSON and receives JSON
      'https://example.com/api/meetings/',
      [
        'name' => $meeting->get_name(),
        'timestart' => $meeting->get_timestart()->format(DateTime::ISO8601),
        'timefinish' => $meeting->get_timefinish()->format(DateTime::ISO8601),
      ],
      ['Authorization' => 'Bearer ' . token::make()]
    );
    $response = $this->client->execute($request);
    $response->throw_if_error();
    $data = $response->get_body_as_json(false, true);
    $meeting->get_storage() // store obtained data
      ->set('id', $data->id)
      ->set('join_url', $data->joinUrl)
      ->set('host_url', $data->hostUrl);
  }

  public function update_meeting(meeting_edit_dto $meeting): void {
    $id = $meeting->get_storage()->get('id', true); // load stored data
    $request = request::put( // create a PUT request that sends JSON and receives JSON
      'https://example.com/api/meetings/',
      [
        'name' => $meeting->get_name(),
        'timestart' => $meeting->get_timestart()->format(DateTime::ISO8601),
        'timefinish' => $meeting->get_timefinish()->format(DateTime::ISO8601),
      ],
      ['Authorization' => 'Bearer ' . token::make()]
    );
    $response = $this->client->execute($request);
    $response->throw_if_error();
    $data = $response->get_body_as_json(false, true);
    $meeting->get_storage() // store obtained data
      ->set('id', $data->id)
      ->set('join_url', $data->joinUrl)
      ->set('host_url', $data->hostUrl);
  }

  public function delete_meeting(meeting_dto $meeting): void {
    $id = $meeting->get_storage()->get('id'); // load stored data
    if (!$id) {
      return; // already deleted
    }
    $request = request::delete( // create a DELETE request
      'https://example.com/api/meetings/' . $id,
      ['Authorization' => 'Bearer ' . token::make()]
    );
    $response = $this->client->execute($request);
    $response->throw_if_error();
    $meeting->get_storage()->delete_all(); // clear all associated data in the storage
  }

  public function get_join_url(meeting_dto $meeting): string {
    return $meeting->get_storage()->get('join_url', true);
  }

  public function get_info(meeting_dto $meeting, string $what): string {
    if ($what === provider::INFO_HOST_URL) {
      return $meeting->get_storage()->get('host_url', true);
    }
    throw new not_implemented_exception();
  }
}

namespace virtualmeeting_kakapo;
use totara_core\virtualmeeting\exception\meeting_exception;

class token {
  public static function make(): string { // create a live authentication token
    $apikey = get_config('virtualmeeting_kakapo', 'api_key');
    $apisecret = get_config('virtualmeeting_kakapo', 'api_secret');
    if (empty($apikey) || empty($apisecret)) {
      throw new meeting_exception('plugin not configured');
    }
    // create a JWT signed with HMAC SHA-256
    // as we do not provide any functions to handle a JWT, please refer to RFC 7519 and do it yourself
    return jwt::sign(
      ['alg' => 'HS256'], // header
      ['iss' => $apikey, 'exp' => time() + 300], // payload with 5 minute expiration
      $apisecret
    );
  }
}

class virtualmeeting_kakapo_meeting_testcase extends advanced_testcase {
  public function test_create_meeting_successfully() {
    $user = self::getDataGenerator()->create_user();
    // create a mock client for testing
    $mock_client = new totara_core\http\clients\simple_mock_client();
    // mock the response of a POST request
    $mock_body = json_encode(['id' => '42', 'joinUrl' => 'https://example.com/kiaora', 'hostUrl' => 'https://example.com/koutou']);
    $mock_response = new totara_core\http\response($mock_body, 201, []);
    $mock_client->mock_queue($mock_response);
    // create a meeting provider with the mock client
    $provider = new virtualmeeting_kakapo\providers\meeting($mock_client);
    // call create_meeting
    $entity = new totara_core\entity\virtual_meeting();
    $entity->plugin = 'kakapo';
    $entity->userid = $user->id;
    $entity->save();
    $dto = new totara_core\virtualmeeting\dto\meeting_edit_dto($entity, 'test meeting', new DateTime('+1 day'), new DateTime('+2 day'));
    $provider->create_meeting($dto);
    // assert storage data
    self::assertEquals(42, $dto->get('id', true));
    self::assertEquals('https://example.com/kiaora', $dto->get('join_url', true));
    self::assertEquals('https://example.com/koutou', $dto->get('host_url', true));
  }
  // test failing case, update, delete etc.
}