sambala 0.8.8 → 0.8.9

data/lib/sambala.rb

@@ -43,7 +43,7 @@ class Sambala
   # * :password = the password to log into the server
   # * :threads = how many parallel operations you want initiated, !!! higher than 4 at you own risk !!!
   # === Example
-  #   sam = Sambala.new(  :domain   =>  'NTDOMAIN', 
+  #   samba = Sambala.new(  :domain   =>  'NTDOMAIN', 
   #                       :host     =>  'sambaserver',
   #                       :share    =>  'sambashare',
   #                       :user     =>  'walrus', 
@@ -52,27 +52,23 @@ class Sambala
   def initialize(options={:domain => '', :host => '', :share => '', :user => '', :password => '', :threads => 1})
     begin
       options[:threads] = 4 if options[:threads] > 4
-      options[:init_timeout] = options[:threads] * 2
+      options[:init_timeout] = options[:threads] * 1
       @options = options; gardener_ok
-    rescue SmbInitError
-      raise SmbInitError.exception("Failed smbclient initialisation")
     rescue
       @gardener.close unless @gardener.nil? || @gardener.class != 'Gardener'
       raise RuntimeError.exception("Unknown Process Failed!!")
     end
   end
-  # The +cd+ instance method takes only one argument, the path to which you wish to change directory
-  # Its one of the only implemented command where queue mode is not available, for the simple reason that
-  # when queued operations are executed in parallel, one does not control which command will get executed first, 
-  # making a queued +cd+ operation very dangerous.  
+
+  # The +cd+ instance method takes only one argument, the path to which you wish to change directory  
   # === Parameters
   # * :to = the path to change directory to
   # === Interactive Returns
   # * _boolean_ = confirms if +cd+ operation completed successfully
   # === Example
-  #   sam.cd(:to => 'aFolder/anOtherFolder/')   # =>  true
+  #   samba.cd(:to => 'aFolder/anOtherFolder/')   # =>  true
   def cd(opts={:to => ''})
-    execute('cd', opts[:to], false)[0]
+		execute_all('cd', opts[:to])
   end
   
   # The +du+ instance does exactly what _du_ usually does: estimates file space usage.
@@ -81,7 +77,7 @@ class Sambala
   # === Interactive Returns
   # * _string_ = +du+ command results
   # === Example
-  #   puts sam.du   # =>  34923 blocks of size 2097152. 27407 blocks available
+  #   puts samba.du   # =>  34923 blocks of size 2097152. 27407 blocks available
   #                       Total number of bytes: 59439077
   def du(opts={:queue=>false})
     execute('du', '', opts[:queue])[1]
@@ -94,12 +90,12 @@ class Sambala
   # === Interactive Returns
   # * _boolean_ = confirms if +del+ operation completed successfully
   # === Example
-  #   sam.del(:mask => 'aFile')   # =>  true
+  #   samba.del(:mask => 'aFile')   # =>  true
   def del(opts={:mask => nil, :queue=>false})
     execute('del', opts[:mask], opts[:queue])[0]
   end
-  
-  # The maexist? instance method is borrowed from Ruby File Class idiome.
+  alias rm del
+  # The exist? instance method is borrowed from Ruby File Class idiome.
   # It is used to test the presence of files or directories on the server
   # === Parameters
   # * :mask = the mask matching the file or directory to look for.
@@ -107,7 +103,7 @@ class Sambala
   # === Interactive Returns
   # * _boolean_ = confirm the presence of a matching file or directory
   # === Example
-  #   sam.exist?(:mask => 'aFile')  # => true
+  #   samba.exist?(:mask => 'aFile')  # => true
   def exist?(opts={:mask => nil, :queue => false})
     execute('ls', opts[:mask], opts[:queue])[0]
   end
@@ -121,24 +117,21 @@ class Sambala
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _getResultMessage_ ]
   # === Example
