CSC/ECE 517 Spring 2024 - E2424. Reimplement the Bookmarks Controller

This page provides a description of the Expertiza based OSS project based on reimplementing the bookmarks controller.

About Expertiza

Expertiza is an open source project based on Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Problem Statement

The Expertiza application requires the reimplementation of its backend functionality for the BookmarksController. Currently, the system relies on traditional Rails architecture, but the project aims to transition to a more streamlined approach using Rails API. This transition is essential for scalability and flexibility, allowing for separate frontend and backend applications.

The BookmarksController serves as the backbone for bookmark management and user interactions within the Expertiza platform. It facilitates actions such as listing bookmarks associated with specific topics, creating new bookmarks, editing existing ones, and deleting bookmarks. Furthermore, it incorporates authorization rules to ensure users possess appropriate roles and permissions for each action.

The reimplemented BookmarksController will adhere to the Rails API structure, residing in the controller/api/v1 directory. It will maintain the existing functionality, including methods for retrieving bookmark ratings, calculating average scores for specific and total ratings, and managing strong parameters through private methods.

Implementation

Current Implementation

The current implementation of the bookmarks crud queries is as follows:

def create

   params[:url] = params[:url].gsub!(%r{http://}, ) if params[:url].start_with?('http://')
   params[:url] = params[:url].gsub!(%r{https://}, ) if params[:url].start_with?('https://')
   begin
     Bookmark.create(url: create_bookmark_params[:url], title: create_bookmark_params[:title], description: create_bookmark_params[:description], user_id: session[:user].id, topic_id: create_bookmark_params[:topic_id])
     ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully created!', request)
     flash[:success] = 'Your bookmark has been successfully created!'
   rescue StandardError
     ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO, request)
     flash[:error] = $ERROR_INFO
   end
   redirect_to action: 'list', id: params[:topic_id]
 end

 def edit
   @bookmark = Bookmark.find(params[:id])
 end

 def update
   @bookmark = Bookmark.find(params[:id])
   @bookmark.update_attributes(url: update_bookmark_params[:bookmark][:url], title: update_bookmark_params[:bookmark][:title], description: update_bookmark_params[:bookmark][:description])
   ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
   flash[:success] = 'Your bookmark has been successfully updated!'
   redirect_to action: 'list', id: @bookmark.topic_id
 end

 def destroy
   @bookmark = Bookmark.find(params[:id])
   @bookmark.destroy
   ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully deleted!', request)
   flash[:success] = 'Your bookmark has been successfully deleted!'
   redirect_to action: 'list', id: @bookmark.topic_id
 end

Team

Mentor

Mohammed Ali Qureshi <mquresh@ncsu.edu>

Students

Akshat Nitin Savla <asavla@ncsu.edu>
Mitanshu Reshamwala <mresham@ncsu.edu>
Tanay Gandhi <tgandhi@ncsu.edu>