bigbluebutton_rails 2.0.0 → 2.1.0

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

@@ -12,7 +12,7 @@
       <div><label><%= BigbluebuttonServer.human_attribute_name(:id) %></label> <%= server.id %></div>
       <div><label><%= BigbluebuttonServer.human_attribute_name(:name) %></label> <%= server.name %></div>
       <div><label><%= BigbluebuttonServer.human_attribute_name(:url) %></label> <%= server.url %></div>
-      <div><label><%= BigbluebuttonServer.human_attribute_name(:salt) %></label> <%= server.salt %></div>
+      <div><label><%= BigbluebuttonServer.human_attribute_name(:secret) %></label> <%= server.secret %></div>
       <div><label><%= BigbluebuttonServer.human_attribute_name(:version) %></label> <%= server.version %></div>
       <div><label><%= BigbluebuttonServer.human_attribute_name(:param) %></label> <%= server.param %></div>
       <div><label>Access</label>

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

@@ -45,8 +45,8 @@
 </p>
 
 <p>
-  <b><%= BigbluebuttonServer.human_attribute_name(:salt) %>:</b>
-  <%= @server.salt %>
+  <b><%= BigbluebuttonServer.human_attribute_name(:secret) %>:</b>
+  <%= @server.secret %>
 </p>
 
 <p>

data/app/workers/bigbluebutton_meeting_updater.rb

@@ -1,6 +1,6 @@
 # A resque worker to get information about a meeting with `getMeetingInfo` and update
-# the associated `BigbluebuttonMeeting` object. This should be triggered whenever a,
-# meeting is created, ended, or when a user joins.
+# the associated `BigbluebuttonMeeting` object. This should be called to speed up the
+# update of a meeting object (usually on creates and ends).
 class BigbluebuttonMeetingUpdater
   @queue = :bigbluebutton_rails
 
@@ -12,20 +12,13 @@ class BigbluebuttonMeetingUpdater
     if room.nil?
       Rails.logger.info "BigbluebuttonMeetingUpdater worker: room #{room_id} not found!"
     else
-      begin
-        room.fetch_meeting_info
-      rescue BigBlueButton::BigBlueButtonException => e
-        Rails.logger.info "BigbluebuttonMeetingUpdater worker: getMeetingInfo generated an error (usually means that the meeting doesn't exist): #{e}"
-
-        # an error usually means that no meeting was found, so it is not running anymore
-        room.finish_meetings
-      else
-        Rails.logger.info "BigbluebuttonMeetingUpdater worker: updating the meetings for the room #{room_id}"
-        room.update_current_meeting
-      end
+      # `fetch_meeting_info` will automatically update the meeting by
+      # calling `room.update_current_meeting_record`
+      room.fetch_meeting_info
     end
     Rails.logger.flush
 
-    # TODO: if the meeting is not found (or is not running), try again a few more times?
+    # note: don't need to keep trying because there's a worker that runs periodically
+    # for each meeting that still hasn't ended
   end
 end

data/bigbluebutton_rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency("rails", ">= 4.0.0")
-  s.add_dependency("bigbluebutton-api-ruby", "~> 1.4.0")
+  s.add_dependency("bigbluebutton-api-ruby", "~> 1.6")
   s.add_dependency("resque", "~> 1.25.1")
   s.add_dependency("resque-scheduler", "~> 3.0")
   s.add_dependency("browser", "~> 0.8.0")

data/config/locales/en.yml

@@ -56,7 +56,7 @@ en:
       bigbluebutton_server:
         name: Name
         param: "String ID"
-        salt: "Security Salt"
+        secret: "Shared Secret"
         url: URL
         version: Version
       bigbluebutton_server_config:

data/config/locales/pt-br.yml

@@ -56,7 +56,7 @@ pt-br:
       bigbluebutton_server:
         name: Nome
         param: Identificador
-        salt: "Chave de segurança"
+        secret: "Chave de segurança"
         url: URL
         version: Versão
       bigbluebutton_server_config:

data/lib/bigbluebutton_rails.rb

@@ -47,6 +47,12 @@ module BigbluebuttonRails
   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.
@@ -55,30 +61,31 @@ module BigbluebuttonRails
   @@metadata_invalid_keys =
     [ @@metadata_room_id,
       @@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'
+      @@metadata_user_name,
+      @@metadata_invitation_url ]
 
   # Name of the attribute of a user that defines his name/username.
-  # Has to be a symbol!
   mattr_accessor :user_attr_name
   @@user_attr_name = :'name'
 
   # Name of the attribute of a user that defines his ID.
-  # Has to be a symbol!
   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'
 
+  # 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

data/lib/bigbluebutton_rails/background_tasks.rb

@@ -3,12 +3,16 @@ module BigbluebuttonRails
   # Helper methods to execute tasks that run in resque and rake.
   class BackgroundTasks
 
+    # For each meeting that hasn't ended yet, call `getMeetingInfo` and update
+    # the meeting attributes or end it.
     def self.finish_meetings
-      BigbluebuttonMeeting.where(running: true).find_each do |meeting|
+      BigbluebuttonMeeting.where(ended: false).find_each do |meeting|
         Rails.logger.info "BackgroundTasks: Checking if the meeting has ended: #{meeting.inspect}"
-        if meeting.room and !meeting.room.fetch_is_running?
-          Rails.logger.info "BackgroundTasks: Setting meeting as ended: #{meeting.inspect}"
-          meeting.update_attributes(running: false)
+        room = meeting.room
+        if room.present? #and !meeting.room.fetch_is_running?
+          # `fetch_meeting_info` will automatically update the meeting by
+          # calling `room.update_current_meeting_record`
+          room.fetch_meeting_info
         end
       end
     end
@@ -16,7 +20,7 @@ module BigbluebuttonRails
     def self.update_recordings
       BigbluebuttonServer.find_each do |server|
         begin
-          server.fetch_recordings
+          server.fetch_recordings(nil, true)
           Rails.logger.info "BackgroundTasks: List of recordings from #{server.url} updated successfully"
         rescue Exception => e
           Rails.logger.info "BackgroundTasks: Failure fetching recordings from #{server.inspect}"

data/lib/bigbluebutton_rails/version.rb

@@ -1,3 +1,3 @@
 module BigbluebuttonRails
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/generators/bigbluebutton_rails/templates/migration.rb

@@ -4,7 +4,7 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
     create_table :bigbluebutton_servers do |t|
       t.string :name
       t.string :url
-      t.string :salt
+      t.string :secret
       t.string :version
       t.string :param
       t.timestamps
@@ -93,17 +93,21 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
 
     create_table :bigbluebutton_meetings do |t|
       t.integer :server_id
+      t.string :server_url
+      t.string :server_secret
       t.integer :room_id
       t.string :meetingid
       t.string :name
       t.datetime :start_time
+      t.decimal :create_time, precision: 14, scale: 0
       t.boolean :running, :default => false
       t.boolean :recorded, :default => false
       t.integer :creator_id
       t.string :creator_name
+      t.boolean :ended, :default => false
       t.timestamps
     end
-    add_index :bigbluebutton_meetings, [:meetingid, :start_time], :unique => true
+    add_index :bigbluebutton_meetings, [:meetingid, :create_time], :unique => true
 
     create_table :bigbluebutton_server_configs do |t|
       t.integer :server_id

data/lib/generators/bigbluebutton_rails/templates/migration_2_1_0.rb

