CV3-50-story(book-event): add book meeting functionality (#511)

- add book event class and mutate function
- add helper to validate user date input
- add test for added lines

[Finishes CV3-50]

Author: adafia

.gitignore

@@ -140,5 +140,5 @@ converge_db/
 events.json
 calendar_list.json
 
-# maintain consistent coding styles 
+# maintain consistent coding styles
 .editorconfig

api/events/schema.py

@@ -14,7 +14,10 @@
 )
 from helpers.calendar.events import RoomSchedules, CalendarEvents
 from helpers.email.email import notification
-from helpers.calendar.credentials import get_single_calendar_event
+from helpers.calendar.credentials import (
+    get_single_calendar_event,
+    credentials
+)
 from helpers.auth.authentication import Auth
 from helpers.pagination.paginate import ListPaginate
 from helpers.devices.devices import update_device_last_activity
@@ -23,6 +26,10 @@
     validate_page_and_per_page,
     validate_calendar_id_input
 )
+from helpers.events_filter.events_filter import (
+    calendar_dates_format,
+    empty_string_checker
+)
 
 utc = pytz.utc
 
@@ -35,6 +42,87 @@ class Meta:
         model = EventsModel
 
 
+class BookEvent(graphene.Mutation):
+    """
+        Book Calendar events
+    """
+    response = graphene.String()
+
+    class Arguments:
+        event_title = graphene.String(required=True)
+        start_date = graphene.String(required=True)
+        start_time = graphene.String(required=True)
+        duration = graphene.Float(required=False)
+        attendees = graphene.String(required=False)
+        organizer = graphene.String(required=False)
+        description = graphene.String(required=False)
+        room = graphene.String(required=True)
+        time_zone = graphene.String(required=True)
+
+    @Auth.user_roles('Admin', 'Default User', 'Super Admin')
+    def mutate(self, info, **kwargs):
+        """Creates calendar events
+
+        Args:
+            event_title: A sting that communicates the event summary/title
+            [required]
+            start_date: The start date of the event eg. 'Nov 4 2019' [required]
+            start_time: The end time of the event eg '07:00 AM' [required]
+            duration: A float of the duration of the event in minutes
+            attendees: A string of emails of the event guests
+            description: Any additional information about the event
+            room: The meeting room where the even will be held [required]
+            time_zone: The timezone of the event location eg. 'Africa/Kigali'
+            organizer: The email of the co-organizer, the converge email is
+            the default
+
+        Returns:
+            A string that communicates a successfully created event.
+        """
+        room = kwargs.get('room', None)
+        attendees = kwargs.get('attendees', None)
+        description = kwargs.get('description', None)
+        time_zone = kwargs.get('time_zone', 'Africa/Accra')
+        duration = kwargs.get('duration', 60)
+        organizer = kwargs.get('organizer', None)
+
+        event_title = kwargs['event_title']
+        empty_string_checker(event_title)
+        empty_string_checker(room)
+        empty_string_checker(time_zone)
+
+        start_date, end_date = calendar_dates_format(
+            kwargs['start_date'], kwargs['start_time'], duration)
+
+        attendees = attendees.replace(" ", "").split(",")
+        guests = []
+        for guest in attendees:
+            attendee = {'email': guest}
+            guests.append(attendee)
+
+        event = {
+            'summary': kwargs['event_title'],
+            'location': room,
+            'description': description,
+            'start': {
+                'dateTime': start_date,
+                'timeZone': time_zone,
+            },
+            'end': {
+                'dateTime': end_date,
+                'timeZone': time_zone,
+            },
+            'attendees': guests,
+            "organizer": {
+                "email": organizer
+            }
+        }
+        service = credentials.set_api_credentials()
+        service.events().insert(calendarId='primary', body=event,
+                                sendNotifications=True).execute()
+        return BookEvent(response='Event created successfully')
+
+
 class EventCheckin(graphene.Mutation):
     """
         Returns the eventcheckin payload
@@ -204,6 +292,19 @@ def check_event_in_db(instance, info, event_check, **kwargs):
 class Mutation(graphene.ObjectType):
     event_checkin = EventCheckin.Field()
     cancel_event = CancelEvent.Field()
+    book_event = BookEvent.Field(
+        description="Mutation to book a calendar event given the arguments\
+            \n- event_title: A sting that communicates the event\
+            summary/title [required]\n- start_date: The start date \
+                 of the event eg 'Nov 4 2019' [required]\
+            \n- start_time: The end time of the event eg'07:00 AM'[required]\
+            \n- duration: A float of the duration of the event in minutes\
+            \n- attendees: A string of emails of the event guests\
+            \n- description: Any additional information about the event\
+            \n- room: The meeting room where the even will be held[required]\
+            \n- organizer: The email of the co - organizer, the converge\
+                email is the default\
+            \n- time_zone: The timezone of the event location")
     end_event = EndEvent.Field(
         description="Mutation to end a calendar event given the arguments\
             \n- calendar_id: The unique identifier of the calendar event\

fixtures/events/book_event_fixtures.py

@@ -0,0 +1,89 @@
+book_event_mutation = '''mutation {
+    bookEvent(
+        eventTitle:"Hello Converge",
+        startDate:"2029-11-06",
+        startTime:"10:00",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "Africa/Kigali",
+        room:"Yankara"
+    ){
+            response
+        }
+    }
+'''
+
+book_event_mutation_no_title = '''mutation {
+    bookEvent(
+        eventTitle:"",
+        startDate:"2019-11-06",
+        startTime:"10:00",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "Africa/Kigali",
+        room:"Yankara"
+    ){
+            response
+        }
+    }
+'''
+
+book_event_mutation_no_room = '''mutation {
+    bookEvent(
+        eventTitle:"Hello Converge",
+        startDate:"2019-11-06",
+        startTime:"10:00",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "Africa/Kigali",
+        room:""
+    ){
+            response
+        }
+    }
+'''
+
+book_event_mutation_no_start_date = '''mutation {
+    bookEvent(
+        eventTitle:"Hello Converge",
+        startDate:"",
+        startTime:"10:00",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "Africa/Kigali",
+        room:"Yankara"
+    ){
+            response
+        }
+    }
+'''
+
+book_event_mutation_no_start_time = '''mutation {
+    bookEvent(
+        eventTitle:"Hello Converge",
+        startDate:"2019-11-06",
+        startTime:"",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "Africa/Kigali",
+        room:"Yankara"
+    ){
+            response
+        }
+    }
+'''
+
+book_event_mutation_no_time_Zone = '''mutation {
+    bookEvent(
+        eventTitle:"Hello Converge",
+        startDate:"2019-11-06",
+        startTime:"10:00",
+        duration:60
+        attendees: "[email protected], [email protected]",
+        timeZone: "",
+        room:"Yankara"
+    ){
+            response
+        }
+    }
+'''

fixtures/events/events_query_by_date_fixtures.py

@@ -51,11 +51,11 @@
     'data': {
         'allEvents': {
             'events': [{
-                    'id': '1',
-                    'roomId': 1,
-                    'room': {
-                        'name': 'Entebbe'
-                        }
+                'id': '1',
+                'roomId': 1,
+                'room': {
+                    'name': 'Entebbe'
+                }
             }],
             'hasNext': False,
             'hasPrevious': False,
@@ -200,14 +200,14 @@
 '''
 
 event_query_without_page_and_per_page_response = {
-  'data': {
+    'data': {
         'allEvents': {
             'events': [{
-                    'id': '1',
-                    'roomId': 1,
-                    'room': {
-                        'name': 'Entebbe'
-                        }
+                'id': '1',
+                'roomId': 1,
+                'room': {
+                    'name': 'Entebbe'
+                }
             }],
             'hasNext': None,
             'hasPrevious': None,

helpers/calendar/credentials.py

@@ -37,6 +37,9 @@ def set_api_credentials(self):
         return service
 
 
+credentials = Credentials()
+
+
 def get_google_calendar_events(calendarId=None, timeMin=None,
                                timeMax=None, singleEvents=None, orderBy=None,
                                syncToken=None, pageToken=None
@@ -78,7 +81,7 @@ def get_single_calendar_event(calendar_id, event_id):
     credentials = Credentials()
     service = credentials.set_api_credentials()
     event = service.events().get(
-                                calendarId=calendar_id,
-                                eventId=event_id
-                                ).execute()
+        calendarId=calendar_id,
+        eventId=event_id
+    ).execute()
     return event

helpers/events_filter/events_filter.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from graphql import GraphQLError
 import pytz
+import inspect
 from dateutil import parser
 
 
@@ -63,3 +64,64 @@ def sort_events_by_date(events):
     events.sort(
         key=lambda x: parser.parse(x.start_time).astimezone(utc),
         reverse=True)
+
+
+def empty_string_checker(string_to_check):
+    """Raises a GraphQL error when an empty string is passed
+
+    Args:
+        string_to_check: Any string that should not be empty
+    """
+    frame = inspect.currentframe()
+    info_data = inspect.getouterframes(frame, context=1)
+    context = info_data[1].code_context[0].strip()
+    error_title = context[context.index("(") + 1:context.rindex(")")]
+    if not string_to_check:
+        raise GraphQLError('{} can not be empty'.format(error_title))
+
+
+def date_time_format_validator(date_text, time_text):
+    """This function validates the date and time format
+
+    Args:
+        start_date: Date string of the day of the event:'YY-MM-DD'
+        start_time: Time sting of the time of the event: 'HH:MM'
+    """
+    try:
+        datetime.strptime(date_text, '%Y-%m-%d')
+    except ValueError:
+        raise ValueError("start date should be in this format: 'YY-MM-DD'")
+    try:
+        datetime.strptime(time_text, '%H:%M')
+    except ValueError:
+        raise ValueError("start time should be in this format: 'HH:MM'")
+
+
+def calendar_dates_format(start_date, start_time, duration):
+    """Converts user date, time and duration input into start_date
+        and end_date format that is acceptable by the Google Calendar API
+
+    Args:
+        start_date: Date string of the day of the event
+        start_time: Time sting of the time of the event
+        duration: A float of the duration of the event
+
+    Returns:
+        start_date and end_date in this format "%Y-%m-%dT%H:%M:%S".
+    """
+    empty_string_checker(start_date)
+    empty_string_checker(start_time)
+    date_time_format_validator(start_date, start_time)
+    start_date = start_date + " " + start_time
+    start_date = parser.parse(start_date)
+    current_date = datetime.now()
+
+    if current_date > start_date:
+        raise GraphQLError("Sorry time travel hasn't been invented yet")
+
+    end_date = start_date + timedelta(minutes=duration)
+
+    start_date = start_date.strftime('%Y-%m-%dT%H:%M:%S')
+    end_date = end_date.strftime('%Y-%m-%dT%H:%M:%S')
+
+    return (start_date, end_date)