-  #   sam.get(:from => 'aFile.txt')   # => [true, "getting file \\aFile.txt.rb of size 3877 as test.rb (99.6 kb/s) (average 89.9 kb/s)\r\n"]
+  #   samba.get(:from => 'aFile.txt')   # => [true, "getting file \\aFile.txt.rb of size 3877 as test.rb (99.6 kb/s) (average 89.9 kb/s)\r\n"]
   def get(opts={:from => nil, :to => nil, :queue => false})
     opts[:to].nil? ? strng = opts[:from] : strng = opts[:from] + ' ' + opts[:to]
     execute('get', strng, opts[:queue])
   end
   
-  # The +lcd+ instance method changes the current working directory on the local machine to the directory specified.
-  # Its one of the only implemented command where queue mode is not available, for the simple reason that
-  # when queued operations are executed in parallel, one does not control which command will get executed first, 
-  # making a queued +lcd+ operation very dangerous.  
+  # The +lcd+ instance method changes the current working directory on the local machine to the directory specified. 
   # === Parameters
   # * :to = the path to change directory to
   # === Interactive Returns
   # * _boolean_ = confirms if +cd+ operation completed successfully
   # === Example
-  #   sam.lcd(:to => 'aLocalFolder/anOtherFolder/')   # => true
+  #   samba.lcd(:to => 'aLocalFolder/anOtherFolder/')   # => true
   def lcd(opts={:to => ''})
-    execute('lcd', opts[:to], false)[0]
+		execute_all('lcd', opts[:to])
   end
   
   # The +lowercase+ method toggles lowercasing of filenames for the get command.
@@ -147,7 +140,7 @@ class Sambala
   # === Interactive Returns
   # * _boolean_ = confirms if +lowercase+ operation completed successfully
   # === Example
-  #   sam.lowercase   # => true      # toggle from files all UPPERCASE to all lowercase
+  #   samba.lowercase   # => true      # toggle from files all UPPERCASE to all lowercase
   def lowercase
     execute_all('lowercase' ,'')
   end
@@ -159,7 +152,7 @@ class Sambala
   # === Interactive Returns
   # * _string_ = containing +ls+ command results
   # === Example
-  #   sam.ls  # =>  genpi.rb                            A       81  Mon Nov 17 22:12:40 2008
+  #   samba.ls  # =>  genpi.rb                            A       81  Mon Nov 17 22:12:40 2008
   #                     34923 blocks of size 2097152. 27407 blocks available
   def ls(opts={:mask => nil, :queue=>false})
     execute('ls' ,opts[:mask], opts[:queue])[1]
@@ -172,7 +165,7 @@ class Sambala
   # === Parameters
   # * :mask = the matching filter
   # === Example
-  #   sam.mask(:mask => 'filter*')  # => true
+  #   samba.mask(:mask => 'filter*')  # => true
   def mask(opts={:mask => nil})
     execute_all('mask' ,opts[:mask])
   end
@@ -185,7 +178,7 @@ class Sambala
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _mgetResultMessage_ ]
   # === Example
-  #   sam.mget(:mask => 'file*')  # => [true, "getting file \\file_new.txt of size 3877 as file_new.txt (99.6 kb/s) (average 89.9 kb/s)\r\n"]
+  #   samba.mget(:mask => 'file*')  # => [true, "getting file \\file_new.txt of size 3877 as file_new.txt (99.6 kb/s) (average 89.9 kb/s)\r\n"]
   def mget(opts={:mask => nil, :queue => false})
     execute('mget' ,opts[:mask], opts[:queue])
   end
@@ -197,7 +190,7 @@ class Sambala
   # === Interactive Returns
   # * _boolean_ = confirms if +mkdir+ operation completed successfully
   # === Example
-  #   sam.mkdir(:path => 'aFolder/aNewFolder')  # => true
+  #   samba.mkdir(:path => 'aFolder/aNewFolder')  # => true
   def mkdir(opts={:path => '', :queue => false})
     execute('mkdir' ,opts[:path], opts[:queue])[0]
   end
@@ -211,7 +204,7 @@ class Sambala
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _mputResultMessage_ ]
   # === Example
