bigbluebutton_rails 0.0.5 → 0.0.6

data/app/controllers/bigbluebutton/servers_controller.rb

@@ -1,14 +1,15 @@
 class Bigbluebutton::ServersController < ApplicationController
 
   respond_to :html
-  respond_to :json, :only => [:index, :show, :new, :create, :update, :destroy]
+  respond_to :json, :only => [:index, :show, :new, :create, :update, :destroy, :activity]
+  before_filter :find_server, :only => [:show, :edit, :activity, :update, :destroy]
 
   def index
     respond_with(@servers = BigbluebuttonServer.all)
   end
 
   def show
-    respond_with(@server = BigbluebuttonServer.find_by_param(params[:id]))
+    respond_with(@server)
   end
 
   def new
@@ -16,31 +17,43 @@ class Bigbluebutton::ServersController < ApplicationController
   end
 
   def edit
-    respond_with(@server = BigbluebuttonServer.find_by_param(params[:id]))
+    respond_with(@server)
   end
 
   def activity
-    @server = BigbluebuttonServer.find_by_param(params[:id])
-    # @new_meetings = @server.rooms
-    @server.fetch_meetings
-    # @new_meetings = @server.meetings.reject{ |r|
-    #  i = @new_meetings.index(r)
-    #  i.nil? ? false : r.attr_equal?(@new_meetings[i])
-    #}
-    @server.meetings.each do |meeting|
-      meeting.fetch_meeting_info
+    error = false
+    begin
+      @server.fetch_meetings
+      @server.meetings.each do |meeting|
+        meeting.fetch_meeting_info
+      end
+    rescue BigBlueButton::BigBlueButtonException => e
+      error = true
+      message = e.to_s
     end
 
-    # TODO catch exceptions
-
-    if params[:update_list]
-      render :partial => 'activity_list'
+    # update_list works only for html
+    if params[:update_list] && (params[:format].nil? || params[:format].to_s == "html")
+      render :html => 'activity_list', :server => @server
       return
     end
 
-    # TODO json response
-
-    respond_with(@server)
+    respond_with @server.meetings do |format|
+      # we return/render the fetched meetings even in case of error
+      # but we set the error message in the response
+      if error
+        flash[:error] = message
+        format.html { render :activity }
+        format.json {
+          array = @server.meetings
+          array.insert(0, { :message => message })
+          render :json => array, :status => :error
+        }
+      else
+        format.html
+        format.json
+      end
+    end
   end
 
   def create
@@ -54,15 +67,13 @@ class Bigbluebutton::ServersController < ApplicationController
         }
         format.json { render :json => @server, :status => :created }
       else
-        format.html { render :action => "new" }
+        format.html { render :new }
         format.json { render :json => @server.errors.full_messages, :status => :unprocessable_entity }
       end
     end
   end
 
   def update
-    @server = BigbluebuttonServer.find_by_param(params[:id])
-
     respond_with @server do |format|
       if @server.update_attributes(params[:bigbluebutton_server])
         format.html {
@@ -71,14 +82,13 @@ class Bigbluebutton::ServersController < ApplicationController
         }
         format.json { head :ok }
       else
-        format.html { render :action => "edit" }
+        format.html { render :edit }
         format.json { render :json => @server.errors.full_messages, :status => :unprocessable_entity }
       end
     end
   end
 
   def destroy
-    @server = BigbluebuttonServer.find_by_param(params[:id])
     @server.destroy
 
     respond_with do |format|
@@ -86,4 +96,11 @@ class Bigbluebutton::ServersController < ApplicationController
       format.json { head :ok }
     end
   end
+
+  protected
+
+  def find_server
+    @server = BigbluebuttonServer.find_by_param(params[:id])
+  end
+
 end

data/app/models/bigbluebutton_room.rb

@@ -131,7 +131,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
     unless response.nil?
       self.attendee_password = response[:attendeePW]
       self.moderator_password = response[:moderatorPW]
-      self.save
+      self.save unless self.new_record?
     end
 
     response
@@ -140,13 +140,17 @@ class BigbluebuttonRoom < ActiveRecord::Base
   # Returns the URL to join this room.
   # username:: Name of the user
   # role:: Role of the user in this room. Can be <tt>[:moderator, :attendee]</tt>
+  # password:: Password to be use (in case role == nil)
   #
   # Uses the API but does not require a request to the server.
-  def join_url(username, role)
-    if role == :moderator
+  def join_url(username, role, password=nil)
+    case role
+    when :moderator
       self.server.api.join_meeting_url(self.meetingid, username, self.moderator_password)
-    else
+    when :attendee
       self.server.api.join_meeting_url(self.meetingid, username, self.attendee_password)
