bigbluebutton_rails 1.4.0 → 2.0.0

data/lib/bigbluebutton_rails/background_tasks.rb

@@ -0,0 +1,31 @@
+module BigbluebuttonRails
+
+  # Helper methods to execute tasks that run in resque and rake.
+  class BackgroundTasks
+
+    def self.finish_meetings
+      BigbluebuttonMeeting.where(running: true).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)
+        end
+      end
+    end
+
+    def self.update_recordings
+      BigbluebuttonServer.find_each do |server|
+        begin
+          server.fetch_recordings
+          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}"
+          Rails.logger.info "BackgroundTasks: #{e.inspect}"
+          Rails.logger.info "BackgroundTasks: #{e.backtrace.join("\n")}"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/bigbluebutton_rails/controller_methods.rb

@@ -29,12 +29,12 @@ module BigbluebuttonRails
         # Returns the role that the current user has in the room 'room'. Return values:
         #   :moderator      # the user has attendee permissions
         #   :attendee       # the user has moderator permissions
-        #   :password       # the user must enter a password that will define his role
+        #   :key            # the user must enter a key that will define his role
         #   nil             # no role at all (the room is blocked to this user)
         #
         # Returning :moderator or :attendee means that the current user has access
         # to the room and has moderator or attendee privileges, respectively.
-        # Returning :password indicates that the user must enter a password to define
+        # Returning :key indicates that the user must enter a key to define
         # his role in the room.
         # At last, returning nil means that the user cannot access access this room
         # at all. BigbluebuttonRails::RoomController will thrown an exception of the
@@ -51,7 +51,7 @@ module BigbluebuttonRails
         # You may want to redefine this method in your application to define
         # real roles to the users. By default, if the room is not private and the user
         # is logged, he will have moderator permissions. Otherwise, he must enter
-        # a password. Redefine it in your ApplicationController to make it available
+        # a key. Redefine it in your ApplicationController to make it available
         # to all controllers. For example:
         #
         #   def bigbluebutton_role(@room)
@@ -63,7 +63,7 @@ module BigbluebuttonRails
         #     # only friends are allowed to enter
         #     elsif @room.owner.friends.include? bigbluebutton_user
         #       if @room.private
-        #         :password # with password if the room is private
+        #         :key # with key if the room is private
         #       else
         #         :attendee
         #       end
@@ -77,7 +77,7 @@ module BigbluebuttonRails
         #
         def bigbluebutton_role(room)
           if room.private or bigbluebutton_user.nil?
-            :password # ask for a password
+            :key # ask for a key
           else
             :moderator
           end
@@ -107,18 +107,22 @@ module BigbluebuttonRails
         end
 
         # Method called right before a meeting is created to get options that should receive
-        # priority over the options saved in the database when sending the <tt>create</tt>API
-        # call.
+        # priority over the options saved in the database when sending the <tt>create</tt>
+        # API call.
         # The parameter 'room' is the BigbluebuttonRoom where the meeting is about
         # to be created.
         #
-        # By default, all options send in a 'create' API call are taken from the
+        # By default, all options sent in a 'create' API call are taken from the
         # options saved in the database for the target room. This includes, for example,
         # the meeting's name, dial number, welcome message, if it should be recorded or not.
         # This method can return a hash of options to force some of these options to be
         # different from what is stored in the database. For example, if a room should *not* be
         # recorded in case unprivileged users create it, this method can return <tt>{ record: false }</tt>
         # to force the <tt>record</tt> flag to be false.
+        # The keys used in this hash should correspond to the attributes sent in the <tt>CREATE</tt>
+        # API call, not the the attributes stored in the database! See the method
+        # <tt>create_meeting</tt> in the gem <tt>bigbluebutton-api-ruby</tt> for examples.
+        # (https://github.com/mconf/bigbluebutton-api-ruby/blob/master/lib/bigbluebutton_api.rb#L156)
         #
         # You may want to override this in your ApplicationController to implement your own
         # own logic, if needed. For example:

data/lib/bigbluebutton_rails/dial_number.rb

