mysql_backups 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f72b9907288779ccc6967863b280003c7d601cab
+  data.tar.gz: 2a8e4aceb6e8306d4e22d6871a4ef2394ae20465
+SHA512:
+  metadata.gz: f2281afa736ea165d99c944817df145f2356021db2cc6646ab0912fabd5efee38b86a2ccacd9eaa467a9cb70204c342efed0250ba369a87a35797a747d824bfb
+  data.tar.gz: 2028f5661337215a90488c697a2b6810ed6612fd63ed642b02e01a0661958b9a3bed436a9b3ca11b1112a8ab5b87ff93bc4b29b4f9eaf2b125f1dd0171939e7c

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql_backup.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    mysql_backup (1.1.0)
+      colorize
+      trollop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    rake (10.5.0)
+    trollop (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  mysql_backup!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Reed
+
+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,48 @@
+# MySQL Backup Tools
+
+## Installation
+
+    $ gem install mysql_backup
+
+## Usage
+
+Run the command `mysql-backup` to backup a database. You must provide a config file in order to tell it what to backup.
+
+    mysql-backup --config /path/to/config.yaml
+
+## Config files
+
+The backup config is stored in a YAML file. The only required settings are `server`, `username` and `database`
+
+For example:
+
+    # reddit-stream.backup.yaml
+    server: 127.0.0.1
+    username: backup_user
+    database: redditstream
+
+There are a number of optional parameters as well:
+
+    # reddit-stream.backup.yaml
+    #
+    # These are the mandatory settings, same as before
+    server: 127.0.0.1
+    username: backup_user
+    database: redditstream
+
+    # you can specify the list of tables to be backed up
+    tables: [action_log_notes, payment_log, payment_log_notes]
+
+    # list multiple locations to save the backup to. SSH hosts can
+    # be listed here as well, and the file will be transferred using
+    # scp
+    save_to:
+    - ~/backups
+    - user@remote.com:backups/
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql_backup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mysql-backup

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'mysql_backup'
+
+begin
+    MysqlBackup::App.new.main
+rescue => e
+    puts e.to_s
+end

data/lib/mysql_backup.rb

@@ -0,0 +1,89 @@
+require 'trollop'
+require 'mysql_backup/version'
+require 'mysql_backup/backup_config'
+
+module MysqlBackup
+  class App
+    def main
+
+      opts = Trollop::options do
+        version "mysql-backup #{MysqlBackup::VERSION} (c) 2015 @reednj"
+        opt :config, "YAML config file", :type => :string
+        opt :filename, "Name of backup output file", :type => :string
+      end
+
+      Dir.mkdir tmp_dir if !File.exist? tmp_dir
+      @seed = (rand() * 10000).round.to_s
+
+      begin
+        config_path = opts[:config] || 'mysql-backup.conf'
+        @config = BackupConfig.load_from config_path
+      rescue => e
+        puts "Error: Could not load config file at '#{config_path}' - #{e.message}"
+        return
+      end
+      
+      @output_file = opts[:filename] || "#{@config.database}.#{Date.today}.#{@seed}.sql.gz"
+      self.create_backup
+
+      @config.save_to.each do |path|
+        begin
+          self.save path
+          puts File.join(path, filename)
+        rescue => e
+          puts "Could not save backup to #{path} - #{e.message}"
+        end
+      end
+
+      self.clean
+    end
+
+    def create_backup
+      password = ''
+      password = "-p#{@config.password}" if @config.password?
+      options = '--skip-comments'
+      tables = @config.tables.join ' '
+      run! "mysqldump -u #{@config.username} #{password} --host=#{@config.server} #{options} #{@config.database} #{tables} | gzip > #{tmp_path}; exit ${PIPESTATUS[0]}"
+    end
+
+    def save(to_dir)
+      if _remote_path? to_dir
+        dest = File.join(to_dir, filename)
+        run! "scp #{tmp_path} #{dest}"
+      else
+        p = File.expand_path to_dir
+        dest = File.join(p, filename)
+        FileUtils.copy tmp_path, dest
+      end
+    end
+
+    def clean
+      File.delete tmp_path
+    end
+
+    def filename
+      @output_file
+    end
+
+    def tmp_dir
+      File.expand_path "~/.tmp/"
+    end
+
+    def tmp_path
+      File.join tmp_dir, "mysql.#{@seed}.bak"
+    end
+
+    # runs a shell command in such a way that if it fails (according to the exit status)
+    # and exception will be raised with the stderr output
+    def run!(cmd)
+      output = `(#{cmd}) 2>&1`
+      raise "#{output}" if $?.exitstatus != 0
+    end
+
+    # is this path on a remote server? do we need to use scp to copy the backup there?
+    def _remote_path?(path)
+      # not exactly foolproof, but it will do for now
+      path.include? ':'
+    end
+  end
+end

data/lib/mysql_backup/backup_config.rb

@@ -0,0 +1,66 @@
+require 'ostruct'
+require 'fileutils'
+require 'json'
+require 'yaml'
+require 'time'
+
+require 'mysql_backup/extensions'
+
+module MysqlBackup
+	class BackupConfig
+		def initialize(config)
+			@config = config
+			_validate!
+		end
+
+		def self.load_from(path)
+			data = YAML.load_file(path)
+			BackupConfig.new data
+		end
+
+		def _validate!
+			raise 'config object required' if @config.nil?
+			raise 'server required' if server.nil?
+			raise 'username required' if username.nil?
+			raise 'database required' if database.nil?
+			raise 'backup destination required' if save_to.nil?
+		end
+
+		def server
+			@config['server']
+		end
+
+		def username
+			@config['username'] || (app_config? ? AppConfig.db[:username] : nil)
+		end
+
+		def password
+			pw = @config['password'] || (app_config? ? AppConfig.db[:password] : nil)
+			return nil if pw.nil? || pw.strip == ''
+			return pw
+		end
+
+		def database
+			@config['database']
+		end
+
+		def password?
+			!password.nil?
+		end
+
+		def tables
+			Array.from @config['tables']
+		end
+
+		def save_to
+			return ['.'] if @config['save_to'].nil?
+			Array.from @config['save_to']
+		end
+
+		def app_config?
+			!!defined?(AppConfig) && !AppConfig.nil? && !AppConfig.db.nil? && AppConfig.db[:database] == self.database
+		end
+
+	end
+
+end

data/lib/mysql_backup/extensions.rb

@@ -0,0 +1,35 @@
+
+def try_load_file(path)
+	begin
+		load_relative path
+		return path
+	rescue LoadError => e
+		return nil
+	end
+end
+
+def try_load(paths)
+	Array.from(paths).each do |path|
+		result = try_load_file path
+		return result if !result.nil?
+	end
+
+	return nil
+end
+
+def this_dir
+	file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+	File.expand_path File.dirname(file)
+end
+
+def load_relative(path)
+	load File.expand_path path, this_dir()
+end
+
+class Array
+	def self.from(a)
+		return a if a.is_a? Array
+		return [] if a.nil?
+		return [a]
+	end
+end

data/lib/mysql_backup/version.rb

@@ -0,0 +1,3 @@
+module MysqlBackup
+  VERSION = "1.1.0"
+end

data/mysql-backup-dev

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec exe/mysql-backup "$@"

data/mysql-test.conf

@@ -0,0 +1,7 @@
+server: 127.0.0.1
+username: linkuser
+database: redditstream
+tables: [action_log_notes, payment_log, payment_log_notes]
+save_to:
+   - ~/Documents
+

data/mysql_backup.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql_backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql_backups"
+  spec.version       = MysqlBackup::VERSION
+  spec.authors       = ["Nathan Reed"]
+  spec.email         = ["reednj@gmail.com"]
+
+  spec.summary       = %q{easily make mysql backups from the command line}
+  spec.homepage      = "https://github.com/reedn/mysql_backup"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.required_ruby_version = '>=1.9.3'
+  spec.add_dependency  'colorize'
+  spec.add_dependency  'trollop'
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mysql_backups
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Nathan Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- reednj@gmail.com
+executables:
+- mysql-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mysql-backup
+- lib/mysql_backup.rb
+- lib/mysql_backup/backup_config.rb
+- lib/mysql_backup/extensions.rb
+- lib/mysql_backup/version.rb
+- mysql-backup-dev
+- mysql-test.conf
+- mysql_backup.gemspec
+homepage: https://github.com/reedn/mysql_backup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: easily make mysql backups from the command line
+test_files: []