sambal 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f975857d880b0980139c775c4209198a0fc61d
-  data.tar.gz: 736a0bff136bf70413f17df9e54a691b38e26a3a
+  metadata.gz: ec4f0b1b79fd466d3545c06238d4685e02d690cd
+  data.tar.gz: 8036f666109f31542df162291523a7742af88d81
 SHA512:
-  metadata.gz: c64dd602dc5e03c8c5d4b2f72664e0fd2edf37fca88b795ee0f1ebb9d977d483c0e071728d187f45ce10bbbf4cb94f20b4fc7fe62a2eea031d11909201b07fad
-  data.tar.gz: 16d10c22578db5eb2ac0b30835d892b41588cf4a79b953d9ad3231e0c3735a8808001edde69f8d1631470d9ff41a997fe5aacc9017efd66f34c2fb9c8cb20be6
+  metadata.gz: 73f4147a17833f4d2c308c60a0b66a1687d2e98eb5ab384d60bfb1442d9e92f922515fd8c1f62a4514aa54153342a12edaa1c8906da0e64e3d36127b6d6bba6d
+  data.tar.gz: a5407cf3408aa99a2b8887b8863c62713b35f602b637303160e740033711c86e0d2542d5395897e6b7ca066f463b3c712e023e3cdb9bae4c077ac19da0e02c5b

data/README.md

@@ -24,13 +24,13 @@ Or install it yourself as:
 
 A working installation of samba, specifically the "smbclient" command line utility. See http://www.samba.org for more information.
 On a mac this can be installed through homebrew https://github.com/mxcl/homebrew, like this:
-    
+
     brew install samba
 
 On the Mac it can probably also be installed both through Fink and MacPorts.
 
 On Linux (Ubuntu) it's as easy as:
-    
+
     apt-get install smbclient
 
 It should be available in a similar way on all major Linux distributions.
@@ -40,9 +40,11 @@ It should be available in a similar way on all major Linux distributions.
     client = Sambal::Client.new(domain: 'WORKGROUP', host: '127.0.0.1', share: '', user: 'guest', password: '--no-pass', port: 445)
     client.ls # returns hash of files
     client.put("local_file.txt","remote_file.txt") # uploads file to server
+    client.exists?("remote_file.txt") # checks if file is on server
     client.put_content("My content here", "remote_file") # uploads content to a file on server
     client.get("remote_file.txt", "local_file.txt") # downloads file from server
     client.del("remote_file.txt") # deletes files from server
+    client.exists?("some_directory") # checks if directory is on server
     client.cd("some_directory") # changes directory on server
     client.close # closes connection
 

data/lib/sambal/client.rb

@@ -9,12 +9,34 @@ module Sambal
 
     attr_reader :connected
 
-    def initialize(options={})
+    def parsed_options(user_options)
+      default_options = {
+        domain: 'WORKGROUP',
+        host: '127.0.0.1',
+        share: '',
+        user: 'guest',
+        password: '--no-pass',
+        port: 445,
+        timeout: 10,
+        columns: 80
+      }
+
+      options = default_options.merge(user_options)
+      options[:ip_address] ||= options[:host] if options[:host] == default_options[:host]
+      options
+    end
+
+    def initialize(user_options={})
       begin
-        options = {domain: 'WORKGROUP', host: '127.0.0.1', share: '', user: 'guest', password: '--no-pass', port: 445, timeout: 10, columns: 80}.merge(options)
+        options = parsed_options(user_options)
         @timeout = options[:timeout].to_i
-        @o, @i, @pid = PTY.spawn("COLUMNS=#{options[:columns]} smbclient \"//#{options[:host]}/#{options[:share]}\" '#{options[:password]}' -W \"#{options[:domain]}\" -U \"#{options[:user]}\" -p #{options[:port]}")
-        res = @o.expect(/(.*\n)?smb:.*\\>/, @timeout)[0] rescue nil
+
+        option_flags = "-W \"#{options[:domain]}\" -U \"#{options[:user]}\" -I #{options[:ip_address]} -p #{options[:port]}"
+        command = "COLUMNS=#{options[:columns]} smbclient \"//#{options[:host]}/#{options[:share]}\" '#{options[:password]}'"
+
+        @output, @input, @pid = PTY.spawn(command + ' ' + option_flags)
+
+        res = @output.expect(/(.*\n)?smb:.*\\>/, @timeout)[0] rescue nil
         @connected = case res
         when nil
           $stderr.puts "Failed to connect"
@@ -70,6 +92,10 @@ module Sambal
       parse_files(ask_wrapped('ls', qualifier))
     end
 
+    def exists?(path)
+      ls(path).key? File.basename(path)
+    end
+
     def cd(dir)
       response = ask("cd \"#{dir}\"")
       if response.split("\r\n").join('') =~ /NT_STATUS_OBJECT_NAME_NOT_FOUND/
@@ -79,9 +105,9 @@ module Sambal
       end
     end
 
-    def get(file, output)
+    def get(filename, output)
       begin
-        file_context(file) do |file|
+        file_context(filename) do |file|
           response = ask_wrapped 'get', [file, output]
           if response =~ /^getting\sfile.*$/
             Response.new(response, true)
@@ -157,9 +183,9 @@ module Sambal
       end
     end
 
-    def del(file)
+    def del(filename)
       begin
-        file_context(file) do |file|
+        file_context(filename) do |file|
           response = ask_wrapped 'del', file
           next_line = response.split("\n")[1]
           if next_line =~ /^smb:.*\\>/
