bigbluebutton_rails 0.0.5 → 0.0.6

data/.gitignore

@@ -5,3 +5,5 @@ pkg
 log
 *.gem
 spec/integration_conf.yml
+coverage/
+rails_best_practices_output.html

data/.rvmrc

@@ -0,0 +1,6 @@
+#!/bin/bash
+if [ -e '.rvmrc_custom' ]; then
+  source .rvmrc_custom;
+else
+  rvm --create use 1.9.2@bigbluebutton_rails;
+fi

data/.travis.yml

@@ -0,0 +1,4 @@
+script: "bundle exec rake setup:rails_app setup:rails_app:db spec"
+rvm:
+  - 1.8.7
+  - 1.9.2

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.0.6
+
+* After fetch_meetings, the rooms that are not found in the DB are *not* saved by default anymore.
+* New action to join external rooms (rooms that are not in the DB but exist in the BBB server).
+* Fixed some errors and warnings for Ruby 1.8.
+* Some changes in the logic of RoomsController#auth to enable a user to join a room that has a blank password.
+* Improvements in the mobile_join view to show a link that includes user authentication. But the QR code is still a bare link to the BBB server.
+* Made some improvements based on tips by rails_best_practices and increased the test coverage to 100% for almost all classes.
+
 == 0.0.5
 
 * URLs for both servers and rooms are now defined with a string attribute (called "param") instead of the model ID.

data/Gemfile

@@ -2,3 +2,21 @@ source 'http://rubygems.org'
 
 gemspec
 
+group :development, :test do
+  gem "rspec-rails"
+  gem "factory_girl"
+  gem "sqlite3-ruby"
+  gem "generator_spec"
+  gem "shoulda-matchers"
+  gem "forgery"
+  gem "cucumber-rails"
+  gem "database_cleaner"
+  gem "rdoc"
+  gem "rails_best_practices"
+end
+
+group :test do
+  if RUBY_VERSION >= "1.9"
+    gem 'simplecov', '>= 0.4.0', :require => false
+  end
+end

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (0.0.5)
-      bigbluebutton-api-ruby (~> 0.0.10)
+    bigbluebutton_rails (0.0.6)
+      bigbluebutton-api-ruby (~> 0.0.11)
       rails (>= 3.0.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.6)
-      actionpack (= 3.0.6)
-      mail (~> 2.2.15)
-    actionpack (3.0.6)
-      activemodel (= 3.0.6)
-      activesupport (= 3.0.6)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.5.0)
@@ -22,21 +22,21 @@ GEM
       rack-mount (~> 0.6.14)
       rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.6)
-      activesupport (= 3.0.6)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.6)
-      activemodel (= 3.0.6)
-      activesupport (= 3.0.6)
-      arel (~> 2.0.2)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.6)
-      activemodel (= 3.0.6)
-      activesupport (= 3.0.6)
-    activesupport (3.0.6)
-    arel (2.0.9)
-    bigbluebutton-api-ruby (0.0.10)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    bigbluebutton-api-ruby (0.0.11)
       nokogiri (~> 1.4.0)
     builder (2.1.2)
     capybara (1.0.0)
@@ -46,63 +46,73 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 0.2.0)
       xpath (~> 0.1.4)
-    childprocess (0.1.9)
+    childprocess (0.2.0)
       ffi (~> 1.0.6)
-    cucumber (0.10.7)
+    colored (1.2)
+    cucumber (1.0.2)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.0)
+      gherkin (~> 2.4.5)
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.5)
-    cucumber-rails (0.5.2)
-      capybara (>= 1.0.0.rc1)
-      cucumber (>= 0.10.5)
-      nokogiri (>= 1.4.4)
-      rack-test (>= 0.5.7)
+    cucumber-rails (1.0.2)
+      capybara (>= 1.0.0)
+      cucumber (~> 1.0.0)
+      nokogiri (>= 1.4.6)
     database_cleaner (0.6.7)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    factory_girl (1.3.3)
+    factory_girl (2.0.2)
     ffi (1.0.9)
-    forgery (0.3.7)
+    forgery (0.3.12)
       nokogiri (~> 1.4)
-    generator_spec (0.8.2)
+    generator_spec (0.8.3)
       rails (~> 3.0)
       rspec-rails
-    gherkin (2.4.0)
+    gherkin (2.4.5)
       json (>= 1.4.6)
+    haml (3.1.2)
     i18n (0.5.0)
-    json (1.5.2)
-    json_pure (1.5.2)
-    mail (2.2.15)
+    json (1.5.3)
+    json_pure (1.5.3)
+    mail (2.2.19)
       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)
+    nokogiri (1.4.7)
+    polyglot (0.3.2)
     rack (1.2.3)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.6)
