sambala 0.8.9 → 0.9.0

data/lib/sambala.rb

@@ -62,50 +62,47 @@ class Sambala
 
   # 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
+  # * _to_ = the path to change directory to
   # === Interactive Returns
   # * _boolean_ = confirms if +cd+ operation completed successfully
   # === Example
-  #   samba.cd(:to => 'aFolder/anOtherFolder/')   # =>  true
-  def cd(opts={:to => ''})
-		execute_all('cd', opts[:to])
+  #   samba.cd('aFolder/anOtherFolder/')   # =>  true
+  def cd(to='.')
+		execute_all('cd',to)
   end
   
-  # The +du+ instance does exactly what _du_ usually does: estimates file space usage.
-  # === Parameters
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # The +du+ instance method does exactly what _du_ usually does: estimates file space usage.
   # === Interactive Returns
   # * _string_ = +du+ command results
   # === Example
   #   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]
+  def du
+    execute('du', '', false)[1]
   end
   
   # The +del+ instance method delete files on smb shares
   # === Parameters
-  # * :mask = the mask matching the file to be deleted inside the current working directory.
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _mask_ = the mask matching the file to be deleted inside the current working directory.
+  # * _queue_ = sets queue processing mode. Defaults to interactive mode when no option given.
   # === Interactive Returns
   # * _boolean_ = confirms if +del+ operation completed successfully
   # === Example
-  #   samba.del(:mask => 'aFile')   # =>  true
-  def del(opts={:mask => nil, :queue=>false})
-    execute('del', opts[:mask], opts[:queue])[0]
+  #   samba.del('aFile')   # =>  true
+  def del(mask, queue=false)
+    execute('del', mask, queue)[0]
   end
   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.
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _mask_ = the mask matching the file or directory to look for.
   # === Interactive Returns
   # * _boolean_ = confirm the presence of a matching file or directory
   # === Example
-  #   samba.exist?(:mask => 'aFile')  # => true
-  def exist?(opts={:mask => nil, :queue => false})
-    execute('ls', opts[:mask], opts[:queue])[0]
+  #   samba.exist?('aFile')  # => true
+  def exist?(mask)
+    execute('ls', mask, false)[0]
   end
   
   # The +get+ instance method copy files from smb shares.
@@ -125,13 +122,13 @@ class Sambala
   
   # 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
+  # * _to_ = the path to change directory to
   # === Interactive Returns
   # * _boolean_ = confirms if +cd+ operation completed successfully
   # === Example
-  #   samba.lcd(:to => 'aLocalFolder/anOtherFolder/')   # => true
-  def lcd(opts={:to => ''})
-		execute_all('lcd', opts[:to])
+  #   samba.lcd('aLocalFolder/anOtherFolder/')   # => true
+  def lcd(to='.')
+		execute_all('lcd', to)
   end
   
   # The +lowercase+ method toggles lowercasing of filenames for the get command.
@@ -147,15 +144,14 @@ class Sambala
   
   # The method +ls+ or its alias _dir_, list the files and directories matching :mask in the current working directory on the smb server.
   # === Parameters
-  # * :mask = the mask matching the file to be listed inside the current working directory.
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _mask_ = the mask matching the file to be listed inside the current working directory.
   # === Interactive Returns
   # * _string_ = containing +ls+ command results
   # === Example
   #   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]
+  def ls(mask='')
+    execute('ls' ,mask, false)[1]
   end
   alias dir ls
   
@@ -163,50 +159,50 @@ class Sambala
   # See man page for smbclient to get more on the details of operation
   # This method has no queue processing option
   # === Parameters
-  # * :mask = the matching filter
+  # * _mask_ = the matching filter
   # === Example
-  #   samba.mask(:mask => 'filter*')  # => true
-  def mask(opts={:mask => nil})
-    execute_all('mask' ,opts[:mask])
+  #   samba.mask('filter*')  # => true
+  def mask(mask)
+    execute_all('mask' ,mask)
   end
   
   # The +mget+ method copy all files matching :mask from the server to the client machine
   # See man page for smbclient to get more on the details of operation
   # === Parameters
-  # * :mask = the file matching filter
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _mask_ = the file matching filter
+  # * _queue_ = sets queue processing mode. Defaults to interactive mode when no option given.
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _mgetResultMessage_ ]
   # === Example
-  #   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])
+  #   samba.mget('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(mask,queue=false)
+    execute('mget' ,mask, queue)
   end
   
   # The method +mkdir+ or its alias _md_, creates a new directory on the server.
   # === Parameters
-  # * :path = the directory to create
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _path_ = the directory to create
+  # * _queue_ = sets queue processing mode. Defaults to interactive mode when no option given.
   # === Interactive Returns
   # * _boolean_ = confirms if +mkdir+ operation completed successfully
   # === Example
-  #   samba.mkdir(:path => 'aFolder/aNewFolder')  # => true
-  def mkdir(opts={:path => '', :queue => false})
-    execute('mkdir' ,opts[:path], opts[:queue])[0]
+  #   samba.mkdir('aFolder/aNewFolder')  # => true
+  def mkdir(path, queue=false)
+    execute('mkdir' ,path, queue)[0]
   end
   alias md mkdir
   
   # The +mput+ method copy all files matching :mask in the current working directory on the local machine to the server.
   # See man page for smbclient to get more on the details of operation
   # === Parameters
-  # * :mask = the file matching filter
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
+  # * _mask_ = the file matching filter
+  # * _queue_ = sets queue processing mode. Defaults to interactive mode when no option given.
   # === Interactive Returns
   # _array_ = [ _booleanSuccess_, _mputResultMessage_ ]
   # === Example
