Refactoring slack channel creation

Author: stefdworschak

docker-compose.yml

@@ -25,6 +25,7 @@ services:
 
     environment:
       - ENV_FILE=/hackathon-app/.env
+      - DEVELOPMENT=1
       - STATIC_URL=https://codeinstitute-webpublic.s3.eu-west-1.amazonaws.com/hackathon_staticfiles/1.62-a/
     entrypoint: ['python3', 'manage.py', 'runserver', '0.0.0.0:8000']
     ports:
@@ -37,11 +38,30 @@ services:
     environment:
       - ENV_FILE=/hackathon-app/.env
       - DEVELOPMENT=1
+      - STATIC_URL=https://codeinstitute-webpublic.s3.eu-west-1.amazonaws.com/hackathon_staticfiles/1.62-a/
     entrypoint: ["celery", "-A", "main", "worker", "-l",  "info"]
     volumes:
+      - ./staticfiles/:/hackathon-app/staticfiles/
       - ./data/:/hackathon-app/data/
       - ./.env:/hackathon-app/.env
 
+      # code
+      - ./accounts/:/hackathon-app/accounts/
+      - ./competencies/:/hackathon-app/competencies/
+      - ./custom_slack_provider/:/hackathon-app/custom_slack_provider/
+      - ./hackadmin/:/hackathon-app/hackadmin/
+      - ./hackathon/:/hackathon-app/hackathon/
+      - ./home/:/hackathon-app/home/
+      - ./images/:/hackathon-app/images/
+      - ./main/:/hackathon-app/main/
+      - ./profiles/:/hackathon-app/profiles/
+      - ./resources/:/hackathon-app/resources/
+      - ./showcase/:/hackathon-app/showcase/
+      - ./submissions/:/hackathon-app/submissions/
+      - ./teams/:/hackathon-app/teams/
+      - ./templates/:/hackathon-app/templates/
+      - ./static/:/hackathon-app/static/
+
   mysql:
     image: docker.io/mysql:5.6.36
     command: mysqld --character-set-server=utf8 --collation-server=utf8_general_ci

hackathon/migrations/0047_hackathon_channel_prefix.py

@@ -0,0 +1,30 @@
+# Generated by Django 3.1.13 on 2023-01-23 12:19
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('hackathon', '0048_auto_20221219_1655'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='hackathon',
+            name='channel_admins',
+            field=models.ManyToManyField(blank=True, related_name='administered_channels', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AddField(
+            model_name='hackathon',
+            name='channel_name',
+            field=models.CharField(blank=True, help_text="Only use lowercase and dash ('-') for spaces", max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='hackathon',
+            name='channel_url',
+            field=models.CharField(blank=True, help_text='Url', max_length=255, null=True),
+        ),
+    ]

hackathon/migrations/0048_hackathon_channel_url.py

@@ -234,21 +234,48 @@ def calculate_timezone_offset(timezone, timezone_offset):
     return offset - timezone_offset
 
 
+def create_slack_channel(endpoint, headers, params):
+    create_response = requests.get(endpoint, params=params, headers=headers)
+    if create_response.status_code != 200:
+        return {
+            'ok': False,
+            'error': ('An error occurred creating the Private Slack Channel. '
+                      f'Error code: {create_response.get("error")}')
+        }
+
+    create_response = create_response.json()
+    if not create_response.get('ok'):
+        if create_response.get('error') == 'name_taken':
+            error_msg = (f'An error occurred creating the Private Slack Channel. '
+                         f'A channel with the name "{params["name"]}" already '
+                         f'exists. Please change your team name and try again '
+                         f'or contact an administrator')
+        else:
+            error_msg = (f'An error occurred creating the Private Slack Channel. '
+                         f'Error code: {create_response.get("error")}')
+        return {
+            'ok': False,
+            'error': error_msg
+        }
+
+    return create_response
+
+
 def invite_users_to_slack_channel(endpoint, headers, params):
     response = requests.post(endpoint, params=params, headers=headers)
-    if not response.status_code == 200:
+    if response.status_code != 200:
         return {
             'ok': False,
             'error': ('An unexpected error occurred creating the '
                       'Private Slack Channel.')
         }
-    
+
     response = response.json()
     if not response.get('ok'):
         return {
             'ok': False,
             'error': ('An error occurred creating the Private Slack Channel. '
                       f'Error code: {response.get("error")}')
         }
-    
+
     return {'ok': True, 'response': response}

hackathon/migrations/0049_auto_20230123_1219.py

@@ -20,7 +20,8 @@
     choose_team_levels, find_all_combinations,
     distribute_participants_to_teams,
     create_teams_in_view, update_team_participants,
-    calculate_timezone_offset, invite_users_to_slack_channel)
+    calculate_timezone_offset, invite_users_to_slack_channel,
+    create_slack_channel)
 from teams.forms import HackProjectForm, EditTeamName
 
 SLACK_CHANNEL_ENDPOINT = 'https://slack.com/api/conversations.create'
@@ -246,9 +247,9 @@ def create_private_channel(request, team_id):
         return redirect(reverse('view_team', kwargs={'team_id': team_id}))
 
     # Create new channel
-    date_str = datetime.now().strftime('%y%m')
+    date_str = datetime.now().strftime('%b-%y').lower()
     team_name = re.sub('[^A-Za-z0-9]+', '', team.display_name.lower())
-    channel_name = f'{date_str}-hackathon-{team_name}'
+    channel_name = f'{date_str}-hackathon-{team.hackathon.id}-{team_name}'
     params = {
         'team_id': settings.SLACK_TEAM_ID,
         'name': channel_name,
@@ -257,27 +258,12 @@ def create_private_channel(request, team_id):
     # Cannot use Bot Token to create a channel if workspace settings
     # specify only Admins and Owners can create channels 
     headers = {'Authorization': f'Bearer {settings.SLACK_ADMIN_TOKEN}'}
-    create_response = requests.get(SLACK_CHANNEL_ENDPOINT, params=params,
-                                   headers=headers)
-    if not create_response.status_code == 200:
-        messages.error(request, (f'An error occurred creating the Private Slack Channel. '
-                                 f'Error code: {create_response.get("error")}'))
-        return redirect(reverse('view_team', kwargs={'team_id': team_id}))
-    
-    create_response = create_response.json()
-    if not create_response.get('ok'):
-        if create_response.get('error') == 'name_taken':
-            error_msg = (f'An error occurred creating the Private Slack Channel. '
-                         f'A channel with the name "{channel_name}" already '
-                         f'exists. Please change your team name and try again '
-                         f'or contact an administrator')
-        else:
-            error_msg = (f'An error occurred creating the Private Slack Channel. '
-                         f'Error code: {create_response.get("error")}')
-        messages.error(request, error_msg)
+    channel_response = create_slack_channel(SLACK_CHANNEL_ENDPOINT, headers, params)
+    if not response['ok']:
+        messages.error(request, response['error'])
         return redirect(reverse('view_team', kwargs={'team_id': team_id}))
-    
-    channel = create_response.get('channel', {}).get('id')
+
+    channel = channel_response.get('channel', {}).get('id')
     communication_channel = (f'https://{settings.SLACK_WORKSPACE}.slack.com/'
                              f'app_redirect?channel={channel}')
     team.communication_channel = communication_channel