s3-mysql-backup 1.0.0

data/README.md

@@ -0,0 +1,62 @@
+# S3 MySQL Backup
+
+Simple backup of a MySQL database to Amazon S3, 
+with email notification via Gmail.
+
+
+## What does it do?
+
+It makes a gzipped and timestamped local backup of the specified 
+database using mysqldump.  The local backup is then copied to 
+Amazon S3, and the results are emailed to the specified recipient.
+
+Local and S3 backups are retained at this schedule:
+- keep 30 days complete
+- keep 90 days weekly beyond that
+- keep only monthly after that
+
+
+## Configuration
+
+Configure with a YAML file:
+
+```yaml
+
+# backup_dir            where to store the local backups
+backup_dir: ~/s3_mysql_backups
+
+# s3_access_key_id      your Amazon S3 access_key_id
+# s3_secret_access_key  your Amazon S3 secret_access_key
+# s3_bucket             your Amazon S3 bucket for the backups
+s3_access_key_id: my-key
+s3_secret_access_key: my-secret
+s3_bucket: my-bucket
+
+# dump_user             the database user for mysqldump
+# dump_pass             the password for the dump user
+dump_user: my-user
+dump_pass: my-pass
+
+# mail_to               where to send the backup summary email
+mail_to: recipient@example.com
+
+# Gmail credentials
+gmail_user: me@gmail.com
+gmail_pass: gmail-password
+
+```
+
+
+## Installation 
+
+    gem install s3-mysql-backup
+
+
+## Usage
+
+    S3MysqlBackup.new('database_name', '/path/to/s3-mysql-backup-config.yml').run
+
+
+## Credits
+
+2008+ Seventh Compass

data/lib/s3-mysql-backup.rb

@@ -0,0 +1 @@
+require 's3_mysql_backup'

data/lib/s3_mysql_backup.rb

@@ -0,0 +1,108 @@
+require "net/smtp"
+require "time"
+require 'fileutils'
+require 'yaml'
+
+require File.dirname(__FILE__) + '/s3utils'
+
+#
+class S3MysqlBackup
+  
+  def initialize(db_name, path_to_config)
+    @db_name        = db_name
+    @path_to_config = path_to_config
+
+    self
+  end
+  
+  def run
+    ensure_backup_dir_exists
+
+    @s3utils = S3Utils.new(config['s3_access_key_id'], config['s3_secret_access_key'], config['s3_bucket'])
+
+    @dumpfile = dump_db
+    remove_old_backups
+    mail_notification(@dumpfile)
+  end
+  
+  
+  protected
+  
+  # make the DB backup file
+  def dump_db
+    filename  = Time.now.strftime("#{@backup_dir}/#{@db_name}.%Y%m%d.%H%M%S.sql.gz")
+    mysqldump = `which mysqldump`.to_s.strip
+    `#{mysqldump} --user=#{config['dump_user']} --password=#{config['dump_pass']} #{@db_name} | gzip > #{filename}`
+    @s3utils.store(filename)
+    filename
+  end
+
+  def ensure_backup_dir_exists
+    @backup_dir = File.expand_path(config['backup_dir'])
+    FileUtils.mkdir_p @backup_dir
+  end
+
+  def human_size(num, unit='bytes')
+    units = %w(bytes KB MB GB TB PB EB ZB YB)
+    if num <= 1024
+      "#{"%0.2f"%num} #{unit}"
+    else
+      human_size(num/1024.0, units[units.index(unit)+1])
+    end
+  end
+
+  def mail_notification(filename)
+    stats = File.stat(filename)
+    subject = "sql backup: #{@db_name}: #{human_size(stats.size)}"
+
+    content = []
+    content << "From: #{config['gmail_user']}"
+    content << "To: #{config['mail_to']}"
+    content << "Subject: #{subject}"
+    content << "Date: #{Time.now.rfc2822}"
+    content << "\n#{File.basename(filename)}\n" # body
+    content = content.join("\n")
+
+    smtp = Net::SMTP.new("smtp.gmail.com", 587)
+    smtp.enable_starttls
+    smtp.start("smtp.gmail.com", config['gmail_user'], config['gmail_pass'], :login) do
+      smtp.send_message(content, config['gmail_user'], config['mail_to'])
+    end
+  end
+
+  def config
+    @s3config ||= YAML::load_file(@path_to_config)
+  end
+
+  # remove old backups
+  #   - keep 30 days complete
+  #   - keep 90 days weekly beyond that
+  #   - keep only monthly after that
+  def remove_old_backups
+    today   = Date.today
+    weekly  = (today - 30)
+    monthly = (today - 120)
+
+    Dir["#{config['backup_dir']}/*.sql.gz"].each do |name|
+      date     = name.split('.')[1]
+      filedate = Date.strptime(date, '%Y%m%d')
+
+      if filedate < weekly && filedate >= monthly
+        # keep weeklies and also first of month
+        unless filedate.wday == 0 || filedate.day == 1
+          FileUtils.rm_f(name)
+          @s3utils.delete(name)
+        end
+      elsif filedate < monthly
+        # delete all old local files
+        FileUtils.rm_f(name)
+
+        # keep just first of month in S3
+        unless filedate.day == 1
+          @s3utils.delete(name)
+        end
+      end
+    end # Dir.each
+  end # remove_old_backups
+
+end

data/lib/s3utils.rb

@@ -0,0 +1,51 @@
+require 'aws/s3'
+
+include AWS::S3
+
+
+# wrapper for S3 operations
+#
+class S3Utils
+
+  def initialize(access_key_id, secret_access_key, bucket)
+    @bucket = bucket
+    connect(access_key_id, secret_access_key)
+    ensure_bucket_exists
+    self
+  end
+
+  def copy(from, to)
+    S3Object.copy(File.basename(from), File.basename(to), @bucket)
+  end
+
+  def store(file_path)
+    S3Object.store(File.basename(file_path), open(file_path), @bucket)
+  end
+
+  def delete(file_path)
+    S3Object.delete(File.basename(file_path), @bucket)
+  end
+
+  def list
+    Bucket.find(@bucket).objects.each do |obj|
+      puts "#{obj.bucket.name}/#{obj.key}"
+    end
+  end
+
+  protected
+
+  def connect(access_key_id, secret_access_key)
+    AWS::S3::Base.establish_connection!(
+      :access_key_id     => access_key_id,
+      :secret_access_key => secret_access_key
+    )
+  end
+
+  def ensure_bucket_exists
+    Bucket.find(@bucket)
+
+  rescue AWS::S3::NoSuchBucket
+    Bucket.create(@bucket)
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: s3-mysql-backup
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Emminger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple mysql backup to Amazon S3
+email: jeff@7compass.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/s3-mysql-backup.rb
+- lib/s3_mysql_backup.rb
+- lib/s3utils.rb
+- README.md
+homepage: https://github.com/7compass/s3-mysql-backup
+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.24
+signing_key: 
+specification_version: 3
+summary: Simple mysql backup to S3
+test_files: []