duplicati 0.0.1

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: nVBmrsBEd9K48oqRBAijkavSfMKtxW82w

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+notifications:
+  recipients:
+    - jarmo.p@gmail.com
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jarmo Pertman
+
+MIT License
+
+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,46 @@
+# Duplicati
+[![Build Status](https://secure.travis-ci.org/jarmo/duplicati-rb.png)](http://travis-ci.org/jarmo/duplicati-rb)
+[![Coverage](https://coveralls.io/repos/jarmo/duplicati-rb/badge.png?branch=master)](https://coveralls.io/r/jarmo/duplicati-rb)
+
+This gem is a [Duplicati](http://duplicati.com) backup utility wrapper written in Ruby with easier API and sensible configuration defaults compared to Duplicati's own utilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'duplicati'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install duplicati
+
+## Usage
+
+````
+require "duplicati"
+
+Duplicati.backup(
+  :backup_paths => ["/foo/bar", "/foo/baz"],
+  :backup_store_path => "file:///backup",
+  :backup_encryption_key => "very-secret-key"
+)
+````
+
+Refer to [Duplicati documentation](http://duplicati.com/howtos) for different backup store locations.
+
+## Limitations
+
+* Currently only backup is supported. Use command line or GUI utility directly for restoring.
+* You need to start Ruby with administrative privileges under Windows to backup files in use.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/duplicati.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duplicati/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "duplicati"
+  gem.version       = Duplicati::VERSION
+  gem.authors       = ["Jarmo Pertman"]
+  gem.email         = ["jarmo.p@gmail.com"]
+  gem.description   = %q{Duplicati backup utility wrapper in Ruby with easier API and sensible configuration defaults.}
+  gem.summary       = %q{Duplicati backup utility wrapper in Ruby with easier API and sensible configuration defaults.}
+  gem.homepage      = "https://github.com/jarmo/duplicati-rb"
+
+  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 "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/duplicati/backup.rb

@@ -0,0 +1,22 @@
+class Duplicati
+  class Backup
+    def initialize(opts={})
+      @opts = opts
+    end
+
+    def command
+      %Q["#{@opts[:duplicati_path]}" backup "#{(@opts[:backup_paths] || []).join(File::PATH_SEPARATOR)}" "#{@opts[:backup_store_path]}"
+             --passphrase="#{@opts[:backup_encryption_key]}"
+             --auto-cleanup                        
+             --full-if-older-than=1M
+             --usn-policy=on
+             --snapshot-policy=on
+             --full-if-sourcefolder-changed
+             2>&1 1>> "#{@opts[:log_path]}" &&
+
+             "#{@opts[:duplicati_path]}" delete-all-but-n 5 "#{@opts[:backup_store_path]}"
+             --force
+             2>&1 1>> "#{@opts[:log_path]}"]
+    end
+  end
+end

data/lib/duplicati/notification/growl.rb

@@ -0,0 +1,36 @@
+class Duplicati
+  module Notification
+    class Growl
+      class << self
+        def notify(success)
+          return unless load_gem
+
+          growl = GNTP.new("Backup")
+          growl.register(:notifications => [{
+            :name     => "backup-notify",
+            :enabled  => true,
+          }])
+
+          growl.notify(
+            :name  => "backup-notify",
+            :title => "Backup",
+            :text  => success ? "Backup successfully finished!" : "Backup failed!",
+            :icon  => File.expand_path(success ? "success.png" : "failed.png", File.dirname(__FILE__))
+          )
+        rescue => e
+          Kernel.warn "Failed to notify via Growl: #{e.message}"
+        end
+
+        private
+
+        def load_gem
+          require "ruby_gntp"
+          true
+        rescue LoadError
+          Kernel.warn "ruby_gntp gem is not installed, which is needed for Growl notifications!"
+          false
+        end
+      end
+    end
+  end
+end

data/lib/duplicati/version.rb

@@ -0,0 +1,3 @@
+class Duplicati
+  VERSION = "0.0.1"
+end

data/lib/duplicati.rb

@@ -0,0 +1,59 @@
+require File.expand_path("duplicati/version", File.dirname(__FILE__))
+require File.expand_path("duplicati/backup", File.dirname(__FILE__))
+require File.expand_path("duplicati/notification/growl", File.dirname(__FILE__))
+
+class Duplicati
+
+  class << self
+    def backup(opts={})
+      new(opts).backup
+    end
+  end
+
+  attr_reader :opts, :execution_success
+
+  def initialize(opts={})
+    opts[:log_path] ||= "duplicati.log"
+    opts[:duplicati_path] = duplicati_path(opts[:duplicati_path])
+    opts[:notifications] ||= [Notification::Growl]
+    @opts = opts
+  end
+
+  def backup
+    execute Backup.new(
+      options :duplicati_path, :backup_paths, :backup_store_path, :backup_encryption_key, :log_path
+    ).command
+  end
+
+  private
+
+  def duplicati_path(path_from_options)
+    path = path_from_options || ENV["DUPLICATI_PATH"] || "/Program Files/Duplicati"
+    File.join(path, "Duplicati.CommandLine")
+  end
+
+  def execute(command)
+    old_log_file_size = File.read(@opts[:log_path]).strip.size rescue 0
+    @execution_success = system(format command) && File.read(@opts[:log_path]).strip.size > old_log_file_size
+    notify
+  end
+
+  def options(*options_to_extract)
+    options_to_extract.reduce({}) do |memo, option|
+      memo[option] = @opts[option]
+      memo
+    end
+  end
+
+  def format(command)
+    command.gsub($/, "").squeeze(" ")
+  end
+
+  def notify
+    @opts[:notifications].each do |notification|
+      notification.notify @execution_success
+    end
+  end
+
+end
+

data/spec/duplicati/backup_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Duplicati::Backup do
+  it "#command" do
+    Duplicati::Backup.new(
+      :duplicati_path => "/bin/duplicati-commandline",
+      :backup_paths => ["/foo/bar", "/baz/bar"],
+      :backup_store_path => "file:///foo/backup",
+      :backup_encryption_key => "secret",
+      :log_path => "/zzz/output.log"
+    ).command.should == %Q["/bin/duplicati-commandline" backup "/foo/bar#{File::PATH_SEPARATOR}/baz/bar" "file:///foo/backup"
+             --passphrase="secret"
+             --auto-cleanup                        
+             --full-if-older-than=1M
+             --usn-policy=on
+             --snapshot-policy=on
+             --full-if-sourcefolder-changed
+             2>&1 1>> "/zzz/output.log" &&
+
+             "/bin/duplicati-commandline" delete-all-but-n 5 "file:///foo/backup"
+             --force
+             2>&1 1>> "/zzz/output.log"]
+  end
+end

data/spec/duplicati/notification/growl_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Duplicati::Notification::Growl do
+
+  before do
+    Kernel.stub(:warn)
+    Object.any_instance.stub(:require).with("ruby_gntp")
+    GNTP = double('gntp').as_null_object unless defined?(GNTP) && GNTP.null_object?
+  end
+
+  let(:growl) { subject.class }
+
+  it "notifies with success message" do
+    GNTP.should_receive(:notify).with notification_args("Backup successfully finished!", "success.png")
+    growl.notify(true)
+  end
+
+  it "notifies with failure message" do
+    GNTP.should_receive(:notify).with notification_args("Backup failed!", "failed.png")
+    growl.notify(false)    
+  end
+
+  it "does not blow up when ruby_gntp gem is not installed" do
+    Object.any_instance.unstub(:require)
+    GNTP.should_not_receive(:notify)
+
+    expect {
+      growl.notify(false)
+    }.to_not raise_error
+  end
+
+  it "does not blow up when notifying fails" do
+    GNTP.stub(:register) { raise "foo" }
+
+    expect {
+      growl.notify(false)
+    }.to_not raise_error
+  end
+
+  def notification_args(text, icon)
+    {
+      :name  => "backup-notify",
+      :title => "Backup",
+      :text  => text,
+      :icon  => File.expand_path(icon, File.join(File.dirname(__FILE__), "../../../lib/duplicati/notification"))
+    }
+  end
+
+end

data/spec/duplicati_spec.rb

@@ -0,0 +1,140 @@
+require "spec_helper"
+
+describe Duplicati do
+  context "#initialize" do
+
+    it "has specified default log path" do
+      Duplicati.new.opts[:log_path].should == "duplicati.log"
+    end
+
+    it "allows to specify log path" do
+      Duplicati.new(:log_path => "/foo/bar").opts[:log_path].should == "/foo/bar"
+    end
+
+    it "has default duplicati path" do
+      Duplicati.new.opts[:duplicati_path].should == "/Program Files/Duplicati/Duplicati.CommandLine"
+    end
+
+    it "allows to specify duplicati path via options" do
+      Duplicati.new(:duplicati_path => "/zzz/baz").opts[:duplicati_path].should == "/zzz/baz/Duplicati.CommandLine"
+    end
+
+    it "allows to specify duplicati path via environment variable" do
+      begin
+        ENV["DUPLICATI_PATH"] = "/env/path"
+        Duplicati.new.opts[:duplicati_path].should == "/env/path/Duplicati.CommandLine"
+      ensure
+        ENV.delete "DUPLICATI_PATH"
+      end
+    end
+
+    it "has default notifications" do
+      Duplicati.new.opts[:notifications].should == [Duplicati::Notification::Growl]
+    end
+
+    it "allows to specify notifications" do
+      Duplicati.new(:notifications => [Object]).opts[:notifications].should == [Object]
+    end
+
+    it "allows to specify other options" do
+      Duplicati.new(:foo => true).opts[:foo].should be_true
+    end
+
+  end
+
+  context "#backup" do
+    it "executes the backup command" do
+      Duplicati::Backup.any_instance.should_receive(:command).and_return("backup command")
+      duplicati = Duplicati.new
+      duplicati.should_receive(:execute).with("backup command")
+
+      duplicati.backup
+    end
+
+    it "proxies options to backup command" do
+      duplicati_path = "/foo/bar"
+      options = {
+        :duplicati_path => duplicati_path,
+        :backup_paths => ["foo", "bar"],
+        :backup_encryption_key => "secret",
+        :backup_store_path => "baz",
+        :log_path => "tmp"
+      }
+      expected_formatted_options = options.dup
+      expected_formatted_options[:duplicati_path] += "/Duplicati.CommandLine"
+      Duplicati::Backup.should_receive(:new).with(expected_formatted_options).and_return(double('backup').as_null_object)
+      Duplicati.any_instance.stub(:execute)
+
+      Duplicati.new(options).backup
+    end
+  end
+
+  context ".backup" do
+    it "is a convenience method for .new#backup" do
+      Duplicati::Backup.any_instance.should_receive(:command).and_return("backup command")
+      Duplicati.any_instance.should_receive(:execute).with("backup command")
+
+      Duplicati.backup
+    end
+  end
+
+  context "#execute" do
+
+    before do
+      Duplicati.any_instance.stub(:notify)
+    end
+
+    it "executes the command" do
+      cmd = "multiline
+        command     with  spaces"
+      Object.any_instance.should_receive(:system).with("multiline command with spaces")
+
+      Duplicati.new(:log_path => "foo").send(:execute, cmd)
+    end
+
+    context "#execution_success" do
+      it "is false when command itself fails" do
+        Object.any_instance.should_receive(:system).and_return false
+
+        duplicati = Duplicati.new
+        duplicati.send(:execute, "")
+        duplicati.execution_success.should be_false 
+      end
+
+      it "is false when command succeeds and log file size does not increase" do
+        Object.any_instance.should_receive(:system).and_return true
+        File.should_receive(:read).with("foo").and_return "", ""
+
+        duplicati = Duplicati.new :log_path => "foo"
+        duplicati.send(:execute, "")
+        duplicati.execution_success.should be_false 
+      end
+
+      it "is true when command succeeds and log file size increases" do
+        Object.any_instance.should_receive(:system).and_return true
+        File.should_receive(:read).with("foo").and_return "", "output"
+
+        duplicati = Duplicati.new :log_path => "foo"
+        duplicati.send(:execute, "")
+        duplicati.execution_success.should be_true
+      end
+    end
+
+    context "#notify" do
+      before do
+        Duplicati.any_instance.unstub(:notify)
+      end
+
+      it "notifies with all possible notifications" do
+        Object.any_instance.stub(:system).and_return false
+        notification1 = double('notification1').as_null_object
+        notification2 = double('notification2').as_null_object
+        
+        notification1.should_receive(:notify).with(false)
+        notification2.should_receive(:notify).with(false)
+        Duplicati.new(:notifications => [notification1, notification2]).send(:execute, "")
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+Coveralls.wear!
+
+require "duplicati"
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: duplicati
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jarmo Pertman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Duplicati backup utility wrapper in Ruby with easier API and sensible
+  configuration defaults.
+email:
+- jarmo.p@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- duplicati.gemspec
+- lib/duplicati.rb
+- lib/duplicati/backup.rb
+- lib/duplicati/notification/failed.png
+- lib/duplicati/notification/growl.rb
+- lib/duplicati/notification/success.png
+- lib/duplicati/version.rb
+- spec/duplicati/backup_spec.rb
+- spec/duplicati/notification/growl_spec.rb
+- spec/duplicati_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jarmo/duplicati-rb
+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.24
+signing_key: 
+specification_version: 3
+summary: Duplicati backup utility wrapper in Ruby with easier API and sensible configuration
+  defaults.
+test_files:
+- spec/duplicati/backup_spec.rb
+- spec/duplicati/notification/growl_spec.rb
+- spec/duplicati_spec.rb
+- spec/spec_helper.rb
+has_rdoc: