Add feedback enhancement feature

README.md

@@ -36,10 +36,11 @@ Doubtfire requires multiple environment variables that help define settings abou
 | `DF_INSTITUTION_NAME`          | The name of your institution running Doubtfire.                                                                                                                                                                                                                             | _Doubtfire University_         |
 | `DF_INSTITUTION_EMAIL_DOMAIN`  | The email domain from which emails are sent to and from in your institution.                                                                                                                                                                                                | `doubtfire.com`                |
 | `DF_INSTITUTION_HOST`          | The host running the Doubtfire instance.                                                                                                                                                                                                                                    | `localhost:3000`               |
+| `DF_COOKIE_DOMAIN`             | The domain to be associated with secure cookies.                                                                                                                                                                                                                            | Attempts to read from host     |
 | `DF_INSTITUTION_PRODUCT_NAME`  | The name of the product (i.e. Doubtfire) at your institution.                                                                                                                                                                                                               | _Doubtfire_                    |
-| `DF_INSTITUTION_HAS_LOGO`  | Set to true (or 1) if there is an associated institution logo to be included in the header.                                                                                                                                                                                     | false                          |
-| `DF_INSTITUTION_LOGO_URL`  | The url of the logo to include in the header if there is a logo.                                                                                                                                                                                                                | /assets/images/institution-logo.png |
-| `DF_INSTITUTION_LOGO_LINK_URL`  | The url used for the hyperlink associated with clicking the logo.                                                                                                                                                                                                          | /                              |
+| `DF_INSTITUTION_HAS_LOGO`      | Set to true (or 1) if there is an associated institution logo to be included in the header.                                                                                                                                                                                 | false                          |
+| `DF_INSTITUTION_LOGO_URL`      | The url of the logo to include in the header if there is a logo.                                                                                                                                                                                                            | /assets/images/institution-logo.png |
+| `DF_INSTITUTION_LOGO_LINK_URL` | The url used for the hyperlink associated with clicking the logo.                                                                                                                                                                                                           | /                              |
 | `DF_SECRET_KEY_BASE`           | The Rails secret key.                                                                                                                                                                                                                                                       | Default key provided.          |
 | `DF_SECRET_KEY_ATTR`           | The secret key to encrypt certain database fields.                                                                                                                                                                                                                          | Default key provided.          |
 | `DF_SECRET_KEY_DEVISE`         | The secret key provided to Devise.                                                                                                                                                                                                                                          | Default key provided.          |
@@ -68,6 +69,9 @@ Doubtfire requires multiple environment variables that help define settings abou
 | `D2L_OAUTH_SITE_AUTHORIZE_URL` | The URL to authorize the D2L integration.                                                                                                                                                                                                                                   | `/oauth2/auth`                 |
 | `D2L_OAUTH_SITE_TOKEN_URL`     | The URL to get the token for the D2L integration.                                                                                                                                                                                                                           | `/core/connect/token`          |
 | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
+| **Latex Configuration**        |                                                                                                                                                                                                                                                                             |                                |
+| `LATEX_CONTAINER_NAME`         | The name of the container housing the latex image. Used when pdfs are generated.                                                                                                                                                                                            | No default                     |
+| `LATEX_BUILD_PATH`             | The path to the latex build script within the container.                                                                                                                                                                                                                    | /texlive/shell/latex_build.sh  |
 
 If you have chosen to use AAF Rapid Connect authentication, then you will also need to provide the following:
 

app/api/api_root.rb

@@ -63,7 +63,6 @@ class ApiRoot < Grape::API
   mount ScormExtensionCommentsApi
   mount GroupSetsApi
   mount LearningOutcomesApi
-  mount LearningAlignmentApi
   mount ProjectsApi
   mount SettingsApi
   mount StudentsApi
@@ -99,6 +98,8 @@ class ApiRoot < Grape::API
   mount WebcalApi
   mount WebcalPublicApi
 
+  mount Feedback::FeedbackChipApi
+
   #
   # Add auth details to all end points
   #
@@ -111,7 +112,6 @@ class ApiRoot < Grape::API
   AuthenticationHelpers.add_auth_to ScormExtensionCommentsApi
   AuthenticationHelpers.add_auth_to GroupSetsApi
   AuthenticationHelpers.add_auth_to LearningOutcomesApi
