siba 0.4.4 → 0.5.0

data/LICENSE

@@ -1,7 +1,7 @@
-Copyright (c) 2012 Evgeny Neumerzhitskiy
-
 MIT License
 
+Copyright (c) 2012 Evgeny Neumerzhitskiy
+
 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

data/README.md

@@ -1,15 +1,16 @@
 # Overview
 
+SIBA is a simple backup and restore utility. It implements daily backup rotation scheme. It is most suitable in sutuations when you need to have a history of backups. When run daily, SIBA retains full year history of backups by keeping 23 files in total: for the last 6 days, 5 weeks and 12 months.
 
-SIBA is a simple backup and restore utility. It implements daily backup rotation scheme. It is most suitable in sutuations when you need to have a history of backups and not just the last one. If run daily, SIBA retains full year history of backups by keeping only 23 files: 6 daily, 5 weekly and 12 monthly full backups.
+<img src="http://webdevelopercv.com/images/works/siba.png" width="326" height="326">
 
 ## Main features
 
-* **Ease of use.** Configure, backup and restore with a single command.
-* **Secure.** All backups are encrypted on your computer before reaching backup destination.
-* **Cross platform.** Utility can be run on any computer with Ruby 1.9 or later.
-* **Easy to extend.** Developers can easily add new backup sources, archivers, encryptors and destinations.
-* **Free and open source.** Use SIBA for any purpose without restrictions.
+* **Easy to use:** configure, backup and restore with a single command.
+* **Secure:** all backups are encrypted before moving to destination.
+* **Cross platform:** runs on any computer with Ruby 1.9 or later.
+* **Easy to extend:** developers can easily add new backup sources, archivers, encryptions and destinations.
+* **Free and open source:** use SIBA for any purpose without restrictions.
 
 ## Installation
 
@@ -19,30 +20,54 @@ SIBA is a simple backup and restore utility. It implements daily backup rotation
 
 ## Usage
 
-1. Create a configuration file
+1. Create a configuration file:
 
         $ siba generate mybak
 
-2. Backup
+2. Backup:
 
         $ siba backup mybak
 
-3. Restore
+3. Restore:
 
         $ siba restore mybak
 
-4. Show available plugins
+4. Show available plugins:
 
         $ siba list
 
-5. Create a gem project for a new destination plugin (or for a source, archive, encryption plugin).
+5. Show other commands and options:
+
+        $ siba
+
+6. Create a gem skeleton for a new destination plugin:
 
         $ siba scaffold destination my-cloud
 