-  #   sam.mput(:mask => 'file*')  # =>  [true, "putting file \\file_new.txt of size 1004 as file_new.txt (65.4 kb/s) (average 65.4 kb/s)\r\n"]
+  #   samba.mput(:mask => 'file*')  # =>  [true, "putting file \\file_new.txt of size 1004 as file_new.txt (65.4 kb/s) (average 65.4 kb/s)\r\n"]
   def mput(opts={:mask => nil, :queue => false})
     execute('mput' ,opts[:mask], opts[:queue])
   end
@@ -225,7 +218,7 @@ class Sambala
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _putResultMessage_ ]
   # === Example
-  #   sam.put(:from => 'aLocalFile.txt')   # =>  [false, "aLocalFile.txt does not exist\r\n"]
+  #   samba.put(:from => 'aLocalFile.txt')   # =>  [false, "aLocalFile.txt does not exist\r\n"]
 
   def put(opts={:from => nil, :to => nil, :queue => false})
     opts[:to].nil? ? strng = opts[:from] : strng = opts[:from] + ' ' + opts[:to]
@@ -237,10 +230,22 @@ class Sambala
   # === Interactive Returns
   # * _boolean_ = confirms if +mkdir+ operation completed successfully
   # === Example
-  #   sam.recurse   # => true
+  #   samba.recurse   # => true
   def recurse
     execute_all('recurse' ,'')
   end
+
+	# The +rmdir+ method deletes the specified directory
+	# === Parameters
+	# * :path = the relative path to the directory to be deleted
+  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # === Interactive Returns
+  # * _boolean_ = confirms if +rmdir+ operation completed successfully
+  # === Example
+	# 	samba.rmdir(:path => 'mydir')		# => true
+	def rmdir(opts={:path=>nil,:queue=>false})
+		execute('rmdir' ,opts[:path], opts[:queue])[0]
+	end
   
   # The +volume+ method returns remote volume information.
   # === Parameters
@@ -248,14 +253,14 @@ class Sambala
   # === Interactive Returns
   # * _string_ = containing +volume+ command results
   # === Example
-  #   sam.volume  # => "Volume: |geminishare| serial number 0x6d723053"
+  #   samba.volume  # => "Volume: |geminishare| serial number 0x6d723053"
   def volume(opts={:queue=>false})
     execute('volume' ,'', opts[:queue])[1]
   end
   
   # The +queue_results+ methods collect a done queue items results
   # === Example 
-  #   result = sam.queue_results
+  #   result = samba.queue_results
   def queue_results
     crop = @gardener.harvest(:full_crop)
     crop.map! { |result| [ result[:success], result[:seed], result[:message] ]  }
@@ -263,14 +268,14 @@ class Sambala
   
   # The +progress+ method returns a progress ratio indicator from 0.00 to 1.00
   # === Example
-  #   progress = sam.progress   # => 0.75
+  #   progress = samba.progress   # => 0.75
   def progress
     @gardener.growth(:progress)
   end
   
   # The +close+ method safely end the smbclient session
   # === Example
-  #   sam.close
+  #   samba.close
   def close
     result = @gardener.close
     result.values.map { |queue| queue.empty? }.uniq.size == 1 ? true : false

data/lib/sambala_gardener.rb

@@ -11,6 +11,7 @@ class Sambala
   # 
   # :title:Sambala::Gardener
   module Gardener
+		require 'timeout'
     
     # The +execute+ method splits the execution according to the operation mode: queue or interactive.
     # === Parameters
@@ -31,7 +32,6 @@ class Sambala
     # === Example
     #   result = execute_all('mask','match*')   # =>  true
     def execute_all(command,data)
-      sleep 1
       result = @gardener.seed_all("#{command} #{data}")
       bools = result.map { |row| row[:success] }
       bools.uniq.size == 1 ? true : false
@@ -65,11 +65,15 @@ class Sambala
       init = []
       catch :gardener do
         4.times do |num|
-          init_gardener; init = @init_status = @gardener.init_status
-          init.map! { |result| result[:success] }
-          throw :gardener if init.uniq.size == 1 and init[0] == true
-          @gardener.close; @gardener = nil
-          @options[:threads] -= 1 unless @options[:threads] == 1; @options[:init_timeout] += 1
+          init_gardener; sleep 1
+					begin
+						Timeout.timeout(2) { @init_status = @gardener.init_status }
+						init = @init_status
+          	init.map! { |result| result[:success] }
+          	throw :gardener if init.uniq.size == 1 and init[0] == true
+					rescue Timeout::Error
+					end
+					kill_gardener_and_incr
         end
         raise SmbInitError.exception("Couldn't set smbclient properly")
       end
@@ -81,7 +85,6 @@ class Sambala
         PTY.spawn("smbclient //#{@options[:host]}/#{@options[:share]} #{@options[:password]} -W #{@options[:domain]} -U #{@options[:user]}") do |r,w,pid|
           w.sync = true
           $expect_verbose = false
-          
           catch :init do
             loop do
               r.expect(/.*\xD\xAsmb:[ \x5C]*\x3E.*/) do |text|
@@ -92,15 +95,14 @@ class Sambala
               end
             end
           end
-
           Abundance.grow do |seed|
             w.print "#{seed.sprout}\r"
             catch :result do
               loop do
-                r.expect(/.*\xD\xAsmb: \w*[\x5C]*\x3E.*/) do |text|
+                r.expect(/.*\xD\xAsmb: [\x5C]*\w*[\x5C]+\x3E.*/) do |text|
                   if text != nil
                     msg = text[0]