-      actionmailer (= 3.0.6)
-      actionpack (= 3.0.6)
-      activerecord (= 3.0.6)
-      activeresource (= 3.0.6)
-      activesupport (= 3.0.6)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
       bundler (~> 1.0)
-      railties (= 3.0.6)
-    railties (3.0.6)
-      actionpack (= 3.0.6)
-      activesupport (= 3.0.6)
+      railties (= 3.0.9)
+    rails_best_practices (0.10.1)
+      activesupport
+      colored
+      erubis
+      haml
+      i18n
+      ruby-progressbar
+      ruby_parser
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
       rake (>= 0.8.7)
+      rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (0.8.7)
-    rdoc (3.6.1)
+    rake (0.9.2)
+    rdoc (3.9.1)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -116,21 +126,29 @@ GEM
       activesupport (~> 3.0)
       railties (~> 3.0)
       rspec (~> 2.6.0)
+    ruby-progressbar (0.0.10)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
     rubyzip (0.9.4)
-    selenium-webdriver (0.2.1)
-      childprocess (>= 0.1.7)
+    selenium-webdriver (0.2.2)
+      childprocess (>= 0.1.9)
       ffi (>= 1.0.7)
       json_pure
       rubyzip
-    shoulda-matchers (1.0.0.beta2)
-    sqlite3 (1.3.3)
+    sexp_processor (3.0.5)
+    shoulda-matchers (1.0.0.beta3)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+    sqlite3 (1.3.4)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
-    term-ansicolor (1.0.5)
+    term-ansicolor (1.0.6)
     thor (0.14.6)
-    treetop (1.4.9)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.28)
+    tzinfo (0.3.29)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -139,12 +157,14 @@ PLATFORMS
 
 DEPENDENCIES
   bigbluebutton_rails!
-  cucumber-rails (~> 0.5.2)
-  database_cleaner (~> 0.6.7)
-  factory_girl (~> 1.3.2)
-  forgery (~> 0.3.7)
-  generator_spec (~> 0.8.2)
-  rdoc (~> 3.6.0)
-  rspec-rails (~> 2.6.0)
-  shoulda-matchers (~> 1.0.0.beta)
-  sqlite3-ruby (~> 1.3.3)
+  cucumber-rails
+  database_cleaner
+  factory_girl
+  forgery
+  generator_spec
+  rails_best_practices
+  rdoc
+  rspec-rails
+  shoulda-matchers
+  simplecov (>= 0.4.0)
+  sqlite3-ruby

data/README.rdoc

@@ -1,4 +1,5 @@
 = BigBlueButton on Rails
+http://travis-ci.org/mconf/bigbluebutton_rails.png {(more...)}[http://travis-ci.org/#!/mconf/bigbluebutton_rails]
 
 {BigBlueButton}[http://bigbluebutton.org] integration for Ruby on Rails 3.
 
@@ -181,6 +182,28 @@ Run the tests:
   rake spec
   rake cucumber
 
+Or simply:
+
+  rake
+
 Develop. :)
 
 If you want your code to be integrated in this repository, please create a branch with your modifications and submit a pull request.
+
+=== Test Coverage
+
+Coverage is analyzed by default when you run:
+
+  rake spec
+
+Run it and look at the file <tt>coverage/index.html</tt>.
+
+=== Best Practices
+
+We use the gem <tt>rails_best_practices</tt> to get some nice tips on how to improve the code.
+
+Run:
+
+  rake best_practices
+
+And look at the file <tt>rails_best_practices_output.html</tt> to see the tips.

data/Rakefile

@@ -30,23 +30,25 @@ end
 desc 'Setup RailsApp used in tests.'
 namespace :setup do
   task :rails_app do |app|
-    cd "spec/rails_app/"
+    cd File.join(File.dirname(__FILE__), "spec", "rails_app")
     sh "rails destroy bigbluebutton_rails:install"
     sh "rails generate bigbluebutton_rails:install"
+    cd File.dirname(__FILE__)
   end
 
   namespace :rails_app do |app|
     task :db do
+      cd File.join(File.dirname(__FILE__), "spec", "rails_app")
       # base
-      cd "spec/rails_app/"
       sh "rake db:drop:all"
       sh "rake db:create:all"
-      # test
-      sh "rake db:migrate RAILS_ENV=test"
-      sh "rake db:test:prepare RAILS_ENV=test"
       # development
       sh "rake db:migrate RAILS_ENV=development"
       sh "rake db:seed RAILS_ENV=development"
+      # test
+      sh "rake db:migrate RAILS_ENV=test"
+      sh "rake db:test:prepare RAILS_ENV=test"
+      cd File.dirname(__FILE__)
     end
   end
 end
@@ -57,7 +59,9 @@ task :cucumber do
     sh %{ cucumber features/ }
   end
   puts "* Dummy app features"
