katsutedev / mal4j Goto Github PK

Move object tests into their own classes and instead use a static class to retrieve MAL obj. Only create if not already set.

For each test create static object then run single method tests. Keep only a single object per class.

hasNextPage is called twice for some reason

https://github.com/Katsute/MyAnimeList-Java-API/blob/270092b5596e0b08f7a8c787341ffa33fe592048/src/main/java/com/kttdevelopment/myanimelist/PaginatedIterator.java#L23-L39

The current line split regex works except in cases where an escaped quote exists. This needs to be fixed so that it works with escaped quotes.

(?<=[{\[,]|(?=[}\]])) ?(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)(?!$)

Example where regex works: {"obj":{},"arr":[],"escaped":"str"}
Example where regex fails: {"obj":{},"arr":[],"escape\"d":"str"}

The fixed regex should split where there is a {}[], except within quotes.

Do not make a pull, instead post a new regex in the comments

The client side code works correctly and limits these parameters to their minimum and maximum values. This is a server side issue where the API returns a code 400 when trying to load with 0 offset or limiting over the max possible results (insufficient search listings).

An error code 404 indicates that the listing has already been deleted. For the delete method there really is no reason to throw an exception if it has already been deleted since we wanted to delete the listing anyways.

Use try catch only on case 404.

For endpoints that return only yyyymmdd format return Date only, it doesn't make sense to return a long for these fields.

Notable issues:

• Anime/manga start/end date
• Anime/manga list start/finish date
• User birthday

For methods returning an epoch time, return date.

Note that date is not immutable and the method should return a new date each time.

Affected methods:
https://github.com/Katsute/Mal4J/blob/90edac3d143a82663804737efe26a50e3abd4eb1/src/main/java/com/kttdevelopment/mal4j/property/MediaItem.java#L64-L82
https://github.com/Katsute/Mal4J/blob/90edac3d143a82663804737efe26a50e3abd4eb1/src/main/java/com/kttdevelopment/mal4j/property/MediaItem.java#L157-L175
https://github.com/Katsute/Mal4J/blob/90edac3d143a82663804737efe26a50e3abd4eb1/src/main/java/com/kttdevelopment/mal4j/property/ListStatus.java#L54-L72
https://github.com/Katsute/Mal4J/blob/90edac3d143a82663804737efe26a50e3abd4eb1/src/main/java/com/kttdevelopment/mal4j/property/ListStatus.java#L102-L109

The documentation for ForumTopicGet shows different response structures. This is an API issue.

The update methods work correctly and return a correct list status, as well as an implicit call to #getManga. This method however fails when trying to search UserMangaList for both self and users, this seems to be a server side issue as this code was working last week.

It's also important to note that AnimeListStatus is still functioning properly.

With many nullable fields it can be difficult to determine whether the default value is the actual value (ex: false by default).

All methods should be changed to return object type rather than primitive types.

This issue only affects branch redoc@0450bbc5.

Consolidate some newly added markdown files into the redoc document, this will make it easier to make changes.

Let the server handle parameter limits and instead throw a bad parameters exception if the server throws it.

Maps store primitives as their object type making it impossible to cast them. Make json return a json object instead of using maps and lists. This would also make it easier to access the object in the schema as we could skip casting with methods.

Add matrix testing for JDK11 and latest

Priority can be represented as an enum
0 - Low
1 - Medium
2 - High

Rewatch value can be represented as an enum
0 - None
1 - Very Low
2 - Low
3 - Medium
4 - High
5 - Very High

The API treats rewatching as watching if it is already completed. This bug is intentional and will not be resolved in this library.

The API says the key is num_watched_episodes but it is actually num_episodes_watched. This is an API issue.

Changes:

• Move FAQ to its own markdown file.
• Move setup to its own markdown file.
• Move features to README.
• Replace javadoc site with Redoc (possible move to /docs path).

Both the Anime and Manga classes explicitly state the methods getAnime and getManga but these methods can be retrieved by instead implementing the interface AnimeRetrievable and MangaRetrievable.

The NSFW parameter doesn't seem to work with ranking and seasonal searches. This is an API issue (or maybe this is intended?)

• Have separate profiles (package & deploy)
• Move settings to pom

For some reason updating an Anime listing that already exists returns a 500 error. It is unclear what causes this and why it only occurs for Anime list updates.

Potential fix may require first getting that list, deleting it, then updating it with values from the initial list with new values.

This issue may or may not be fixed at a later date. If you experience this issue simply delete and update.

Change required to remain consistent with Favorite (not ByFavorites)

This issue only affects branch redoc@0450bbc5.

There are several defects in redoc that is causing valid schema to produce invalid documentation.

