bigbluebutton_rails 1.2.0 → 1.3.0.beta1

data/lib/bigbluebutton_rails/controller_methods.rb

@@ -83,6 +83,37 @@ module BigbluebuttonRails
           end
         end
 
+        # Method used called right before a meeting is created to check
+        # whether the current user ('bigbluebutton_user') is allowed to create
+        # the meeting in the target room.
+        # By default any moderator can create meetings.
+        # The parameter 'room' is the BigbluebuttonRoom where the meeting is about
+        # to be created. And 'role' is the role already defined for the user
+        # (:moderator, :attendee, etc).
+        #
+        # This method can also be used to run anything you may need to run
+        # right before a meeting is created, such as adapting the metadata.
+        # You can also, for instance, check if the user has permissions to record
+        # the meeting and set the flag 'record' accordingly.
+        #
+        # You may want to do override this in your ApplicationController to
+        # implement your own logic, for example:
+        #
+        #   def bigbluebutton_can_create?(room, role)
+        #     if role == :moderator
+        #       unless bigbluebutton_user.can_record_meeting?(room)
+        #         room.update_attributes(:record => false)
+        #       end
+        #       true
+        #     else
+        #       false
+        #     end
+        #   end
+        #
+        def bigbluebutton_can_create?(room, role)
+          role == :moderator
+        end
+
       end
     end
 

data/lib/bigbluebutton_rails/rails/routes.rb

@@ -12,10 +12,10 @@ module ActionDispatch::Routing
     # ==== Default routes
     #
     # Passing the option :default, it will generate the default routes to access
-    # bigbluebutton servers and rooms. These routes are the resourceful routes generated
+    # servers, rooms and recordings. The routes generated are the CRUD routes generated
     # by rails to a resource, plus the other available actions for servers and rooms.
     #
-    #    bigbluebutton_routes :default
+    #   bigbluebutton_routes :default
     #
     # Examples of some routes generated:
     #
@@ -23,19 +23,27 @@ module ActionDispatch::Routing
     #                                             { :action=>"show", :controller=>"bigbluebutton/servers" }
     #                                      POST   /bigbluebutton/servers/:id(.:format)
     #                                             { :action=>"update", :controller=>"bigbluebutton/servers" }
+    #
     #   join_bigbluebutton_room            GET    /bigbluebutton/rooms/:id/join(.:format)
     #                                             { :action=>"join", :controller=>"bigbluebutton/rooms" }
+    #
     #   running_bigbluebutton_room         GET    /bigbluebutton/rooms/:id/running(.:format)
     #                                             { :action=>"running", :controller=>"bigbluebutton/rooms" }
     #
-    # The routes point by default to the controllers Bigbluebutton::ServersController and Bigbluebutton::RoomsController
+    #   play_bigbluebutton_recording       GET    /bigbluebutton/recordings/:id/play(.:format)
+    #                                             { :action=>"play", :controller=>"bigbluebutton/recordings" }
+    #
+    # The routes point by default to the controllers provided by this gem
     # and they are scoped (namespaced) with 'bigbluebutton'. You can change the namespace with:
     #
-    #    bigbluebutton_routes :default, :scope => "webconference"
+    #   bigbluebutton_routes :default, :scope => "webconference"
     #
     # You can also change the controllers with:
     #
-    #    bigbluebutton_routes :default, :controllers { :servers => "custom_servers", :rooms => "custom_rooms" }
+    #   bigbluebutton_routes :default,
+    #                        :controllers => { :servers => "custom_servers",
+    #                                          :rooms => "custom_rooms",
+    #                                          :recordings => "custom_recordings" }
     #
     # ==== Room matchers
     #
@@ -43,7 +51,7 @@ module ActionDispatch::Routing
     # Rooms can belong to users, communities or any other type of "entity" in an aplication.
     # This helper creates routes to the all the actions available in Bigbluebutton::RoomsController.
     #
-    #    bigbluebutton_routes :room_matchers
+    #   bigbluebutton_routes :room_matchers
     #
     # You can, for example, create routes associated with users:
     #
@@ -55,10 +63,13 @@ module ActionDispatch::Routing
     #
     #   user_room               GET  /users/:user_id/room/:id(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"show" }