+    else
+      self.server.api.join_meeting_url(self.meetingid, username, password)
     end
   end
 
@@ -191,6 +195,42 @@ class BigbluebuttonRoom < ActiveRecord::Base
     self.param
   end
 
+  # The join logic
+  # A moderator can create the meeting and join
+  # An attendee can only join if the meeting is running
+  def perform_join(username, role, request=nil)
+    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(request.protocol, request.host) unless request.nil?
+      send_create unless is_running?
+      ret = join_url(username, role)
+
+    # normal user only joins if the conference is running
+    # if it's not, wait for a moderator to create the conference
+    else
+      ret = join_url(username, role) if is_running?
+    end
+
+    ret
+  end
+
+  # add a domain name and/or protocol to the logout_url if needed
+  def add_domain_to_logout_url(protocol, host)
+    unless logout_url.nil?
+      url = logout_url.downcase
+      unless url.nil? or url =~ /^[a-z]+:\/\//           # matches the protocol
+        unless url =~ /^[a-z0-9]+([\-\.]{1}[a-z0-9]+)*/  # matches the host domain
+          url = host + url
+        end
+        url = protocol + url
+      end
+      update_attributes(:logout_url => url.downcase)
+    end
+  end
+
   protected
 
   def init
@@ -219,7 +259,7 @@ class BigbluebuttonRoom < ActiveRecord::Base
 
   def random_voice_bridge
     value = (70000 + ActiveSupport::SecureRandom.random_number(9999)).to_s
-    count = 0
+    count = 1
     while not BigbluebuttonRoom.find_by_voice_bridge(value).nil? and count < 10
       count += 1
       value = (70000 + ActiveSupport::SecureRandom.random_number(9999)).to_s

data/app/models/bigbluebutton_server.rb

@@ -1,4 +1,4 @@
-require 'bigbluebutton-api'
+require 'bigbluebutton_api'
 
 class BigbluebuttonServer < ActiveRecord::Base
   has_many :rooms,
@@ -65,18 +65,16 @@ class BigbluebuttonServer < ActiveRecord::Base
     response[:meetings].each do |attr|
       room = BigbluebuttonRoom.find_by_server_id_and_meetingid(self.id, attr[:meetingID])
       if room.nil?
-        room = BigbluebuttonRoom.create(:server => self, :meetingid => attr[:meetingID],
-                                        :name => attr[:meetingID], :attendee_password => attr[:attendeePW],
-                                        :moderator_password => attr[:moderatorPW], :external => true,
-                                        :randomize_meetingid => false)
+        room = BigbluebuttonRoom.new(:server => self, :meetingid => attr[:meetingID],
+                                     :name => attr[:meetingID], :attendee_password => attr[:attendeePW],
+                                     :moderator_password => attr[:moderatorPW], :external => true,
+                                     :randomize_meetingid => false, :private => true)
       else
         room.update_attributes(:attendee_password => attr[:attendeePW],
                                :moderator_password => attr[:moderatorPW])
       end
       room.running = attr[:running]
 
-      # TODO What if the update/save above fails?
-
       @meetings << room
     end
   end

data/app/views/bigbluebutton/rooms/external.html.erb

@@ -0,0 +1,24 @@
+<h1>Join the meeting <%= @room.name %></h1>
+
+<p id="error"><%= flash[:error] %></p>
+
+<p>This meeting was created from another application.<br/>You must provide a name and a password to join:</p>
+
+<%= form_tag external_bigbluebutton_server_rooms_path(@server) do %>
+  <%= hidden_field_tag "meeting", params[:meeting] %>
+
+  <div class="field">
+    Name:<br />
+    <% if bigbluebutton_user.nil? %>
+      <%= text_field_tag "user[name]", "" %>
+    <% else %>
+      <%= text_field_tag "user[name]", bigbluebutton_user.name %>
+    <% end %>
+  </div>
+  <div class="field">
+    Password:<br />
+    <%= password_field_tag "user[password]", "" %>
+  </div>
+
+  <%= submit_tag "Submit" %>
+<% end %>

data/app/views/bigbluebutton/rooms/join_mobile.html.erb

@@ -3,7 +3,7 @@
 <div style="text-align:center; width:250px;">
   <a href="<%= @join_url %>"><b>Click here</b><br/>to join from a mobile device</a><br><br/>
   <span>Or scan the code below:</span><br/>
-  <img src="<%= qrcode_url(@join_url) %>" style="float:left; border:1px solid #ccc;"/>
+  <img src="<%= qrcode_url(@qrcode_url) %>" style="float:left; border:1px solid #ccc;"/>
 </div>
 
 

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

