guitsaru-rails_backup 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 / 2008-12-01
+
+* First Version

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+README.textile
+Rakefile
+bin/rails_backup
+lib/rails_backup.rb
+test/test_rails_backup.rb
+test/config.yml.erb
+test/sample_rails_project/config/boot.rb
+test/sample_rails_project/config/database.yml
+test/sample_rails_project/config/environment.rb
+test/sample_rails_project/config/environments/mysql.rb
+test/sample_rails_project/config/environments/sqlite3.rb
+test/sample_rails_project/config/initializers/inflections.rb
+test/sample_rails_project/config/initializers/mime_types.rb
+test/sample_rails_project/config/initializers/new_rails_defaults.rb
+test/sample_rails_project/config/locales/en.yml
+test/sample_rails_project/config/routes.rb
+test/sample_rails_project/db/sqlite.sqlite3
+test/sample_rails_project/public/uploads/uploaded_image.png

data/README.textile

@@ -0,0 +1,65 @@
+h1. rails_backup
+
+by Matt Pruitt
+
+http://guitsaru.com
+
+h2. DESCRIPTION:
+
+Automatically backup your rails database and other files to a git repository.
+
+h2. FEATURES/PROBLEMS:
+
+Backs up your rails project's database files and any other files specified in the configuration.
+
+h2. SYNOPSIS:
+
+@rails_backup /var/www/apps/project/config/rails_backup.yml@
+
+h2. INSTALL:
+
+@sudo gem install rails_backup@
+
+h2. Sample Configuration
+
+* The user values are used for the repository's git configuration.
+* root is the root to your rails project.
+* repository is the remote repository to push the backup to.
+* files is a list of other files to backup relative to the root directory.
+
+<pre>
+user:
+  name: User Name
+  email: user@email.com
+root: /var/www/apps/sample_rails_project
+backup_directory: /home/deploy/backup
+repository: git@github.com:user/repo_backup.git
+environment: production
+files:
+  - public/uploads/
+</pre>
+
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Matt Pruitt
+
+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/Rakefile

@@ -0,0 +1,27 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  load 'tasks/setup.rb'
+end
+
+ensure_in_path 'lib'
+require 'rails_backup'
+
+task :default => 'test:run'
+
+PROJ.name = 'rails_backup'
+PROJ.authors = 'Matt Pruitt'
+PROJ.email = 'guitsaru@gmail.com'
+PROJ.url = 'http://github.com/guitsaru/rails_backup'
+PROJ.version = '1.0.0'
+PROJ.summary = "Automatically backup your rails database and other files to a git repository."
+PROJ.rubyforge.name = 'rails-backup'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/rails_backup

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rails_backup'
+
+unless ARGV.first
+  puts "Specify a rails_backup configuration file to use:"
+  puts "rails_backup /path/to/config/file"
+  exit
+end
+
+begin
+  rails_backup = RailsBackup.new(ARGV.first)
+  rails_backup.backup
+rescue Exception => e
+  puts "Backup Failed:"
+  puts e
+end

data/lib/rails_backup.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+require 'ftools'
+
+class RailsBackup
+  def initialize(config_file)
+    @config = YAML.load_file(config_file)
+    @db_config = YAML.load_file(@config['root'] + '/config/database.yml')[@config['environment']]
+  end
+  
+  def backup
+    copy_files
+    git_push
+  end
+  
+  def copy_files
+    # Create Backup Directory if it doesn't exist
+    File.makedirs(@config['backup_directory'])
+    
+    backup_files
+    backup_database
+  end
+  
+  def git_push
+    git_initialize
+    git_add
+    git_push_repository
+  end
+  
+private
+  def backup_files
+    @config['files'].each do |file|
+      source = File.join(@config['root'], file)
+      destination = File.join(@config['backup_directory'], file)
+      File.makedirs(File.dirname(destination))
+      File.copy(source, destination) unless File.directory?(source)
+      
+      if File.directory?(source)
+        File.makedirs(destination)
+        
+        FileUtils.cp_r(source, File.dirname(destination))
+      end
+    end
+  end
+
+  def backup_database
+    if @db_config['adapter'] == 'sqlite3'
+      source = File.join(@config['root'], @db_config['database'])
+      destination = File.join(@config['backup_directory'], @db_config['database'])
+      File.makedirs(File.dirname(destination))
+      File.copy(source, destination)    
+    elsif @db_config['adapter'] == 'mysql'
+      dump_string = "mysqldump -u#{@db_config['username']} "
+      dump_string += "-p#{@db_config['password']} " if @db_config['password']
+      dump_string += "#{@db_config['database']}"
+      
+      destination = File.join(@config['backup_directory'], 'db', "#{@db_config['database']}.sql")
+      File.makedirs(File.dirname(destination))
+      File.open(destination, 'w') { |f| f.write `#{dump_string}` }
+    end
+  end
+
+  def git_initialize
+    system("cd #{@config['backup_directory']} && git init && git config user.name'#{@config['user']['name']}' && git config user.email #{@config['user']['email']}") unless File.exist?(File.join(@config['backup_directory'], '.git'))
+  end
+  
+  def git_add
+    system("cd #{@config['backup_directory']} && git add . && git commit -a -m 'Backing up #{DateTime.now}'")
+  end
+  
+  def git_push_repository
+    system("cd #{@config['backup_directory']} && git push #{@config['repository']} master")
+  end
+end

data/test/config.yml.erb

