Merge pull request #29 from SamR1/add-token

Add token to access feeds

Author: SamR1

Makefile.config

@@ -7,6 +7,7 @@ export FLASK_ENV=development
 export TWOOTFEED_CONFIG_DIR=$(APP_PATH)/
 export TWOOTFEED_CONFIG_FILE=$(APP_PATH)/config.yml
 export TWOOTFEED_LOG=twootfeed.log
+export TWOOTFEED_SETTINGS=DevelopmentConfig
 
 GUNICORN_LOG=gunicorn.log
 

docs/_images/FreshRSS.png

@@ -20,49 +20,7 @@ The feed displays only the original tweets (not the retweets) and toots, with:
 - location (only for Twitter)
 - numbers of retweets and likes for tweets and boosts and favourites for toots
 
+.. warning::
 
-
-.. danger::
-
-   | **twootfeed** is developed for personal use.
-   | Tweets and toots are displayed for the user associated to API keys, it may expose private items if feeds are publicly available.
-
-
-Examples
-~~~~~~~~
-
-- Search on Twitter
-
-.. figure:: _images/twitter.png
-   :alt: Twitter search
-   :figclass: doc-img
-
-Results in RSS Feed:
-
-.. figure:: _images/RSSFeed.png
-   :alt: RSS Feed
-   :figclass: doc-img
-
-Display on FreshRSS, a great free self-hosted aggregator (https://github.com/FreshRSS/FreshRSS):
-
-.. figure:: _images/FreshRSS.png
-   :alt: FreshRSS
-   :figclass: doc-img
-
-- Search on Mastodon
-
-.. figure:: _images/mastodon.png
-   :alt: Mastodon search
-   :figclass: doc-img
-
-Results in RSS Feed:
-
-.. figure:: _images/MastodonRSSFeed.png
-   :alt: Mastodon Feed
-   :figclass: doc-img
-
-Display on FreshRSS:
-
-.. figure:: _images/MastodonFreshRSS.png
-   :alt: Mastodon FreshRSS
-   :figclass: doc-img
+   | **twootfeed** is developed for a personal use.
+   | Tweets and toots are displayed for the user associated to the API keys (feeds may contain items with **restricted visibility**).

docs/_images/MastodonFreshRSS.png

@@ -41,16 +41,45 @@ Installation
 
     Update the `feed and app parameters <parameters.html>`_.
 
+    .. versionadded:: 0.7.0
+
+    Since **twootfeed** is connected to the user account, feeds may display items with **restricted visibility**.
+
+    A token is now mandatory to start the application and access feeds (minimum length: 25 characters).
+
+    Some examples for token generation:
+
+    > with Python
+
+    .. code-block:: bash
+
+        $ python
+        Python 3.10.5 (main, Jun  6 2022, 18:49:26) [GCC 12.1.0] on linux
+        Type "help", "copyright", "credits" or "license" for more information.
+        >>> import secrets
+        >>> secrets.token_urlsafe()
+        'pgoeS3qOsLHxduzNY_gmn6p5vWZqSzqBgnb_VPupQ7o'
+        >>>
+
+    > with a linux command line
+
+    .. code-block:: bash
+
+        $ date | sha256sum | base64 | head -c 25; echo
+        NWU2MzE1ZGM0MmVlZDg5NDNhN
+
+
 
 - The files location can be changed with the following environment variables:
 
-========================= =============================================== ===========================================================================================
- variable                 description                                     app default value
-========================= =============================================== ===========================================================================================
- `TWOOTFEED_CONFIG_DIR`   configuration and credentials files directory   **'~/.config/twootfeed/'**
- `TWOOTFEED_CONFIG_FILE`  config file full path                           config dir + **'config.yml'** => with default value: **'~/.config/twootfeed/config.yml'**
- `TWOOTFEED_LOG`          application log file                            _no default value (log printed on the console)_
-========================= =============================================== ===========================================================================================
+=========================== =============================================== ===========================================================================================
+ variable                   description                                     app default value
+=========================== =============================================== ===========================================================================================
+ ``TWOOTFEED_CONFIG_DIR``   configuration and credentials files directory   **'~/.config/twootfeed/'**
+ ``TWOOTFEED_CONFIG_FILE``  config file full path                           config dir + **'config.yml'** => with default value: **'~/.config/twootfeed/config.yml'**
+ ``TWOOTFEED_LOG``          application log file                            `no default value (log printed on the console)`
+ ``TWOOTFEED_SETTINGS``     application settings                            **'ProductionConfig'**
+=========================== =============================================== ===========================================================================================
 
 - Start the app
 
@@ -62,33 +91,35 @@ Installation
 Usage
 ~~~~~
 
-The RSS feeds are available on these urls:
+The following RSS feeds are available:
 
 - for Twitter search:
 
-    - http://localhost:8080/tweets/<keywords>
-    - http://localhost:8080/<keywords>  (*will be deprecated in a next version*)
+    - http://localhost:8080/tweets/<keywords>?token=XXX
+    - http://localhost:8080/<keywords>?token=XXX  (*will be deprecated in a next version*)
 
 - for Mastodon search:
 
     - keyword as a hashtag:
 
-        - http://localhost:8080/toots/<hashtag> (without the leading #)
+        - http://localhost:8080/toots/<hashtag>?token=XXX (without the leading #)
 
     - query:
 
-        - http://localhost:8080/toots/search/<query>
-        - http://localhost:8080/toot_search/<query> (*will be deprecated in a next version*)
+        - http://localhost:8080/toots/search/<query>?token=XXX
+        - http://localhost:8080/toot_search/<query>?token=XXX (*will be deprecated in a next version*)
 
 - for Mastodon connected user favorites:
 
-    - http://localhost:8080/toots/favorites
-    - http://localhost:8080/toot_favorites (*will be deprecated in a next version*)
+    - http://localhost:8080/toots/favorites?token=XXX
+    - http://localhost:8080/toot_favorites?token=XXX (*will be deprecated in a next version*)
 
 - for Mastodon connected user bookmarks:
 
-    - http://localhost:8080/toots/bookmarks
+    - http://localhost:8080/toots/bookmarks?token=XXX
 
 - for Mastodon connected user home timeline:
 
-    - http://localhost:8080/toots/home_timeline
+    - http://localhost:8080/toots/home_timeline?token=XXX
+
+where XXX is the token set in configuration.

docs/_images/MastodonRSSFeed.png

@@ -25,6 +25,7 @@ Application parameters are stored in ``config.yml`` file:
       timezone: 'Europe/Paris'
       text_length_limit: 100
       max_items: 20
+      token: ''
     app:
       host: '0.0.0.0'
       port: '8080'
@@ -54,6 +55,7 @@ Feed
 * **timezone**: Feed timezone
 * **text_length_limit:** title length of a Feed item
 * **max_items**: maximum number of displayed items
+* **token**: token for feeds access
 
 App
 ~~~