bigbluebutton_rails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9687e5b7cb9d7a46841c69500d2e9cc5362be38
-  data.tar.gz: 914f67a881910033c18550e2dc239c056ac12ca9
+  metadata.gz: a7aa314ce4ce2cd5647e00de7c1507a570cd2943
+  data.tar.gz: e79e43b6313f3f001d77c2e86fdaf1af2e196e26
 SHA512:
-  metadata.gz: 47dc457d18c9fed76fe02fb491eeaeaab33114af0e953a2b0da256296bd3eeb8a79c7640f995a1a1ac080d78dab14889305f6c29590e6bdbe1153a70ea0c9d59
-  data.tar.gz: 07b8fae4cc3b53ba89403dcd15f1c9486e5f5d13af88b87473c6d6a46199a9ae47400c51a4eb1a908f8059647190066778ed5c8b7637063f3f931b9ee2325bb8
+  metadata.gz: 6cc93453645452f995ce330a496cf00c3e60841709cf0345e62d0a365caf8c692f057f4226dc579ff493330d46cc4e2f8585b3b6a2867b88c2762c82cc34e29c
+  data.tar.gz: 923713967e60d3f4120590061fc266a4d296a605ecbdb94d4188a4856b83b83b8a1277407fda41f00396532bb51792264186ba8caef697dcfd45765b9acb2893

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+
+## [2.1.0] - 2016-07-22
+
+* [#98] Improved how meeting records are created and ended. Now they are more reliable and
+  will work even if the resque workers are not running.
+* [#132] Fixed recordings being set as unavailable when making requests to a subset of the
+  recordings (when using filters in `getRecordings`).
+* [#133] Added option for applications to pass custom metadata when a meeting is being
+  created without having to create these metadata in the database.
+* Renamed the attributes `BigbluebuttonServer#salt` to `BigbluebuttonServer#secret`.
+
+
+------------------------------------
+
+All tickets below use references to IDs in our old issue tracking system.
+To find them, search for their description or ID in the new issue tracker.
+
+------------------------------------
+
+
 ## [2.0.0] - 2016-04-07
 
 To learn how to migrate to 2.0.0 see:
@@ -246,6 +266,7 @@ 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.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
 [1.3.0]: https://github.com/mconf/bigbluebutton_rails/compare/v1.2.0...v1.3.0

data/Gemfile.lock

@@ -7,8 +7,8 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (2.0.0)
-      bigbluebutton-api-ruby (~> 1.4.0)
+    bigbluebutton_rails (2.1.0)
+      bigbluebutton-api-ruby (~> 1.6)
       browser (~> 0.8.0)
       rails (>= 4.0.0)
       resque (~> 1.25.1)
@@ -46,8 +46,8 @@ GEM
     addressable (2.3.6)
     arel (5.0.1.20140414130214)
     awesome_print (1.2.0)
-    bigbluebutton-api-ruby (1.4.0)
-      xml-simple (>= 1.1.1)
+    bigbluebutton-api-ruby (1.6.0)
+      xml-simple (~> 1.1)
     browser (0.8.0)
     builder (3.2.2)
     capybara (2.2.1)
@@ -139,7 +139,7 @@ GEM
     mono_logger (1.1.0)
     multi_json (1.10.1)
     multi_test (0.1.1)
-    mysql2 (0.3.16)
+    mysql2 (0.3.18)
     net-http-digest_auth (1.4)
     net-http-persistent (2.9.4)
     nokogiri (1.6.2.1)

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -367,11 +367,6 @@ class Bigbluebutton::RoomsController < ApplicationController
           url.gsub!(/^[^:]*:\/\//i, "bigbluebutton://")
         end
 
-        # enqueue an update in the meetings for later on
-        # note: this is the only update that is not in the model, but has to be here
-        # because the model doesn't know when a user joined a room
-        Resque.enqueue(::BigbluebuttonMeetingUpdater, @room.id, 15.seconds)
-
         redirect_to url
       else
         flash[:error] = t('bigbluebutton_rails.rooms.errors.join.not_running')

data/app/controllers/bigbluebutton/servers_controller.rb

@@ -197,7 +197,7 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def server_allowed_params
-    [ :name, :url, :salt, :param ]
+    [ :name, :url, :secret, :param ]
   end
 
 end

data/app/models/bigbluebutton_meeting.rb

@@ -13,8 +13,8 @@ class BigbluebuttonMeeting < ActiveRecord::Base
 
   validates :meetingid, :presence => true, :length => { :minimum => 1, :maximum => 100 }
 
-  validates :start_time, :presence => true
-  validates :start_time, :uniqueness => { :scope => :room_id }
+  validates :create_time, :presence => true
+  validates :create_time, :uniqueness => { :scope => :room_id }
 
   # Whether the meeting was created by the `user` or not.
   def created_by?(user)

data/app/models/bigbluebutton_recording.rb

@@ -41,7 +41,7 @@ class BigbluebuttonRecording < ActiveRecord::Base
   # were fetched.
   #
   # TODO: catch exceptions on creating/updating recordings
-  def self.sync(server, recordings)
+  def self.sync(server, recordings, full_sync=false)
     recordings.each do |rec|
       rec_obj = BigbluebuttonRecording.find_by_recordid(rec[:recordID])
       rec_data = adapt_recording_hash(rec)
@@ -58,17 +58,21 @@ class BigbluebuttonRecording < ActiveRecord::Base
       end
     end
 
-    # set as unavailable the recordings that are not in 'recordings'
-    recordIDs = recordings.map{ |rec| rec[:recordID] }
-    if recordIDs.length <= 0 # empty response
-      BigbluebuttonRecording.
-        where(available: true, server: server).
-        update_all(available: false)
-    else
-      BigbluebuttonRecording.
-        where(available: true, server: server).
-        where.not(recordid: recordIDs).
-        update_all(available: false)
+    # set as unavailable the recordings that are not in 'recordings', but
+    # only in a full synchronization process, which means that the recordings
+    # in `recordings` are *all* available in `server`, not a subset.
+    if full_sync
+      recordIDs = recordings.map{ |rec| rec[:recordID] }
+      if recordIDs.length <= 0 # empty response
+        BigbluebuttonRecording.
+          where(available: true, server: server).
+          update_all(available: false)
+      else
+        BigbluebuttonRecording.
+          where(available: true, server: server).
+          where.not(recordid: recordIDs).
+          update_all(available: false)
+      end
     end
   end
 

data/app/models/bigbluebutton_room.rb

@@ -107,23 +107,38 @@ class BigbluebuttonRoom < ActiveRecord::Base
   def fetch_meeting_info
     require_server :get_meeting_info
 
-    response = self.server.api.get_meeting_info(self.meetingid, self.moderator_api_password)
-
-    @participant_count = response[:participantCount]
-    @moderator_count = response[:moderatorCount]
-    @running = response[:running]
-    @has_been_forcibly_ended = response[:hasBeenForciblyEnded]
-    @start_time = response[:startTime]
-    @end_time = response[:endTime]
-    @attendees = []
-    response[:attendees].each do |att|
-      attendee = BigbluebuttonAttendee.new
-      attendee.from_hash(att)
-      @attendees << attendee
-    end
+    begin
+      response = self.server.api.get_meeting_info(self.meetingid, self.moderator_api_password)
+
+      @participant_count = response[:participantCount]
+      @moderator_count = response[:moderatorCount]
+      @running = response[:running]
+      @has_been_forcibly_ended = response[:hasBeenForciblyEnded]
+      @start_time = response[:startTime]
+      @end_time = response[:endTime]
+      @attendees = []
+      if response[:attendees].present?
+        response[:attendees].each do |att|
+          attendee = BigbluebuttonAttendee.new
+          attendee.from_hash(att)
+          @attendees << attendee
+        end
+      end
 
-    # a 'shortcut' to update meetings since we have all information we need
-    update_current_meeting(response[:metadata])
+      # a 'shortcut' to update meetings since we have all information we need
+      # if we got here, it means the meeting is still in the server, so it's not ended
+      self.update_attributes(create_time: response[:createTime]) unless self.new_record?
+      self.update_current_meeting_record(response[:metadata], true)
+
+    rescue BigBlueButton::BigBlueButtonException => e
+      # note: we could catch only the 'notFound' error, but there are complications, so
+      # it's better to end the meeting prematurely and open it again if needed than to
+      # not end it at all (e.g. in case the server stops responding)
+      Rails.logger.info "BigbluebuttonRoom: detected that a meeting ended in the room #{self.meetingid} after the error #{e.inspect}"
+
+      self.update_attributes(create_time: nil) unless self.new_record?
+      self.finish_meetings
+    end
 
     response
   end
@@ -143,8 +158,8 @@ class BigbluebuttonRoom < ActiveRecord::Base
     require_server :end
     response = self.server.api.end_meeting(self.meetingid, self.moderator_api_password)
 
-    # enqueue an update in the meetings for later on
-    Resque.enqueue(::BigbluebuttonMeetingUpdater, self.id, 15.seconds)
+    # enqueue an update in the meeting to end it faster
+    Resque.enqueue(::BigbluebuttonMeetingUpdater, self.id)
 
     response
   end
@@ -178,7 +193,17 @@ class BigbluebuttonRoom < ActiveRecord::Base
       self.moderator_api_password = response[:moderatorPW]
       self.create_time = response[:createTime]
       self.voice_bridge = response[:voiceBridge] if response.has_key?(:voiceBridge)
-      self.save unless self.new_record?
+
+      unless self.new_record?
+        self.save
+
+        # creates the meeting object since the create was successful
+        create_meeting_record(response[:metadata])
+
+        # enqueue an update in the meeting with a small delay we assume to be
+        # enough for the user to fully join the meeting
+        Resque.enqueue(::BigbluebuttonMeetingUpdater, self.id, 10.seconds)
+      end
     end
 
     response
@@ -290,23 +315,24 @@ class BigbluebuttonRoom < ActiveRecord::Base
 
   # Returns the current meeting running on this room, if any.
   def get_current_meeting
-    unless self.start_time.nil?
-      BigbluebuttonMeeting.find_by_room_id_and_start_time(self.id, self.start_time.utc)
+    unless self.create_time.nil?
+      BigbluebuttonMeeting.find_by(room_id: self.id, create_time: self.create_time)
     else
       nil
     end
   end
 
   # Updates the current meeting associated with this room
-  def update_current_meeting(metadata=nil)
-    unless self.start_time.nil?
+  def update_current_meeting_record(metadata=nil, force_not_ended=false)
+    unless self.create_time.nil?
       attrs = {
-        :server => self.server,
-        :meetingid => self.meetingid,
-        :name => self.name,
-        :recorded => self.record_meeting,
-        :running => self.running
+        :running => self.running,
+        :start_time => self.start_time.try(:utc)
       }
+      # note: it's important to update the 'ended' attr so the meeting is
+      # reopened in case it was mistakenly considered as ended
+      attrs[:ended] = false if force_not_ended
+
       unless metadata.nil?
         begin
           attrs[:creator_id] = metadata[BigbluebuttonRails.metadata_user_id].to_i
@@ -318,25 +344,60 @@ class BigbluebuttonRoom < ActiveRecord::Base
       end
 
       meeting = self.get_current_meeting
-      if !meeting.nil?
-        meeting.update_attributes(attrs)
+      meeting.update_attributes(attrs) if meeting.present?
+    end
+  end
 
-      # only create a new meeting if it is running
-      elsif self.running
-        attrs.merge!({ :room => self, :start_time => self.start_time.utc })
-        meeting = BigbluebuttonMeeting.create(attrs)
+  def create_meeting_record(metadata=nil)
+    unless get_current_meeting.present?
+      if self.create_time.present?
+
+        # to make sure there's no other meeting related to this room that
+        # has not yet been set as ended
+        self.finish_meetings
+
+        attrs = {
+          room: self,
+          server: self.server,
+          server_url: self.server.url,
+          server_secret: self.server.secret,
+          meetingid: self.meetingid,
+          name: self.name,
+          recorded: self.record_meeting,
+          create_time: self.create_time,
+          running: self.running,
+          ended: false,
+          start_time: self.start_time.try(:utc)
+        }
+        unless metadata.nil?
+          begin
+            attrs[:creator_id] = metadata[BigbluebuttonRails.metadata_user_id].to_i
+            attrs[:creator_name] = metadata[BigbluebuttonRails.metadata_user_name]
+          rescue
+            attrs[:creator_id] = nil
+            attrs[:creator_name] = nil
+          end
+        end
+        BigbluebuttonMeeting.create(attrs)
 
+        Rails.logger.error "Did not create a current meeting because there was no create_time on room #{self.meetingid}"
+      else
+        Rails.logger.error "Did not create a current meeting because there was no create_time on room #{self.meetingid}"
       end
-    else
-      # TODO: not enough information to find the meeting, do what?
     end
   end
 
   # Sets all meetings related to this room as not running
   def finish_meetings
-    BigbluebuttonMeeting.where(running: true)
+    BigbluebuttonMeeting.where(ended: false)
+      .where(room_id: self.id)
+      .update_all(running: false, ended: true)
+
+    # in case there are inconsistent meetings marked as running
+    # but that already ended
+    BigbluebuttonMeeting.where(running: true, ended: true)
       .where(room_id: self.id)
-      .update_all(running: false)
+      .update_all(running: false, ended: true)
   end
 
   # Gets a 'configToken' to use when joining the room.
@@ -503,9 +564,6 @@ class BigbluebuttonRoom < ActiveRecord::Base
     self.server.api.request_headers = @request_headers # we need the client's IP
     response = self.server.api.create_meeting(self.name, self.meetingid, opts)
 
-    # enqueue an update in the meetings to start now
-    Resque.enqueue(::BigbluebuttonMeetingUpdater, self.id)
-
     response
   end
 
@@ -540,9 +598,18 @@ class BigbluebuttonRoom < ActiveRecord::Base
   end
 
   def get_metadata_for_create
-    self.metadata.inject({}) { |result, meta|
+    metadata = self.metadata.inject({}) { |result, meta|
       result["meta_#{meta.name}"] = meta.content; result
     }
+
+    dynamic_metadata = self.try(BigbluebuttonRails.dynamic_metadata_method)
+    unless dynamic_metadata.blank?
+      metadata = self.dynamic_metadata.inject(metadata) { |result, meta|
+        result["meta_#{meta[0]}"] = meta[1]; result
+      }
+    end
+
+    metadata
   end
 
   private

data/app/models/bigbluebutton_server.rb

@@ -42,7 +42,7 @@ class BigbluebuttonServer < ActiveRecord::Base
             :format => { :with => /\A[a-zA-Z\d_]+[a-zA-Z\d_-]*[a-zA-Z\d_]+\z/,
                          :message => I18n.t('bigbluebutton_rails.servers.errors.param_format') }
 
-  validates :salt,
+  validates :secret,
             :presence => true,
             :length => { :minimum => 1, :maximum => 500 }
 
@@ -75,7 +75,7 @@ class BigbluebuttonServer < ActiveRecord::Base
 
     version = self.version
     version = set_api_version_from_server if version.blank?
-    @api = BigBlueButton::BigBlueButtonApi.new(self.url, self.salt, version.to_s, false)
+    @api = BigBlueButton::BigBlueButtonApi.new(self.url, self.secret, version.to_s, false)
   end
 
   # Fetches the meetings currently created in the server (running or not).
@@ -101,7 +101,7 @@ class BigbluebuttonServer < ActiveRecord::Base
                                :moderator_api_password => attr[:moderatorPW])
       end
       room.running = attr[:running]
-      room.update_current_meeting
+      room.update_current_meeting_record
 
       @meetings << room
     end
@@ -141,11 +141,12 @@ class BigbluebuttonServer < ActiveRecord::Base
   #          metadata values.
   #
   # Triggers API call: <tt>getRecordings</tt>.
-  def fetch_recordings(filter={})
+  def fetch_recordings(filter=nil, full_sync=false)
+    filter ||= {}
     logger.info "Fetching recordings for the server #{self.inspect} with filter: #{filter.inspect}"
     recordings = self.api.get_recordings(filter)
     if recordings and recordings[:recordings]
-      BigbluebuttonRecording.sync(self, recordings[:recordings])
+      BigbluebuttonRecording.sync(self, recordings[:recordings], full_sync)
     end
   end
 
@@ -156,7 +157,7 @@ class BigbluebuttonServer < ActiveRecord::Base
   def set_api_version_from_server
     begin
       # creating the object with version=nil makes the gem fetch the version from the server
-      api = BigBlueButton::BigBlueButtonApi.new(self.url, self.salt, nil, false)
+      api = BigBlueButton::BigBlueButtonApi.new(self.url, self.secret, nil, false)
       self.version = api.version
     rescue BigBlueButton::BigBlueButtonException
       # we just ignore errors in case the server is not responding
@@ -187,16 +188,16 @@ class BigbluebuttonServer < ActiveRecord::Base
 
   # Checks if we have to update the server version or not and do it if needed.
   # If the user only changes the version, we assume he's trying to force an API version.
-  # If the user changes url/salt and the version, we also assume that he wants
+  # If the user changes url/secret and the version, we also assume that he wants
   # to force the API version
   def check_for_version_update
-    if [:url, :salt, :version].any? { |k| self.changes.key?(k) }
+    if [:url, :secret, :version].any? { |k| self.changes.key?(k) }
       self.set_api_version_from_server
     end
   end
 
   def check_for_config_update
-    if [:url, :salt, :version].any?{ |k| self.changes.key?(k) }
+    if [:url, :secret, :version].any?{ |k| self.changes.key?(k) }
       self.update_config
     end
   end

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

@@ -23,8 +23,8 @@
     <%= f.text_field :url %>
   </div>
   <div class="field">
-    <%= f.label :salt %><br />
-    <%= f.text_field :salt %>
+    <%= f.label :secret %><br />
+    <%= f.text_field :secret %>
   </div>
   <div class="field">
     <%= f.label :version %><br />