bigbluebutton_rails 2.2.0 → 2.3.0

data/app/views/bigbluebutton/api/rooms/join.rabl

@@ -0,0 +1,6 @@
+object false
+
+child(@room => :data) {
+  node(:type) { 'join-url' }
+  node(:id) { @url }
+}

data/app/views/bigbluebutton/api/rooms/running.rabl

@@ -0,0 +1,10 @@
+object false
+
+child(@room => :data) {
+  node(:type) { |obj| api_type_of(obj) }
+  node(:id) { |obj| obj.to_param }
+
+  node :attributes do |room|
+    { :running => room.is_running? }
+  end
+}

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

@@ -0,0 +1 @@
+<iframe src="<%= @playback_url %>" style="width:100%;height:100%;border:0;margin:0;padding:0;"></iframe>

data/app/views/bigbluebutton/servers/_activity_list.html.erb

@@ -20,13 +20,13 @@
         <span class="not_running">Not running</span>
       <% end %>
     </div>
-    <% unless room.start_time.nil? %>
-      Started at: <%= room.start_time.strftime("%F, %R UTC%z") %><br/>
+    <% unless room.create_time.nil? %>
+      Started at: <%= Time.at(room.create_time).strftime("%F, %R UTC%z") %><br/>
     <% end %>
     <% unless room.end_time.nil? %>
       Ended at: <%= room.end_time.strftime("%F, %R UTC%z") %> (forcibly ended: <%= room.has_been_forcibly_ended %>)
     <% end %>
-    <% unless room.attendees.count == 0 %>
+    <% unless room.current_attendees.count == 0 %>
       Participants (<%= room.participant_count %> total, <%= room.moderator_count %> moderators):
       <div class="bbbrails_meeting_attendees">
         <div class="header">
@@ -34,11 +34,11 @@
           <div class="field">ID</div>
           <div class="field">Name</div>
         </div>
-        <% room.attendees.each do |attendee| %>
+        <% room.current_attendees.each do |attendee| %>
           <div class="row">
             <div class="field"><%= attendee.role %></div>
             <div class="field"><%= attendee.user_id %></div>
-            <div class="field"><%= attendee.full_name %></div>
+            <div class="field"><%= attendee.user_name %></div>
           </div>
         <% end %>
       </div>

data/app/workers/{bigbluebutton_finish_meetings.rb → bigbluebutton_finish_meetings_worker.rb}

@@ -1,11 +1,11 @@
 # A resque worker to check for meetings that already finished and mark
 # them as finished.
 # Same as "rake bigbluebutton_rails:meetings:finish".
-class BigbluebuttonFinishMeetings
+class BigbluebuttonFinishMeetingsWorker
   @queue = :bigbluebutton_rails
 
   def self.perform
-    Rails.logger.info "BigbluebuttonFinishMeetings worker running"
+    Rails.logger.info "BigbluebuttonFinishMeetingsWorker worker running"
     BigbluebuttonRails::BackgroundTasks.finish_meetings
   end
 end

data/app/workers/{bigbluebutton_meeting_updater.rb → bigbluebutton_meeting_updater_worker.rb}

@@ -1,16 +1,16 @@
 # A resque worker to get information about a meeting with `getMeetingInfo` and update
 # the associated `BigbluebuttonMeeting` object. This should be called to speed up the
 # update of a meeting object (usually on creates and ends).
-class BigbluebuttonMeetingUpdater
+class BigbluebuttonMeetingUpdaterWorker
   @queue = :bigbluebutton_rails
 
   def self.perform(room_id, wait=nil)
-    Rails.logger.info "BigbluebuttonMeetingUpdater worker: waiting #{wait} for room #{room_id}"
+    Rails.logger.info "BigbluebuttonMeetingUpdaterWorker worker: waiting #{wait} for room #{room_id}"
     sleep(wait) unless wait.nil?
 
     room = BigbluebuttonRoom.find(room_id)
     if room.nil?