@@ -0,0 +1,48 @@
+module BigbluebuttonRails
+  class DialNumber
+
+    # Generates a random dial number based on the `pattern` (e.g. '123x-xxxx')
+    def self.randomize(pattern=nil, opt={})
+      return nil if pattern.nil?
+      sym = get_symbol(opt)
+      size = pattern.count(sym)
+
+      # e.g. random from 0 to 999 if the pattern has 3 x's
+      num = SecureRandom.random_number((10 ** size) - 1)
+
+      get_dial_number_from_ordinal(num, pattern, opt)
+    end
+
+    def self.get_dial_number_from_ordinal(ordinal, pattern=nil, opt={})
+      return nil if pattern.nil?
+      sym = get_symbol(opt)
+
+      number_size = pattern.count(sym)
+      ordinal_str = ordinal.to_s.rjust(number_size,'0').reverse
+      dial_number = pattern.reverse
+
+      ordinal_str.each_char do |n|
+        dial_number.sub!(sym, n)
+      end
+
+      dial_number.reverse
+    end
+
+    def self.get_ordinal_from_dial_number(number, pattern=nil, opt={})
+      return nil if pattern.nil?
+      sym = get_symbol(opt)
+
+      regexp = Regexp.new(pattern.gsub(sym, '([0-9])')) # make a pattern to capture only the numbers
+      match = regexp.match(number) # extract only the numbers
+
+      # join the numbers and turn then into an ordinal integer
+      ordinal = match[1, match.size].join.to_i if match.present?
+
+      ordinal
+    end
+
+    def self.get_symbol opt
+      opt[:symbol] || 'x'
+    end
+  end
+end

data/lib/bigbluebutton_rails/rails/routes.rb

@@ -43,7 +43,8 @@ module ActionDispatch::Routing
     #   bigbluebutton_routes :default,
     #                        :controllers => { :servers => "custom_servers",
     #                                          :rooms => "custom_rooms",
-    #                                          :recordings => "custom_recordings" }
+    #                                          :recordings => "custom_recordings",
+    #                                          :playback_types => "custom_playback_types }
     #
     # ==== Room matchers
     #
@@ -84,13 +85,14 @@ module ActionDispatch::Routing
       options = params.extract_options!
       options_scope = options.has_key?(:scope) ? options[:scope] : BigbluebuttonRails.routing_scope
       options_as = options.has_key?(:as) ? options[:as] : options_scope
-      options_only = options.has_key?(:only) ? options[:only] : ["servers", "rooms", "recordings"]
+      options_only = options.has_key?(:only) ? options[:only] : ["servers", "rooms", "recordings", "playback_types"]
       BigbluebuttonRails.set_controllers(options[:controllers])
 
       scope options_scope, :as => options_as do
         add_routes_for_servers if options_only.include?("servers")
         add_routes_for_rooms if options_only.include?("rooms")
         add_routes_for_recordings if options_only.include?("recordings")
+        add_routes_for_playback_types if options_only.include?("playback_types")
       end
     end
 
@@ -109,6 +111,7 @@ module ActionDispatch::Routing
           post :join
           post :fetch_recordings
           get :recordings
+          post :generate_dial_number
         end
       end
     end
@@ -137,5 +140,9 @@ module ActionDispatch::Routing
       end
     end
 
+    def add_routes_for_playback_types #:nodoc:
+      resources :playback_types, :only => [:update],
+                                 :controller => BigbluebuttonRails.controllers[:playback_types]
+    end
   end
 end

data/lib/bigbluebutton_rails/utils.rb

@@ -1,8 +1,15 @@
+require 'browser'
+
 module BigbluebuttonRails
 
-  # just a wrapper around the Rails method to convert values to boolean
+  # Returns whether the current client should use the mobile client
+  # or the desktop client.
+  def self.use_mobile_client?(browser)
+    browser.mobile? || browser.tablet?
+  end
+
+  # Just a wrapper around the Rails method to convert values to boolean
   def self.value_to_boolean(value)
     ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
   end
-
 end

data/lib/bigbluebutton_rails/version.rb

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

data/lib/generators/bigbluebutton_rails/install_generator.rb

@@ -26,14 +26,6 @@ module BigbluebuttonRails
         end
       end
 
-      def create_schedule
-        unless options.migration_only?
-          create_file 'config/schedule.rb'
-          content = File.read(File.expand_path("../../../../config/schedule.rb", __FILE__))
-          append_file 'config/schedule.rb', "\n#{content}" unless behavior == :revoke
-        end
-      end
-
       protected
 
       def migration_path

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

@@ -16,8 +16,8 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.string :owner_type
       t.string :meetingid
       t.string :name
-      t.string :attendee_password
-      t.string :moderator_password
+      t.string :attendee_key
+      t.string :moderator_key
       t.string :welcome_msg
       t.string :logout_url
       t.string :voice_bridge
