Canvas API to mark a web conference as having a prepared recording

Fixes: CNVS-19783

Test Plan:
Run migrations
Create a new web conference.
Get the conference key from a rails console:
  conf_key = WebConference.last.conference_key
Get the secret key:
  secret = WebConference.last.config[:secret_dec]
Put together a signed payload like this:
  signed = JWT.encode({meeting_id: conf_key}, secret)

Then post it to your localhost like this (not in the rails console):
curl --data "signed_parameters={the string you got handed when you signed the payload}" http://localhost:3000/api/v1/courses/{your course id}/conferences/{your conference id}/recording_ready

If you look at the rails server you should see the html of the notification email fly by.

Change-Id: I87cf9fc229130c2e23529c47856a66aa8e57c697
Reviewed-on: https://gerrit.instructure.com/51813
Reviewed-by: Joel Hough <joel@instructure.com>
Tested-by: Jenkins
QA-Review: Derek Hansen <dhansen@instructure.com>
Product-Review: Joel Hough <joel@instructure.com>

Author: mcwqy9

app/coffeescripts/notifications/NotificationGroupMappings.coffee

@@ -13,7 +13,8 @@ define [
       # gets the I18n version of the group name. The display text used for the items gets set through the
       # ProfileController#communication. The values are defined in Notification#category_display_name.
       @groups =
-        Course: ['due_date', 'grading_policies', 'course_content', 'files', 'announcement', 'announcement_created_by_you', 'announcement_reply', 'grading', 'invitation',
+        Course: ['due_date', 'grading_policies', 'course_content', 'files', 'announcement',
+                 'announcement_created_by_you', 'announcement_reply', 'grading', 'invitation',
                  'all_submissions', 'late_grading', 'submission_comment']
         Discussions: ['discussion', 'discussion_entry']
         Communication: ['added_to_conversation', 'conversation_message', 'conversation_created']
@@ -22,6 +23,7 @@ define [
         Parent: []
         Groups: ['membership_update']
         Alerts: ['other']
+        Conferences: ['recording_ready']
 
     # Get the I18n display text to use for the group name.
     getGroupDisplayName: (groupName) =>
@@ -34,4 +36,5 @@ define [
         when 'Groups' then I18n.t('groups.groups', 'Groups')
         when 'Alerts' then I18n.t('groups.alerts', 'Alerts')
         when 'Other' then I18n.t('groups.admin', 'Administrative')
+        when 'Conferences' then I18n.t('groups.conferences', 'Conferences')
         else I18n.t('groups.other', 'Other')

app/controllers/conferences_controller.rb

@@ -136,7 +136,12 @@ class ConferencesController < ApplicationController
   include Api::V1::Conferences
 
   before_filter :require_context
-  add_crumb(proc{ t '#crumbs.conferences', "Conferences"}) { |c| c.send(:named_context_url, c.instance_variable_get("@context"), :context_conferences_url) }
+  skip_before_filter :load_user, :only => [:recording_ready]
+
+  add_crumb(proc{ t '#crumbs.conferences', "Conferences"}) do |c|
+    c.send(:named_context_url, c.instance_variable_get("@context"), :context_conferences_url)
+  end
+
   before_filter { |c| c.active_tab = "conferences" }
   before_filter :require_config
   before_filter :reject_student_view_student
@@ -285,6 +290,21 @@ def join
     redirect_to named_context_url(@context, :context_conferences_url)
   end
 
+  def recording_ready
+    secret = @conference.config[:secret_dec]
+    begin
+      signed_params = Canvas::Security.decode_jwt(params[:signed_parameters], [secret])
+      if signed_params[:meeting_id] == @conference.conference_key
+        @conference.recording_ready!
+        render  json: [], status: :accepted
+      else
+        render json: signed_id_invalid_json, status: :unprocessable_entity
+      end
+    rescue Canvas::Security::InvalidToken
+      render json: invalid_jwt_token_json, status: :unauthorized
+    end
+  end
+
   def close
     if authorized_action(@conference, @current_user, :close)
       unless @conference.active?

app/messages/notification_types.yml

@@ -246,3 +246,8 @@
   notifications:
     - name: Summaries
       delay_for: 0
+
+- category: Recording Ready
+  notifications:
+    - name: Web Conference Recording Ready
+      delay_for: 0

app/messages/web_conference_recording_ready.email.erb

@@ -0,0 +1,11 @@
+<% define_content :link do %>
+  <%= polymorphic_url([asset.context, :conferences]) %>
+<% end %>
+
+<% define_content :subject do %>
+  <%= t :subject, "Web Conference Recording Ready: %{name}", :name => asset.context.name %>
+<% end %>
+
+<%= t :body, "Your recording of %{title} for %{name} is ready.", :title => asset.title, :name => asset.context.name %>
+
+<%= t :details_link, "You can see the details here: %{link}", :link => content(:link) %>

app/messages/web_conference_recording_ready.email.html.erb

@@ -0,0 +1,15 @@
+<% define_content :link do %>
+  <%= polymorphic_url([asset.context, :conferences]) %>
+<% end %>
+
+<% define_content :subject do %>
+  <%= t :subject, "Web Conference Recording Ready: %{name}", :name => asset.context.name %>
+<% end %>
+
+<% define_content :footer_link do %>
+  <a href="<%= content(:link) %>">
+    <%= t :details_link, "Click here to see the details"%>
+  </a>
+<% end %>
+
+<p><%= t :body, "Your recording of %{title} for %{name} is ready.", :title => asset.title, :name => asset.context.name %></p>

app/messages/web_conference_recording_ready.sms.erb

@@ -0,0 +1,3 @@
+<%= t :body, "Your recording of %{title} for %{name} is ready.", :title => asset.title, :name => asset.context.name %>
+
+<%= t :link_message, "More info at %{url}", :url => HostUrl.context_host(asset.context) %>

app/messages/web_conference_recording_ready.summary.erb

@@ -0,0 +1,9 @@
+<% define_content :link do %>
+  <%= polymorphic_url([asset.context, :conferences]) %>
+<% end %>
+
+<% define_content :subject do %>
+  <%= t :subject, "Web Conference Recording Ready: %{name}", :name => asset.context.name %>
+<% end %>
+
+<%= t :body, "Your recording of %{title} for %{name} is ready.", :title => asset.title, :name => asset.context.name %>

app/messages/web_conference_recording_ready.twitter.erb

@@ -0,0 +1,4 @@
+<% define_content :link do -%>
+  <%= polymorphic_url([asset.context, :conferences]) %>
+<% end -%>
+<%= t :tweet, "Canvas Alert - Recording ready: %{title}, %{name}", :title => asset.title, :name => asset.context.name %>

app/models/big_blue_button_conference.rb

@@ -19,6 +19,8 @@
 require 'nokogiri'
 
 class BigBlueButtonConference < WebConference
+  include ActionDispatch::Routing::PolymorphicRoutes
+  include CanvasRails::Application.routes.url_helpers
   after_destroy :end_meeting
   after_destroy :delete_all_recordings
 
@@ -51,13 +53,21 @@ def initiate_conference
       :moderatorPW => settings[:admin_key],
       :logoutURL => (settings[:default_return_url] || "http://www.instructure.com"),
       :record => settings[:record] ? "true" : "false",
-      :welcome => settings[:record] ? t("This conference may be recorded.") : ""
+      :welcome => settings[:record] ? t("This conference may be recorded.") : "",
+      "meta_canvas-recording-ready-url" => recording_ready_url
     }) or return nil
     @conference_active = true
     save
     conference_key
   end
 
+  def recording_ready_url
+    polymorphic_url([:api_v1, context, :conferences, :recording_ready],
+                    conference_id: self.id,
+                    protocol: HostUrl.protocol,
+                    host: HostUrl.context_host(self))
+  end
+
   def conference_status
     if (result = send_request(:isMeetingRunning, :meetingID => conference_key)) && result[:running] == 'true'
       :active

app/models/notification.rb

@@ -60,7 +60,7 @@ class Notification < ActiveRecord::Base
     state :active do
       event :deactivate, :transitions_to => :inactive
     end
-    
+
     state :inactive do
       event :reactivate, :transitions_to => :active
     end
@@ -103,7 +103,7 @@ def infer_default_content
   def create_message(asset, to_list, options={})
     return NotificationMessageCreator.new(self, asset, options.merge(:to_list => to_list)).create_message
   end
- 
+
   def category_spaceless
     (self.category || "None").gsub(/\s/, "_")
   end
@@ -128,35 +128,35 @@ def sort_order
       9
     end
   end
-  
+
   def self.types_to_show_in_feed
      TYPES_TO_SHOW_IN_FEED
   end
-  
+
   def show_in_feed?
     self.category == "TestImmediately" || Notification.types_to_show_in_feed.include?(self.name)
   end
-  
+
   def registration?
     return self.category == "Registration"
   end
 
   def migration?
     return self.category == "Migration"
   end
-  
+
   def summarizable?
     return !self.registration? && !self.migration?
   end
-  
+
   def dashboard?
     return ["Migration", "Registration", "Summaries", "Alert"].include?(self.category) == false
   end
-  
+
   def category_slug
     (self.category || "").gsub(/ /, "_").gsub(/[^\w]/, "").downcase
   end
-  
+
   # if user is given, categories that aren't relevant to that user will be
   # filtered out.
   def self.dashboard_categories(user = nil)
@@ -183,8 +183,8 @@ def related_user_setting(user)
     setting[:id] = "cat_#{self.id}_option" if setting
     setting
   end
-  
-  def default_frequency(user = nil)
+
+  def default_frequency(_user = nil)
     # user arg is used in plugins
     case category
     when 'All Submissions'
@@ -249,11 +249,13 @@ def default_frequency(user = nil)
       FREQ_IMMEDIATELY
     when 'Conversation Created'
       FREQ_NEVER
+    when 'Recording Ready'
+      FREQ_IMMEDIATELY
     else
       FREQ_DAILY
     end
   end
-  
+
   # TODO i18n: show the localized notification name in the dashboard (or
   # wherever), even if we continue to store the english string in the db
   # (it's actually just the titleized message template filename)
@@ -326,6 +328,7 @@ def names
     t 'names.appointment_reserved_by_user', 'Appointment Reserved By User'
     t 'names.appointment_reserved_for_user', 'Appointment Reserved For User'
     t 'names.submission_needs_grading', 'Submission Needs Grading'
+    t 'names.web_conference_recording_ready', 'Web Conference Recording Ready'
   end
 
   # TODO: i18n ... show these anywhere we show the category today
@@ -352,63 +355,66 @@ def category_names
     t 'categories.migration', 'Migration'
     t 'categories.reminder', 'Reminder'
     t 'categories.submission_comment', 'Submission Comment'
+    t 'categories.recording_ready', 'Recording Ready'
   end
 
   # Translatable display text to use when representing the category to the user.
   # NOTE: If you add a new notification category, update the mapping file for groupings to show up
   #       on notification preferences page. /app/coffeescripts/notifications/NotificationGroupMappings.coffee
   def category_display_name
     case category
-      when 'Announcement'
-        t(:announcement_display, 'Announcement')
-      when 'Announcement Created By You'
-        t(:announcement_created_by_you_display, 'Announcement Created By You')
-      when 'Course Content'
-        t(:course_content_display, 'Course Content')
-      when 'Files'
-        t(:files_display, 'Files')
-      when 'Discussion'
-        t(:discussion_display, 'Discussion')
-      when 'DiscussionEntry'
-        t(:discussion_post_display, 'Discussion Post')
-      when 'Due Date'
-        t(:due_date_display, 'Due Date')
-      when 'Grading'
-        t(:grading_display, 'Grading')
-      when 'Late Grading'
-        t(:late_grading_display, 'Late Grading')
-      when 'All Submissions'
-        t(:all_submissions_display, 'All Submissions')
-      when 'Submission Comment'
-        t(:submission_comment_display, 'Submission Comment')
-      when 'Grading Policies'
-        t(:grading_policies_display, 'Grading Policies')
-      when 'Invitation'
-        t(:invitation_display, 'Invitation')
-      when 'Other'
-        t(:other_display, 'Administrative Notifications')
-      when 'Calendar'
-        t(:calendar_display, 'Calendar')
-      when 'Student Appointment Signups'
-        t(:student_appointment_display, 'Student Appointment Signups')
-      when 'Appointment Availability'
-        t(:appointment_availability_display, 'Appointment Availability')
-      when 'Appointment Signups'
-        t(:appointment_signups_display, 'Appointment Signups')
-      when 'Appointment Cancelations'
-        t(:appointment_cancelations_display, 'Appointment Cancelations')
-      when 'Conversation Message'
-        t(:conversation_message_display, 'Conversation Message')
-      when 'Added To Conversation'
-        t(:added_to_conversation_display, 'Added To Conversation')
-      when 'Conversation Created'
-        t(:conversation_created_display, 'Conversations Created By Me')
-      when 'Membership Update'
-        t(:membership_update_display, 'Membership Update')
-      when 'Reminder'
-        t(:reminder_display, 'Reminder')
-      else
-        t(:missing_display_display, "For %{category} notifications", :category => category)
+    when 'Announcement'
+      t(:announcement_display, 'Announcement')
+    when 'Announcement Created By You'
+      t(:announcement_created_by_you_display, 'Announcement Created By You')
+    when 'Course Content'
+      t(:course_content_display, 'Course Content')
+    when 'Files'
+      t(:files_display, 'Files')
+    when 'Discussion'
+      t(:discussion_display, 'Discussion')
+    when 'DiscussionEntry'
+      t(:discussion_post_display, 'Discussion Post')
+    when 'Due Date'
+      t(:due_date_display, 'Due Date')
+    when 'Grading'
+      t(:grading_display, 'Grading')
+    when 'Late Grading'
+      t(:late_grading_display, 'Late Grading')
+    when 'All Submissions'
+      t(:all_submissions_display, 'All Submissions')
+    when 'Submission Comment'
+      t(:submission_comment_display, 'Submission Comment')
+    when 'Grading Policies'
+      t(:grading_policies_display, 'Grading Policies')
+    when 'Invitation'
+      t(:invitation_display, 'Invitation')
+    when 'Other'
+      t(:other_display, 'Administrative Notifications')
+    when 'Calendar'
+      t(:calendar_display, 'Calendar')
+    when 'Student Appointment Signups'
+      t(:student_appointment_display, 'Student Appointment Signups')
+    when 'Appointment Availability'
+      t(:appointment_availability_display, 'Appointment Availability')
+    when 'Appointment Signups'
+      t(:appointment_signups_display, 'Appointment Signups')
+    when 'Appointment Cancelations'
+      t(:appointment_cancelations_display, 'Appointment Cancelations')
+    when 'Conversation Message'
+      t(:conversation_message_display, 'Conversation Message')
+    when 'Added To Conversation'
+      t(:added_to_conversation_display, 'Added To Conversation')
+    when 'Conversation Created'
+      t(:conversation_created_display, 'Conversations Created By Me')
+    when 'Membership Update'
+      t(:membership_update_display, 'Membership Update')
+    when 'Reminder'
+      t(:reminder_display, 'Reminder')
+    when 'Recording Ready'
+      t(:recording_ready_display, 'Recording Ready')
+    else
+      t(:missing_display_display, "For %{category} notifications", :category => category)
     end
   end
 
@@ -511,6 +517,8 @@ def category_description
       t(:added_to_conversation_description, 'You are added to a conversation')
     when 'Conversation Created'
       t(:conversation_created_description, 'You created a conversation')
+    when 'Recording Ready'
+      t(:web_conference_recording_ready, 'A conference recording is ready')
     when 'Membership Update'
       mt(:membership_update_description, <<-EOS)
 *Admin only: pending enrollment activated*