-      Rails.logger.info "BigbluebuttonMeetingUpdater worker: room #{room_id} not found!"
+      Rails.logger.info "BigbluebuttonMeetingUpdaterWorker worker: room #{room_id} not found!"
     else
       # `fetch_meeting_info` will automatically update the meeting by
       # calling `room.update_current_meeting_record`

data/app/workers/bigbluebutton_recordings_for_room_worker.rb

@@ -0,0 +1,27 @@
+# TODO: This worker exists only because we don't have yet a way to figure out
+# precisely when a recording is done processing. Ideally the web conference
+# server would send us a request notifying that the recording is ready.
+# For now, this worker is used to get all recordings of a room after a meeting
+# is ended in the room. It keeps trying a few times even if a recording was
+# already found, which is important in case there are multiple playback formats
+# that are processed individually (e.g. the first time the recording is found it
+# might have only one of the formats done).
+
+# A resque worker to get the recordings of a room.
+class BigbluebuttonRecordingsForRoomWorker
+  @queue = :bigbluebutton_rails
+
+  def self.perform(room_id, tries_left=0)
+    Rails.logger.info "BigbluebuttonRecordingsForRoomWorker worker running"
+
+    room = BigbluebuttonRoom.find(room_id)
+    if room.present?
+      Rails.logger.info "BigbluebuttonRecordingsForRoomWorker getting recordings for #{room.inspect}"
+      room.fetch_recordings
+
+      if tries_left > 0
+        Resque.enqueue_in(5.minutes, ::BigbluebuttonRecordingsForRoomWorker, room_id, tries_left - 1)
+      end
+    end
+  end
+end

data/app/workers/{bigbluebutton_update_recordings.rb → bigbluebutton_update_recordings_worker.rb}

@@ -1,11 +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
+class BigbluebuttonUpdateRecordingsWorker
   @queue = :bigbluebutton_rails
 
   def self.perform(server_id=nil)
-    Rails.logger.info "BigbluebuttonUpdateRecordings worker running"
+    Rails.logger.info "BigbluebuttonUpdateRecordingsWorker worker running"
     BigbluebuttonRails::BackgroundTasks.update_recordings(server_id)
   end
 end

data/app/workers/{bigbluebutton_update_server_configs.rb → bigbluebutton_update_server_configs_worker.rb}

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

data/bigbluebutton_rails.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_dependency("resque", "~> 1.25.1")
   s.add_dependency("resque-scheduler", "~> 3.0")
   s.add_dependency("browser", "~> 0.8.0")
+  s.add_dependency("activerecord-import", "~> 1.0")
 end

data/config/locales/en.yml

@@ -68,6 +68,26 @@ en:
       bigbluebutton_server: "Web Conference Server"
       bigbluebutton_server_config: "Web Conference Server Configurations"
   bigbluebutton_rails:
+    api:
+      errors:
+        forbidden:
+          msg: "You are not authorized to make this API call"
+          title: "Forbidden"
+        invalid_pagination:
+          msg: "One or more pagination parameters are wrong"
+          title: "Invalid pagination parameters"
+        invalid_key:
+          msg: "The key informed is not valid for this room"
+          title: "Invalid key"
+        missing_params:
+          msg: "You did not inform one or more required parameters"
+          title: "Missing parameters"
+        room_not_found:
+          msg: "Could not find the target room"
+          title: "Resource not found"
+        room_not_running:
+          msg: "There's no meeting currently running in this room"
+          title: "Meeting not running"
     bigbluebutton: BigBlueButton
     metadata:
       errors:
@@ -89,6 +109,7 @@ en:
       default:
         description: "Meeting held on %{time} (UTC)"
       errors:
+        destroyed: "This recording no longer exist."
         check_for_server:
           no_server: "There's no server associated with this recording."
         play:

data/config/locales/pt-br.yml

@@ -89,6 +89,7 @@ pt-br:
       default:
         description: "Reunião realizada em %{time} (UTC)"
       errors:
+        destroyed: "Esta gravação não existe mais."
         check_for_server:
           no_server: "Não há um servidor associado a esta gravação"
         play:

