From 43e58e402e70c25cda72c97c62267dece7e80610 Mon Sep 17 00:00:00 2001
From: Zachary Chai <zachary.chai@blindsidenetworks.com>
Date: Tue, 31 Jan 2017 15:34:25 -0500
Subject: [PATCH] organize routes and update comments

---
 app/controllers/bbb_controller.rb |  5 +++++
 config/routes.rb                  | 16 +++++++++-------
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/app/controllers/bbb_controller.rb b/app/controllers/bbb_controller.rb
index b480bdee..2ee0f447 100644
--- a/app/controllers/bbb_controller.rb
+++ b/app/controllers/bbb_controller.rb
@@ -24,6 +24,7 @@ class BbbController < ApplicationController
   before_action :validate_checksum, only: :callback
 
   # GET /:resource/:id/join
+  # GET /:resource/:room_id/:id/join
   def join
     if params[:name].blank?
       return render_bbb_response(
@@ -103,6 +104,7 @@ class BbbController < ApplicationController
   end
 
   # DELETE /rooms/:id/end
+  # DELETE /rooms/:room_id/:id/end
   def end
     load_and_authorize_room_owner!
 
@@ -114,6 +116,7 @@ class BbbController < ApplicationController
   end
 
   # GET /rooms/:id/recordings
+  # GET /rooms/:room_id/:id/recordings
   def recordings
     load_room!
 
@@ -127,6 +130,7 @@ class BbbController < ApplicationController
   end
 
   # PATCH /rooms/:id/recordings/:record_id
+  # PATCH /rooms/:room_id/:id/recordings/:record_id
   def update_recordings
     published = params[:published] == 'true'
     metadata = params.select{ |k, v| k.match(/^meta_/) }
@@ -138,6 +142,7 @@ class BbbController < ApplicationController
   end
 
   # DELETE /rooms/:id/recordings/:record_id
+  # DELETE /rooms/:room_id/:id/recordings/:record_id
   def delete_recordings
     bbb_res = bbb_delete_recordings(params[:record_id])
     if bbb_res[:returncode]
diff --git a/config/routes.rb b/config/routes.rb
index 4ba0a691..5817bb61 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -29,25 +29,27 @@ Rails.application.routes.draw do
   # meetings offer a landing page for NON authenticated users to create and join session in BigBlueButton
   # rooms offer a customized landing page for authenticated users to create and join session in BigBlueButton
 
+  # recording routes for updating, deleting and viewing recordings
+  get '/rooms/:room_id/recordings', to: 'bbb#recordings', defaults: {format: 'json'}
   patch '/rooms/:room_id/recordings/:record_id', to: 'bbb#update_recordings', defaults: {format: 'json'}
   delete '/rooms/:room_id/recordings/:record_id', to: 'bbb#delete_recordings', defaults: {format: 'json'}
-
-
-  get '/rooms/:room_id',  to: 'landing#resource', resource: 'rooms'
-  get '/rooms/:room_id/recordings', to: 'bbb#recordings', defaults: {format: 'json'}
-  get '/rooms/:room_id/:id', to: 'landing#resource', resource: 'rooms'
-  delete '/rooms/:room_id/:id/end', to: 'bbb#end', defaults: {format: 'json'}
   get '/rooms/:room_id/:id/recordings', to: 'bbb#recordings', defaults: {format: 'json'}
   patch '/rooms/:room_id/:id/recordings/:record_id', to: 'bbb#update_recordings', defaults: {format: 'json'}
   delete '/rooms/:room_id/:id/recordings/:record_id', to: 'bbb#delete_recordings', defaults: {format: 'json'}
 
+  # room routes for joining, ending, waiting and refreshing authenticated meetings
+  get '/rooms/:room_id',  to: 'landing#resource', resource: 'rooms'
+  get '/rooms/:room_id/:id', to: 'landing#resource', resource: 'rooms'
+  get '/rooms/:room_id/:id/join', to: 'bbb#join', resource: 'rooms', defaults: {format: 'json'}
+  delete '/rooms/:room_id/:id/end', to: 'bbb#end', defaults: {format: 'json'}
+
+  # routes shared between meetings and rooms
   get '/:resource/:id', to: 'landing#resource', as: :resource
   get '/:resource/:id/join', to: 'bbb#join', as: :bbb_join, defaults: {format: 'json'}
   post '/:resource/:id/callback', to: 'bbb#callback' #, defaults: {format: 'json'}
 
   get '/:resource/:room_id/:id/wait', to: 'landing#wait_for_moderator'
   get '/:resource/:room_id/:id/session_status_refresh', to: 'landing#session_status_refresh'
-  get '/:resource/:room_id/:id/join', to: 'bbb#join', defaults: {format: 'json'}
 
 
   root to: 'landing#index', :resource => 'meetings'