bigbluebutton_rails 1.4.0 → 2.0.0

data/app/workers/bigbluebutton_update_recordings.rb

@@ -0,0 +1,11 @@
+# A resque worker to get the list of recordings from the server and update
+# the database.
+# Same as "rake bigbluebutton_rails:recordings:update".
+class BigbluebuttonUpdateRecordings
+  @queue = :bigbluebutton_rails
+
+  def self.perform
+    Rails.logger.info "BigbluebuttonUpdateRecordings worker running"
+    BigbluebuttonRails::BackgroundTasks.update_recordings
+  end
+end

data/app/workers/bigbluebutton_update_server_configs.rb

@@ -0,0 +1,18 @@
+# A resque worker to get the server configs from time to time (information such
+# as available layouts are updated).
+class BigbluebuttonUpdateServerConfigs
+  @queue = :bigbluebutton_rails
+
+  def self.perform
+    Rails.logger.info "BigbluebuttonUpdateServerConfigs worker running"
+    BigbluebuttonServer.find_each do |server|
+      Rails.logger.info "BigbluebuttonUpdateServerConfigs updating configs for #{server.inspect}"
+
+      # update configs
+      server.update_config
+
+      # update API version
+      server.update_attributes(version: server.set_api_version_from_server)
+    end
+  end
+end

data/bigbluebutton_rails.gemspec

@@ -8,17 +8,18 @@ Gem::Specification.new do |s|
   s.summary     = "BigBlueButton integration for Ruby on Rails"
   s.email       = "mconf-dev@googlegroups.com"
   s.homepage    = "http://github.com/mconf/bigbluebutton_rails"
-  s.description = "It allows you to interact with BigBlueButton from your Ruby on Rails application"
-  s.authors     = ['Mconf', 'Leonardo Crauss Daronco']
-  s.license     = 'MIT'
+  s.description = "Allows access and use of BigBlueButton from a Ruby on Rails application"
+  s.authors     = ["Mconf", "Leonardo Crauss Daronco"]
+  s.email       = ["contact@mconf.org", "leonardodaronco@gmail.com"]
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency("rails", ">= 3.0.0")
-  s.add_dependency("bigbluebutton-api-ruby", "~> 1.3.0")
-  s.add_dependency("strong_parameters", "~> 0.2.0")
+  s.add_dependency("rails", ">= 4.0.0")
+  s.add_dependency("bigbluebutton-api-ruby", "~> 1.4.0")
   s.add_dependency("resque", "~> 1.25.1")
-  s.add_dependency("browser", "~> 0.5.0")
+  s.add_dependency("resque-scheduler", "~> 3.0")
+  s.add_dependency("browser", "~> 0.8.0")
 end

data/config/locales/en.yml

@@ -10,6 +10,10 @@ en:
         format_type: Type
         length: Length
         url: URL
+      bigbluebutton_playback_type:
+        default: Default
+        name: Name
+        visible: Visible
       bigbluebutton_recording:
         description: "Description"
         end_time: "End Time"
@@ -20,9 +24,17 @@ en:
         recordid: "Record ID"
         room_id: "Room ID"
         server_id: "Server ID"
+        size: "Size"
         start_time: "Start Time"
       bigbluebutton_room:
-        attendee_password: "Attendee Password"
+        allow_start_stop_recording: "Allow users to start/stop recording"
+        attendee_api_password: "Internal API key for attendees"
+        attendee_key: "Key for attendees"
+        auto_start_video: "Auto start video"
+        auto_start_audio: "Auto start audio"
+        auto_start_recording: "Auto start recording"
+        background: "Background image"
+        default_layout: "Default Layout"
         dial_number: "Dial Number"
         duration: Duration
         external: "Externally Created"
@@ -30,10 +42,13 @@ en:
         max_participants: "Maximum Number of Participants"
         meetingid: "Meeting ID"
         metadata: Metadata
-        moderator_password: "Moderator Password"
+        moderator_api_password: "Internal API key for moderators"
+        moderator_key: "Key for moderators"
+        moderator_only_message: "Message to be shown to moderators only"
         name: Name
         param: "String ID"
         private: Private
+        presenter_share_only: "Only presenter shares audio and video"
         record: Record
         server_id: "Server ID"
         voice_bridge: "Voice Bridge"
@@ -44,17 +59,33 @@ en:
         salt: "Security Salt"
         url: URL
         version: Version
