feat: add scholaistic integration

Author: purfectliterature

app/controllers/components/course/scholaistic_component.rb

@@ -12,11 +12,62 @@ def self.enabled_by_default?
   end
 
   def sidebar_items
-    settings_sidebar_items
+    main_sidebar_items + settings_sidebar_items
   end
 
   private
 
+  def main_sidebar_items
+    return [] unless scholaistic_course_linked?
+
+    student_sidebar_items + admin_sidebar_items
+  end
+
+  def student_sidebar_items
+    [
+      {
+        key: :scholaistic_assessments,
+        icon: :chatbot,
+        title: settings.assessments_title || I18n.t('course.scholaistic.assessments'),
+        weight: 4,
+        path: course_scholaistic_assessments_path(current_course)
+      }
+    ] + assistant_sidebar_items
+  end
+
+  def assistant_sidebar_items
+    ScholaisticApiService.assistants!(current_course).map do |assistant|
+      {
+        key: "scholaistic_assistant_#{assistant[:id]}",
+        icon: :chatbot,
+        title: assistant[:sidebar_title] || assistant[:title],
+        weight: 4.5,
+        path: course_scholaistic_assistant_path(current_course, assistant[:id])
+      }
+    end
+  rescue StandardError => e
+    Rails.logger.error("Failed to load Scholaistic assistants: #{e.message}")
+    raise e unless Rails.env.production?
+
+    []
+  end
+
+  def admin_sidebar_items
+    return [] unless can?(:manage_scholaistic_assistants, current_course)
+
+    [
+      {
+        key: :scholaistic_assistants,
+        type: :admin,
+        icon: :chatbot,
+        title: I18n.t('components.scholaistic.manage_assistants'),
+        weight: 9,
+        path: course_scholaistic_assistants_path(current_course),
+        exact: true
+      }
+    ]
+  end
+
   def settings_sidebar_items
     [
       {

app/controllers/course/achievement/condition/scholaistic_assessments_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+class Course::Achievement::Condition::ScholaisticAssessmentsController <
+  Course::Condition::ScholaisticAssessmentsController
+  include Course::AchievementConditionalConcern
+end

app/controllers/course/admin/scholaistic_settings_controller.rb

@@ -8,14 +8,18 @@ def edit
   end
 
   def update
-    update_settings_and_render(scholaistic_settings_params)
+    if @settings.update(params) && current_course.save
+      render_settings
+    else
+      render json: { errors: @settings.errors }, status: :bad_request
+    end
   end
 
   def confirm_link_course
     key = ScholaisticApiService.parse_link_course_callback_request(request, params)
     head :bad_request and return if key.blank?
 
-    @settings.update(integration_key: key) && current_course.save
+    @settings.update(integration_key: key, last_synced_at: nil) && current_course.save
   end
 
   def link_course
@@ -33,9 +37,18 @@ def link_course
   def unlink_course
     head :ok and return if @settings.integration_key.blank?
 
-    ScholaisticApiService.unlink_course!(@settings.integration_key)
+    ActiveRecord::Base.transaction do
+      ScholaisticApiService.unlink_course!(@settings.integration_key)
+
+      raise ActiveRecord::Rollback unless current_course.scholaistic_assessments.destroy_all
+
+      @settings.update(integration_key: nil, last_synced_at: nil)
+      current_course.save!
+    end
 
-    update_settings_and_render(integration_key: nil)
+    render_settings
+  rescue ActiveRecord::Rollback
+    render json: { errors: @settings.errors }, status: :bad_request
   end
 
   protected
@@ -58,12 +71,4 @@ def render_settings
     @ping_result = ScholaisticApiService.ping_course(@settings.integration_key) if @settings.integration_key.present?
     render 'edit'
   end
-
-  def update_settings_and_render(params)
-    if @settings.update(params) && current_course.save
-      render_settings
-    else
-      render json: { errors: @settings.errors }, status: :bad_request
-    end
-  end
 end

app/controllers/course/assessment/condition/scholaistic_assessments_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+class Course::Assessment::Condition::ScholaisticAssessmentsController <
+  Course::Condition::ScholaisticAssessmentsController
+  include Course::AssessmentConditionalConcern
+end

app/controllers/course/condition/scholaistic_assessments_controller.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+class Course::Condition::ScholaisticAssessmentsController < Course::ConditionsController
+  load_resource :scholaistic_assessment_condition, class: Course::Condition::ScholaisticAssessment.name, parent: false
+  before_action :set_course_and_conditional, only: [:create]
+  authorize_resource :scholaistic_assessment_condition, class: Course::Condition::ScholaisticAssessment.name
+
+  def index
+    render_available_scholaistic_assessments
+  end
+
+  def show
+    render_available_scholaistic_assessments
+  end
+
+  def create
+    try_to_perform @scholaistic_assessment_condition.save
+  end
+
+  def update
+    try_to_perform @scholaistic_assessment_condition.update(scholaistic_assessment_condition_params)
+  end
+
+  def destroy
+    try_to_perform @scholaistic_assessment_condition.destroy
+  end
+
+  private
+
+  def render_available_scholaistic_assessments
+    scholaistic_assessments = current_course.scholaistic_assessments
+    existing_conditions = @conditional.specific_conditions - [@scholaistic_assessment_condition]
+    @available_assessments = (scholaistic_assessments - existing_conditions.map(&:dependent_object)).sort_by(&:title)
+    render 'available_scholaistic_assessments'
+  end
+
+  def try_to_perform(operation_succeeded)
+    if operation_succeeded
+      success_action
+    else
+      render json: { errors: @scholaistic_assessment_condition.errors }, status: :bad_request
+    end
+  end
+
+  def scholaistic_assessment_condition_params
+    params.require(:condition_scholaistic_assessment).permit(:scholaistic_assessment_id)
+  end
+
+  def set_course_and_conditional
+    @scholaistic_assessment_condition.course = current_course
+    @scholaistic_assessment_condition.conditional = @conditional
+  end
+
+  def component
+    current_component_host[:course_scholaistic_component]
+  end
+end

app/controllers/course/scholaistic/assistants_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+class Course::Scholaistic::AssistantsController < Course::Scholaistic::Controller
+  def index
+    authorize! :manage_scholaistic_assistants, current_course
+
+    @embed_src = ScholaisticApiService.embed!(
+      current_course_user,
+      ScholaisticApiService.assistants_path,
+      request.origin
+    )
+  end
+
+  def show
+    authorize! :read_scholaistic_assistants, current_course
+
+    @assistant_title = ScholaisticApiService.assistant!(current_course, params[:id])[:title]
+
+    @embed_src = ScholaisticApiService.embed!(
+      current_course_user,
+      ScholaisticApiService.assistant_path(params[:id]),
+      request.origin
+    )
+  end
+end

app/controllers/course/scholaistic/controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+class Course::Scholaistic::Controller < Course::ComponentController
+  include Course::Scholaistic::Concern
+
+  before_action :not_found_if_scholaistic_course_not_linked
+
+  private
+
+  def component
+    current_component_host[:course_scholaistic_component]
+  end
+
+  def not_found_if_scholaistic_course_not_linked
+    head :not_found unless scholaistic_course_linked?
+  end
+end

app/controllers/course/scholaistic/scholaistic_assessments_controller.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+class Course::Scholaistic::ScholaisticAssessmentsController < Course::Scholaistic::Controller
+  load_and_authorize_resource :scholaistic_assessment, through: :course, class: Course::ScholaisticAssessment.name
+
+  before_action :sync_scholaistic_assessments!, only: [:index, :show, :edit]
+
+  def index
+    submissions_status_hash = ScholaisticApiService.submissions!(
+      @scholaistic_assessments.map(&:upstream_id),
+      current_course_user
+    )
+
+    @assessments_status = @scholaistic_assessments.to_h do |assessment|
+      submission_status = submissions_status_hash[assessment.upstream_id]&.[](:status)
+
+      [assessment.id,
+       if submission_status == :graded
+         :submitted
+       elsif submission_status.present?
+         submission_status
+       else
+         (can?(:attempt, assessment) && (assessment.start_at <= Time.zone.now)) ? :open : :unavailable
+       end]
+    end
+  end
+
+  def new
+    @embed_src = ScholaisticApiService.embed!(
+      current_course_user,
+      ScholaisticApiService.new_assessment_path,
+      request.origin
+    )
+  end
+
+  def show
+    upstream_id = @scholaistic_assessment.upstream_id
+
+    @embed_src =
+      ScholaisticApiService.embed!(
+        current_course_user,
+        if can?(:update, @scholaistic_assessment)
+          ScholaisticApiService.edit_assessment_path(upstream_id)
+        else
+          ScholaisticApiService.assessment_path(upstream_id)
+        end,
+        request.origin
+      )
+  end
+
+  def edit
+    @embed_src = ScholaisticApiService.embed!(
+      current_course_user,
+      ScholaisticApiService.edit_assessment_details_path(@scholaistic_assessment.upstream_id),
+      request.origin
+    )
+  end
+
+  def update
+    if @scholaistic_assessment.update(update_params)
+      head :ok
+    else
+      render json: { errors: @scholaistic_assessment.errors.full_messages.to_sentence }, status: :bad_request
+    end
+  end
+
+  private
+
+  def update_params
+    params.require(:scholaistic_assessment).permit(:base_exp)
+  end
+
+  def sync_scholaistic_assessments!
+    response = ScholaisticApiService.assessments!(current_course)
+
+    # TODO: The SQL queries will scale proportionally with `response[:assessments].size`,
+    # but we won't always have to sync all assessments since there's `last_synced_at`.
+    # In the future, we can optimise this, but it's not easy because there are multiple
+    # relations to `Course::ScholaisticAssessment` that need to be updated.
+    ActiveRecord::Base.transaction do
+      response[:assessments].map do |assessment|
+        current_course.scholaistic_assessments.find_or_initialize_by(
+          upstream_id: assessment[:upstream_id]
+        ).tap do |scholaistic_assessment|
+          scholaistic_assessment.start_at = assessment[:start_at]
+          scholaistic_assessment.end_at = assessment[:end_at]
+          scholaistic_assessment.title = assessment[:title]
+          scholaistic_assessment.description = assessment[:description]
+          scholaistic_assessment.published = assessment[:published]
+        end.save!
+      end
+
+      if response[:deleted].present? && !current_course.scholaistic_assessments.
+         where(upstream_id: response[:deleted]).destroy_all
+        raise ActiveRecord::Rollback
+      end
+
+      current_course.settings(:course_scholaistic_component).public_send('last_synced_at=', response[:last_synced_at])
+
+      current_course.save!
+    end
+  end
+
+  def submission_status(assessment)
+  end
+end