@@ -0,0 +1,21 @@
+class BigbluebuttonRailsTo210 < ActiveRecord::Migration
+  def self.up
+    add_column :bigbluebutton_meetings, :server_url, :string
+    add_column :bigbluebutton_meetings, :server_secret, :string
+    add_column :bigbluebutton_meetings, :create_time, :decimal, precision: 14, scale: 0
+    add_column :bigbluebutton_meetings, :ended, :boolean, :default => false
+    remove_index :bigbluebutton_meetings, [:meetingid, :start_time]
+    add_index :bigbluebutton_meetings, [:meetingid, :create_time], :unique => true
+    rename_column :bigbluebutton_servers, :salt, :secret
+  end
+
+  def self.down
+    remove_column :bigbluebutton_meetings, :server_url
+    remove_column :bigbluebutton_meetings, :server_secret
+    remove_column :bigbluebutton_meetings, :create_time
+    remove_column :bigbluebutton_meetings, :ended
+    remove_index :bigbluebutton_meetings, [:meetingid, :create_time]
+    add_index :bigbluebutton_meetings, [:meetingid, :start_time], :unique => true
+    rename_column :bigbluebutton_servers, :secret, :salt
+  end
+end

data/spec/controllers/bigbluebutton/rooms_controller_spec.rb

@@ -8,7 +8,7 @@ describe Bigbluebutton::RoomsController do
   render_views
   let(:server) { FactoryGirl.create(:bigbluebutton_server) }
   let(:room) { FactoryGirl.create(:bigbluebutton_room, :server => server) }
-  let(:params_to_ignore) { ['moderator_api_password', 'attendee_api_password'] }
+  let(:params_to_ignore) { ['moderator_api_password', 'attendee_api_password', 'create_time'] }
 
   describe "#index" do
     context "basic" do
@@ -1020,18 +1020,6 @@ describe Bigbluebutton::RoomsController do
         it { should respond_with(:redirect) }
         it { should redirect_to("http://test.com/join/url") }
       end
-
-      context "schedules a BigbluebuttonMeetingUpdater" do
-        before(:each) {
-          expect {
-            get :join, :id => room.to_param
-          }.to change{ Resque.info[:pending] }.by(1)
-        }
-        subject { Resque.peek(:bigbluebutton_rails) }
-        it("should have a job schedule") { subject.should_not be_nil }
-        it("the job should be the right one") { subject['class'].should eq('BigbluebuttonMeetingUpdater') }
-        it("the job should have the correct parameters") { subject['args'].should eq([room.id, 15]) }
-      end
     end
 
     context "gets a new config token before joining" do

data/spec/controllers/bigbluebutton/servers_controller_spec.rb