-  #   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])
+  #   samba.mput('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(mask, queue=false)
+    execute('mput' ,mask, queue)
   end
   
   # The +put+ instance method copy files to smb shares.
@@ -237,26 +233,35 @@ class Sambala
 
 	# 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.
+	# * _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]
+	# 	samba.rmdir('mydir')		# => true
+	def rmdir(path,queue=false)
+		execute('rmdir' , path, queue)[0]
 	end
   
   # The +volume+ method returns remote volume information.
-  # === Parameters
-  # * :queue = sets queue processing mode. Defaults to interactive mode when no option given.
   # === Interactive Returns
   # * _string_ = containing +volume+ command results
   # === Example
   #   samba.volume  # => "Volume: |geminishare| serial number 0x6d723053"
-  def volume(opts={:queue=>false})
-    execute('volume' ,'', opts[:queue])[1]
+  def volume
+    execute('volume' ,'', false)[1]
   end
+
+	# The +local+ methods allow shell command execution on the local machine.
+	# === Parameters
+	# * _command_ = the shell comand to be executed locally
+	# === Interactive Returns
+	# * _string_ = the normal return message of the command
+	# === Example
+	# 	samba.local('mkdir mydir')
+	def local(command)
+		execute('!', command, false)[1]
+	end
   
   # The +queue_results+ methods collect a done queue items results
   # === Example 

data/test/tc_sambala_main.rb

@@ -2,7 +2,17 @@ $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require 'test/unit'
 require 'sambala'
 
-TESTDIR = 'sambala_test'
+TESTFILE = 'sambala_test'
+TESTDIR = 'sambala_temp'
+WELCOME = "
+  .|'''.|                     '||              '||          
+  ||..  '   ....   .. .. ..    || ...   ....    ||   ....   
+   ''|||.  '' .||   || || ||   ||'  || '' .||   ||  '' .||  
+ .     '|| .|' ||   || || ||   ||    | .|' ||   ||  .|' ||  
+ |'....|'  '|..'|' .|| || ||.  '|...'  '|..'|' .||. '|..'|' 
+
+
+/////////////////////////////////////////////////////////////"
 
 class TestSambalaMain < Test::Unit::TestCase
   
@@ -17,16 +27,20 @@ class TestSambalaMain < Test::Unit::TestCase
 		check_mkdir(TESTDIR)
 		check_exist(TESTDIR)
 		check_cd(TESTDIR)
+		
 		ls_two = check_ls
 		assert(ls_one != ls_two)
+		check_lcd_put_get
 		# check_exist
 		check_cd('..')
 		check_rmdir(TESTDIR)
   end
   
   def teardown
+		@samba.rmdir(TESTDIR) if @samba.exist?(TESTDIR)
     close = @samba.close
     assert(close)
+		Dir.rmdir(TESTDIR) if File.exist?(TESTDIR)
   end
   
   private
@@ -37,6 +51,7 @@ class TestSambalaMain < Test::Unit::TestCase
   end
   
   def get_samba_param_from_input
+		puts WELCOME
     puts "I will need you to input some working Samba connection settings..."
     print "\n"; sleep 1
     print "host name or IP: "
@@ -73,23 +88,63 @@ class TestSambalaMain < Test::Unit::TestCase
   end
 
 	def check_cd(path)
-		cd = @samba.cd(:to => path)
+		cd = @samba.cd(path)
 		assert_equal(true,cd)
 	end
   
 	def check_exist(path)
-		exist = @samba.exist?(:mask => path)
+		exist = @samba.exist?(path)
 		assert_equal(true,exist)
 	end
 	
 	def check_mkdir(path)
-		re = @samba.mkdir(:path => path)
+		re = @samba.mkdir(path)
 		assert_equal(true,re)
 	end
 	
 	def check_rmdir(path)
-		re = @samba.rmdir(:path => path)
+		re = @samba.rmdir(path)
+		assert_equal(true,re)
+	end
+	
+	def check_lcd_put_get
+		before = @samba.local('ls')
+		@samba.local("mkdir #{TESTDIR}")
+		after = @samba.local('ls')
+		assert(before != after)
+		
+		re = @samba.lcd(TESTDIR)
+		assert_equal(true,re)
+		before2 = @samba.local('ls')
+		@samba.local("touch #{TESTFILE}")
+		after2 = @samba.local('ls')
+		assert(before2 != after2)
+		
+		
+		re = @samba.put(:from => TESTFILE, :to => TESTFILE)
+		assert_kind_of(Array,re)
+		assert_equal(true,re[0])
+		
+		@samba.local("rm #{TESTFILE}")
+		after2_2 = @samba.local('ls')
+		assert(before2 == after2_2)
+		
+		re = @samba.get(:from => TESTFILE, :to => TESTFILE)
+		assert_kind_of(Array,re)
+		assert_equal(true,re[0])
+		
+		re = @samba.del(TESTFILE)
+		assert_equal(true,re)
+		
+		after2_3 = @samba.local('ls')
+		assert(after2 == after2_3)
+		@samba.local("rm #{TESTFILE}")
+		
+		re = @samba.lcd('..')
 		assert_equal(true,re)
+		@samba.local("rmdir #{TESTDIR}")
+		after = @samba.local('ls')
+		assert(before == after)
 	end
 	
 	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sambala
 version: !ruby/object:Gem::Version 
-  version: 0.8.9
+  version: 0.9.0
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-27 00:00:00 -05:00
+date: 2009-01-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency