s3-mysql-backup 2.0.2 → 2.1.0

data/README.md

@@ -1,13 +1,13 @@
 # S3 MySQL Backup
 
-Simple backup of a MySQL database to Amazon S3, 
-with email notification via Gmail.
+Simple backup of a MySQL database to Amazon S3,
+with email notification via SMTP.
 
 
 ## 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 
+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:
@@ -17,7 +17,7 @@ Local and S3 backups are retained at this schedule:
 
 The email summary is a short email like:
 
-    From:    my-user@gmail.com
+    From:    my-user@example.com
     To:      my-recipient@example.com
     Date:    2012-12-22
     Subject: sql backup: my_database_name: 42.0 MB
@@ -31,18 +31,20 @@ Configure with a YAML file:
 
 ```yaml
 
-# backup_dir            where to store the local backups
+# backup_dir            where to store the local backups, default is ~/s3_mysql_backups
 backup_dir: ~/s3_mysql_backups
+# remote_dir            OPTIONAL, where to store the remote backups, default is the root of your s3_bucket
+remote_dir: /path/to/remote/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_server             OPTIONAL: your non-Amazon S3-compatible server
+# s3_server             OPTIONAL, your non-Amazon S3-compatible server
 s3_access_key_id: my-key
 s3_secret_access_key: my-secret
 s3_bucket: my-bucket
 
-# dump_host             OPTIONAL: your mysql host name
+# dump_host             OPTIONAL, your mysql host name
 # dump_user             the database user for mysqldump
 # dump_pass             the password for the dump user
 dump_user: my-user
@@ -51,14 +53,18 @@ 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
+# Mail credentials
+mail_user: me@example.com
+mail_pass: example_password
+mail_domain: smtp.example.com   # OPTIONAL, defaults to: smtp.gmail.com
+mail_port: 587                  # OPTIONAL, defaults to: 587
+mail_authentication: login      # OPTIONAL, defaults to: :login
+mail_start_tls: true            # OPTIONAL, defaults to: true
 
 ```
 
 
-## Installation 
+## Installation
 
     gem install s3-mysql-backup
 
@@ -67,7 +73,9 @@ gmail_pass: gmail-password
 
 From Ruby:
 
-    S3MysqlBackup.new('database_name', '/path/to/s3-mysql-backup-config.yml').run
+    S3MysqlBackup.new("database_name", "/path/to/s3-mysql-backup-config.yml").run
+    or
+    S3MysqlBackup.new("database_name", { hash: of_options }).run
 
 From command line:
 
@@ -84,6 +92,7 @@ Write tests
 
 
 ## Changelog
+- 2013-10-13 2.1.0 Allow other mail hosts, allow Hash config at runtime (https://github.com/7compass/s3-mysql-backup/pull/7)
 - 2013-06-01 1.2.2 Bugfix for passwords with spaces
 - 2013-06-01 1.2.1 Added mysql host option (github.com/sagrimson)
 - 2013-05-30 1.1.0 Added support for S3-compatible services, e.g. DreamObjects (thanks to John N. Milner - github.com/jnm)

data/lib/s3_mysql_backup.rb

@@ -7,30 +7,43 @@ 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
-
     connect_to_s3
-
     remove_old_backups
-    
     mail_notification(dump_db)
   end
-  
-  
+
+
   protected
-  
+
   def config
-    defaults = { 'dump_host' => 'localhost' }
-    @s3config ||= defaults.merge(YAML::load_file(@path_to_config))
+    defaults = {
+      "dump_host"           => "localhost",
+      "mail_domain"         => "smtp.gmail.com",
+      "mail_port"           => "587",
+      "mail_authentication" => :login,
+      "backup_dir"          => "~/s3_mysql_backups",
+    }
+
+    if @s3config.nil?
+      @s3config = @path_to_config.is_a?(Hash) ? defaults.merge(stringify_keys(@path_to_config)) : defaults.merge(YAML::load_file(@path_to_config))
+
+      # Backcompat for gmail_* keys
+      @s3config.keys.each do |key|
+        @s3config[key.sub(/^gmail/, "mail")] = @s3config.delete(key)
+      end
+    end
+    
+    @s3config    
   end
 
   def connect_to_s3
@@ -42,7 +55,7 @@ class S3MysqlBackup
     filename  = Time.now.strftime("#{@backup_dir}/#{@db_name}.%Y%m%d.%H%M%S.sql.gz")
     mysqldump = `which mysqldump`.to_s.strip
     `#{mysqldump} --host='#{config['dump_host']}' --user='#{config['dump_user']}' --password='#{config['dump_pass']}' '#{@db_name}' | gzip > #{filename}`
-    @s3utils.store(filename)
+    @s3utils.store(filename, config['remote_dir'])
     filename
   end
 
@@ -66,17 +79,17 @@ class S3MysqlBackup
     subject = "sql backup: #{@db_name}: #{human_size(stats.size)}"
 
     content = []
-    content << "From: #{config['gmail_user']}"
+    content << "From: #{config['mail_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'])
+    smtp = Net::SMTP.new(config["mail_domain"], config["mail_port"])
+    smtp.enable_starttls unless config["mail_start_tls"] == false
+    smtp.start(config["mail_domain"], config['mail_user'], config['mail_pass'], config['mail_authentication']) do
+      smtp.send_message(content, config['mail_user'], config['mail_to'])
     end
   end
 
@@ -111,4 +124,11 @@ class S3MysqlBackup
     end # Dir.each
   end # remove_old_backups
 
+  def stringify_keys(hash)
+    hash.keys.each do |key|
+      hash[key.to_s] = hash.delete(key)
+    end
+    hash
+  end
+
 end

data/lib/s3utils.rb

@@ -11,8 +11,9 @@ class S3Utils
     self
   end
 
-  def store(file_path)
-    @s3_bucket.objects.create(File.basename(file_path), open(file_path))
+  def store(file_path, remote_path=nil)
+    upload_location = (!remote_path.nil? && !remote_path.empty?) ? "#{remote_path}/#{File.basename(file_path)}" : File.basename(file_path)
+    @s3_bucket.objects.create(upload_location, open(file_path))
   end
 
   def delete(file_path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3-mysql-backup
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70338179173760 !ruby/object:Gem::Requirement
+  requirement: &70118190119740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338179173760
+  version_requirements: *70118190119740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70338179173280 !ruby/object:Gem::Requirement
+  requirement: &70118190119260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70338179173280
+  version_requirements: *70118190119260
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70338179172820 !ruby/object:Gem::Requirement
+  requirement: &70118190118800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.0.5
   type: :development
   prerelease: false
-  version_requirements: *70338179172820
+  version_requirements: *70118190118800
 description: A simple mysql backup to Amazon S3
 email: jeff@7compass.com
 executables: