robinsp-backitup 0.0.1

data/Manifest

@@ -0,0 +1,14 @@
+bin/backitup
+spec/test-config.backitup
+spec/file_packager_spec.rb
+spec/config_spec.rb
+spec/runner_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+Rakefile
+Manifest
+lib/back_it_up.rb
+lib/back_it_up/config.rb
+lib/back_it_up/file_packager.rb
+lib/back_it_up/command.rb
+lib/back_it_up/runner.rb

data/Rakefile

@@ -0,0 +1,16 @@
+require 'spec'
+require 'spec/rake/spectask'
+require 'echoe'
+
+Echoe.new('backitup', '0.0.1') do |p|
+  p.description    = "Simple backup"
+  p.url            = "http://github.com/robinsp/backitup"
+  p.author         = "Robin Spainhour"
+  p.email          = "robin@robinspainhour.com"
+  p.ignore_pattern = ["tmp/*"]
+  p.dependencies = ["rubyzip"]
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end

data/backitup.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backitup}
+  s.version = "0.0.1"
+
+  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-27}
+  s.default_executable = %q{backitup}
+  s.description = %q{Simple backup}
+  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_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb"]
+  s.files = ["bin/backitup", "spec/test-config.backitup", "spec/file_packager_spec.rb", "spec/config_spec.rb", "spec/runner_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Rakefile", "Manifest", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "backitup.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/robinsp/backitup}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backitup"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{backitup}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Simple backup}
+
+  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<rubyzip>, [">= 0"])
+    else
+      s.add_dependency(%q<rubyzip>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rubyzip>, [">= 0"])
+  end
+end

data/bin/backitup

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'back_it_up/command'

data/lib/back_it_up/command.rb

@@ -0,0 +1,21 @@
+require 'back_it_up'
+
+module BackItUp
+  class Command
+    def self.run!(args=ARGV)
+      filename = args.shift      
+      if filename == nil || filename == ""
+        usage
+      else 
+        BackItUp::Runner.new(filename)
+      end
+      
+    end
+    
+    def self.usage
+      puts "Usage: backitup config-file"
+    end
+  end  
+end
+
+BackItUp::Command.run!

data/lib/back_it_up/config.rb

@@ -0,0 +1,55 @@
+module BackItUp
+  class Config
+    attr_reader :files, :dirs, :dest_filename
+    
+    def initialize(file_handle)
+      @files = []      
+      @dirs = []    
+      
+      file_content = ""
+
+      while l = file_handle.gets do 
+        file_content << l
+      end
+      
+      eval(file_content)
+    end
+    
+    def backup
+      yield
+    end
+    
+    # Full path and name of the package file to create.
+    # A timestamp will be appended to the filename and the extension is 
+    # determined by the packager used.
+    #
+    #   # Using the zip packager with a destination file setting:
+    #   /var/backup/mybackup 
+    #
+    #   # ...then the final result might be:
+    #   /var/backup/mybackup_200900527_053032.zip
+    def destination_file(filename) 
+      raise "Invalid destination file." if File.directory?(filename)
+      @dest_filename = filename
+    end
+    
+    def file(filename = nil)
+
+      unless (filename  == "" || filename == nil)
+        if File.exists?(filename)
+          if File.directory? filename
+            @dirs << filename
+          else
+            @files << filename
+          end
+              
+        else 
+          puts "WARNING: File #{filename} could not be found"    
+        end
+      end
+      
+    end
+    
+    alias_method :dir, :file
+  end  
+end

data/lib/back_it_up/file_packager.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'zip/zip'
+
+module BackItUp
+  class FilePackager  
+    INVALID_CONFIG_MSG = "Invalid config"
+    attr_reader :produced_file
+    
+    def initialize(config) 
+      raise INVALID_CONFIG_MSG if config == nil || !config.is_a?(Config)
+      @config = config
+    end
+    
+    def package
+      target_filename = create_target_filename
+      
+      prefix = File.basename(target_filename, ".zip")
+      
+      Zip::ZipFile.open(target_filename, Zip::ZipFile::CREATE) do |zip|
+        @config.files.each do |filename|
+          zip.add("./#{prefix}#{filename}", filename)
+        end
+      end
+      
+      @produced_file = target_filename
+    end
+    
+    protected 
+    def create_target_filename
+      @config.dest_filename + "_#{timestamp}" + ".zip"
+    end
+    
+    private 
+    def timestamp
+      Time.now.strftime("%Y%m%d_%H%M%S")
+    end
+  end
+end

