duplicati 0.0.7 → 0.0.8

data/README.md

@@ -1,4 +1,5 @@
 # Duplicati
+[![Gem Version](https://badge.fury.io/rb/duplicati.png)](http://badge.fury.io/rb/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)
 
@@ -136,6 +137,25 @@ class CustomNotification
 end
 ````
 
+## Execution status
+
+Duplicati has a ````#execution_success?```` method for determining the success
+status of backup command:
+
+````ruby
+Duplicati.backup(options).execution_success? # => "true" when execution was a success.
+````
+
+## Fine Grained Commands Execution
+
+It is possible to execute commands separately when needed:
+
+````ruby
+Duplicati.backup(options).execution_success?
+# is same as
+Duplicati.new(options).backup.clean.notify.execution_success?
+````
+
 ## Limitations
 
 * Currently only backup is supported. Use Duplicati's command line or GUI utility directly for restoring.

data/lib/duplicati/backup.rb

@@ -21,10 +21,6 @@ class Duplicati
              --usn-policy=auto
              --snapshot-policy=auto
              --full-if-sourcefolder-changed
-             2>&1 1>> "#{@log_path}" &&
-
-             "#{@duplicati_path}" delete-all-but-n 5 "#{@backup_store_path}"
-             --force
              2>&1 1>> "#{@log_path}"]
     end
 

data/lib/duplicati/clean.rb

@@ -0,0 +1,16 @@
+class Duplicati
+  class Clean
+    def initialize(opts)
+      @duplicati_path = opts[:duplicati_path]
+      @backup_store_path = opts[:backup_store_path] or raise ":backup_store_path option is missing for clean!"
+      @log_path = opts[:log_path]
+    end
+
+    def command
+      %Q["#{@duplicati_path}" delete-all-but-n 5 "#{@backup_store_path}"
+             --force
+             2>&1 1>> "#{@log_path}"]
+    end
+
+  end
+end

data/lib/duplicati/version.rb

@@ -1,3 +1,3 @@
 class Duplicati
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/duplicati.rb

@@ -1,5 +1,6 @@
 require File.expand_path("duplicati/version", File.dirname(__FILE__))
 require File.expand_path("duplicati/backup", File.dirname(__FILE__))
+require File.expand_path("duplicati/clean", File.dirname(__FILE__))
 require File.expand_path("duplicati/notification/base", File.dirname(__FILE__))
 require File.expand_path("duplicati/notification/growl", File.dirname(__FILE__))
 require File.expand_path("duplicati/notification/mail", File.dirname(__FILE__))
@@ -8,7 +9,7 @@ class Duplicati
 
   class << self
     def backup(opts={})
-      new(opts).backup
+      new(opts).backup.clean.notify
     end
   end
 
@@ -26,6 +27,7 @@ class Duplicati
     end
 
     @opts = opts
+    @execution_success = true
   end
 
   def backup
@@ -33,6 +35,24 @@ class Duplicati
       options :duplicati_path, :backup_paths, :backup_store_path,
       :backup_encryption_key, :inclusion_filters, :exclusion_filters, :log_path
     ).command
+
+    self
+  end
+
+  def clean
+    execute Clean.new(
+      options :duplicati_path, :backup_store_path, :log_path
+    ).command
+
+    self
+  end
+
+  def notify
+    @opts[:notifications].each do |notification|
+      notification.notify execution_success?
+    end
+
+    self
   end
 
   private
@@ -47,8 +67,6 @@ class Duplicati
     puts formatted_command if $DEBUG
     system(formatted_command)
     @exit_status = $?.exitstatus
-    notify
-    execution_success?
   end
 
   def options(*options_to_extract)
@@ -62,12 +80,6 @@ class Duplicati
     command.gsub($/, "").squeeze(" ")
   end
 
-  def notify
-    @opts[:notifications].each do |notification|
-      notification.notify execution_success?
-    end
-  end
-
   # https://code.google.com/p/duplicati/issues/detail?id=678
   # 0 - Success
   # 1 - Success (but no changed files)
@@ -76,7 +88,7 @@ class Duplicati
   # 100 - No connection to server -> Fatal error
   # 200 - Invalid command/arguments
   def execution_success?
-    @exit_status && @exit_status.between?(0, 2)
+    @execution_success &&= @exit_status && @exit_status.between?(0, 2)
   end
 
 end

data/spec/duplicati/backup_spec.rb

@@ -40,10 +40,6 @@ describe Duplicati::Backup do
              --usn-policy=auto
              --snapshot-policy=auto
              --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
 

data/spec/duplicati/clean_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Duplicati::Clean do
+
+  context "#initialize" do
+    it "raises an Exception if backup store path is not provided" do
+      expect {
+        Duplicati::Clean.new(:backup_paths => [])
+      }.to raise_error(RuntimeError, ":backup_store_path option is missing for clean!")
+    end
+  end
+
+  context "#command" do
+
+    it "generates clean command for Duplicati using different options" do
+      Duplicati::Clean.new(
+        :duplicati_path => "/bin/duplicati-commandline",
+        :backup_store_path => "file:///foo/backup",
+        :log_path => "/zzz/output.log"
+      ).command.should == %Q["/bin/duplicati-commandline" delete-all-but-n 5 "file:///foo/backup"
+             --force
+             2>&1 1>> "/zzz/output.log"]
+    end
+
+  end
+end

data/spec/duplicati_spec.rb

@@ -73,12 +73,12 @@ describe Duplicati do
   end
 
   context "#backup" do
-    it "executes the backup command" do
+    it "executes the backup command and returns self" do
       Duplicati::Backup.any_instance.should_receive(:command).and_return("backup command")
       duplicati = Duplicati.new(:backup_paths => [], :backup_store_path => "")
       duplicati.should_receive(:execute).with("backup command")
 
