Merge pull request doubtfire-lms#448 from DudeUnleashed/courseflow

feature/Courseflow-api

Author: macite

Gemfile

@@ -4,10 +4,10 @@ source 'https://rubygems.org'
 
 # Ruby versions for various enviornments
 ruby_versions = {
-  development: '~>3.1.0',
-  test: '~>3.1.0',
-  staging: '~>3.1.0',
-  production: '~>3.1.0'
+  development: '~>3.3.0',
+  test: '~>3.3.0',
+  staging: '~>3.3.0',
+  production: '~>3.3.0'
 }
 # Get the ruby version for the current enviornment
 ruby ruby_versions[(ENV['RAILS_ENV'] || 'development').to_sym]
@@ -112,3 +112,5 @@ gem 'shellwords'
 
 # PDF reader for validating PDF file submissions
 gem 'pdf-reader'
+
+gem 'csv'

Gemfile.lock

@@ -113,6 +113,7 @@ GEM
       bigdecimal
       rexml
     crass (1.0.6)
+    csv (3.3.0)
     database_cleaner-active_record (2.1.0)
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
@@ -168,7 +169,15 @@ GEM
     faraday-net_http (3.1.0)
       net-http
     ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
     fugit (1.11.0)
       et-orbi (~> 1, >= 1.2.11)
       raabro (~> 1.4)
@@ -267,6 +276,16 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
+    nokogiri (1.16.5-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-linux)
+      racc (~> 1.4)
     observer (0.1.2)
     orm_adapter (0.5.0)
     parallel (1.25.1)
@@ -497,8 +516,20 @@ GEM
     zeitwerk (2.6.16)
 
 PLATFORMS
-  aarch64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
   x86_64-linux
+  x86_64-linux-gnu
+  x86_64-linux-musl
+  aarch64-linux
 
 DEPENDENCIES
   better_errors
@@ -507,6 +538,7 @@ DEPENDENCIES
   byebug
   ci_reporter
   coderay
+  csv
   database_cleaner-active_record
   devise
   devise_ldap_authenticatable
@@ -560,7 +592,7 @@ DEPENDENCIES
   webmock
 
 RUBY VERSION
-   ruby 3.1.4p223
+   ruby 3.3.2p78
 
 BUNDLED WITH
-   2.4.22
+   2.5.11

app/api/api_root.rb

@@ -92,6 +92,13 @@ class ApiRoot < Grape::API
   mount WebcalApi
   mount WebcalPublicApi
 
+  mount Courseflow::CourseApi
+  mount Courseflow::CourseMapApi
+  mount Courseflow::CourseMapUnitApi
+  mount Courseflow::SpecializationApi
+  mount Courseflow::RequirementSetApi
+  mount UnitDefinitionApi
+
   #
   # Add auth details to all end points
   #
@@ -128,6 +135,13 @@ class ApiRoot < Grape::API
   AuthenticationHelpers.add_auth_to UnitsApi
   AuthenticationHelpers.add_auth_to WebcalApi
 
+  AuthenticationHelpers.add_auth_to Courseflow::CourseApi
+  AuthenticationHelpers.add_auth_to Courseflow::CourseMapApi
+  AuthenticationHelpers.add_auth_to Courseflow::CourseMapUnitApi
+  AuthenticationHelpers.add_auth_to Courseflow::SpecializationApi
+  AuthenticationHelpers.add_auth_to Courseflow::RequirementSetApi
+  AuthenticationHelpers.add_auth_to UnitDefinitionApi
+
   add_swagger_documentation \
     base_path: nil,
     api_version: 'v1',

app/api/courseflow/course_api.rb

