duplicati 0.0.4 → 0.0.5

data/README.md

@@ -6,6 +6,9 @@ This gem is a [Duplicati](http://duplicati.com) backup utility wrapper written i
 
 ## Installation
 
+1. Install [Duplicati](http://duplicati.com) itself.
+2. Install Duplicati gem.
+
 Add this line to your application's Gemfile:
 
     gem 'duplicati'
@@ -20,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-````
+````ruby
 require "duplicati"
 
 Duplicati.backup(
@@ -32,9 +35,110 @@ Duplicati.backup(
 
 Refer to [Duplicati documentation](http://duplicati.com/howtos) for different backup store locations.
 
+## Filters
+
+Duplicati allows to specify inclusion and exclusion filters when it comes to backups, restoring and so on.
+
+It has [quite complex filtering API](https://code.google.com/p/duplicati/wiki/FilterUsage), which this gem tries to simplify.
+
+To include only .txt files, you need to write this:
+
+````ruby
+Duplicati.backup(:inclusion_filter => /.*\.txt$/)
+````
+
+Globs are also supported:
+````ruby
+Duplicati.backup(:inclusion_filter => "*.mp3")
+````
+
+It is also possible to have multiple filters:
+````ruby
+Duplicati.backup(:inclusion_filters => [/.*\.txt$/, "*.mp3"])
+````
+
+Exclusion filters work similarly:
+````ruby
+Duplicati.backup(:exclusion_filter => "*.exe")
+````
+
+## Notifications
+
+Duplicati gem supports currently two different notifications.
+
+### Growl
+
+Growl notifications are enabled by default if not specified otherwise.
+
+For these to work you need to install [Growl](http://growl.info/) or [Growl for Windows](http://www.growlforwindows.com) and
+a [ruby_gntp](https://github.com/snaka/ruby_gntp) gem.
+
+You can enable Growl notifications manually by specifying ````:notifications```` option like this:
+
+````ruby
+Duplicati.backup(
+  :notifications => [Duplicati::Notification::Growl.new],
+  # other options
+)
+````
+
+### E-mail
+
+To use e-mail notifications, you need to install [mail](https://github.com/mikel/mail) gem.
+
+After that you need to specify ````:notifications```` option like this:
+
+````ruby
+Duplicati.backup(
+  :notifications => [
+    Duplicati::Notification::Mail.new(
+      :to => "recipient@example.com",
+      :smtp_config => { :domain => "example.com", :address => "mail.example.com" }
+    )
+  ],
+  # other options
+)
+````
+
+
+### Multiple notifications
+
+You can use multiple notifications together by specifying them in the ````:notifications```` option array:
+
+````ruby
+Duplicati.backup(:notifications => [NotificationClass1.new, NotificationClass2.new, ...])
+````
+
+### Disabling notifications
+
+To disable all notifications, you need to pass an empty array to ````:notifications```` option:
+
+````ruby
+Duplicati.backup(:notifications => [])
+````
+
+### Others
+
+It is really easy to add new notification types by just implementing one class with single method called ````#notify````.
+
+This method takes a single boolean argument called ````success```` which will be true if the Duplicati command succeeded
+and false otherwise. For example:
+
+````ruby
+class CustomNotification
+  def notify(success)
+    if success
+      # notify with success message
+    else
+      # notify with failure message
+    end
+  end
+end
+````
+
 ## Limitations
 
-* Currently only backup is supported. Use command line or GUI utility directly for restoring.
+* Currently only backup is supported. Use Duplicati's command line or GUI utility directly for restoring.
 * You need to start Ruby with administrative privileges under Windows to backup files in use.
 
 ## Contributing

data/lib/duplicati/notification/base.rb

@@ -0,0 +1,13 @@
+class Duplicati
+  module Notification
+    class Base
+      def load_gem(name)
+        require name
+        true
+      rescue LoadError
+        Kernel.warn "#{name} gem is not installed, which is needed for #{self.class.name}!"
+        false
+      end
+    end
+  end
+end

data/lib/duplicati/notification/growl.rb

@@ -1,35 +1,23 @@
 class Duplicati
   module Notification
-    class Growl
-      class << self
-        def notify(success)
-          return unless load_gem
+    class Growl < Base
+      def notify(success)
+        return unless load_gem "ruby_gntp"
 
-          growl = GNTP.new("Backup")
-          growl.register(:notifications => [{
-            :name     => "backup-notify",
-            :enabled  => true,
-          }])
+        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
+        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
     end
   end

data/lib/duplicati/notification/mail.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__))  + "/base"
+
+class Duplicati
+  module Notification
+    class Mail < Base
+      def initialize(opts={})
+        @smtp_config = {:port => 25, :openssl_verify_mode => "none"}.merge(opts[:smtp_config] || {})
+        @to = opts[:to]
+      end
+
+      def notify(success)
+        return unless load_gem "mail"
+
+        smtp_config = @smtp_config
+        to_address = @to
+
+        ::Mail.deliver do
+          delivery_method :smtp, smtp_config
+
+          to to_address
+          from "backup@duplicati.com"
+          subject "#{`hostname`.strip} - Backup #{success ? "Succeeded" : "Failed"}!"
+          body "#{Time.now} - backup #{success ? "succeeded" : "failed"}!"
+        end
+      rescue => e
+        Kernel.warn "Failed to notify via Mail: #{e.message}"      
+      end
+    end
+  end
+end
+

data/lib/duplicati/version.rb

@@ -1,3 +1,3 @@
 class Duplicati
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/duplicati.rb

@@ -1,6 +1,8 @@
 require File.expand_path("duplicati/version", File.dirname(__FILE__))
 require File.expand_path("duplicati/backup", 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__))
 
 class Duplicati
 
@@ -15,7 +17,7 @@ class Duplicati
   def initialize(opts={})
     opts[:log_path] ||= "duplicati.log"
     opts[:duplicati_path] = duplicati_path(opts[:duplicati_path])
-    opts[:notifications] ||= [Notification::Growl]
+    opts[:notifications] ||= [Notification::Growl.new]
     opts[:inclusion_filters] ||= [opts[:inclusion_filter]].compact
     opts[:exclusion_filters] ||= [opts[:exclusion_filter]].compact
 

data/spec/duplicati/notification/growl_spec.rb

@@ -8,7 +8,7 @@ describe Duplicati::Notification::Growl do
     GNTP = double('gntp').as_null_object unless defined?(GNTP) && GNTP.null_object?
   end
 
-  let(:growl) { subject.class }
+  let(:growl) { subject }
 
   it "notifies with success message" do
     GNTP.should_receive(:notify).with notification_args("Backup successfully finished!", "success.png")
@@ -21,7 +21,7 @@ describe Duplicati::Notification::Growl do
   end
 
   it "does not blow up when ruby_gntp gem is not installed" do
-    Object.any_instance.unstub(:require)
+    Object.any_instance.stub(:require).with("ruby_gntp") { raise LoadError }
     GNTP.should_not_receive(:notify)
 
     expect {

data/spec/duplicati/notification/mail_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Duplicati::Notification::Mail do
+
+  before do
+    Kernel.stub(:warn)
+    Object.any_instance.stub(:require).with("mail")
+    ::Mail = double('mail').as_null_object unless defined?(::Mail) && ::Mail.null_object?
+  end
+
+  let(:mail) { Duplicati::Notification::Mail.new(:to => "foo@example.com", :smtp_config => {:domain => "example.com", :port => 26})}
+  let(:smtp_config) { {:port => 26, :openssl_verify_mode => "none", :domain => "example.com"} }
+
+  it "notifies with message" do
+    ::Mail.should_receive(:deliver)
+    mail.notify(true)
+  end
+
+  it "does not blow up when mail gem is not installed" do
+    Object.any_instance.stub(:require).with("mail") { raise LoadError }
+    ::Mail.should_not_receive(:deliver)
+
+    expect {
+      mail.notify(false)
+    }.to_not raise_error
+  end
+
+  it "does not blow up when notifying fails" do
+    ::Mail.stub(:deliver) { raise "foo" }
+
+    expect {
+      mail.notify(false)
+    }.to_not raise_error
+  end
+
+end

data/spec/duplicati_spec.rb

@@ -29,7 +29,9 @@ describe Duplicati do
     end
 
     it "has default notifications" do
-      Duplicati.new.opts[:notifications].should == [Duplicati::Notification::Growl]
+      notifications = Duplicati.new.opts[:notifications]
+      notifications.size.should == 1
+      notifications.first.should be_kind_of(Duplicati::Notification::Growl)
     end
 
     it "allows to specify notifications" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duplicati
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-30 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,12 +61,15 @@ files:
 - duplicati.gemspec
 - lib/duplicati.rb
 - lib/duplicati/backup.rb
+- lib/duplicati/notification/base.rb
 - lib/duplicati/notification/failed.png
 - lib/duplicati/notification/growl.rb
+- lib/duplicati/notification/mail.rb
 - lib/duplicati/notification/success.png
 - lib/duplicati/version.rb
 - spec/duplicati/backup_spec.rb
 - spec/duplicati/notification/growl_spec.rb
+- spec/duplicati/notification/mail_spec.rb
 - spec/duplicati_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jarmo/duplicati-rb
@@ -81,18 +84,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -687412045
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -687412045
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -103,5 +100,7 @@ summary: Duplicati backup utility wrapper in Ruby with easier API and sensible c
 test_files:
 - spec/duplicati/backup_spec.rb
 - spec/duplicati/notification/growl_spec.rb
+- spec/duplicati/notification/mail_spec.rb
 - spec/duplicati_spec.rb
 - spec/spec_helper.rb
+has_rdoc: