-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Define model and refactor ApiClient #59
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ashfame
approved these changes
Sep 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! Structure of meta fields on post object in REST API response is what I chose. Let me know if you think changing any of that would simplify anything here as well.
ashfame
reviewed
Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this PR, I think there were some issues with the architecture:
Post
model was split between theapi/
and theparser/
, for example.api/
. This would tie the app to the format of the API. (There is some discussion on that here).ApiClient
contained all the methods of all data types (e.g. post, settings, users, etc) so it wouldn't scale (it would become a huge file that handles all types of data).This PR fixes all of the above issues, by:
model/
, which contains (for now)Post
,SiteSettings
andUser
. These are the structures that hold the data our app needs, in a format that is adequate for our use cases.ApiClient
into multiple modules, so that you can callapiClient.posts.create()
instead ofapiClient.createPost()
. Each module gets its own class, and can implement whatever methods are required for the given API.ApiClient
is an "adapter" that always returns instances of our model types, instead of API-specific types. In short, types defined underapi/
should never be used outside ofapi/
. The app should only used the types defined undermodel/
.I'm doing this now because I was experiencing issues due to the lack of a model when implementing the feature that retrieves an existing post and displays it on the app (title, title parsed, date, date parsed, etc), and also because I think it's better to address these issues early so that we can build on top of a strong foundation.
Some code examples: