redis-backup 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in svn-backup.gemspec
+gemspec
+gem 'aws-sdk'
+gem 'redis'

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Jose Diaz-Gonzalez
+
+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,4 @@
+redis-backup
+============
+
+a small ruby gem that allows automated redis-backups

data/Rakefile

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

data/bin/redis-backup

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# -*- encoding : utf-8 -*-
+
+#
+# redis-backup
+#
+# Uses environment variables for running:
+#
+# - BACKUP_DIR: Directory to write backups to
+# - REDIS_SAVE: 0 or 1. If "1", then perform, and wait for, a bgsave before copying backup
+# - REDIS_SAVE_METHOD: If calling a save, the method to call on redis for saving (save or bgsave)
+# - REDIS_HOST: Host for local redis
+# - REDIS_PORT: Port to local redis
+# - REDIS_SOURCE: Full path to redis dump.rdb file
+# - S3_SAVE: 0 or 1. If "1", then use S3 to backup the file
+# - S3_BUCKET: Name of bucket to use on S3
+# - S3_ACCESS_KEY_ID: Your access_key_id for AWS S3
+# - S3_SECRET_ACCESS_KEY: Your secret_access_key for AWS S3
+#
+
+require 'aws-sdk'
+require 'date'
+require 'fileutils'
+require 'optparse'
+require 'redis'
+
+require File.expand_path('../../lib/redis-backup/version', __FILE__)
+version = RedisBackup::VERSION
+
+backup_dir = "/data/backup/redis"
+redis_host = "localhost"
+redis_port = 6379
+redis_save_method = false
+redis_source = "/var/lib/redis/dump.rdb"
+s3_save = !!ENV.fetch("S3_SAVE", false)
+s3_bucket = false
+s3_access_key_id = false
+s3_secret_access_key = false
+
+optparse = OptionParser.new do |opts|
+  opts.version = version
+  opts.banner = "Usage: redis-backup [options]"
+  opts.on('-h', '--help', 'Usage information') do
+    puts opts
+    exit
+  end
+  opts.on('-b', '--backup-dir BACKUP_DIR', 'Directory to write backups to') { |dir| backup_dir = dir }
+  opts.on('-s', '--redis-source REDIS_SOURCE', 'Full path to redis dump.rdb file') { |source| redis_source = source }
+  opts.on('-m', '--redis-save-method REDIS_SAVE_METHOD', 'The method to call on redis for saving (save or bgsave or none)') { |method| redis_save_method = method }
+  opts.on('-H', '--redis-host REDIS_HOST', 'Host for local redis') { |host| redis_host = host }
+  opts.on('-p', '--redis-port REDIS_PORT', 'Port for local redis') { |port| redis_port = port.to_i }
+  opts.on('-B', '--s3-bucket S3_BUCKET', 'Name of bucket to use on S3') { |bucket| s3_bucket = bucket }
+  opts.on('-A', '--s3-access-key-id S3_ACCESS_KEY_ID', 'Your access_key_id for AWS S3') { |key| s3_access_key_id = key }
+  opts.on('-S', '--s3-secret-access-key S3_SECRET_ACCESS_KEY', 'Your secret_access_key for AWS S3') { |secret| s3_secret_access_key = secret }
+end
+optparse.parse!
+
+BACKUP_DIR = backup_dir
+REDIS_SAVE_METHOD = redis_save_method
+REDIS_HOST = redis_host
+REDIS_SOURCE = redis_source
+REDIS_PORT = redis_port
+S3_SAVE = !!s3_bucket && !!s3_access_key_id && !!s3_secret_access_key
+S3_BUCKET = s3_bucket
+S3_ACCESS_KEY_ID = s3_access_key_id
+S3_SECRET_ACCESS_KEY = s3_secret_access_key
+
+
+def colorize(text, color_code); RUBY_PLATFORM =~ /win32/ ?  text : "#{color_code}#{text}\e[0m"; end
+def red(text);      colorize(text, "\e[31m"); end
+def green(text);    colorize(text, "\e[32m"); end
+def yellow(text);   colorize(text, "\e[33m"); end
+def blue(text);     colorize(text, "\e[34m"); end
+def magenta(text);  colorize(text, "\e[35m"); end
+def cyan(text);     colorize(text, "\e[36m"); end
+def white(text);    colorize(text, "\e[37m"); end
+def bold(text);     colorize(text, "\e[1m");  end
+def grey(text);     colorize(text, "\e[90m"); end
+
+abort("Redis .rdb file does not exist: " + REDIS_SOURCE) unless File.exists? REDIS_SOURCE
+
+FileUtils.mkdir_p BACKUP_DIR unless File.directory? BACKUP_DIR
+
+abort("Backup directory does not exist: " + BACKUP_DIR) unless File.directory? BACKUP_DIR
+abort("Backup directory is not writable: " + BACKUP_DIR) unless File.writable? BACKUP_DIR
+
+if S3_SAVE
+  abort("No bucket specified") unless S3_BUCKET
+  abort("No access key specified in S3_ACCESS_KEY_ID environment variable") unless S3_ACCESS_KEY_ID
+  abort("No secret access key specified in S3_SECRET_ACCESS_KEY environment variable") unless S3_SECRET_ACCESS_KEY
+  AWS.config({
+    access_key_id: S3_ACCESS_KEY_ID,
+    secret_access_key: S3_SECRET_ACCESS_KEY
+  })
+  s3 = AWS::S3.new
+  bucket = s3.buckets[S3_BUCKET]
+  abort("Bucket does not exist: " + S3_BUCKET) unless bucket.exists?
+  begin
+    owner = bucket.owner
+  rescue AWS::S3::Errors::AccessDenied => e
+    abort("Access to the bucket is denied: " + S3_BUCKET)
+  end
+end
+
+
+puts blue(cyan('Starting save'))
+backup_start = Time.now
+
+puts "--> Saving from %s to %s" % [ REDIS_SOURCE, BACKUP_DIR ]
+
+if REDIS_SAVE_METHOD
+  puts "-->  Performing background save " + bold(cyan('↴'))
+  bgsave_start = Time.now
+
+  mtime = File.mtime(REDIS_SOURCE).strftime("%Y-%m-%d-%H-%M-%S")
+  puts "    - Current backup.rdb mtime: " + mtime
+
+  puts "    - Sending '%s' command" % (REDIS_SAVE_METHOD)
+  redis = Redis.new(
+    :host => REDIS_HOST,
+    :port => REDIS_PORT
+  )
+
+  if REDIS_SAVE_METHOD == "bgsave"
+    redis.bgsave
+  else
+    redis.save
+  end
+
+  puts "    - Command sent, waiting"
+
+  while File.mtime(REDIS_SOURCE).strftime("%Y-%m-%d-%H-%M-%S") == mtime
+    sleep 0.0001
+  end
+
+  puts "    - Save performed successfully, took %.2f seconds" % (Time.now - backup_start)
+end
+
+DATETIME = DateTime.parse(`date`).strftime("%Y-%m-%d-%H-%M-%S")
+REDIS_DEST = "%s/%s-dump.rdb" % [ BACKUP_DIR, DATETIME ]
+
+puts "--> Copying backup from %s to %s" % [ REDIS_SOURCE, REDIS_DEST ]
+FileUtils.cp(REDIS_SOURCE, REDIS_DEST)
+
+if S3_SAVE
+  puts "--> Pushing file to S3 " + bold(cyan('↴'))
+  s3_start = Time.now
+
+  puts "    - Connecting to S3"
+  s3 = AWS::S3.new
+  bucket = s3.buckets[S3_BUCKET]
+
+  puts "    - Uploading the file, please wait..."
+  basename = File.basename(REDIS_DEST)
+  object = bucket.objects[basename]
+  object.write(:file => REDIS_DEST)
+  request_uri = object.url_for(:read).request_uri.gsub(S3_ACCESS_KEY_ID, "YOUR_S3_ACCESS_KEY_ID")
+
+  puts "    - Uploaded to: " + object.public_url.request_uri
+  puts "    - Use this URL to download the file: https://s3.amazonaws.com/" + S3_BUCKET + request_uri
+  puts "    - S3 sync performed successfully, took %.2f seconds" % (Time.now - s3_start)
+end
+
+puts '🚀   ' + green('Backup took %.2f seconds' % (Time.now - backup_start))

data/lib/redis-backup.rb

@@ -0,0 +1,4 @@
+require "redis-backup/version"
+
+module RedisBackup
+end

data/lib/redis-backup/version.rb

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

data/redis-backup.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redis-backup/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jose Diaz-Gonzalez"]
+  gem.email         = ["email@josediazgonzalez.com"]
+  gem.description   = %q{redis-backup is a simple backup script to automate the creation and storage or redis dump.rdb files.}
+  gem.summary       = %q{a small ruby gem that allows automated redis-backups}
+  gem.homepage      = "https://github.com/josegonzalez/redis-backup"
+
+  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          = "redis-backup"
+  gem.require_paths = ["lib"]
+  gem.version       = RedisBackup::VERSION
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: redis-backup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jose Diaz-Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies: []
+description: redis-backup is a simple backup script to automate the creation and storage
+  or redis dump.rdb files.
+email:
+- email@josediazgonzalez.com
+executables:
+- redis-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/redis-backup
+- lib/redis-backup.rb
+- lib/redis-backup/version.rb
+- redis-backup.gemspec
+homepage: https://github.com/josegonzalez/redis-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.23
+signing_key: 
+specification_version: 3
+summary: a small ruby gem that allows automated redis-backups
+test_files: []
+has_rdoc: