mys3ql 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+[awaiting v1.0.0]

data/README.md

@@ -9,11 +9,17 @@ Install and configure as below.
 
 To perform a full backup:
 
-    $ mys3ql full
+    $ mys3ql -f
+    $ mys3ql --full
 
 If you are using MySql's binary logging (see below), back up the binary logs like this:
 
-    $ mys3ql incremental
+    $ mys3ql -i
+    $ mys3ql --incremental
+
+By default mys3ql looks for a configuration file at ~/.mys3ql.  You can override this like so:
+
+    $ mys3ql -f --config=FILE
 
 
 ## Installation
@@ -21,14 +27,14 @@ If you are using MySql's binary logging (see below), back up the binary logs lik
 First install the gem:
 
     $ gem install mys3ql
-    
-Second, create your `~/.mys3ql` config file:
+
+Second, create your config file:
 
     mysql:
       # Database to back up
       database: aircms_production
       # MySql credentials
-      user: root
+      user:
       password:
       # Path (with trailing slash) to mysql commands e.g. mysqldump
       bin_path: /usr/local/mysql/bin/
@@ -44,6 +50,7 @@ Second, create your `~/.mys3ql` config file:
       # Bucket in which to store your backups
       bucket: db_backups
 
+If you only have one database to back up on your server, you can put the config file at `~/.mys3ql`.  Otherwise, tell the `mys3ql` command where the config file is with the `--config=FILE` switch.
 
 ## Binary logging
 
@@ -67,4 +74,15 @@ Marc-André Cournoyer's [mysql_s3_backup](https://github.com/macournoyer/mysql_s
 - tests ;)
 - restore (pull latest dump, pull bin files, pipe dump into mysql, pipe binfiles into mysql)
 - remove old dump files (s3)
-- fix verbosity/debugging flag
+
+
+## Questions, Problems, Feedback
+
+Please use the GitHub [issue tracker](https://github.com/airblade/mys3ql/issues) or email me.
+
+
+## Intellectual property
+
+Copyright 2011 Andy Stewart (boss@airbladesoftware.com).
+
+Released under the MIT licence.

data/bin/mys3ql

@@ -1,8 +1,63 @@
 #!/usr/bin/env ruby-local-exec
 
+# Hmm, is there a better way which doesn't force rubygems?
+require 'rubygems'
+require 'bundler/setup'
+
 lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
 $LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
 
 require 'mys3ql'
+require 'choice'
+
+Choice.options do
+
+  header ''
+  header 'Specific options:'
+
+  option :full do
+    short '-f'
+    long '--full'
+    desc 'Dump database, push to S3, and clean up bin logs on S3'
+  end
+
+  option :incremental do
+    short '-i'
+    long '--incremental'
+    desc "Push mysql's bin logs to S3"
+  end
+
+  option :config do
+    short '-c'
+    long '--config=FILE'
+    desc 'Load configuration from YAML file (default: ~/.mys3ql)'
+    default '~/.mys3ql'
+  end
+
+  separator ''
+  separator 'General options:'
+
+  option :debug do
+    short '-d'
+    long '--debug'
+    desc 'Turn on debugging mode'
+  end
+
+  option :help do
+    long '--help'
+    desc 'Show this message'
+  end
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version'
+    action do
+      puts "mys3ql v#{Mys3ql::VERSION}"
+      exit
+    end
+  end
+
+end
 
-Mys3ql::Conductor.run ARGV
+Mys3ql::Conductor.run Choice.choices

data/lib/mys3ql/conductor.rb

@@ -5,26 +5,25 @@ require 'mys3ql/s3'
 module Mys3ql
   class Conductor
 
-    def self.run(args)
-      abort usage unless args.length == 1 && %w[ full inc ].include?(args.first)
-      conductor = Conductor.new
+    def self.run(options)
+      conductor = Conductor.new(options['config'])
+      conductor.debug = options[:debug]
 
-      command = args.first
-      if command == 'full'
+      if options['full']
         conductor.full
-      else
+      elsif options['incremental']
         conductor.incremental
       end
     end
 
-    def initialize
-      @config = Config.new
+    def initialize(config_file = nil)
+      @config = Config.new(config_file)
       @mysql = Mysql.new @config
       @s3 = S3.new @config
     end
 
     def full
-      @mysql.dump 
+      @mysql.dump
       @s3.push_dump_to_s3 @mysql.dump_file
       @mysql.clean_up_dump
       @s3.delete_bin_logs_on_s3
@@ -34,13 +33,8 @@ module Mys3ql
       @s3.push_bin_logs_to_s3
     end
 
-    def self.usage
-      <<END
-usage:
-  mys3ql full            - full backup, push to S3
-  mys3ql incremental     - push bin logs to S3
-END
+    def debug=(val)
+      @config.debug = val
     end
-
   end
 end

data/lib/mys3ql/config.rb

@@ -3,13 +3,26 @@ require 'yaml'
 module Mys3ql
   class Config
 
-    def initialize
-      @config = YAML.load_file config_file
+    def initialize(config_file = nil)
+      config_file = config_file || default_config_file
+      @config = YAML.load_file File.expand_path(config_file)
     rescue Errno::ENOENT
-      $stderr.puts "missing ~/.mys3ql config file"
+      $stderr.puts "missing config file #{config_file}"
       exit 1
     end
 
+    #
+    # General
+    #
+
+    def debug=(val)
+      @debug = val
+    end
+
+    def debugging?
+      @debug
+    end
+
     #
     # MySQL
     #
@@ -60,7 +73,7 @@ module Mys3ql
       @config['s3']
     end
 
-    def config_file
+    def default_config_file
       File.join "#{ENV['HOME']}", '.mys3ql'
     end
   end

data/lib/mys3ql/mysql.rb

@@ -19,7 +19,7 @@ module Mys3ql
 
     def clean_up_dump
       File.delete dump_file
-      debug "deleted #{dump_file}"
+      log "deleted #{dump_file}"
     end
 
     def dump_file

data/lib/mys3ql/s3.rb

@@ -15,7 +15,7 @@ module Mys3ql
       s3_file  = push_to_s3 dump_file, key
       if s3_file
         s3_file.copy @config.bucket, copy_key
-        debug "copied #{key} to #{copy_key}"
+        log "copied #{key} to #{copy_key}"
       end
     end
 
@@ -32,7 +32,7 @@ module Mys3ql
     def delete_bin_logs_on_s3
       bucket.files.all(:prefix => "#{bin_logs_prefix}").each do |file|
         file.destroy
-        debug "destroyed #{file.key}"
+        log "destroyed #{file.key}"
       end
     end
 
@@ -45,7 +45,7 @@ module Mys3ql
           :aws_secret_access_key => @config.secret_access_key,
           :aws_access_key_id     => @config.access_key_id
         )
-        debug 'connected to s3'
+        log 'connected to s3'
         s
       end
     end
@@ -53,7 +53,7 @@ module Mys3ql
     def bucket
       @directory ||= begin
         d = s3.directories.get @config.bucket  # assume bucket exists
-        debug "opened bucket #{@config.bucket}"
+        log "opened bucket #{@config.bucket}"
         d
       end
     end
@@ -66,7 +66,7 @@ module Mys3ql
           :body   => File.open(local_file_name),
           :public => false
         )
-        debug "pushed #{local_file_name} to #{s3_key}"
+        log "pushed #{local_file_name} to #{s3_key}"
         s3_file
       end
     end

data/lib/mys3ql/shell.rb

@@ -11,11 +11,7 @@ module Mys3ql
     end
 
     def log(message)
-      puts message if debugging?
-    end
-
-    def debugging?
-      true
+      puts message if @config.debugging?
     end
 
   end

data/lib/mys3ql/version.rb

@@ -1,3 +1,3 @@
 module Mys3ql
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mys3ql.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency 'choice', '~> 0.1.4'
   s.add_dependency 'fog', '~> 1.0.0'
   s.add_development_dependency 'rake'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mys3ql
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,13 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-26 00:00:00 +02:00
+date: 2011-10-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: choice
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fog
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,11 +49,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :runtime
-  requirement: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,7 +63,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  requirement: *id002
+  version_requirements: *id003
 description: Simple backup of your MySql database onto Amazon S3.
 email: 
 - boss@airbladesoftware.com
@@ -59,6 +75,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile