webtranslateit-safe 0.4.0 → 0.4.1

data/lib/webtranslateit/safe/sftp.rb

@@ -1,7 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
     class Sftp < Sink
 
       protected
@@ -15,42 +13,38 @@ module WebTranslateIt
       end
 
       def save
-        raise 'pipe-streaming not supported for SFTP.' unless @backup.path
+        raise RuntimeError, 'pipe-streaming not supported for SFTP.' unless @backup.path
 
         puts "Uploading #{host}:#{full_path} via SFTP" if verbose? || dry_run?
 
-        return if dry_run? || local_only?
-
-        opts = {}
-        opts[:password] = password if password
-        opts[:port] = port if port
-        Net::SFTP.start(host, user, opts) do |sftp|
-          puts "Sending #{@backup.path} to #{full_path}" if verbose?
-          begin
-            sftp.upload! @backup.path, full_path
-          rescue Net::SFTP::StatusException
-            puts "Ensuring remote path (#{path}) exists" if verbose?
-            # mkdir -p
-            folders = path.split('/')
-            folders.each_index do |i|
-              folder = folders[0..i].join('/')
-              puts "Creating #{folder} on remote" if verbose?
-              begin
-                sftp.mkdir!(folder)
-              rescue StandardError
-                Net::SFTP::StatusException
+        unless dry_run? || local_only?
+          opts = {}
+          opts[:password] = password if password
+          opts[:port] = port if port
+          Net::SFTP.start(host, user, opts) do |sftp|
+            puts "Sending #{@backup.path} to #{full_path}" if verbose?
+            begin
+              sftp.upload! @backup.path, full_path
+            rescue Net::SFTP::StatusException
+              puts "Ensuring remote path (#{path}) exists" if verbose?
+              # mkdir -p
+              folders = path.split('/')
+              folders.each_index do |i|
+                folder = folders[0..i].join('/')
+                puts "Creating #{folder} on remote" if verbose?
+                sftp.mkdir!(folder) rescue Net::SFTP::StatusException
               end
+              retry
             end
-            retry
           end
+          puts '...done' if verbose?
         end
-        puts '...done' if verbose?
       end
 
       def cleanup
         return if local_only? || dry_run?
 
-        return unless (keep = config[:keep, :sftp])
+        return unless keep = config[:keep, :sftp]
 
         puts "listing files: #{host}:#{base}*" if verbose?
         opts = {}
@@ -59,11 +53,11 @@ module WebTranslateIt
         Net::SFTP.start(host, user, opts) do |sftp|
           files = sftp.dir.glob(path, File.basename("#{base}*"))
 
-          puts(files.collect(&:name)) if verbose?
+          puts files.collect {|x| x.name } if verbose?
 
-          files = files
-                  .collect(&:name)
-                  .sort
+          files = files.
+            collect {|x| x.name }.
+            sort
 
           cleanup_with_limit(files, keep) do |f|
             file = File.join(path, f)
@@ -90,7 +84,5 @@ module WebTranslateIt
       end
 
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/sink.rb

@@ -1,7 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
     class Sink < Stream
 
       def process
@@ -17,7 +15,7 @@ module WebTranslateIt
       # base is used in 'cleanup' to find all files that begin with base. the '.'
       # at the end is essential to distinguish b/w foo.* and foobar.* archives for example
       def base
-        @base ||= File.join(path, "#{File.basename(@backup.filename).split('.').first}.")
+        @base ||= File.join(path, File.basename(@backup.filename).split('.').first + '.')
       end
 
       def full_path
@@ -25,16 +23,13 @@ module WebTranslateIt
       end
 
       # call block on files to be removed (all except for the LAST 'limit' files
-      def cleanup_with_limit(files, limit, &)
+      def cleanup_with_limit(files, limit, &block)
         return unless files.size > limit
 
         to_remove = files[0..(files.size - limit - 1)]
         # TODO: validate here
-        to_remove.each(&)
+        to_remove.each(&block)
       end
-
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/source.rb

@@ -1,14 +1,10 @@
 module WebTranslateIt
-
   module Safe
-
     class Source < Stream
 
       attr_accessor :id
-
       def initialize(id, config)
-        @id = id.to_s
-        @config = config
+        @id, @config = id.to_s, config
       end
 
       def timestamp
@@ -25,13 +21,12 @@ module WebTranslateIt
 
       def backup
         return @backup if @backup
-
         @backup = Backup.new(
-          id: @id,
-          kind: kind,
-          extension: extension,
-          command: command,
-          timestamp: timestamp
+          :id        => @id,
+          :kind      => kind,
+          :extension => extension,
+          :command   => command,
+          :timestamp => timestamp
         )
         # can't do this in the initializer hash above since
         # filename() calls expand() which requires @backup