+    #
     #   user_join_room          GET  /users/:user_id/room/:id/join(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"join" }
+    #
     #   user_end_room           GET  /users/:user_id/room/:id/end(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"end" }
+    #
     #   user_invite_room        GET  /users/:user_id/room/:id/invite(.:format)
     #                                { :controller=>"bigbluebutton/rooms", :action=>"invite" }
     #
@@ -72,14 +83,14 @@ module ActionDispatch::Routing
     def bigbluebutton_routes_default(*params) #:nodoc:
       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"]
       BigbluebuttonRails.set_controllers(options[:controllers])
 
-      scope options_scope, :as => options_scope do
-        resources :servers, :controller => BigbluebuttonRails.controllers[:servers] do
-          get :activity, :on => :member
-          get :rooms, :on => :member
-        end
-        add_routes_for_rooms
+      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")
       end
     end
 
@@ -87,7 +98,7 @@ module ActionDispatch::Routing
       add_routes_for_rooms
     end
 
-    def add_routes_for_rooms
+    def add_routes_for_rooms #:nodoc:
       resources :rooms, :controller => BigbluebuttonRails.controllers[:rooms] do
         collection do
           get :external
@@ -100,10 +111,35 @@ module ActionDispatch::Routing
           get :invite
           get :join_mobile
           post :join, :action => :auth
+          post :fetch_recordings
+          get :recordings
+        end
+      end
+    end
+
+    def add_routes_for_servers #:nodoc:
+      resources :servers, :controller => BigbluebuttonRails.controllers[:servers] do
+        member do
+          get :activity
+          get :rooms
+          get :recordings
+          post :publish_recordings
+          post :unpublish_recordings
+          post :fetch_recordings
+        end
+      end
+    end
+
+    def add_routes_for_recordings #:nodoc:
+      resources :recordings, :except => [:new, :create],
+                             :controller => BigbluebuttonRails.controllers[:recordings] do
+        member do
+          get :play
+          post :publish
+          post :unpublish
         end
       end
     end
 
   end
 end
-

data/lib/bigbluebutton_rails/version.rb

@@ -1,3 +1,3 @@
 module BigbluebuttonRails
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0.beta1".freeze
 end

data/lib/generators/bigbluebutton_rails/install_generator.rb

@@ -14,14 +14,6 @@ module BigbluebuttonRails
         copy_file "config/locales/en.yml", "config/locales/bigbluebutton_rails.en.yml" unless options.migration_only?
       end
 
-      def copy_public_files
-        unless options.migration_only?
-          copy_file "public/javascripts/jquery.min.js", "public/javascripts/jquery.min.js"
-          copy_file "public/images/loading.gif", "public/images/loading.gif"
-          copy_file "public/stylesheets/bigbluebutton_rails.css", "public/stylesheets/bigbluebutton_rails.css"
-        end
-      end
-
       def self.next_migration_number(dirname)
         ActiveRecord::Generators::Base.next_migration_number(dirname)
       end
@@ -34,6 +26,14 @@ 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

@@ -9,6 +9,7 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.string :param
       t.timestamps
     end
+
     create_table :bigbluebutton_rooms do |t|
       t.integer :server_id
       t.integer :owner_id
@@ -23,17 +24,52 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.string :dial_number
       t.integer :max_participants
       t.boolean :private, :default => false
-      t.boolean :randomize_meetingid, :default => true
       t.boolean :external, :default => false
       t.string :param
+      t.boolean :record, :default => false
+      t.integer :duration, :default => 0
       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_recordings do |t|
+      t.integer :server_id
+      t.integer :room_id
+      t.string :recordid
+      t.string :meetingid
+      t.string :name
+      t.boolean :published, :default => false
+      t.datetime :start_time
+      t.datetime :end_time
+      t.boolean :available, :default => true
+      t.timestamps
+    end
+    add_index :bigbluebutton_recordings, :room_id
+    add_index :bigbluebutton_recordings, :recordid, :unique => true
+
+    create_table :bigbluebutton_metadata do |t|
+      t.integer :owner_id
+      t.string :owner_type
+      t.string :name
+      t.text :content
+      t.timestamps
+    end
+
+    create_table :bigbluebutton_playback_formats do |t|
+      t.integer :recording_id
+      t.string :format_type
+      t.string :url
+      t.integer :length
+      t.timestamps
+    end
   end
 
   def self.down
+    drop_table :bigbluebutton_playback_formats
+    drop_table :bigbluebutton_metadata
+    drop_table :bigbluebutton_recordings
     drop_table :bigbluebutton_rooms
     drop_table :bigbluebutton_servers
   end

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

@@ -0,0 +1,55 @@
+class BigbluebuttonRailsTo130 < ActiveRecord::Migration
+
+  def self.up
+    create_table :bigbluebutton_recordings do |t|
+      t.integer :server_id
+      t.integer :room_id
+      t.string :recordid
+      t.string :meetingid
+      t.string :name
+      t.boolean :published, :default => false
+      t.datetime :start_time
+      t.datetime :end_time
+      t.boolean :available, :default => true
+      t.timestamps
+    end
+    add_index :bigbluebutton_recordings, :room_id
+    add_index :bigbluebutton_recordings, :recordid, :unique => true
+
+    create_table :bigbluebutton_metadata do |t|
+      t.integer :owner_id
+      t.string :owner_type
+      t.string :name
+      t.text :content
+      t.timestamps
+    end
+
+    create_table :bigbluebutton_playback_formats do |t|
+      t.integer :recording_id
+      t.string :format_type
+      t.string :url
+      t.integer :length
+      t.timestamps
+    end
+
+    change_table(:bigbluebutton_rooms) do |t|
+      t.boolean :record, :default => false
+      t.integer :duration, :default => 0
+    end
+
+    remove_column :bigbluebutton_rooms, :randomize_meetingid
+  end
+
+  def self.down
+    add_column :bigbluebutton_rooms, :randomize_meetingid, :boolean, :default => true
+    change_table(:bigbluebutton_rooms) do |t|
+      t.remove :record
+      t.remove :duration
+    end
+    drop_table :bigbluebutton_playback_formats
+    drop_table :bigbluebutton_metadata
+    remove_index :bigbluebutton_recordings, :room_id
+    remove_index :bigbluebutton_recordings, :recordid
+    drop_table :bigbluebutton_recordings
+  end
+end

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

@@ -0,0 +1,13 @@
+class BigbluebuttonRailsTo130B < ActiveRecord::Migration
+
+  def self.up
+    # Generate a meetingID for every room
+    BigbluebuttonRoom.all.each do |room|
+      room.update_attributes(:meetingid => room.unique_meetingid)
+    end
+  end
+
+  def self.down
+    # Can't undo
+  end
+end

data/lib/generators/bigbluebutton_rails/views_generator.rb

@@ -3,14 +3,18 @@ require 'rails/generators/active_record'
 module BigbluebuttonRails
   module Generators
     class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../app/views", __FILE__)
+      source_root File.expand_path("../../../../app", __FILE__)
       desc "Copies all bigbluebutton_rails views into your application folders."
 
       argument :scope, :required => false, :default => nil,
                        :desc => "The scope to copy views to"
 
       def copy_views
-        directory "bigbluebutton", "app/views/#{ scope || :bigbluebutton}"
+        directory "views/bigbluebutton", "app/views/#{ scope || :bigbluebutton}"
+      end
+
+      def copy_stylesheets
+        copy_file "assets/stylesheets/bigbluebutton_rails.css", "app/assets/stylesheets/bigbluebutton_rails.css"
       end
 
     end

data/lib/tasks/bigbluebutton_rails/recordings.rake

@@ -0,0 +1,18 @@
+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
+        rescue Exception => e
+          puts "Failure fetching recordings from #{server.inspect}"
+          puts e.inspect
+          puts e.backtrace.join "\n"
+        end
+      end
+    end
+
+  end
+end

data/spec/bigbluebutton_rails_spec.rb

@@ -5,8 +5,8 @@ describe BigbluebuttonRails do
     BigbluebuttonRails.should be_a(Module)
   end
 
-  it "should have an engine" do
-    BigbluebuttonRails::Engine.new.should be_a_kind_of(Rails::Engine)
+  it "should have be an engine" do
+    BigbluebuttonRails::Engine.should be < Rails::Engine
   end
 
   describe "#value_to_boolean" do