-  AuthenticationHelpers.add_auth_to LearningAlignmentApi
   AuthenticationHelpers.add_auth_to ProjectsApi
   AuthenticationHelpers.add_auth_to StudentsApi
   AuthenticationHelpers.add_auth_to Submission::PortfolioApi
@@ -139,6 +139,7 @@ class ApiRoot < Grape::API
   AuthenticationHelpers.add_auth_to TestAttemptsApi
 
   AuthenticationHelpers.add_auth_to D2lIntegrationApi::D2lApi
+  AuthenticationHelpers.add_auth_to Feedback::FeedbackChipApi
 
   add_swagger_documentation \
     base_path: nil,

app/api/authentication_api.rb

@@ -14,7 +14,7 @@ class AuthenticationApi < Grape::API
   helpers AuthorisationHelpers
 
   #
-  # Sign in - only mounted if AAF auth is NOT used
+  # Sign in - only mounted if AAF and SAML auth is NOT used
   #
   if !AuthenticationHelpers.aaf_auth? && !AuthenticationHelpers.saml_auth?
     desc 'Sign in'
@@ -29,10 +29,6 @@ class AuthenticationApi < Grape::API
       remember = params[:remember]
       logger.info "Authenticate #{username} from #{request.ip}"
 
-      # Truncate the 's' from sXXX for Swinburne auth
-      truncate_s_match = (username =~ /^[Ss]\d{6,10}([Xx]|\d)$/)
-      username[0] = '' if !truncate_s_match.nil? && truncate_s_match.zero?
-
       # No provided credentials
       if username.nil? || password.nil?
         error!({ error: 'The request must contain the user username and password.' }, 400)
@@ -72,7 +68,8 @@ class AuthenticationApi < Grape::API
 
       # Return user details
       present :user, user, with: Entities::UserEntity
-      present :auth_token, user.generate_authentication_token!(remember: remember).authentication_token
+      present :auth_token, user.generate_authentication_token!.authentication_token
+      add_refresh_cookie_to_response(remember)
     end
   end
 
@@ -232,6 +229,7 @@ class AuthenticationApi < Grape::API
     params do
       requires :username, type: String, desc: 'The user\'s username'
       requires :auth_token, type: String, desc: 'The user\'s temporary auth token'
+      optional :remember, type: Boolean, desc: 'User has requested to remember login', default: false
     end
     post '/auth' do
       error!({ error: 'Invalid authentication details.' }, 404) if params[:auth_token].blank? || params[:username].blank?
@@ -252,6 +250,7 @@ class AuthenticationApi < Grape::API
         # Respond user details with new auth token
         present :user, user, with: Entities::UserEntity
         present :auth_token, token.authentication_token
+        add_refresh_cookie_to_response(params[:remember])
       end
     end
   end
@@ -356,14 +355,27 @@ class AuthenticationApi < Grape::API
        }
   delete '/auth' do
     user = User.find_by(username: headers['username'] || headers['Username'])
-    token = user.token_for_text?(headers['auth-token'] || headers['Auth-Token'], :general) unless user.nil?
+    token = user&.token_for_text?(headers['auth-token'] || headers['Auth-Token'], :general)
 
     if token.present?
       logger.info "Sign out #{user.username} from #{request.ip}"
       token.destroy!
     end
 
+    if cookies['refresh_token'].present?
+      auth_param = cookies['refresh_token']
+      user_param = cookies['username']
+
+      user = User.find_by(username: user_param)
+      token = user&.token_for_text?(auth_param, :refresh_token)
+      if token.present?
+        logger.info "Sign out #{user.username} from #{request.ip}"
+        token.destroy!
+      end
+    end
+
     present nil
+    add_refresh_cookie_to_response(false)
   end
 
   desc 'Get SCORM authentication token'
@@ -382,4 +394,15 @@ class AuthenticationApi < Grape::API
       present :scorm_auth_token, token.authentication_token
     end
   end
+
+  desc 'Get access token from the refresh token cookie'
+  post '/auth/access-token' do
+    if authenticated?(:refresh_token)
+      # Return user details
+      present :user, current_user, with: Entities::UserEntity
+      present :auth_token, current_user.generate_authentication_token!(token_type: :general).authentication_token
+    else
+      error!({ error: 'Invalid refresh token.' }, 404)
+    end
+  end
 end

