dreamhost-personal-backup 0.1.0

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+notifications:
+  disabled: true
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby

data/CHANGELOG

@@ -0,0 +1,4 @@
+= Dreamhost Personal Backup gem CHANGELOG
+
+== 0.1.0
+ * Initial limited feature release. Includes basic rsync backup, logging, and check for an already-running backup.

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'rsync'
+
+group :test, :development do
+  gem 'mocha', :require => false
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,78 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    metaclass (0.0.1)
+    mime-types (2.0)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (4.1.0)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rsync (1.0.8)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  jeweler
+  mocha
+  rsync
+  simplecov

data/LICENSE

@@ -0,0 +1,21 @@
+==== Dreamhost Backup Gem License
+
+Copyright (c) 2013 Phil Trimble
+
+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,105 @@
+= Dreamhost Personal Backup Gem
+
+THIS IS A WORK IN PROGRESS. FEATURES MAY NOT WORK AND DOCUMENTATION MAY NOT BE ACCURATE.
+PLEASE DO NOT USE YET FOR BACKUPS.
+
+{<img src="https://travis-ci.org/ptrimble/dreamhost-personal-backup.png" />}[https://travis-ci.org/ptrimble/dreamhost-personal-backup] {<img src="https://coveralls.io/repos/ptrimble/dreamhost-personal-backup/badge.png?branch=master" />}[https://coveralls.io/r/ptrimble/dreamhost-personal-backup]
+
+Provides functionality to perform personal backups (on Linux or OSX) to a Dreamhost personal backup server.
+
+Dreamhost provides a 'personal backup' that allows you to back up your personal files to
+special Dreamhost backup servers. I use it as an offsite mirror of my personal files (documents,
+music, photos, etc).
+
+This backup is a mirror of what is on your home machine. It does not have versioning. If you want to restore from
+backup then you simply copy what is on the Dreamhost server to your home machine.
+
+Currently you must set up your own schedule to execute this gem.
+
+This gem uses rsync to perform the backups.
+
+Dreamhost Personal Backup Wiki: http://wiki.dreamhost.com/Personal_Backup
+
+=== Usage
+
+Install the usual way:
+    gem install dreamhost-personal-backup
+
+You can then call it from the command line.
+    $ dreamhost_personal_backup
+
+The gem accepts only one parameter (which is optional): a config file path.
+    $ dreamhost_personal_backup '/path/to/you/config/file'
+
+Calling without a config file parameter will cause the gem to look for a config file at
+'~/.dreamhost_personal_backup/default_config.yml'. If this file does not exist then an error will be returned.
+
+==== Dreamhost Setup
+
+This gem currently assumes that you have activated your Dreamhost Backup User via the Dreamhost Panel and that you
+have set up SSH trust with your backup server.
+
+Dreamhost Backup Servers use rssh, which is a restricted shell. As such setting up SSH via their instructions is the
+only way to truly automate backups. See their wiki (http://wiki.dreamhost.com/Personal_Backup) for step-by-step
+instructions on how to set up SSH trust between your host and the backup server.
+
+=== Configuration
+
+This gem can be called either by passing a configuration YAML filepath or by setting up a configuration file in a
+default location. The default location that this gem will reference for a configuration file is
+'~/.dreamhost_personal_backup/default_config.yml'. If this file does not exist and no config file is passed then an
+error will be returned.
+
+The following parameters are available:
+
+    * user (required)
+    * host (required)
+    * targets (required)
+    * logfile (optional, default: STDOUT)
+    * logrotationsizeinbytes (optional, default: 105000000)
+    * logkeepcount (optional, default: 3)
+    * notifyemail (optional, default: nil)
+
+Here is an example config file:
+
+    user: <username>
+    host: <host>
+
+    logfile: ~/logs/backup.log
+    logrotationsizeinbytes: 500000000
+    logkeepcount: 5
+
+    notifyemail: target_address@email.com
+
+    targets:
+      music: /media/drive/Music
+      documents: ~/Documents
+      writing: ~/Writing
+      scripts: ~/scripts
+      gmail-archive: ~/gmail-archive
+      patches: ~/Code/patches
+
+==== cron
+
+Tasks with this gem can be scheduled to execute at regular intervals. Example:
+
+    # Run the backup script every 3 hours every day
+    0 0,3,6,9,12,15,18,22 * * * dreamhost_personal_backup
+
+=== rsync details
+
+The following parameters are used with rsync:
+     * Archive (-a) - ensures that all symbolic links, devices, attributes, permissions, ownerships, etc are preserved
+     * Verbose (-v) - Shows verbose logging
+     * Compress (-z) - Compresses files during transfer
+     * Partial/ Progress (-P) - Keeps partially tranferred files and shows progress in the logs
+     * Deletes (--delete) - Deletes files on the Dreamhost side that do not exist on the sending side
+
+In practice what this means is that it keeps a mirror of what is on the sending side. Deleting a file on the home host
+will remove it from the backup server.
+
+=== Credits and code
+
+* Source: https://github.com/ptrimble/dreamhost-personal-backup
+* Build status: http://travis-ci.org/#!/ptrimble/dreamhost-personal-backup
+* Code Coverage: https://coveralls.io/r/ptrimble/dreamhost-personal-backup

data/bin/dreamhost_personal_backup

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'dreamhost_personal_backup'
+
+DreamhostPersonalBackup.perform_backup(ARGV[0])

data/dreamhost-personal-backup.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile.rb, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "dreamhost-personal-backup"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Trimble"]
+  s.date = "2014-01-15"
+  s.description = "Provides functionality to perform personal backups (on Linux or OSX) to a Dreamhost personal backup server."
+  s.email = "philtrimble@gmail.com"
+  s.executables = ["dreamhost_personal_backup"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".coveralls.yml",
+    ".travis.yml",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "bin/dreamhost_personal_backup",
+    "dreamhost-personal-backup.gemspec",
+    "lib/backup/backup.rb",
+    "lib/backup/configurator.rb",
+    "lib/backup/status_manager.rb",
+    "lib/dreamhost_personal_backup.rb",
+    "rakefile.rb",
+    "test/test_backup.rb",
+    "test/test_configurator.rb",
+    "test/test_dreamhost_personal_backup.rb",
+    "test/test_files/test_config_file_missing_optional_params.yml",
+    "test/test_files/test_invalid_parameters.yml",
+    "test/test_files/test_standard_config_file.yml",
+    "test/test_helper.rb",
+    "test/test_status_manager.rb"
+  ]
+  s.homepage = "https://github.com/ptrimble/dreamhost-personal-backup"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Provides functionality to perform personal backups (on Linux or OSX) to a Dreamhost personal backup server."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rsync>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<coveralls>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rsync>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<coveralls>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rsync>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<coveralls>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/backup/backup.rb

@@ -0,0 +1,55 @@
+require 'rsync'
+
+module DreamhostPersonalBackup
+
+  class MissingConfigParameter < StandardError; end
+
+  module Backup
+    RSYNC_COMMAND_ARGS = ['-e ssh', '-avzP', '--delete']
+
+    def self.run_for_target_directory(target_dir, config_parameters)
+      check_for_required_parameters(config_parameters)
+
+      user = config_parameters[:user]
+      host = config_parameters[:host]
+      logger = config_parameters[:logger]
+
+      target_dir = File.expand_path(target_dir)
+
+      logger.info("  Running backup for target directory: #{target_dir}")
+
+      rsync_result = Rsync.run(target_dir, "#{user}@#{host}:~/", RSYNC_COMMAND_ARGS)
+
+      log_rsync_result(rsync_result, logger)
+
+      rsync_result.success?
+    end
+
+    private
+
+    def self.check_for_required_parameters(config_parameters)
+      raise MissingConfigParameter if config_parameters[:user].nil?
+      raise MissingConfigParameter if config_parameters[:host].nil?
+      raise MissingConfigParameter if config_parameters[:logger].nil?
+    end
+
+    def self.log_rsync_result(rsync_result, logger)
+      if rsync_result.success?
+        if rsync_result.changes.count > 0
+          logger.info("  Results:")
+
+          rsync_result.changes.each do |change|
+            logger.info "   #{change.summary} - #{change.filename}"
+          end
+        else
+          logger.info("  No changes took place!")
+        end
+
+        logger.info("  Backup completed successfully")
+      else
+        logger.error("  Backup failed, error: #{rsync_result.error}")
+      end
+    end
+  end
+
+end

data/lib/backup/configurator.rb

@@ -0,0 +1,59 @@
+require 'yaml'
+require 'logger'
+
+module DreamhostPersonalBackup
+
+  class ConfigFileNotFound < StandardError; end
+  class InvalidConfigParameter < StandardError; end
+
+  class Configurator
+
+    VALID_CONFIG_PARAMETERS = [:user, :host, :logfile, :targets, :notifyemail, :logrotationsizeinbytes, :logkeepcount]
+
+    DEFAULT_CONFIG_FILE = '~/.dreamhost_personal_backup/default_config.yml'
+    DEFAULT_LOG_SIZE = 105000000
+    DEFAULT_LOG_KEEP_COUNT = 3
+
+    def self.process_config_file(config_file_path = nil)
+      config_file_path ||= DEFAULT_CONFIG_FILE
+      config_file = File.expand_path(config_file_path)
+
+      raise DreamhostPersonalBackup::ConfigFileNotFound unless File.file?(config_file)
+
+      config_parameters = Hash.new
+
+      config_file = YAML.load_file(config_file)
+      config_file.each do |config_key, config_value|
+        config_parameter = config_key.downcase.to_sym
+
+        raise DreamhostPersonalBackup::InvalidConfigParameter unless VALID_CONFIG_PARAMETERS.include?(config_parameter)
+
+        config_parameters[config_parameter] = config_value
+      end
+
+      config_parameters = set_default_values_if_necessary(config_parameters)
+
+      config_parameters[:logger] = create_logger(config_parameters)
+
+      config_parameters
+    end
+
+    private
+
+    def self.set_default_values_if_necessary(config_parameters)
+      config_parameters[:logrotationsizeinbytes] = DEFAULT_LOG_SIZE unless config_parameters.has_key?(:logrotationsizeinbytes)
+      config_parameters[:logkeepcount] = DEFAULT_LOG_KEEP_COUNT unless config_parameters.has_key?(:logkeepcount)
+
+      config_parameters
+    end
+
+    def self.create_logger(config_parameters)
+      logfile = File.expand_path(config_parameters[:logfile]) unless config_parameters[:logfile].nil?
+      logfile = STDOUT if logfile.nil?
+
+      Logger.new(logfile,
+                 shift_age = config_parameters[:logkeepcount],
+                 shift_size = config_parameters[:logrotationsizeinbytes])
+    end
+  end
+end

data/lib/backup/status_manager.rb

@@ -0,0 +1,31 @@
+module DreamhostPersonalBackup
+
+  module StatusManager
+
+    PID_FILE = '~/.dreamhost_personal_backup/running.pid'
+
+    def self.is_backup_running?
+      pid_file = File.expand_path(PID_FILE)
+      return false unless File.file?(pid_file)
+
+      pid = File.open(pid_file).read.to_i
+
+      begin
+        Process.getpgid(pid)
+        return true
+      rescue Errno::ESRCH
+        return false
+      end
+    end
+
+    def self.create_pid_file
+      File.open(File.expand_path(PID_FILE), "w") { |f| f.write(Process.pid) }
+    end
+
+    def self.remove_pid_file
+      pid_file = File.expand_path(PID_FILE)
+      File.delete(pid_file) if File.file?(pid_file)
+    end
+
+  end
+end

data/lib/dreamhost_personal_backup.rb

@@ -0,0 +1,32 @@
+require 'backup/configurator'
+require 'backup/backup'
+require 'backup/status_manager'
+
+module DreamhostPersonalBackup
+  VERSION = '0.1.0'
+
+  def self.perform_backup(config_file)
+    return if DreamhostPersonalBackup::StatusManager.is_backup_running?
+
+    DreamhostPersonalBackup::StatusManager.create_pid_file
+
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file(config_file)
+
+    logger = config_parameters[:logger]
+
+    # Add some newlines for readability
+    logger.info("")
+    logger.info("")
+
+    logger.info("Starting new backup run at #{DateTime.now}")
+
+    config_parameters[:targets].each_value do |target|
+      DreamhostPersonalBackup::Backup.run_for_target_directory(target, config_parameters)
+    end
+
+    DreamhostPersonalBackup::StatusManager.remove_pid_file
+
+    logger.info("Backup run completed at #{DateTime.now}")
+  end
+
+end

data/rakefile.rb

@@ -0,0 +1,36 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'dreamhost_personal_backup'
+
+task :default => :test
+
+desc 'Run all tests'
+task :test => ["test:lib"]
+
+namespace :test do
+
+  desc 'Run gem tests.'
+  Rake::TestTask.new(:lib) do |t|
+    t.libs << 'lib'
+    t.test_files = FileList['test/test*.rb'].exclude('test_helper.rb')
+    t.verbose = false
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dreamhost-personal-backup"
+    gemspec.summary = "Provides functionality to perform personal backups (on Linux or OSX) to a Dreamhost personal backup server."
+    gemspec.description = "Provides functionality to perform personal backups (on Linux or OSX) to a Dreamhost personal backup server."
+    gemspec.email = "philtrimble@gmail.com"
+    gemspec.homepage = "https://github.com/ptrimble/dreamhost-personal-backup"
+    gemspec.version = DreamhostPersonalBackup::VERSION
+    gemspec.authors = ["Phil Trimble"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/test/test_backup.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
+
+require 'backup/backup'
+require 'logger'
+
+class BackupTests < Test::Unit::TestCase
+
+  CONFIG_PARAMETERS = {:user => "testuser", :host => "localhost", :logger => Logger.new(STDOUT)}
+
+  SOURCE_DIR_PARAMETER = "/path/to/source"
+  DEST_DIR_PARAMETER = "#{CONFIG_PARAMETERS[:user]}@#{CONFIG_PARAMETERS[:host]}:~/"
+
+  def test_backup_is_performed_without_errors_with_updated_file
+    set_expected_rsync_result_as(true)
+    assert DreamhostPersonalBackup::Backup.run_for_target_directory(SOURCE_DIR_PARAMETER, CONFIG_PARAMETERS)
+  end
+
+  def test_backup_returns_failure_if_rsync_reports_an_error
+    set_expected_rsync_result_as(false)
+    assert_equal false, DreamhostPersonalBackup::Backup.run_for_target_directory(SOURCE_DIR_PARAMETER, CONFIG_PARAMETERS)
+  end
+
+  def test_backup_fails_if_user_is_missing
+    parameters_with_host_only = {:host => "localhost"}
+
+    assert_raise(DreamhostPersonalBackup::MissingConfigParameter) {
+      DreamhostPersonalBackup::Backup.run_for_target_directory(SOURCE_DIR_PARAMETER, parameters_with_host_only)
+    }
+  end
+
+  def test_backup_fails_if_host_is_missing
+    parameters_with_user_only = {:user => "testuser"}
+
+    assert_raise(DreamhostPersonalBackup::MissingConfigParameter) {
+      DreamhostPersonalBackup::Backup.run_for_target_directory(SOURCE_DIR_PARAMETER, parameters_with_user_only)
+    }
+  end
+
+  private
+
+  def set_expected_rsync_result_as(rsync_return_code)
+    rsync_change = stub(:summary => "timestamp", :filename => "test.dat")
+
+    rsync_change_array = Array.new
+    rsync_change_array.push(rsync_change)
+
+    rsync_return_code = stub(:success? => rsync_return_code, :changes => rsync_change_array, :error => "rsync example error")
+
+    suppress_logging_messages
+
+    Rsync.expects(:run).with(SOURCE_DIR_PARAMETER,
+                             DEST_DIR_PARAMETER,
+                             DreamhostPersonalBackup::Backup::RSYNC_COMMAND_ARGS).returns(rsync_return_code)
+  end
+
+  def suppress_logging_messages
+    Logger.any_instance.expects(:info).at_least(0).returns(nil)
+    Logger.any_instance.expects(:error).at_least(0).returns(nil)
+  end
+
+end

data/test/test_configurator.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
+
+require 'backup/configurator'
+
+class ConfiguratorTests < Test::Unit::TestCase
+
+  def test_raise_error_if_config_file_does_not_exist
+    assert_raise(DreamhostPersonalBackup::ConfigFileNotFound) {
+      DreamhostPersonalBackup::Configurator.process_config_file("/file/does/not/exist")
+    }
+  end
+
+  def test_config_file_is_processed_without_errors
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_standard_config_file.yml')
+    assert config_parameters.is_a?(Hash), "Config parameters should be a hash"
+  end
+
+  def test_config_parameters_set_without_error_from_valid_file
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_standard_config_file.yml')
+
+    assert_equal "testuser", config_parameters[:user]
+    assert_equal "testhost.com", config_parameters[:host]
+    assert_equal "TestEmail@email.com", config_parameters[:notifyemail]
+
+    assert config_parameters[:targets].is_a?(Hash)
+  end
+
+  def test_raise_error_if_invalid_parameter_is_passed
+    assert_raise(DreamhostPersonalBackup::InvalidConfigParameter) {
+      DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_invalid_parameters.yml')
+    }
+  end
+
+  def test_all_targets_set_as_expected
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_standard_config_file.yml')
+
+    assert_equal "~/music", config_parameters[:targets]["Music"]
+    assert_equal "~/movies", config_parameters[:targets]["Movies"]
+    assert_equal "~/photos", config_parameters[:targets]["Photos"]
+  end
+
+  def test_default_log_size_set_if_not_present_in_config_file
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_config_file_missing_optional_params.yml')
+
+    assert_equal DreamhostPersonalBackup::Configurator::DEFAULT_LOG_SIZE, config_parameters[:logrotationsizeinbytes]
+  end
+
+  def test_default_log_file_keep_count_set_if_not_present_in_config_file
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_config_file_missing_optional_params.yml')
+
+    assert_equal DreamhostPersonalBackup::Configurator::DEFAULT_LOG_KEEP_COUNT, config_parameters[:logkeepcount]
+  end
+
+  def test_logger_created_even_if_no_parameters_set
+    config_parameters = DreamhostPersonalBackup::Configurator.process_config_file('test/test_files/test_config_file_missing_optional_params.yml')
+
+    assert_not_nil config_parameters[:logger]
+  end
+end

data/test/test_dreamhost_personal_backup.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
+
+class DreamhostPersonalBackupTests < Test::Unit::TestCase
+
+end

data/test/test_files/test_config_file_missing_optional_params.yml

@@ -0,0 +1,7 @@
+User: testuser
+Host: testhost.com
+
+Targets:
+  Music: ~/music
+  Movies: ~/movies
+  Photos: ~/photos

data/test/test_files/test_invalid_parameters.yml

@@ -0,0 +1,8 @@
+User: testuser
+Host: testhost.com
+LogFile: ~/logs/backup.log
+InvalidParameter: ThisShouldNotBeSet!
+Targets:
+  Music: ~/music
+  Movies: ~/movies
+  Photos: ~/photos

data/test/test_files/test_standard_config_file.yml

@@ -0,0 +1,11 @@
+User: testuser
+Host: testhost.com
+
+NotifyEmail: TestEmail@email.com
+
+LogRotationSizeInBytes: 105000000
+
+Targets:
+  Music: ~/music
+  Movies: ~/movies
+  Photos: ~/photos

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+
+SimpleCov.start do
+  add_filter 'test'
+end
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '../../lib/'))
+
+$KCODE = 'u' if RUBY_VERSION =~ /^1\.8/
+
+require 'rubygems'
+require 'test/unit'
+
+require 'mocha/setup'  # The mocha docs state that this MUST come after the require for test/unit

data/test/test_status_manager.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
+
+require 'backup/status_manager'
+
+class StatusManagerTests < Test::Unit::TestCase
+
+  def test_is_backup_running_returns_false_if_no_pid_file_is_found
+    File.expects(:file?).with(File.expand_path(DreamhostPersonalBackup::StatusManager::PID_FILE)).at_least(1).returns(false)
+
+    assert_equal false, DreamhostPersonalBackup::StatusManager.is_backup_running?
+  end
+
+  def test_is_backup_running_returns_true_if_pid_file_is_found_and_pid_is_running
+    File.expects(:file?).with(File.expand_path(DreamhostPersonalBackup::StatusManager::PID_FILE)).at_least(1).returns(true)
+
+    file_handle = stub(read: "100")
+    File.expects(:open).at_least(1).returns(file_handle)
+
+    Process.expects(:getpgid).at_least(1)
+
+    assert DreamhostPersonalBackup::StatusManager.is_backup_running?
+  end
+
+  def test_is_backup_running_returns_false_if_pid_file_is_found_and_pid_is_not_running
+    File.expects(:file?).with(File.expand_path(DreamhostPersonalBackup::StatusManager::PID_FILE)).at_least(1).returns(true)
+
+    file_handle = stub(read: "100")
+    File.expects(:open).at_least(1).returns(file_handle)
+
+    Process.expects(:getpgid).at_least(1).raises(Errno::ESRCH)
+
+    assert_equal false, DreamhostPersonalBackup::StatusManager.is_backup_running?
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: dreamhost-personal-backup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Phil Trimble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rsync
+  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: mocha
+  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: simplecov
+  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: coveralls
+  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: jeweler
+  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'
+description: Provides functionality to perform personal backups (on Linux or OSX)
+  to a Dreamhost personal backup server.
+email: philtrimble@gmail.com
+executables:
+- dreamhost_personal_backup
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .coveralls.yml
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- bin/dreamhost_personal_backup
+- dreamhost-personal-backup.gemspec
+- lib/backup/backup.rb
+- lib/backup/configurator.rb
+- lib/backup/status_manager.rb
+- lib/dreamhost_personal_backup.rb
+- rakefile.rb
+- test/test_backup.rb
+- test/test_configurator.rb
+- test/test_dreamhost_personal_backup.rb
+- test/test_files/test_config_file_missing_optional_params.yml
+- test/test_files/test_invalid_parameters.yml
+- test/test_files/test_standard_config_file.yml
+- test/test_helper.rb
+- test/test_status_manager.rb
+homepage: https://github.com/ptrimble/dreamhost-personal-backup
+licenses: []
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides functionality to perform personal backups (on Linux or OSX) to a
+  Dreamhost personal backup server.
+test_files: []