duolingo-dart / duolingo4d Goto Github PK

以下のAPIを使用して単語の定義情報を取得する機能を追加する。

https://www.duolingo.com/api/1/dictionary_page?lexeme_id=

以下のURLを使用してディスカッションをフォロー / アンフォローすることができる機能を追加する。
どちらもPOST送信で正常に処理される。

https://forum-api.duolingo.com/comments/{commentId (like 54867020)}/watch
https://forum-api.duolingo.com/comments/{commentId (like 54867020)}/unwatch

以下のURLで PUT と DELETE メソッドでリクエストを送信することで
フォローとアンフォローを行うことができる。

https://www.duolingo.com/2017-06-30/users/557897808/subscriptions/433800710

Duolingo APIから返却されるユーザーIDは文字列と数値で型が混在しているが、
Duolingo4DではユーザーIDを文字列として扱うように標準化する。

以下のURLのAPIを参照できる機能を追加する。

https://www.duolingo.com/2017-06-30/shop-items

以下のURLを参照できる機能を追加。

https://duolingo-achievements-prod.duolingo.com/users/557897808/achievements?fromLanguage=en&learningLanguage=ja

別ユーザーが新たに authenticate メソッドを通じて認証された場合は保持しているキャッシュ情報を削除する。
認証が完了したかどうかは認証エラーが存在するかどうかで判断する。

以下のURLを参照できる機能を追加する。

https://forum-api.duolingo.com/api/1/searchables?q=test&page=0&limit=20

以下のURLを参照する機能を追加する。

https://forum-api.duolingo.com/comments?sort_by=new&topic_id=null

topic_id が null の場合はForumのコメントリストが返却され、
特定の topic_id が指定された場合はそのトピックのコメントリストを返却する。

sort_by は hot, new, 'followed' がある。

以下のURLを参照する機能を追加する。

https://forum-api.duolingo.com/topics/{topicIid}

以下のURLに参照することができる機能を追加する。

https://stories.duolingo.com/api2/stories?fromLanguage=en&learningLanguage=ja&illustrationFormat=png

illustrationFormat はsvg, png, pdfに対応している。

Duolingo APIから返却されたJSON文字列を変換する際に文字コードを明示的に指定するように修正を行う。

jsonDecode(utf8.decode(response.body.runes.toList()));

アプリによっては単純にDuolingo APIを使うだけではなく、
認証されたユーザーのセッションを引き継いだまま他の処理を行う場面も考えられるため、
Duolingo から認証されたDuolingoユーザーのセッション情報を返却する機能を追加する。

また、この返却されたセッション情報はDuolingo4Dの内部処理で使用するセッションオブジェクトとは別オブジェクトとし、
呼び出し側のユーザーの意志でこの新しいオブジェクトに格納されたデータは編集できない仕様とする。

fromLanguageやlearningLangugeといった認証されたユーザーに紐づく情報は
キャッシュして再利用するように全体的に修正を行う。

この修正で一部のメソッドに関してrequired指定されていた引数をオプションとして定義できるように修正する。

Duolingoでフォローしている友達の情報を取得する機能を追加する。
フォローしている友達のIDは leaderboard_activity APIから取得できる。

キャッシュ機能を追加してから実装したほうがいいかもしれない。

現状Word Hint APIのレスポンスはオリジナルのJSONをそのままラッピングして返却しているが、
このオリジナルのデータは構造がわかりにくく扱いにくい。

そのためある程度すぐに使える形式に整形したオブジェクトを返却する機能を追加する。
既存の機能はそのまま残すこととする。

In json_impl.dart is this code:
@override bool getBool({ required String key, bool defaultValue = false, }) => _resource[key] ?? defaultValue;
but if _resource[key] is not type bool, it shows error

以下のURLを参照できる機能を追加する。

https://www-prod.duolingo.com/2017-06-30/alphabets/courses/ja/en

UserResponseにUser APIから返却される "trackingProperties" に紐づくTrackingPropertiesフィールドを追加する。
この対応に伴いTrackingPropertiesクラスを新しく作成する。

以下のURLを参照する機能を追加する。

https://duolingo-leaderboards-prod.duolingo.com/leaderboards/7d9f5dd1-8423-491a-91f2-2532052038ce/users/557897808?client_unlocked=true

以下のURLの情報を参照する機能を追加する。

https://www.duolingo.com/2017-06-30/users/113899970/subscriptions

以下のURLを参照できる機能を追加する。

https://events-login.duolingo.com/api/2/userEventDetails/a8fff4b7-4053-4dd6-a1a6-85ffce2ea55e

以下のURLのAPIを参照する機能を追加する。

https://forum-api.duolingo.com/comments/1678438

以下のURLを参照できる機能の追加。

https://friends-prod.duolingo.com/users/113899970/recommendations

leaderboard_activity APIのレスポンスをラッピングして返却する機能を追加する。

Word Hint APIは要認証だがドキュメントでは不要になっているため修正する。

APIから返却されたレスポンスから特定の情報だけを抽出したい場合があり、
その際にはあらかじめAPI通信が行われ結果がキャッシュされていると毎回APIを呼び出す必要がなくなる。

そのためAPI通信で取得したレスポンスデータをキャッシュする機能を追加する。
レスポンスデータをキャッシュするかどうかは呼び出し元のオプション引数で制御する。

どのタイミングでキャッシュをクリアするかは要検討。

以下のURLを参照する機能を追加する。

https://www.duolingo.com/manifest.json

一通りの主要なAPIを実装できたので、
いったんここで仕様の整理と利便性を向上させるためのリファクタリングを検討する。

Unhandled exception:
type 'Null' is not a subtype of type 'String'
#0      DuolingoImpl.user (package:duolingo4d/src/duolingo_impl.dart:107:13)
#1      DuolingoImpl.authenticate (package:duolingo4d/src/duolingo_impl.dart:82:34)
<asynchronous suspension>
#2      main (file:///home/******/Documents/duolingo/bin/duolingo.dart:12:37)
<asynchronous suspension>

Code:

import 'package:duolingo4d/duolingo4d.dart';


void main() async {
  final duolingo = Duolingo.instance;

  final AuthResponse authResponse = await duolingo.authenticate(
    username: '*************',
    password: '***********',
  );

  if (authResponse.status.isNotOk) {
    // Client or Server error or something.
    authResponse.status.reasonPhrase;
    authResponse.headers;
    return;
  }

  if (authResponse.hasError) {
    // When there is an error on authentication.
    final authError = authResponse.error!;
    print(authError.code);
    print(authError.reason);

    authError.isInvalidUser; // Returns true if user is invalid.
    authError.isInvalidPassword; // Returns true if password is invalid.
    return;
  }

  // Do something if user is authenticated.
}

以下のURLを参照できる機能を追加する。

https://www.duolingo.com/users/search

なお、以下のbodyをPOST送信することで通信が成立する。

per_page: 15
q: q

以下のURLを参照する機能を追加する。

https://forum-api.duolingo.com/api/1/topics/list

以下のURLを参照できる機能を追加する。

https://events-login.duolingo.com/api/2/events?available_only=true&end_range=2022-01-15T16:14:36.942Z&fields=hosts&is_featured_only=false&language_ids=ja&must_start_within_range=false&start_range=2021-12-16T16:14:36.942Z

APIから返却される各レスポンスオブジェクトに以下の実装を追加する。

1. toString
2. Operator ==
3. hashCode

以下のURLの情報を参照する機能を追加する。

https://www.duolingo.com/2017-06-30/users/113899970/subscribers