• /anime, /anime/seasonal/{year}/{season}, /anime/suggestions
  • List status not being returned
  • Studios not being returned
• /anime/{anime_id}
  • Studios not being returned
  • RelatedAnime not being returned
  • Recommendations not being returned
• /anime/ranking
  • Not returning Anime
• /users/{user_name}/animelist
  • Comments type is any
• /manga
  • List status not being returned
  • Authors not being returned
• /manga/{anime_id}
  • Authors not being returned
  • RelatedManga not being returned
  • Recommendations not being returned
  • Serialization not being returned
• /manga/ranking
  • Not returning Manga
• /users/{user_name}/mangalist
  • Edit not being returned
• /forum/boards
  • Subboards not being returned
  • Post author not being returned
• /forum/topic/{topic_id}
  • Internal posts not being returned
  • Poll options not being returned

Current name is too vague and may cause issues in the future in the event of additional Java wrappers.

• Change repo name to Mal4J
• Change logo
• Change subdomain to mal4j but also keep myanimelist and mal as redirects
• Change maven repo to mal4j

Standard APIs return a fields. Revert the previous change.

The forum endpoint returns all fields by default, this class should be changed to extend SearchQuery only and not FieldSearchQuery.

Prerequisites

If all checks are not passed then the request will be closed.

• I have checked that no other similar feature request already exists.
• I have checked that this feature does not already exist.
• The feature request makes sense for the project.

Proposal

Describe the feature that should be added.
Designs for the finished authentication screen.

Reasoning

Explain why this feature should be added.
Its a bit empty at the moment. Please edit the html file with new designs ♥

Add methods to return URL strings as URL objects

Repository will be maintained primarily by @Katsute and not @Ktt-Development

Note that this repository will still retain owner ship over:

• myanimelist.kttdevelopment.com domain
• com.kttdevelopment.myanimelist repository

Some of the search queries have a withQuery in the builder when it shouldn't. All the queries should be checked as this may not be the only one.

https://github.com/Katsute/Mal4J/blob/806f8a1216173ff0fcfcfdf29e34f4c3e99fe2b4/src/main/java/com/kttdevelopment/mal4j/query/AnimeSuggestionQuery.java#L56-L59

According to ZeroCrystal there are several undocumented fields for update (and possibly get). This library should audit all new possible methods asap.

https://myanimelist.net/forum/?topicid=1889002&show=0#msg61697894

• Code is wrapping lines instead of overflowing to scroll.
• Mobile view may be cluttered, add additional padding on main divs.

The object is created using the data[node.my_list_status] when it should use data[list_status].

The API by default does not return all fields and it is expected that in the future they will have rate limits.

This should be changed so there is a static variable ALL_ANIME_FIELDS and ALL_MANGA_FIELDS.

Currently the setup of null to all has lead to bugs where empty or null fields would lead to all of them being sent.

The API does not return a role even when explicitly listed on the field parameter.

This issue still exists as of 7/17/2022

Have the @me user return an AuthenticatedUser instead of user and have the class have additional methods to retrieve user anime and manga listings.

According to json these replacements must be made when converting from json to string:
\/ → /
\\ → \

ForumTopicDetail should be ForumTopic and ForumTopic should be ForumTopicDetail.

Have the forumTopicDetail method return a query instead of a list. This would make is consistent with other methods.

This repository acts independently of the main organization (Ktt Development) and is not posted on that site. This repository should instead maintain its own site for overview and documentation.

https://github.com/Katsute/Mal4J/blob/9da055d985834dcaaa851fe094258e2dddfc9c7a/src/main/java/com/kttdevelopment/mal4j/user/UserMangaStatistics.java#L86-L93

Add a new class that extends FieldSearchQuery with the withQuery method. For ForumSearchQuery just deprecate the field methods.

These objects only return longs at the moment, Date methods need to be added.

This class in particular ForumTopicDetail and Post.

Add method to retrieve expiry as a date.
Add method isExpired()

Relates to #67

For methods that return Date only, the update method should not allow setting a long value, only Dates.

Currently the API depends on Retrofit2 which itself depends on about a dozen libraries to operate. The long term goal is to try and get this library to operate with minimal or no dependencies.

Proposed Changes:

• Remove retrofit and handle requests internally

• Find a way to parse the JSON without using a library (or a standalone library)

• Make project modular (previously blocked by retrofit defect)

• Replicate retrofit behavior with annotations

• Replicate json behavior by reading line by line with regex, possibly trim spaces

MediaItem is missing some date return methods.

Some methods in the library may be unclear to some developers, a FAQ should be added to address these questions.

A link to this page should also be added in the issue templates, list, and readme.

When GitHub environments is released require manual approvals for deployments.