From c761a07b7dc61d42013f9b29afd128271354dd81 Mon Sep 17 00:00:00 2001 From: Julio Biason Date: Tue, 22 Nov 2022 09:27:21 -0300 Subject: [PATCH] Shared IP and PORT --- design/caldav.md | 3 ++- design/deezer.md | 2 +- design/email.md | 2 ++ design/guildwars2.md | 3 ++- design/mastodon.md | 3 ++- design/netflix.md | 3 ++- design/rss.md | 3 ++- design/steam.md | 3 ++- design/store.md | 27 ++++++++++++++++++--------- 9 files changed, 33 insertions(+), 16 deletions(-) diff --git a/design/caldav.md b/design/caldav.md index a3f3fdf..75ab402 100644 --- a/design/caldav.md +++ b/design/caldav.md @@ -6,7 +6,8 @@ CalDav uses the [iCalendar](https://en.wikipedia.org/wiki/ICalendar) format. ## Configuration -The CalDav capturer needs the URL for the CalDav. +The CalDav capturer needs the URL for the CalDav, besides the IP and PORT of +Store. ## Internals diff --git a/design/deezer.md b/design/deezer.md index 548cf71..8d508bb 100644 --- a/design/deezer.md +++ b/design/deezer.md @@ -8,7 +8,7 @@ user. ## Configuration -Configuration requires the OAuth token. +Configuration requires the OAuth token, besides the IP and PORT of the Store. ## Internals diff --git a/design/email.md b/design/email.md index 57982ed..c3ae409 100644 --- a/design/email.md +++ b/design/email.md @@ -13,6 +13,8 @@ The Capturer will require: - Username - Password +... besides the IP and PORT of the Store. + **Note**: We may need to support IMAPS. ## Internals diff --git a/design/guildwars2.md b/design/guildwars2.md index d510808..7ed54c0 100644 --- a/design/guildwars2.md +++ b/design/guildwars2.md @@ -5,7 +5,8 @@ completed achievements and play time. ## Configuration -The only required configuration is the access token. +The only required configuration is the access token, besides the IP and PORT of +the Store. ## Internals diff --git a/design/mastodon.md b/design/mastodon.md index 6a89c06..bbd4c75 100644 --- a/design/mastodon.md +++ b/design/mastodon.md @@ -6,7 +6,8 @@ private and such, which seem better. ## Configuration -The only required configuration is the access token. +The only required configuration is the access token, besides the IP and PORT of +the Store. ## Internals diff --git a/design/netflix.md b/design/netflix.md index a9fc2e1..07604f7 100644 --- a/design/netflix.md +++ b/design/netflix.md @@ -6,7 +6,8 @@ There is no API. We need to scrap the user account page to find that out. ## Configuration -Sadly, we may need username and password in the configuration. +Sadly, we may need username and password in the configuration, besides the IP +and PORT of the Store. ## Internals diff --git a/design/rss.md b/design/rss.md index f317db5..9f42d10 100644 --- a/design/rss.md +++ b/design/rss.md @@ -6,7 +6,8 @@ Markdown (although I've done this before, using ## Configuration -The only required configuration is the feed URL. +The only required configuration is the feed URL, besides the IP and PORT of the +Store. ## Internals diff --git a/design/steam.md b/design/steam.md index ca656a7..d55527d 100644 --- a/design/steam.md +++ b/design/steam.md @@ -8,7 +8,8 @@ be captured. ## Configuration -The only required configuration is the Steam ID. +The only required configuration is the Steam ID, besides the IP and PORT of the +Store. ## Internals diff --git a/design/store.md b/design/store.md index 1d484e1..7ca5d18 100644 --- a/design/store.md +++ b/design/store.md @@ -4,9 +4,18 @@ The Store is the central point of the application. It is responsible for keeping all the information sent by Capturers and providing a search/list functionality for Viewers. +## Configuration + +We would need, at least (probably in envvars): + +- `IP`: Binding IP for the server. +- `PORT`: Binding port for the server. + +## Internals + We would probably need a design like: -## Entry +### Entry | Field | Description | | ------- | --------------------------------------------------- | @@ -15,7 +24,7 @@ We would probably need a design like: | content | Text, produced by a Capturer. It's always Markdown. | | source | Capturer name. | -## Meta +### Meta Meta contains the meta information of the entry, used by a Capturer. A view may or may not display those fields. @@ -27,14 +36,14 @@ or may not display those fields. | name | Meta field name. | | value | Meta field value. | -## Attachments +### Attachments Attachments are not meta information, but something related to the entry -- for example, if the content contains any images, those are added as attachments. -| Field | Description | -| ------------ | --------------------------------------------------- | -| id | UUID of the record. | -| entry | ForeignKey of the entry. | -| content_type | Type of the content. | -| content | Attachment content, in Base64. | +| Field | Description | +| ------------- | --------------------------------------------------- | +| id | UUID of the record. | +| entry | ForeignKey of the entry. | +| content\_type | Type of the content. | +| content | Attachment content, in Base64. |