data/lib/back_it_up/runner.rb

@@ -0,0 +1,11 @@
+module BackItUp
+  class Runner
+    def initialize(filename)
+      raise "Couldn't find file #{filename}" unless File.exists?(filename)
+      
+      file = File.open(filename) 
+      config = Config.new(file)
+      puts "Wrote backup to: #{ FilePackager.new(config).package }"
+    end
+  end
+end

data/lib/back_it_up.rb

@@ -0,0 +1,3 @@
+require 'back_it_up/runner'
+require 'back_it_up/config'
+require 'back_it_up/file_packager'

data/spec/config_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BackItUp::Config do 
+
+  it "should eval the file content" do 
+    file = mock('mock-file')
+    file.expects(:gets).twice.returns("file 'string'", nil)
+    
+    BackItUp::Config.any_instance.expects(:file).with("string")
+    BackItUp::Config.new(file)
+  end
+  
+  it "should be able to handle our test config" do 
+    test_file = File.dirname(__FILE__) + "/test-config.backitup"
+    
+    BackItUp::Config.new(File.open(test_file))
+  end
+  
+  describe "" do 
+    before do 
+      mock_file = mock('mock-file')
+      mock_file.stubs(:gets).returns(nil)
+      @config = BackItUp::Config.new(mock_file)
+    end
+    
+    it "should have empty array of files by default" do 
+      @config.files.should == []
+    end
+    
+    it "should have empty array of dirs by default" do 
+      @config.dirs.should == []
+    end
+    
+    describe "destination_file()" do 
+      
+      it "should save the filename to dest_filename attribute" do 
+        filename = File.expand_path(File.dirname(__FILE__) + "backup") 
+        @config.destination_file(filename)
+        @config.dest_filename.should == filename
+      end
+      
+      it "should fail if filename is an existing directory" do 
+        filename = File.expand_path(File.dirname(__FILE__) )
+        lambda { @config.destination_file(filename) }.should raise_error("Invalid destination file.")
+      end
+    end
+      
+    describe "backup()" do 
+      it "should yield to block" do 
+        test_value = false
+        
+        @config.backup do 
+          test_value = true
+        end
+        
+        test_value.should be_true
+      end
+    end
+    
+    describe "file()" do 
+      before do 
+        @valid_file = File.expand_path(File.dirname(__FILE__) + '/test-config.backitup')
+      end
+
+      it "should warn if file doesn't exist" do 
+        file_name = "should-not-exist"
+        BackItUp::Config.any_instance.expects(:puts).with("WARNING: File should-not-exist could not be found")
+        @config.file(file_name)
+      end
+      
+      it "should not add non-existning files to files attribute" do 
+        file_name = "should-not-exist"
+        @config.file(file_name)
+        @config.files.should be_empty
+      end
+      
+      it "should allow nil file name argument" do 
+        @config.file
+      end
+      
+      it "should check if file exists" do 
+        File.expects(:exists?).with("filename").returns(false)
+        @config.file("filename")
+      end
+      
+      it "should add the file to the files array" do 
+        @config.file(@valid_file)
+        @config.files.pop.should == @valid_file
+      end
+      
+      it "should check if file argument is directory" do 
+        File.expects(:directory?).returns(false)        
+        @config.file(@valid_file)
+      end
+      
+      it "should add directories to dirs array" do 
+        File.stubs(:directory?).returns(true)
+        @config.file(@valid_file)
+        @config.dirs.pop.should == @valid_file
+      end
+    end
+  end
+  
+end