@@ -202,15 +228,15 @@ module Sambal
     end
 
     def close
-      @i.close
-      @o.close
+      @input.close
+      @output.close
       Process.wait(@pid)
       @connected = false
     end
 
     def ask(cmd)
-      @i.printf("#{cmd}\n")
-      response = @o.expect(/^smb:.*\\>/,@timeout)[0] rescue nil
+      @input.printf("#{cmd}\n")
+      response = @output.expect(/^smb:.*\\>/,@timeout)[0] rescue nil
       if response.nil?
         $stderr.puts "Failed to do #{cmd}"
         raise Exception.new, "Failed to do #{cmd}"
@@ -229,30 +255,33 @@ module Sambal
       [cmd,filenames].flatten.join(' ')
     end
 
+    # Parse output from Client#ls
+    # Returns Hash of file names with meta information
     def parse_files(str)
-      files = {}
-      str.each_line do |line|
-        if line =~ /\s+([\w\.\d\-\_\?\!\s]+)\s+([DAH]?)\s+(\d+)\s+(.+)$/
-          lsplit = line.split(/\s{2,}/)
-          #$stderr.puts "lsplit: #{lsplit}"
-          lsplit.shift ## remove first empty string
-          name = lsplit.shift#$1
-          if lsplit.first =~ /^[A-Za-z]+$/
-            type = lsplit.shift
-          else
-            type = ""
-          end
-          size = lsplit.shift#$3
-          date = lsplit.join(' ')#$4
-          name.gsub!(/\s+$/,'')
-          files[name] = if type =~/^D.*$/
-            {type: :directory, size: size, modified: (Time.parse(date) rescue "!!#{date}")}
-          else
-            {type: :file, size: size , modified: (Time.parse(date) rescue "!!#{date}")}
-          end
+      listing = str.each_line.inject({}) do |files, line|
+        line.strip!
+        name = line[/.*(?=\b\s+[ABDHNRS]+\s+\d+)/]
+        name ||= line[/^\.\.|^\./]
+
+        if name
+          line.sub!(name, '')
+          line.strip!
+
+          type = line[0] == "D" ? :directory : :file
+          size = line[/\d+/]
+
+          date = line[/(?<=\d  )\D.*$/]
+          modified = (Time.parse(date) rescue "!!#{date}")
+
+          files[name] = {
+            type: type,
+            size: size,
+            modified: modified
+          }
         end
+        files
       end
-      files
+      Hash[listing.sort]
     end
   end
 end

data/lib/sambal/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module Sambal
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/sambal/client_spec.rb

@@ -6,6 +6,7 @@ require 'tempfile'
 describe Sambal::Client do
 
   TEST_DIRECTORY_WITH_SPACE_IN_NAME = 'my dir with spaces in name'
+  TEST_DIRECTORY_WITH_CONSECUTIVE_SPACES_IN_NAME = 'my dir with   consecutive spaces in name'
   TEST_FILE_IN_DIRECTORY_WITH_SPACE_IN_NAME = 'a_file_in_a_dir_with_spaces_in_name'
   TEST_SPACES_IN_NAME_PATH = "#{TEST_DIRECTORY_WITH_SPACE_IN_NAME}/#{TEST_FILE_IN_DIRECTORY_WITH_SPACE_IN_NAME}"
   TEST_DIRECTORY = 'testdir'
@@ -26,6 +27,7 @@ describe Sambal::Client do
       f << "Hello"
     end
     FileUtils.mkdir_p "#{test_server.share_path}/#{TEST_DIRECTORY_WITH_SPACE_IN_NAME}"
+    FileUtils.mkdir_p "#{test_server.share_path}/#{TEST_DIRECTORY_WITH_CONSECUTIVE_SPACES_IN_NAME}"
     File.open("#{test_server.share_path}/#{TEST_DIRECTORY_WITH_SPACE_IN_NAME}/#{TEST_FILE_IN_DIRECTORY_WITH_SPACE_IN_NAME}", 'w') do |f|
       f << "Hello there"
     end
@@ -67,6 +69,7 @@ describe Sambal::Client do
     it "should list files with spaces in their names" do
       result = @sambal_client.ls
       expect(result).to have_key(TEST_DIRECTORY_WITH_SPACE_IN_NAME)
+      expect(result).to have_key(TEST_DIRECTORY_WITH_CONSECUTIVE_SPACES_IN_NAME)
     end
 
     it "should list files on an smb server" do
@@ -84,6 +87,20 @@ describe Sambal::Client do
     end
   end
 
+  describe 'exists?' do
+    it "returns true if a file or directory exists at a given path" do
+      expect(@sambal_client.exists?(TESTFILE)).to eq(true)
+      expect(@sambal_client.exists?(TESTFILE_SUB_PATH)).to eq(true)
+      expect(@sambal_client.exists?(TEST_DIRECTORY)).to eq(true)
+      expect(@sambal_client.exists?(SUB_DIRECTORY_PATH)).to eq(true)
+    end
+
+    it "returns false if nothing exists at a given path" do
+      expect(@sambal_client.exists?('non_existing_file.txt')).to eq(false)
+      expect(@sambal_client.exists?('non_existing_directory')).to eq(false)
+    end
+  end
+
   describe 'mkdir' do
     before(:all) do
       @sambal_client.cd('/')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sambal
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - John Axel Eriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby Samba Client