robinsp-backitup 0.0.2 → 0.0.3

data/Manifest

@@ -1,18 +1,20 @@
-bin/backitup
 sample.backitup
-spec/test-config.backitup
-spec/file_packager_spec.rb
-spec/config_spec.rb
-spec/runner_spec.rb
-spec/file_list_spec.rb
-spec/spec.opts
-spec/spec_helper.rb
-Rakefile
 lib/back_it_up.rb
 lib/back_it_up/config.rb
+lib/back_it_up/runner.rb
+lib/back_it_up/command.rb
+lib/back_it_up/ftp.rb
 lib/back_it_up/file_list.rb
 lib/back_it_up/file_packager.rb
-lib/back_it_up/command.rb
-lib/back_it_up/runner.rb
 README.rdoc
+Rakefile
+spec/test-config.backitup
+spec/file_list_spec.rb
+spec/spec_helper.rb
+spec/runner_spec.rb
+spec/spec.opts
+spec/file_packager_spec.rb
+spec/ftp_spec.rb
+spec/config_spec.rb
+bin/backitup
 Manifest

data/README.rdoc

@@ -1,6 +1,7 @@
 = BackItUp
 
-<em>This is still in the workings and right now it is only an advanced zip file creator.</em>
+Simple tool to easily configure the files and directories to copy to a local zip file
+and FTP (optional) to a remote host.
 
 == Install
 
@@ -29,6 +30,8 @@ Create a backup script looking something like this
 	  dir "~/Desktop/drop-in-me-for-backup"
 		
 	  destination_file "/tmp/backupfile"
+	  
+	  ftp 'host.domain.com', 'username', 'password', :remote_dir => 'backups'
 	end
 
 Run *backitup* with your script file as argument

data/Rakefile

@@ -2,7 +2,7 @@ require 'spec'
 require 'spec/rake/spectask'
 require 'echoe'
 
-Echoe.new('backitup', '0.0.2') do |p|
+Echoe.new('backitup', '0.0.3') do |p|
   p.description    = "Simple backup tool"
   p.url            = "http://github.com/robinsp/backitup"
   p.author         = "Robin Spainhour"

data/backitup.gemspec

@@ -2,28 +2,28 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backitup}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Spainhour"]
-  s.date = %q{2009-05-28}
+  s.date = %q{2009-05-29}
   s.default_executable = %q{backitup}
   s.description = %q{Simple backup tool}
   s.email = %q{robin@robinspainhour.com}
   s.executables = ["backitup"]
-  s.extra_rdoc_files = ["bin/backitup", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "README.rdoc"]
-  s.files = ["bin/backitup", "sample.backitup", "spec/test-config.backitup", "spec/file_packager_spec.rb", "spec/config_spec.rb", "spec/runner_spec.rb", "spec/file_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Rakefile", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "README.rdoc", "Manifest", "backitup.gemspec"]
+  s.extra_rdoc_files = ["lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/runner.rb", "lib/back_it_up/command.rb", "lib/back_it_up/ftp.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "README.rdoc", "bin/backitup"]
+  s.files = ["sample.backitup", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/runner.rb", "lib/back_it_up/command.rb", "lib/back_it_up/ftp.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "README.rdoc", "Rakefile", "spec/test-config.backitup", "spec/file_list_spec.rb", "spec/spec_helper.rb", "spec/runner_spec.rb", "spec/spec.opts", "spec/file_packager_spec.rb", "spec/ftp_spec.rb", "spec/config_spec.rb", "bin/backitup", "Manifest", "backitup.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/robinsp/backitup}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backitup", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{backitup}
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Simple backup tool}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rubyzip>, [">= 0"])

data/lib/back_it_up.rb

@@ -1,4 +1,17 @@
+class NilClass 
+  def blank?
+    true
+  end
+end
+
+class String 
+  def blank?
+    (self == nil || self == "")
+  end
+end
+
 require 'back_it_up/runner'
 require 'back_it_up/config'
 require 'back_it_up/file_packager'
 require 'back_it_up/file_list'
+require 'back_it_up/ftp'

data/lib/back_it_up/config.rb

@@ -17,6 +17,18 @@ module BackItUp
   # in the <tt>~/Desktop/drop-in-me-for-backup</tt> directory and its sub dirs, and 
   # place them in <tt>/tmp/backupfile_[date]_time.zip</tt>.
   module ScriptDSL 
