fun_sftp 0.0.7 → 0.0.8

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -0,0 +1,182 @@
+[![Gem Version](https://badge.fury.io/rb/fun_sftp.png)](http://badge.fury.io/rb/fun_sftp)
+
+FunSftp
+=======
+
+FunSftp is a ruby gem that provides a nice and easy to use wrapper for the Net::SFTP library.
+
+Reference: [net-sftp](http://net-ssh.github.com/sftp/v2/api/index.html)
+
+Installation
+------------
+
+```ruby
+gem 'fun_sftp'
+```
+
+Usage
+-----
+
+Let's say you need to send a file or directory to a remote host. Well, you can upload it to the remote host via the following:
+
+Setup the connection and specify a `source` directory if desired:
+
+```ruby
+include FunSftp
+conn = SFTPClient.new(server, username, password)
+conn.source = 'projects/awesome_project' #optional
+```
+
+Changing directories `chdir` and listing all files `ll` can be useful when working in a console. FunSftp now allows you to change your location on the remote host. This saves you from constantly entering long absolute paths.
+
+```ruby
+conn.chdir("projects")
+# Changes Directory
+# => "Current Path changed to => ./projects"
+
+conn.ll
+# Lists all files in current location
+# => file1
+#    file2
+#    Directory1
+#    Directory2
+
+conn.pwd
+# Returns the current working directory
+# => "./projects"
+```
+
+If you need to start from scratch then reset to the base path:
+
+```ruby
+conn.reset_path!
+# => "Path Reset and set to => ."
+```
+
+Now, you can upload your file:
+
+```ruby
+conn.upload!("my_local_file_name.txt", "some_remote_directory/give_a_name.txt")
+```
+
+or directory
+
+```ruby
+conn.upload!("my_awesome_local_directory", "desired_remote_directory_name")
+```
+
+That's it! Check the remote host to see that your file posted.
+
+You can also download a remote file to your local machine:
+
+```ruby
+conn.download!("some_remote_directory/file_to_download_name.txt", "desired_local_name.txt")
+```
+
+or directory
+
+```ruby
+conn.download!("some_remote_directory", "desired_local_directory_name")
+```
+
+Need to read a file on the remote host? Ah, it's no biggie...
+
+```ruby
+conn.read("path/to/file_name.txt")
+# => Hello World!
+```
+
+When investigating items on the remote host, these commands can be handy:
+
+```ruby
+conn.has_directory?("directory_name")
+# returns true or false if the directory exists
+
+conn.entries("directory_name")
+# outputs a nice array of entries in the specified directory
+# Pass true as a second argument if you would like to see '.' files
+# => ["test1", "test2", "some_directory_here"]
+
+conn.items_in("directory_name")
+# Traverses the provided directory returning an array of directories and files
+# => ["test1", "test1/h1.rb", "test2", "test2/h2.txt"]
+
+conn.print_directory_items("directory_name")
+# a print out of contained directories/files one line at a time
+# => test1.txt
+#    test2.png
+#    fun_directory_1
+
+conn.glob("directory_name", "**/*.rb")
+# Traverses the directory specified using the second argument/matcher
+# So, you can get things like...
+# => ["some_directory_here/hello_world.rb", "sftp_is_fun.rb"]
+```
+
+FileUtils
+---------
+
+FileUtilities are handy for doing some dirty work on the remote host.
+
+So far, you can make/remove directories, remove/rename files
+
+```ruby
+conn.mkdir!("new_directory_name_here")
+```
+
+Removing a directory is the same as above except you would swap mkdir! for rmdir!:
+
+```ruby
+conn.rmdir!("directory_name_to_remove")
+```
+
+Files can be removed and renamed off the remote host:
+
+```ruby
+conn.rm("file.txt")
+
+conn.rename("old_file_name.txt", "new_file_name.txt")
+# old_file_name.txt is now named new_file_name.txt on the remote host.
+```
+
+Hopefully, this is easy enough to work with and transfer files!!
+
+Logging
+-------
+
+By default, logging is turned on and will use the Rails logger if within a Rails projects. If not logging will defer to STDOUT. Logging is prominent when downloading or uploading. To turn off logging, you can create an initializer and modify the configuration by:
+
+```ruby
+FunSftp.configure do |config|
+  config.log = false
+end
+```
+
+You can also define your own logger if you'd like.
+
+```ruby
+FunSftp.configure do |config|
+  config.logger = MyAwesomeLogger.new
+end
+```
+
+Contribute
+-------------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+License
+-------
+
+Copyright (c) 2013 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/fun_sftp.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency 'net-sftp'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
 end

data/lib/fun_sftp/configuration.rb

@@ -0,0 +1,43 @@
+module FunSftp
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.logger
+    if loggable?
+      configuration and configuration.logger
+    end
+  end
+
+  def self.loggable?
+    (configuration and !configuration.log) ? false : true
+  end
+
+  class Configuration
+    attr_accessor :log, :logger
+
+    def initialize
+      @log = true
+    end
+
+    def log=(val)
+      if [true, false].include?(val)
+        @log = val
+      else
+        raise ArgumentError, "#{val} is not a correct value to set. Must be of either: [true, false]"
+      end
+    end
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+  end
+end

data/lib/fun_sftp/download_callbacks.rb

@@ -0,0 +1,23 @@
+module FunSftp
+  class DownloadCallbacks
+    def on_open(downloader, file)
+      FunSftp.logger.info "starting download: #{file.remote} -> #{file.local} (#{file.size} bytes)"
+    end
+
+    def on_get(downloader, file, offset, data)
+      FunSftp.logger.info "writing #{data.length} bytes to #{file.local} starting at #{offset}"
+    end
+
+    def on_close(downloader, file)
+      FunSftp.logger.info "finished with #{file.remote}"
+    end
+
+    def on_mkdir(downloader, path)
+      FunSftp.logger.info "creating directory #{path}"
+    end
+
+    def on_finish(downloader)
+      FunSftp.logger.info "all done!"
+    end
+  end
+end

data/lib/fun_sftp/upload_callbacks.rb

@@ -0,0 +1,23 @@
+module FunSftp
+  class UploadCallbacks
+    def on_open(uploader, file)
+      FunSftp.logger.info "starting upload: #{file.local} -> #{file.remote} (#{file.size} bytes)"
+    end
+
+    def on_put(uploader, file, offset, data)
+      FunSftp.logger.info "writing #{data.length} bytes to #{file.remote} starting at #{offset}"
+    end
+
+    def on_close(uploader, file)
+      FunSftp.logger.info "finished with #{file.remote}"
+    end
+
+    def on_mkdir(uploader, path)
+      FunSftp.logger.info "creating directory #{path}"
+    end
+
+    def on_finish(uploader)
+      FunSftp.logger.info "all done!"
+    end
+  end
+end

data/lib/fun_sftp/version.rb

@@ -1,3 +1,3 @@
 module FunSftp
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/fun_sftp.rb

@@ -1,81 +1,146 @@
 require 'fun_sftp/version'
+require 'fun_sftp/configuration'
+require 'fun_sftp/upload_callbacks'
+require 'fun_sftp/download_callbacks'
 
-#safe require to avoid any 'constant already init msg'
+# safe require
+# avoids any 'constant already init msg'
 orig_verbose = $VERBOSE
 $VERBOSE = nil
 require 'net/sftp'
 $VERBOSE = orig_verbose
 
+# Reference: http://net-ssh.rubyforge.org/sftp/v2/api/
 module FunSftp
-
   class SFTPClient
-    attr_accessor :server, :user, :password, :client
+    attr_accessor :server, :user, :password, :client, :source
 
     def initialize(server, user, password)
       @server, @user, @password = server, user, password
+      @source = '.'
       @client = setup_login
     end
-  
+
+    def source=(path)
+      @source = clean_path(path)
+    end
+
     def setup_login
       Net::SFTP.start(@server, @user, :password => @password)
     end
-  
+
     def upload!(source, target) #send to remote
-      @client.upload!(source, target) #target example: 'some_directory/some_name.txt'
+      #target example: 'some_directory/some_name.txt'
+      opts = {:progress => UploadCallbacks.new, :recursive => true}
+      converted_target = join_to_pwd(target)
+      opts.delete(:progress) unless FunSftp.loggable?
+      opts.delete(:recursive) unless has_directory?(converted_target)
+      @client.upload!(source, converted_target, opts)
     end
-  
+
     def download!(target, source) #fetch locally from remote
-      @client.download!(target, source)
+      opts = {:progress => DownloadCallbacks.new, :recursive => true}
+      converted_target = join_to_pwd(target)
+      opts.delete(:progress) unless FunSftp.loggable?
+      opts.delete(:recursive) unless has_directory?(converted_target)
+      @client.download!(converted_target, source, opts)
     end
-  
+
     def read(path) #read a file
-      file = @client.file.open(path)
+      file = @client.file.open(join_to_pwd(path))
       while !file.eof?
         puts file.gets
       end
     end
 
     def glob(path, pattern) # ex: ('some_directory', '**/*.rb')
-      @client.dir.glob(path, pattern).collect(&:name)
+      @client.dir.glob(join_to_pwd(path), pattern).collect(&:name)
     end
 
-    def entries(dir) #array of directory items
-      @client.dir.entries(dir).collect(&:name).reject!{|a| a.match(/^\.+$/)}
+    def entries(dir, show_dot_files = false) #array of directory entries not caring for '.' files
+      entries_arr = @client.dir.entries(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
       begin
         true if entries(dir)
-      rescue Exception => e
+      rescue Net::SFTP::StatusException => e
         false
       end
     end
 
-    def print_directory_items(dir) #printout of directory items
-      @client.dir.foreach(dir) { |file| print "#{file.name}\n" }
+    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
     end
-  
-    #### Some Handy File Util Methods
+
+    #################################
+    # Some Handy File Util Methods  #
+    #################################
+
     def mkdir!(path) #make directory
-      @client.mkdir! path
+      @client.mkdir!(join_to_pwd(path))
     end
-  
+
     def rm(path) #remove a file
-      @client.remove!(path)
+      @client.remove!(join_to_pwd(path))
     end
-  
+
     def rmdir!(path) #remove directory
-      @client.rmdir!(path)
+      @client.rmdir!(join_to_pwd(path))
     end
-  
+
     def rename(name, new_name) #rename a file
-      @client.rename!(name, new_name)
+      previous, renamed = join_to_pwd(name), join_to_pwd(new_name)
+      @client.rename!(previous, renamed)
+    end
+
+    def ll
+      print_directory_items('.')
+    end
+
+    def chdir(path)
+      if path =~ /~/
+        new_path = clean_path(path)
+        change_directory_check(new_path, path)
+      else
+        change_directory_check(join_to_pwd(path), path)
+      end
+    end
+
+    def pwd
+      @source
+    end
+
+    def reset_path!
+      @source = '.'
+      "Path Reset and set to => #{@source}"
+    end
+
+    private
+
+    def join_to_pwd(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}"
+      else
+        "Sorry Path => #{entered_path} not found"
+      end
     end
-    ##################################
 
   end
 end

data/spec/fun_sftp/sftp_client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module FunSftp
+  describe 'sftp client' do
+
+    let(:sftp_mock) {double('sftp')} #sftp_mock is the @client var
+
+    before do
+      Net::SFTP.stub(:start => 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')
+      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")}
+
+      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])
+      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])
+      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)
+      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)
+      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')
+      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')
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'fun_sftp'
+Bundler.require :default, :development