@@ -26,13 +26,18 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.boolean :private, :default => false
       t.boolean :external, :default => false
       t.string :param
-      t.boolean :record, :default => false
+      t.boolean :record_meeting, :default => false
       t.integer :duration, :default => 0
+      t.string :attendee_api_password
+      t.string :moderator_api_password
+      t.decimal :create_time, precision: 14, scale: 0
+      t.string :moderator_only_message
+      t.boolean :auto_start_recording, default: false
+      t.boolean :allow_start_stop_recording, default: true
       t.timestamps
     end
     add_index :bigbluebutton_rooms, :server_id
     add_index :bigbluebutton_rooms, :meetingid, :unique => true
-    add_index :bigbluebutton_rooms, :voice_bridge, :unique => true
 
     create_table :bigbluebutton_room_options do |t|
       t.integer :room_id
@@ -40,6 +45,7 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.boolean :presenter_share_only
       t.boolean :auto_start_video
       t.boolean :auto_start_audio
+      t.string :background
       t.timestamps
     end
     add_index :bigbluebutton_room_options, :room_id
@@ -56,6 +62,7 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.datetime :end_time
       t.boolean :available, :default => true
       t.string :description
+      t.integer :size, limit: 8, default: 0
       t.timestamps
     end
     add_index :bigbluebutton_recordings, :room_id
@@ -71,12 +78,19 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
 
     create_table :bigbluebutton_playback_formats do |t|
       t.integer :recording_id
-      t.string :format_type
+      t.integer :playback_type_id
       t.string :url
       t.integer :length
       t.timestamps
     end
 
+    create_table :bigbluebutton_playback_types do |t|
+      t.string :identifier
+      t.boolean :visible, :default => false
+      t.boolean :default, :default => false
+      t.timestamps
+    end
+
     create_table :bigbluebutton_meetings do |t|
       t.integer :server_id
       t.integer :room_id
@@ -84,22 +98,30 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.string :name
       t.datetime :start_time
       t.boolean :running, :default => false
-      t.boolean :record, :default => false
+      t.boolean :recorded, :default => false
       t.integer :creator_id
       t.string :creator_name
       t.timestamps
     end
     add_index :bigbluebutton_meetings, [:meetingid, :start_time], :unique => true
+
+    create_table :bigbluebutton_server_configs do |t|
+      t.integer :server_id
+      t.text :available_layouts
+      t.timestamps
+    end
   end
 
   def self.down
     drop_table :bigbluebutton_meetings
     drop_table :bigbluebutton_playback_formats
+    drop_table :bigbluebutton_playback_types
     drop_table :bigbluebutton_metadata
     drop_table :bigbluebutton_recordings
     drop_table :bigbluebutton_rooms
     drop_table :bigbluebutton_rooms_options
     drop_table :bigbluebutton_servers
+    drop_table :bigbluebutton_server_configs
   end
 
 end

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

@@ -0,0 +1,56 @@
+class BigbluebuttonRailsTo200 < ActiveRecord::Migration
+
+  def self.up
+    create_table :bigbluebutton_playback_types do |t|
+      t.string :identifier
+      t.boolean :visible, default: false
+      t.boolean :default, default: false
+      t.timestamps
+    end
+
+    rename_column :bigbluebutton_rooms, :record, :record_meeting
+    rename_column :bigbluebutton_meetings, :record, :recorded
+    rename_column :bigbluebutton_rooms, :attendee_password, :attendee_key
+    rename_column :bigbluebutton_rooms, :moderator_password, :moderator_key
+    add_column :bigbluebutton_rooms, :moderator_api_password, :string
+    add_column :bigbluebutton_rooms, :attendee_api_password, :string
+    add_column :bigbluebutton_rooms, :create_time, :decimal, precision: 14, scale: 0
+    remove_column :bigbluebutton_playback_formats, :format_type
+    add_column :bigbluebutton_playback_formats, :playback_type_id, :integer
+    remove_index :bigbluebutton_rooms, :voice_bridge
+
+    create_table :bigbluebutton_server_configs do |t|
+      t.integer :server_id
+      t.text :available_layouts
+      t.timestamps
+    end
+
+    add_column :bigbluebutton_rooms, :moderator_only_message, :string
+    add_column :bigbluebutton_rooms, :auto_start_recording, :boolean, default: false
+    add_column :bigbluebutton_rooms, :allow_start_stop_recording, :boolean, default: true
+
+    add_column :bigbluebutton_room_options, :background, :string
+
+    add_column :bigbluebutton_recordings, :size, :integer, limit: 8, default: 0
+  end
+
+  def self.down
+    drop_table :bigbluebutton_playback_types
+    rename_column :bigbluebutton_rooms, :record_meeting, :record
+    rename_column :bigbluebutton_meetings, :recorded, :record
+    rename_column :bigbluebutton_rooms, :attendee_key, :attendee_password
+    rename_column :bigbluebutton_rooms, :moderator_key, :moderator_password
+    remove_column :bigbluebutton_rooms, :moderator_api_password
+    remove_column :bigbluebutton_rooms, :attendee_api_password
+    remove_column :bigbluebutton_rooms, :create_time
+    add_column :bigbluebutton_playback_formats, :format_type, :string
+    remove_column :bigbluebutton_playback_formats, :playback_type_id
+    add_index :bigbluebutton_rooms, :voice_bridge, :unique => true
+    drop_table :bigbluebutton_server_configs
+    remove_column :bigbluebutton_rooms, :moderator_only_message
+    remove_column :bigbluebutton_rooms, :auto_start_recording
+    remove_column :bigbluebutton_rooms, :allow_start_stop_recording
+    remove_column :bigbluebutton_room_options, :background
+    remove_column :bigbluebutton_recordings, :size, :integer
+  end
+end