data/spec/controllers/bigbluebutton/recordings_controller_json_responses_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Bigbluebutton::RecordingsController do
+  render_views
+  let(:recording) { FactoryGirl.create(:bigbluebutton_recording) }
+
+  context "json responses for" do
+
+    describe "#index" do
+      before do
+        @recording1 = FactoryGirl.create(:bigbluebutton_recording)
+        @recording2 = FactoryGirl.create(:bigbluebutton_recording)
+      end
+      before(:each) { get :index, :format => 'json' }
+      it { should respond_with(:success) }
+      it { should respond_with_content_type(:json) }
+      it { should respond_with_json([@recording1, @recording2].to_json) }
+    end
+
+    describe "#show" do
+      before(:each) { get :show, :id => recording.to_param, :format => 'json' }
+      it { should respond_with(:success) }
+      it { should respond_with_content_type(:json) }
+      it { should respond_with_json(recording.to_json) }
+    end
+
+    describe "#show" do
+      before(:each) { get :show, :id => recording.to_param, :format => 'json' }
+      it { should respond_with(:success) }
+      it { should respond_with_content_type(:json) }
+      it { should respond_with_json(recording.to_json) }
+    end
+
+    describe "#update" do
+      let(:new_recording) { FactoryGirl.build(:bigbluebutton_recording) }
+      before { @recording = recording }
+
+      context "on success" do
+        before(:each) {
+          put :update, :id => @recording.to_param, :bigbluebutton_recording => new_recording.attributes, :format => 'json'
+        }
+        it { should respond_with(:success) }
+        it { should respond_with_content_type(:json) }
+      end
+
+      context "on failure" do
+        before(:each) {
+          new_recording.recordid = nil # invalid
+          put :update, :id => @recording.to_param, :bigbluebutton_recording => new_recording.attributes, :format => 'json'
+        }
+        it { should respond_with(:unprocessable_entity) }
+        it { should respond_with_content_type(:json) }
+        it {
+          new_recording.save # should fail
+          should respond_with_json(new_recording.errors.full_messages.to_json)
+        }
+      end
+    end
+
+    describe "#destroy" do
+      before :each do
+        @recording = recording
+        @recording.server = nil
+        BigbluebuttonRecording.stub(:find_by_recordid) { @recording }
+        delete :destroy, :id => @recording.to_param, :format => 'json'
+      end
+      it { should respond_with(:success) }
+      it { should respond_with_content_type(:json) }
+    end
+
+    # these actions are essentially the same
+    [:publish, :unpublish].each do |action|
+      describe "##{action.to_s}" do
+        before { mock_server_and_api }
+        let(:flag) { action == :publish ? true : false }
+
+        context "on success" do
+          before {
+            mocked_server.should_receive(:send_publish_recordings).with(recording.recordid, flag)
+          }
+          before(:each) { post action, :id => recording.to_param, :format => 'json' }
+          it { should respond_with(:success) }
+          it { should respond_with_content_type(:json) }
+          it { should respond_with_json(I18n.t("bigbluebutton_rails.recordings.notice.#{action.to_s}.success")) }
+        end
+
+        context "on failure" do
+          let(:bbb_error_msg) { SecureRandom.hex(250) }
+          let(:bbb_error) { BigBlueButton::BigBlueButtonException.new(bbb_error_msg) }
+          before {
+            request.env["HTTP_REFERER"] = "/any"
+            mocked_server.should_receive(:send_publish_recordings) { raise bbb_error }
+          }
+          before(:each) { post action, :id => recording.to_param, :format => 'json' }
+          it { should respond_with(:error) }
+          it { should respond_with_content_type(:json) }
+          it { should respond_with_json(bbb_error_msg[0..200]) }
+        end
+
+        context "returns error if there's no server associated" do
+          before { recording.stub(:server) { nil } }
+          before(:each) { post action, :id => recording.to_param, :format => 'json' }
+          it { should respond_with(:error) }
+          it { should respond_with_content_type(:json) }
+          it { should respond_with_json(I18n.t('bigbluebutton_rails.recordings.errors.check_for_server.no_server')) }
+        end
+      end
+    end
+
+  end
+end