Vouchers for user promotion - Part 2: Redemption

app/abilities/user_ability.rb

@@ -14,11 +14,7 @@ def initialize(user)
       user.admin? || (!user.generic? && user == given_user)
     end
 
-    can :fill_user_select, User do
-      user.active_teachable_editor?
-    end
-
-    can :list_generic_users, User do
+    can [:fill_user_select, :list_generic_users], User do
       user.admin?
     end
   end

app/abilities/voucher_ability.rb

@@ -7,5 +7,7 @@ def initialize(user)
     can [:create, :invalidate], Voucher do |voucher|
       user.can_update_personell?(voucher.lecture)
     end
+
+    can [:verify, :redeem, :cancel], Voucher
   end
 end

app/controllers/concerns/notifier.rb

@@ -0,0 +1,43 @@
+module Notifier
+  extend ActiveSupport::Concern
+
+  def notify_new_editor_by_mail(editor, lecture)
+    NotificationMailer.with(recipient: editor,
+                            locale: editor.locale,
+                            lecture: lecture)
+                      .new_editor_email.deliver_later
+  end
+
+  def notify_new_teacher_by_mail(lecture)
+    NotificationMailer.with(recipient: lecture.teacher,
+                            locale: lecture.teacher.locale,
+                            lecture: lecture)
+                      .new_teacher_email.deliver_later
+  end
+
+  def notify_previous_teacher_by_mail(previous_teacher, lecture)
+    NotificationMailer.with(recipient: previous_teacher,
+                            locale: previous_teacher.locale,
+                            lecture: lecture)
+                      .previous_teacher_email.deliver_later
+  end
+
+  def notify_about_teacher_change_by_mail(lecture, previous_teacher)
+    notify_new_teacher_by_mail(lecture)
+    notify_previous_teacher_by_mail(previous_teacher, lecture)
+  end
+
+  def notify_cospeakers_by_mail(speaker, talks)
+    talks.each do |talk|
+      talk.speakers.each do |cospeaker|
+        next if cospeaker == speaker
+
+        NotificationMailer.with(recipient: cospeaker,
+                                locale: cospeaker.locale,
+                                talk: talk,
+                                speaker: speaker)
+                          .new_speaker_email.deliver_later
+      end
+    end
+  end
+end

app/controllers/cypress/factories_controller.rb

@@ -7,26 +7,34 @@ module Cypress
   class FactoriesController < CypressController
     # Wrapper around FactoryBot.create to create a factory via a POST request.
     def create
-      unless params["0"].is_a?(String)
-        msg = "First argument must be a string indicating the factory name."
-        msg += " But we got: '#{params["0"]}'"
-        raise(ArgumentError, msg)
-      end
+      validate_factory_name(params["0"])
 
       attributes, should_validate = params_to_attributes(params.except(:controller, :action,
                                                                        :number))
 
-      res = if should_validate
-        FactoryBot.create(*attributes) # default case
-      else
-        FactoryBot.build(*attributes).tap { |instance| instance.save(validate: false) }
-      end
+      # Partition the attributes into valid attributes and instance methods
+      attributes, instance_methods = partition_attributes(attributes)
 
-      render json: res.to_json, status: :created
+      # Extract the values from the instance_methods hashes
+      instance_methods = extract_instance_methods(instance_methods)
+
+      res = create_or_build_factory(attributes, should_validate)
+
+      instance_methods_results = evaluate_instance_methods(res, instance_methods)
+
+      render json: res.as_json.merge(instance_methods_results), status: :created
     end
 
     private
 
+      def validate_factory_name(factory_name)
+        return if factory_name.is_a?(String)
+
+        msg = "First argument must be a string indicating the factory name."
+        msg += " But we got: '#{factory_name}'"
+        raise(ArgumentError, msg)
+      end
+
       def params_to_attributes(params)
         should_validate = true
 
@@ -35,7 +43,7 @@ def params_to_attributes(params)
             if value.key?("validate")
               should_validate = (value["validate"] != "false")
             else
-              value.transform_keys(&:to_sym)
+              transform_hash(value)
             end
           elsif value.is_a?(String)
             value.to_sym
@@ -46,5 +54,44 @@ def params_to_attributes(params)
 
         return attributes, should_validate
       end
+
+      def transform_hash(value)
+        value.transform_keys(&:to_sym).transform_values do |v|
+          if v.is_a?(Hash) && v.keys.all? { |k| k.match?(/^\d+$/) }
+            # Convert nested arrays to arrays of strings
+            v.values.map(&:to_s)
+          else
+            v
+          end
+        end
+      end
+
+      def partition_attributes(attributes)
+        attributes.partition do |attr|
+          !(attr.is_a?(Hash) && attr.keys == ["instance_methods"])
+        end
+      end
+
+      def extract_instance_methods(instance_methods)
+        instance_methods.flat_map { |hash| hash["instance_methods"] }
+      end
+
+      def create_or_build_factory(attributes, should_validate)
+        if should_validate
+          FactoryBot.create(*attributes) # default case
+        else
+          FactoryBot.build(*attributes).tap { |instance| instance.save(validate: false) }
+        end
+      end
+
+      def evaluate_instance_methods(instance, methods)
+        methods.index_with do |method_name|
+          if instance.respond_to?(method_name)
+            instance.send(method_name)
+          else
+            throw("Method not found: #{method_name}")
+          end
+        end
+      end
   end
 end

app/controllers/cypress/user_creator_controller.rb

@@ -1,6 +1,8 @@
 module Cypress
   # Creates a user for use in Cypress tests.
   class UserCreatorController < CypressController
+    CYPRESS_PASSWORD = "cypress123".freeze
+
     def create
       unless params[:role].is_a?(String)
         msg = "First argument must be a string indicating the user role."
@@ -12,11 +14,13 @@ def create
       is_admin = (role == "admin")
 
       user = User.create(name: "#{role} Cypress", email: "#{role}@mampf.cypress",
-                         password: "cypress123", consents: true, admin: is_admin,
-                         locale: I18n.default_locale)
+                         name_in_tutorials: "#{role} Real Cypress Name",
+                         password: CYPRESS_PASSWORD, consents: true,
+                         admin: is_admin, locale: I18n.default_locale)
       user.confirm
 
-      render json: user.to_json, status: :created
+      additional_data = { password: CYPRESS_PASSWORD }
+      render json: user.as_json.merge(additional_data), status: :created
     end
   end
 end

app/controllers/lectures_controller.rb

@@ -1,5 +1,6 @@
 # LecturesController
 class LecturesController < ApplicationController
+  include Notifier
   include ActionController::RequestForgeryProtection
   before_action :set_lecture, except: [:new, :create, :search]
   before_action :set_lecture_cookie, only: [:show, :organizational,
@@ -66,6 +67,7 @@ def edit
 
   def create
     @lecture = Lecture.new(lecture_params)
+    @lecture.teacher = current_user unless current_user.admin?
     authorize! :create, @lecture
     @lecture.save
     if @lecture.valid?
@@ -105,10 +107,7 @@ def update
       recipients = User.where(id: new_ids)
 
       recipients.each do |r|
-        NotificationMailer.with(recipient: r,
-                                locale: r.locale,
-                                lecture: @lecture)
-                          .new_editor_email.deliver_later
+        notify_new_editor_by_mail(r, @lecture)
       end
     end
 
@@ -336,9 +335,10 @@ def lecture_params
                         :submission_max_team_size, :submission_grace_period,
                         :annotations_status]
       if action_name == "update" && current_user.can_update_personell?(@lecture)
-        allowed_params.push(:teacher_id, { editor_ids: [] })
+        allowed_params.push({ editor_ids: [] })
       end
-      allowed_params.push(:course_id, :teacher_id, { editor_ids: [] }) if action_name == "create"
+      allowed_params.push(:course_id, { editor_ids: [] }) if action_name == "create"
+      allowed_params.push(:teacher_id) if current_user.admin?
       params.require(:lecture).permit(allowed_params)
     end
 

app/controllers/vouchers_controller.rb

@@ -1,4 +1,5 @@
 class VouchersController < ApplicationController
+  include Notifier
   load_and_authorize_resource
   before_action :find_voucher, only: :invalidate
 
@@ -26,9 +27,35 @@ def invalidate
     end
   end
 
+  def verify
+    @voucher = Voucher.check_voucher(check_voucher_params[:secure_hash])
+    respond_to do |format|
+      if @voucher
+        format.js
+        format.html { head :no_content }
+      else
+        error_message = I18n.t("controllers.voucher_invalid")
+        format.js { render "error", locals: { error_message: error_message } }
+        format.html { redirect_to edit_profile_path, alert: error_message }
+      end
+    end
+  end
+
   def redeem
-    # TODO: this will be dealt with in the corresponding 2nd PR
-    render js: "alert('Voucher redeemed!')"
+    voucher = Voucher.check_voucher(check_voucher_params[:secure_hash])
+    if voucher
+      VoucherProcessor.call(voucher, current_user, check_voucher_params)
+      redirect_to edit_profile_path, notice: success_message(voucher)
+    else
+      handle_invalid_voucher
+    end
+  end
+
+  def cancel
+    respond_to do |format|
+      format.html { redirect_to edit_profile_path }
+      format.js
+    end
   end
 
   private
@@ -44,12 +71,28 @@ def find_voucher
       handle_voucher_not_found
     end
 
+    def check_voucher_params
+      params.permit(:secure_hash, tutorial_ids: [], talk_ids: [])
+    end
+
     def set_related_data
       @lecture = @voucher.lecture
       @role = @voucher.role
       I18n.locale = @lecture.locale
     end
 
+    def success_message(voucher)
+      if voucher.tutor?
+        I18n.t("controllers.become_tutor_success")
+      elsif voucher.editor?
+        I18n.t("controllers.become_editor_success")
+      elsif voucher.teacher?
+        I18n.t("controllers.become_teacher_success")
+      elsif voucher.speaker?
+        I18n.t("controllers.become_speaker_success")
+      end
+    end
+
     def handle_successful_save(format)
       format.html { redirect_to edit_lecture_path(@lecture, anchor: "people") }
       format.js
@@ -80,4 +123,12 @@ def handle_voucher_not_found
         end
       end
     end
+
+    def handle_invalid_voucher
+      error_message = I18n.t("controllers.voucher_invalid")
+      respond_to do |format|
+        format.js { render "error", locals: { error_message: error_message } }
+        format.html { redirect_to edit_profile_path, alert: error_message }
+      end
+    end
 end

app/helpers/application_helper.rb

@@ -327,4 +327,10 @@ def get_class_for_any_path(paths)
   def get_class_for_any_path_startswith(paths)
     paths.any? { |path| request.path.starts_with?(path) } ? ACTIVE_CSS_CLASS : ""
   end
+
+  def truncate_result(result, length = 40)
+    result.first(length).tap do |truncated|
+      return truncated.length < length ? truncated : "#{truncated}..."
+    end
+  end
 end

app/helpers/lectures_helper.rb

@@ -129,4 +129,10 @@ def lecture_view_icon(lecture)
       tag.i(class: "fas fa-eye")
     end
   end
+
+  def editors_preselection(lecture)
+    options_for_select(lecture.eligible_as_editors.map do |editor|
+                         [editor.info, editor.id]
+                       end, lecture.editor_ids)
+  end
 end

app/helpers/notifications_helper.rb

@@ -7,6 +7,7 @@ def notification_menu_item_header(notification)
     return medium_notification_item_header(notifiable) if notification.medium?
     return course_notification_item_header(notifiable) if notification.course?
     return lecture_notification_item_header(notifiable) if notification.lecture?
+    return redemption_notification_item_header(notifiable) if notification.redemption?
 
     announcement_notification_item_header(notifiable)
   end
@@ -17,6 +18,7 @@ def notification_menu_item_details(notification)
     return medium_notification_item_details(notifiable) if notification.medium?
     return course_notification_item_details(notifiable) if notification.course?
     return lecture_notification_item_details(notifiable) if notification.lecture?
+    return redemption_notification_item_details(notifiable) if notification.redemption?
 
     ""
   end
@@ -26,6 +28,7 @@ def notification_color(notification)
     return "bg-post-it-blue" if notification.generic_announcement?
     return "bg-post-it-red" if notification.announcement?
     return "bg-post-it-orange" if notification.course? || notification.lecture?
+    return "bg-post-it-green" if notification.redemption?
 
     "bg-post-it-yellow"
   end
@@ -39,6 +42,8 @@ def notification_header(notification)
       t("notifications.course_selection")
     elsif notification.lecture_announcement?
       announcement_notification_card_header(notifiable)
+    elsif notification.redemption?
+      redemption_notification_card_header(notifiable)
     else
       link_to(t("mampf_news.title"), news_path, class: "text-dark")
     end
@@ -53,6 +58,8 @@ def notification_text(notification)
       course_notification_card_text(notifiable)
     elsif notification.lecture?
       lecture_notification_card_text(notifiable)
+    elsif notification.redemption?
+      t("notifications.redemption")
     else
       t("notifications.new_announcement")
     end
@@ -69,6 +76,8 @@ def notification_link(notification)
       course_notification_card_link
     elsif notification.lecture?
       lecture_notification_card_link
+    elsif notification.redemption?
+      redemption_notification_details(notifiable)
     else
       notifiable.details
     end