liquid_backup 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Williams
+
+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,17 @@
+# liquid_backup
+
+Backup Library used on our servers
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Liquid Media. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "liquid_backup"
+    gem.summary = %Q{Backup your application server}
+    gem.description = %Q{Backup your application server}
+    gem.email = "os@liquidmedia.ca"
+    gem.homepage = "http://github.com/liquidmedia/liquid_backup"
+    gem.authors = ["Dan Williams"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+task :backup do
+  require 'lib/backup'
+  
+  p Backup::Manager
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/backup.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'singleton'
+require 'date'
+
+module Backup
+  KEEP = 7
+end
+
+$: << File.join(File.dirname(__FILE__),'backup')
+
+require 'job'
+require 'manager'
+
+
+Dir.glob(File.join(File.dirname(__FILE__),'backup','handler','*.rb')).each{|h| require h}

data/lib/backup/handler/s3.rb

@@ -0,0 +1,25 @@
+require 'aws/s3'
+
+module Backup
+  module Handler
+    class S3
+      def initialize(options={})
+        AWS::S3::Base.establish_connection!(:access_key_id => options[:access_key_id], :secret_access_key => options[:secret_access_key])
+      end
+      
+      def store(location, files = [])
+        return false unless files.any?
+        
+        AWS::S3::Bucket.create(location) 
+        
+        files.each do |file|
+          AWS::S3::S3Object.store("#{File.mtime(file).strftime("%Y%m%d%H%M%S")}_#{File.split(file)[-1]}", File.open(file), location)
+        end
+      end
+  
+      def cleanup
+    
+      end
+    end
+  end
+end

data/lib/backup/job.rb

@@ -0,0 +1,111 @@
+class Backup::Job
+  attr_accessor :script_path
+  attr_accessor :application_directory
+  attr_accessor :backups_path
+  attr_accessor :current_backup_path
+  attr_accessor :previous_backups_path
+  
+  attr_accessor :destination_handler
+  attr_accessor :destination_location
+  
+  def initialize(script_path)
+    @script_path            = script_path
+    @application_directory  = script_path.gsub('/current/config/backup.rb','')
+    @backups_path           = File.join(application_directory,'backups')
+    @current_backup_path    = File.join(backups_path,'current')
+    @previous_backups_path  = File.join(backups_path,'previous')
+    
+    create_backup_folders
+  end
+  
+  def perform
+    archive
+    
+    eval(File.read(script_path), binding)
+    
+    finalize
+    upload
+  end
+  
+  def backup
+    yield
+  end
+  
+  private 
+  
+    def archive
+      archive_files         = Dir.glob(File.join(current_backup_path,'*.tar.gz'))
+      last_run              = File.mtime(current_backup_path).strftime("%Y%m%d%H%M%S")
+      last_run_destination  = File.join(previous_backups_path,last_run)
+      
+      FileUtils.mkdir_p last_run_destination
+      FileUtils.mv archive_files, last_run_destination
+    end
+    
+    def finalize
+      finalize_folders
+      finalize_databases
+
+      cleanup
+    end
+    
+    def cleanup
+      FileUtils.rm_rf File.join(current_backup_path,'folders')      
+      FileUtils.rm_rf File.join(current_backup_path,'databases') 
+      
+      previous_backups = Dir.glob(File.join(previous_backups_path,'*')).sort
+      
+      backups_to_prune = previous_backups - previous_backups[-Backup::KEEP,Backup::KEEP]
+
+      FileUtils.rm_rf backups_to_prune
+    end
+  
+    def finalize_folders
+      source        = File.join(current_backup_path,'folders')
+      destination   = File.join(current_backup_path,'folders.tar.gz')
+      
+      compress(source, destination)
+    end
+    
+    def finalize_databases
+      source        = File.join(current_backup_path,'databases')
+      destination   = File.join(current_backup_path,'databases.tar.gz')
+      
+      compress(source, destination)
+    end
+    
+    def upload
+      files_to_backup = Dir.glob(File.join(current_backup_path,'*.tar.gz'))
+      Backup::Manager.handler(destination_handler).store(destination_location, files_to_backup)
+    end
+    
+    def compress(source,destination)
+      `/usr/bin/env tar czf #{destination} #{source}`
+    end
+  
+    def create_backup_folders
+      FileUtils.mkdir_p backups_path
+      FileUtils.mkdir_p current_backup_path
+      FileUtils.mkdir_p File.join(current_backup_path,'folders')
+      FileUtils.mkdir_p File.join(current_backup_path,'databases')
+      FileUtils.mkdir_p previous_backups_path
+    end
+    
+    def destination(name, location)
+      @destination_handler   = name
+      @destination_location  = location
+    end
+  
+    def folder(path, options = {})
+      source        = File.join(application_directory,'current',path)
+      destination   = File.join(current_backup_path,'folders',path.gsub('/','_') + '.tar.gz')
+      
+      compress(source, destination)
+    end
+    
+    def database(name, options = {})
+      destination    = File.join(current_backup_path,'databases', name + '_' + Date.today.strftime("%Y%m%d%H%M%S") + '.sql')
+      
+      `/usr/local/pgsql/bin/pg_dump -U postgres #{name} > #{destination}`
+    end
+end

data/lib/backup/manager.rb

@@ -0,0 +1,30 @@
+
+class Backup::Manager
+  include Singleton
+  
+  attr_accessor :backup_handler
+  
+  def initialize
+    @backup_handler = {}
+  end
+  
+  def collect_jobs(pattern)
+    @backup_jobs = []
+    Dir.glob(pattern).each do |backupjob|
+      @backup_jobs << Backup::Job.new(backupjob)
+    end
+    @backup_jobs
+  end
+  
+  def use(name, handler)
+    @backup_handler[name] = handler
+  end
+  
+  def handler(name)
+    @backup_handler[name]
+  end
+  
+  def self.method_missing(method, *args)
+    self.instance.send(method, *args)
+  end
+end

data/spec/backup_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Backup do
+  
+  describe Backup::Manager do
+    it "should return a list of backup jobs" do
+      jobs = Backup::Manager.collect_jobs(File.join(File.dirname(__FILE__),'fs_root/home/**/current/config/backup.rb'))
+      jobs.should be_an(Array)
+      
+      jobs.first.should be_an(Backup::Job)
+    end
+  end
+  
+  describe Backup::Job do
+    before(:each) do
+      @job = Backup::Job.new(File.join(File.dirname(__FILE__), "/fs_root/home/user1/app1/production/current/config/backup.rb"))
+    end
+    
+    it "should report the correct application directory" do
+      @job.application_directory.should eql(File.join(File.dirname(__FILE__), "/fs_root/home/user1/app1/production"))
+    end
+    
+    it "should create a backup directory" do
+      File.directory?(@job.backups_path).should be true
+    end
+    
+    context "S3" do      
+      it "should attempt to save the files to S3" do
+        credidentials = {:access_key_id =>'acces_key', :secret_access_key =>"secret"}
+        AWS::S3::Base.should_receive(:establish_connection!).with(credidentials).and_return(true)
+        
+        s3 = Backup::Handler::S3.new(credidentials)
+        Backup::Manager.use(:s3, s3)
+        
+        @job = Backup::Job.new(File.join(File.dirname(__FILE__), "/fs_root/home/user1/app1/production/current/config/backup.rb"))
+        Backup::Manager.handler(:s3).should_receive(:store).with('liquidmedia_fairness',Dir.glob(File.join(@job.current_backup_path,'*.tar.gz'))).and_return(true)
+        @job.perform
+      end
+    end
+  end
+end

data/spec/fs_root/home/user1/app1/production/current/config/backup.rb

@@ -0,0 +1,6 @@
+backup do
+  destination :s3, 'liquidmedia_fairness'
+  
+  folder 'public/system'
+  database 'clearinghouse_development'
+end

data/spec/fs_root/home/user1/app1/production/current/public/system/important_files/file1.txt

@@ -0,0 +1 @@
+Important!

data/spec/fs_root/home/user1/app1/production/current/public/system/important_files/file2.txt

@@ -0,0 +1 @@
+Also Important!

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'backup'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: liquid_backup
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Backup your application server
+email: os@liquidmedia.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/backup.rb
+- lib/backup/handler/s3.rb
+- lib/backup/job.rb
+- lib/backup/manager.rb
+- spec/backup_spec.rb
+- spec/fs_root/home/user1/app1/production/current/public/system/important_files/file1.txt
+- spec/fs_root/home/user1/app1/production/current/public/system/important_files/file2.txt
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/liquidmedia/liquid_backup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Backup your application server
+test_files: 
+- spec/backup_spec.rb
+- spec/fs_root/home/user1/app1/production/current/config/backup.rb
+- spec/spec_helper.rb