fun_sftp 0.0.9 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67b220be2614c7b34c153b584f02238f0174b74f
+  data.tar.gz: 22115d2401251baea5304935624f743d9916c245
+SHA512:
+  metadata.gz: 8f888a31d041721867705096b1854a40eb3927a000bf0e7f4581628ae314762b18dd220790960f4723c9a20b4538f294684006554c64a2c7a5842c251d014f20
+  data.tar.gz: 99611e5cb32b7f67c38136418eef4100e31a37919092f1ae5dd4e24b05ab51124915987ee937f1a7ed5514486294da93042a1252844576d244eb01925e205966

data/README.md

@@ -50,7 +50,7 @@ If you need to start from scratch then reset to the base path:
 
 ```ruby
 conn.reset_path!
-# => "Path Reset and set to => ."
+# => "Path Reset!"
 ```
 
 Now, you can upload your file:
@@ -86,6 +86,20 @@ conn.read("path/to/file_name.txt")
 # => Hello World!
 ```
 
+It is also possible to read the attributes size, access time and modified time.
+
+```ruby
+conn.size("path/to/file_name.txt")
+# => 1413455562
+# works also for directories
+
+conn.atime("path/to/file_name.txt")
+# => 2014-10-16 12:32:42 +0200
+
+conn.mtime("path/to/file_name.txt")
+#=> 2014-10-16 12:32:42 +0200
+```
+
 When investigating items on the remote host, these commands can be handy:
 
 ```ruby
@@ -172,7 +186,7 @@ Contribute
 License
 -------
 
-Copyright (c) 2013 George Diaz
+Copyright (c) 2014 George Diaz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/fun_sftp.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'net-sftp'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
 end

data/lib/fun_sftp.rb

@@ -13,134 +13,128 @@ $VERBOSE = orig_verbose
 # Reference: http://net-ssh.rubyforge.org/sftp/v2/api/
 module FunSftp
   class SFTPClient
-    attr_accessor :server, :user, :password, :client, :source
+
+    attr_accessor :source
+
+    attr_reader :server, :user, :password, :client
+
+    alias_method :pwd, :source
 
     def initialize(server, user, password)
       @server, @user, @password = server, user, password
-      @source = '.'
+      self.source = '.'
       @client = setup_login
     end
 
-    def source=(path)
-      @source = clean_path(path)
-    end
-
     def setup_login
-      Net::SFTP.start(@server, @user, :password => @password)
+      Net::SFTP.start(server, user, password: password)
     end
 
-    def upload!(source, target) #send to remote
+    def upload!(src, target) #send to remote
       #target example: 'some_directory/some_name.txt'
-      opts = {:progress => UploadCallbacks.new, :recursive => true}
-      converted_target = join_to_pwd(target)
+      opts = { progress: UploadCallbacks.new, recursive: true }
+      converted_target = clean_path(target)
       opts.delete(:progress) unless FunSftp.loggable?
-      opts.delete(:recursive) unless has_directory?(converted_target)
-      @client.upload!(source, converted_target, opts)
+      opts.delete(:recursive) unless has_directory?(target)
+      client.upload!(src, converted_target, opts)
     end
 
-    def download!(target, source) #fetch locally from remote
-      opts = {:progress => DownloadCallbacks.new, :recursive => true}
-      converted_target = join_to_pwd(target)
+    def download!(target, src) #fetch locally from remote
+      opts = { progress: DownloadCallbacks.new, recursive: true}
+      converted_target = clean_path(target)
       opts.delete(:progress) unless FunSftp.loggable?
-      opts.delete(:recursive) unless has_directory?(converted_target)
-      @client.download!(converted_target, source, opts)
+      opts.delete(:recursive) unless has_directory?(target)
+      client.download!(converted_target, src, opts)
     end
 
     def read(path) #read a file
-      file = @client.file.open(join_to_pwd(path))
+      file = client.file.open(clean_path(path))
       while !file.eof?
         puts file.gets
       end
     end
 
-    def glob(path, pattern) # ex: ('some_directory', '**/*.rb')
-      @client.dir.glob(join_to_pwd(path), pattern).collect(&:name)
+    def size(path) #returns the size of a file. ex: => 1413455562
+      client.file.open(clean_path(path)).stat.size
+    end
+
+    def atime(path) #returns the atime (access time) of a file. ex: => 2014-10-16 12:32:42 +0200
+      Time.at(client.file.open(clean_path(path)).stat.atime)
+    end
+
+    def mtime(path) #returns the mtime (modified time) of a file. ex: => 2014-10-16 12:32:42 +0200
+      Time.at(client.file.open(clean_path(path)).stat.mtime)
+    end
+
+    def glob(path, pattern='**/*') # ex: ('some_directory', '**/*.rb')
+      client.dir.glob(clean_path(path), pattern).collect(&:name)
     end
