db-rotator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba4a2bd4dffd3e671210454b4e7ba6dbb758ca07
+  data.tar.gz: c9c7f9835d3807f3d302288844138330919a5942
+SHA512:
+  metadata.gz: 7abcb7f9c2aad35f1d891edb148182cb86e09f338a5b008bb8ab09386b93f25e87ed1d0d430f93447b57dd38ee51b06214e78a8f1f0ffdc662ee1264c5ef327f
+  data.tar.gz: 03d563062c0940986b8f94e422869f1aa9ad22059820b3e354f98835d4db3b8246aaefdc18616790bef8a68fcfc9a9a362a857dccfadfbdd854c11c471747fc9

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*.gem

data/LICENSE

@@ -0,0 +1,339 @@
+GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,46 @@
+# DBRotator
+Easy MySQL database rotation and pruning. Tell this utility where your nightly MySQL backup is, and it downloads, imports, and organizes the dump, pruning all but the newest N databases.
+
+## Installation
+
+`gem install db-rotator`
+
+## Usage
+
+1. First off, the following is required:
+  - SSH access to your most current MySQL backup as a single endpoint, like a symlink that updates nightly.
+  - root access to destination MySQL instance. Recommended to setup username/password in `~/.my.cnf` so that "mysql" works without `-u` or `-p`.
+
+2. Configure the required options (see below). Configuration can be passed as command line arguments or set in `~/.db-rotator.yml`.
+
+  Minimal usage example:
+
+  `db-rotator -p 'appdump_' -c 'scp db5:/opt/backups/latest.sql.bz2'`
+
+  Run `db-rotator -h` for the list of configuration options from CLI.
+
+  You can also set up configuration at `~/.db-rotator.yml`, and omit any CLI options, like so:
+
+  ```
+  db_prefix: "appdump_"
+  scp_command: "scp db5:/opt/backups/latest.sql.bz2"
+  ```
+
+3. Put `db-rotator` in your crontab, and execute it when you're sure your nightly dump has finished.
+
+  `0 3 * * * db-rotator -p 'appdump_' -c 'scp db5:/opt/backups/latest.sql.bz2' >> /some/log/file`
+
+## Required Configuration
+  - **db_prefix** (-p). Database naming prefix. Example: `myproject_`, which might name a DB as myproject_09182013.
+  - **scp_command** (-c). Receives second arg of dump path. Example: `scp hostname:/path/to/mysql/backups/backup_filename.sql.bz2`
+
+## Optional Configuration
+
+- **local_dump_destination** (-d). Where to put the dump, as a directory. Won't be deleted after running rotator. Default: `/tmp`
+- **mysql_command** (-m). Used for all database management operations. Default: `mysql`
+- **maximum_dbs** (-n). Maximum number of DBs to maintain, or null to disable pruning. Default: 2
+- **unarchive_command** (-u). How to unarchive your dump to standard output. Default: `bzip2 -cd`
+- **unarchive_extra_pipe** (-i). Any extra script(s) you want to run between unarchive & import. Example: ["/some/filter/for/imported_data", "/some/other/filter/for/imported_data"] Default: nil
+- **reasonable_diskspace** (-s). Rough estimate of temporary disk space required to import a typical dump, in GB. Ensures this amount of space is free before importing. Default: nil
+- **rails_db_yaml_path** (-y). Updates database name in your YAML file. Example: `/path/to/railsroot/config/database.yml` Default: nil
+- **rails_environments** (-e). In conjunction with -y, which rails envs to update DB name for. If passing multiple via command line, use a comma to separate, like `-e "development,staging"`. Default: ["development"]

data/bin/db-rotator

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/db_rotator_config.rb'
+require_relative '../lib/db_rotator.rb'
+
+config = DBRotatorConfig.new
+config.configure
+puts config.config
+rotator = DBRotator.new(config)
+rotator.rotate

data/db-rotator.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = "db-rotator"
+  s.version     = "0.0.1"
+  s.summary     = "Easy MySQL database rotation and pruning"
+  s.description = "Easy MySQL database rotation and pruning"
+  s.authors     = ["Michael Nelson"]
+  s.email       = "michael@nelsonware.com"
+  s.executables << "db-rotator"
+  s.files       = `git ls-files`.split
+  #s.test_files  = `git ls-files -- test/*`.split
+  s.homepage    = "https://github.com/mcnelson/db-rotator"
+  s.license     = "LGPL-2.0"
+
+  s.add_development_dependency  'minitest'
+end

data/lib/db_rotator.rb

@@ -0,0 +1,154 @@
+require 'yaml'
+
+class DBRotator
+  TIME_FORMAT = "%Y%m%d"
+
+  def initialize(config)
+    @config = config.config
+    @schemas = []
+    populate_schemas
+  end
+
+  def rotate
+    refresh
+    update_db_yaml
+  end
+
+  def refresh
+    download_dump
+    import
+    prune
+    grant_access
+  end
+
+  def import
+    import_dump
+    populate_schemas
+  end
+
+  private
+
+  def download_dump
+    verbose_message "Downloading dump..."
+    bash_exec "rm -f #{local_dump_path}"
+    bash_exec "#{@config[:scp_command]} #{local_dump_path}"
+  end
+
+  def import_dump
+    if reasonable_diskspace?
+      verbose_message "Importing dump..."
+
+      mysql_exec "DROP SCHEMA IF EXISTS #{todays_dbname}"
+      mysql_exec "CREATE SCHEMA #{todays_dbname}"
+
+      bash_exec %[#{@config[:unarchive_command]} #{local_dump_path} |
+                  #{extra_pipe}
+                 #{@config[:mysql_command]} #{todays_dbname}]
+    else
+      raise "not enough disk space: #{raw_diskspace}"
+    end
+  end
+
+  def prune
+    if @config[:maximum_dbs]
+      verbose_message "Pruning DBs..."
+
+      if @schemas.count > (n = @config[:maximum_dbs].to_i)
+        @schemas.sort_by(&:to_date).reverse[n..-1].each do |schema|
+          mysql_exec "DROP SCHEMA IF EXISTS #{schema.name}"
+        end
+      end
+    end
+  end
+
+  def grant_access
+    verbose_message "Granting ..."
+    mysql_exec "GRANT ALL ON #{todays_dbname}.* to `%`@`localhost`"
+  end
+
+  def populate_schemas
+    @schemas = raw_schemas.split.each.with_object([]) do |schema_name, memo|
+      memo << Schema.new(schema_name, schema_regex) if schema_name =~ schema_regex
+    end
+  end
+
+  def update_db_yaml
+    if @config[:rails_db_yaml_path]
+      hash = YAML.load(File.read(@config[:rails_db_yaml_path]))
+
+      @config[:rails_environments].each do |env|
+        hash[env.to_s]["database"] = todays_dbname
+      end
+
+      File.write(@config[:rails_db_yaml_path], hash.to_yaml)
+    end
+  end
+
+  def extra_pipe
+    @config[:unarchive_extra_pipe] && "#{@config[:unarchive_extra_pipe].join(' | ')} |"
+  end
+
+  def todays_stamp
+    Time.now.strftime(TIME_FORMAT)
+  end
+
+  def todays_dbname
+    "#{@config[:db_prefix]}#{todays_stamp}"
+  end
+
+  def schema_regex
+    /#{@config[:db_prefix]}([0-9]+)/
+  end
+
+  def local_dump_path
+    [@config[:local_dump_destination], @config[:dump_filename]].join('/')
+  end
+
+  def reasonable_diskspace?
+    if @config[:reasonable_diskspace]
+      return raw_diskspace.to_i >= @config[:reasonable_diskspace]
+    end
+
+    true
+  end
+
+  def raw_diskspace
+    bash_exec "df -h `mysql -B -e 'select @@datadir;' | tail -1` | tail -1 | awk '{ print $2 }'"
+  end
+
+  def raw_schemas
+    mysql_exec "SHOW DATABASES"
+  end
+
+  def bash_exec(cmd, skip_raise = false)
+    out = `#{cmd} || echo '__failed'`
+    out = out.strip == "__failed" ? nil : out
+    raise "Command failed: #{cmd}" if !skip_raise && !out
+
+    out
+  end
+
+  def mysql_exec(cmd)
+    bash_exec "#{@config[:mysql_command]} -B -e '#{cmd}'"
+  end
+
+  def verbose_message(msg)
+    puts msg if @config[:verbose]
+  end
+
+  class Schema
+    attr_reader :name
+
+    def initialize(name, schema_regex)
+      @name = name
+      @schema_regex = schema_regex
+    end
+
+    def to_date
+      Date.strptime(
+        name.match(@schema_regex)[1],
+        TIME_FORMAT
+      )
+    end
+  end
+end

data/lib/db_rotator_config.rb

@@ -0,0 +1,111 @@
+
+require 'optparse'
+require 'pathname'
+
+class DBRotatorConfig
+  class FileNotFoundError < StandardError; end
+
+  FILE = ".db-rotator.yml"
+
+  CONFIG = {
+    db_prefix:              [['-p', "--db-prefix PREFIX", "Database naming prefix"], nil],
+    scp_command:            [['-c', "--scp-command COMMAND", "Command to retrive dump. Receives second arg of dump path"], nil],
+
+    local_dump_destination: [['-d', "--local-destination [PATH]", "Where to put the dump, as a directory. Won't be deleted after running rotator.", "Default: /tmp"], "/tmp"],
+    mysql_command:          [['-m', "--mysql-command [COMMAND]", "Used for all database management operations.", "mysql"], "mysql"],
+    maximum_dbs:            [['-n', "--maximum-dbs [N]", "Maximum number of DBs to maintain, or null to disable pruning.", "Default: 2"], 2],
+    unarchive_command:      [['-u', "--unarchive-command [COMMAND]", "How to unarchive your dump to standard output.", "Default: bzip2 -cd"], "bzip2 -cd"],
+    unarchive_extra_pipe:   [['-i', "--extra-pipes [SCRIPT1,SCRIPT2]", Array, "Any extra script(s) you want to run between unarchive & import.", "Example: -i 'script1,script2'"], nil],
+    reasonable_diskspace:   [['-s', "--minimum-diskspace [GB]", "Rough estimate of temporary disk space required to import a typical dump, in GB.", "Default: nil"], nil],
+    rails_db_yaml_path:     [['-y', "--rails-db-yaml [PATH]", "Updates database name in your YAML file when given.", "Default: nil"], nil],
+    rails_environments:     [['-e', "--rails-db-environments [ENV1,ENV2]", Array, "In conjunction with -y, which rails envs to update DB name for.", "Default [development]"], ["development"]],
+
+    config_file:            [['-f', "--config-file PATH", "Load configuration from .yml file"], nil],
+  }
+
+  REQUIRED = %i(db_prefix scp_command)
+  attr_reader :config
+
+  def initialize
+    @config = {}
+  end
+
+  def configure
+    begin
+      ARGV.empty? ? from_file : from_cli
+
+      if @config[:config_file]
+        from_file
+      end
+
+      check_required
+      add_default_values
+      add_derived_values
+    rescue FileNotFoundError => e
+      puts "There was a problem loading configuration: #{e.message}"
+      puts cli_parser.summarize
+      exit
+    end
+  end
+
+  def from_cli
+    cli_parser.parse!(ARGV)
+  end
+
+  def from_file
+    raise FileNotFoundError, "no such config file -- #{config_syspath}" unless File.exists?(config_syspath)
+    @config = YAML.load_file(config_syspath).each.with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+    if !(missing = REQUIRED.delete_if { |k| @config[k] }).empty?
+      raise "please set config option(s) in #{config_syspath}: #{missing.join(', ')}"
+    end
+  end
+
+  def cli_parser
+    OptionParser.new do |opts|
+      opts.banner = "Usage: db-rotator [options]"
+
+      CONFIG.each do |key, pair|
+        o = pair.first
+        if o[3].nil?
+          opts.on(o[0], o[1], o[2]) do |v|
+            @config[key] = v
+          end
+        else
+          opts.on(o[0], o[1], o[2], o[3]) do |v|
+            @config[key] = v
+          end
+        end
+      end
+
+      opts.on("-v", "--verbose") do |v|
+        @config[:verbose] = v
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+  end
+
+  def config_syspath
+    @config[:config_file] || [ENV['HOME'], FILE].join('/')
+  end
+
+  def check_required
+    REQUIRED.each { |k| raise "config option '#{k.to_s} is required'" if @config[k].nil? }
+  end
+
+  def add_default_values
+    CONFIG.each do |key, pair|
+      @config[key] ||= pair.last
+    end
+  end
+
+  def add_derived_values
+    # Figure out the dump filename
+    pn = Pathname.new(@config[:scp_command])
+    @config[:dump_filename] = pn.basename.to_s
+  end
+end

data/test/test_db_rotator.rb

@@ -0,0 +1,6 @@
+
+require 'minitest'
+
+describe DBRotator do
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: db-rotator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Easy MySQL database rotation and pruning
+email: michael@nelsonware.com
+executables:
+- db-rotator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- bin/db-rotator
+- db-rotator.gemspec
+- lib/db_rotator.rb
+- lib/db_rotator_config.rb
+- test/test_db_rotator.rb
+homepage: https://github.com/mcnelson/db-rotator
+licenses:
+- LGPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Easy MySQL database rotation and pruning
+test_files: []