@@ -40,12 +35,13 @@ module WebTranslateIt
         @backup
       end
 
+      protected
+
       def self.human_name
         name.split('::').last.downcase
       end
 
     end
-
   end
-
 end
+

data/lib/webtranslateit/safe/stream.rb

@@ -1,22 +1,17 @@
 module WebTranslateIt
-
   module Safe
-
     class Stream
 
       attr_accessor :config, :backup
-
       def initialize(config, backup)
-        @config = config
-        @backup = backup
+        @config, @backup = config, backup
       end
-
       # FIXME: move to Backup
       def expand(path)
-        path
-          .gsub(/:kind\b/, @backup.kind.to_s)
-          .gsub(/:id\b/, @backup.id.to_s)
-          .gsub(/:timestamp\b/, @backup.timestamp)
+        path .
+        gsub(/:kind\b/, @backup.kind.to_s) .
+        gsub(/:id\b/, @backup.id.to_s) .
+        gsub(/:timestamp\b/, @backup.timestamp)
       end
 
       private
@@ -32,9 +27,6 @@ module WebTranslateIt
       def dry_run?
         config[:dry_run]
       end
-
     end
-
   end
-
-end
+end

data/lib/webtranslateit/safe/svndump.rb

@@ -1,17 +1,13 @@
 module WebTranslateIt
-
   module Safe
-
     class Svndump < Source
 
       def command
         "svnadmin dump #{config[:options]} #{config[:repo_path]}"
       end
 
-      def extension = '.svn'
+      def extension; '.svn'; end
 
     end
-
   end
-
 end

data/lib/webtranslateit/safe/tmp_file.rb

@@ -1,10 +1,7 @@
 require 'tmpdir'
 module WebTranslateIt
-
   module Safe
-
     module TmpFile
-
       @keep_files = []
 
       def self.tmproot
@@ -15,21 +12,22 @@ module WebTranslateIt
         begin
           FileUtils.remove_entry_secure tmproot
         rescue ArgumentError => e
-          raise unless e.message =~ /parent directory is world writable/
-
-          puts <<~ERR
+          if e.message =~ /parent directory is world writable/
+            puts <<-ERR
 
 
-            ********************************************************************************
-            It looks like you have wrong permissions on your TEMP directory.  The usual
-            case is when you have world writable TEMP directory withOUT the sticky bit.
+********************************************************************************
+It looks like you have wrong permissions on your TEMP directory.  The usual
+case is when you have world writable TEMP directory withOUT the sticky bit.
 
-            Try "chmod +t" on it.
+Try "chmod +t" on it.
 
-            ********************************************************************************
+********************************************************************************
 
-          ERR
-          raise
+ERR
+          else
+            raise
+          end
         end
         @tmproot = nil
       end
@@ -45,9 +43,6 @@ module WebTranslateIt
         @keep_files << file # so that it will not get gcollected and removed from filesystem until the end
         file.path
       end
-
     end
-
   end
-
 end

data/lib/webtranslateit/safe/version.rb

@@ -1,9 +1,5 @@
 module WebTranslateIt
-
   module Safe
-
-    VERSION = '0.4.0'
-
+    VERSION = '0.4.1'
   end
-
 end

data/lib/webtranslateit/safe.rb

@@ -38,25 +38,25 @@ require 'webtranslateit/safe/sftp'
 require 'webtranslateit/safe/ftp'
 
 module WebTranslateIt
-
   module Safe
-
     ROOT = File.join(File.dirname(__FILE__), '..', '..')
 
-    def safe(&)
-      Config::Node.new(&)
+    def safe(&block)
+      Config::Node.new(&block)
     end
 
     def process(config)
+
       [[Mysqldump, [:mysqldump, :databases]],
        [Pgdump,    [:pgdump,    :databases]],
        [Mongodump, [:mongodump, :databases]],
        [Archive,   [:tar,       :archives]],
-       [Svndump,   [:svndump,   :repos]]].each do |klass, path|
-        next unless (collection = config[*path])
-
-        collection.each do |name, c|
-          klass.new(name, c).backup.run(c, :gpg, :gzip, :local, :s3, :cloudfiles, :sftp, :ftp)
+       [Svndump,   [:svndump,   :repos]]
+      ].each do |klass, path|
+        if collection = config[*path]
+          collection.each do |name, c|
+            klass.new(name, c).backup.run(c, :gpg, :gzip, :local, :s3, :cloudfiles, :sftp, :ftp)
+          end
         end
       end
 
@@ -64,7 +64,5 @@ module WebTranslateIt
     end
     module_function :safe
     module_function :process
-
   end
-
 end

data/spec/webtranslateit/safe/archive_spec.rb

@@ -4,9 +4,9 @@ describe WebTranslateIt::Safe::Archive do
 
   def def_config
     {
-      options: 'OPTS',
-      files: 'apples',
-      exclude: 'oranges'
+      :options => 'OPTS',
+      :files   => 'apples',
+      :exclude => 'oranges'
     }
   end
 
@@ -19,49 +19,49 @@ describe WebTranslateIt::Safe::Archive do
   describe :backup do
     before(:each) do
       @archive = archive
-      stub(@archive).timestamp { 'NOW' }
+      stub(@archive).timestamp {'NOW'}
     end
 
     {
-      id: 'foo',
-      kind: 'archive',
-      extension: '.tar',
-      filename: 'archive-foo.NOW',
-      command: 'tar -cf - OPTS --exclude=oranges apples'
+      :id => 'foo',
+      :kind => 'archive',
+      :extension => '.tar',
+      :filename => 'archive-foo.NOW',
+      :command => 'tar -cf - OPTS --exclude=oranges apples',
     }.each do |k, v|
-      it "sets #{k} to #{v}" do
+      it "should set #{k} to #{v}" do
         @archive.backup.send(k).should == v
       end
     end
   end
 
   describe :tar_exclude_files do
-    it "returns '' when no excludes" do
+    it "should return '' when no excludes" do
       archive(:foo, {}).send(:tar_exclude_files).should == ''
     end
 
-    it 'accepts single exclude as string' do
-      archive(:foo, {exclude: 'bar'}).send(:tar_exclude_files).should == '--exclude=bar'
+    it 'should accept single exclude as string' do
+      archive(:foo, {:exclude => 'bar'}).send(:tar_exclude_files).should == '--exclude=bar'
     end
 
-    it 'accepts multiple exclude as array' do
-      archive(:foo, {exclude: ['foo', 'bar']}).send(:tar_exclude_files).should == '--exclude=foo --exclude=bar'
+    it 'should accept multiple exclude as array' do
+      archive(:foo, {:exclude => ['foo', 'bar']}).send(:tar_exclude_files).should == '--exclude=foo --exclude=bar'
     end
   end
 
   describe :tar_files do
-    it 'raises RuntimeError when no files' do
+    it 'should raise RuntimeError when no files' do
       lambda {
         archive(:foo, {}).send(:tar_files)
       }.should raise_error(RuntimeError, 'missing files for tar')
     end
 
-    it 'accepts single file as string' do
-      archive(:foo, {files: 'foo'}).send(:tar_files).should == 'foo'
+    it 'should accept single file as string' do
+      archive(:foo, {:files => 'foo'}).send(:tar_files).should == 'foo'
     end
 
-    it 'accepts multiple files as array' do
-      archive(:foo, {files: ['foo', 'bar']}).send(:tar_files).should == 'foo bar'
+    it 'should accept multiple files as array' do
+      archive(:foo, {:files => ['foo', 'bar']}).send(:tar_files).should == 'foo bar'
     end
   end
 end

data/spec/webtranslateit/safe/cloudfiles_spec.rb

@@ -172,4 +172,4 @@ describe WebTranslateIt::Safe::Cloudfiles do
       @cloudfiles.send(:save)
     end
   end
-end
+end

data/spec/webtranslateit/safe/config_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe WebTranslateIt::Safe::Config do
-  it 'parses example config' do
+  it 'should parse example config' do
     config = WebTranslateIt::Safe::Config::Node.new do
 
       dry_run false
@@ -47,7 +47,7 @@ describe WebTranslateIt::Safe::Config do
         database :blog
 
         database :production do
-          keep local: 3
+          keep :local => 3
 
           gpg do
             password 'custom-production-pass'
@@ -69,7 +69,7 @@ describe WebTranslateIt::Safe::Config do
         database :blog
 
         database :production do
-          keep local: 3
+          keep :local => 3
 
           skip_tables [:logger_exceptions, :request_logs]
         end
@@ -102,7 +102,7 @@ describe WebTranslateIt::Safe::Config do
         end
 
         archive :misc do
-          files ['/backup/*.rb']
+          files [ '/backup/*.rb' ]
         end
       end
 
@@ -125,13 +125,13 @@ describe WebTranslateIt::Safe::Config do
         'key' => 's3 key',
         'secret' => 'secret',
         'bucket' => 'bucket',
-        'path' => 'path1'
+        'path' => 'path1',
       },
 
       'sftp' => {
         'user' => 'sftp user',
         'password' => 'sftp password',
-        'host' => 'sftp host'
+        'host' => 'sftp host',
       },
 
       'gpg' => {'password' => 'astrails', 'key' => 'gpg-key'},