@@ -0,0 +1,100 @@
+require 'grape'
+module Courseflow
+  class CourseApi < Grape::API
+
+    format :json
+    helpers AuthenticationHelpers
+    helpers AuthorisationHelpers
+
+    before do
+      authenticated?
+    end
+
+    desc "Get all course data"
+    get '/course' do
+      courses = Course.all # get all courses in the database
+      present courses, with: Entities::CourseEntity # present the courses using the CourseEntity
+    end
+
+    desc "Get course by ID"
+    params do
+      requires :courseId, type: Integer, desc: "Course ID"
+    end
+    get '/course/courseId/:courseId' do
+      course = Course.find(params[:courseId]) # find the course by ID
+      present course, with: Entities::CourseEntity      # present the course using the CourseEntity
+    end
+
+    desc "Get courses that partially match the search params"
+    params do # define the parameters that can be used to filter the courses, all optional, if none given it'll return every course
+      optional :name, type: String, desc: "Course name"
+      optional :code, type: String, desc: "Course code"
+      optional :year, type: Integer, desc: "Course year"
+    end
+    get '/course/search' do
+      courses = Course.all # gets all courses initially
+
+      courses = courses.where("name LIKE :name", name: "%#{params[:name]}%") if params[:name].present?  # if name is provided, filter by name, even partially
+      courses = courses.where("code LIKE :code", code: "%#{params[:code]}%") if params[:code].present?  # if code is provided, filter by code, (can do things like SIT to get all SIT courses)
+      courses = courses.where(year: params[:year]) if params[:year].present?                  # if year is provided, filter by year
+
+      present courses, with: Entities::CourseEntity                                                     # return the filtered courses
+    end
+
+    desc "Add a new course"
+    params do # define the parameters required to create a new course
+      requires :name, type: String
+      requires :code, type: String
+      requires :year, type: Integer
+      requires :version, type: String
+      requires :url, type: String
+    end
+    post '/course' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to create a course' }, 403)
+      end
+      course = Course.new(params) # create a new course with the provided params
+      if course.save
+        present course, with: Entities::CourseEntity # if the course is saved, present the course using the CourseEntity
+      else
+        error!({ error: "Failed to create course", details: course.errors.full_messages }, 400) # if the course is not saved, return an error with the full error messages
+      end
+    end
+
+    desc "Update an existing course via its ID"
+    params do # define the parameters required to update a course
+      requires :courseId, type: Integer, desc: "Course ID"
+      requires :name, type: String
+      requires :code, type: String
+      requires :year, type: Integer
+      requires :version, type: String
+      requires :url, type: String
+    end
+    put '/course/courseId/:courseId' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to update a course' }, 403)
+      end
+      course = Course.find(params[:courseId]) # find the course by ID
+      error!({ error: "Course not found" }, 404) unless course # return an error if the course is not found
+
+      if course.update(name: params[:name], code: params[:code], year: params[:year], version: params[:version], url: params[:url]) # update the course with the provided params
+        present course, with: Entities::CourseEntity # if the course is updated, present the course using the CourseEntity
+      else
+        error!({ error: "Failed to update course", details: course.errors.full_messages }, 400) # if the course is not updated, return an error with the full error messages
+      end
+    end
+
+    desc "Deletes an existing course via its ID"
+    params do
+      requires :courseId, type: Integer, desc: "Course ID"
+    end
+    delete '/course/courseId/:courseId' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to delete a course' }, 403)
+      end
+      course = Course.find(params[:courseId]) # find the course by ID
+      course.destroy
+      { message: "Course with ID #{params[:courseId]} has been deleted" } # return a message saying the course was deleted
+    end
+  end
+end

app/api/courseflow/course_map_api.rb

@@ -0,0 +1,106 @@
+require 'grape'
+module Courseflow
+  class CourseMapApi < Grape::API
+
+    format :json
+    helpers AuthenticationHelpers
+    helpers AuthorisationHelpers
+
+    before do
+      authenticated?
+    end
+
+    desc "Get course map via user ID"
+    params do
+      requires :userId, type: Integer, desc: "User ID"
+    end
+    get '/coursemap/userId/:userId' do
+      course_map = CourseMap.find_by(userId: params[:userId])
+      if course_map
+        present course_map, with: Entities::CourseMapEntity
+      else
+        error!({ error: "Course map #{params[:userId]} not found" }, 404)
+      end
+    end
+
+    desc "Get course map via course ID"
+    params do
+      requires :courseId, type: Integer, desc: "Course ID"
+    end
+    get '/coursemap/courseId/:courseId' do
+      course_map = CourseMap.where(courseId: params[:courseId])
+      if course_map
+        present course_map, with: Entities::CourseMapEntity
+      else
+        error!({ error: "Course map #{params[:courseId]} not found" }, 404)
+      end
+    end
+
+    desc "Add a new course map"
+    params do
+      requires :userId, type: Integer
+      requires :courseId, type: Integer
+    end
+    post '/coursemap' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to add a new course map' }, 403)
+      end
+      course_map = CourseMap.new(params)
+      if course_map.save
+        present course_map, with: Entities::CourseMapEntity
+      else
+        error!({ error: "Failed to create course map", details: coursemap.errors.full_messages }, 400)
+      end
+    end
+
+    desc "Update an existing course map via its ID"
+    params do
+      requires :courseMapId, type: Integer, desc: "Course map ID"
+      requires :userId, type: Integer
+      requires :courseId, type: Integer
+    end
+    put '/coursemap/courseMapId/:courseMapId' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to update course maps' }, 403)
+      end
+      course_map = CourseMap.find(params[:courseMapId])
+      if course_map.update(params.except(:courseMapId))
+        present course_map, with: Entities::CourseMapEntity
+      else
+        error!({ error: "Failed to update course map", details: course_map.errors.full_messages }, 400)
+      end
+    end
+
+    desc "Delete all course maps via its associated course map ID"
+    params do
+      requires :courseMapId, type: Integer, desc: "Course map ID"
+    end
+    delete '/coursemap/courseMapId/:courseMapId' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to delete course maps' }, 403)
+      end
+      course_map = CourseMap.find(params[:courseMapId])
+      if course_map
+        course_map.destroy
+      else
+        error!({ error: "Course map #{params[:courseMapId]} not found" }, 404)
+      end
+    end
+
+    desc "Delete all course maps via its associated user ID"
+    params do
+      requires :userId, type: Integer, desc: "User ID"
+    end
+    delete '/coursemap/userId/:userId' do
+      unless authorise? current_user, User, :handle_courseflow
+        error!({ error: 'Not authorised to delete course maps' }, 403)
+      end
+      course_map = CourseMap.find(params[:userId])
+      if course_map
+        course_map.destroy
+      else
+        error!({ error: "Course map #{params[:userId]} not found" }, 404)
+      end
+    end
+  end
+end