+      bigbluebutton_server_config:
+        available_layouts: "Available layouts"
     models:
-      bigbluebutton_metadata: "BigBlueButton Recording Metadata"
-      bigbluebutton_playback_format: "BigBlueButton Recording Playback Format"
-      bigbluebutton_recording: "BigBlueButton Recording"
-      bigbluebutton_room: "BigBlueButton Room"
-      bigbluebutton_server: "BigBlueButton Server"
+      bigbluebutton_metadata: "Web Conference Recording Metadata"
+      bigbluebutton_playback_format: "Web Conference Recording Playback Format"
+      bigbluebutton_recording: "Web Conference Recording"
+      bigbluebutton_room: "Web Conference Room"
+      bigbluebutton_server: "Web Conference Server"
+      bigbluebutton_server_config: "Web Conference Server Configurations"
   bigbluebutton_rails:
     bigbluebutton: BigBlueButton
     metadata:
       errors:
         name_format: "can only use letters, numbers and the symbols \"-\" or \"_\", but only letters at the beginning"
+    playback_types:
+      notice:
+        update:
+          success: "The playback type was successfully updated."
+      presentation:
+        name: "Play"
+        tip: "Plays the recording in an HTML5 page. The recording is not downloaded to your computer and will require Internet to be reproduced."
+      presentation_export:
+        name: "Download HTML"
+        tip: "Downloads an HTML page that you can use to reproduce the recording offline using your browser. Has all the features of the HTML player online plus the advantage of also working offline. Currently can only be reproduced using the Firefox browser."
+      presentation_video:
+        name: "Download"
+        tip: "Downloads a vídeo file (uses the WebM format) with the recording. You can use this video file to watch the recording offline and to share this recording in other websites."
     recordings:
       default:
         description: "Meeting held on %{time} (UTC)"
@@ -74,6 +105,8 @@ en:
         update:
           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>"
       errors:
         fetch_recordings:
           no_server: "There's no server associated with this room."
@@ -82,6 +115,8 @@ en:
           failure: "Authentication failure."
           not_running: "The meeting is not running. You must wait for a moderator to join."
           wrong_params: "Wrong params in your request."
+        generate_dial_number:
+          not_unique: "We're sorry, but it wasn't possible to generate a unique dial number for this room. You can either try again or manually set a dial number."
         param_format: "can only use letters, numbers and the symbols \"-\" or \"_\" (not at the begin or end)"
         server:
           nil: "Your room must be associated to a server to execute this operation."
@@ -97,6 +132,8 @@ en:
           success: "The meeting was successfully ended."
         fetch_recordings:
           success: "The list of recordings for this room was successfully updated."
+        generate_dial_number:
+          success: "A unique dial number was generated and saved."
         update:
           failure: "Your room could not be updated."
           success: "Your room was successfully updated."
@@ -115,3 +152,11 @@ en:
           success: "Your recordings were successfully unpublished."
         update:
           success: "Your server was successfully updated."
+    server_configs:
+      layouts:
+        defaultlayout: "Default Layout"
+        lecture: "Lecture"
+        lectureassistant: "Lecture Assistant"
+        presentfocus: "Webinar"
+        videochat: "Video Chat"
+        webcamsfocus: "Meeting"

data/config/locales/pt-br.yml

@@ -0,0 +1,162 @@
+---
+pt-br:
+  activerecord:
+    attributes:
+      bigbluebutton_metadata:
+        content: Conteúdo
+        name: Nome
+        owner: Dono
+      bigbluebutton_playback_format:
+        format_type: Tipo
+        length: Tamanho
+        url: URL
+      bigbluebutton_playback_type:
+        default: "Padrão"
+        name: Nome
+        visible: "Visível"
+      bigbluebutton_recording:
+        description: "Descrição"
+        end_time: "Horário de Fim"
+        meetingid: "ID da Reunião"
+        metadata: Metadados
+        name: Nome
+        published: Publicada
+        recordid: "ID da Gravação"
+        room_id: "ID da Sala"
+        size: "Tamanho"
+        server_id: "ID do Servidor"
+        start_time: "Horário de Início"
+      bigbluebutton_room:
+        allow_start_stop_recording: "Permitir ao usuário iniciar/parar a gravação"
+        attendee_api_password: "Chave interna da API para participantes"
+        attendee_key: "Chave para participantes"
+        auto_start_video: "Auto iniciar vídeo"
+        auto_start_audio: "Auto iniciar áudio"
+        auto_start_recording: "Auto iniciar gravação"
+        background: "Imagem de fundo"
+        default_layout: "Layout Padrão"
+        dial_number: "Número de discagem"
+        duration: Duração
+        external: "Criada externamente"
+        logout_url: "URL de saída"
+        max_participants: "Número Máximo de Participantes"
+        meetingid: "ID da Reunião"
+        metadata: Metadados
+        moderator_api_password: "Chave interna da API para moderadores"
+        moderator_key: "Chave para moderadores"
+        moderator_only_message: "Mensagem mostrada somente aos moderadores"
+        name: Nome
+        param: Identificador
+        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:
+        name: Nome
+        param: Identificador
+        salt: "Chave de segurança"
+        url: URL
+        version: Versão
+      bigbluebutton_server_config:
+        available_layouts: "Layouts disponíveis"
+    models:
+      bigbluebutton_metadata: "Metadado de Gravação da Webconferência"
+      bigbluebutton_playback_format: "Formato de Reprodução de Webconferência"
+      bigbluebutton_recording: "Gravação de Webconferência"
+      bigbluebutton_room: "Sala de Webconferência"
+      bigbluebutton_server: "Servidor de Webconferência"
+      bigbluebutton_server_config: "Configurações do Servidor de Webconferência"
+  bigbluebutton_rails:
+    bigbluebutton: BigBlueButton
+    metadata:
+      errors:
+        name_format: "pode utilizar apenas letras, números e os símbolos \"-\" ou \"_\", mas apenas letras no início"
+    playback_types:
+      notice:
+        update:
+          success: "Formato de reprodução atualizado com sucesso."
+      presentation:
+        name: "Reproduzir"
+        tip: "Reproduz a gravação em uma página HTML5. Não é feito download da gravação para o seu computador, portanto exige internet para a gravação ser reproduzida."
+      presentation_export:
+        name: "Download HTML"
+        tip: "Faz o download de uma página HTML que você pode usar para reproduzir a gravação usando o seu navegador mesmo sem conexão com a internet. Tem todas as características da versão online, mas com a vantagem de não exigir internet. Atualmente só pode ser reproduzida usando o navegador Firefox."
+      presentation_video:
+        name: "Download"
+        tip: "Realiza o download da gravação em um arquivo de vídeo (no formato WebM). Você pode usar esse arquivo de vídeo para assistir a gravação offline e/ou compartilhar esta gravação em outros sites."
+    recordings:
+      default:
+        description: "Reunião realizada em %{time} (UTC)"
+      errors:
+        check_for_server:
+          no_server: "Não há um servidor associado a esta gravação"
+        play:
+          no_format: "Não há URL de playback para esta gravação"
+      notice:
+        destroy:
+          success: "Sua gravação foi destruída com sucesso."
+          success_with_bbb_error: "A gravação foi destruída com sucesso mas não foi removida do servidor de webconferência (\"%{error}\")"
+        publish:
+          success: "Sua gravação foi publicada com sucesso."
+        unpublish:
+          success: "Sua gravação foi ocultada com sucesso."
+        update:
+          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>"
+      errors:
+        fetch_recordings:
+          no_server: "Não há nenhum servidor associado a esta sala."
+        join:
+          cannot_create: "Você não tem permissões para iniciar esta reunião."
+          failure: "Falha de autenticação."
+          not_running: "A reunião não está em andamento. Você deve aguardar por um moderador para ingressar."
+          wrong_params: "Parâmetros errados na sua requisição."
+        generate_dial_number:
+          not_unique: "Desculpe, mas não foi possível gerar um número de discagem único. Você pode tentar novamente ou então atribuir um número manualmente."
+        param_format: "você pode usar apenas letras, números e os símbolos \"-\" ou \"_\" (não no começo ou fim)"
+        server:
+          nil: "Sua sala deve ser associada a um servidor para executar esta operação."
+      notice:
+        create:
+          failure: "Sua sala não pôde ser criada."
+          success: "Sua sala foi criada com sucesso."
+        destroy:
+          success: "A reunião foi destruída com sucesso."
+          success_with_bbb_error: "A sala foi destruída com sucesso mas a reunião não foi finalizada no servidor de webconferência (\"%{error}\")"
+        end:
+          not_running: "A reunião não pôde ser finalizada pois não está em andamento."
+          success: "A reunião foi finalizada com sucesso."
+        fetch_recordings:
+          success: "A lista de gravações para esta sala foi atualizada com sucesso."
+        generate_dial_number:
+          success: "Um número de discagem único foi gerado e gravado."
+        update:
+          failure: "Sua sala não pode ser atualizada."
+          success: "Sua sala foi atualizada com sucesso."
+    servers:
+      errors:
+        param_format: "você pode usar apenas letras, números e os símbolos \"-\" ou \"_\" (não no começo ou fim)"
+        url_format: "deve utilizar o padrão http://<servidor>/bigbluebutton/api"
+      notice:
+        create:
+          success: "Seu servidor foi criado com sucesso."
+        fetch_recordings:
+          success: "A lista de gravações foi atualizada com sucesso."
+        publish_recordings:
+          success: "Suas gravações foram publicadas com sucesso."
+        unpublish_recordings:
+          success: "Suas gravações foram ocultadas com sucesso."
+        update:
+          success: "Seu servidor foi atualizado."
+    server_configs:
+      layouts:
+        defaultlayout: "Layout Padrão"
+        lecture: "Aula"
+        lectureassistant: "Assistente de aula"
+        presentfocus: "Webinar"
+        videochat: "Vídeo Chat"
+        webcamsfocus: "Reunião"

data/config/resque/resque.rake

@@ -0,0 +1,27 @@
+# Resque tasks
+require 'resque/tasks'
+require 'resque/scheduler/tasks'
+
+task "resque:setup" => :environment
+
+namespace :resque do
+  task :setup do
+    require 'resque'
+    require 'resque-scheduler'
+
+    # you probably already have this somewhere
+    Resque.redis = 'localhost:6379'
+
+    # If you want to be able to dynamically change the schedule,
+    # uncomment this line.  A dynamic schedule can be updated via the
+    # Resque::Scheduler.set_schedule (and remove_schedule) methods.
+    # When dynamic is set to true, the scheduler process looks for
+    # schedule changes and applies them on the fly.
+    # Note: This feature is only available in >=2.0.0.
+    # Resque::Scheduler.dynamic = true
+
+    # The schedule doesn't need to be stored in a YAML, it just needs to
+    # be a hash.  YAML is usually the easiest.
+    Resque.schedule = YAML.load_file('config/workers_schedule.yml')
+  end
+end

data/config/resque/workers_schedule.yml

@@ -0,0 +1,17 @@
+finish_meetings:
+  every:
+    - "5m"
+  class: BigbluebuttonFinishMeetings
+  description: "Checks for meetings that finished and mark as finished. Same as 'rake bigbluebutton_rails:meetings:finish'."
+
+update_recordings:
+  every:
+    - "30m"
+  class: BigbluebuttonUpdateRecordings
+  description: "Gets the recordings in the server to populate the db. Same as 'rake bigbluebutton_rails:recordings:update'."
+
+update_server_configs:
+  every:
+    - "1h"
+  class: BigbluebuttonUpdateServerConfigs
+  description: "Updates the server configs that are stored locally. Same as 'rake bigbluebutton_rails:server_configs:update'."

data/lib/bigbluebutton_rails.rb

@@ -3,19 +3,25 @@ require 'rails'
 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'
+    :recordings => 'bigbluebutton/recordings',
+    :playback_types => 'bigbluebutton/playback_types'
   }
 
   # Default scope for routes
@@ -51,6 +57,12 @@ module BigbluebuttonRails
       @@metadata_user_id,
       @@metadata_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'
+
   # Name of the attribute of a user that defines his name/username.
   # Has to be a symbol!
   mattr_accessor :user_attr_name
@@ -61,6 +73,22 @@ module BigbluebuttonRails
   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.
+  # Has to be a symbol!
+  mattr_accessor :invitation_url_method
+  @@invitation_url_method = :'invitation_url'
+
+  # 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)
@@ -73,7 +101,7 @@ module BigbluebuttonRails
 
   def self.set_controllers(options)
     unless options.nil?
-      @@controllers.merge!(options).slice!(:servers, :rooms, :recordings)
+      @@controllers.merge!(options).slice!(:servers, :rooms, :recordings, :playback_types)
     end
   end