data/config/resque/resque.rake

@@ -10,7 +10,13 @@ namespace :resque do
     require 'resque-scheduler'
 
     # you probably already have this somewhere
-    Resque.redis = 'localhost:6379'
+    attrs = {
+      host: ENV['REDIS_HOST'] || 'localhost'
+      port: ENV['REDIS_PORT'] || 6379
+      db: ENV['REDIS_DB'] || 0
+      password: ENV['REDIS_PASSWORD'] || nil
+    }
+    Resque.redis = Redis.new(attrs)
 
     # If you want to be able to dynamically change the schedule,
     # uncomment this line.  A dynamic schedule can be updated via the

data/config/resque/workers_schedule.yml

@@ -1,17 +1,17 @@
 finish_meetings:
   every:
     - "5m"
-  class: BigbluebuttonFinishMeetings
+  class: BigbluebuttonFinishMeetingsWorker
   description: "Checks for meetings that finished and mark as finished. Same as 'rake bigbluebutton_rails:meetings:finish'."
 
 update_recordings:
   every:
     - "30m"
-  class: BigbluebuttonUpdateRecordings
+  class: BigbluebuttonUpdateRecordingsWorker
   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
+  class: BigbluebuttonUpdateServerConfigsWorker
   description: "Updates the server configs that are stored locally. Same as 'rake bigbluebutton_rails:server_configs:update'."

data/docker-compose.yml

@@ -0,0 +1,68 @@
+version: '2'
+services:
+
+  # development
+  dev:
+    build: .
+    tty: true
+    ports:
+      - "3000:3000"
+    depends_on:
+      - dev_db
+      - dev_redis
+    environment:
+      - REDIS_HOST=dev_redis
+      - REDIS_PASSWORD=BCsy8zMwZay66cim
+      - DATABASE_HOST=dev_db
+      - RAILS_ENV=development
+    volumes:
+      - $PWD:/usr/src/app
+    command: bash -c "cd spec/rails_app && rake db:create db:migrate && rails s -p3000"
+  dev_db:
+    image: mysql:5.6
+    expose:
+      - "3306"
+    volumes:
+      - ~/.docker-volumes/bigbluebutton_rails/dev/mysql/:/var/lib/mysql
+    environment:
+      - MYSQL_ROOT_PASSWORD=bbbrails
+      - MYSQL_DATABASE=bigbluebutton_rails_dev
+      - MYSQL_USER=bbbrails
+      - MYSQL_PASSWORD=bbbrails
+  dev_redis:
+    image: redis:3.2
+    expose:
+      - "6379"
+    command: redis-server --requirepass "BCsy8zMwZay66cim"
+
+  # test
+  test:
+    build: .
+    tty: true
+    depends_on:
+      - test_db
+      - test_redis
+    environment:
+      - REDIS_HOST=test_redis
+      - REDIS_PASSWORD=db62b65a8d19a213
+      - DATABASE_HOST=test_db
+      - RAILS_ENV=test
+    volumes:
+      - $PWD:/usr/src/app
+    command: rake rails_app:install rails_app:db spec
+  test_db:
+    image: mysql:5.6
+    expose:
+      - "3306"
+    volumes:
+      - ~/.docker-volumes/bigbluebutton_rails/test/mysql/:/var/lib/mysql
+    environment:
+      - MYSQL_ROOT_PASSWORD=bbbrails
+      - MYSQL_DATABASE=bigbluebutton_rails_test
+      - MYSQL_USER=bbbrails
+      - MYSQL_PASSWORD=bbbrails
+  test_redis:
+    image: redis:3.2
+    expose:
+      - "6379"
+    command: redis-server --requirepass "db62b65a8d19a213"

data/lib/bigbluebutton_rails.rb

@@ -3,13 +3,12 @@ require 'browser'
 require 'resque'
 require 'resque-scheduler'
 
-require 'classes/bigbluebutton_attendee'
-
 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/api_controller_methods'
 require 'bigbluebutton_rails/background_tasks'
 require 'bigbluebutton_rails/rails/routes'
 require 'bigbluebutton_rails/exceptions'

