csd 0.3.4 → 0.3.5

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

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

@@ -10,6 +10,9 @@ module CSD
         #
         DEBIAN_DEPENDENCIES = %w{ libnotify-bin libmng1 dkms }
         
+        # This method notifies users about following operation of AI, and initiates introduction method.
+        # The actual installation process is carried out by method install! for the purpose of keeping source code clean.
+        #
         def install
           UI.separator
           UI.info "This operation will download and install the DeckLink device drivers.".green.bold
@@ -18,6 +21,12 @@ module CSD
           install!
         end
         
+        # This method installs DeckLink drivers by initiating corresponding method sequentially. It will download DeckLink
+        # drivers from official website, extract the dirver from tar file, select the suitable driver according to system 
+        # architecture, and intall the DeckLink driver. After the installation process, it will add the driver into boot loader,
+        # so the driver can be loaded automatically at system booting up. It will also notify the user and clean up working 
+        # directory when the whole operation is completed.
+        #
         def install!
           create_working_directory
           define_relative_paths
@@ -29,6 +38,17 @@ module CSD
           cleanup_working_directory
         end
         
+        # This method is to provide general introductions to users, like current working directory.
+        # 
+        # ====Options
+        # [debug]  If debug option is set, users will be notified about system platform and current working module.
+        # [help]   If help option is set, AI will provide all help information and cleanup in case the working directory was temporary and is empty.
+        # [reveal] If reveal option is set, AI will continue and process the next method.
+        # [yes]    If yes option is set, AI will continue and process the next method.
+        # 
+        # If users did not specify any option, AI will ask for their willingness to continue and process the next method 
+        # after the users choose 'yes'. Or AI will terminate its operation.
+        # 
         def introduction
           UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
           if Options.debug
@@ -46,6 +66,10 @@ module CSD
           end
         end
         
+        # This method downloads DeckLink driver from official BlackmagicDesign website. Before downloading the driver,
+        # AI will search the current working directory for the driver, if it is already there, AI will not download the
+        # driver again. Otherwise, AI will download the driver, and place it in the current working directory.
+        #
         def download
           if Path.tar.file?
             UI.warn "The driver will not be downloaded, because it already exists: #{Path.tar.enquote}"
@@ -56,9 +80,10 @@ module CSD
           end
         end
         
+        # This method extracts the tar file of DeckLink driver.
         def extract
           if Path.packages.directory?
-            UI.warn "The tar file will not be extracted, because package repositot already exist: #{Path.packages.enquote}"
+            UI.warn "The tar file will not be extracted, because package repository already exist: #{Path.packages.enquote}"
           else
             UI.info "Extracting DeckLink drivers".green.bold
             Cmd.mkdir Path.packages
@@ -92,7 +117,7 @@ module CSD
         
         def define_relative_paths
           blacklink_repository   = 'http://www.blackmagic-design.com/downloads/software/'
-          decklink_basename      = 'DeckLink_Linux_7.7.3'
+          decklink_basename      = 'DeckLink_Linux_7.9'
           decklink_extension     = '.tar.gz'
           Path.decklink_url      = blacklink_repository + decklink_basename + decklink_extension
           Path.tar               = Pathname.new(File.join(Path.work, "#{decklink_basename + decklink_extension}"))

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

@@ -208,7 +208,7 @@ module CSD
         def define_relative_paths
           UI.debug "#{self.class}#define_relative_paths defines relative graphics paths now"
           Path.radeon       = Pathname.new(File.join(Path.work, 'radeon'))
-          Path.radeon_run   = Pathname.new(File.join(Path.radeon, 'ati-driver-installer-10-7-x86.x86_64.run'))
+          Path.radeon_run   = Pathname.new(File.join(Path.radeon, 'ati-driver-installer-10-9-x86.x86_64.run'))
           Path.geforce      = Pathname.new(File.join(Path.work, 'geforce'))
           Path.geforce_run  = Pathname.new(File.join(Path.geforce, 'NVIDIA-Linux-x86-256.44.run.sh'))
         end

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

@@ -200,7 +200,9 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
         end
         
         # The method creates a minimum configuration file for i2conf if it is not available.
-        # This configuration is based on 
+        # This configuration is based on currently available carenet-se service. However, the user may modify the
+        # configuration file according to its own network scenario after installation process.
+        #
         def configure_i2conf
           if Path.i2conf_example_conf.file?
             UI.warn "Creating no example configuration file, because it already exists: #{Path.i2conf_example_conf}. "
@@ -218,6 +220,11 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           Cmd.run %{notify-send --icon=i2conf_gnome "I2conf installation complete" "You are now ready to use your SIP MCU." }, :internal => true, :die_on_failure => false
         end
         
+        # This method notifies users that i2conf installation process is completed successfully.
+        # It is AI's internal notification, which will be shown on the command line interface.
+        # Users can then start i2conf by clicking the icon in gnome menu or use command line interface.
+        # AI will also notify the users about possible modifications on the configuration file, according to users' network scenario.
+        # 
         def congratulations
           cleanup_working_directory if Options.temp
           UI.separator
@@ -233,6 +240,17 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           UI.separator
         end
         
+        # This method provides general introductions to users, like current working directory.
+        # 
+        # ====Options
+        # [debug]  If debug option is set, users will be notified about system platform and current working module.
+        # [help]   If help option is set, AI will provide all help information and cleanup in case the working directory was temporary and is empty.
+        # [reveal] If reveal option is set, AI will continue and process the next method.
+        # [yes]    If yes option is set, AI will continue and process the next method.
+        # 
+        # If users did not specify any option, AI will ask for their willingness to continue and process the next method 
+        # after the users choose 'yes'. Or AI will terminate its operation.
+        # 
         def introduction
           UI.info " Working directory:       ".green.bold + Path.work.to_s.yellow
           if Options.debug
@@ -250,6 +268,8 @@ Categories=Application;Internet;Network;Chat;AudioVideo}
           end
         end
         
+        # This method is to define relative path in i2conf module. This will make the program clean and easy to read.
+        #
         def define_relative_paths
           UI.debug "#{self.class}#define_relative_paths defines relative i2conf paths now"
           Path.str_manager              = Pathname.new(File.join(Path.work, 'libstrmanager'))

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

@@ -127,6 +127,7 @@ module CSD
           Path.ffmpeg_libswscale                  = Pathname.new(File.join(Path.ffmpeg_repository, 'libswscale'))
           Path.x264_repository                    = Pathname.new(File.join(Path.work, 'x264'))
           Path.packaging                          = Pathname.new(File.join(Path.work, 'packaging'))
+          Path.packages                           = Pathname.new(File.join(Path.work, 'packages'))
           Path.hdviper                            = Pathname.new(File.join(Path.work, 'hdviper'))
           Path.hdviper_x264                       = Pathname.new(File.join(Path.hdviper, 'x264'))
           Path.hdviper_libtidx264                 = Pathname.new(File.join(Path.hdviper_x264, 'libtidx264.a'))

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

@@ -19,7 +19,9 @@ module CSD
               UI.info "This operation will make debian packages for all MiniSIP libraries.".green.bold
               UI.separator
               packing_introduction
+              remove_ffmpeg
               Cmd.mkdir Path.packaging
+              Cmd.mkdir Path.packages
               libraries.each do |library|
                 @library = library
                 @directory = Pathname.new(File.join(Path.repository, library))
@@ -72,13 +74,16 @@ module CSD
                 if Cmd.cd(Path.packaging)
                   package = File.basename(Dir[File.join(Path.packaging, "#{@library}*.deb")].first)
                   Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
+                  Cmd.move(File.join(Path.packaging, package.to_s), Path.packages) if package or Options.reveal
                 end
               else
                 if Cmd.cd(Path.packaging)
                   package = File.basename(Dir[File.join(Path.packaging, "#{@library}0*.deb")].first)
                   Cmd.run("sudo dpkg -i #{package}") if package or Options.reveal
+                  Cmd.move(File.join(Path.packaging, package.to_s), Path.packages) if package or Options.reveal
                   dev_package = File.basename(Dir[File.join(Path.packaging, "#{@library}-dev*.deb")].first)
                   Cmd.run("sudo dpkg -i #{dev_package}") if dev_package or Options.reveal
+                  Cmd.move(File.join(Path.packaging, dev_package.to_s), Path.packages) if dev_package or Options.reveal
                 end
               end
             end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csd
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Technology Transfer Alliance Team