bigbluebutton_rails 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 1.1.0
+
+* Rooms are now decoupled from servers:
+  * A room can exist without a server;
+  * Everytime a 'send_create' is called in a room, the method 'select_server' is called to select a server where the meeting will be held. The room is saved if the server changed;
+  * The method 'select_server' by default selects the server with less rooms;
+  * The routes for rooms are not nested with servers anymore ('/bigbluebutton/rooms' instead of '/bigbluebutton/server/:id/rooms').
+    * Because of this change all path helpers for rooms <b>must be updated!</b>
+* rooms/external now receives a parameter "server_id" to indicate the server in which the external rooms is running. The views were updated.
+* "bigbluebutton_routes :room_matchers" now generates all routes available for rooms, not only a selected set as before.
+
 == 1.0.0
 
 * First version with support to BigBlueButton 0.8:

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (1.0.0)
+    bigbluebutton_rails (1.1.0)
       bigbluebutton-api-ruby (~> 0.1.0)
       rails (>= 3.0.0)
 

data/README.rdoc

@@ -1,24 +1,23 @@
 = BigBlueButton on Rails
-http://travis-ci.org/mconf/bigbluebutton_rails.png {(more...)}[http://travis-ci.org/#!/mconf/bigbluebutton_rails]
+{<img src="http://travis-ci.org/mconf/bigbluebutton_rails.png" alt="Travis CI Status" />}[http://travis-ci.org/#!/mconf/bigbluebutton_rails]
 
 {BigBlueButton}[http://bigbluebutton.org] integration for Ruby on Rails 3.
 
 Features:
-* Allows multiple servers and multiple conference rooms
-* Full API access using {bigbluebutton-api-ruby}[https://github.com/mconf/bigbluebutton-api-ruby]
-* Easy way to join conferences: simply create a room and call the "join" action
-* Easy integration with authentication and authorization mechanisms, such as Devise and CanCan
-* Possibility to create private rooms, that require a password to join
-* Deals with visitors (users that are not logged), allowing (or forbidding) them to join rooms
-* Random meeting IDs to avoid problems with end_meeting, timeouts and reuse of URLs
-* Server activity monitor
-
-Planned features:
-* Friendly URLs (e.g. http://somewhere.com/my-server/my-room)
-* Limit the number of users per room and rooms per server
-* Server administration (modify config.xml, use bbb-conf, etc.)
-* Decouple servers-rooms to allow server selection on-the-fly
-* Load balancing
+* Allows multiple servers and multiple conference rooms.
+* Full API access using {bigbluebutton-api-ruby}[https://github.com/mconf/bigbluebutton-api-ruby].
+* Easy way to join conferences: simply create a room and call the "join" action.
+* Easy integration with authentication and authorization mechanisms, such as Devise and CanCan.
+* Possibility to create private rooms, that require a password to join.
+* Deals with visitors (users that are not logged), allowing (or forbidding) them to join rooms.
+* Random meeting IDs to avoid problems with end_meeting, timeouts and reuse of URLs.
+* Server activity monitor.
+* "On-the-fly" server selection when a meeting is started.
+
+Possible future features:
+* Limit the number of users per room and rooms per server.
+* Server administration (modify config.xml, use bbb-conf, etc.).
+* Load balancing.
 
 For more future features and issues check {our google code page}[http://code.google.com/p/mconf/issues/list?can=2&q=label%3AComponent%20label%3ABigBlueButtonRails].
 
@@ -66,33 +65,32 @@ The routes to BigbluebuttonRails can be generated with the helper <tt>bigbluebut
 It will generate the default routes. You need to call it at least once and the routes will be scoped with 'bigbluebutton'. They will look like:
 
   /bigbluebutton/servers
-  /bigbluebutton/servers/default-server/rooms/my-room
-  /bigbluebutton/servers/default-server/rooms/his-room/join
+  /bigbluebutton/servers/my-server/new
+  /bigbluebutton/servers/my-server/rooms
+  /bigbluebutton/rooms
+  /bigbluebutton/rooms/my-room/join
 
-You can customize the scope name and also make the routes point to custom controllers.
+You can customize the scope name and also make the routes use custom controllers.
 
   bigbluebutton_routes :default, :scope => 'webconference', :controllers => { :servers => 'custom_servers', :rooms => 'custom_rooms' }
   bigbluebutton_routes :default, :scope => '' # to remove the scope
 
 You may also want shorter routes to access conference rooms. For that, use the option <tt>room_matchers</tt>:
 
-  bigbluebutton_routes :room_matchers
-
   resources :users do
     bigbluebutton_routes :room_matchers
   end
 
-It creates routes to the actions used to access the conference room, so you can allow access to webconference rooms using URLs such as:
+It creates routes to the actions used to access a conference room, so you can allow access to webconference rooms using URLs such as:
 
-  http://myserver.com/server-name/room-name/join
-  http://myserver.com/user-name/public-room/join
-  http://myserver.com/ziltoid-room/join
+  http://myserver.com/my-community/room-name/join
+  http://myserver.com/user-name/room-name/join
 
 For more information see:
 
 * {How to: Routes}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Routes]
 
-=== User authorization, permissions and assumptions
+=== Basic configurations
 
 There are some basic assumptions made by BigbluebuttonRails:
 
@@ -103,7 +101,21 @@ If you don't, you can change this behaviour easily, keep reading.
 
 BigbluebuttonRails uses the methods <tt>bigbluebutton_user</tt> and <tt>bigbluebutton_role(room)</tt> to get the current user and to get the permission that the current
 user has in the <tt>room</tt>, respectively. These methods are defined in {lib/bigbluebutton_rails/controller_methods.rb}[https://github.com/mconf/bigbluebutton_rails/blob/master/lib/bigbluebutton_rails/controller_methods.rb]
-and you can reimplement them in your application controller to change their behaviour.
+and you can reimplement them in your application controller to change their behaviour as shown below.
+
+  class ApplicationController < ActionController::Base
+
+    # overriding bigbluebutton_rails function
+    def bigbluebutton_user
+      current_user && current_user.is_a?(User) ? current_user : nil
+    end
+
+    def bigbluebutton_role(room)
+      ...
+    end
+
+  end
+
 
 ==== See also
 
@@ -116,25 +128,27 @@ Fork this repository, clone your fork and start by installing the dependencies:
 
   bundle install
 
-Edit <tt>spec/rails_app/features/integration_conf.yml.example</tt> and set values for an existent BigBlueButton server. Save it as <tt>spec/integration_conf.yml</tt>. You will need it to run the integration tests. For more information see the page [Testing](https://github.com/mconf/bigbluebutton_rails/wiki/Testing) in our wiki.
+Save <tt>spec/rails_app/features/config.yml.example</tt> as <tt>config.yml</tt> and edit it to set values for an existent BigBlueButton server. You will need it to run the integration tests. For more information see the page {Testing}[https://github.com/mconf/bigbluebutton_rails/wiki/Testing] in our wiki.
 
 Prepare the rails_app used for tests:
 
   rake setup:rails_app
-  rake setup:rails_app:db
+  rake setup:rails_app:db SERVER=my-server # select a server you defined in 'config.yml'
 
 Run the tests:
 
   rake spec
-  rake cucumber
+  rake cucumber SERVER=my-server
 
 Or simply:
 
-  rake
+  rake SERVER=my-server
+
+Note: If you don't set the SERVER variable, the first server in <tt>config.yml</tt> will be used.
 
 Develop. :)
 
-If you want your code to be integrated in this repository, please create a branch with your modifications and submit a pull request.
+If you want your code to be integrated in this repository, please fork it, create a branch with your modifications and submit a pull request.
 
 === Test Coverage
 

data/Rakefile

@@ -69,7 +69,6 @@ task :notes do
   puts `grep -r 'OPTIMIZE\\|FIXME\\|TODO' app/ public/ spec/`
 end
 
-# FIXME: not the best way to test these migrations, but works for now
 desc 'Setup the rails_app using the migration files created when upgrading the gem
       version, run all tests and destroys the generated files.'
 namespace :spec do

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -2,13 +2,12 @@ require 'bigbluebutton_api'
 
 class Bigbluebutton::RoomsController < ApplicationController
 
-  before_filter :find_server
   before_filter :find_room, :only => [:show, :edit, :update, :destroy, :join, :invite, :running, :end, :destroy, :end, :join_mobile]
+  before_filter :find_server, :only => [:external, :external_auth]
   respond_to :html, :except => :running
   respond_to :json, :only => [:running, :show, :new, :index, :create, :update]
 
   def index
-    # TODO restrict to rooms belonging to the selected server
     respond_with(@rooms = BigbluebuttonRoom.all)
   end
 
@@ -26,7 +25,6 @@ class Bigbluebutton::RoomsController < ApplicationController
 
   def create
     @room = BigbluebuttonRoom.new(params[:bigbluebutton_room])
-    @room.server = @server
 
     if !params[:bigbluebutton_room].has_key?(:meetingid) or
         params[:bigbluebutton_room][:meetingid].blank?
@@ -37,7 +35,7 @@ class Bigbluebutton::RoomsController < ApplicationController
       if @room.save
         message = t('bigbluebutton_rails.rooms.notice.create.success')
         format.html {
-          params[:redir_url] ||= bigbluebutton_server_room_path(@server, @room)
+          params[:redir_url] ||= bigbluebutton_room_path(@room)
           redirect_to params[:redir_url], :notice => message
         }
         format.json { render :json => { :message => message }, :status => :created }
@@ -65,7 +63,7 @@ class Bigbluebutton::RoomsController < ApplicationController
       if @room.update_attributes(params[:bigbluebutton_room])
         message = t('bigbluebutton_rails.rooms.notice.update.success')
         format.html {
-          params[:redir_url] ||= bigbluebutton_server_room_path(@server, @room)
+          params[:redir_url] ||= bigbluebutton_room_path(@room)
           redirect_to params[:redir_url], :notice => message
         }
         format.json { render :json => { :message => message } }
@@ -101,7 +99,7 @@ class Bigbluebutton::RoomsController < ApplicationController
     respond_with do |format|
       format.html {
         flash[:error] = message if error
-        params[:redir_url] ||= bigbluebutton_server_rooms_url
+        params[:redir_url] ||= bigbluebutton_rooms_url
         redirect_to params[:redir_url]
       }
       if error
@@ -173,24 +171,31 @@ class Bigbluebutton::RoomsController < ApplicationController
     end
   end
 
+  # receives :server_id to indicate the server and :meeting to indicate the
+  # MeetingID of the meeting that should be joined
   def external
     if params[:meeting].blank?
       message = t('bigbluebutton_rails.rooms.errors.external.blank_meetingid')
-      params[:redir_url] ||= bigbluebutton_server_rooms_path(@server)
+      params[:redir_url] ||= bigbluebutton_rooms_path
       redirect_to params[:redir_url], :notice => message
     end
-    @room = BigbluebuttonRoom.new(:meetingid => params[:meeting])
+    @room = BigbluebuttonRoom.new(:server => @server, :meetingid => params[:meeting])
   end
 
   # Authenticates an user using name and password passed in the params from #external
   # Uses params[:meeting] to get the meetingID of the target room
   def external_auth
+    # check :meeting and :user
     if !params[:meeting].blank? && !params[:user].blank?
       @server.fetch_meetings
       @room = @server.meetings.select{ |r| r.meetingid == params[:meeting] }.first
+      message = t('bigbluebutton_rails.rooms.errors.external.inexistent_meeting') if @room.nil?
     else
+      message = t('bigbluebutton_rails.rooms.errors.external.wrong_params')
+    end
+
+    unless message.nil?
       @room = nil
-      message = t('bigbluebutton_rails.rooms.errors.auth.wrong_params')
       redirect_to request.referer, :notice => message
       return
     end
@@ -255,7 +260,7 @@ class Bigbluebutton::RoomsController < ApplicationController
     else
       respond_with do |format|
         format.html {
-          redirect_to(bigbluebutton_server_room_path(@server, @room), :notice => message)
+          redirect_to(bigbluebutton_room_path(@room), :notice => message)
         }
         format.json { render :json => message }
       end
@@ -264,7 +269,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def join_mobile
-    @join_url = join_bigbluebutton_server_room_url(@server, @room, :mobile => '1')
+    @join_url = join_bigbluebutton_room_url(@room, :mobile => '1')
     @join_url.gsub!(/http:\/\//i, "bigbluebutton://")
 
     # TODO: we can't use the mconf url because the mobile client scanning the qrcode is not
@@ -280,11 +285,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def find_server
-    if params.has_key?(:server_id)
-      @server = BigbluebuttonServer.find_by_param(params[:server_id])
-    else
-      @server = BigbluebuttonServer.first
-    end
+    @server = BigbluebuttonServer.find(params[:server_id])
   end
 
   def join_internal(username, role, wait_action)

data/app/controllers/bigbluebutton/servers_controller.rb

@@ -1,8 +1,8 @@
 class Bigbluebutton::ServersController < ApplicationController
 
   respond_to :html
-  respond_to :json, :only => [:index, :show, :new, :create, :update, :destroy, :activity]
-  before_filter :find_server, :only => [:show, :edit, :activity, :update, :destroy]
+  respond_to :json, :only => [:index, :show, :new, :create, :update, :destroy, :activity, :rooms]
+  before_filter :find_server, :only => [:show, :edit, :activity, :update, :destroy, :rooms]
 
   def index
     respond_with(@servers = BigbluebuttonServer.all)
@@ -97,6 +97,10 @@ class Bigbluebutton::ServersController < ApplicationController
     end
   end
 
+  def rooms
+    respond_with(@rooms = @server.rooms)
+  end
+
   protected
 
   def find_server

data/app/models/bigbluebutton_room.rb

@@ -2,7 +2,6 @@ class BigbluebuttonRoom < ActiveRecord::Base
   belongs_to :server, :class_name => 'BigbluebuttonServer'
   belongs_to :owner, :polymorphic => true
 
-  validates :server_id, :presence => true
   validates :meetingid, :presence => true, :uniqueness => true,
     :length => { :minimum => 1, :maximum => 100 }
   validates :name, :presence => true, :uniqueness => true,
@@ -64,6 +63,8 @@ class BigbluebuttonRoom < ActiveRecord::Base
   #
   # Triggers API call: <tt>get_meeting_info</tt>.
   def fetch_meeting_info
+    require_server
+
     response = self.server.api.get_meeting_info(self.meetingid, self.moderator_password)
 
     @participant_count = response[:participantCount]
@@ -86,6 +87,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
   #
   # Triggers API call: <tt>is_meeting_running</tt>.
   def fetch_is_running?
+    require_server
     @running = self.server.api.is_meeting_running?(self.meetingid)
   end
 
@@ -93,17 +95,25 @@ class BigbluebuttonRoom < ActiveRecord::Base
   #
   # Triggers API call: <tt>end_meeting</tt>.
   def send_end
+    require_server
     self.server.api.end_meeting(self.meetingid, self.moderator_password)
   end
 
   # Sends a call to the BBB server to create the meeting.
   #
+  # Will trigger 'select_server' to select a server where the meeting
+  # will be created. If a server is selected, the model is saved.
+  #
   # With the response, updates the following attributes:
   # * <tt>attendee_password</tt>
   # * <tt>moderator_password</tt>
   #
   # Triggers API call: <tt>create_meeting</tt>.
   def send_create
+    # updates the server whenever a meeting will be created
+    self.server = select_server
+    self.save unless self.new_record?
+    require_server
 
     unless self.randomize_meetingid
       response = do_create_meeting
@@ -145,6 +155,8 @@ class BigbluebuttonRoom < ActiveRecord::Base
   #
   # Uses the API but does not require a request to the server.
   def join_url(username, role, password=nil)
+    require_server
+
     case role
     when :moderator
       self.server.api.join_meeting_url(self.meetingid, username, self.moderator_password)
@@ -234,6 +246,28 @@ class BigbluebuttonRoom < ActiveRecord::Base
 
   protected
 
+  # Every room needs a server to be used.
+  # The server of a room can change during the room's lifespan, but
+  # it should not change if the room is running or if it was created
+  # but not yet ended.
+  # Any action that requires a server should call 'require_server' before
+  # anything else.
+  def require_server
+    if self.server.nil?
+      msg = I18n.t('bigbluebutton_rails.rooms.errors.server.not_set')
+      raise BigbluebuttonRails::ServerRequired.new(msg)
+    end
+  end
+
+  # This method can be overridden to change the way the server is selected
+  # before a room is created
+  # This one selects the server with less rooms in it
+  def select_server
+    BigbluebuttonServer.
+      select("bigbluebutton_servers.*, count(bigbluebutton_rooms.id) as room_count").
+      joins(:rooms).group(:server_id).order("room_count ASC").first
+  end
+
   def init
     self[:meetingid] ||= random_meetingid
     self[:voice_bridge] ||= random_voice_bridge

data/app/models/bigbluebutton_server.rb

@@ -4,7 +4,7 @@ class BigbluebuttonServer < ActiveRecord::Base
   has_many :rooms,
            :class_name => 'BigbluebuttonRoom',
            :foreign_key => 'server_id',
-           :dependent => :destroy
+           :dependent => :nullify
 
   validates :name,
             :presence => true,

data/app/views/bigbluebutton/rooms/_form.html.erb

@@ -1,10 +1,10 @@
 <% if @room.new_record? %>
-  <% url = bigbluebutton_server_rooms_path(@server) %>
+  <% url = bigbluebutton_rooms_path %>
 <% else %>
-  <% url = bigbluebutton_server_room_path(@server, @room) %>
+  <% url = bigbluebutton_room_path(@room) %>
 <% end %>
 
-<%= form_for [@server, @room], :url => url do |f| %>
+<%= form_for @room, :url => url do |f| %>
   <% if @room.errors.any? %>
     <div id="error_explanation">
       <h2><%= pluralize(@room.errors.count, "error") %>:</h2>
@@ -16,6 +16,10 @@
     </div>
   <% end %>
 
+  <div class="field">
+    <%= f.label :server_id %><br />
+    <%= f.text_field :server_id %>
+  </div>
   <div class="field">
     <%= f.label :name %><br />
     <%= f.text_field :name %>

data/app/views/bigbluebutton/rooms/_rooms.html.erb

@@ -0,0 +1,37 @@
+<div id="bbbrails_rooms_links">
+  <%= link_to('View servers list', bigbluebutton_servers_path) %><br/>
+  <%= link_to('New room', new_bigbluebutton_room_path) %>
+</div>
+
+<ul id="bbbrails_rooms_list">
+  <% @rooms.each do |room| %>
+    <li>
+      <div class="field">
+        <label><%= BigbluebuttonRoom.human_attribute_name(:server_id) %></label> <%= room.server_id %>
+        <%= link_to('(view server)', bigbluebutton_server_path(room.server)) unless room.server.nil? %>
+      </div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:meetingid) %></label> <%= room.meetingid %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:randomize_meetingid) %></label> <%= room.randomize_meetingid %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:name) %></label> <%= room.name %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:private) %></label> <%= room.private %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:attendee_password) %></label> <%= room.attendee_password %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:moderator_password) %></label> <%= room.moderator_password %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:welcome_msg) %></label> <%= room.welcome_msg %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:logout_url) %></label> <%= room.logout_url %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:dial_number) %></label> <%= room.dial_number %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:voice_bridge) %></label> <%= room.voice_bridge %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:max_participants) %></label> <%= room.max_participants %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:external) %></label> <%= room.external %></div>
+      <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:param) %></label> <%= room.param %></div>
+      <div class="field"><label>Access</label>
+        <%= link_to 'Show', bigbluebutton_room_path(room) %> |
+        <%= link_to 'Join', join_bigbluebutton_room_path(room) %> |
+        <%= link_to 'Invite', invite_bigbluebutton_room_path(room) %> |
+        <%= link_to 'Mobile Join', join_mobile_bigbluebutton_room_path(room) %> |
+        <%= link_to 'Edit', edit_bigbluebutton_room_path(room) %> |
+        <%= link_to 'End', end_bigbluebutton_room_path(room), :confirm => 'Are you sure?' %> |
+        <%= link_to 'Destroy', bigbluebutton_room_path(room), :confirm => 'Are you sure?', :method => :delete %>
+      </div>
+    </li>
+  <% end %>
+</ul>