bigbluebutton_rails 0.1.1 → 1.0.0

data/lib/bigbluebutton_rails/exceptions.rb

@@ -3,8 +3,4 @@ module BigbluebuttonRails
   # Raised when the user is not authorized to join a room
   class RoomAccessDenied < StandardError; end
 
-  # Raised when an action that requires a server is called for a
-  # room that does not have a server associated
-  class ServerRequired < StandardError; end
-
 end

data/lib/bigbluebutton_rails/rails/routes.rb

@@ -13,23 +13,23 @@ module ActionDispatch::Routing
     #
     # Passing the option :default, it will generate the default routes to access
     # bigbluebutton servers and rooms. These routes are the resourceful routes generated
-    # by rails to a resource, plus the other available actions for servers and rooms.
+    # by rails to a resource, plus two new actions for the rooms.
     #
     #    bigbluebutton_routes :default
     #
-    # Examples of some routes generated:
+    # Some routes generated:
     #
     #   bigbluebutton_server               GET    /bigbluebutton/servers/:id(.:format)
     #                                             { :action=>"show", :controller=>"bigbluebutton/servers" }
     #                                      POST   /bigbluebutton/servers/:id(.:format)
     #                                             { :action=>"update", :controller=>"bigbluebutton/servers" }
-    #   join_bigbluebutton_room            GET    /bigbluebutton/rooms/:id/join(.:format)
+    #   join_bigbluebutton_server_room     GET    /bigbluebutton/servers/:server_id/rooms/:id/join(.:format)
     #                                             { :action=>"join", :controller=>"bigbluebutton/rooms" }
-    #   running_bigbluebutton_room         GET    /bigbluebutton/rooms/:id/running(.:format)
+    #   running_bigbluebutton_server_room  GET    /bigbluebutton/servers/:server_id/rooms/:id/running(.:format)
     #                                             { :action=>"running", :controller=>"bigbluebutton/rooms" }
     #
     # The routes point by default to the controllers Bigbluebutton::ServersController and Bigbluebutton::RoomsController
-    # and they are scoped (namespaced) with 'bigbluebutton'. You can change the namespace with:
+    # and the the routes are scoped (namespaced) with 'bigbluebutton'. You can change the namespace with:
     #
     #    bigbluebutton_routes :default, :scope => "webconference"
     #
@@ -40,8 +40,7 @@ module ActionDispatch::Routing
     # ==== Room matchers
     #
     # Generates matchers to access a room from a different url or inside another resource.
-    # Rooms can belong to users, communities or any other type of "entity" in an aplication.
-    # This helper creates routes to the all the actions available in Bigbluebutton::RoomsController.
+    # It creates routes to the actions #show, #join, #running, #end, #invite, and #auth.
     #
     #    bigbluebutton_routes :room_matchers
     #
@@ -51,12 +50,18 @@ module ActionDispatch::Routing
     #     bigbluebutton_routes :room_matchers
     #   end
     #
-    # Examples of some routes generated:
+    # The routes generated are:
     #
     #   user_room               GET  /users/:user_id/room/:id(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"show" }
     #   user_join_room          GET  /users/:user_id/room/:id/join(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"join" }
+    #   user_join_mobile_room   GET  /users/:user_id/room/:id/invite(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"invite" }
+    #   user_auth_room          POST /users/:user_id/room/:id/join(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"auth" }
+    #   user_running_room       GET  /users/:user_id/room/:id/running(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"running" }
     #   user_end_room           GET  /users/:user_id/room/:id/end(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"end" }
     #   user_invite_room        GET  /users/:user_id/room/:id/invite(.:format)
@@ -77,31 +82,33 @@ module ActionDispatch::Routing
       scope options_scope, :as => options_scope do
         resources :servers, :controller => BigbluebuttonRails.controllers[:servers] do
           get :activity, :on => :member