-      duplicati.backup
+      duplicati.backup.should == duplicati
     end
 
     it "proxies options to backup command" do
@@ -102,11 +102,14 @@ describe Duplicati do
   end
 
   context ".backup" do
-    it "is a convenience method for .new#backup" do
+    it "is a convenience method for .new#backup#clean#notify" do
       Duplicati::Backup.any_instance.should_receive(:command).and_return("backup command")
       Duplicati.any_instance.should_receive(:execute).with("backup command")
+      Duplicati::Clean.any_instance.should_receive(:command).and_return("clean command")
+      Duplicati.any_instance.should_receive(:execute).with("clean command")
+      Duplicati.any_instance.should_receive(:notify)
 
-      Duplicati.backup(:backup_paths => [], :backup_store_path => "")
+      Duplicati.backup(:backup_paths => [], :backup_store_path => "", :notifications => [])
     end
   end
 
@@ -130,7 +133,7 @@ describe Duplicati do
         $?.should_receive(:exitstatus).and_return -1
 
         duplicati = Duplicati.new
-        duplicati.send(:execute, "").should be_false
+        duplicati.send(:execute, "")
         duplicati.should_not be_execution_success
       end
 
@@ -139,7 +142,20 @@ describe Duplicati do
         $?.should_receive(:exitstatus).and_return 3
 
         duplicati = Duplicati.new
-        duplicati.send(:execute, "").should be_false
+        duplicati.send(:execute, "")
+        duplicati.should_not be_execution_success
+      end
+
+      it "is false when one of the commands fail with invalid exit status" do
+        duplicati = Duplicati.new
+        
+        Object.any_instance.should_receive(:system).twice.and_return true
+        $?.should_receive(:exitstatus).and_return 0
+        duplicati.send(:execute, "")
+        duplicati.should be_execution_success
+
+        $?.should_receive(:exitstatus).and_return 3
+        duplicati.send(:execute, "")
         duplicati.should_not be_execution_success
       end
 
@@ -148,7 +164,7 @@ describe Duplicati do
         $?.should_receive(:exitstatus).and_return 0
 
         duplicati = Duplicati.new
-        duplicati.send(:execute, "").should be_true
+        duplicati.send(:execute, "")
         duplicati.should be_execution_success
       end
 
@@ -157,7 +173,7 @@ describe Duplicati do
         $?.should_receive(:exitstatus).and_return 1
 
         duplicati = Duplicati.new
-        duplicati.send(:execute, "").should be_true
+        duplicati.send(:execute, "")
         duplicati.should be_execution_success
       end
 
@@ -166,7 +182,19 @@ describe Duplicati do
         $?.should_receive(:exitstatus).and_return 2
 
         duplicati = Duplicati.new
-        duplicati.send(:execute, "").should be_true
+        duplicati.send(:execute, "")
+        duplicati.should be_execution_success
+      end
+
+      it "is true when all of the commands succeed with success exit status" do
+        duplicati = Duplicati.new
+        
+        Object.any_instance.should_receive(:system).twice.and_return true
+        $?.should_receive(:exitstatus).twice.and_return 0
+        duplicati.send(:execute, "")
+        duplicati.should be_execution_success
+
+        duplicati.send(:execute, "")
         duplicati.should be_execution_success
       end
     end
@@ -176,26 +204,31 @@ describe Duplicati do
         Duplicati.any_instance.unstub(:notify)
       end
 
+      it "returns self" do
+        duplicati = Duplicati.new
+        duplicati.notify.should == duplicati
+      end
+
       it "notifies with all possible notifications with false execution success" do
-        Object.any_instance.stub(:system).and_return false
-        $?.should_receive(:exitstatus).and_return 3
         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, "")
+
+        duplicati = Duplicati.new(:notifications => [notification1, notification2])
+        duplicati.should_receive(:execution_success?).twice.and_return(false)
+        duplicati.notify
       end
 
       it "notifies with all possible notifications with true execution success" do
-        Object.any_instance.stub(:system).and_return true
-        $?.should_receive(:exitstatus).and_return 0
         notification1 = double('notification1').as_null_object
         notification2 = double('notification2').as_null_object
-        
         notification1.should_receive(:notify).with(true)
         notification2.should_receive(:notify).with(true)
-        Duplicati.new(:notifications => [notification1, notification2]).send(:execute, "")
+
+        duplicati = Duplicati.new(:notifications => [notification1, notification2])
+        duplicati.should_receive(:execution_success?).twice.and_return(true)
+        duplicati.notify
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duplicati
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ files:
 - duplicati.gemspec
 - lib/duplicati.rb
 - lib/duplicati/backup.rb
+- lib/duplicati/clean.rb
 - lib/duplicati/notification/base.rb
 - lib/duplicati/notification/failed.png
 - lib/duplicati/notification/growl.rb
@@ -68,6 +69,7 @@ files:
 - lib/duplicati/notification/success.png
 - lib/duplicati/version.rb
 - spec/duplicati/backup_spec.rb
+- spec/duplicati/clean_spec.rb
 - spec/duplicati/notification/growl_spec.rb
 - spec/duplicati/notification/mail_spec.rb
 - spec/duplicati_spec.rb
@@ -86,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -480531571
+      hash: -685447987
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -480531571
+      hash: -685447987
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -105,6 +107,7 @@ summary: Duplicati backup utility wrapper in Ruby with easier API and sensible c
   defaults.
 test_files:
 - spec/duplicati/backup_spec.rb
+- spec/duplicati/clean_spec.rb
 - spec/duplicati/notification/growl_spec.rb
 - spec/duplicati/notification/mail_spec.rb
 - spec/duplicati_spec.rb