Rake task and service for publishing a course

[inulty-dfe]

Context

We sometimes need to publish a course through the console. The main scenario is for when the course is in a previous recruitment cycle.
It's good to have a stable service to run this in a repeatable and safe way

Changes proposed in this pull request

Extract a Service Courses::PublishService from the methods in the Course model.

The service accepts a user and a course
The task accepts a uuid and user email

• I created a Rake tasks which accepts an email address so we don't commit an admins email address to the code.
• I chose the uuid because courses' uuid are unique across all RecruitmentCycles.

I've used the service in the Publish::CoursesController#publish action

Guidance to review

[inulty-dfe]

Register request to publish course from 2024 cycle

[inulty-dfe]

I don't think it should raise an error. I want to use this in the controller so I don't want to catch this error.

Should this

1. return false if the course is unpulishable?
2. return the course and expect the caller to check if the course was published?

[tomas-stefano]

I'd go for a mixed solution 1 and 2.

This is how I'd write this:

module Courses
  class CoursePublisher
    def initialize(course:, user:)
      @course = course
      @user = user
    end

    def call
      return false unless @course.publishable?

      publish_course
      notify_course_published

      @course
    end

    private

    def publish_course
      Course.transaction do
        @course.publish_sites
        @course.publish_enrichment(@user)
        @course.application_status_open!
      end
    end

    def notify_course_published
      NotificationService::CoursePublished.call(course: @course)
    end
  end
end

And on controller (some fake code to exemplify):

def publish
  course = Course.find_by(uuid: params[:uuid])
  
  if result = Courses::CoursePublisher.new(course:, user: current_user).call
    redirect_to course_path(result), notice: 'Course published successfully!'
  else
    redirect_to courses_path, alert: 'Course could not be published.'
  end
end

I put the notification out of the transaction. Not sure if it should though.

Also Publish has this pattern of include ServicePattern. Not sure if I like to suffix everything with Service though.

[inulty-dfe]

Nice, I'll incorporate this into the PR

[tomas-stefano]

🚀

What do you think about adding a documentation or small content to support playbook?