-6. Show other commands and options
+Tip: to create other plugin types, replace `destination` with `source`, `archive` or `encryption`.
+
+[Read more about SIBA plugin development](https://github.com/evgenyneu/siba/blob/master/scaffolds/project/README.md)
 
-        $ siba
 
 ## Scheduling backups
 
 It is recommended to run `siba backup` command daily or hourly. Use your favourite scheduler to automate the process: Cron, Scheduled Tasks, iCal etc.
+
+## Supported plugins
+
+### Source
+
+* **Files:** backup local files and directories.
+
+### Archive
+  
+* **Tar:** archive with optional gzip or bzip2 compression.
+
+### Encryption
+  
+* **Gpg:** encrypt with AES256, Blowfish, Twofish, 3DES and other ciphers.
+
+### Destination
+  
+* **Dir:** backup to local directory.
+* **Aws-s3:** upload backup to Amazon S3 storage.

data/lib/siba/console.rb

@@ -62,9 +62,12 @@ Options:"
         end
 
         o.on("--version", "Show version") do
-          show_message "SIBA (SImple BAckup) #{Siba::VERSION}"
+          show_message "SIBA #{Siba::VERSION}"
           return
         end
+
+        o.separator ""
+        o.separator "Homepage: https://github.com/evgenyneu/siba"
       end
 
       if argv.empty? 

data/lib/siba/helpers/file_helper.rb

@@ -10,9 +10,7 @@ module Siba
       end
 
       def dirs_count(dir)
-        entries(dir).count do |a| 
-          siba_file.file_directory? File.join(dir, a)
-        end
+        dirs(dir).size
       end
 
       # Reads a file in UTF-8 encoding
@@ -48,6 +46,20 @@ module Siba
         siba_file.dir_entries(dir) - %w{ . .. }
       end
 
+      # Retuns an array containing names of sub-directories located in the dir 
+      def dirs(dir)
+        entries(dir).select do |entry|
+          siba_file.file_directory?(File.join(dir,entry))
+        end
+      end
+
+      # Retuns an array containing names of files located in the dir 
+      def files(dir)
+        entries(dir).select do |entry|
+          siba_file.file_file?(File.join(dir,entry))
+        end
+      end
+
       # Raises error if dirs are not identical 
       def dirs_same?(dir1, dir2)
         dir1_entries = siba_file.dir_entries dir1

data/lib/siba/plugins/plugins.yml

@@ -1,5 +1,6 @@
 source:
   files: Backup local files and directories
+  mongo-db: Backup and restore MongoDB
 archive:
   tar: Archive with optional gzip or bzip2 compression
 encryption:

data/lib/siba/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Siba
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/scaffolds/project/LICENSE

@@ -1,7 +1,7 @@
-Copyright (c) <year> <name>
-
 MIT License
 
+Copyright (c) <year> <name>
+
 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

data/scaffolds/project/README.md

@@ -1,6 +1,6 @@
 # Developing a SIBA plugin
 
-Follow four simple steps to develop a SIBA extension plugin.
+Follow the four simple steps to develop a SIBA extension plugin.
 
 ## 1. Generate project skeleton
 
@@ -8,11 +8,11 @@ Generate an empty project for a plugin gem:
 
         $ siba scaffold CATEGORY plugin-name
 
-where CATEGORY can be: source, archive, encryption or destination. 
+where CATEGORY can be: source, archive, encryption or destination.
 
 ## 2. Change `init.rb` file
 
-After the project is generated, add your code to init.rb file located in lib/your-plugin-dir. It already has all necessay methods with instructions and examples.
+After the project is generated, add your code to `init.rb` file located in `lib/your-plugin-dir`. It already has all necessary methods with instructions and examples.
 
 ## 3. Change `options.yml`
 
@@ -20,14 +20,25 @@ Add your plugin options to `options.yml`. It is located in the same directory as
 
 ## 4. Publish
 
-Publish your plugin gem. If you want your plugin to be shown to users by `siba list` and `siba generate` commands, please add its description to /lib/siba/plugins/plugins.yml file in SIBA project on github and issue a pull request.
+Publish your plugin gem. If you want your plugin to be shown to users by `siba list` and `siba generate` commands, add its description to /lib/siba/plugins/plugins.yml file in [siba github project](https://github.com/evgenyneu/siba) and send a pull request.
+
 
 ## Testing
 
-The project contains test files with examples. Two types of tests are used: unit and integration. In unit tests file system, shell and other time consuming operations are not performed.
+The project generated with `siba scaffold` command contains test files with examples. Two types of tests are used: unit and integration. In unit tests file system, shell and other time consuming operations are not performed.
+
+First, make sure you have bundler installed:
+
+        $ gem install bundler
+
+Then, `cd` to the project directory and install all dependencies:
+
+        $ bundle install
+
+Finally, run unit tests:
+
+        $ rake
 
-To run unit tests:
-        rake
+And integration tests:
 
-To run integration tests
-        rake test:i9n
+        $ rake test:i9n

data/scaffolds/project/siba-c6y-demo.gemspec

@@ -8,11 +8,10 @@ Gem::Specification.new do |s|
   s.authors     = ["TODO: Write your name"]
   s.email       = ["TOD0: your@email.com"]
   s.homepage    = ""
+  s.license     = "MIT"
   s.summary     = %q{TODO: Write a gem summary}
   s.description = %q{TODO: Write a gem description}
 
-  s.rubyforge_project = "siba-c6y-demo"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/siba.gemspec

@@ -8,8 +8,9 @@ Gem::Specification.new do |s|
   s.authors     = ["Evgeny Neumerzhitskiy"]
   s.email       = ["sausageskin@gmail.com"]
   s.homepage    = "https://github.com/evgenyneu/siba"
+  s.license     = "MIT"
   s.summary     = %q{Simple backup and restore utility.}
-  s.description = %q{SIBA is a backup and restore utility. It implements backup rotation scheme. It retains full year history of backups by keeping only 23 files: 6 daily, 5 weekly and 12 monthly backups. Backups are compressed and encrypted. Various backup sources and destinations can be added through extension gems.}
+  s.description = %q{SIBA is a backup and restore utility. It implements daily backup rotation scheme. It retains full year history of backups by keeping 23 files in total: for the last 6 days, 5 weeks and 12 months. Backups are archived and encrypted. Various backup sources and destinations can be added through extension gems.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/integration/helpers/i9n_file_helper.rb

@@ -22,6 +22,28 @@ describe Siba::FileHelper do
     entries.wont_be_empty
     entries.must_equal entries_to_compare
   end
+  
+  it "should call dirs" do
+    test_dir = prepare_test_dir "dir-not-empty"
+    entries = @obj.dirs test_dir
+    entries.wont_be_empty
+    dirs_to_compare = @obj.entries(test_dir).select {|a| File.directory?(File.join(test_dir, a))}
+    entries.size.must_equal dirs_to_compare.size
+    entries.each do |a|
+      dirs_to_compare.must_include a
+    end
+  end
+
+  it "should call files" do
+    test_dir = prepare_test_dir "dir-not-empty"
+    entries = @obj.files test_dir
+    entries.wont_be_empty
+    files_to_compare = @obj.entries(test_dir).select {|a| File.file?(File.join(test_dir, a))}
+    entries.size.must_equal files_to_compare.size
+    entries.each do |a|
+      files_to_compare.must_include a
+    end
+  end
 
   it "should call dirs_count" do
     test_dir = prepare_test_dir "dir-not-empty"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: siba
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &85332600 !ruby/object:Gem::Requirement
+  requirement: &83691080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *85332600
+  version_requirements: *83691080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &85332150 !ruby/object:Gem::Requirement
+  requirement: &83690410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *85332150
+  version_requirements: *83690410
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &85331650 !ruby/object:Gem::Requirement
+  requirement: &83689690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,11 +43,11 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *85331650
-description: ! 'SIBA is a backup and restore utility. It implements backup rotation
-  scheme. It retains full year history of backups by keeping only 23 files: 6 daily,
-  5 weekly and 12 monthly backups. Backups are compressed and encrypted. Various backup
-  sources and destinations can be added through extension gems.'
+  version_requirements: *83689690
+description: ! 'SIBA is a backup and restore utility. It implements daily backup rotation
+  scheme. It retains full year history of backups by keeping 23 files in total: for
+  the last 6 days, 5 weeks and 12 months. Backups are archived and encrypted. Various
+  backup sources and destinations can be added through extension gems.'
 email:
 - sausageskin@gmail.com
 executables:
@@ -214,7 +214,8 @@ files:
 - test/unit/yml/siba_options_backup.yml
 - test/unit/yml/valid.yml
 homepage: https://github.com/evgenyneu/siba
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: