rails_simple_backup_restore 0.0.1

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_simple_backup_restore.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Witrant
+
+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,96 @@
+# RailsSimpleBackupRestore
+
+A simple backup/restore gem for Rails.
+
+How it works:
+
+`SimpleBackup.backup`:
+
+* the database is dumped to `db/data.yml` with [yaml_db](http://rubygems.org/gems/yaml_db)
+* a temporary zip file is created with:
+  * `config/backup_version`
+  * `db/data.yml`
+  * all files listed in `config/backup_files` (each line being expanded with `Dir[line_of_backup_files]`)
+* the temporary file object is returned (it may already have been removed from disk, but you can `#read` it)
+
+`SimpleBackup.restore(file)`:
+
+* check that the file is a ZIP and contains the same `config/backup_version`
+* delete all files listed in `config/backup_files` (each line being expanded with `Dir[line_of_backup_files]`)
+* extract all files included in the ZIP file
+* load the database dump
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_simple_backup_restore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_simple_backup_restore
+
+## Usage
+
+Create a file config/backup_version with, for example :
+
+    my rails app backup v1
+
+Create a file config/backup_files with, for example :
+
+    public/system/**/*
+
+In your controller:
+
+    def backup
+      send_data SimpleBackup.backup.read, :filename => "Backup.zip"
+    end
+
+    def restore
+      if params[:file]
+        @done = true
+        begin
+          SimpleBackup.restore(params[:file])
+          @success = true
+        rescue => e
+          @error = e.message
+        end
+      end
+    end
+
+In the restore view (haml syntax, twitter bootstrap style):
+
+    - if @done
+      - if @success
+        .alert.alert-block.alert-success
+          %p
+            %strong Restauration done!
+      - else
+        .alert.alert-block.alert-error
+          %p
+            %strong= "An error occured during restore"
+          %p
+            = @error
+
+    = form_tag restore_path, :class => "form-horizontal", :multipart => true do
+      %fieldset
+        %legend Restore
+        .control-group
+          = label_tag :file, "Backup file", :class => "control-label"
+          .controls
+            = file_field_tag :file, :class => "input-file"
+        .form-actions
+          = submit_tag "Restore backup", :class => "btn btn-primary"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rails_simple_backup_restore.rb

@@ -0,0 +1,7 @@
+require "rails_simple_backup_restore/version"
+
+module RailsSimpleBackupRestore
+  class Engine < Rails::Engine
+    config.autoload_paths << File.expand_path("../rails_simple_backup_restore", __FILE__)
+  end
+end

data/lib/rails_simple_backup_restore/simple_backup.rb

@@ -0,0 +1,72 @@
+module SimpleBackup
+  def self.init
+    require 'tmpdir'
+    require 'zip/zip'
+    require 'yaml_db'
+  end
+  
+  def self.current_backup_files
+    files = []
+    backup_files_path = Rails.root.join("config", "backup_files")
+    if backup_files_path.exist?
+      backup_files_path.each_line do |line|
+        Dir[line.strip].each do |path|
+          next if File.directory?(path)
+          files << path
+        end
+      end
+    end
+    files
+  end
+  
+  def self.db_dump_path
+    "db/data.yml"
+  end
+  
+  def self.backup
+    init
+    
+    input_filenames = ["config/backup_version"]
+    
+    SerializationHelper::Base.new(YamlDb::Helper).dump db_dump_path
+    
+    input_filenames << db_dump_path
+    
+    input_filenames += current_backup_files
+    
+    zip = nil
+    Dir.mktmpdir 'simple_backup' do |dir|
+      zip_path = File.join(dir, "backup.zip")
+      Zip::ZipFile.open(zip_path, Zip::ZipFile::CREATE) do |zipfile|
+        input_filenames.each do |filename|
+          zipfile.add(filename, Rails.root.join(filename))
+        end
+      end
+      zip = File.open(zip_path, 'r')
+    end
+    zip
+  end
+  
+  def self.restore(file)
+    init
+    
+    Dir.mktmpdir 'simple_restore' do |dir|
+      Zip::ZipFile.open(file.path) do |zip|
+        version = zip.find_entry "config/backup_version"
+        raise "Invalid a backup file" unless version
+        current_version = File.read("config/backup_version")
+        raise "Backup version mismatch" if current_version != zip.read("config/backup_version")
+        
+        current_backup_files.each do |file|
+          File.delete(file)
+        end
+        
+        zip.each do |entry|
+          File.open(entry.name, "wb") { |f| f.write entry.get_input_stream.read }
+        end
+        
+        SerializationHelper::Base.new(YamlDb::Helper).load db_dump_path
+      end
+    end
+  end
+end

data/lib/rails_simple_backup_restore/version.rb

@@ -0,0 +1,3 @@
+module RailsSimpleBackupRestore
+  VERSION = "0.0.1"
+end

data/rails_simple_backup_restore.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_simple_backup_restore/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ouvrages"]
+  gem.email         = ["contact@ouvrages-web.fr"]
+  gem.description   = %q{A simple backup/restore gem for Rails}
+  gem.summary       = %q{Backup the database and custom paths into a single file and allow restore}
+  gem.homepage      = ""
+
+  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.name          = "rails_simple_backup_restore"
+  gem.require_paths = ["lib"]
+  gem.version       = RailsSimpleBackupRestore::VERSION
+  gem.add_dependency 'yaml_db'
+  gem.add_dependency 'rails', '>= 3.0'
+  gem.add_dependency 'rubyzip'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rails_simple_backup_restore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ouvrages
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaml_db
+  requirement: &88584140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *88584140
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &88583870 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *88583870
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &88583620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *88583620
+description: A simple backup/restore gem for Rails
+email:
+- contact@ouvrages-web.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_simple_backup_restore.rb
+- lib/rails_simple_backup_restore/simple_backup.rb
+- lib/rails_simple_backup_restore/version.rb
+- rails_simple_backup_restore.gemspec
+homepage: ''
+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.11
+signing_key: 
+specification_version: 3
+summary: Backup the database and custom paths into a single file and allow restore
+test_files: []