data/lib/tasks/bigbluebutton_rails/meetings.rake

@@ -2,21 +2,9 @@ require 'bigbluebutton_exception'
 
 namespace :bigbluebutton_rails do
   namespace :meetings do
-
     desc "Checks all meetings with running==true to see if they have finished"
     task :finish => :environment do
-      BigbluebuttonMeeting.where(:running => true).all.each do |meeting|
-        begin
-          puts "[rake bigbluebutton_rails:meetings:finish] Getting meeting info for: #{meeting.inspect}"
-          meeting.room.fetch_meeting_info
-        rescue BigBlueButton::BigBlueButtonException => e
-
-          # it will fail with an exception if the meeting ended because the meetingID is not found
-          puts "[rake bigbluebutton_rails:meetings:finish] Setting meeting as not running: #{meeting.inspect}"
-          meeting.update_attributes(:running => false)
-        end
-      end
+      BigbluebuttonRails::BackgroundTasks.finish_meetings
     end
-
   end
 end

data/lib/tasks/bigbluebutton_rails/recordings.rake

@@ -1,19 +1,8 @@
 namespace :bigbluebutton_rails do
   namespace :recordings do
-
     desc "Fetch recordings in all servers"
     task :update => :environment do
-      BigbluebuttonServer.all.each do |server|
-        begin
-          server.fetch_recordings
-          puts "[rake bigbluebutton_rails:recordings:update] List of recordings from #{server.url} updated successfully"
-        rescue Exception => e
-          puts "[rake bigbluebutton_rails:recordings:update] Failure fetching recordings from #{server.inspect}"
-          puts e.inspect
-          puts e.backtrace.join "\n"
-        end
-      end
+      BigbluebuttonRails::BackgroundTasks.update_recordings
     end
-
   end
 end

data/lib/tasks/bigbluebutton_rails/server_configs.rake

@@ -0,0 +1,10 @@
+namespace :bigbluebutton_rails do
+  namespace :server_configs do
+    desc "Fetch server configs for all servers"
+    task :update => :environment do
+      BigbluebuttonServer.all.each do |s|
+        s.update_config
+      end
+    end
+  end
+end

data/spec/bigbluebutton_rails_spec.rb

@@ -8,17 +8,4 @@ describe BigbluebuttonRails do
   it "should have be an engine" do
     BigbluebuttonRails::Engine.should be < Rails::Engine
   end
-
-  describe "#value_to_boolean" do
-    it { BigbluebuttonRails::value_to_boolean("true").should be_true }
-    it { BigbluebuttonRails::value_to_boolean("1").should be_true }
-    it { BigbluebuttonRails::value_to_boolean(1).should be_true }
-    it { BigbluebuttonRails::value_to_boolean(true).should be_true }
-    it { BigbluebuttonRails::value_to_boolean("t").should be_true }
-    it { BigbluebuttonRails::value_to_boolean("false").should be_false }
-    it { BigbluebuttonRails::value_to_boolean("0").should be_false }
-    it { BigbluebuttonRails::value_to_boolean(0).should be_false }
-    it { BigbluebuttonRails::value_to_boolean(false).should be_false }
-    it { BigbluebuttonRails::value_to_boolean("f").should be_false }
-  end
 end