-                    
+										
                     msg.gsub!(/smb: \w*\x5C\x3E\s*$/, '')
                     msg.gsub!(/^\s*#{seed.sprout}/, '')
                     msg.lstrip!
@@ -122,6 +124,20 @@ class Sambala
         end
       end
     end
+		
+		private
+		
+		def kill_gardener_and_incr
+			begin
+				Timeout.timeout(2) { @gardener.close }
+			rescue Timeout::Error
+				pids = @gardener.rows_pids; pids << @gardener.garden_pid
+				pids.each { |pid| Process.kill('HUP', pid)}
+			end
+			@gardener = nil
+      @options[:threads] -= 1 unless @options[:threads] == 1; @options[:init_timeout] += 1
+		end
+		
   end
   
 end

data/test/tc_sambala_main.rb

@@ -0,0 +1,98 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'sambala'
+
+TESTDIR = 'sambala_test'
+
+class TestSambalaMain < Test::Unit::TestCase
+  
+  def setup
+    check_smbclient_presence
+    get_samba_param_from_input
+    init_sambala
+  end
+  
+  def test_main
+    ls_one = check_ls
+		check_mkdir(TESTDIR)
+		check_exist(TESTDIR)
+		check_cd(TESTDIR)
+		ls_two = check_ls
+		assert(ls_one != ls_two)
+		# check_exist
+		check_cd('..')
+		check_rmdir(TESTDIR)
+  end
+  
+  def teardown
+    close = @samba.close
+    assert(close)
+  end
+  
+  private
+  
+  def check_smbclient_presence
+    answer = `smbclient --help`
+    assert(answer.include?('Usage'), "No 'smbclient' tool was found on this computer,\nPlease install 'smbclient' and try again.")
+  end
+  
+  def get_samba_param_from_input
+    puts "I will need you to input some working Samba connection settings..."
+    print "\n"; sleep 1
+    print "host name or IP: "
+    @host = $stdin.gets.chomp
+    print "share name: "
+    @share = $stdin.gets.chomp
+    print "domain: "
+    @domain = $stdin.gets.chomp
+    print "user: "
+    @user = $stdin.gets.chomp
+    print "password: "
+    @password = $stdin.gets.chomp
+    puts "I will now try to connect to #{@share.to_s} for the purpose of testing sambala..."
+    print "\n"
+  end
+  
+  def init_sambala
+    @samba = Sambala.new( :domain => @domain,
+                          :host => @host, 
+                          :share => @share,
+                          :user => @user, 
+                          :password => @password, 
+                          :threads => 1)
+    puts "Connection successfull,\nnow proceding with test:"
+  end
+  
+  def check_ls
+    result = @samba.ls
+    assert_not_nil(result)
+		result_alias = @samba.dir
+    assert_not_nil(result)
+		assert(result == result_alias)
+		return result
+  end
+
+	def check_cd(path)
+		cd = @samba.cd(:to => path)
+		assert_equal(true,cd)
+	end
+  
+	def check_exist(path)
+		exist = @samba.exist?(:mask => path)
+		assert_equal(true,exist)
+	end
+	
+	def check_mkdir(path)
+		re = @samba.mkdir(:path => path)
+		assert_equal(true,re)
+	end
+	
+	def check_rmdir(path)
+		re = @samba.rmdir(:path => path)
+		assert_equal(true,re)
+	end
+	
+	
+  
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sambala
 version: !ruby/object:Gem::Version 
-  version: 0.8.8
+  version: 0.8.9
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 -05:00
+date: 2009-01-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.6
+        version: 1.3.1
     version: 
 description: 
 email: lp@spiralix.org
@@ -33,7 +33,7 @@ extra_rdoc_files: []
 files: 
 - lib/sambala.rb
 - lib/sambala_gardener.rb
-- lib/test_sambala2.rb
+- test/tc_sambala_main.rb
 has_rdoc: true
 homepage: http://sambala.rubyforge.org/
 post_install_message: 
@@ -60,5 +60,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: ruby samba client, interactive smbclient commands session and multi-threaded smb transfer queued mode
-test_files: []
-
+test_files: 
+- test/tc_sambala_main.rb

data/lib/test_sambala2.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
-# require 'test/unit'
-# require 'rubygems'
-require 'sambala'
-
-puts "init"
-begin
-# b = Sambala.new(  :domain => 'TCSMTLPROD',
-#                   :host => 'modulagampc', 
-#                   :share => 'testBkp',
-#                   :user => 'perronlo', 
-#                   :password => 'lpMOD1135', 
-#                   :threads => 4 )
-# rescue Sambala::SmbInitError
-#   raise RuntimeError.exception("Couldn't initialise Sambala")
-# end
-
-b = Sambala.new(  :domain => '',
-                  :host => 'spiralgemini', 
-                  :share => 'geminishare',
-                  :user => 'leelasheel', 
-                  :password => 'goLEELAubu', 
-                  :threads => 2 )
-rescue Sambala::SmbInitError
-  raise RuntimeError.exception("Couldn't initialise Sambala")
-end
-
-puts "init Sambala done"
-puts "sambala object: #{b.inspect}"
-b.lowercase
-puts "done lowercase"
-# l = b.ls
-l = b.ls(:mask => 'gen*')
-puts "progress is: #{b.progress}"
-puts "ls: #{l.inspect}"
-# pu = b.put(:from => 'shoe.rb')
-# puts "progress is: #{b.progress}"
-# puts "put: #{pu.inspect}"
-
-# g = b.get(:from => 'inin.rb')
-# puts "get: #{g.inspect}"
-v = b.volume
-puts "progress is: #{b.progress}"
-puts "volume: #{v.inspect}"
-
-b.recurse
-d = b.du
-puts "progress is: #{b.progress}"
-puts "du: #{d.inspect}"
-# c = b.close
-# puts "CCCCCCCCCC is: #{c.inspect}"
-
-lsqueue = b.ls(:queue => true)
-puts "lsqueue: #{lsqueue.inspect} #{lsqueue.class}"
-# b.put(:from => 'ore.rb', :queue => true)
-puts "progress is: #{b.progress}"
-# b.get(:from => 'TEST.rb', :queue => true)
-b.volume(:queue => true)
-puts "progress is: #{b.progress}"
-b.du(:queue => true)
-puts "progress is: #{b.progress}"
-
-res = b.queue_results
-puts "results is: #{res.inspect}"
-# sleep 1
-# b.recurse
-# l = b.ls
-# puts "ls: #{l.inspect}"
-
-c = b.close
-puts "CCCCCCCCCC is: #{c.inspect}"