Flutter客户端插件lyon1tomussclient的使用

📚 Lyon1TomussClient 使用

Lyon1TomussClient 是一个用于与里昂第一大学（Lyon 1 University）的学术平台 Tomuss 进行交互的 Dart 库。它通过 Lyon1CasClient 进行身份验证。

✨ 特性

• 使用里昂第一大学 CAS 凭据对用户进行身份验证。
• 从里昂第一大学 Tomuss 获取学术信息。
• 访问成绩、教学单元、硕士课程等。

⚙️ 安装

在项目的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  lyon1tomussclient: any
  lyon1casclient: any

🔒 使用

首先，导入所需的库：

import 'package:lyon1tomussclient/lyon1tomussclient.dart';
import 'package:lyon1casclient/lyon1casclient.dart';

然后，使用 Lyon1CasClient 类来使用里昂第一大学 CAS 凭据对用户进行身份验证。身份验证成功后，创建一个新的 Lyon1TomussClient 实例并传入 Lyon1CasClient 对象：

void main() async {
  // 创建 Lyon1CasClient 实例
  Lyon1CasClient lyon1Cas = Lyon1CasClient();

  // 身份验证
  final bool isAuthenticated = (await lyon1Cas.authenticate(Credential("p1234567", "a_valid_password"))).authResult;

  // 检查是否认证成功
  if (!isAuthenticated) {
    print("您未通过身份验证。请检查用户名和密码。");
    return;
  }

  // 创建 Lyon1TomussClient 实例
  final Lyon1TomussClient tomuss = Lyon1TomussClient(lyon1Cas);

  // 获取当前学期的解析页面
  final ParsedPage? parsedPageOpt = await tomuss.getParsedPage(Lyon1TomussClient.currentSemester());

  // 检查是否获取到解析页面
  if (parsedPageOpt == null) {
    print("获取 Tomuss 数据时出错。");
    return;
  }

  // 解析页面
  final ParsedPage parsedPage = parsedPageOpt;

  // 列出教学单元
  for (final TeachingUnit tu in parsedPage.teachingunits!) {
    print(tu.title);
    print("\t成绩:");
    for (final Grade g in tu.grades) {
      print("\t\t${g.title}: ${g.numerator}/${g.denominator}");
    }

    // 列出当前教学单元的导师
    print("\t导师:");
    for (final Teacher t in tu.masters) {
      print("\t\t${t.name} (${t.email})");
    }
  }

  // 列出学期
  for (final Semester s in parsedPage.semesters!) {
    print("${s.title} (${s.url})");
  }
}

请确保将 "p1234567" 替换为实际的里昂第一大学 CAS 用户名，并将 "a_valid_password" 替换为相应的密码。

示例代码

以下是一个完整的示例代码，您可以将其复制到您的项目中进行测试：

import 'package:lyon1tomussclient/lyon1tomussclient.dart';
import 'package:lyon1casclient/lyon1casclient.dart';

void main() async {
  // 创建 Lyon1CasClient 实例
  Lyon1CasClient lyon1Cas = Lyon1CasClient();

  // 身份验证
  final bool isAuthenticated = (await lyon1Cas.authenticate(Credential("p1234567", "a_valid_password"))).authResult;

  // 检查是否认证成功
  if (!isAuthenticated) {
    print("您未通过身份验证。请检查用户名和密码。");
    return;
  }

  // 创建 Lyon1TomussClient 实例
  final Lyon1TomussClient tomuss = Lyon1TomussClient(lyon1Cas);

  // 获取当前学期的解析页面
  final ParsedPage? parsedPageOpt = await tomuss.getParsedPage(Lyon1TomussClient.currentSemester());

  // 检查是否获取到解析页面
  if (parsedPageOpt == null) {
    print("获取 Tomuss 数据时出错。");
    return;
  }

  // 解析页面
  final ParsedPage parsedPage = parsedPageOpt;

  // 列出教学单元
  for (final TeachingUnit tu in parsedPage.teachingunits!) {
    print(tu.title);
    print("\t成绩:");
    for (final Grade g in tu.grades) {
      print("\t\t${g.title}: ${g.numerator}/${g.denominator}");
    }

    // 列出当前教学单元的导师
    print("\t导师:");
    for (final Teacher t in tu.masters) {
      print("\t\t${t.name} (${t.email})");
    }
  }

  // 列出学期
  for (final Semester s in parsedPage.semesters!) {
    print("${s.title} (${s.url})");
  }
}