bigbluebutton_rails 0.0.4 → 0.0.5

data/config/locales/en.yml

@@ -7,6 +7,9 @@ en:
           success: "Your server was successfully created."
         update:
           success: "Your server was successfully updated."
+      errors:
+        param_format: 'you can only use letters, numbers and the symbols "-" or "_" (not at the begin or end)'
+        url_format: 'should use the pattern http://<server>/bigbluebutton/api'
     rooms:
       notice:
         create:
@@ -18,21 +21,25 @@ en:
         end:
           success: "The meeting was successfully ended."
           not_running: "The meeting could not be ended because it is not running."
-      error:
+        destroy:
+          success: "The meeting was successfully destroyed."
+      errors:
         auth:
           failure: "Authentication failure."
           not_running: "The meeting is not running. You must wait for a moderator to join."
+        param_format: 'you can only use letters, numbers and the symbols "-" or "_" (not at the begin or end)'
 
   activerecord:
     models:
       bigbluebutton_server: "BigBlueButton Server"
       bigbluebutton_room: "BigBlueButton Room"
-    attributes: 
+    attributes:
       bigbluebutton_server:
         name: "Name"
         url: "URL"
         salt: "Security Salt"
         version: "Version"
+        param: "String ID"
       bigbluebutton_room:
         server_id: "Server ID"
         meetingid: "Meeting ID"
@@ -46,4 +53,6 @@ en:
         dial_number: "Dial Number"
         voice_bridge: "Voice Bridge"
         max_participants: "Maximum Number of Participants"
+        external: "Externally created"
+        param: "String ID"
 

data/lib/bigbluebutton_rails/controller_methods.rb

@@ -26,25 +26,58 @@ module BigbluebuttonRails
           current_user
         end
 
-        # Returns the role that the current user has in the room 'room'.
-        # Possibilities:
-        #   :moderator
-        #   :attendee
-        # You may want to redefine this method in your controllers to define
-        # real roles to the users. By default, everyone has moderator permissions.
-        # Redefine it in your ApplicationController to make it available to all
-        # controllers. For example:
+        # 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
+        #   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
+        # 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
+        # class BigbluebuttonRails::RoomAccessDenied in this case. By default rails will
+        # show an error page whenever an exception is thrown (and not catch). To show
+        # a better-looking page, add in your ApplicationController a block to catch the
+        # exception, such as:
+        #
+        #   rescue_from BigbluebuttonRails::RoomAccessDenied do |exception|
+        #     flash[:error] = "You don't have permission to access this room!"
+        #     redirect_to root_url
+        #   end
+        #
+        # 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
+        # to all controllers. For example:
         #
         #   def bigbluebutton_role(@room)
-        #     r = Roles.where(:bigbluebutton_room_id => @room.id).
-        #               where(:user_id => current_user.id).
-        #               first
-        #     r.role
+        #
+        #     # the owner is the moderator
+        #     if @room.owner == bigbluebutton_user
+        #       :moderator
+        #
+        #     # only friends are allowed to enter
+        #     elsif @room.owner.friends.include? bigbluebutton_user
+        #       if @room.private
+        #         :password # with password if the room is private
+        #       else
+        #         :attendee
+        #       end
+        #
+        #     # not a friend? you're not allowed in
+        #     else
+        #       nil
+        #     end
+        #
         #   end
         #
         def bigbluebutton_role(room)
-          if room.private or current_user.nil?
-            nil # ask for a password
+          if room.private or bigbluebutton_user.nil?
+            :password # ask for a password
           else
             :moderator
           end

data/lib/bigbluebutton_rails/exceptions.rb

@@ -0,0 +1,6 @@
+module BigbluebuttonRails
+
+  # Raised when the user is not authorized to join a room
+  class RoomAccessDenied < StandardError; end
+
+end

data/lib/bigbluebutton_rails/rails/routes.rb

@@ -52,18 +52,20 @@ module ActionDispatch::Routing
     #
     # The routes generated are:
     #
-    #   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_auth_room     POST /users/:user_id/room/:id/join(.:format)
-    #                           { :controller=>"bigbluebutton/rooms", :action=>"auth" }
-    #   user_running_room  GET  /users/:user_id/room/:id/running(.:format)
-    #                           { :controller=>"bigbluebutton/rooms", :action=>"running" }
-    #   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" }
+    #   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_join_mobile_room   GET  /users/:user_id/room/:id/invite(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"invite" }
+    #   user_auth_room          POST /users/:user_id/room/:id/join(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"auth" }
+    #   user_running_room       GET  /users/:user_id/room/:id/running(.:format)
+    #                                { :controller=>"bigbluebutton/rooms", :action=>"running" }
+    #   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" }
     #
     def bigbluebutton_routes(*params)
       options = params.extract_options!