+    alias_method :items_in, :glob
 
     def entries(dir, show_dot_files = false) #array of directory entries not caring for '.' files
-      entries_arr = @client.dir.entries(join_to_pwd(dir)).collect(&:name)
+      entries_arr = client.dir.entries(clean_path(dir)).collect(&:name)
       entries_arr.reject!{|a| a.match(/^\..*$/)} unless show_dot_files
       entries_arr
     end
 
-    def has_directory?(dir) #returns true if directory exists
+    def has_directory?(dir)
       begin
-        true if entries(dir)
+        true if client.dir.entries(clean_path(dir)).any?
       rescue Net::SFTP::StatusException => e
         false
       end
     end
 
-    def print_directory_items(dir) #printout of directory's items
-      @client.dir.foreach(join_to_pwd(dir)) { |file| puts "#{file.name}" }
-    end
-
-    def items_in(root_dir) #array of *all* directories & files inside provided root directory
-      glob(root_dir, '**/*').sort
+    def print_directory_items(dir='.') #printout of directory's items
+      client.dir.foreach(clean_path(dir)) { |file| puts "#{file.name}" }
     end
-
-    #################################
-    # Some Handy File Util Methods  #
-    #################################
+    alias_method :ll, :print_directory_items
 
     def mkdir!(path) #make directory
-      @client.mkdir!(join_to_pwd(path))
+      client.mkdir!(clean_path(path))
     end
 
     def rm(path) #remove a file
-      @client.remove!(join_to_pwd(path))
+      client.remove!(clean_path(path))
     end
 
     def rmdir!(path) #remove directory
-      @client.rmdir!(join_to_pwd(path))
+      client.rmdir!(clean_path(path))
     end
 
     def rename(name, new_name) #rename a file
-      previous, renamed = join_to_pwd(name), join_to_pwd(new_name)
-      @client.rename!(previous, renamed)
-    end
-
-    def ll
-      print_directory_items('.')
+      previous, renamed = clean_path(name), clean_path(new_name)
+      client.rename!(previous, renamed)
     end
 
     def chdir(path)
-      if path =~ /~/
-        new_path = clean_path(path)
-        change_directory_check(new_path, path)
+      clean_path = clean_path(path)
+      if has_directory? path
+        self.source = clean_path
+        "Current Path change to => #{source}"
       else
-        change_directory_check(join_to_pwd(path), path)
+        "Sorry Path => #{path} not found"
       end
     end
 
-    def pwd
-      @source
-    end
-
     def reset_path!
-      @source = '.'
-      "Path Reset and set to => #{@source}"
+      self.source = '.'
+      "Path Reset!"
     end
 
     private
 
     def join_to_pwd(path)
-      File.join(@source, path)
+      File.join(source, path)
     end
 
     def clean_path(path)
-      tilda_ith = path.rindex(/~/)
-      new_path = path[tilda_ith..-1].gsub(/~/, '.')
-    end
-
-    def change_directory_check(converted_path, entered_path)
-      if has_directory? converted_path
-        @source = converted_path
-        "Current Path changed to => #{@source}"
+      if path.start_with? '~'
+        path.sub(/~/, '.')
       else
-        "Sorry Path => #{entered_path} not found"
+        Pathname(join_to_pwd(path)).cleanpath.to_path
       end
     end
 
   end
-end
+end

data/lib/fun_sftp/version.rb

@@ -1,3 +1,3 @@
 module FunSftp
-  VERSION = "0.0.9"
+  VERSION = "1.0.0"
 end

data/spec/fun_sftp/sftp_client_spec.rb

@@ -3,67 +3,103 @@ require 'spec_helper'
 module FunSftp
   describe 'sftp client' do
 
-    let(:sftp_mock) {double('sftp')} #sftp_mock is the @client var
+    let(:sftp_mock) { double('sftp') }
 
     before do
-      Net::SFTP.stub(:start => sftp_mock)
+      allow(Net::SFTP).to receive(:start).and_return(sftp_mock)
     end
 
     context 'initialization' do
       it 'should initialize with creds' do
         expect(SFTPClient).to receive(:new).with('localhost', 'user1', 'pass')
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
+        SFTPClient.new('localhost', 'user1', 'pass')
       end
     end
 
-    describe 'file utilities' do
-      let(:file_1) {double("sftp_dir", :name => ".")}
-      let(:dir_1) {double("sftp_dir", :name => "import_docs")}
-      let(:dir_2) {double("sftp_dir", :name => "training_docs")}
+    context 'file utilities' do
+      let(:sftp_cli) { SFTPClient.new('localhost', 'user1', 'pass') }
+      let(:test_file) { File.expand_path('../../support/test1.txt', __FILE__) }
+      let(:file_1) { double('sftp_dir', name: '.') }
+      let(:dir_1) { double('sftp_dir', name: 'import_docs') }
+      let(:dir_2) { double('sftp_dir', name: 'training_docs') }
 