@@ -88,7 +88,7 @@ describe Bigbluebutton::ServersController do
       let(:attrs) { FactoryGirl.attributes_for(:bigbluebutton_server) }
       let(:params) { { :bigbluebutton_server => attrs } }
       let(:allowed_params) {
-        [ :name, :url, :salt, :param ]
+        [ :name, :url, :secret, :param ]
       }
 
       it {
@@ -179,7 +179,7 @@ describe Bigbluebutton::ServersController do
       let(:attrs) { FactoryGirl.attributes_for(:bigbluebutton_server) }
       let(:params) { { :bigbluebutton_server => attrs } }
       let(:allowed_params) {
-        [ :name, :url, :salt, :param ]
+        [ :name, :url, :secret, :param ]
       }
 
       it {

data/spec/factories/bigbluebutton_meeting.rb

@@ -6,7 +6,9 @@ FactoryGirl.define do
     m.sequence(:name) { |n| "Name#{n}" }
     m.recorded false
     m.running false
+    m.ended false
     m.start_time { Time.at(Time.now.to_i + rand(999999)) }
+    m.create_time { Time.now.to_i + rand(999999) }
     # m.creator_id
     # m.creator_name
   end

data/spec/factories/bigbluebutton_metadata.rb

@@ -1,5 +1,5 @@
 FactoryGirl.define do
-  factory  :bigbluebutton_metadata do |r|
+  factory :bigbluebutton_metadata do |r|
     r.association :owner, :factory => :bigbluebutton_recording
     r.sequence(:name) { |n| "#{Forgery(:name).first_name.downcase}-#{n}" }
     r.content { Forgery(:name).full_name }

data/spec/factories/bigbluebutton_room.rb

@@ -19,6 +19,7 @@ FactoryGirl.define do
     r.dial_number { SecureRandom.random_number(9999999).to_s }
     r.sequence(:logout_url) { |n| "http://bigbluebutton#{n}.test.com/logout" }
     r.sequence(:max_participants) { |n| n }
+    r.create_time { Time.now.to_i + rand(999999) }
 
     after(:create) do |r|
       r.updated_at = r.updated_at.change(:usec => 0)

data/spec/factories/bigbluebutton_server.rb

@@ -2,7 +2,7 @@ FactoryGirl.define do
   factory :bigbluebutton_server do |s|
     s.sequence(:name) { |n| "Server #{n}" }
     s.sequence(:url) { |n| "http://bigbluebutton#{n}.test.com/bigbluebutton/api" }
-    s.salt { Forgery(:basic).password :at_least => 30, :at_most => 40 }
+    s.secret { Forgery(:basic).password :at_least => 30, :at_most => 40 }
     s.version '0.9'
     s.sequence(:param) { |n| "server-#{n}" }
   end

data/spec/lib/bigbluebutton_rails/background_tasks_spec.rb

@@ -3,55 +3,146 @@ require 'spec_helper'
 describe BigbluebuttonRails::BackgroundTasks do
 
   describe ".finish_meetings" do
+    let!(:api) { double(BigBlueButton::BigBlueButtonApi) }
 
-    context "set meetings that ended as not running" do
+    context "set meetings that ended as not running and ended" do
       let(:room) { FactoryGirl.create(:bigbluebutton_room) }
-      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, running: true, room: room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
+      let!(:exception) {
+        e = BigBlueButton::BigBlueButtonException.new('Test error')
+        e.key = 'notFound'
+        e
+      }
+
       before {
         BigBlueButton::BigBlueButtonApi.any_instance
           .stub(:get_api_version).and_return("0.9")
         BigBlueButton::BigBlueButtonApi.any_instance
-          .should_receive(:is_meeting_running?).once.with(room.meetingid).and_return(false)
+          .should_receive(:get_meeting_info).once { raise exception }
       }
       before(:each) { BigbluebuttonRails::BackgroundTasks.finish_meetings }
-      it { meeting.reload.running.should be false }
+      it { meeting.reload.running.should be(false) }
+      it { meeting.reload.ended.should be(true) }
     end
 
     context "doesn't change meetings that are still running" do
       let(:room) { FactoryGirl.create(:bigbluebutton_room) }
-      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, running: true, room: room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
       before {
         BigBlueButton::BigBlueButtonApi.any_instance
           .stub(:get_api_version).and_return("0.9")
         BigBlueButton::BigBlueButtonApi.any_instance
-          .should_receive(:is_meeting_running?).once.with(room.meetingid).and_return(true)
+          .should_receive(:get_meeting_info).once.and_return({ running: true })
       }
       before(:each) { BigbluebuttonRails::BackgroundTasks.finish_meetings }
-      it { meeting.reload.running.should be true }
+      it { meeting.reload.running.should be(true) }
+      it { meeting.reload.ended.should be(false) }
     end
 
-    context "ignores meetings that are not running" do
+    context "ignores meetings that already ended" do
       let(:room) { FactoryGirl.create(:bigbluebutton_room) }
-      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, running: false, room: room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: true, room: room) }
+      before(:each) {
+        BigbluebuttonRoom.any_instance.should_not_receive(:fetch_meeting_info)
+        BigbluebuttonRails::BackgroundTasks.finish_meetings
+      }
+      it { meeting.reload.running.should be(false) }
+    end
+
+    context "considers both meetings running and not running" do
+      let(:room1) { FactoryGirl.create(:bigbluebutton_room) }
+      let(:room2) { FactoryGirl.create(:bigbluebutton_room) }
+      let!(:meeting1) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room1) }
+      let!(:meeting2) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: false, room: room2) }
+      let!(:exception) {
+        e = BigBlueButton::BigBlueButtonException.new('Test error')
+        e.key = 'notFound'
+        e
+      }
+
       before {
-        BigBlueButton::BigBlueButtonApi.any_instance.should_not_receive(:is_meeting_running?)
+        BigBlueButton::BigBlueButtonApi.any_instance
+          .stub(:get_api_version).and_return("0.9")
+        BigBlueButton::BigBlueButtonApi.any_instance.stub(:get_meeting_info) { raise exception }
       }
       before(:each) { BigbluebuttonRails::BackgroundTasks.finish_meetings }
