Version v1.0.13-beta

Author: gustavobazzo

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,9 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+.cache
+
+*.zip
+src/react/package-lock.json
+*.asset

LICENSE

@@ -0,0 +1,60 @@
+# tool_recitapis
+
+This plugin is designed to retrieve data from various APIs for use by other RECIT plugins.
+
+## GRICS API
+<a href='https://espaceapi.grics.ca/'>Espace API - GRICS</a>
+
+This function aims to obtain data from GRICS according to user rights in order to enroll students in courses or work plans.
+
+Before this plugin can read the GRICS API, you need to create your GRICS application in the GRICS API espace.
+Once you are logged into the GRICS espace, two applications must be created.
+
+The first application will be used for reading data on the <b>client side</b>.
+
+### Step 1
+You will need to fill in the following fields:
+<ul>
+	<li>Application name</li> 
+    <li>Authorization type: Native and browser-based (Authorization code + PKCE)</li> 
+    <li>Scopes: apiclients (API Espace), openid (my user ID) and profile (my user profile: last name, first name, user name)</li>
+    <li>URI addresses for redirection after login: YOUR_SERVER/admin/tool/recitapis/view.php</li>
+    <li>Authentication options: Microsoft</li>
+    <li>Link to terms of use (French)</li>
+    <li>Link to privacy policy (French)</li>
+</ul>
+
+Keep the <b>client ID</b> and <b>secret</b> of your application in a safe place.
+You will need to add them to the parameters of this plugin.
+
+### Step 2
+Subscribe to the following product(s): <b>Plateforme d'identité Mozaïk (5.1.10)</b>.
+
+### Step 3
+Once GRICS confirms that the subscriptions are complete, the final step is to give consent for your application.
+
+Simply copy the consent URL and paste it into any web browser. If you have permission, you will be able to grant consent.
+
+<hr/>
+
+The second application will be used for reading data on the <b>server side</b>.
+
+### Step 1
+You will need to fill in the following fields:
+<ul>
+	<li>Application name</li> 
+    <li>Authorization type: Machine/Robot (client credentials) and PKCE server (Authorization code + PKCE + secret client)</li> 
+    <li>Scopes: apiclients (API Espace)</li>
+    <li>URI addresses for redirection after login: YOUR_SERVER</li>
+    <li>Link to terms of use (French)</li>
+    <li>Link to privacy policy (French)</li>
+</ul>
+
+Keep the <b>client ID</b> and <b>secret</b> of your application in a safe place.
+You will need to add them to the parameters of this plugin.
+
+### Step 2
+Subscribe to the following product(s): <b>Élève (5.5.5)</b>.
+
+### Step 3
+Grant the consent in the same way you did for the previous application.

README.md

@@ -0,0 +1,30 @@
+function Get-PluginVersion {
+    $file_data = Get-Content ./src/version.php | Where-Object {$_ -like "*$plugin->release*"}
+
+	$CharArray = $file_data.Split("=")
+
+	$result = $CharArray[1].replace("'", "").replace(";","").trim()
+	
+	return $result
+}
+
+function Create-Zipfile($zipName, $pluginName, $pluginVersion){
+	#remove the current zip file
+	$zipFile="$($zipName)-$($pluginVersion).zip"
+	
+	if(Test-Path -Path $zipFile -PathType Leaf){
+		Remove-Item -Path $zipFile
+	}
+
+	#zip the folder except the folders .cache and node_modules
+	& "c:\Program Files\7-Zip\7z.exe" a -mx "$zipFile" "src\*"-mx0 -xr!"src\react\.cache" -xr!"src\react\node_modules" -xr!"src\react\package-lock.json"
+
+	#set the plugin name
+	& "c:\Program Files\7-Zip\7z.exe" rn "$zipFile" "src\" "$pluginName\"
+}
+
+$zipName="tool_recitapis"
+$pluginName="recitapis"
+$pluginVersion = Get-PluginVersion
+
+Create-Zipfile $zipName $pluginName $pluginVersion

create-zip.ps1

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package   tool_recitapis
+ * @copyright 2024 RÉCIT 
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace recitapis;
+ 
+class Options
+{
+    static function getGricsApiClientId(){ 
+        return get_config('tool_recitapis', 'gricsbackendclientid');
+    }
+
+    static function getGricsApiSecret(){  
+        return \core\encryption::decrypt(get_config('tool_recitapis', 'gricsbackendsecret'));
+    }
+
+    static function getGricsOrganizationNumber(){ 
+        return get_config('tool_recitapis', 'gricsorganizationnumber');
+    }
+
+    static function getGricsUrlApi(){ 
+        return get_config('tool_recitapis', 'gricsurlapi');
+    }
+
+    static function getGricsUrlToken($mode){ 
+        return get_config('tool_recitapis', 'gricsurltoken');
+    }
+}