bigbluebutton_rails 2.1.0 → 2.2.0

data/app/models/bigbluebutton_server.rb

@@ -3,15 +3,10 @@ require 'bigbluebutton_api'
 class BigbluebuttonServer < ActiveRecord::Base
   include ActiveModel::ForbiddenAttributesProtection
 
-  has_many :rooms,
-           :class_name => 'BigbluebuttonRoom',
-           :foreign_key => 'server_id',
-           :dependent => :nullify
-
   has_many :recordings,
-           :class_name => 'BigbluebuttonRecording',
-           :foreign_key => 'server_id',
-           :dependent => :nullify
+           class_name: 'BigbluebuttonRecording',
+           foreign_key: 'server_id',
+           dependent: :destroy
 
   has_one :config,
           class_name: 'BigbluebuttonServerConfig',
@@ -25,12 +20,10 @@ class BigbluebuttonServer < ActiveRecord::Base
 
   validates :name,
             :presence => true,
-            :uniqueness => true,
             :length => { :minimum => 1, :maximum => 500 }
 
   validates :url,
             :presence => true,
-            :uniqueness => true,
             :length => { :maximum => 500 },
             :format => { :with => /http[s]?:\/\/.*\/bigbluebutton\/api/,
                          :message => I18n.t('bigbluebutton_rails.servers.errors.url_format') }
@@ -62,12 +55,22 @@ class BigbluebuttonServer < ActiveRecord::Base
   before_save :check_for_version_update
   after_update :check_for_config_update
 
+  # Schedules a recording update right after a recording server is added.
+  after_create do
+    Resque.enqueue(::BigbluebuttonUpdateRecordings, self.id)
+  end
+
   # In case there's no config created yet, build one.
   def config_with_initialize
-    config_without_initialize || build_config
+    config_without_initialize || build_config(server: self)
   end
   alias_method_chain :config, :initialize
 
+  # Helper to get the default server
+  def self.default
+    self.first
+  end
+
   # Returns the API object (<tt>BigBlueButton::BigBlueButtonAPI</tt> defined in
   # <tt>bigbluebutton-api-ruby</tt>) associated with this server.
   def api
@@ -90,15 +93,21 @@ class BigbluebuttonServer < ActiveRecord::Base
     # updates the information in the rooms that are currently in BBB
     @meetings = []
     response[:meetings].each do |attr|
-      room = BigbluebuttonRoom.find_by_server_id_and_meetingid(self.id, attr[:meetingID])
+      room = BigbluebuttonRoom.find_by(meetingid: attr[:meetingID])
       # TODO: there might be more attributes returned by the API, review them all
       if room.nil?
-        room = BigbluebuttonRoom.new(:server => self, :meetingid => attr[:meetingID],
-                                     :name => attr[:meetingID], :attendee_api_password => attr[:attendeePW],
-                                     :moderator_api_password => attr[:moderatorPW], :external => true, :private => true)
+        attrs = {
+          meetingid: attr[:meetingID],
+          name: attr[:meetingID],
+          attendee_api_password: attr[:attendeePW],
+          moderator_api_password: attr[:moderatorPW],
+          external: true,
+          private: true
+        }
+        room = BigbluebuttonRoom.new(attrs)
       else
-        room.update_attributes(:attendee_api_password => attr[:attendeePW],
-                               :moderator_api_password => attr[:moderatorPW])
+        room.update_attributes(attendee_api_password: attr[:attendeePW],
+                               moderator_api_password: attr[:moderatorPW])
       end
       room.running = attr[:running]
       room.update_current_meeting_record
@@ -168,6 +177,11 @@ class BigbluebuttonServer < ActiveRecord::Base
     self.version
   end
 
+  # Returns the URL to the <tt>/check</tt> request in the server.
+  def check_url
+    self.api.check_url
+  end
+
   protected
 
   def init

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

@@ -10,49 +10,49 @@
     </div>
   <% end %>
 
+  <div class="field">
+    <%= f.label :description %><br />
+    <%= f.text_field :description %>
+  </div>
   <div class="field">
     <%= f.label :id %><br />
     <%= @recording.id %>
   </div>
   <div class="field">
     <%= f.label :recordid %><br />
-    <%= f.text_field :recordid %>
+    <%= f.text_field :recordid, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :name %><br />
-    <%= f.text_field :name %>
+    <%= f.text_field :name, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :room_id %><br />
-    <%= f.text_field :room_id, :disabled => "disabled" %>
+    <%= f.text_field :room_id, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :server_id %><br />
-    <%= f.text_field :server_id, :disabled => "disabled" %>
+    <%= f.text_field :server_id, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :published %><br />
-    <%= f.check_box :published %>
+    <%= f.check_box :published, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :available %><br />
-    <%= f.check_box :available %>
+    <%= f.check_box :available, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :start_time %><br />
-    <%= f.text_field :start_time %>
+    <%= f.text_field :start_time, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :end_time %><br />
-    <%= f.text_field :end_time %>
-  </div>
-  <div class="field">
-    <%= f.label :description %><br />
-    <%= f.text_field :description %>
+    <%= f.text_field :end_time, :disabled => true %>
   </div>
   <div class="field">
     <%= f.label :size %><br />
-    <%= f.text_field :size %>
+    <%= f.text_field :size, :disabled => true %>
   </div>
 
   <p>

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

@@ -20,10 +20,6 @@
     <%= f.label :id %><br />
     <%= @room.id %>
   </div>
-  <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

@@ -8,10 +8,6 @@
   <% @rooms.each do |room| %>
     <li>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:id) %></label> <%= room.id %></div>
-      <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(:name) %></label> <%= room.name %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:meetingid) %></label> <%= room.meetingid %></div>
       <div class="field"><label><%= BigbluebuttonRoom.human_attribute_name(:private) %></label> <%= room.private %></div>

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

@@ -4,10 +4,6 @@
   <b><%= BigbluebuttonRoom.human_attribute_name(:id) %>:</b>
   <%= @room.id %>
 </p>
-<p>
-  <b><%= BigbluebuttonRoom.human_attribute_name(:server_id) %>:</b>
-  <%= @room.server_id %>
-</p>
 <p>
   <b><%= BigbluebuttonRoom.human_attribute_name(:name) %>:</b>
   <%= @room.name %>

data/app/workers/bigbluebutton_update_recordings.rb

@@ -4,8 +4,8 @@
 class BigbluebuttonUpdateRecordings
   @queue = :bigbluebutton_rails
 
-  def self.perform
+  def self.perform(server_id=nil)
     Rails.logger.info "BigbluebuttonUpdateRecordings worker running"
-    BigbluebuttonRails::BackgroundTasks.update_recordings
+    BigbluebuttonRails::BackgroundTasks.update_recordings(server_id)
   end
 end

data/config/locales/en.yml

@@ -50,7 +50,6 @@ en:
         private: Private
         presenter_share_only: "Only presenter shares audio and video"
         record: Record
-        server_id: "Server ID"
         voice_bridge: "Voice Bridge"
         welcome_msg: "Welcome Message"
       bigbluebutton_server:
@@ -106,7 +105,7 @@ en:
           success: "Your recording was successfully updated."
     rooms:
       default_welcome_msg: "Welcome to <b>%%CONFNAME%%</b>!<br><br>To join the audio bridge click the headset icon (upper-left hand corner). Use a headset to avoid causing background noise for others.<br>"
-      default_welcome_msg_dial_number: "Welcome to <b>%%CONFNAME%%</b>!<br><br>To join the audio bridge click the headset icon (upper-left hand corner). Use a headset to avoid causing background noise for others.<br>You can call into this conference with a regular phone using the number \"%%DIALNUM%%\".<br>"
+      default_welcome_msg_dial_number: "<br>You can call into this conference with a regular phone using the number \"%%DIALNUM%%\".<br>"
       errors:
         fetch_recordings:
           no_server: "There's no server associated with this room."

data/config/locales/pt-br.yml

@@ -50,7 +50,6 @@ pt-br:
         private: Privada
         presenter_share_only: "Somente apresentador compartilha áudio e vídeo"
         record: Gravar
-        server_id: "ID do Servidor"
         voice_bridge: "Voice Bridge"
         welcome_msg: "Mensagem de boas-vindas"
       bigbluebutton_server:
@@ -106,7 +105,7 @@ pt-br:
           success: "Sua gravação foi atualizada com sucesso."
     rooms:
       default_welcome_msg: "Bem-vindo(a) a <b>%%CONFNAME%%</b>!<br><br>Para compartilhar o seu microfone, clique no botão com um headset (à esquerda da barra superior). Use um headset para ter uma melhor experiência de áudio com menos ruídos.<br>"
-      default_welcome_msg_dial_number: "Bem-vindo(a) a <b>%%CONFNAME%%</b>!<br><br>Para compartilhar o seu microfone, clique no botão com um headset (à esquerda da barra superior). Use um headset para ter uma melhor experiência de áudio com menos ruídos.<br>Você pode discar para esta conferência através de um telefone usando o número \"%%DIALNUM%%\".<br>"
+      default_welcome_msg_dial_number: "<br>Você pode discar para esta conferência através de um telefone usando o número \"%%DIALNUM%%\".<br>"
       errors:
         fetch_recordings:
           no_server: "Não há nenhum servidor associado a esta sala."

data/lib/bigbluebutton_rails.rb

@@ -1,120 +1,34 @@
 require 'rails'
+require 'browser'
+require 'resque'
+require 'resque-scheduler'
 
 require 'classes/bigbluebutton_attendee'
 
-module BigbluebuttonRails
-  require 'browser'
-  require 'resque'
-  require 'resque-scheduler'
-  require 'bigbluebutton_rails/rails'
-  require 'bigbluebutton_rails/utils'
-  require 'bigbluebutton_rails/controller_methods'
-  require 'bigbluebutton_rails/internal_controller_methods'
-  require 'bigbluebutton_rails/background_tasks'
-  require 'bigbluebutton_rails/rails/routes'
-  require 'bigbluebutton_rails/exceptions'
-  require 'bigbluebutton_rails/dial_number'
-
-  # Default controllers to generate the routes
-  mattr_accessor :controllers
-  @@controllers = {
-    :servers => 'bigbluebutton/servers',
-    :rooms => 'bigbluebutton/rooms',
-    :recordings => 'bigbluebutton/recordings',
-    :playback_types => 'bigbluebutton/playback_types'
-  }
-
-  # Default scope for routes
-  mattr_accessor :routing_scope
-  @@routing_scope = 'bigbluebutton'
-
-  # Name of the metadata parameter that will contain the room's ID
-  # when a room is created. Used to match the room of a recording when
-  # recordings are fetched from the DB.
-  # Has to be a symbol!
-  mattr_accessor :metadata_room_id
-  @@metadata_room_id = :'bbbrails-room-id'
-
-  # Name of the metadata parameter that will contain the user's ID
-  # when a room is created.
-  # Has to be a symbol!
-  mattr_accessor :metadata_user_id
-  @@metadata_user_id = :'bbbrails-user-id'
-
-  # Name of the metadata parameter that will contain the user's name
-  # when a room is created.
-  # Has to be a symbol!
-  mattr_accessor :metadata_user_name
-  @@metadata_user_name = :'bbbrails-user-name'
-
-  # Name of the metadata parameter that will contain the room's invitation
-  # URL, in case `invitation_url_method` is implemented by the application.
-  # Has to be a symbol!
-  mattr_accessor :metadata_invitation_url
-  @@metadata_invitation_url = :'invitation-url'
-
-  # List of invalid metadata keys. Invalid keys are usually keys that are
-  # used by the gem and by the application. The application using this gem
-  # can add items to this list as well.
-  # All values added can be symbols or strings.
-  mattr_accessor :metadata_invalid_keys
-  @@metadata_invalid_keys =
-    [ @@metadata_room_id,
-      @@metadata_user_id,
-      @@metadata_user_name,
-      @@metadata_invitation_url ]
+require 'bigbluebutton_rails/rails'
+require 'bigbluebutton_rails/configuration'
+require 'bigbluebutton_rails/utils'
+require 'bigbluebutton_rails/controller_methods'
+require 'bigbluebutton_rails/internal_controller_methods'
+require 'bigbluebutton_rails/background_tasks'
+require 'bigbluebutton_rails/rails/routes'
+require 'bigbluebutton_rails/exceptions'
+require 'bigbluebutton_rails/dial_number'
 
-  # Name of the attribute of a user that defines his name/username.
-  mattr_accessor :user_attr_name
-  @@user_attr_name = :'name'
-
-  # Name of the attribute of a user that defines his ID.
-  mattr_accessor :user_attr_id
-  @@user_attr_id = :'id'
-
-  # Name of the method that returns the invitation URL of a room.
-  # Must be implemented by the application, there's no default implemented in this gem.
-  mattr_accessor :invitation_url_method
-  @@invitation_url_method = :'invitation_url'
-
-  # Name of the method that returns a hash of metadata to be added to create calls.
-  # By default only the metadata created in the database and associated with the room
-  # will be used. This method can be used to dynamically decide on which metadata to
-  # use when a meeting is about to be created.
-  # Receives the meeting as argument and must return a hash where keys are metadata keys
-  # and values are the metadata values.
-  mattr_accessor :dynamic_metadata_method
-  @@dynamic_metadata_method = :'dynamic_metadata'
-
-  # Whether or not the gem should pass the voice bridges set in the rooms when making
-  # API calls. By default it is false, meaning that the voice bridge will never be
-  # passed, so it will be generated by the web conference server. Setting it to true
-  # will make the voice bridge set locally in the room to be used in the web conference
-  # server. Notice that the voice bridge has to be unique in a web conference server, so
-  # if you are setting the voice bridges manually, you will also have to make sure that
-  # the voice bridges are unique (there's nothing in the gem to guarantee this uniqueness).
-  mattr_accessor :use_local_voice_bridges
-  @@use_local_voice_bridges = false
-
-  # Finds the BigbluebuttonRoom associated with the recording data in 'data', if any.
-  # TODO: if not found, remove the association or keep the old one?
-  def self.match_room_recording(data)
-    if block_given?
-      yield
-    else
-      BigbluebuttonRoom.find_by_meetingid(data[:meetingid])
-    end
+module BigbluebuttonRails
+  class << self
+    attr_accessor :configuration
   end
 
-  def self.set_controllers(options)
-    unless options.nil?
-      @@controllers.merge!(options).slice!(:servers, :rooms, :recordings, :playback_types)
-    end
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  # Default way to setup the gem.
-  def self.setup
-    yield self
+  def self.reset
+    @configuration = Configuration.new
   end
 
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/bigbluebutton_rails/background_tasks.rb

@@ -17,11 +17,15 @@ module BigbluebuttonRails
       end
     end
 
-    def self.update_recordings
+    # Updates the recordings for all servers if `server_id` is nil or or for the
+    # server with id `server_id`.
+    def self.update_recordings(server_id=nil)
       BigbluebuttonServer.find_each do |server|
         begin
-          server.fetch_recordings(nil, true)
-          Rails.logger.info "BackgroundTasks: List of recordings from #{server.url} updated successfully"
+          if server_id.nil? || server_id == server.id
+            server.fetch_recordings(nil, true)
+            Rails.logger.info "BackgroundTasks: List of recordings from #{server.url} updated successfully"
+          end
         rescue Exception => e
           Rails.logger.info "BackgroundTasks: Failure fetching recordings from #{server.inspect}"
           Rails.logger.info "BackgroundTasks: #{e.inspect}"

data/lib/bigbluebutton_rails/configuration.rb

@@ -0,0 +1,80 @@
+module BigbluebuttonRails
+  class Configuration
+    attr_accessor :guest_support
+    attr_accessor :controllers
+    attr_accessor :routing_scope
+    attr_accessor :metadata_room_id
+    attr_accessor :metadata_user_id
+    attr_accessor :metadata_user_name
+    attr_accessor :metadata_invitation_url
+    attr_accessor :metadata_invalid_keys
+    attr_accessor :user_attr_name
+    attr_accessor :user_attr_id
+    attr_accessor :use_local_voice_bridges
+
+    # methods
+    attr_accessor :select_server
+    attr_accessor :match_room_recording
+    attr_accessor :get_invitation_url
+    attr_accessor :get_dynamic_metadata
+
+    def initialize
+      @controllers = {
+        servers: 'bigbluebutton/servers',
+        rooms: 'bigbluebutton/rooms',
+        recordings: 'bigbluebutton/recordings',
+        playback_types: 'bigbluebutton/playback_types'
+      }
+      @routing_scope = 'bigbluebutton'
+
+      @metadata_room_id        = :'bbbrails-room-id'
+      @metadata_user_id        = :'bbbrails-user-id'
+      @metadata_user_name      = :'bbbrails-user-name'
+      @metadata_invitation_url = :'invitation-url'
+      @metadata_invalid_keys =
+        [ @metadata_room_id, @metadata_user_id,
+          @metadata_user_name, @metadata_invitation_url ]
+
+      @user_attr_name = :'name'
+      @user_attr_id   = :'id'
+      @use_local_voice_bridges = false
+      @guest_support = false
+
+      # How to find the room of a recording using the `data` returned by
+      # a `getRecordings`.
+      @match_room_recording = Proc.new do |data, *args|
+        BigbluebuttonRoom.find_by_meetingid(data[:meetingid])
+      end
+
+      # Default method to return the invitation URL of a room. By default
+      # returns nil (disable the feature).
+      @get_invitation_url = Proc.new{ |room| nil }
+
+      # Default method to get the dynamic metadata to use when creating a
+      # conference in a room.
+      @get_dynamic_metadata = Proc.new{ |room| nil }
+
+      # Selects a server to be used by `room` whenever it needs to make API calls.
+      # By default, if no servers are available an exception is raised.
+      #
+      # This method can be overwritten to change the way the server is selected
+      # before a room is used. `api_method` contains the API method that is being
+      # called. Any server returned here will be used. It *must* return a server,
+      # otherwise the API calls will fail and the code will probably break.
+      #
+      # One good example is to always select a new server when a meeting is being
+      # created (in case `api_method` is `:create`), making this a simple load
+      # balancing tool that can work well in simple cases.
+      @select_server = Proc.new do |room, api_method=nil|
+        room.select_server(api_method)
+      end
+    end
+
+    def set_controllers(options)
+      unless options.nil? || options.empty?
+        @controllers.merge!(options).slice!(:servers, :rooms, :recordings, :playback_types)
+      end
+    end
+
+  end
+end