@@ -149,11 +149,11 @@ describe WebTranslateIt::Safe::Config do
         'databases' => {
           'blog' => {},
           'production' => {
-            'keep' => {'local' => 3},
-            'gpg' => {'password' => 'custom-production-pass'},
-            'skip_tables' => ['logger_exceptions', 'request_logs']
-          }
-        }
+           'keep' => {'local' => 3},
+           'gpg' => {'password' => 'custom-production-pass'},
+            'skip_tables' => ['logger_exceptions', 'request_logs'],
+          },
+        },
       },
 
       'pgdump' => {
@@ -166,15 +166,15 @@ describe WebTranslateIt::Safe::Config do
         'databases' => {
           'blog' => {},
           'production' => {
-            'keep' => {'local' => 3},
-            'skip_tables' => ['logger_exceptions', 'request_logs']
-          }
-        }
+           'keep' => {'local' => 3},
+            'skip_tables' => ['logger_exceptions', 'request_logs'],
+          },
+        },
       },
 
       'svndump' => {
         'repos' => {
-          'my_repo' => {
+          'my_repo'=> {
             'repo_path' => '/home/svn/my_repo'
           }
         }
@@ -187,10 +187,10 @@ describe WebTranslateIt::Safe::Config do
           'dot-configs' => {'files' => ['/home/*/.[^.]*']},
           'blog' => {
             'files' => ['/var/www/blog.astrails.com/'],
-            'exclude' => ['/var/www/blog.astrails.com/log', '/var/www/blog.astrails.com/tmp']
+            'exclude' => ['/var/www/blog.astrails.com/log', '/var/www/blog.astrails.com/tmp'],
           },
-          'misc' => {'files' => ['/backup/*.rb']}
-        }
+          'misc' => { 'files' => ['/backup/*.rb'] },
+        },
       },
 
       'mongodump' => {
@@ -206,7 +206,7 @@ describe WebTranslateIt::Safe::Config do
     config.to_hash.should == expected
   end
 
-  it 'makes an array from multivalues' do
+  it 'should make an array from multivalues' do
     config = WebTranslateIt::Safe::Config::Node.new do
       skip_tables 'a'
       skip_tables 'b'
@@ -219,13 +219,13 @@ describe WebTranslateIt::Safe::Config do
     expected = {
       'skip_tables' => ['a', 'b'],
       'files' => ['/foo', '/bar'],
-      'exclude' => ['/foo/bar', '/foo/bar/baz']
+      'exclude' => ['/foo/bar', '/foo/bar/baz'],
     }
 
     config.to_hash.should == expected
   end
 
-  it 'raises error on key duplication' do
+  it 'should raise error on key duplication' do
     proc do
       WebTranslateIt::Safe::Config::Node.new do
         path 'foo'
@@ -234,7 +234,7 @@ describe WebTranslateIt::Safe::Config do
     end.should raise_error(ArgumentError, "duplicate value for 'path'")
   end
 
-  it 'accepts hash as data' do
+  it 'should accept hash as data' do
     WebTranslateIt::Safe::Config::Node.new do
       tar do
         archive 'blog', files: 'foo', exclude: ['aaa', 'bbb']
@@ -251,7 +251,7 @@ describe WebTranslateIt::Safe::Config do
     }
   end
 
-  it 'accepts hash as data and a block' do
+  it 'should accept hash as data and a block' do
     WebTranslateIt::Safe::Config::Node.new do
       tar do
         archive 'blog', files: 'foo' do
@@ -270,21 +270,21 @@ describe WebTranslateIt::Safe::Config do
     }
   end
 
-  it 'accepts multiple levels of data hash' do
+  it 'should accept multiple levels of data hash' do
     config = WebTranslateIt::Safe::Config::Node.new nil, tar: {
-      s3: {bucket: '_bucket', key: '_key', secret: '_secret'},
-      keep: {s3: 2}
+      s3: { bucket: '_bucket', key: '_key', secret: '_secret', },
+      keep: { s3: 2 }
     }
 
     config.to_hash.should == {
       'tar' => {
-        's3' => {'bucket' => '_bucket', 'key' => '_key', 'secret' => '_secret'},
-        'keep' => {'s3' => 2}
+        's3' => { 'bucket' => '_bucket', 'key' => '_key', 'secret' => '_secret', },
+        'keep' => { 's3' => 2 }
       }
     }
   end
-
-  it 'sets multi value as array' do
+  
+  it 'should set multi value as array' do
     config = WebTranslateIt::Safe::Config::Node.new do
       tar do
         archive 'foo' do