first commit

.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.DS_Store

.rspec

@@ -0,0 +1 @@
+--color

.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p327

Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in get_back.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    get_back (0.0.1)
+      rails (~> 3.2.12)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.12)
+      actionpack (= 3.2.12)
+      mail (~> 2.4.4)
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    arel (3.0.2)
+    builder (3.0.4)
+    columnize (0.3.6)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.4)
+    journey (1.0.4)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    linecache19 (0.5.13)
+      ruby_core_source (>= 0.1.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    mysql2 (0.3.11)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.12)
+      actionmailer (= 3.2.12)
+      actionpack (= 3.2.12)
+      activerecord (= 3.2.12)
+      activeresource (= 3.2.12)
+      activesupport (= 3.2.12)
+      bundler (~> 1.0)
+      railties (= 3.2.12)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    ruby-debug-base19 (0.11.26)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.5)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.36)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  get_back!
+  jquery-rails
+  mysql2
+  rspec-rails
+  ruby-debug19

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.

README.rdoc

@@ -0,0 +1,22 @@
+= GetBack
+
+Rails engine with utilities for backup and restore of entire application database.
+Includes rake tasks that may be invoked by cron task to periodically backup the database and send it by email.
+
+Include this in your application Gemfile:
+
+gem 'get_back'
+
+Mount the get_back routes in your config.routes.rb with:
+
+mount GetBack::Engine => '/get_back', :as => 'get_back', and the following routes are added
+    backups_backups GET    /backups/backups(.:format)            backups/backups#index
+                    POST   /backups/backups(.:format)            backups/backups#create
+ new_backups_backup GET    /backups/backups/new(.:format)        backups/backups#new
+edit_backups_backup GET    /backups/backups/:id/edit(.:format)   backups/backups#edit
+     backups_backup GET    /backups/backups/:id(.:format)        backups/backups#show
+                    PUT    /backups/backups/:id(.:format)        backups/backups#update
+                    DELETE /backups/backups/:id(.:format)        backups/backups#destroy
+
+
+An admin page is provided at the url: '/get_back/index'

Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GetBack'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

app/assets/javascripts/get_back/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

app/assets/stylesheets/get_back/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

app/controllers/get_back/application_controller.rb

@@ -0,0 +1,5 @@
+module GetBack
+  class ApplicationController < ::ApplicationController
+    layout 'layouts/application'
+  end
+end

app/controllers/get_back/backups_controller.rb

@@ -0,0 +1,80 @@
+module GetBack
+  class BackupsController < ApplicationController
+    def index
+      @backups = BackupFile.find(:all).sort
+    end
+
+    # creates a new backup file from the database
+    def create
+      backup = BackupFile.new # creates new BackupFile object with current date/time
+      backup.save
+      redirect_to backups_path
+    end
+
+    # restores the selected backup file (denoted by the passed-in param[:id]) to be the active database
+    # the passed-in :id field is not the typical numeric table index but instead has the filename root, like:
+    # "backups_2009-08-16_07-50-26_development_dump"
+    def restore
+      backfile = BackupFile.find(params[:id])
+      if write_db(backfile)
+        flash[:notice] = "Database has been restored to backup version dated:<br/>#{backfile.date}"
+      else
+        flash[:error] ||= "Restore database failed<br/>file was probably corrupted."
+      end
+      redirect_to backups_path
+    end
+
+    def restore_from_upload
+      if params[:upload][:uploaded_file].blank?
+        flash[:error] = "Please click \"Browse\" to select a local database file to upload" # this should never be called, as the detection is now done in javascript at the client. Leave it here for posterity!
+      else
+        backfile = BackupFile.new(:filename=>uploaded_file_path)
+        if write_db(backfile)
+          flash[:notice] = "Database restored from uploaded file<br/>with date #{backfile.date}"
+        else
+          flash[:error] ||= "Database restore failed"
+        end
+      end
+      redirect_to backups_path
+    end
+
+    def destroy
+      backup_file = BackupFile.find(params[:id])
+      if backup_file.destroy
+        flash[:notice] = "Backup file was deleted"
+      else
+        flash[:error] = "Delete backup file failed"
+      end
+      redirect_to backups_path
+    end
+
+    # here "show" is used for REST conformance. Here we download the file instead of displaying it
+    def show
+      backup_file = BackupFile.find(params[:id])
+      send_file backup_file.filename
+    end
+
+    private
+
+    # overwrites the active database with the file passed in
+    def write_db(backfile)
+      if backfile.valid?
+        ApplicationDatabase.restore_from_file(backfile) # returns false if restore fails
+      else
+        flash[:error] = "File name does not have correct format.<br/>Are you sure it's a database backup file?<br/>Database was not restored."
+        false
+      end
+    end
+
+    def uploaded_file_path
+      # TODO should unzip after uploading
+      filename = params[:upload][:uploaded_file].original_filename
+      directory = "tmp/uploads"
+      path = File.join(directory, filename)
+      File.open(path,"wb"){|f| f.write(params[:upload][:uploaded_file].read)}
+      #File.join(RAILS_ROOT,path)
+      Rails.root.join(path)
+    end
+
+  end
+end

app/helpers/get_back/application_helper.rb

@@ -0,0 +1,4 @@
+module GetBack
+  module ApplicationHelper
+  end
+end

app/models/application_database.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+class ApplicationDatabase
+  def initialize
+    @@db_config = ActiveRecord::Base.configurations[Rails.env]
+    @@password = @@db_config['password'].nil? ? '' : "--password=#{@@db_config['password']}"
+  end
+
+  def self.extract_contents
+    new
+    %x[#{@@db_config['path']}mysqldump -u #{@@db_config['username']} #{@@password} --single-transaction -Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE --hex-blob #{@@db_config['database']}]
+  end
+
+  def self.save_to_file(file)
+    # TODO instead of creating a copy of the db in memory and writing to the file,
+    # should try command output redirection (>) in the unix shell directly to the file, in the ApplicationController.extract_contents
+    # method. This might avoid the memory problems that are causing the backups to fail.
+    # see http://blog.craigambrose.com/articles/2007/03/01/a-rake-task-for-database-backups
+    new
+    %x[#{@@db_config['path']}mysqldump -u #{@@db_config['username']} #{@@password} --single-transaction -Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE --hex-blob #{@@db_config['database']} > #{file} ]
+  end
+
+  def self.restore_from_file(backfile)
+    # when it has been tested in production mode, replace the next two lines with new
+    new_back = backfile.filename
+    @db_config = ActiveRecord::Base.configurations["development"]    # TODO hard coded here... MUST CHANGE THIS AFTER TESTING
+    password = @db_config['password'].nil? ? '' : "--password=#{@db_config['password']}"
+    %x[#{@db_config['path']}mysql --database #{@db_config['database']} --host=#{@db_config['host']} --user=#{@db_config['username']} #{password} -e \"source #{new_back}\";]
+    $?.exitstatus.zero?
+  end
+
+end