Merge pull request #166 from HackSoftware/files/more-improvements

Files: Improvements

Author: RadoRado

.env.example

@@ -6,5 +6,6 @@ FILE_UPLOAD_STORAGE="local" # s3
 
 AWS_S3_ACCESS_KEY_ID=""
 AWS_S3_SECRET_ACCESS_KEY=""
-AWS_STORAGE_BUCKET_NAME="django-styleguide-example"
-AWS_S3_REGION_NAME="eu-central-1"
+AWS_STORAGE_BUCKET_NAME=""
+AWS_S3_REGION_NAME=""
+AWS_S3_CUSTOM_DOMAIN=""

README.md

@@ -9,6 +9,34 @@
 
 ---
 
+**Table of contents:**
+
+<!-- toc -->
+
+- [General API Stuff](#general-api-stuff)
+  * [CORS](#cors)
+- [Authentication - JWT](#authentication---jwt)
+  * [Settings](#settings)
+  * [APIs](#apis)
+  * [Requiring authentication](#requiring-authentication)
+- [Authentication - Sessions](#authentication---sessions)
+  * [DRF & Overriding `SessionAuthentication`](#drf--overriding-sessionauthentication)
+  * [Cross origin](#cross-origin)
+  * [APIs](#apis-1)
+  * [`HTTP Only` / `SameSite`](#http-only--samesite)
+  * [Reading list](#reading-list)
+- [Example List API](#example-list-api)
+- [File uploads](#file-uploads)
+- [Helpful commands for local development without docker-compose](#helpful-commands-for-local-development-without-docker-compose)
+- [Helpful commands for local development with docker-compose](#helpful-commands-for-local-development-with-docker-compose)
+- [Deployment](#deployment)
+  * [Heroku](#heroku)
+  * [AWS ECS](#aws-ecs)
+
+<!-- tocstop -->
+
+---
+
 This project serves as an [example of our styleguide](https://github.com/HackSoftware/Django-Styleguide)
 
 The structure is inspired by [cookiecutter-django](https://github.com/pydanny/cookiecutter-django) and modified based on our experience with Django.
@@ -202,6 +230,25 @@ Example data structure:
 }
 ```
 
+## File uploads
+
+Following this article - <https://www.hacksoft.io/blog/direct-to-s3-file-upload-with-django> - there's a rich file-upload implementation in the Django Styleguide Example.
+
+Everything is located in the `files` app.
+
+Configuration wise, everything is located in [`config/settings/files_and_storages.py`](config/settings/files_and_storages.py)
+
+Additionally, you can check the available options in [`.env.example`](.env.example)
+
+Currently, the following is supported:
+
+1. Standard local file upload.
+1. Standard S3 file upload.
+1. Using CloudFront as CDN.
+1. The so-called "direct" upload that can work both locally and with S3 (for more context, [check the article](https://www.hacksoft.io/blog/direct-to-s3-file-upload-with-django))
+
+Feel free to use this as the basis of your file upload needs.
+
 ## Helpful commands for local development without docker-compose
 
 To create Postgres database:

config/settings/files_and_storages.py

@@ -36,3 +36,8 @@
     AWS_DEFAULT_ACL = env("AWS_DEFAULT_ACL", default="private")
 
     AWS_PRESIGNED_EXPIRY = env.int("AWS_PRESIGNED_EXPIRY", default=10)  # seconds
+
+    _AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN", default="")
+
+    if _AWS_S3_CUSTOM_DOMAIN:
+        AWS_S3_CUSTOM_DOMAIN = _AWS_S3_CUSTOM_DOMAIN

markdown_tools/toc.py

@@ -0,0 +1,44 @@
+import re
+from subprocess import check_output
+
+
+def get_new_toc():
+    new_toc = check_output(
+        'markdown-toc README.md',
+        shell=True
+    ).decode('utf-8')
+
+    pattern = ['<!-- toc -->', '', new_toc, '', '<!-- tocstop -->']
+
+    return '\n'.join(pattern)
+
+
+def get_readme():
+    with open('README.md', 'r') as f:
+        return f.read()
+
+
+def save_readme(readme):
+    with open('README.md', 'w') as f:
+        return f.write(readme)
+
+
+def replace_toc():
+    readme = get_readme()
+    new_toc = get_new_toc()
+
+    regex = '<!-- toc -->(.|\n)+<!-- tocstop -->'
+
+    new_readme = re.sub(regex, new_toc, readme)
+
+    save_readme(new_readme)
+
+    print('TOC updated ...')
+
+
+def main():
+    return replace_toc()
+
+
+if __name__ == '__main__':
+    main()

styleguide_example/files/tests/__init__.py

@@ -0,0 +1,9 @@
+from django.test import TestCase
+
+
+class DirectUploadApiTests(TestCase):
+    """
+    We want to test the following:
+
+    1. A start-upload-finish cycle, where we patch the presign generation with local upload storage.
+    """

styleguide_example/files/tests/flows/__init__.py

@@ -0,0 +1,26 @@
+from django.test import TestCase
+
+
+class StandardUploadApiTests(TestCase):
+    """
+    We want to test the following general cases:
+
+    1. Upload a file, below the size limit, assert models gets created accordingly.
+    1. Upload a file, above the size limit (patch settings), assert API error, nothing gets created.
+    """
+
+
+class StandardUploadAdminTests(TestCase):
+    """
+    We want to test the following general cases:
+
+    File within size limit:
+
+    1. Create a new file via the Django admin, assert everything gets created (we are using services there).
+    2. Update an existing file via the Django admin, assert everything gets updated (we are using services there).
+
+    File not within size limit:
+
+    1. Create a new file via the Django admin, assert error, nothing gets created.
+    2. Update an existing fila via the Django admin, assert error, nothing gets created.
+    """