-      it { meeting.reload.running.should be false }
+      it { meeting1.reload.running.should be(false) }
+      it { meeting1.reload.ended.should be(true) }
+      it { meeting1.reload.running.should be(false) }
+      it { meeting1.reload.ended.should be(true) }
+    end
+
+    context "ignore meetings that have no room" do
+      let(:room) { FactoryGirl.create(:bigbluebutton_room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
+      before(:each) {
+        BigbluebuttonRoom.any_instance.should_not_receive(:fetch_meeting_info)
+        meeting.room.delete
+        BigbluebuttonRails::BackgroundTasks.finish_meetings
+      }
+      it { meeting.reload.running.should be(true) }
     end
 
-    it "works for multiple meetings"
+    context "calls finish_meetings if an exception 'notFound' is raised" do
+      let!(:room) { FactoryGirl.create(:bigbluebutton_room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
+      let!(:exception) {
+        e = BigBlueButton::BigBlueButtonException.new('Test error')
+        e.key = 'notFound'
+        e
+      }
+
+      before {
+        BigbluebuttonServer.any_instance.should_receive(:api) { api }
+        expect(api).to receive(:get_meeting_info).once { raise exception }
+        BigbluebuttonRoom.any_instance.should_receive(:finish_meetings).once
+      }
+      it { expect { BigbluebuttonRails::BackgroundTasks.finish_meetings }.not_to raise_exception }
+    end
+
+    context "calls finish_meetings if an exception other than 'notFound' is raised" do
+      let!(:room) { FactoryGirl.create(:bigbluebutton_room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
+      let!(:exception) {
+        e = BigBlueButton::BigBlueButtonException.new('Test error')
+        e.key = 'anythingElse'
+        e
+      }
+
+      before {
+        BigbluebuttonServer.any_instance.should_receive(:api) { api }
+        expect(api).to receive(:get_meeting_info).once { raise exception }
+        BigbluebuttonRoom.any_instance.should_receive(:finish_meetings)
+      }
+      it { expect { BigbluebuttonRails::BackgroundTasks.finish_meetings }.not_to raise_exception }
+    end
+
+    context "calls finish_meetings if an exception with a blank key is raised" do
+      let!(:room) { FactoryGirl.create(:bigbluebutton_room) }
+      let!(:meeting) { FactoryGirl.create(:bigbluebutton_meeting, ended: false, running: true, room: room) }
+      let!(:exception) {
+        e = BigBlueButton::BigBlueButtonException.new('Test error')
+        e.key = ''
+        e
+      }
+
+      before {
+        BigbluebuttonServer.any_instance.should_receive(:api) { api }
+        expect(api).to receive(:get_meeting_info).once { raise exception }
+        BigbluebuttonRoom.any_instance.should_receive(:finish_meetings)
+      }
+      it { expect { BigbluebuttonRails::BackgroundTasks.finish_meetings }.not_to raise_exception }
+    end
   end
 
   describe ".update_recordings" do
-
     context "fetches the meetings for all servers" do
       let!(:server1) { FactoryGirl.create(:bigbluebutton_server) }
       let!(:server2) { FactoryGirl.create(:bigbluebutton_server) }
       before {
         BigbluebuttonServer.stub(:find_each).and_yield(server1).and_yield(server2)
-        server1.should_receive(:fetch_recordings).once
-        server2.should_receive(:fetch_recordings).once
+        server1.should_receive(:fetch_recordings).once.with(nil, true)
+        server2.should_receive(:fetch_recordings).once.with(nil, true)
       }
       it { BigbluebuttonRails::BackgroundTasks.update_recordings }
     end