data/lib/bigbluebutton_rails/api_controller_methods.rb

@@ -0,0 +1,138 @@
+module BigbluebuttonRails
+  module APIControllerMethods
+
+    def self.included(base)
+      base.class_eval do
+
+        def map_sort(param, default, allowed=[])
+          return default if param.blank? || param.empty?
+
+          param.split(',').inject('') do |memo, obj|
+            if obj[0] == '-'
+              attr = obj.gsub(/^-/, '')
+              order = 'DESC'
+            else
+              attr = obj
+              order = 'ASC'
+            end
+            if allowed.blank? || allowed.include?(attr)
+              memo = "#{memo}," unless memo.blank?
+              memo = "#{memo} #{attr} #{order}"
+            else
+              memo
+            end
+          end
+        end
+
+        def validate_pagination
+          param = params[:page]
+          if param
+            if param[:size]
+              size = Integer(param[:size]) rescue nil
+              return error_invalid_pagination if size.nil? || size < 1
+            end
+            if param[:number]
+              page = Integer(param[:number]) rescue nil
+              return error_invalid_pagination if page.nil? || page < 1
+            end
+          end
+        end
+
+        def map_pagination(param, default)
+          limit = default
+          if param && param[:size]
+            limit = Integer(param[:size]) rescue nil
+          end
+          limit = default if !limit || limit < 1
+
+          offset = 0
+          page = 1
+          if param && param[:number]
+            page = Integer(param[:number]) rescue nil
+            page ||= 1
+            offset = (page-1)*limit
+            offset = 0 if offset < 0
+          end
+
+          [limit, offset, page]
+        end
+
+        def map_pagination_links(current)
+          original = request.original_url
+
+          uri = URI.parse(original)
+          query = Rack::Utils.parse_query(uri.query)
+          uri.query = Rack::Utils.build_query(query) # just to encode the params
+
+          links = { self: uri.to_s }
+
+          if current - 1 > 0
+            query["page[number]"] = current - 1
+            uri.query = Rack::Utils.build_query(query)
+            links.merge!({ prev: uri.to_s })
+          end
+
+          query["page[number]"] = current + 1
+          uri.query = Rack::Utils.build_query(query)
+          links.merge!({ next: uri.to_s })
+
+          query["page[number]"] = 1
+          uri.query = Rack::Utils.build_query(query)
+          links.merge!({ first: uri.to_s })
+
+          links
+        end
+
+        def map_search(param)
+          if param && param[:terms]
+            param[:terms].split(',').map(&:strip)
+          end
+        end
+
+        def error_room_not_found
+          msg = t('bigbluebutton_rails.api.errors.room_not_found.msg')
+          title = t('bigbluebutton_rails.api.errors.room_not_found.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 404, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+        def error_room_not_running
+          msg = t('bigbluebutton_rails.api.errors.room_not_running.msg')
+          title = t('bigbluebutton_rails.api.errors.room_not_running.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 400, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+        def error_missing_params
+          msg = t('bigbluebutton_rails.api.errors.missing_params.msg')
+          title = t('bigbluebutton_rails.api.errors.missing_params.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 400, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+        def error_forbidden
+          msg = t('bigbluebutton_rails.api.errors.forbidden.msg')
+          title = t('bigbluebutton_rails.api.errors.forbidden.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 403, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+        def error_invalid_key
+          msg = t('bigbluebutton_rails.api.errors.invalid_key.msg')
+          title = t('bigbluebutton_rails.api.errors.invalid_key.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 403, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+        def error_invalid_pagination
+          msg = t('bigbluebutton_rails.api.errors.invalid_pagination.msg')
+          title = t('bigbluebutton_rails.api.errors.invalid_pagination.title')
+          @errors = [BigbluebuttonRails::APIError.new(msg, 400, title)]
+          render 'bigbluebutton/api/error'
+        end
+
+      end
+    end
+
+  end
+end