bigbluebutton_rails 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88081dab1ee2f637c46993cd9b6f655cc4516afb
-  data.tar.gz: 791d30eb4d1873e75834754aed5c43b4b4a1c3f2
+  metadata.gz: 11d54d5048d19522934b6204fd71ff45a618bd6a
+  data.tar.gz: 257cda68bff0f0fb1217761fe913892558cbebb9
 SHA512:
-  metadata.gz: 69a370e8996753af92fdf67be6d6c6172fd02938f1a9b9a2c23960a0f2cb2d656ba70a67f3a87bd830c7a9b7246cf53d8c7f75b7c4cbcf2a735c79cf18a40899
-  data.tar.gz: 2adec10068e736881b444dbf584b5427ef83d7661a0fafed7e0b5037b0762e5faf4b5323a360c4b8d5e64357e5b6c8592b410b1a2e019af93c8e3c3658d4eefa
+  metadata.gz: bec8ac81fede7c116cce3c7946ef1141ec4761eb5408252a6013bf2d90e0535f0862782e42b8f9e5d81020809172178f96bfe01d1a6e29e3adb1867323b8b48f
+  data.tar.gz: 904805e273db9719f0996eabe2b0acd6f1d9c7209a2331b35bec60b5622f2253e075b5158d72a0404912bb57489edecc90326a279fa9468edd322c285eb47a7c

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [3.0.0] - 2019-11-18
+
+* Rename Room's and Server's #param to #slug.
+* New route and logic to remove meeting objects.
+* Remove `description` from meetings, move contents to `title`.
+* Add option for users to edit the title of meetings.
+* Send participant count in the ajax response when the meeting is running.
+* Use incremental numbers when generating dial numbers, not random ones.
+* Remove recordings when a meeting is removed.
+* Add state to recordings, following new developments in BigBlueButton's API.
+* Run the worker to fetch recordings after a meeting ends a little faster
+  than before. Now that we track the state of recordings they will appear
+  faster in a `getRecordings` call.
+* Set the default title of new meetings to the name of the room.
+* Add option to turn on debug on API calls.
+
+
 ## [2.3.0] - 2019-11-14
 
 * [#136] Improve matching between recordings and meetings and migrate old recordings to
@@ -319,8 +336,9 @@ https://github.com/mconf/bigbluebutton_rails/wiki/Migrate-to-1.3.0
 * Controller to access servers and rooms
 * rooms_controller interacts with a BBB server using bigbluebutton-api-ruby
 
-[2.2.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.2.0...v2.3.0
-[2.3.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.1.0...v2.2.0
+[3.0.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.3.0...v3.0.0
+[2.3.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/mconf/bigbluebutton_rails/compare/v1.4.0...v2.0.0
 [1.4.0]: https://github.com/mconf/bigbluebutton_rails/compare/v1.3.0...v1.4.0

data/Gemfile

@@ -12,7 +12,6 @@ group :development do
   gem "rdoc"
   gem "rails_best_practices"
 end
-gem "rspec-rails", '~> 2.99.0'
 
 group :test do
   if RUBY_VERSION >= "1.9"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (2.3.0)
+    bigbluebutton_rails (3.0.0)
       activerecord-import (~> 1.0)
       bigbluebutton-api-ruby (~> 1.6)
       browser (~> 0.8.0)
@@ -12,29 +12,29 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (4.1.4)
-      actionpack (= 4.1.4)
-      actionview (= 4.1.4)
-      mail (~> 2.5.4)
-    actionpack (4.1.4)
-      actionview (= 4.1.4)
-      activesupport (= 4.1.4)
+    actionmailer (4.1.14.2)
+      actionpack (= 4.1.14.2)
+      actionview (= 4.1.14.2)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.14.2)
+      actionview (= 4.1.14.2)
+      activesupport (= 4.1.14.2)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.4)
-      activesupport (= 4.1.4)
+    actionview (4.1.14.2)
+      activesupport (= 4.1.14.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activemodel (4.1.4)
-      activesupport (= 4.1.4)
+    activemodel (4.1.14.2)
+      activesupport (= 4.1.14.2)
       builder (~> 3.1)
-    activerecord (4.1.4)
-      activemodel (= 4.1.4)
-      activesupport (= 4.1.4)
+    activerecord (4.1.14.2)
+      activemodel (= 4.1.14.2)
+      activesupport (= 4.1.14.2)
       arel (~> 5.0.0)
     activerecord-import (1.0.2)
       activerecord (>= 3.2)
-    activesupport (4.1.4)
+    activesupport (4.1.14.2)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -151,15 +151,15 @@ GEM
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.1.4)
-      actionmailer (= 4.1.4)
-      actionpack (= 4.1.4)
-      actionview (= 4.1.4)
-      activemodel (= 4.1.4)
-      activerecord (= 4.1.4)
-      activesupport (= 4.1.4)
+    rails (4.1.14.2)
+      actionmailer (= 4.1.14.2)
+      actionpack (= 4.1.14.2)
+      actionview (= 4.1.14.2)
+      activemodel (= 4.1.14.2)
+      activerecord (= 4.1.14.2)
+      activesupport (= 4.1.14.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.1.4)
+      railties (= 4.1.14.2)
       sprockets-rails (~> 2.0)
     rails_best_practices (1.15.4)
       activesupport
@@ -171,9 +171,9 @@ GEM
       json
       require_all
       ruby-progressbar
-    railties (4.1.4)
-      actionpack (= 4.1.4)
-      activesupport (= 4.1.4)
+    railties (4.1.14.2)
+      actionpack (= 4.1.14.2)
+      activesupport (= 4.1.14.2)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)

data/Rakefile

@@ -3,8 +3,8 @@ require 'bundler/setup'
 require 'rdoc/task'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
-# require 'cucumber'
-# require 'cucumber/rake/task'
+require 'cucumber'
+require 'cucumber/rake/task'
 
 desc 'Default: run specs and features.'
 task :default => [:spec]
@@ -24,7 +24,6 @@ end
 eval("$specification = begin; #{ IO.read('bigbluebutton_rails.gemspec')}; end")
 Gem::PackageTask.new $specification do |pkg|
   pkg.need_tar = true
-  # pkg.need_zip = true
 end
 
 namespace :rails_app do
@@ -60,19 +59,19 @@ namespace :rails_app do
   end
 end
 
-# task :cucumber do
-#   # Disable all features that need the bot. It isn't working since BigBlueButton 0.81.
-#   tags = "~@need-bot"
+task :cucumber do
+  # Disable all features that need the bot. It isn't working since BigBlueButton 0.81.
+  tags = "~@need-bot"
 
-#   puts "* Dummy app features"
-#   cd File.join(File.dirname(__FILE__), "spec", "rails_app")
-#   sh "bundle exec cucumber features/ --tags #{tags}"
-#   cd File.dirname(__FILE__)
-# end
+  puts "* Dummy app features"
+  cd File.join(File.dirname(__FILE__), "spec", "rails_app")
+  sh "bundle exec cucumber features/ --tags #{tags}"
+  cd File.dirname(__FILE__)
+end
 
-# task :notes do
-#   puts `grep -r 'OPTIMIZE\\|FIXME\\|TODO' app/ public/ spec/`
-# end
+task :notes do
+  puts `grep -r 'OPTIMIZE\\|FIXME\\|TODO' app/ public/ spec/`
+end
 
 desc 'Setup the rails_app using the migration files created when upgrading the gem
       version, run all tests and destroys the generated files.'
@@ -87,6 +86,7 @@ namespace :spec do
     sh "bundle exec rails generate bigbluebutton_rails:install 2.0.0 --migration-only --force"
     sh "bundle exec rails generate bigbluebutton_rails:install 2.1.0 --migration-only --force"
     sh "bundle exec rails generate bigbluebutton_rails:install 2.2.0 --migration-only --force"
+    sh "bundle exec rails generate bigbluebutton_rails:install 2.3.0 --migration-only --force"
 
     sh "bundle exec rake db:drop RAILS_ENV=test"
     sh "bundle exec rake db:create RAILS_ENV=test"
@@ -98,6 +98,7 @@ namespace :spec do
     # Rake::Task["cucumber"].invoke
 
     cd "spec/rails_app/"
+    sh "bundle exec rails destroy bigbluebutton_rails:install 2.3.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 2.2.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 2.1.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 2.0.0 --migration-only"

data/app/controllers/bigbluebutton/api/rooms_controller.rb

@@ -49,7 +49,7 @@ class Bigbluebutton::Api::RoomsController < ApplicationController
   end
 
   def join
-    error_room_not_running unless check_is_running
+    return error_room_not_running unless check_is_running
 
     # map "meta[_-]" to "userdata-"
     options = params.select{ |k,v| k.match(/^meta[-_]/) }
@@ -63,7 +63,7 @@ class Bigbluebutton::Api::RoomsController < ApplicationController
   protected
 
   def find_room
-    @room ||= BigbluebuttonRoom.find_by(param: params[:id])
+    @room ||= BigbluebuttonRoom.find_by(slug: params[:id])
     error_room_not_found if @room.nil?
   end
 

data/app/controllers/bigbluebutton/meetings_controller.rb

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+require 'bigbluebutton_api'
+
+class Bigbluebutton::MeetingsController < ApplicationController
+  include BigbluebuttonRails::InternalControllerMethods
+
+  before_filter :find_meeting
+
+  respond_to :html
+
+  layout :determine_layout
+
+  def determine_layout
+    'application'
+  end
+
+  def destroy
+    if @meeting.ended?
+      if @meeting.destroy
+        respond_with do |format|
+          format.html {
+            flash[:success] = t('bigbluebutton_rails.meetings.delete.success')
+            redirect_to_using_params_or_back(request.referer)
+          }
+        end
+      else
+        flash[:error] = t('bigbluebutton_rails.meetings.notice.destroy.error_destroy')
+        redirect_to_using_params_or_back(request.referer)
+      end
+    else
+      flash[:error] = t('bigbluebutton_rails.meetings.notice.destroy.running.not_ended')
+      redirect_to_using_params_or_back(request.referer)
+    end
+  end
+
+  def find_meeting
+    @meeting ||= BigbluebuttonMeeting.find_by(id: params[:id])
+  end
+
+  def edit
+    respond_with(@meeting)
+  end
+
+  def meeting_params
+    unless params[:bigbluebutton_meeting].nil?
+      params[:bigbluebutton_meeting].permit(*meeting_allowed_params)
+    else
+      {}
+    end
+  end
+
+  def update
+    respond_with @meeting do |format|
+      if @meeting.update_attributes(meeting_params)
+        format.html {
+          message = t('bigbluebutton_rails.meetings.notice.update.success')
+          redirect_to_using_params @meeting, :notice => message
+        }
+      else
+        format.html { redirect_to_params_or_render :edit }
+      end
+    end
+  end
+
+  def meeting_allowed_params
+    [ :title ]
+  end
+
+end

data/app/controllers/bigbluebutton/recordings_controller.rb

@@ -46,19 +46,13 @@ class Bigbluebutton::RecordingsController < ApplicationController
   def destroy
     error = false
     begin
-      if @recording.server
-        server = @recording.server
-        server.send_delete_recordings(@recording.recordid)
-      end
+      @recording.destroy
       message = t('bigbluebutton_rails.recordings.notice.destroy.success')
     rescue BigBlueButton::BigBlueButtonException => e
       error = true
       message = t('bigbluebutton_rails.recordings.notice.destroy.success_with_bbb_error', :error => e.to_s[0..200])
     end
 
-    # TODO: what if it fails?
-    @recording.destroy
-
     respond_with do |format|
       format.html {
         if error
@@ -156,7 +150,7 @@ class Bigbluebutton::RecordingsController < ApplicationController
   end
 
   def recording_allowed_params
-    [ :description ]
+    []
   end
 
   protected

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -124,7 +124,8 @@ class Bigbluebutton::RoomsController < ApplicationController
       flash[:error] = e.to_s[0..200]
       render :json => { :running => "false", :error => "#{e.to_s[0..200]}" }
     else
-      render :json => { :running => "#{@room.is_running?}" }
+      info = @room.fetch_meeting_info
+      render :json => { :running => "#{@room.is_running?}", :participants_qty => info}
     end
   end
 
@@ -224,7 +225,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   protected
 
   def find_room
-    @room ||= BigbluebuttonRoom.find_by(param: params[:id])
+    @room ||= BigbluebuttonRoom.find_by(slug: params[:id])
   end
 
   def set_request_headers
@@ -234,7 +235,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def join_check_room
-    @room ||= BigbluebuttonRoom.find_by_param(params[:id]) unless params[:id].blank?
+    @room ||= BigbluebuttonRoom.find_by(slug: params[:id]) unless params[:id].blank?
     if @room.nil?
       message = t('bigbluebutton_rails.rooms.errors.join.wrong_params')
       redirect_to :back, :notice => message
@@ -363,7 +364,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   def room_allowed_params
     [ :name, :meetingid, :attendee_key, :moderator_key, :welcome_msg,
       :private, :logout_url, :dial_number, :voice_bridge, :max_participants, :owner_id,
-      :owner_type, :external, :param, :record_meeting, :duration, :default_layout, :presenter_share_only,
+      :owner_type, :external, :slug, :record_meeting, :duration, :default_layout, :presenter_share_only,
       :auto_start_video, :auto_start_audio, :background,
       :moderator_only_message, :auto_start_recording, :allow_start_stop_recording,
       :metadata_attributes => [ :id, :name, :content, :_destroy, :owner_id ] ]

data/app/controllers/bigbluebutton/servers_controller.rb

@@ -147,7 +147,7 @@ class Bigbluebutton::ServersController < ApplicationController
   protected
 
   def find_server
-    @server ||= BigbluebuttonServer.find_by_param(params[:id])
+    @server ||= BigbluebuttonServer.find_by(slug: params[:id])
   end
 
   def publish_unpublish(ids, publish)
@@ -182,7 +182,7 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def server_allowed_params
-    [ :name, :url, :secret, :param ]
+    [ :name, :url, :secret, :slug ]
   end
 
 end

data/app/models/bigbluebutton_meeting.rb

@@ -7,7 +7,7 @@ class BigbluebuttonMeeting < ActiveRecord::Base
   has_one :recording,
           :class_name => 'BigbluebuttonRecording',
           :foreign_key => 'meeting_id',
-          :dependent => :nullify
+          :dependent => :destroy
 
   has_many :attendees,
            :class_name => 'BigbluebuttonAttendee',

data/app/models/bigbluebutton_recording.rb

@@ -7,6 +7,8 @@ class BigbluebuttonRecording < ActiveRecord::Base
   belongs_to :room, class_name: 'BigbluebuttonRoom'
   belongs_to :meeting, class_name: 'BigbluebuttonMeeting'
 
+  before_destroy :delete_from_server!
+
   validates :server, :presence => true
 
   validates :recordid,
@@ -27,10 +29,21 @@ class BigbluebuttonRecording < ActiveRecord::Base
 
   serialize :recording_users, Array
 
+  STATES = {
+    processing: 'processing',
+    processed: 'processed',
+    published: 'published',
+    unpublished: 'unpublished'
+  }
+
   def to_param
     self.recordid
   end
 
+  def is_published?
+    self.state.eql?(BigbluebuttonRecording::STATES[:published]) || self.state.eql?(BigbluebuttonRecording::STATES[:unpublished])
+  end
+
   def get_token(user, ip)
     server = BigbluebuttonServer.default
     user.present? ? authName = user.username : authName = "anonymous"
@@ -218,7 +231,7 @@ class BigbluebuttonRecording < ActiveRecord::Base
   def self.update_recording(server, recording, data)
     recording.server = server
     recording.room = BigbluebuttonRails.configuration.match_room_recording.call(data)
-    recording.attributes = data.slice(:meetingid, :name, :published, :start_time, :end_time, :size)
+    recording.attributes = data.slice(:meetingid, :name, :published, :start_time, :end_time, :size, :state)
     recording.available = true
     recording.recording_users = adapt_recording_users(data[:recordingUsers])
     recording.save!
@@ -230,12 +243,11 @@ class BigbluebuttonRecording < ActiveRecord::Base
   # The format expected for 'data' follows the format returned by
   # BigBlueButtonApi#get_recordings but with the keys already converted to our format.
   def self.create_recording(server, data)
-    filtered = data.slice(:recordid, :meetingid, :name, :published, :start_time, :end_time, :size)
+    filtered = data.slice(:recordid, :meetingid, :name, :published, :start_time, :end_time, :size, :state)
     recording = BigbluebuttonRecording.create(filtered)
     recording.available = true
     recording.room = BigbluebuttonRails.configuration.match_room_recording.call(data)
     recording.server = server
-    recording.description = I18n.t('bigbluebutton_rails.recordings.default.description', :time => Time.at(recording.start_time).utc.to_formatted_s(:long))
     recording.meeting = BigbluebuttonRecording.find_matching_meeting(recording)
     recording.recording_users = adapt_recording_users(data[:recordingUsers])
     recording.save!

data/app/models/bigbluebutton_room.rb

@@ -47,12 +47,12 @@ class BigbluebuttonRoom < ActiveRecord::Base
     :presence => true,
     :numericality => { :only_integer => true, :greater_than_or_equal_to => 0 }
 
-  validates :param,
+  validates :slug,
             :presence => true,
             :uniqueness => true,
             :length => { :minimum => 1 },
             :format => { :with => /\A([a-zA-Z\d_]|[a-zA-Z\d_]+[a-zA-Z\d_-]*[a-zA-Z\d_]+)\z/,
-                         :message => I18n.t('bigbluebutton_rails.rooms.errors.param_format') }
+                         :message => I18n.t('bigbluebutton_rails.rooms.errors.slug_format') }
 
   # Passwords are 16 character strings
   # See http://groups.google.com/group/bigbluebutton-dev/browse_thread/thread/9be5aae1648bcab?pli=1
@@ -68,7 +68,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
 
   after_initialize :init
   after_create :create_room_options
-  before_validation :set_param
+  before_validation :set_slug
   before_validation :set_keys
 
   # the full logout_url used when logout_url is a relative path
@@ -94,12 +94,12 @@ class BigbluebuttonRoom < ActiveRecord::Base
       query_orders = []
 
       words.reject(&:blank?).each do |word|
-        str  = "name LIKE ? OR param LIKE ?"
+        str  = "name LIKE ? OR slug LIKE ?"
         query_strs << str
         query_params += ["%#{word}%", "%#{word}%"]
         query_orders += [
           "CASE WHEN name LIKE '%#{word}%' THEN 1 ELSE 0 END + \
-           CASE WHEN param LIKE '%#{word}%' THEN 1 ELSE 0 END"
+           CASE WHEN slug LIKE '%#{word}%' THEN 1 ELSE 0 END"
         ]
       end
       where(query_strs.join(' OR '), *query_params.flatten).order(query_orders.join(' + ') + " DESC")
@@ -278,7 +278,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
     opts.merge!({ userID: id }) unless id.blank? || options[:userID].present?
 
     # Get options passed by the application, if any
-    user_opts = BigbluebuttonRails.configuration.get_join_options.call(self, user)
+    user_opts = BigbluebuttonRails.configuration.get_join_options.call(self, user, { username: username, role: role })
     user_opts = {} if user_opts.blank?
     opts.merge!(user_opts)
 
@@ -324,7 +324,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
   end
 
   def to_param
-    self.param
+    self.slug
   end
 
   # The create logic.
@@ -416,6 +416,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
           server_secret: server.secret,
           meetingid: self.meetingid,
           name: self.name,
+          title: self.name,
           recorded: self.record_meeting,
           create_time: self.create_time,
           running: self.running,
@@ -476,7 +477,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
       # have to keep polling the server for them
       # 3 times so it tries at: 4, 9, 14 and 19
       # no point trying more since there is a global synchronization process
-      Resque.enqueue_in(4.minutes, ::BigbluebuttonRecordingsForRoomWorker, self.id, 3)
+      Resque.enqueue_in(1.minutes, ::BigbluebuttonRecordingsForRoomWorker, self.id, 10)
     end
   end
 
@@ -540,14 +541,23 @@ class BigbluebuttonRoom < ActiveRecord::Base
   # Will always generate a unique number. Tries several times if the number already
   # exists and returns `nil` in case it wasn't possible to generate a unique value.
   def generate_dial_number!(pattern=nil)
-    pattern ||= 'xxxx-xxxx'
-    20.times do
-      dn = BigbluebuttonRails::DialNumber.randomize(pattern)
-      if BigbluebuttonRoom.where(dial_number: dn).empty?
-        return self.update_attributes(dial_number: dn)
+    unless pattern.nil?
+      dn = self.class.generate_dial_number(pattern)
+      return self.update_attributes(dial_number: dn)
+    else
+      nil
+    end
+  end
+
+  def self.generate_dial_number(pattern=nil)
+    unless pattern.nil?
+      unless BigbluebuttonRoom.maximum(:dial_number).nil?
+        return BigbluebuttonRoom.maximum(:dial_number).next
+      else
+        return pattern.gsub('x', '0')
       end
+      nil
     end
-    nil
   end
 
   def fetch_recordings(filter={})
@@ -654,10 +664,10 @@ class BigbluebuttonRoom < ActiveRecord::Base
     end
   end
 
-  # if :param wasn't set, sets it as :name downcase and parameterized
-  def set_param
-    if self.param.blank?
-      self.param = self.name.parameterize.downcase unless self.name.nil?
+  # if :slug wasn't set, sets it as :name downcase and parameterized
+  def set_slug
+    if self.slug.blank?
+      self.slug = self.name.parameterize.downcase unless self.name.nil?
     end
   end