@@ -79,11 +81,13 @@ module ActionDispatch::Routing
 
       scope options_scope, :as => options_scope do
         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
           end
         end
@@ -94,6 +98,7 @@ module ActionDispatch::Routing
       # TODO This is generating helpers like "user_running_room" instead of "running_user_room"
       get 'room/:id' => "#{BigbluebuttonRails.controllers[:rooms]}#show", :as => 'room'
       get 'room/:id/join' => "#{BigbluebuttonRails.controllers[:rooms]}#join", :as => 'join_room'
+      get 'room/:id/join_mobile' => "#{BigbluebuttonRails.controllers[:rooms]}#join_mobile", :as => 'join_mobile_room'
       post 'room/:id/join' => "#{BigbluebuttonRails.controllers[:rooms]}#auth", :as => 'join_room'
       get 'room/:id/running' => "#{BigbluebuttonRails.controllers[:rooms]}#running", :as => 'running_room'
       get 'room/:id/end' => "#{BigbluebuttonRails.controllers[:rooms]}#end", :as => 'end_room'

data/lib/bigbluebutton_rails/rails.rb

@@ -1,6 +1,10 @@
 module BigbluebuttonRails
   class Engine < ::Rails::Engine
 
+    initializer 'bigbluebutton_rails.helper' do |app|
+      ActionView::Base.send :include, BigbluebuttonRailsHelper
+    end
+
     initializer "bigbluebutton_rails.controller_methods" do
       ActiveSupport.on_load(:action_controller) do
         include BigbluebuttonRails::ControllerMethods

data/lib/bigbluebutton_rails/version.rb

@@ -1,3 +1,3 @@
 module BigbluebuttonRails
-  VERSION = "0.0.4".freeze
+  VERSION = "0.0.5".freeze
 end

data/lib/bigbluebutton_rails.rb

@@ -6,6 +6,7 @@ module BigbluebuttonRails
   require 'bigbluebutton_rails/rails'
   require 'bigbluebutton_rails/controller_methods'
   require 'bigbluebutton_rails/rails/routes'
+  require 'bigbluebutton_rails/exceptions'
 
   # Default controllers to generate the routes
   mattr_accessor :controllers

data/lib/generators/bigbluebutton_rails/install_generator.rb

@@ -4,13 +4,22 @@ module BigbluebuttonRails
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      source_root File.expand_path("../templates", __FILE__)
+      argument :migrate_to_version, :type => :string, :default => "", :description => "Generate migration to this version"
+      class_option :migration_only, :type => :boolean, :default => false, :description => "Generate only the migration file"
+      source_root File.expand_path("../../../../", __FILE__) # set to gem root
 
-      desc "Creates the initializer, initial migration and locale files."
+      desc "Creates the migrations and locale files. Also used to create migrations when updating the gem version."
 
       def copy_locale
-        # uses bigbluebutton_rails/config to avoid using the local application en.yml
-        copy_file "../../../../../bigbluebutton_rails/config/locales/en.yml", "config/locales/bigbluebutton_rails.en.yml"
+        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)
@@ -18,7 +27,21 @@ module BigbluebuttonRails
       end
 
       def create_migration_file
-        migration_template 'migration.rb', 'db/migrate/create_bigbluebutton_rails.rb'
+        if migrate_to_version.blank?
+          migration_template "#{migration_path}/migration.rb", "db/migrate/create_bigbluebutton_rails.rb"
+        else
+          migration_template "#{migration_path}/migration_#{version_filename}.rb", "db/migrate/bigbluebutton_rails_to_#{version_filename}.rb"
+        end
+      end
+
+      protected
+
+      def migration_path
+        File.join("lib", "generators", "bigbluebutton_rails", "templates")
+      end
+
+      def version_filename
+        migrate_to_version.gsub(".", "_")
       end
 
     end

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

@@ -6,6 +6,7 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.string :url
       t.string :salt
       t.string :version
+      t.string :param
       t.timestamps
     end
     create_table :bigbluebutton_rooms do |t|
@@ -23,6 +24,8 @@ class CreateBigbluebuttonRails < ActiveRecord::Migration
       t.integer :max_participants
       t.boolean :private, :default => false
       t.boolean :randomize_meetingid, :default => true
+      t.boolean :external, :default => false
+      t.string :param
       t.timestamps
     end
     add_index :bigbluebutton_rooms, :server_id

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