-          get :rooms, :on => :member
+          resources :rooms, :controller => BigbluebuttonRails.controllers[:rooms] do
+            collection do
+              get :external
+              post :external, :action => :external_auth
+            end
+            member do
+              get :join
+              get :running
+              get :end
+              get :invite
+              get :join_mobile
+              post :join, :action => :auth
+            end
+          end
         end
-        add_routes_for_rooms
       end
     end
 
     def bigbluebutton_routes_room_matchers(*params) #:nodoc:
-      add_routes_for_rooms
-    end
-
-    def add_routes_for_rooms
-      resources :rooms, :controller => BigbluebuttonRails.controllers[:rooms] do
-        collection do
-          get :external
-          post :external, :action => :external_auth
-        end
-        member do
-          get :join
-          get :running
-          get :end
-          get :invite
-          get :join_mobile
-          post :join, :action => :auth
-        end
-      end
+      # TODO This is generating helpers like "user_running_room" instead of "running_user_room"
+      get 'room/:id' => "#{BigbluebuttonRails.controllers[:rooms]}#show", :as => 'room'
+      get 'room/:id/join' => "#{BigbluebuttonRails.controllers[:rooms]}#join", :as => 'join_room'
+      get 'room/:id/join_mobile' => "#{BigbluebuttonRails.controllers[:rooms]}#join_mobile", :as => 'join_mobile_room'
+      post 'room/:id/join' => "#{BigbluebuttonRails.controllers[:rooms]}#auth", :as => 'join_room'
+      get 'room/:id/running' => "#{BigbluebuttonRails.controllers[:rooms]}#running", :as => 'running_room'
+      get 'room/:id/end' => "#{BigbluebuttonRails.controllers[:rooms]}#end", :as => 'end_room'
+      get 'room/:id/invite' => "#{BigbluebuttonRails.controllers[:rooms]}#invite", :as => 'invite_room'
     end
 
   end

data/lib/bigbluebutton_rails/version.rb

@@ -1,3 +1,3 @@
 module BigbluebuttonRails
-  VERSION = "0.1.1".freeze
+  VERSION = "1.0.0".freeze
 end

data/spec/controllers/bigbluebutton/rooms_controller_exception_handling_spec.rb

@@ -2,13 +2,14 @@ require 'spec_helper'
 
 describe Bigbluebutton::RoomsController do
   render_views
+  let(:server) { Factory.create(:bigbluebutton_server) }
+  let(:room) { Factory.create(:bigbluebutton_room, :server => server) }
 
   # make sure that the exceptions thrown by bigbluebutton-api-ruby are treated by the controller
   context "exception handling" do
     let(:bbb_error_msg) { "err msg" }
     let(:bbb_error) { BigBlueButton::BigBlueButtonException.new(bbb_error_msg) }
     let(:http_referer) { bigbluebutton_server_path(mocked_server) }
