csd 0.4.2 → 0.4.3

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/lib/csd/application/decklink/base.rb

@@ -3,6 +3,8 @@ require 'csd/application/default/base'
 
 module CSD
   module Application
+    #This module installs DeckLink card drivers in the system.
+    #
     module Decklink
       class Base < CSD::Application::Base
         

data/lib/csd/application/graphics/base.rb

@@ -3,6 +3,8 @@ require 'csd/application/default/base'
 
 module CSD
   module Application
+    # This module updates graphics card drivers for the system.
+    #
     module Graphics
       class Base < CSD::Application::Base
         
@@ -101,7 +103,7 @@ module CSD
         # * The method will ask for users' approval before initiate the shell script.
         #
         def install_radeon
-          Cmd.git_clone 'drivers for ATI radeon', 'git://github.com/csd/ati.git', Path.radeon
+          Cmd.git_clone 'drivers for ATI radeon', 'http://github.com/csd/ati.git', Path.radeon
           Cmd.run "chmod +x #{Path.radeon_run}", :announce_pwd => false
           proprietary_continue
           Cmd.run "sudo #{Path.radeon_run}", :announce_pwd => false
@@ -160,7 +162,7 @@ module CSD
         #
         def install_geforce!
           raise Error::Graphics::Amd64NotSupported, "Sorry, nVIDIA GeForce is currently only supported on x86" unless Gem::Platform.local.cpu == 'x86' 
-          Cmd.git_clone 'drivers for nVIDIA GeForce', 'git://github.com/csd/nvidia.git', Path.geforce
+          Cmd.git_clone 'drivers for nVIDIA GeForce', 'http://github.com/csd/nvidia.git', Path.geforce
           Cmd.run "chmod +x #{Path.geforce_run}", :announce_pwd => false
           proprietary_continue_for_geforce
           # Note that we cannot use Cmd.run here, because the User input is not forwared to

data/lib/csd/application/i2conf/base.rb

@@ -5,6 +5,8 @@ require 'csd/application/i2conf/config_example'
 
 module CSD
   module Application
+    # This module sets up the i2conf reflector in the system.
+    #
     module I2conf
       class Base < CSD::Application::Base
         
@@ -106,7 +108,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
         # strManager is a high-performance UDP packet reflector with high customizing per-flow options.
         # 
         def checkout_strmanager
-          Cmd.git_clone('strManager library', 'git://github.com/csd/strManager.git', Path.str_manager)
+          Cmd.git_clone('strManager library', 'http://github.com/csd/strManager.git', Path.str_manager)
         end
         
         # The method copies several files in libtool to the directory of strManager to avoid libtool version mismatch.
@@ -147,7 +149,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
         # The method checks out i2conf source code from git repository.
         #
         def checkout_i2conf
-          Cmd.git_clone('i2conf repository', 'git://github.com/csd/i2conf.git', Path.i2conf)
+          Cmd.git_clone('i2conf repository', 'http://github.com/csd/i2conf.git', Path.i2conf)
         end
         
         # The method fixes i2conf source code. The bootstrap file of i2conf only specifies automake version from 1.7 to 1.10.

data/lib/csd/application/minisip/component/ffmpeg.rb

@@ -4,6 +4,8 @@ module CSD
   module Application
     module Minisip
       module Component
+       # This modules compile FFmpeg libraries from source code.
+       #
         module FFmpeg
           class << self
             

data/lib/csd/application/minisip/component/gnome.rb

@@ -4,6 +4,8 @@ module CSD
   module Application
     module Minisip
       module Component
+        # This method updates the Desktop entities in system Gnome menu.
+        #
         module Gnome
           class << self
             

data/lib/csd/application/minisip/component/network.rb

@@ -4,6 +4,8 @@ module CSD
   module Application
     module Minisip
       module Component
+        # This module updates the network firmware of the system.
+        #
         module Network
           class << self
             
@@ -21,6 +23,11 @@ module CSD
               'net.ipv4.udp_wmem_min' => '4096'
             }
             
+            # This method fixes the udp buffer size and updates the suitable network firmware after auto detection.
+            # AI will first use the optimum buffer parameters, which have been tested and identified, to update
+            # the system and then make them permanent in the system. AI will also detect the system for its network card,
+            # and initiate the corresponding method to update it.
+            #
             def compile
               UI.debug "#{self}.compile was called"
               fix_udp_buffer