@@ -0,0 +1,9 @@
+user:
+  name: Matt Pruitt
+  email: guitsaru@gmail.com
+root:   /users/Matt/Documents/Code/Ruby/rails_backup/test/sample_rails_project
+backup_directory: /users/Matt/Documents/Code/Ruby/rails_backup/test/backup
+repository: git@github.com:guitsaru/rails_backup_test.git
+environment: <%= environment %>
+files:
+  - public/uploads/

data/test/sample_rails_project/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/sample_rails_project/config/database.yml

@@ -0,0 +1,12 @@
+sqlite3:
+  adapter: sqlite3
+  database: db/sqlite.sqlite3
+  pool: 5
+  timeout: 5000
+
+mysql:
+  adapter: mysql
+  database: backup
+  user: root
+  host: localhost
+  timeout: 5000

data/test/sample_rails_project/config/environment.rb

@@ -0,0 +1,11 @@
+RAILS_GEM_VERSION = '2.2.2' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.time_zone = 'UTC'
+  config.action_controller.session = {
+    :session_key => '_sample_rails_project_session',
+    :secret      => '0d9bae460dc3317e91927c943076ac6b83eedcd7e968a04bd64f1a5ffe6ea66e848deb1170d61c3b17d5374f194dc8de8f5e9f2b47132ed483a349df2ac3afbb'
+  }
+end

data/test/sample_rails_project/config/environments/mysql.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test/sample_rails_project/config/environments/sqlite3.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test/sample_rails_project/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/sample_rails_project/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/sample_rails_project/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,17 @@
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/test/sample_rails_project/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/sample_rails_project/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/test/test_rails_backup.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require "test/unit"
+require 'context'
+require 'erb'
+
+require File.dirname(__FILE__) + '/../rails_backup'
+
+def load_env(env)
+  template = ERB.new(File.open(File.dirname(__FILE__) + '/config.yml.erb', 'r') { |f| f.read })
+  
+  environment = env
+  File.open(File.dirname(__FILE__) + '/config.yml', 'w') { |f| f.write(template.result(binding)) }
+end
+
+class TestRailsBackup < Test::Unit::TestCase
+  context "mysql" do
+    before do
+      load_env('mysql')
+      @rails_backup = RailsBackup.new(File.dirname(__FILE__) + '/config.yml')
+    end
+    
+    context "copy files" do
+      before do
+        @rails_backup.copy_files
+      end
+
+      should "copy the database file" do
+        assert(File.exist?(File.dirname(__FILE__) + '/backup/db/backup.sql'), "No db file backed up.")
+      end
+
+      should "copy other files" do
+        assert(File.exist?(File.dirname(__FILE__) + '/backup/public/uploads/uploaded_image.png'), "No image backed up.")
+      end
+    end
+  end
+
+  context "sqlite" do
+    before do
+      load_env('sqlite3')
+      @rails_backup = RailsBackup.new(File.dirname(__FILE__) + '/config.yml')
+    end
+
+    context "copy files" do
+      before do
+        @rails_backup.copy_files
+      end
+
+      should "copy the database file" do
+        assert(File.exist?(File.dirname(__FILE__) + '/backup/db/sqlite.sqlite3'), "No db file backed up.")
+      end
+
+      should "copy other files" do
+        assert(File.exist?(File.dirname(__FILE__) + '/backup/public/uploads/uploaded_image.png'), "No image backed up.")
+      end
+    end
+  end
+
+  context "git" do
+    before do
+      load_env('sqlite3')
+      @rails_backup = RailsBackup.new(File.dirname(__FILE__) + '/config.yml')
+      @rails_backup.copy_files
+      @rails_backup.git_push
+    end
+    
+    should "initialize the repository" do
+      assert(File.exist?(File.dirname(__FILE__) + '/backup/.git'), "No git repository found")
+      assert(File.open(File.dirname(__FILE__) + '/backup/.git/config') { |f| f.read } =~ /Matt Pruitt/, "Git repository not configured")
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: guitsaru-rails_backup
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Pruitt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-01 00:00:00 -08:00
+default_executable: rails_backup
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: ""
+email: guitsaru@gmail.com
+executables: 
+- rails_backup
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- bin/rails_backup
+files: 
+- History.txt
+- Manifest.txt
+- README.textile
+- Rakefile
+- bin/rails_backup
+- lib/rails_backup.rb
+- tasks/ann.rake
+- tasks/bones.rake
+- tasks/gem.rake
+- tasks/git.rake
+- tasks/manifest.rake
+- tasks/notes.rake
+- tasks/post_load.rake
+- tasks/rdoc.rake
+- tasks/rubyforge.rake
+- tasks/setup.rb
+- tasks/spec.rake
+- tasks/svn.rake
+- tasks/test.rake
+- test/config.yml.erb
+- test/sample_rails_project/config/boot.rb
+- test/sample_rails_project/config/database.yml
+- test/sample_rails_project/config/environment.rb
+- test/sample_rails_project/config/environments/mysql.rb
+- test/sample_rails_project/config/environments/sqlite3.rb
+- test/sample_rails_project/config/initializers/inflections.rb
+- test/sample_rails_project/config/initializers/mime_types.rb
+- test/sample_rails_project/config/initializers/new_rails_defaults.rb
+- test/sample_rails_project/config/locales/en.yml
+- test/sample_rails_project/config/routes.rb
+- test/sample_rails_project/db/sqlite.sqlite3
+- test/sample_rails_project/public/uploads/uploaded_image.png
+- test/test_rails_backup.rb
+has_rdoc: true
+homepage: http://github.com/guitsaru/rails_backup
+post_install_message: 
+rdoc_options: 
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rails-backup
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Automatically backup your rails database and other files to a git repository.
+test_files: 
+- test/test_rails_backup.rb