-  sh %{ cd spec/rails_app; cucumber features/ }
+  cd File.join(File.dirname(__FILE__), "spec", "rails_app")
+  sh "cucumber features/"
+  cd File.dirname(__FILE__)
 end
 
 task :notes do
@@ -88,3 +92,10 @@ namespace :spec do
     sh "rails destroy bigbluebutton_rails:install 0.0.4"
   end
 end
+
+task :best_practices do |app|
+  sh "rails_best_practices -f html --spec &>/dev/null"
+  puts
+  puts "Output will be in the file rails_best_practices_output.html"
+  puts
+end

data/app/controllers/bigbluebutton/rooms_controller.rb

@@ -1,10 +1,11 @@
-require 'bigbluebutton-api'
+require 'bigbluebutton_api'
 
 class Bigbluebutton::RoomsController < ApplicationController
 
   before_filter :find_server
+  before_filter :find_room, :only => [:show, :edit, :update, :destroy, :join, :invite, :running, :end, :destroy, :end, :join_mobile]
   respond_to :html, :except => :running
-  respond_to :json, :only => [:running, :show, :new, :index, :create, :update, :end, :destroy]
+  respond_to :json, :only => [:running, :show, :new, :index, :create, :update]
 
   def index
     # TODO restrict to rooms belonging to the selected server
@@ -12,7 +13,7 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def show
-    respond_with(@room = BigbluebuttonRoom.find_by_param(params[:id]))
+    respond_with(@room)
   end
 
   def new
@@ -20,14 +21,13 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def edit
-    respond_with(@room = BigbluebuttonRoom.find_by_param(params[:id]))
+    respond_with(@room)
   end
 
   def create
     @room = BigbluebuttonRoom.new(params[:bigbluebutton_room])
     @room.server = @server
 
-    # TODO Generate a random meetingid everytime a room is created
     if !params[:bigbluebutton_room].has_key?(:meetingid) or
         params[:bigbluebutton_room][:meetingid].blank?
       @room.meetingid = @room.name
@@ -47,7 +47,7 @@ class Bigbluebutton::RoomsController < ApplicationController
             message = t('bigbluebutton_rails.rooms.notice.create.failure')
             redirect_to params[:redir_url], :error => message
           else
-            render :action => "new"
+            render :new
           end
         }
         format.json { render :json => @room.errors.full_messages, :status => :unprocessable_entity }
@@ -56,8 +56,6 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def update
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     if !params[:bigbluebutton_room].has_key?(:meetingid) or
         params[:bigbluebutton_room][:meetingid].blank?
       params[:bigbluebutton_room][:meetingid] = params[:bigbluebutton_room][:name]
@@ -77,7 +75,7 @@ class Bigbluebutton::RoomsController < ApplicationController
             message = t('bigbluebutton_rails.rooms.notice.update.failure')
             redirect_to params[:redir_url], :error => message
           else
-            render :action => "edit"
+            render :edit
           end
         }
         format.json { render :json => @room.errors.full_messages, :status => :unprocessable_entity }
@@ -86,8 +84,6 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def destroy
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     # TODO Destroy the room record even if end_meeting failed?
 
     error = false
@@ -119,8 +115,6 @@ class Bigbluebutton::RoomsController < ApplicationController
 
   # Used by logged users to join public rooms.
   def join
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     role = bigbluebutton_role(@room)
     if role.nil?
       raise BigbluebuttonRails::RoomAccessDenied.new
@@ -136,8 +130,6 @@ class Bigbluebutton::RoomsController < ApplicationController
 
   # Used to join private rooms or to invited anonymous users (not logged)
   def invite
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     respond_with @room do |format|
 
       role = bigbluebutton_role(@room)
@@ -156,9 +148,54 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   # Authenticates an user using name and password passed in the params from #invite
+  # Uses params[:id] to get the target room
   def auth
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
+    @room = BigbluebuttonRoom.find_by_param(params[:id]) unless params[:id].blank?
+    if @room.nil?
+      message = t('bigbluebutton_rails.rooms.errors.auth.wrong_params')
+      redirect_to request.referer, :notice => message
+      return
+    end
+
+    name = bigbluebutton_user.nil? ? params[:user][:name] : bigbluebutton_user.name
+    role = bigbluebutton_role(@room)
+    if role.nil?
+      raise BigbluebuttonRails::RoomAccessDenied.new
+    elsif role == :password
+      role = @room.user_role(params[:user])
+    end
+
+    unless role.nil? or name.nil?
+      join_internal(name, role, :invite)
+    else
+      flash[:error] = t('bigbluebutton_rails.rooms.errors.auth.failure')
+      render :invite, :status => :unauthorized
+    end
+  end
+
+  def external
+    if params[:meeting].blank?
+      message = t('bigbluebutton_rails.rooms.errors.external.blank_meetingid')
+      params[:redir_url] ||= bigbluebutton_server_rooms_path(@server)
+      redirect_to params[:redir_url], :notice => message
+    end
+    @room = BigbluebuttonRoom.new(:meetingid => params[:meeting])
+  end
+
+  # Authenticates an user using name and password passed in the params from #external
+  # Uses params[:meeting] to get the meetingID of the target room
+  def external_auth
+    @room = nil
+    if !params[:meeting].blank? && !params[:user].blank?
+      @server.fetch_meetings
+      @room = @server.meetings.select{ |r| r.meetingid == params[:meeting] }.first
+    else
+      message = t('bigbluebutton_rails.rooms.errors.auth.wrong_params')
+      redirect_to request.referer, :notice => message
+      return
+    end
 