-    let(:room) { Factory.create(:bigbluebutton_room, :server => mocked_server) }
     before {
       mock_server_and_api
       request.env["HTTP_REFERER"] = http_referer
@@ -25,16 +26,16 @@ describe Bigbluebutton::RoomsController do
       end
 
       after :each do
-        delete :destroy, :id => room.to_param
+        delete :destroy, :server_id => mocked_server.to_param, :id => room.to_param
         should respond_with(:redirect)
-        should redirect_to bigbluebutton_rooms_url
+        should redirect_to bigbluebutton_server_rooms_url
         should set_the_flash.to(bbb_error_msg)
       end
     end
 
     describe "#running" do
       before { mocked_api.should_receive(:is_meeting_running?) { raise bbb_error } }
-      before(:each) { get :running, :id => room.to_param }
+      before(:each) { get :running, :server_id => mocked_server.to_param, :id => room.to_param }
       it { should respond_with(:success) }
       it { response.body.should == build_running_json(false, bbb_error_msg) }
       it { should set_the_flash.to(bbb_error_msg) }
@@ -51,7 +52,7 @@ describe Bigbluebutton::RoomsController do
       end
 
       after :each do
-        get :end, :id => room.to_param
+        get :end, :server_id => mocked_server.to_param, :id => room.to_param
         should respond_with(:redirect)
         should redirect_to(http_referer)
         should set_the_flash.to(bbb_error_msg)
@@ -62,11 +63,7 @@ describe Bigbluebutton::RoomsController do
       before { controller.stub(:bigbluebutton_user) { Factory.build(:user) } }
 
       context "as moderator" do
-        before {
-          controller.should_receive(:bigbluebutton_role).with(room).and_return(:moderator)
-          room.stub(:select_server).and_return(mocked_server)
-          BigbluebuttonRoom.stub(:find_by_param).and_return(room)
-        }
+        before { controller.should_receive(:bigbluebutton_role).with(room).and_return(:moderator) }
 
         it "catches exception on is_meeting_running" do
           mocked_api.should_receive(:is_meeting_running?) { raise bbb_error }
@@ -83,7 +80,7 @@ describe Bigbluebutton::RoomsController do
         end
 
         after :each do
-          get :join, :id => room.to_param
+          get :join, :server_id => mocked_server.to_param, :id => room.to_param
           should respond_with(:redirect)
           should redirect_to(http_referer)
           should set_the_flash.to(bbb_error_msg)
@@ -91,7 +88,7 @@ describe Bigbluebutton::RoomsController do
 
       end
 
-      context "as attendee" do
+      context "as moderator" do
         before { controller.should_receive(:bigbluebutton_role).with(room).and_return(:attendee) }
 
         it "catches exception on is_meeting_running" do
@@ -104,7 +101,7 @@ describe Bigbluebutton::RoomsController do
         end
 
         after :each do
-          get :join, :id => room.to_param
+          get :join, :server_id => mocked_server.to_param, :id => room.to_param
           should respond_with(:redirect)
           should redirect_to(http_referer)
           should set_the_flash.to(bbb_error_msg)

data/spec/controllers/bigbluebutton/rooms_controller_json_responses_spec.rb

@@ -5,21 +5,21 @@ describe Bigbluebutton::RoomsController do
   let(:server) { Factory.create(:bigbluebutton_server) }
   let(:room) { Factory.create(:bigbluebutton_room, :server => server) }
 
-  context "json responses for" do
+  context "json responses for " do
 
     describe "#index" do
       before do
         @room1 = Factory.create(:bigbluebutton_room, :server => server)
         @room2 = Factory.create(:bigbluebutton_room, :server => server)
       end
-      before(:each) { get :index, :format => 'json' }
+      before(:each) { get :index, :server_id => server.to_param, :format => 'json' }
       it { should respond_with(:success) }
       it { should respond_with_content_type(:json) }
       it { should respond_with_json([@room1, @room2].to_json) }
     end
 
     describe "#new" do
-      before(:each) { get :new, :format => 'json' }
+      before(:each) { get :new, :server_id => server.to_param, :format => 'json' }
       it { should respond_with(:success) }
       it { should respond_with_content_type(:json) }
       it {
@@ -30,7 +30,7 @@ describe Bigbluebutton::RoomsController do
     end
 
     describe "#show" do
-      before(:each) { get :show, :id => room.to_param, :format => 'json' }
+      before(:each) { get :show, :server_id => server.to_param, :id => room.to_param, :format => 'json' }
       it { should respond_with(:success) }
       it { should respond_with_content_type(:json) }
       it { should respond_with_json(room.to_json) }
@@ -41,7 +41,7 @@ describe Bigbluebutton::RoomsController do
 
       context "on success" do
         before(:each) {
-          post :create, :bigbluebutton_room => new_room.attributes, :format => 'json'
+          post :create, :server_id => server.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
         }
         it { should respond_with(:created) }
         it { should respond_with_content_type(:json) }
@@ -54,7 +54,7 @@ describe Bigbluebutton::RoomsController do
       context "on failure" do
         before(:each) {
           new_room.name = nil # invalid
-          post :create, :bigbluebutton_room => new_room.attributes, :format => 'json'
+          post :create, :server_id => server.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
         }
         it { should respond_with(:unprocessable_entity) }
         it { should respond_with_content_type(:json) }
@@ -71,7 +71,7 @@ describe Bigbluebutton::RoomsController do
 
       context "on success" do
         before(:each) {
-          put :update, :id => @room.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
+          put :update, :server_id => server.to_param, :id => @room.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
         }
         it { should respond_with(:success) }
         it { should respond_with_content_type(:json) }
@@ -84,7 +84,7 @@ describe Bigbluebutton::RoomsController do
       context "on failure" do
         before(:each) {
           new_room.name = nil # invalid
-          put :update, :id => @room.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
+          put :update, :server_id => server.to_param, :id => @room.to_param, :bigbluebutton_room => new_room.attributes, :format => 'json'
         }
         it { should respond_with(:unprocessable_entity) }
         it { should respond_with_content_type(:json) }
@@ -103,7 +103,7 @@ describe Bigbluebutton::RoomsController do
           mocked_api.should_receive(:is_meeting_running?).and_return(true)
           mocked_api.should_receive(:end_meeting).with(room.meetingid, room.moderator_password)
         }
-        before(:each) { get :end, :id => room.to_param, :format => 'json' }
+        before(:each) { get :end, :server_id => mocked_server.to_param, :id => room.to_param, :format => 'json' }
         it { should respond_with(:success) }
         it { should respond_with_content_type(:json) }
         it { should respond_with_json(I18n.t('bigbluebutton_rails.rooms.notice.end.success')) }
@@ -111,7 +111,7 @@ describe Bigbluebutton::RoomsController do
 
       context "room is not running" do
         before { mocked_api.should_receive(:is_meeting_running?).and_return(false) }
-        before(:each) { get :end, :id => room.to_param, :format => 'json' }
+        before(:each) { get :end, :server_id => mocked_server.to_param, :id => room.to_param, :format => 'json' }
         it { should respond_with(:error) }
         it { should respond_with_content_type(:json) }
         it { should respond_with_json(I18n.t('bigbluebutton_rails.rooms.notice.end.not_running')) }
@@ -122,7 +122,7 @@ describe Bigbluebutton::RoomsController do
         before {
           mocked_api.should_receive(:is_meeting_running?).and_return{ raise BigBlueButton::BigBlueButtonException.new(msg) }
         }
-        before(:each) { get :end, :id => room.to_param, :format => 'json' }
+        before(:each) { get :end, :server_id => mocked_server.to_param, :id => room.to_param, :format => 'json' }
         it { should respond_with(:error) }
         it { should respond_with_content_type(:json) }
         it { should respond_with_json(msg) }
@@ -139,7 +139,7 @@ describe Bigbluebutton::RoomsController do
           mocked_api.should_receive(:end_meeting)
         }
         before(:each) {
-          delete :destroy, :id => room.to_param, :format => 'json'
+          delete :destroy, :server_id => mocked_server.to_param, :id => room.to_param, :format => 'json'
         }
         it { should respond_with(:success) }
         it { should respond_with_content_type(:json) }
@@ -155,7 +155,7 @@ describe Bigbluebutton::RoomsController do
           mocked_api.should_receive(:is_meeting_running?).and_return{ raise BigBlueButton::BigBlueButtonException.new(msg) }
         }
         before(:each) {
-          delete :destroy, :id => room.to_param, :format => 'json'
+          delete :destroy, :server_id => mocked_server.to_param, :id => room.to_param, :format => 'json'
         }
         it { should respond_with(:error) }
         it { should respond_with_content_type(:json) }