Astra route (#257)

* Simplify .gitignore

* Update master workflow

* Fix dockerfile

* Update master host config

* add astra route in server.go

* astra controller and route

* Fix conflicts w/ master branch

---------

Co-authored-by: jpahm <20374744+jpahm@users.noreply.github.com>

Author: recursiveTurtle

api/controllers/astra.go

@@ -0,0 +1,46 @@
+package controllers
+
+import (
+	"context"
+	"net/http"
+	"time"
+
+	"github.com/gin-gonic/gin"
+
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
+
+	"github.com/UTDNebula/nebula-api/api/configs"
+	"github.com/UTDNebula/nebula-api/api/responses"
+	"github.com/UTDNebula/nebula-api/api/schema"
+)
+
+var astraCollection *mongo.Collection = configs.GetCollection("astra")
+
+// @Id AstraEvents
+// @Router /astra/{date} [get]
+// @Description "Returns AstraEvent based on the input date"
+// @Produce json
+// @Param date path string true "date (ISO format) to retrieve astra events"
+// @Success 200 {array} schema.MultiBuildingEvents[schema.AstraEvent] "All AstraEvents with events on the inputted date"
+func AstraEvents(c *gin.Context) {
+	//gin context has info about request and allows converting to json format
+
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	defer cancel() //make resources available if function returns before timeout
+
+	date := c.Param("date") //input date
+
+	var astra_events schema.MultiBuildingEvents[schema.AstraEvent] //stores astra events for input date
+
+	//find astra event given date
+	err := astraCollection.FindOne(ctx, bson.M{"date": date}).Decode(&astra_events)
+
+	//if there is an error
+	if err != nil {
+		c.JSON(http.StatusInternalServerError, responses.ErrorResponse{Status: http.StatusInternalServerError, Message: "error", Data: err.Error()})
+		return
+	}
+	//no error
+	c.JSON(http.StatusOK, responses.MultiBuildingEventsResponse[schema.AstraEvent]{Status: http.StatusOK, Message: "success", Data: astra_events})
+}

api/docs/docs.go

@@ -15,6 +15,35 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
+        "/astra/{date}": {
+            "get": {
+                "description": "\"Returns AstraEvent based on the input date\"",
+                "produces": [
+                    "application/json"
+                ],
+                "operationId": "AstraEvents",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "date (ISO format) to retrieve astra events",
+                        "name": "date",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "All AstraEvents with events on the inputted date",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/schema.MultiBuildingEvents-schema_AstraEvent"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/autocomplete/dag": {
             "get": {
                 "description": "\"Returns an aggregation of courses for use in generating autocomplete DAGs\"",
@@ -1344,6 +1373,35 @@ const docTemplate = `{
                 }
             }
         },
+        "schema.AstraEvent": {
+            "type": "object",
+            "properties": {
+                "activity_name": {
+                    "type": "string"
+                },
+                "capacity": {
+                    "type": "number"
+                },
+                "current_state": {
+                    "type": "string"
+                },
+                "end_date": {
+                    "type": "string"
+                },
+                "meeting_type": {
+                    "type": "string"
+                },
+                "not_allowed_usage_mask": {
+                    "type": "number"
+                },
+                "start_date": {
+                    "type": "string"
+                },
+                "usage_color": {
+                    "type": "string"
+                }
+            }
+        },
         "schema.Autocomplete": {
             "type": "object",
             "properties": {
@@ -1516,6 +1574,20 @@ const docTemplate = `{
                 }
             }
         },
+        "schema.MultiBuildingEvents-schema_AstraEvent": {
+            "type": "object",
+            "properties": {
+                "buildings": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.SingleBuildingEvents-schema_AstraEvent"
+                    }
+                },
+                "date": {
+                    "type": "string"
+                }
+            }
+        },
         "schema.MultiBuildingEvents-schema_SectionWithTime": {
             "type": "object",
             "properties": {
@@ -1577,6 +1649,20 @@ const docTemplate = `{
                 }
             }
         },
+        "schema.RoomEvents-schema_AstraEvent": {
+            "type": "object",
+            "properties": {
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.AstraEvent"
+                    }
+                },
+                "room": {
+                    "type": "string"
+                }
+            }
+        },
         "schema.RoomEvents-schema_SectionWithTime": {
             "type": "object",
             "properties": {
@@ -1698,6 +1784,20 @@ const docTemplate = `{
                 }
             }
         },
+        "schema.SingleBuildingEvents-schema_AstraEvent": {
+            "type": "object",
+            "properties": {
+                "building": {
+                    "type": "string"
+                },
+                "rooms": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.RoomEvents-schema_AstraEvent"
+                    }
+                }
+            }
+        },
         "schema.SingleBuildingEvents-schema_SectionWithTime": {
             "type": "object",
             "properties": {
@@ -1761,7 +1861,7 @@ const docTemplate = `{
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
 	Version:          "1.0.0",
-	Host:             "",
+	Host:             "api.utdnebula.com",
 	BasePath:         "",
 	Schemes:          []string{"http", "https"},
 	Title:            "nebula-api",

api/docs/swagger.yaml

@@ -60,6 +60,25 @@ definitions:
       role:
         type: string
     type: object
+  schema.AstraEvent:
+    properties:
+      activity_name:
+        type: string
+      capacity:
+        type: number
+      current_state:
+        type: string
+      end_date:
+        type: string
+      meeting_type:
+        type: string
+      not_allowed_usage_mask:
+        type: number
+      start_date:
+        type: string
+      usage_color:
+        type: string
+    type: object
   schema.Autocomplete:
     properties:
       course_numbers:
@@ -173,6 +192,15 @@ definitions:
       start_time:
         type: string
     type: object
+  schema.MultiBuildingEvents-schema_AstraEvent:
+    properties:
+      buildings:
+        items:
+          $ref: '#/definitions/schema.SingleBuildingEvents-schema_AstraEvent'
+        type: array
+      date:
+        type: string
+    type: object
   schema.MultiBuildingEvents-schema_SectionWithTime:
     properties:
       buildings:
@@ -213,6 +241,15 @@ definitions:
           type: string
         type: array
     type: object
+  schema.RoomEvents-schema_AstraEvent:
+    properties:
+      events:
+        items:
+          $ref: '#/definitions/schema.AstraEvent'
+        type: array
+      room:
+        type: string
+    type: object
   schema.RoomEvents-schema_SectionWithTime:
     properties:
       events:
@@ -292,6 +329,15 @@ definitions:
       last_name:
         type: string
     type: object
+  schema.SingleBuildingEvents-schema_AstraEvent:
+    properties:
+      building:
+        type: string
+      rooms:
+        items:
+          $ref: '#/definitions/schema.RoomEvents-schema_AstraEvent'
+        type: array
+    type: object
   schema.SingleBuildingEvents-schema_SectionWithTime:
     properties:
       building:
@@ -301,12 +347,32 @@ definitions:
           $ref: '#/definitions/schema.RoomEvents-schema_SectionWithTime'
         type: array
     type: object
+host: api.utdnebula.com
 info:
   contact: {}
   description: The public Nebula Labs API for access to pertinent UT Dallas data
   title: nebula-api
   version: 1.0.0
 paths:
+  /astra/{date}:
+    get:
+      description: '"Returns AstraEvent based on the input date"'
+      operationId: AstraEvents
+      parameters:
+      - description: date (ISO format) to retrieve astra events
+        in: path
+        name: date
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: All AstraEvents with events on the inputted date
+          schema:
+            items:
+              $ref: '#/definitions/schema.MultiBuildingEvents-schema_AstraEvent'
+            type: array
   /autocomplete/dag:
     get:
       description: '"Returns an aggregation of courses for use in generating autocomplete

api/routes/astra.go

@@ -0,0 +1,14 @@
+package routes
+
+import (
+	"github.com/UTDNebula/nebula-api/api/controllers"
+	"github.com/gin-gonic/gin"
+)
+
+func AstraRoute(router *gin.Engine) {
+	//All routes related to astra events come here
+	astraGroup := router.Group("/astra")
+
+	astraGroup.OPTIONS("", controllers.Preflight)
+	astraGroup.GET(":date", controllers.AstraEvents)
+}

api/server.go

@@ -23,6 +23,7 @@ func swagger_controller_placeholder() {}
 // @title nebula-api
 // @description The public Nebula Labs API for access to pertinent UT Dallas data
 // @version 1.0.0
+// @host api.utdnebula.com
 // @schemes http https
 // @x-google-backend {"address": "REDACTED"}
 // @x-google-endpoints [{"name": "nebula-api-2lntm5dxoflqn.apigateway.nebula-api-368223.cloud.goog", "allowCors": true}]
@@ -62,6 +63,7 @@ func main() {
 	routes.StorageRoute(router)
 	routes.RoomsRoute(router)
 	routes.EventsRoute(router)
+	routes.AstraRoute(router)
 
 	// Retrieve the port string to serve traffic on
 	portString := configs.GetPortString()