+    # This is just to check if the room is not blocked, not to get the actual role
     raise BigbluebuttonRails::RoomAccessDenied.new if bigbluebutton_role(@room).nil?
 
     # if there's a user logged, use his name instead of the name in the params
@@ -166,16 +203,21 @@ class Bigbluebutton::RoomsController < ApplicationController
     role = @room.user_role(params[:user])
 
     unless role.nil? or name.nil?
-      join_internal(name, role, :invite)
+      @room.fetch_meeting_info
+      if @room.is_running?
+        join_url = @room.join_url(name, role)
+        redirect_to(join_url)
+      else
+        flash[:error] = t('bigbluebutton_rails.rooms.errors.auth.not_running')
+        render :external
+      end
     else
       flash[:error] = t('bigbluebutton_rails.rooms.errors.auth.failure')
-      render :action => "invite", :status => :unauthorized
+      render :external, :status => :unauthorized
     end
   end
 
   def running
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     begin
       @room.fetch_is_running?
     rescue BigBlueButton::BigBlueButtonException => e
@@ -184,12 +226,9 @@ class Bigbluebutton::RoomsController < ApplicationController
     else
       render :json => { :running => "#{@room.is_running?}" }
     end
-
   end
 
   def end
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-
     error = false
     begin
       @room.fetch_is_running?
@@ -225,13 +264,21 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def join_mobile
-    @room = BigbluebuttonRoom.find_by_param(params[:id])
-    @join_url = @room.join_url(bigbluebutton_user.name, bigbluebutton_role(@room))
-    @join_url.gsub!("http://", "bigbluebutton://")
+    @join_url = join_bigbluebutton_server_room_path(@server, @room, :mobile => '1')
+    @join_url.gsub!(/http:\/\//i, "bigbluebutton://")
+
+    # TODO: we can't use the mconf url because the mobile client scanning the qrcode is not
+    # logged. so we are using the full BBB url for now.
+    @qrcode_url = @room.join_url(bigbluebutton_user.name, bigbluebutton_role(@room))
+    @qrcode_url.gsub!("http://", "bigbluebutton://")
   end
 
   protected
 
+  def find_room
+    @room = BigbluebuttonRoom.find_by_param(params[:id])
+  end
+
   def find_server
     if params.has_key?(:server_id)
       @server = BigbluebuttonServer.find_by_param(params[:server_id])
@@ -241,45 +288,19 @@ class Bigbluebutton::RoomsController < ApplicationController
   end
 
   def join_internal(username, role, wait_action)
-
     begin
-      @room.fetch_is_running?
-
-      # if the current user is a moderator, create the room (if needed)
-      # and join it
-      if role == :moderator
-
-        add_domain_to_logout_url(@room, request.protocol, request.host)
-
-        @room.send_create unless @room.is_running?
-        join_url = @room.join_url(username, 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
+      url = @room.perform_join(username, role, request)
+      unless url.nil?
+        url.gsub!(/http:\/\//i, "bigbluebutton://") if BigbluebuttonRails::value_to_boolean(params[:mobile])
+        redirect_to(url)
       else
-        if @room.is_running?
-          join_url = @room.join_url(username, role)
-          redirect_to(join_url)
-        else
-          flash[:error] = t('bigbluebutton_rails.rooms.errors.auth.not_running')
-          render :action => wait_action
-        end
+        flash[:error] = t('bigbluebutton_rails.rooms.errors.auth.not_running')
+        render wait_action
       end
-
     rescue BigBlueButton::BigBlueButtonException => e
       flash[:error] = e.to_s
       redirect_to request.referer
     end
   end
 
-  def add_domain_to_logout_url(room, protocol, host)
-    unless @room.logout_url.nil? or @room.logout_url =~ /^[a-z]+:\/\//  # matches the protocol
-      unless @room.logout_url =~ /^[a-z0-9]+([\-\.]{ 1}[a-z0-9]+)*/     # matches the host domain
-        @room.logout_url = host + @room.logout_url
-      end
-      @room.logout_url = protocol + @room.logout_url
-    end
-  end
-
 end