-      it "should return entries without prepended '.' " do
-        sftp_mock.stub_chain(:dir, :entries).with(anything()).and_return([file_1, dir_1, dir_2])
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        expect(@sftp_cli.entries('Desktop')).to eq([dir_1.name, dir_2.name])
+      before do
+        allow(sftp_mock).to receive_message_chain(:file, :open).with(anything()).and_return(File.open(test_file))
       end
 
-      it "should return with all files including '.' " do
-        sftp_mock.stub_chain(:dir, :entries).with(anything()).and_return([file_1, dir_1, dir_2])
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        expect(@sftp_cli.entries('Desktop', true)).to eq([file_1.name, dir_1.name, dir_2.name])
+      describe '#entries' do
+        before do
+          allow(sftp_mock).to receive_message_chain(:dir, :entries).with('Desktop').and_return([file_1, dir_1, dir_2])
+        end
+
+        it "should return entries without prepended '.' " do
+          expect(sftp_cli.entries('Desktop')).to eq([dir_1.name, dir_2.name])
+        end
+
+        it "should return with all files including '.' " do
+          expect(sftp_cli.entries('Desktop', true)).to eq([file_1.name, dir_1.name, dir_2.name])
+        end
+      end
+
+      describe '#read' do
+        it 'should read both lines from test file' do
+          expect(sftp_cli).to receive(:puts).twice
+          sftp_cli.read(test_file)
+        end
+      end
+
+      describe '#size' do
+        it 'should get the size from test file' do
+          expect(sftp_cli.size(test_file)).to eq(File.size(test_file))
+        end
+      end
+
+      describe '#atime' do
+        it 'should get the atime from test file' do
+          expect(sftp_cli.atime(test_file)).to eq(File.atime(test_file))
+        end
       end
 
-      it 'should read both lines from test file' do
-        file = File.expand_path('../../support/test1.txt', __FILE__)
-        sftp_mock.stub_chain(:file, :open).with(anything()).and_return(File.open(file))
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        expect(@sftp_cli).to receive(:puts).twice
-        @sftp_cli.read(file)
+      describe '#mtime' do
+        it 'should get the mtime from test file' do
+          expect(sftp_cli.mtime(test_file)).to eq(File.mtime(test_file))
+        end
       end
 
-      it 'should return false for directory not found' do
-        sftp_response = Object.new
-        def sftp_response.code; code = 2 end
-        def sftp_response.message; message = 'no such file' end
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        @sftp_cli.stub(:entries).and_raise(Net::SFTP::StatusException.new(sftp_response))
-        expect(@sftp_cli.has_directory?('bogus_directory')).to eql(false)
+      describe '#has_directory?' do
+        it 'should return false for directory not found' do
+          sftp_response = Object.new
+          def sftp_response.code; code = 2 end
+          def sftp_response.message; message = 'no such file' end
+          allow(sftp_mock).to receive_message_chain(:dir, :entries, :any?).and_raise(Net::SFTP::StatusException.new(sftp_response))
+          expect(sftp_cli.has_directory?('bogus_directory')).to eql(false)
+        end
       end
 
-      it 'should change directory source path' do
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        @sftp_cli.stub(:has_directory?).with(anything()).and_return(true)
-        @sftp_cli.chdir('projects')
-        expect(@sftp_cli.source).to eql('./projects')
+      describe '#chdir' do
+        before do
+          allow(sftp_cli).to receive(:has_directory?).with(anything()).and_return(true)
+        end
+
+        it 'should change directory source path' do
+          sftp_cli.chdir('projects')
+          expect(sftp_cli.source).to eq('projects')
+        end
+
+        it 'should sub tilda for period in path' do
+          sftp_cli.chdir('~/some_dir/working_dir')
+          expect(sftp_cli.source).to eq('./some_dir/working_dir')
+        end
       end
 
-      it 'should sub tilda in path' do
-        @sftp_cli = SFTPClient.new('localhost', 'user1', 'pass')
-        @sftp_cli.stub(:has_directory?).with(anything()).and_return(true)
-        @sftp_cli.chdir('~/some_dir/working_dir')
-        expect(@sftp_cli.source).to eql('./some_dir/working_dir')
+      describe '#reset_path!' do
+        it 'resets source' do
+          sftp_cli.source = 'some_dir/one'
+          sftp_cli.reset_path!
+          expect(sftp_cli.source).to eq('.')
+        end
       end
     end
 
   end
-end
+end

metadata

@@ -1,62 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: fun_sftp
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - George Diaz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Wrapper for Ruby's Net::SFTP library which makes SFTP easy! See Documentation
@@ -67,8 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
@@ -83,27 +90,26 @@ files:
 - spec/support/test1.txt
 homepage: https://rubygems.org/gems/fun_sftp
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: fun_sftp
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: FunSFTP for secure file transfers
 test_files:
 - spec/fun_sftp/sftp_client_spec.rb