@@ -0,0 +1,38 @@
+class BigbluebuttonRailsTo004 < ActiveRecord::Migration
+
+  def self.up
+    create_table :bigbluebutton_servers do |t|
+      t.string :name
+      t.string :url
+      t.string :salt
+      t.string :version
+      t.timestamps
+    end
+    create_table :bigbluebutton_rooms do |t|
+      t.integer :server_id
+      t.integer :owner_id
+      t.string :owner_type
+      t.string :meetingid
+      t.string :name
+      t.string :attendee_password
+      t.string :moderator_password
+      t.string :welcome_msg
+      t.string :logout_url
+      t.string :voice_bridge
+      t.string :dial_number
+      t.integer :max_participants
+      t.boolean :private, :default => false
+      t.boolean :randomize_meetingid, :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
+  end
+
+  def self.down
+    drop_table :bigbluebutton_rooms
+    drop_table :bigbluebutton_servers
+  end
+
+end

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

@@ -0,0 +1,23 @@
+class BigbluebuttonRailsTo005 < ActiveRecord::Migration
+
+  def self.up
+    add_column :bigbluebutton_rooms, :external, :boolean, :default => false
+    add_column :bigbluebutton_rooms, :param, :string
+    add_column :bigbluebutton_servers, :param, :string
+
+    BigbluebuttonRoom.all.each do |r|
+      r.update_attributes(:param => r.name.parameterize.downcase) unless r.name.nil?
+    end
+    BigbluebuttonServer.all.each do |s|
+      s.update_attributes(:param => s.name.parameterize.downcase) unless s.name.nil?
+    end
+
+  end
+
+  def self.down
+    remove_column :bigbluebutton_rooms, :external
+    remove_column :bigbluebutton_rooms, :param
+    remove_column :bigbluebutton_servers, :param
+  end
+
+end

data/public/stylesheets/bigbluebutton_rails.css

@@ -0,0 +1,138 @@
+.bbbrails_meeting_description {
+  padding: 5px;
+  margin-top: 20px;
+}
+
+.bbbrails_meeting_description span.running {
+  color: green;
+}
+
+.bbbrails_meeting_description span.not_running {
+  color: #a00000;
+}
+
+.bbbrails_meeting_description .button_bar {
+  float: right;
+  margin-right: 10px;
+  border-left: 1px solid #aaa;
+}
+
+.bbbrails_meeting_description .button_bar a {
+  margin-left: 5px;
+}
+
+.bbbrails_meeting_description .title_bar {
+  padding: 5px;
+  background: #f0f0f0;
+}
+
+.bbbrails_meeting_description_changed {
+  border: 1px solid #d00000;
+}
+
+.bbbrails_countdown {
+  float: right;
+  padding: 5px;
+  margin: 10px;
+}
+
+.bbbrails_meeting_attendees {
+  margin-top: 10px;
+}
+
+.bbbrails_meeting_attendees .header, .bbbrails_meeting_attendees .row {
+  clear: both;
+  border-top: 1px solid #ddd;
+}
+
+.bbbrails_meeting_attendees .header .field {
+  float: left;
+  margin: 0 5px 0 0;
+  width: 180px;
+  font-weight: bold;
+  padding: 3px;
+}
+
+.bbbrails_meeting_attendees .row .field {
+  float: left;
+  margin: 0 5px 0 0;
+  width: 180px;
+  padding: 3px;
+}
+
+
+/*
+ * Used in bigbluebutton_servers/index
+ */
+
+#bbbrails_servers_list {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+}
+
+#bbbrails_servers_links {
+  margin-bottom: 5px;
+  padding-bottom: 5px;
+  border-bottom: 1px solid #ddd;
+}
+
+#bbbrails_servers_list li {
+  margin-bottom: 5px;
+  padding-bottom: 5px;
+  border-bottom: 1px solid #ddd;
+  clear: both;
+}
+
+#bbbrails_servers_list div.field {
+  margin: 0;
+  padding: 0;
+  clear: both;
+}
+
+#bbbrails_servers_list label {
+  font-weight: bold;
+  width: 150px;
+  float: left;
+  text-align: right;
+  margin-right: 10px;
+  clear: both;
+}
+
+/*
+ * Used in bigbluebutton_rooms/index
+ */
+
+#bbbrails_rooms_list {
+  list-style-type: none;
+  margin: 0;
+  padding: 0;
+}
+
+#bbbrails_rooms_links {
+  margin-bottom: 5px;
+  padding-bottom: 5px;
+  border-bottom: 1px solid #ddd;
+}
+
+#bbbrails_rooms_list li {
+  margin-bottom: 5px;
+  padding-bottom: 5px;
+  border-bottom: 1px solid #ddd;
+  clear: both;
+}
+
+#bbbrails_rooms_list div.field {
+  margin: 0;
+  padding: 0;
+  clear: both;
+}
+
+#bbbrails_rooms_list label {
+  font-weight: bold;
+  width: 300px;
+  float: left;
+  text-align: right;
+  margin-right: 10px;
+  clear: both;
+}