app/api/entities/learning_outcome_entity.rb

@@ -1,9 +1,13 @@
 module Entities
   class LearningOutcomeEntity < Grape::Entity
     expose :id
-    expose :ilo_number
+    expose :context_type
+    expose :context_id
     expose :abbreviation
-    expose :name
-    expose :description
+    expose :short_description
+    expose :full_outcome_description
+    expose :linked_outcome_ids do |learning_outcome, _options|
+      learning_outcome.linked_outcomes.pluck(:id)
+    end
   end
 end

app/api/entities/project_entity.rb

@@ -24,7 +24,6 @@ class ProjectEntity < Grape::Entity
 
     expose :tutorial_enrolments, using: TutorialEnrolmentEntity, unless: :summary_only
     expose :groups, using: GroupEntity, unless: :summary_only
-    expose :task_outcome_alignments, using: TaskOutcomeAlignmentEntity, unless: :summary_only
 
     expose :grade, if: :for_staff
     expose :grade_rationale, if: :for_staff

app/api/entities/task_definition_entity.rb

@@ -50,5 +50,7 @@ def staff?(my_role)
     expose :overseer_image_id, if: ->(unit, options) { staff?(options[:my_role]) }, expose_nil: false
     expose :assessment_enabled, if: ->(unit, options) { staff?(options[:my_role]) }
     expose :moss_language, if: ->(unit, options) { staff?(options[:my_role]) }, expose_nil: false
+
+    expose :learning_outcomes, using: LearningOutcomeEntity, as: :ilos
   end
 end

app/api/entities/unit_entity.rb

@@ -57,7 +57,6 @@ def can_read_unit_config?(my_role)
     # expose :tutorial_enrolments, using: TutorialEnrolmentEntity, unless: :summary_only, if: lambda { |unit, options| is_staff?(options[:my_role]) }
 
     expose :ordered_task_definitions, as: :task_definitions, using: TaskDefinitionEntity, unless: :summary_only
-    expose :task_outcome_alignments, using: TaskOutcomeAlignmentEntity, unless: :summary_only
     expose :group_sets, using: GroupSetEntity, unless: :summary_only
     expose :groups, using: GroupEntity, unless: :summary_only
     # expose :group_memberships, using: GroupMembershipEntity, unless: :summary_only do |unit, options|

app/api/feedback/entities/feedback_chip_entity.rb

@@ -0,0 +1,24 @@
+module Feedback
+  module Entities
+    class FeedbackChipEntity < Grape::Entity
+      expose :id
+      expose :type do |chip|
+        case chip.type
+        when 'Feedback::FeedbackTemplateChip'
+          'template'
+        when 'Feedback::FeedbackGroupChip'
+          'group'
+        else
+          'unknown'
+        end
+      end
+      expose :chip_text
+      expose :description
+      expose :task_status
+      expose :parent_chip_id
+      expose :learning_outcome_id
+      expose :summary_text
+      expose :comment_text
+    end
+  end
+end

app/api/feedback/entities/feedback_group_chip_entity.rb

@@ -0,0 +1,21 @@
+module Feedback
+  module Entities
+    class FeedbackGroupChipEntity < Grape::Entity
+      expose :id
+      expose :type do |chip|
+        case chip.type
+        when 'Feedback::FeedbackTemplateChip'
+          'template'
+        when 'Feedback::FeedbackGroupChip'
+          'group'
+        else
+          'unknown'
+        end
+      end
+      expose :chip_text
+      expose :description
+      expose :parent_chip_id
+      expose :learning_outcome_id
+    end
+  end
+end

app/api/feedback/entities/feedback_template_chip_entity.rb

@@ -0,0 +1,25 @@
+module Feedback
+  module Entities
+    class FeedbackTemplateChipEntity < Grape::Entity
+      expose :id
+      expose :type do |chip|
+        case chip.type
+        when 'Feedback::FeedbackTemplateChip'
+          'template'
+        when 'Feedback::FeedbackGroupChip'
+          'group'
+        else
+          'unknown'
+        end
+      end
+      expose :chip_text
+      expose :description
+      expose :task_status
+      expose :parent_chip_id
+      expose :learning_outcome_id
+
+      expose :comment_text
+      expose :summary_text
+    end
+  end
+end