Add Audit Logs example application (#44)

* Add Audit Logs example application

* Add snackbar when events are fired

Co-authored-by: Adam Wolfman <[email protected]>

Author: awolfden

python-django-audit-logs-example/.gitignore

@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

python-django-audit-logs-example/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 WorkOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python-django-audit-logs-example/README.md

@@ -0,0 +1,137 @@
+# python-django-audit-logs-example
+
+An example Django application demonstrating how to use the [WorkOS Python SDK](https://github.com/workos/workos-python) to send and retrieve Audit Log events. This example is not meant to show a real-world example of an Audit Logs implementation, but rather to show concrete examples of how events can be sent using the Python SDK.
+
+## Prerequisites
+
+- Python 3.6+
+
+## Django Project Setup
+
+1. Clone the main git repo for these Python example apps using your preferred secure method (HTTPS or SSH).
+
+   ```bash
+   # HTTPS
+   $ git clone https://github.com/workos/python-django-example-applications.git
+   ```
+
+   or
+
+   ```bash
+   # SSH
+   $ git clone [email protected]:workos/python-django-example-applications.git
+   ```
+
+2. Navigate to the Admin Portal example app within the cloned repo.
+
+   ```bash
+   $ cd python-django-example-applications/python-django-audit-logs-example
+   ```
+
+3. Create and source a Python virtual environment. You should then see `(env)` at the beginning of your command-line prompt.
+
+   ```bash
+   $ python3 -m venv env
+   $ source env/bin/activate
+   (env) $
+   ```
+
+4. Install the cloned app's dependencies. If the `pip` command doesn't work, try `pip3` instead.
+
+   ```bash
+   (env) $ pip install -r requirements.txt
+   ```
+
+5. Obtain and make note of the following values. In the next step, these will be set as environment variables.
+
+   - Your [WorkOS API key](https://dashboard.workos.com/api-keys)
+   - Your [WorkOS Client ID](https://dashboard.workos.com/configuration)
+
+6. Ensure you're in the root directory for the example app, `python-django-audit-logs-example/`. Create a `.env` file to securely store the environment variables. Open this file with the Nano text editor. (This file is listed in this repo's `.gitignore` file, so your sensitive information will not be checked into version control.)
+
+   ```bash
+   (env) $ touch .env
+   (env) $ nano .env
+   ```
+
+7. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
+
+   ```bash
+   export WORKOS_API_KEY=<value found in step 6>
+   export WORKOS_CLIENT_ID=<value found in step 6>
+   ```
+
+   To exit the Nano text editor, type `CTRL + x`. When prompted to "Save modified buffer", type `Y`, then press the `Enter` or `Return` key.
+
+8. Source the environment variables so they are accessible to the operating system.
+
+   ```bash
+   (env) $ source .env
+   ```
+
+   You can ensure the environment variables were set correctly by running the following commands. The output should match the corresponding values.
+
+   ```bash
+   (env) $ echo $WORKOS_API_KEY
+   (env) $ echo $WORKOS_CLIENT_ID
+   ```
+
+9. Run the Django migrations. Again, ensure you're in the `python-django-sso-example/` directory where the `manange.py` file is.
+
+   ```bash
+   (env) $ python3 manage.py migrate
+   ```
+
+   You should see output like:
+
+   ```bash
+   Operations to perform:
+   Apply all migrations: admin, auth, contenttypes, sessions
+   Running migrations:
+   Applying contenttypes.0001_initial... OK
+   Applying auth.0001_initial... OK
+   . . .
+   ```
+
+10. The final setup step is to start the server.
+
+```bash
+(env) $ python3 manage.py runserver --insecure
+```
+
+You'll know the server is running when you see no warnings or errors in the CLI, and output similar to the following is displayed:
+
+```bash
+Watching for file changes with StatReloader
+Performing system checks...
+
+System check identified no issues (0 silenced).
+March 18, 2021 - 04:54:50
+Django version 3.1.7, using settings 'workos_django.settings'
+Starting development server at http://127.0.0.1:8000/
+Quit the server with CONTROL-C.
+```
+
+Navigate to `localhost:8000` in your web browser. You should see a place to enter your organization ID. This can be found in the WorkOS Dashboard for the Organization you'd like to send logs to.
+
+You can stop the local Django server for now by entering `CTRL + c` on the command line.
+
+### Audit Logs Setup with WorkOS
+
+11. Follow the [Audit Logs configuration steps](https://workos.com/docs/audit-logs/emit-an-audit-log-event/sign-in-to-your-workos-dashboard-account-and-configure-audit-log-event-schemas) to set up the following 5 events that are sent with this example:
+
+Action title: "user.signed_in" | Target type: "team"
+Action title: "user.logged_out" | Target type: "team"
+Action title: "user.organization_set" | Target type: "team"
+Action title: "user.organization_deleted" | Target type: "team"
+Action title: "user.connection_deleted" | Target type: "team"
+
+12. Next, take note of the Organization ID for the Org which you will be sending the Audit Log events for. This ID gets entered into the splash page of the example application.
+
+13. Once you enter the Organization ID and submit it, you will be brought to the page where you'll be able to send the audit log events that were just configured. You'll also notice that the action of setting the Organization triggered an Audit Log already. Click the buttons to send the respective events.
+
+14. To obtain a CSV of the Audit Log events that were sent for the last 30 days, click the "Export Events" button. This will bring you to a new page where you can download the events. Downloading the events is a 2 step process. First you need to create the report by clicking the "Generate CSV" button. Then click the "Access CSV" button to download a CSV of the Audit Log events for the selected Organization for the past 30 days.
+
+## Need help?
+
+If you get stuck and aren't able to resolve the issue by reading our API reference or tutorials, you can reach out to us at [email protected] and we'll lend a hand.

python-django-audit-logs-example/audit_logs/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

python-django-audit-logs-example/audit_logs/admin.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AuditLogsConfig(AppConfig):
+    name = "audit_logs"

python-django-audit-logs-example/audit_logs/apps.py

@@ -0,0 +1,96 @@
+from datetime import datetime
+
+user_signed_in = {
+    "action": "user.signed_in",
+    "occurred_at": datetime.now().isoformat(),
+    "actor": {
+        "type": "user",
+        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+    },
+    "targets": [
+        {
+            "type": "team",
+            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+        },
+    ],
+    "context": {
+        "location": "123.123.123.123",
+        "user_agent": "Chrome/104.0.0.0",
+    },
+}
+
+user_logged_out = {
+    "action": "user.logged_out",
+    "occurred_at": datetime.now().isoformat(),
+    "actor": {
+        "type": "user",
+        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+    },
+    "targets": [
+        {
+            "type": "team",
+            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+        },
+    ],
+    "context": {
+        "location": "123.123.123.123",
+        "user_agent": "Chrome/104.0.0.0",
+    },
+}
+
+user_organization_set = {
+    "action": "user.organization_set",
+    "occurred_at": datetime.now().isoformat(),
+    "actor": {
+        "type": "user",
+        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+    },
+    "targets": [
+        {
+            "type": "team",
+            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+        },
+    ],
+    "context": {
+        "location": "123.123.123.123",
+        "user_agent": "Chrome/104.0.0.0",
+    },
+}
+
+user_organization_deleted = {
+    "action": "user.organization_deleted",
+    "occurred_at": datetime.now().isoformat(),
+    "actor": {
+        "type": "user",
+        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+    },
+    "targets": [
+        {
+            "type": "team",
+            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+        },
+    ],
+    "context": {
+        "location": "123.123.123.123",
+        "user_agent": "Chrome/104.0.0.0",
+    },
+}
+
+user_connection_deleted = {
+    "action": "user.connection_deleted",
+    "occurred_at": datetime.now().isoformat(),
+    "actor": {
+        "type": "user",
+        "id": "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+    },
+    "targets": [
+        {
+            "type": "team",
+            "id": "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+        },
+    ],
+    "context": {
+        "location": "123.123.123.123",
+        "user_agent": "Chrome/104.0.0.0",
+    },
+}