@@ -1,16 +1,16 @@
-<% @server.meetings.each do |room| %>
+<% server.meetings.each do |room| %>
   <div class="bbbrails_meeting_description">
     <div class="title_bar">
       <% unless room.new_record? %>
         <div class="button_bar">
-          <%= link_to 'Show', bigbluebutton_server_room_path(@server, room) %>
-          <%= link_to 'Edit', edit_bigbluebutton_server_room_path(@server, room) %>
-          <%= link_to 'Destroy', bigbluebutton_server_room_path(@server, room), :confirm => 'Are you sure?', :method => :delete %>
+          <%= link_to 'Show', bigbluebutton_server_room_path(server, room) %>
+          <%= link_to 'Edit', edit_bigbluebutton_server_room_path(server, room) %>
+          <%= link_to 'Destroy', bigbluebutton_server_room_path(server, room), :confirm => 'Are you sure?', :method => :delete %>
         </div>
         <div class="button_bar">
-          <%= link_to 'Join', join_bigbluebutton_server_room_path(@server, room) %>
-          <%= link_to 'Mobile Join', join_mobile_bigbluebutton_server_room_path(@server, room) %>
-          <%= link_to 'End', end_bigbluebutton_server_room_path(@server, room), :confirm => 'Are you sure?' %>
+          <%= link_to 'Join', join_bigbluebutton_server_room_path(server, room) %>
+          <%= link_to 'Mobile Join', join_mobile_bigbluebutton_server_room_path(server, room) %>
+          <%= link_to 'End', end_bigbluebutton_server_room_path(server, room), :confirm => 'Are you sure?' %>
         </div>
       <% end %>
       <b><%= room.name %></b> (ID: <%= room.meetingid %>) -

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

@@ -47,5 +47,5 @@
 <h1>Server activity monitor:</h1>
 
 <div id="bbbrails_server_activity_meetings">
-  <%= render :partial => 'activity_list' %>
+  <%= render 'activity_list', :server => @server %>
 </div>

data/bigbluebutton_rails.gemspec

@@ -15,16 +15,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency("rails", ">= 3.0.3")
-  s.add_runtime_dependency("bigbluebutton-api-ruby", "~> 0.0.10")
-
-  s.add_development_dependency("rspec-rails", "~> 2.6.0")
-  s.add_development_dependency("factory_girl", "~> 1.3.2")
-  s.add_development_dependency("sqlite3-ruby", "~> 1.3.3")
-  s.add_development_dependency("generator_spec", "~> 0.8.2")
-  s.add_development_dependency("shoulda-matchers", "~> 1.0.0.beta")
-  s.add_development_dependency("forgery", "~> 0.3.7")
-  s.add_development_dependency("cucumber-rails", "~> 0.5.2")
-  s.add_development_dependency("database_cleaner", "~> 0.6.7")
-  s.add_development_dependency("rdoc", "~> 3.6.0")
+  s.add_dependency("rails", ">= 3.0.3")
+  s.add_dependency("bigbluebutton-api-ruby", "~> 0.0.11")
 end

data/config/locales/en.yml

@@ -27,6 +27,9 @@ en:
         auth:
           failure: "Authentication failure."
           not_running: "The meeting is not running. You must wait for a moderator to join."
+          wrong_params: "Wrong params in your request."
+        external:
+          blank_meetingid: "You must specify the meetingid of the meeting you want to join"
         param_format: 'you can only use letters, numbers and the symbols "-" or "_" (not at the begin or end)'
 
   activerecord:

data/lib/bigbluebutton_rails/rails/routes.rb

@@ -83,12 +83,18 @@ module ActionDispatch::Routing
         resources :servers, :controller => BigbluebuttonRails.controllers[:servers] do
           get :activity, :on => :member
           resources :rooms, :controller => BigbluebuttonRails.controllers[:rooms] do
-            get :join, :on => :member
-            get :running, :on => :member
-            get :end, :on => :member
-            get :invite, :on => :member
-            get :join_mobile, :on => :member
-            post :join, :on => :member, :action => :auth
+            collection do
+              get :external
+              post :external, :action => :external_auth
+            end
+            member do
+              get :join
+              get :running
+              get :end
+              get :invite
+              get :join_mobile
+              post :join, :action => :auth
+            end
           end
         end
       end

data/lib/bigbluebutton_rails/utils.rb

@@ -0,0 +1,8 @@
+module BigbluebuttonRails
+
+  # 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 = "0.0.5".freeze
+  VERSION = "0.0.6".freeze
 end

data/lib/bigbluebutton_rails.rb

@@ -4,6 +4,7 @@ require 'classes/bigbluebutton_attendee'
 
 module BigbluebuttonRails
   require 'bigbluebutton_rails/rails'
+  require 'bigbluebutton_rails/utils'
   require 'bigbluebutton_rails/controller_methods'
   require 'bigbluebutton_rails/rails/routes'
   require 'bigbluebutton_rails/exceptions'

data/spec/bigbluebutton_rails_spec.rb

@@ -8,4 +8,17 @@ describe BigbluebuttonRails do
   it "should have an engine" do
     BigbluebuttonRails::Engine.new.should be_a_kind_of(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

data/spec/controllers/bigbluebutton/rooms_controller_exception_handling_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe Bigbluebutton::RoomsController do
+  render_views
+  let(:server) { Factory.create(:bigbluebutton_server) }
+  let(:room) { Factory.create(:bigbluebutton_room, :server => server) }
+
+  # make sure that the exceptions thrown by bigbluebutton-api-ruby are treated by the controller
+  context "exception handling" do
+    let(:bbb_error_msg) { "err msg" }
+    let(:bbb_error) { BigBlueButton::BigBlueButtonException.new(bbb_error_msg) }
+    let(:http_referer) { bigbluebutton_server_path(mocked_server) }
+    before {
+      mock_server_and_api
+      request.env["HTTP_REFERER"] = http_referer
+    }
+
+    describe "#destroy" do
+      it "catches exception on is_meeting_running" do
+        mocked_api.should_receive(:is_meeting_running?) { raise bbb_error }
+      end
+
+      it "catches exception on end_meeting" do
+        mocked_api.should_receive(:is_meeting_running?).and_return(true)
+        mocked_api.should_receive(:end_meeting) { raise bbb_error }
+      end
+
+      after :each do
+        delete :destroy, :server_id => mocked_server.to_param, :id => room.to_param
+        should respond_with(:redirect)
+        should redirect_to bigbluebutton_server_rooms_url
+        should set_the_flash.to(bbb_error_msg)
+      end
+    end
+
+    describe "#running" do
+      before { mocked_api.should_receive(:is_meeting_running?) { raise bbb_error } }
+      before(:each) { get :running, :server_id => mocked_server.to_param, :id => room.to_param }
+      it { should respond_with(:success) }
+      it { response.body.should == build_running_json(false, bbb_error_msg) }
+      it { should set_the_flash.to(bbb_error_msg) }
+    end
+
+    describe "#end" do
+      it "catches exception on is_meeting_running" do
+        mocked_api.should_receive(:is_meeting_running?) { raise bbb_error }
+      end
+
+      it "catches exception on end_meeting" do
+        mocked_api.should_receive(:is_meeting_running?).and_return(true)
+        mocked_api.should_receive(:end_meeting) { raise bbb_error }
+      end
+
+      after :each do
+        get :end, :server_id => mocked_server.to_param, :id => room.to_param
+        should respond_with(:redirect)
+        should redirect_to(http_referer)
+        should set_the_flash.to(bbb_error_msg)
+      end
+    end
+
+    describe "#join" do
+      before { controller.stub(:bigbluebutton_user) { Factory.build(:user) } }
+
+      context "as moderator" do
+        before { controller.should_receive(:bigbluebutton_role).with(room).and_return(:moderator) }
+
+        it "catches exception on is_meeting_running" do
+          mocked_api.should_receive(:is_meeting_running?) { raise bbb_error }
+        end
+
+        it "catches exception on create_meeting" do
+          mocked_api.should_receive(:is_meeting_running?).and_return(false)
+          mocked_api.should_receive(:create_meeting) { raise bbb_error }
+        end
+
+        it "catches exception on join_meeting_url" do
+          mocked_api.should_receive(:is_meeting_running?).and_return(true)
+          mocked_api.should_receive(:join_meeting_url) { raise bbb_error }
+        end
+
+        after :each do
+          get :join, :server_id => mocked_server.to_param, :id => room.to_param
+          should respond_with(:redirect)
+          should redirect_to(http_referer)
+          should set_the_flash.to(bbb_error_msg)
+        end
+
+      end
+
+      context "as moderator" do
+        before { controller.should_receive(:bigbluebutton_role).with(room).and_return(:attendee) }
+
+        it "catches exception on is_meeting_running" do
+          mocked_api.should_receive(:is_meeting_running?) { raise bbb_error }
+        end
+
+        it "catches exception on join_meeting_url" do
+          mocked_api.should_receive(:is_meeting_running?).and_return(true)
+          mocked_api.should_receive(:join_meeting_url) { raise bbb_error }
+        end
+
+        after :each do
+          get :join, :server_id => mocked_server.to_param, :id => room.to_param
+          should respond_with(:redirect)
+          should redirect_to(http_referer)
+          should set_the_flash.to(bbb_error_msg)
+        end
+      end
+
+    end # #join
+
+  end
+end