data/spec/support/test1.txt

@@ -0,0 +1,2 @@
+This is line one of test1.txt
+This is line two of test1.txt

metadata

@@ -1,101 +1,111 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fun_sftp
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 0.0.8
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
 platform: ruby
-authors: 
+authors:
 - George Diaz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-24 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-sftp
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  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
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Wrapper for Ruby's Net::SFTP library which makes SFTP easy! See Documentation at https://github.com/georgediaz88/fun_sftp
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for Ruby's Net::SFTP library which makes SFTP easy! See Documentation
+  at https://github.com/georgediaz88/fun_sftp
+email:
 - georgediaz88@yahoo.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - fun_sftp.gemspec
 - lib/fun_sftp.rb
+- lib/fun_sftp/configuration.rb
+- lib/fun_sftp/download_callbacks.rb
+- lib/fun_sftp/upload_callbacks.rb
 - lib/fun_sftp/version.rb
-has_rdoc: true
+- spec/fun_sftp/sftp_client_spec.rb
+- spec/spec_helper.rb
+- spec/support/test1.txt
 homepage: https://rubygems.org/gems/fun_sftp
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: fun_sftp
-rubygems_version: 1.5.3
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: FunSFTP for secure file transfers
-test_files: []
-
+test_files:
+- spec/fun_sftp/sftp_client_spec.rb
+- spec/spec_helper.rb
+- spec/support/test1.txt