@@ -33,6 +40,8 @@ module CSD
               update_intel if (lspci.success? and lspci.output =~ /82572EI/) or Options.reveal
             end
             
+            # This method uses the optimum UDP buffer parameters for MiniSIP to update the system.
+            #
             def fix_udp_buffer
               return unless Gem::Platform.local.debian? or Options.reveal
               UI.info 'Fixing UDP buffer size'.green.bold
@@ -41,6 +50,11 @@ module CSD
               end
             end
             
+            # This method makes the UDP buffer modification permanent. AI modifies the sysctl.conf file with the updated
+            # values and creates a backup file for it. But before that, AI will first look for the backup file, if it
+            # already exists, AI will consider the UDP buffer size parameters have been made permanent and do not 
+            # touch any thing.
+            # 
             def permanent_udp_buffer
               if Path.sysctl_conf_backup.file? and !Options.reveal
                 UI.warn "The UDP buffer modifications seems to be permanent already. Delete #{Path.sysctl_conf_backup.enquote} to enforce it."
@@ -59,36 +73,52 @@ module CSD
               end
             end
             
+            # This method update realtek firmware by checking out and compiling it.
+            #
             def update_realtek
               checkout_realtek
               compile_realtek
             end
             
+            # This method update intel firmware by checking out and compiling it.
+            #
             def update_intel
               checkout_intel
               compile_intel
             end
             
+            # This method check out realtek firmware from git repository
+            #
             def checkout_realtek
-              Cmd.git_clone 'Realtek firmware', 'git://github.com/csd/realtek.git', Path.realtek_firmware
+              Cmd.git_clone 'Realtek firmware', 'http://github.com/csd/realtek.git', Path.realtek_firmware
             end
             
+            # This method check out intel firmware from git repository
+            #
             def checkout_intel
-              Cmd.git_clone 'Intel firmware', 'git://github.com/csd/intel.git', Path.intel_firmware
+              Cmd.git_clone 'Intel firmware', 'http://github.com/csd/intel.git', Path.intel_firmware
             end
             
+            # This method compile realtek firmware by running the downloaded autorun shell script.
+            # It also gives a UI information the users about the following operation.
+            #
             def compile_realtek
               UI.info 'Compiling Realtek firmware'.green.bold
               Cmd.cd Path.realtek_firmware, :internal => true
               Cmd.run 'sudo ./autorun.sh'
             end
             
+            # This method compile intel firmware by +make+ +install+ command.
+            # It also gives a UI information the users about the following operation.
+            #
             def compile_intel
               UI.info 'Compiling Intel firmware'.green.bold
               Cmd.cd Path.intel_firmware_src, :internal => true
               Cmd.run 'sudo make install'
             end
             
+            # There is no actual operation for this introduction method.
+            #
             def introduction
             end
             

data/lib/csd/application/minisip/component/plugins.rb

@@ -4,9 +4,14 @@ module CSD
   module Application
     module Minisip
       module Component
+        # This module adds the plugins for MiniSIP
+        #
         module Plugins
           class << self
             
+            # The method adds MiniSIP plugins. It will first check whether the plugins have been added, if not, AI will 
+            # initiate corresponding methods to add the plugins.
+            #
             def compile
               UI.debug "#{self}.compile was called"
               if Path.plugins.directory? and !Options.reveal
@@ -16,10 +21,13 @@ module CSD
                 copy
               end
             end
-          
+            
+            # There is no actual operation for this introduction method.
+            #
             def introduction
             end
-          
+            
+            # This method checks out
             def checkout
               Cmd.git_clone('additional MiniSIP plugins', 'http://github.com/csd/minisip-plugins.git', Path.plugins)
             end

data/lib/csd/application/minisip/component/x264.rb

@@ -4,6 +4,8 @@ module CSD
   module Application
     module Minisip
       module Component
+        # This module compiles X264 libraries.
+        #
         module X264
           class << self
             

data/lib/csd/application/mslog/base.rb

@@ -3,6 +3,8 @@ require 'csd/application/default/base'
 
 module CSD
   module Application
+    # This module sets up MiniSIP logging server in the system.
+    #
     module Mslog
       class Base < CSD::Application::Base
 
@@ -97,7 +99,7 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
         # The method is to check out MiniSIP source code from git repository and place it into the current working directory.
         #
         def download
-          Cmd.git_clone 'Source code of logging server', 'git://github.com/csd/minisip-logging-server.git', Path.packages
+          Cmd.git_clone 'Source code of logging server', 'http://github.com/csd/minisip-logging-server.git', Path.packages
         end
         
         # This method compiles Java source code.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -37,8 +37,10 @@ files:
 - VERSION
 - bin/ai
 - bin/ttai
-- csd.gemspec
 - img/3d1.png
+- img/audio1.png
+- img/audio2.png
+- img/audio3.png
 - img/bios0.jpg
 - img/bios1.jpg
 - img/bios2.jpg

data/csd.gemspec

@@ -1,206 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{csd}
-  s.version = "0.4.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Technology Transfer Alliance Team"]
-  s.date = %q{2010-09-27}
-  s.description = %q{CSD stands for Communication Systems Design and is a project of the Telecommunication Systems Laboratory (TSLab) of the Royal Institute of Technology in Stockholm, Sweden. Within CSD many software tools are used to build up various networks and services. This gem is supposed to automate processes to handle the compilation and installation of these software tools. Technology Transfer Alliance (TTA) is the project team, which maintains this code.}
-  s.email = %q{mtoday11@gmail.com}
-  s.executables = ["ai", "ttai"]
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "COPYING",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/ai",
-     "bin/ttai",
-     "csd.gemspec",
-     "img/3d1.png",
-     "img/bios0.jpg",
-     "img/bios1.jpg",
-     "img/bios2.jpg",
-     "img/camera1.jpg",
-     "img/camera2.jpg",
-     "img/checkminisip.png",
-     "img/decklink1.png",
-     "img/decklink2.png",
-     "img/graphics1.png",
-     "img/graphics2.png",
-     "img/graphics3.png",
-     "img/graphics4.png",
-     "img/graphics5.png",
-     "img/installer1.jpg",
-     "img/installer2.jpg",
-     "img/installer3.jpg",
-     "img/minisip1.png",
-     "img/minisip2.png",
-     "img/minisip3.png",
-     "img/minisip4.png",
-     "img/minisip5.png",
-     "img/minisip6.png",
-     "img/minisip7.png",
-     "img/reboot.png",
-     "img/ruby1.png",
-     "img/ruby2.png",
-     "img/ruby3.png",
-     "img/ruby4.png",
-     "img/update1.png",
-     "img/update2.png",
-     "lib/csd.rb",
-     "lib/csd/application.rb",
-     "lib/csd/application/decklink.rb",
-     "lib/csd/application/decklink/about.yml",
-     "lib/csd/application/decklink/base.rb",
-     "lib/csd/application/decklink/options/common.rb",
-     "lib/csd/application/decklink/options/common_defaults.rb",
-     "lib/csd/application/default.rb",
-     "lib/csd/application/default/base.rb",
-     "lib/csd/application/graphics.rb",
-     "lib/csd/application/graphics/about.yml",
-     "lib/csd/application/graphics/base.rb",
-     "lib/csd/application/graphics/error.rb",
-     "lib/csd/application/graphics/options/common.rb",
-     "lib/csd/application/graphics/options/common_defaults.rb",
-     "lib/csd/application/graphics/options/install.rb",
-     "lib/csd/application/graphics/options/install_defaults.rb",
-     "lib/csd/application/i2conf.rb",
-     "lib/csd/application/i2conf/about.yml",
-     "lib/csd/application/i2conf/base.rb",
-     "lib/csd/application/i2conf/config_example.rb",
-     "lib/csd/application/i2conf/options/common.rb",
-     "lib/csd/application/i2conf/options/common_defaults.rb",
-     "lib/csd/application/i2conf/options/install.rb",
-     "lib/csd/application/i2conf/options/install_defaults.rb",
-     "lib/csd/application/minisip.rb",
-     "lib/csd/application/minisip/about.yml",
-     "lib/csd/application/minisip/base.rb",
-     "lib/csd/application/minisip/component.rb",
-     "lib/csd/application/minisip/component/core.rb",
-     "lib/csd/application/minisip/component/core_packaging.rb",
-     "lib/csd/application/minisip/component/ffmpeg.rb",
-     "lib/csd/application/minisip/component/gnome.rb",
-     "lib/csd/application/minisip/component/hdviper.rb",
-     "lib/csd/application/minisip/component/network.rb",
-     "lib/csd/application/minisip/component/plugins.rb",
-     "lib/csd/application/minisip/component/x264.rb",
-     "lib/csd/application/minisip/error.rb",
-     "lib/csd/application/minisip/options/common.rb",
-     "lib/csd/application/minisip/options/common_defaults.rb",
-     "lib/csd/application/minisip/options/install.rb",
-     "lib/csd/application/minisip/options/install_defaults.rb",
-     "lib/csd/application/minisip/options/package.rb",
-     "lib/csd/application/minisip/options/package_defaults.rb",
-     "lib/csd/application/minisip/phonebook_example.rb",
-     "lib/csd/application/minisip/unix.rb",
-     "lib/csd/application/minisip/unix/darwin.rb",
-     "lib/csd/application/minisip/unix/linux.rb",
-     "lib/csd/application/minisip/unix/linux/debian.rb",
-     "lib/csd/application/minisip/unix/linux/debian/ubuntu10.rb",
-     "lib/csd/application/mslog.rb",
-     "lib/csd/application/mslog/about.yml",
-     "lib/csd/application/mslog/base.rb",
-     "lib/csd/application/mslog/options/common.rb",
-     "lib/csd/application/mslog/options/common_defaults.rb",
-     "lib/csd/applications.rb",
-     "lib/csd/commands.rb",
-     "lib/csd/container.rb",
-     "lib/csd/error.rb",
-     "lib/csd/extensions.rb",
-     "lib/csd/extensions/core/array.rb",
-     "lib/csd/extensions/core/dir.rb",
-     "lib/csd/extensions/core/kernel.rb",
-     "lib/csd/extensions/core/object.rb",
-     "lib/csd/extensions/core/open_struct.rb",
-     "lib/csd/extensions/core/option_parser.rb",
-     "lib/csd/extensions/core/pathname.rb",
-     "lib/csd/extensions/core/string.rb",
-     "lib/csd/extensions/gem/platform.rb",
-     "lib/csd/options_parser.rb",
-     "lib/csd/path_container.rb",
-     "lib/csd/user_interface.rb",
-     "lib/csd/user_interface/base.rb",
-     "lib/csd/user_interface/cli.rb",
-     "lib/csd/user_interface/silent.rb",
-     "lib/csd/vendor/active_support/MIT-LICENSE",
-     "lib/csd/vendor/active_support/inflector.rb",
-     "lib/csd/vendor/active_support/object_extensions.rb",
-     "lib/csd/vendor/term/GPL2-LICENSE",
-     "lib/csd/vendor/term/ansicolor.rb",
-     "lib/csd/vendor/zentest/zentest_assertions.rb",
-     "lib/csd/version.rb",
-     "test/application/test_minisip.rb",
-     "test/functional/test_application_base.rb",
-     "test/functional/test_application_default.rb",
-     "test/functional/test_applications.rb",
-     "test/functional/test_cli.rb",
-     "test/functional/test_commands.rb",
-     "test/functional/test_csd.rb",
-     "test/functional/test_options.rb",
-     "test/helper.rb",
-     "test/unit/test_container.rb",
-     "test/unit/test_dir.rb",
-     "test/unit/test_open_struct.rb",
-     "test/unit/test_pathname.rb",
-     "test/unit/test_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-  s.homepage = %q{http://github.com/csd/csd}
-  s.post_install_message = %q{
-============================================================
-
-  Thank you for installing the TTA Automated Installer!
-
-  NOTE: On DEBIAN and UBUNTU the executable `ai´ is *maybe*
-        not in your PATH by default. If that is the case,
-        you can fix it by running this command:
-
-  echo "export PATH=\$PATH:$(gem env | grep "E D" | sed "s/[^\w]* //")" >> ~/.bashrc;. ~/.bashrc
-
-  You can run the AI by typing `ai´ in your command line.
-
-============================================================
-}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Installation and compilation handler for software used in CSD projects.}
-  s.test_files = [
-    "test/application/test_minisip.rb",
-     "test/functional/test_application_base.rb",
-     "test/functional/test_application_default.rb",
-     "test/functional/test_applications.rb",
-     "test/functional/test_cli.rb",
-     "test/functional/test_commands.rb",
-     "test/functional/test_csd.rb",
-     "test/functional/test_options.rb",
-     "test/helper.rb",
-     "test/unit/test_container.rb",
-     "test/unit/test_dir.rb",
-     "test/unit/test_open_struct.rb",
-     "test/unit/test_pathname.rb",
-     "test/unit/test_platform.rb",
-     "test/unit/test_string.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-