rdbackup 0.1.1

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem
+.yardoc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "backup Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2012-08-13
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+
+  gem 'rubygems-tasks',  '~> 0.2'
+  gem 'rspec',  '~> 2.4'
+  gem 'yard',  '~> 0.7'
+  gem 'bundler',  '~> 1.0'
+  gem 'rake',  '~> 0.8'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Christophe Arguel
+
+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.md

@@ -0,0 +1,48 @@
+# rdbackup
+
+Backup local directories to a remote server leveraging rdiff-backup.
+
+## Description
+
+This gem provides an executable script, __rdbackup__, that allows
+to backup local directories to a remote server. The actual backup 
+operation is ensured by rdiff-backup.
+The backup configuration is provided by a YAML file.
+
+## Examples
+
+Example backup configuration:
+
+    server: &backup_server
+        hostname: backup-server
+        directory: /var/lib/backup
+    
+    backup:
+        - directory: /var/lib/dir1
+          server: *backup_server
+    
+        - directory: /var/lib/dir2
+          server: *backup_server
+
+
+Start a backup according to a given configuration file.
+
+    $ rdbackup go path/to/config.yml
+
+Start a backup considering default configuration (_$HOME/.rdbackup.conf_ otherwise _/etc/rdbackup.conf_)
+
+    $ rdbackup go
+
+## Requirements
+rdiff-backup shall be installed on current host and remote host.
+Running as root should the preferable option In order to backup system files.
+
+## Install
+
+    $ gem install rdbackup
+
+## Copyright
+
+Copyright (c) 2012 Christophe Arguel
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/bin/rdbackup

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby 
+
+lib_dir=File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'thor'
+require 'rdbackup'
+
+class RdBackupCli < Thor
+
+  include Thor::Actions
+
+  desc "go CONFIF", <<-DOC
+Make a backup considering the given YAML configuration file.
+If CONFIG is not provided try to load ~/.rdbackup.conf or /etc/rdbackup.conf.
+  DOC
+  def go(config=nil)
+    config ||= default_config
+
+    if config.nil?
+      error("No YAML configuration file found. Aborting.")
+      exit 1
+    end
+
+
+    begin
+    app = RdBackup::Application.new config
+      app.backup
+    rescue Exception => message
+      error ""
+      error "An error occured during backup with the following message : #{message}"
+      exit 1
+    end
+  end
+
+
+  no_tasks do
+
+    # Identify the default configuration.
+    def default_config
+      config = nil
+      catch(:config_found) {
+        [File.join(ENV["HOME"], ".rdbackup.conf"), File.join("/etc", "rdbackup.conf")].each do |conf|
+          if File.exist? conf
+            config = conf
+            throw :config_found
+          end
+        end
+      }
+
+      return config
+    end
+
+  end
+end
+
+RdBackupCli.start

data/lib/rdbackup/app.rb

@@ -0,0 +1,23 @@
+require 'psych'
+
+module RdBackup
+
+  # Backup all directories define in a YAML configuration file.
+  # The actuel backup is ensured by rdiff-backup command.
+  class Application
+
+    # Initialize the instance with a YAML configuration file
+    # @param config [String] path to the YAML config file
+    def initialize(config)
+      @config = Psych.load(File.open(config))
+    end
+
+    # Call rdiff-backup for each source directory to backup
+    def backup
+      @config["backup"].each do |item|
+        well_executed = system("rdiff-backup #{item["directory"]} #{item["server"]["hostname"]}::#{item["server"]["directory"]}")
+        raise "rdiff-backup failed" unless well_executed
+      end
+    end
+  end
+end

data/lib/rdbackup/version.rb

@@ -0,0 +1,4 @@
+module RdBackup
+  # backup version
+  VERSION = "0.1.1"
+end

data/lib/rdbackup.rb

@@ -0,0 +1,2 @@
+require 'rdbackup/version'
+require 'rdbackup/app'

data/rdbackup.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/rdbackup/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rdbackup"
+  gem.version       = RdBackup::VERSION
+  gem.summary       = %q{Backup local directories to a remote server leveraging rdiff-backup.}
+  gem.description   = <<EOD
+This gem provides an executable script to backup local directories.
+THe actual backup is ensured by rdiff-backup.
+The backup configuration is provided by a YAML configuration.
+EOD
+  gem.license       = "MIT"
+  gem.authors       = ["Christophe Arguel"]
+  gem.email         = "christophe.arguel@free.fr"
+  gem.homepage      = "https://rubygems.org/gems/rdbackup"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_dependency 'psych', '~> 1.3.4'
+  gem.add_dependency 'thor', '~> 0.15.4'
+end

data/spec/app_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'rdbackup'
+
+module RdBackup
+
+  describe Application do
+
+    context "after loading sample_config.yml" do
+      subject { RdBackup::Application.new(sample_config) }
+
+      it "should call rdiff-backup for each source diretory to backup" do
+        subject.should_receive(:system).with("rdiff-backup /var/lib/dir1 backup-server::/var/lib/backup").ordered.and_return(0)
+        subject.should_receive(:system).with("rdiff-backup /var/lib/dir2 backup-server::/var/lib/backup").ordered.and_return(0)
+        subject.backup
+      end
+
+      it "should raise an error whenever rdiff-backup failed" do
+        subject.stub(:system) { return 0 }
+        lambda {subject.backup}.should raise_error
+      end
+    end
+  end 
+end

data/spec/backup_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rdbackup'
+
+describe RdBackup do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/sample_config.yml

@@ -0,0 +1,10 @@
+server: &backup_server
+    hostname: backup-server
+    directory: /var/lib/backup
+
+backup:
+    - directory: /var/lib/dir1
+      server: *backup_server
+
+    - directory: /var/lib/dir2
+      server: *backup_server

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'rdbackup/version'
+
+#include Backup
+def sample_config
+  File.join(File.dirname(__FILE__), "sample_config.yml")
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rdbackup
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Christophe Arguel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &9332200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *9332200
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &9345680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *9345680
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: &9344560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *9344560
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &9343860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *9343860
+description: ! 'This gem provides an executable script to backup local directories.
+
+  THe actual backup is ensured by rdiff-backup.
+
+  The backup configuration is provided by a YAML configuration.
+
+'
+email: christophe.arguel@free.fr
+executables:
+- rdbackup
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rdbackup
+- lib/rdbackup.rb
+- lib/rdbackup/app.rb
+- lib/rdbackup/version.rb
+- rdbackup.gemspec
+- spec/app_spec.rb
+- spec/backup_spec.rb
+- spec/sample_config.yml
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/rdbackup
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4285831268404969671
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4285831268404969671
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Backup local directories to a remote server leveraging rdiff-backup.
+test_files:
+- spec/app_spec.rb
+- spec/backup_spec.rb
+- spec/sample_config.yml
+- spec/spec_helper.rb