+    INVALID_FTP_ARG_MSG = "Invalid arguments for ftp"
+
+    # After packaging backup set send the file to this server.
+    #
+    # Options:
+    #   <tt>:remote_dir</tt>  Remote directory on FTP host
+    #
+    def ftp(host, user, passwd, options = {} )
+      raise INVALID_FTP_ARG_MSG if host.blank? || user.blank? || passwd.blank?
+      
+      @ftp_options = options.merge( {:user => user, :host => host, :passwd => passwd } )
+    end
     
     # Starts off the backup script. 
     #
@@ -77,7 +89,7 @@ module BackItUp
   
   class Config
     include ScriptDSL
-    attr_reader :files, :dirs, :dest_filename
+    attr_reader :files, :dirs, :dest_filename, :ftp_options
     
     def initialize(file_handle)
       @files = []      

data/lib/back_it_up/ftp.rb

@@ -0,0 +1,18 @@
+require 'net/ftp'
+
+module BackItUp
+  class Ftp
+    def initialize(options)
+      raise "No options" if options == nil || options.empty?
+      @options = options
+    end
+    
+    def transfer(filename)
+      Net::FTP.open(@options[:host]) do |ftp|
+        ftp.login(@options[:user], @options[:passwd] )
+        ftp.chdir(@options[:remote_dir]) if @options[:remote_dir]
+        ftp.putbinaryfile(filename)
+      end
+    end
+  end  
+end

data/lib/back_it_up/runner.rb

@@ -5,7 +5,14 @@ module BackItUp
       
       file = File.open(filename) 
       config = Config.new(file)
-      puts "Wrote backup to: #{ FilePackager.new(config).package }"
+      packaged_filename = FilePackager.new(config).package
+      puts "Wrote backup to: #{ packaged_filename }."
+      
+      if config.ftp_options
+        BackItUp::Ftp.new(config.ftp_options).transfer(packaged_filename) 
+        puts "Tranferred to FTP host."
+      end
+      
     end
   end
 end

data/sample.backitup

@@ -1,11 +1,9 @@
-
 # sample.backitup
-
 backup do 
-
 	file '/home/robin/backup.this.file'		
-
 	dir "~/Desktop/drop-in-me-for-backup"
 	
 	destination_file "/tmp/backupfile"
+	
+	ftp 'host.domain.com', 'username', 'password', :remote_dir => 'backups'
 end

data/spec/config_spec.rb

@@ -134,6 +134,33 @@ describe BackItUp::Config do
         @config.dirs.pop.should == @valid_file
       end
     end
+    
+    describe "ftp()" do 
+      it "should require host" do 
+        lambda{ @config.ftp("", "string", "string") }.should raise_error(BackItUp::ScriptDSL::INVALID_FTP_ARG_MSG) 
+      end
+      it "should require username" do 
+        lambda{ @config.ftp("string", "", "string") }.should raise_error(BackItUp::ScriptDSL::INVALID_FTP_ARG_MSG) 
+      end
+      it "should require password" do 
+        lambda{ @config.ftp("string", "string", "") }.should raise_error(BackItUp::ScriptDSL::INVALID_FTP_ARG_MSG) 
+      end
+      
+      it "should save args to ftp_options attribute" do 
+        @config.ftp("host", "user", "passwd")
+        @config.ftp_options.should == {:user => "user", :passwd => "passwd", :host => "host"}
+      end
+      
+      it "should save options when given" do 
+        @config.ftp("host", "user", "passwd", :an_option => "the_option")
+        @config.ftp_options.should == {:user => "user", :passwd => "passwd", :host => "host", :an_option => "the_option"}
+      end
+      
+      it "should not override host, user and passwd args when these are given in options" do 
+        @config.ftp("host", "user", "passwd", :user => "user1", :passwd => "passwd1", :host => "host1")
+        @config.ftp_options.should == {:user => "user", :passwd => "passwd", :host => "host"}
+      end
+    end
   end
   
 end

data/spec/ftp_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BackItUp::Ftp do 
+  before do 
+    @user = "username"
+    @passwd = "password"
+    @host = "hostname"
+    
+    @options = {:user => @user, :host => @host, :passwd => @passwd}
+  end
+  
+  describe "constructor" do 
+    it "should require options" do 
+      lambda {BackItUp::Ftp.new(nil) }.should raise_error
+      lambda {BackItUp::Ftp.new({}) }.should raise_error
+      lambda {BackItUp::Ftp.new(@options) }.should_not raise_error
+    end
+  end
+  
+  describe "transfer()" do 
+    before do 
+      @filename = "thefilename"
+      @mock_ftp = stub("mock-ftp", :login => "", :putbinaryfile => "")
+      
+      Net::FTP.stubs(:open).with(@host).yields(@mock_ftp)
+      @ftp = BackItUp::Ftp.new(@options)
+    end
+    
+    it "should open host" do 
+      Net::FTP.expects(:open).with(@host)
+      @ftp.transfer(@filename)
+    end
+    
+    it "should login" do 
+      @mock_ftp.expects(:login).with(@user, @passwd)
+      @ftp.transfer(@filename)
+    end
+    
+    it "should put binary file" do 
+      @mock_ftp.expects(:putbinaryfile).with(@filename)
+      @ftp.transfer(@filename)
+    end
+    
+    it "should change directory if option is set" do 
+      dirname = "remote-directory"
+      @mock_ftp.expects(:chdir).with(dirname)
+      ftp = BackItUp::Ftp.new( @options.merge(:remote_dir => dirname) )
+      ftp.transfer(@filename)
+    end
+  end
+end

data/spec/runner_spec.rb

@@ -17,7 +17,7 @@ describe BackItUp::Runner do
       @file = mock('fake file handle')
       File.stubs(:open).with(@filename).returns(@file)
       
-      @mock_config = mock('mock-config')
+      @mock_config = stub('mock-config', :ftp_options => nil)
       BackItUp::Config.stubs(:new).returns(@mock_config)
       
       @mock_packager
@@ -46,6 +46,15 @@ describe BackItUp::Runner do
       BackItUp::Runner.new(@filename)
     end
     
+    it "should transfer packaged file if ftp is configured" do
+      ftp_config = {:ftp => "config"}
+      @mock_config.stubs(:ftp_options).returns(ftp_config)
+      ftp = mock('ftp')
+      BackItUp::Ftp.expects(:new).with(ftp_config).returns(ftp)
+      ftp.expects(:transfer).with(@package_result_filename)
+      BackItUp::Runner.new(@filename)
+    end
+    
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: robinsp-backitup
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Robin Spainhour
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 00:00:00 -07:00
+date: 2009-05-29 00:00:00 -07:00
 default_executable: backitup
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,32 +29,35 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- bin/backitup
 - lib/back_it_up.rb
 - lib/back_it_up/config.rb
+- lib/back_it_up/runner.rb
+- lib/back_it_up/command.rb
+- lib/back_it_up/ftp.rb
 - lib/back_it_up/file_list.rb
 - lib/back_it_up/file_packager.rb
-- lib/back_it_up/command.rb
-- lib/back_it_up/runner.rb
 - README.rdoc
-files: 
 - bin/backitup
+files: 
 - sample.backitup
-- spec/test-config.backitup
-- spec/file_packager_spec.rb
-- spec/config_spec.rb
-- spec/runner_spec.rb
-- spec/file_list_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- Rakefile
 - lib/back_it_up.rb
 - lib/back_it_up/config.rb
+- lib/back_it_up/runner.rb
+- lib/back_it_up/command.rb
+- lib/back_it_up/ftp.rb
 - lib/back_it_up/file_list.rb
 - lib/back_it_up/file_packager.rb
-- lib/back_it_up/command.rb
-- lib/back_it_up/runner.rb
 - README.rdoc
+- Rakefile
+- spec/test-config.backitup
+- spec/file_list_spec.rb
+- spec/spec_helper.rb
+- spec/runner_spec.rb
+- spec/spec.opts
+- spec/file_packager_spec.rb
+- spec/ftp_spec.rb
+- spec/config_spec.rb
+- bin/backitup
 - Manifest
 - backitup.gemspec
 has_rdoc: true
@@ -86,7 +89,7 @@ requirements: []
 rubyforge_project: backitup
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Simple backup tool
 test_files: []