data/README.rdoc

@@ -1,116 +0,0 @@
-= FunSFTP (Version 0.0.7)
-
-A Ruby Gem that provides a nice and easy to use wrapper for the Net::SFTP library.
-
-Modeled from:
-
-http://net-ssh.github.com/sftp/v2/api/index.html
-
-
-== Install
-
-  Use Ruby versions >= 1.8.7
-
-  1) gem install fun_sftp
-
-     or in a Rails 3+ project:
-
-  2) gem 'fun_sftp'
-  
-     and bundle away!
-
-
-== Usage
-
-Let's say you need to send a file to a remote host. Well, you can upload it to the remote host using these steps:
-
-  1) First setup the connection:
-  
-     include FunSftp
-     conn = SFTPClient.new(server, username, password)
-  
-  2) Now, you can upload your file:
-  
-     conn.upload!("my_file_name.txt", "some_remote_directory/give_a_name.txt")
-
-That's it! Check the remote host to see that your file posted.
-
-You can also download a remote file to your local machine:
-
-  conn.download!("some_remote_directory/file_to_download_name.txt", "give_desired_local_name.txt")
-
-Need to read a file on the remote host? Ah, it's no biggie...
-
-  conn.read("path/to/file_name.txt")
-  #=> Hello World!
-
-When investigating items on the remote host, these commands can be handy:
-
-  1) conn.has_directory?("directory_name")
-     # returns true or false if the directory exists
-
-  2) conn.items_in("directory_name")
-    # returns an array of every directory and file within the provided directory
-    # => ["test1", "test1/h1.rb", "test2", "test2/h2.txt"]
-
-  3) conn.print_directory_items("directory_name")
-     # outputs directories one line at a time
-     # => test1
-          test2
-          some_directory_here
-
-  4) conn.entries("directory_name")
-     # outputs a nice array of entries in the specified directory
-     # => ["test1", "test2", "some_directory_here"]
-
-  5) conn.glob("directory_name", "**/*.rb")
-     # Traverses the directory specified using the second argument/matcher
-     # So, you can get things like...
-     # => ["some_directory_here/hello_world.rb", "sftp_is_fun.rb"]
-
-== FileUtils
-
-FileUtilities are handy for doing some dirty work on the remote host.
-
-So far, you can make/remove directories, remove/rename files
-
-  1) conn.mkdir!("some_remote_directory/a_new_directory_name_here")
-     # makes a_new_directory_name_here under some_remote_directory if it exists
-
-Removing a directory is the same as above except you would swap mkdir! for rmdir!: 
-  
-  2) conn.rmdir!("...")
-
-Files can be removed and renamed off the remote host:
-  
-  1) conn.rm("path/to/file.txt")
-     # would remove file.txt
-  
-  2) conn.rename("old_file_name.txt", "new_file_name.txt")
-     # old_file_name.txt is now named new_file_name.txt on the remote host.
-
-Hopefully, this is easy enough to work with and transfer files!!
-Look for new helpful method calls in future releases.
-
-== License
-
-Copyright (c) 2012 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:
- 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
- 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.