bigbluebutton_rails 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+rdoc/*
+pkg
+*.sqlite3
+log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+== 0.1.0
+
+* First version
+* DB models for BigBlueButton servers and rooms
+* Controller to access servers and rooms
+* rooms_controller interacts with a BBB server using bigbluebutton-api-ruby

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    bigbluebutton_rails (0.0.1)
+      bigbluebutton-api-ruby (~> 0.0.8)
+      rails (~> 3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    bigbluebutton-api-ruby (0.0.8)
+      nokogiri (~> 1.4.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.3)
+    forgery (0.3.7)
+      nokogiri (~> 1.4)
+    generator_spec (0.8.2)
+      rails (~> 3.0)
+      rspec-rails
+    i18n (0.5.0)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    shoulda-matchers (1.0.0.beta2)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bigbluebutton_rails!
+  factory_girl (~> 1.3.2)
+  forgery (~> 0.3.7)
+  generator_spec (~> 0.8.2)
+  rspec-rails (~> 2.5.0)
+  shoulda-matchers (~> 1.0.0.beta)
+  sqlite3-ruby (~> 1.3.3)

data/README.rdoc

@@ -0,0 +1,147 @@
+= BigBlueButton on Rails
+
+BigBlueButton (http://bigbluebutton.org) integration for Ruby on Rails 3.
+
+Features:
+* Allows multiple servers and multiple conference rooms
+* Full API access using bigbluebutton-api-ruby (https://github.com/mconf/bigbluebutton-api-ruby)
+* Easy way to join conferences: simply create a room and call the "join" action
+* Easy integration with authentication and authorization mechanisms, such as Devise and CanCan
+
+Future:
+* Friendly URLs (e.g. http://somewhere.com/my-server/my-room)
+* Random meeting IDs to avoid problems with end_meeting and timeouts
+* Server administration (modify config.xml, use bbb-conf, etc.)
+
+For more future features and issues check http://code.google.com/p/mconf/issues/list?can=2&q=label%3AComponent%20label%3ABigBlueButtonRails
+
+== Installation
+
+You can install the latest version of bigbluebutton_rails using RubyGems:
+
+  gem install bigbluebutton_rails
+
+Or simply add the following line in your Gemfile:
+
+  gem "bigbluebutton_rails"
+
+After installing, you need to run the generator:
+
+  rails generate bigbluebutton_rails:install
+
+This generator will create a migration file and a locale file in your application directories.
+Take a look at the migration to see how the models used by bigbluebutton_rails look like.
+
+All models, controllers and views used are embedded in the gem, but you can replace or extend them if you need to.
+There is one generator to help you with that:
+
+  rails generate bigbluebutton_rails:views
+
+It copies all bigbluebutton_rails views into your application, so you can customize them as you wish.
+
+There is yet another generator that copies the public files (javascripts, images and stylesheets) used by bigbluebutton_rails:
+
+  rails generate bigbluebutton_rails:public
+
+For more information see the section Dependencies below.
+
+=== Routes
+
+The routes to bigbluebutton_rails can be generated with the helper "bigbluebutton_routes". See the example below:
+
+  bigbluebutton_routes :default
+
+  resources :users do
+    bigbluebutton_routes :room_matchers
+    resources :spaces do
+      bigbluebutton_routes :room_matchers
+    end
+  end
+
+The first line generates the default routes. You need to call it at least once to generate the following routes:
+
+  bigbluebutton_routes :default
+
+To have your rooms beloging to a model other than servers, use the room_matchers:
+
+  bigbluebutton_routes :room_matchers
+
+It creates routes to the actions "show", "running", "end", and "join".
+So you can allow access to webconference rooms using URLs such as:
+
+  http://myserver.com/user-10/room-5/join
+  http://myserver.com/zaphod/public-room/join
+
+PS: bigbluebutton_rails does not allows the room access using IDs such as "room-5" or "public-room" yet, but soon you it will.
+
+=== User authorization, permissions and assumptions
+
+There are some basic assumptions made by bigbluebutton_rails:
+
+* You have a method called "current_user" that returns the current user;
+* The current_user has an attribute or method called "name" that returns his/her fullname.
+
+If you don't, you can change this behaviour easily, keep reading.
+
+bigbluebutton_rails uses the methods "bigbluebutton_user" and "bigbluebutton_role(room)" to get the current user and to get the permission that the current
+user has in the "room", respectively.
+
+These methods are defined in "lib/bigbluebutton_rails/controller_methods.rb" and you can reimplement them in your application_controller to change their behaviour.
+
+
+==== Integration with Devise
+
+To be written...
+
+==== Integration with CanCan
+
+To be written...
+
+=== Dependencies
+
+For gem dependencies check the gemspec file.
+
+Files:
+
+* Javascripts:
+  * JQuery (jquery.min.js). See http://jquery.com
+  * JQuery Heartbeat plugin (heartbeat.js). See http://plugins.jquery.com/project/Heartbeat
+* Images:
+  * loading.gif
+
+All these files are used by views/bigbluebutton/rooms/join_wait and can be generated with:
+
+  rails generate bigbluebutton_rails:public
+
+== How it works
+
+bigbluebutton_rails has two entities: servers and rooms. Servers can have multiple rooms, that belong to a server and can also belong to any other model.
+You can make a room belong to a user, for example.
+
+Every server has an associated API object (using the gem bigbluebutton-api-ruby) used to access BigBlueButton.
+The server now has basically the RESTful actions defined in Rails.
+
+The rooms also have the RESTful actions, plus specific actions to "join", "end", and check if a meeting is being held currently in the room ("running").
+All actions are pretty simple. "running" returns a json indicating if the conference is running or not and "end" ends the meeting.
+The most elaborated action is "join", that does the following:
+
+* If the user is a moderator:
+  * If the rooms is not created yet, creates it.
+  * Redirects to the url to join as a moderator.
+* If the user is a normal attendee:
+  * If the rooms is running, redirects to the url to join as an attendee.
+  * Otherwise, redirects to join_wait, to wait for a moderator before joining the conference.
+
+== Development
+
+Install the dependencies:
+
+  bundle install
+
+Prepare the rails_app used for tests:
+
+  rake setup:rails_app
+
+Run the tests:
+
+  rake spec

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'rake/gempackagetask'
+
+desc 'Default: run tests.'
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BigBlueButton on Rails'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('CHANGELOG.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+eval("$specification = begin; #{ IO.read('bigbluebutton_rails.gemspec')}; end")
+Rake::GemPackageTask.new $specification do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc 'Setup RailsApp used in tests.'
+namespace "setup" do
+  task :rails_app do |app|
+    cd 'spec/rails_app/'
+    sh "rake db:drop ENV=test"
+    sh "rails destroy bigbluebutton_rails:install"
+    sh "rails generate bigbluebutton_rails:install"
+    sh "rake db:migrate ENV=test"
+    sh "rake db:test:prepare"
+  end
+end

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -0,0 +1,193 @@
+require 'bigbluebutton-api'
+
+class Bigbluebutton::RoomsController < ApplicationController
+
+  # TODO create filter find_room
+
+  before_filter :find_server
+  respond_to :html, :except => :running
+  respond_to :json, :only => :running
+
+  def index
+    # TODO restrict to rooms belonging to the selected server
+    respond_with(@rooms = BigbluebuttonRoom.all)
+  end
+
+  def show
+    respond_with(@room = BigbluebuttonRoom.find(params[:id]))
+  end
+
+  def new
+    respond_with(@room = BigbluebuttonRoom.new)
+  end
+
+  def edit
+    respond_with(@room = BigbluebuttonRoom.find(params[:id]))
+  end
+
+  def create
+    @room = BigbluebuttonRoom.new(params[:bigbluebutton_room])
+    @room.server = @server
+
+    # TODO Generate a random meeting_id everytime a room is created
+    if !params[:bigbluebutton_room].has_key?(:meeting_id) or
+        params[:bigbluebutton_room][:meeting_id].blank?
+      @room.meeting_id = @room.name
+    end
+
+    respond_with @room do |format|
+      if @room.save
+        format.html {
+          message = t('bigbluebutton_rails.rooms.notice.create.success')
+          redirect_to(bigbluebutton_server_room_path(@server, @room), :notice => message)
+        }
+      else
+        format.html { render :action => "new" }
+      end
+    end
+  end
+
+  def update
+    @room = BigbluebuttonRoom.find(params[:id])
+
+    if !params[:bigbluebutton_room].has_key?(:meeting_id) or
+        params[:bigbluebutton_room][:meeting_id].blank?
+      params[:bigbluebutton_room][:meeting_id] = params[:bigbluebutton_room][:name]
+    end
+
+    respond_with @room do |format|
+      if @room.update_attributes(params[:bigbluebutton_room])
+        format.html {
+          message = t('bigbluebutton_rails.rooms.notice.update.success')
+          redirect_to(bigbluebutton_server_room_path(@server, @room), :notice => message)
+        }
+      else
+        format.html { render :action => "edit" }
+      end
+    end
+  end
+
+  def destroy
+    @room = BigbluebuttonRoom.find(params[:id])
+
+    # TODO Destroy room even if end_meeting failed?
+
+    begin
+      bbb_end_meeting if bbb_is_meeting_running?
+    rescue BigBlueButton::BigBlueButtonException => e
+      flash[:error] = e.to_s
+      # TODO Better error message: "Room destroyed in DB, but not in BBB..."
+    end
+
+    @room.destroy
+    redirect_to(bigbluebutton_server_rooms_url)
+  end
+
+  def join
+    @room = BigbluebuttonRoom.find(params[:id])
+    role = bigbluebutton_role(@room)
+
+    begin
+
+      # if the current user is a moderator, create the room (if needed)
+      # and join it
+      if role == :moderator
+        bbb_create_room unless bbb_is_meeting_running?
+        join_url = bbb_join_url(bigbluebutton_user.name, role)
+        redirect_to(join_url)
+
+      # normal user only joins if the conference is running
+      # if it's not, wait for a moderator to create the conference
+      else
+        if bbb_is_meeting_running?
+          join_url = bbb_join_url(bigbluebutton_user.name, role)
+          redirect_to(join_url)
+        else
+          render :action => :join_wait
+        end
+      end
+
+    rescue BigBlueButton::BigBlueButtonException => e
+      flash[:error] = e.to_s
+      redirect_to request.referer
+    end
+
+  end
+
+  def join_wait
+  end
+
+  def running
+    @room = BigbluebuttonRoom.find(params[:id])
+
+    begin
+      run = bbb_is_meeting_running?
+    rescue BigBlueButton::BigBlueButtonException => e
+      flash[:error] = e.to_s
+      render :json => { running: "false", error: "#{e.to_s}" }
+      #redirect_to request.referer
+    else
+      render :json => { running: "#{run}" }
+    end
+
+  end
+
+  def end
+    @room = BigbluebuttonRoom.find(params[:id])
+
+    begin
+      if bbb_is_meeting_running?
+        bbb_end_meeting
+        message = t('bigbluebutton_rails.rooms.notice.end.success')
+      else
+        message = t('bigbluebutton_rails.rooms.notice.end.not_running')
+      end
+    rescue BigBlueButton::BigBlueButtonException => e
+      flash[:error] = e.to_s
+      redirect_to request.referer
+    else
+      redirect_to(bigbluebutton_server_room_path(@server, @room), :notice => message)
+    end
+
+  end
+
+  protected
+
+  def find_server
+    if params.has_key?(:server_id)
+      @server = BigbluebuttonServer.find(params[:server_id])
+    else
+      @server = BigbluebuttonServer.first
+    end
+  end
+
+
+  #
+  # Functions that directly call the BBB API. All prefixed with bbb_
+  #
+
+  def bbb_is_meeting_running?
+    @server.api.is_meeting_running?(@room.meeting_id)
+  end
+
+  def bbb_end_meeting
+    @server.api.end_meeting(@room.meeting_id, @room.moderator_password)
+  end
+
+  def bbb_create_room
+    @server.api.create_meeting(@room.name, @room.meeting_id,
+                               @room.moderator_password, @room.attendee_password,
+                               @room.welcome_msg)
+  end
+
+  def bbb_join_url(username, role)
+    if role == :moderator
+      @server.api.join_meeting_url(@room.meeting_id, username,
+                                   @room.moderator_password)
+    else
+      @server.api.join_meeting_url(@room.meeting_id, username,
+                                   @room.attendee_password)
+    end
+  end
+
+end