syncftp 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+examples
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gregoire Lejeune
+
+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/README.rdoc

@@ -0,0 +1,33 @@
+= syncftp
+
+Sync via FTP, only modified files
+
+== ChangeLog
+
+=== 0.0.1 :
+* First Release
+
+== Example
+
+	require 'syncftp'
+
+	ftp = SyncFTP.new( 'localhost', :username => "MyUser", :password => "********" )
+	ftp.sync( :local => "rootdir", :remote => "temp/syncfs/test" )
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Inspiration
+
+This lib was truly inspired by the awsome glynn (http://github.com/dmathieu/glynn)
+
+== Copyright
+
+Copyright (c) 2010 Gregoire Lejeune. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "syncftp"
+    gem.summary = %Q{Sync via FTP, only modified files}
+    gem.description = %Q{Sync via FTP, only modified files}
+    gem.email = "gregoire.lejeune@free.fr"
+    gem.homepage = "http://github.com/glejeune/syncftp"
+    gem.authors = ["Gregoire Lejeune"]
+    gem.add_dependency 'mime-types', ">= 0"
+    
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "fakefs", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "syncftp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/sample01.rb

@@ -0,0 +1,4 @@
+$:.unshift( "../lib" )
+require 'syncftp'
+
+SyncFTP.new( 'localhost', :loglevel => Logger::DEBUG ).sync( :local => "rootdir", :remote => "temp/syncfs/test" )

data/lib/syncftp.rb

@@ -0,0 +1,207 @@
+# Copyright (c) 2009 Gregoire Lejeune
+# 
+# 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.
+require 'net/ftp'
+require 'yaml'
+require 'digest/md5'
+require 'tmpdir'
+require 'logger'
+require 'rubygems'
+require 'mime/types'
+
+module Net
+  class FTP
+    #
+    # Net::FTP extension
+    #
+    # Check if the +file+ exist on the remote FTP server
+    #
+    def remote_file_exist?( file )
+      ls( file ).size != 0
+    end
+
+    #
+    # Net::FTP extension
+    #
+    # Check if the +dir+ exist on the remote FTP server
+    #
+    def remote_dir_exist?( dir )
+      path = dir.split( "/" )
+      find = path.pop
+      path = path.join( "/" )
+      path = "." if path == ""
+      
+      nlst( path ).include?( dir )
+    end
+    
+    #
+    # Net::FTP extension
+    #
+    # Like FileUtils.mkdir_p but for Net::FTP
+    #
+    def mkdir_p( dir )
+      path = dir.split( "/" )
+      mkpath = path.shift
+      begin
+        mkdir( mkpath ) unless mkpath == ""
+      rescue Net::FTPPermError => e
+        raise Net::FTPPermError, e.message, caller unless remote_dir_exist?(mkpath)
+      end
+      path.each do |d|
+        mkpath = [mkpath, d].join( "/" )
+        begin
+          mkdir( mkpath )
+        rescue Net::FTPPermError => e
+          raise Net::FTPPermError, e.message, caller unless remote_dir_exist?(mkpath)
+        end
+      end
+    end
+  end
+end
+
+class File
+  #
+  # File extension
+  #
+  # Check if the +file+ is a binary file
+  #
+  def self.binary?( file )
+    MIME::Types.type_for( file ).map{ |e| (e.binary?) ? e : nil }.compact.size > 0
+  end
+end
+
+class SyncFTP
+  attr_reader :host, :port, :username, :password
+  
+  #
+  # Create a new SyncFTP object for +host+
+  #
+  # you can specify :
+  #
+  # * +:username+ - default = "anonymous"
+  # * +:password+ - default = nil
+  # * +:port+ - default = 21
+  # * +:logfile+ - default = STDOUT
+  # * +:loglevel+ - default = Logger::UNKNOWN (Cool if you don't want logs)
+  #
+  def initialize(host, options = {})
+    options = {:username => "anonymous", :password => nil, :logfile => STDOUT, :loglevel => Logger::UNKNOWN}.merge(options)
+    @host, @port = host, options[:port]||21
+    @username, @password = options[:username], options[:password]
+    @remote_md5s = {} 
+    @local_md5s = {}
+    @log = Logger.new( options[:logfile] )
+    @log.level = options[:loglevel]
+  end
+  
+  #
+  # Sync local to remote
+  #
+  # you can specify :
+  #
+  # * +:local+ : the local directory (default = ".")
+  # * +:remote+ : the remote directory (default = ".")
+  #
+  def sync( options = {} )
+    options = { :local => ".", :remote => "." }.merge( options )
+    local, remote = options[:local], options[:remote]
+    
+    tmpname = tmpfilename
+    connect do |ftp|
+      # Read remote .syncftp
+      begin
+        ftp.gettextfile( remote+"/"+".syncftp", tmpname )
+        @remote_md5s = YAML.load( File.open( tmpname ).read )
+      rescue Net::FTPPermError => e
+        raise Net::FTPPermError, e.message, caller if ftp.remote_file_exist?( remote+"/"+".syncftp" )
+      end
+      
+      # Do the job Bob !
+      send_dir( ftp, local, remote )
+      
+      # Write new .syncftp
+      File.open( tmpname, 'w' ) do |out|
+        YAML.dump( @local_md5s, out )
+      end
+      ftp.puttextfile( tmpname, remote+"/"+".syncftp" )
+    end
+    File.delete( tmpname )
+  end
+  
+  private
+  def tmpfilename #:nodoc:
+    tmpdir = Dir::tmpdir
+    basename = File.basename( $0 )
+    tempname = nil
+    n = 0
+    
+    if $SAFE > 0 and tmpdir.tainted?
+      tmpdir = '/tmp'
+    end
+    
+    begin
+      t = Time.now.strftime("%Y%m%d")
+      tmpfile = "#{basename}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-#{n}"
+      n += 1
+      tmpname = File.join(tmpdir, tmpfile)
+    end while File.exist?(tmpname)
+    
+    return tmpname
+  end
+  
+  def connect #:nodoc:
+    ftp = Net::FTP.new( )
+    ftp.connect( @host, @port )
+    ftp.login( @username, @password )
+    yield ftp
+    ftp.close
+  end
+  
+  def send_dir(ftp, local, remote) #:nodoc:
+    ftp.mkdir_p(remote)
+    
+    Dir.foreach(local) do |file|
+      next if file == "." or file == ".."
+      
+      local_file = File.join( local, file )
+      remote_file = remote + "/" + file
+      
+      if File.stat(local_file).directory?
+        # It is a directory, we recursively send it
+        send_dir(ftp, local_file, remote_file)
+      else
+        @local_md5s[remote_file] = Digest::MD5.hexdigest( File.open(local_file).read )
+
+        if( @local_md5s[remote_file] != @remote_md5s[remote_file] )
+          @log.info "Copy #{local_file} to ftp://#{@host}:#{@port}/#{remote_file}"
+          
+          # It's a file, we just send it
+          if File.binary?(local_file)
+            ftp.putbinaryfile(local_file, remote_file)
+          else
+            ftp.puttextfile(local_file, remote_file)
+          end
+        else
+          @log.info "#{local_file} don't need to be overwritten !"
+        end
+      end
+    end
+  end
+end

data/syncftp.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{syncftp}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gregoire Lejeune"]
+  s.date = %q{2010-04-15}
+  s.description = %q{Sync via FTP, only modified files}
+  s.email = %q{gregoire.lejeune@free.fr}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/syncftp.rb",
+     "syncftp.gemspec",
+     "test/helper.rb",
+     "test/test_syncftp.rb"
+  ]
+  s.homepage = %q{http://github.com/glejeune/syncftp}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Sync via FTP, only modified files}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_syncftp.rb",
+     "examples/sample01.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+    else
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakefs/safe'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'syncftp'
+
+class Test::Unit::TestCase
+end

data/test/test_syncftp.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestSyncftp < Test::Unit::TestCase
+  context "A User story" do
+    setup do
+      @sync = SyncFTP.new( 'localhost', :username => 'greg', :password => 'mcag71139' )
+    end
+  
+    should "be initialized" do
+      assert_not_nil @sync
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: syncftp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gregoire Lejeune
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Sync via FTP, only modified files
+email: gregoire.lejeune@free.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/syncftp.rb
+- syncftp.gemspec
+- test/helper.rb
+- test/test_syncftp.rb
+has_rdoc: true
+homepage: http://github.com/glejeune/syncftp
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Sync via FTP, only modified files
+test_files: 
+- test/helper.rb
+- test/test_syncftp.rb
+- examples/sample01.rb