data/spec/file_packager_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BackItUp::FilePackager do 
+  describe "constructor" do 
+    it "should fail if initialized with nil config" do 
+      lambda { BackItUp::FilePackager.new(nil) }.should raise_error(BackItUp::FilePackager::INVALID_CONFIG_MSG )
+    end
+    
+    it "should fail if initialized without config" do 
+      lambda { BackItUp::FilePackager.new("a string") }.should raise_error(BackItUp::FilePackager::INVALID_CONFIG_MSG )
+    end  
+  end
+  
+  describe "package()" do 
+    before do 
+      @first_file_to_add = "/etc/passwd"
+      @second_file_to_add = "/etc/httpd/apache.cfg"
+      
+      @configured_dst_filename = "/backups/a-file-name"
+      mock_config = mock
+      mock_config.stubs(:is_a? => true)
+      mock_config.stubs(:dest_filename).returns(@configured_dst_filename)
+      mock_config.stubs(:files).returns([@first_file_to_add, @second_file_to_add])
+
+      @mock_zip = mock("mock-zip")
+      @mock_zip.stubs(:add)
+      Zip::ZipFile.stubs(:open).yields(@mock_zip)
+      
+      @packager = BackItUp::FilePackager.new(mock_config)
+      
+    end
+    
+    it "should use the destination_file setting from config" do 
+      @packager.package.should =~ /^#{@configured_dst_filename}/
+    end
+    
+    it "should append timestamp and zip suffix to destination file name from config" do 
+      @packager.package.should =~ /^#{@configured_dst_filename}_[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]_[0-9][0-9][0-9][0-9][0-9][0-9].zip/
+    end
+    
+    it "should return name of produced file" do 
+      @packager.package.should_not be_nil
+    end
+    
+    it "should set the produced_file attribute" do 
+      @packager.package.should == @packager.produced_file
+    end
+    
+    it "should create the file package" do 
+      Zip::ZipFile.expects(:open).with() do  |name, type| 
+        (name =~ /^#{@configured_dst_filename}/ && type == Zip::ZipFile::CREATE) 
+      end
+      
+      @packager.package
+    end
+    
+    it "should add files to the zip" do 
+      prefix = "./#{File.basename(@configured_dst_filename)}"
+      
+      @mock_zip.expects(:add).with( regexp_matches(/^#{prefix}.*#{@first_file_to_add}$/), @first_file_to_add )
+      @mock_zip.expects(:add).with( regexp_matches(/^#{prefix}.*#{@second_file_to_add}$/), @second_file_to_add )
+      
+      @packager.package
+    end
+
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BackItUp::Runner do 
+
+  it "should require valid file name to initialize" do 
+    name_of_invalid_file = "invalidfile.text"
+    lambda {BackItUp::Runner.new(name_of_invalid_file)}.should raise_error("Couldn't find file #{name_of_invalid_file}")
+  end
+
+  describe "with valid file" do 
+    before do 
+      @package_result_filename = "package_result_filename"
+      
+      File.stubs(:exists?).returns(true)
+      @filename = "a-file-name"
+      
+      @file = mock('fake file handle')
+      File.stubs(:open).with(@filename).returns(@file)
+      
+      @mock_config = mock('mock-config')
+      BackItUp::Config.stubs(:new).returns(@mock_config)
+      
+      @mock_packager
+      @mock_packager.stubs(:package).returns(@package_result_filename)
+      BackItUp::FilePackager.stubs(:new).returns(@mock_packager)
+      
+      
+    end
+    it "should create Config with file handle" do 
+      BackItUp::Config.expects(:new).with( @file ).returns(@mock_config)
+      BackItUp::Runner.new(@filename)
+    end
+    
+    it "should create Packager with Config" do 
+      BackItUp::FilePackager.expects(:new).with(@mock_config)
+      BackItUp::Runner.new(@filename)
+    end
+    
+    it "should start packaging" do 
+      @mock_packager.expects(:package)
+      BackItUp::Runner.new(@filename)
+    end
+    
+    it "should print name of packaged file" do 
+      BackItUp::Runner.any_instance.expects(:puts).with {|s| s =~ /#{@package_result_filename}/ }
+      BackItUp::Runner.new(@filename)
+    end
+    
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'back_it_up'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/spec/test-config.backitup

@@ -0,0 +1,11 @@
+
+backup do
+  file 'any-filename'
+  dir 'a directory'
+  
+  destination_file "backup_name"
+  
+  #ftp_to
+  #scp_to
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: robinsp-backitup
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robin Spainhour
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-27 00:00:00 -07:00
+default_executable: backitup
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple backup
+email: robin@robinspainhour.com
+executables: 
+- backitup
+extensions: []
+
+extra_rdoc_files: 
+- bin/backitup
+- lib/back_it_up.rb
+- lib/back_it_up/config.rb
+- lib/back_it_up/file_packager.rb
+- lib/back_it_up/command.rb
+- lib/back_it_up/runner.rb
+files: 
+- bin/backitup
+- spec/test-config.backitup
+- spec/file_packager_spec.rb
+- spec/config_spec.rb
+- spec/runner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- Rakefile
+- Manifest
+- lib/back_it_up.rb
+- lib/back_it_up/config.rb
+- lib/back_it_up/file_packager.rb
+- lib/back_it_up/command.rb
+- lib/back_it_up/runner.rb
+- backitup.gemspec
+has_rdoc: true
+homepage: http://github.com/robinsp/backitup
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Backitup
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: backitup
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Simple backup
+test_files: []
+