selbackup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dedce289864dd69d16c75eadaf37e8c93c68b85
+  data.tar.gz: 2dbe40fcf8cfed04800806f986716df513097043
+SHA512:
+  metadata.gz: 46a1950613a07676a523cd897a714e64a8a034eecb298702d7bc8b1c50d7fb1dd64ee49b6b6265f413b43bf218bc73fb73c54e33f3ba3da7defc3efbb1e42fdb
+  data.tar.gz: 69ac7b8b16af1bcd1b7a046b95af2e11fdac066e2d6af80ddc3747185e9588cacb1ff43b581482370cc14c4423e7b70ef3fbfaaee19f78cf732788b4b7bc6f5e

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'active_support'
+gem 'fog'
+gem 'i18n'
+gem 'rake'
+
+group :development do
+  gem 'rspec'
+  gem 'rspec-mocks'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    excon (0.23.0)
+    fog (1.12.1)
+      builder
+      excon (~> 0.23.0)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5.0)
+      ruby-hmac
+    formatador (0.2.4)
+    i18n (0.6.4)
+    mime-types (1.23)
+    multi_json (1.7.7)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.8)
+    nokogiri (1.5.10)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    ruby-hmac (0.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  fog
+  i18n
+  rake
+  rspec
+  rspec-mocks

data/LICENSE

@@ -0,0 +1,14 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+ 
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+ 
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+ 
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ 
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
+ 

data/README.fr.md

@@ -0,0 +1,82 @@
+# SelBackup
+
+Selbackup permet d'uploader facilement des fichiers sur un serveur Amazon S3.
+Selbackup permet également d'avoir un backup d'un même fichier sur une durée personnalisable, sans surcharger le serveur.
+
+## Installation
+
+Installation
+```
+gem install specific_install
+gem specific_install -l https://github.com/Selectra-Dev/selbackup.git
+```
+
+votre_fichier.rb
+```
+require 'selbackup'
+```
+
+## Utilisation
+
+```
+selbackup = SelBackup.new('key', 'secret', 'bucket', 'region')
+selbackup.upload_file(VotreFichier, nb_jour, nb_semaine, nb_mois)
+```
+Key, secret et bucket sont vos identifiants de connection à votre server Amazon S3.
+nb_jour, nb_semaine et nb_mois permet de choisir le nombre de fichier quotidiens, hebdomadaires et mensuels à garder. Ces paramètres sont optionnels et fixés respectivement à 7, 4 et 3 par défaut.
+
+## Backup Rotation System
+
+Il vous est possible d'uploader de nombreux type de fichiers, la syntaxe de nommage de fichier recommandée étant: `AAAA-MM-JJ-nom_du_fichier.extension`
+Il est cependant possible de ne pas renseigner de date (la date du jour sera automatiquement rajoutée), ou d'extension.
+A noter que si le fichier à uploader ne contient qu'une date (par exemple, '2013-01-01' ou '2013-01-01.tgz'), une erreur sera retournée et l'upload n'aura pas lieu.
+
+SelBackup doit être utilisé chaque jour pour une efficacité optimale.
+Il garde 'nb_jours' versions quotidiennes, 'nb_semaine' versions hebdomadaires et 'nb_mois' versions mensuelles d'un même fichier 
+
+Ainsi, la rotation des fichiers se fait de cette manière:
+  - Chaque jour, un fichier est upload
+  - Chaque jour, la plus ancienne version quotidienne est supprimée s'il y a plus de nb_jours fichiers quotidiens
+  - Chaque semaine, la plus ancienne version quotidienne devient une version hebdomadaire
+  - Chaque semaine, la plus ancienne version hebdomadaire est est supprimée s'il y a plus de nb_semaine fichiers hebdomadaires.
+  - Chaque mois, la plus ancienne version hebdomadaire devient une version mensuelle
+  - Chaque mois, la plus ancienne version mensuelle est supprimée s'il y a plus de nb_mois fichiers mensuels.
+
+Avec les paramètres par défaut, pour un fichier "file1.tgz", l'arborescence de votre serveur S3 ressemblera donc à:
+```
+  bucket/
+    file1.tgz/
+      2013-01-01-monthly-file1.tgz   # 3 dernières versions mensuelles
+      2013-02-01-monthly-file1.tgz
+      2013-03-01-monthly-file1.tgz
+      2013-03-08-weekly-file1.tgz    # 4 dernières versions hebdomadaires
+      2013-03-15-weekly-file1.tgz
+      2013-03-22-weekly-file1.tgz
+      2013-03-29-weekly-file1.tgz
+      2013-04-05-daily-file1.tgz     # 7 dernières versions journalières
+      2013-04-06-daily-file1.tgz
+      2013-04-07-daily-file1.tgz
+      2013-04-08-daily-file1.tgz
+      2013-04-09-daily-file1.tgz
+
+    file2.tgz/
+      [...]
+    [...]
+```
+
+
+## Auteur
+
+Simon Ninon pour Selectra SARL aka [Cylix](https://github.com/Cylix)
+  
+## License
+
+Nous utilisons la [Licence WTF](LICENSE)
+
+## Contribuer
+
+1. Forkez
+2. Créez votre branche (`git checkout -b ma-branche`)
+3. Commit vos changements (`git commit -am 'Nouvelles features'`)
+4. Push (`git push origin ma-branche`)
+5. Faîtes une `Pull request`

data/README.md

@@ -0,0 +1,83 @@
+# SelBackup
+
+Selbackup allows user to upload easily some files on an Amazon S3 server.
+It also integrates a "Rotation backup system", which is very useful to get a backup of a file during a selected period (without it overcharges the server)
+
+## Installation
+
+Installation
+```
+gem install specific_install
+gem specific_install -l https://github.com/Selectra-Dev/selbackup.git
+```
+
+your_file.rb
+```
+require 'selbackup'
+```
+
+## Usage
+
+```
+selbackup = SelBackup.new('key', 'secret', 'bucket', 'region')
+selbackup.upload_file(VotreFichier, nb_day, nb_week, nb_month)
+```
+Key, secret et bucket are your Amazon S3 logins.
+nb_day, nb_week and nb_month allow user to choose the number of daily, weekly and monthly files to keep on the server. These parameters are optionnal and are set, by default, to 7, 4 and 3.
+
+## Backup Rotation System
+
+You can upload a lot of different files.
+Recommended naming convention is: `YYYY-MM-DD-filename.extension`, but you can upload files named differently.
+For example, you can upload a file without date (today's date will be set by default), or a file without extension.
+However, note that trying to upload a file whose name contains only a date (like '2013-01-01' or '2013-01-01.tgz') will return an error and the upload won't happened.
+
+Selbackup should be used every day to maximize performance.
+It keeps 'nb_day' daily versions, 'nb_week' weekly_version and 'nb_month' monthly version of a same file.
+
+Thus, the files rotation will proceed like this:
+  - Each day, a file is upload
+  - Each day, the latest daily version is removed if there are more than 'nb_days' daily file versions
+  - Each week, the latest daily version upgrades to weekly version.
+  - Each week, the latest weekly version is removed if there are more than 'nb_week' weekly file versions
+  - Each month, the latest weekly version upgrades to monthly version
+  - Each month, the latest monthly version is removed if there are more than 'nb_month' monthly file versions
+
+With default parameters, for a "file1.tgz" file, the tree server will looks like the following scheme
+```
+  bucket/
+    file1.tgz/
+      2013-01-01-monthly-file1.tgz   # 3 last monthly versions
+      2013-02-01-monthly-file1.tgz
+      2013-03-01-monthly-file1.tgz
+      2013-03-08-weekly-file1.tgz    # 4 last weekly versions
+      2013-03-15-weekly-file1.tgz
+      2013-03-22-weekly-file1.tgz
+      2013-03-29-weekly-file1.tgz
+      2013-04-05-daily-file1.tgz     # 7 last daily versions
+      2013-04-06-daily-file1.tgz
+      2013-04-07-daily-file1.tgz
+      2013-04-08-daily-file1.tgz
+      2013-04-09-daily-file1.tgz
+
+    file2.tgz/
+      [...]
+    [...]
+```
+
+
+## Author
+
+Simon Ninon for Selectra SARL aka [Cylix](https://github.com/Cylix)
+  
+## License
+
+We are using [WTF License](LICENSE)
+
+## Contribute
+
+1. Fork
+2. Create your branch (`git checkout -b my-branch`)
+3. Commit your new features (`git commit -am 'New features'`)
+4. Push (`git push origin my-branch`)
+5. Make a `Pull request`

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rspec/core/rake_task'
+require './lib/selbackup.rb'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :test_upload do
+  if ENV["key"] && ENV["secret"] && ENV["bucket"]
+    key = ENV["key"]
+    secret = ENV["secret"]
+    bucket = ENV["bucket"]
+
+    `mkdir upload_test/tmp`
+    `bash upload_test/create_files.sh`
+    sb = SelBackup.new(key, secret, bucket)
+    files = Dir.glob("upload_test/tmp/*")
+    files.each do | file |
+      puts "Uploading: #{file}"
+      sb.upload_file(file)
+      `rm #{file}`
+    end
+  else
+    puts "Usage: rake test_upload key='...' secret='...' bucket='...'"
+  end
+end

data/doc/classes/Object.html

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Object</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
+<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+
+<body>     
+    <div class="banner">
+        
+        <h1>
+            <span class="type">Class</span> 
+            Object 
+            
+                <span class="parent">&lt; 
+                    
+                    BasicObject
+                    
+                </span>
+            
+        </h1>
+        <ul class="files">
+            
+            <li><a href="../files/backup-to-s3_rb.html">backup-to-s3.rb</a></li>
+            
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+  
+
+
+  
+
+
+  
+  
+
+
+  
+
+
+  
+
+  
+
+
+
+  
+
+    
+
+    
+
+    
+      <!-- Section constants -->
+      <div class="sectiontitle">Constants</div>
+      <table border='0' cellpadding='5'>
+        
+          <tr valign='top'>
+            <td class="attr-name">BACKUP_DIR</td>
+            <td>=</td>
+            <td class="attr-value">&#39;test/&#39;</td>
+          </tr>
+          
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"><p>Le principe des sauvegardes est le suivant : Sauvegarde régulière des bases
+de données et des sites dans /home/backups. Lancement régulier de ce
+programme pour pousser les fichiers dans S3 Il ne peux y avoir qu’une seule
+instance a un moment donné</p></td>
+            </tr>
+          
+        
+          <tr valign='top'>
+            <td class="attr-name">CMD_PS_AX</td>
+            <td>=</td>
+            <td class="attr-value">&quot;ps ax | grep &#39;PID&#39; | grep -v grep | awk &#39;{print $1}&#39; | xargs&quot;</td>
+          </tr>
+          
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"></td>
+            </tr>
+          
+        
+          <tr valign='top'>
+            <td class="attr-name">PID_FILE</td>
+            <td>=</td>
+            <td class="attr-value">&#39;/var/run/backup-selectra.pid&#39;</td>
+          </tr>
+          
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"></td>
+            </tr>
+          
+        
+      </table>
+    
+
+
+    
+
+
+    <!-- Methods -->
+              </div>
+
+    </div>
+  </body>
+</html>