handy 0.0.2 → 0.0.3

data/README.md

@@ -1,11 +1,11 @@
 # handy provides follwing tools
 
-##`rake handy:db:restore file=xyz.sql.gz##
-
+##rake handy:db:restore file=xyz.sql.gz##
 restores the data and structure from file 
 
+##rake handy:db:db2db##
+restores the data from production database to staging database
  
-* cap production handy:db:pull
 
 
 Copyright (c) 2010 Neeraj Singh. See LICENSE for details.

data/Rakefile

@@ -4,13 +4,6 @@ require 'rake/testtask'
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test handy gem.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib' << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
 begin
   require 'jeweler'
   require './lib/handy/version'
@@ -23,42 +16,19 @@ begin
     gem.homepage = "http://github.com/neerajdotname/handy"
     gem.authors = ["Neeraj Singh"]
     gem.files = FileList["[A-Z]*", "{lib,test}/**/*", 'init.rb']
+
+    gem.add_dependency('aws', '>= 2.3.21')
+    gem.add_dependency('capistrano', '>= 2.5.19')
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "handy #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc 'Test handy gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
 end

data/lib/handy/backup.rb

@@ -0,0 +1,19 @@
+module Handy
+
+  class Backup
+    def self.run(env, file, backup_file)
+      util = Util.retrieve_db_info(env)
+      cmd = util.mysqldump_command
+      cmd << " --opt --skip-add-locks #{util.database} >> #{file}"
+      Util.execute_cmd(cmd)
+
+      #-c --stdout write on standard output, keep original files unchanged
+      #-q  quite
+      #-9 best compression
+      Util.execute_cmd "gzip -q9 #{file}"
+      Util.execute_cmd "mv #{file}.gz  #{backup_file}"
+      Util.pretty_msg "Backup done at #{File.expand_path(backup_file)}"
+    end
+  end
+
+end

data/lib/handy/db2db.rb

@@ -0,0 +1,18 @@
+module Handy
+  class Db2db
+    def self.run(from_env, to_env, file)
+      from_params = "-Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE"
+      from_util = Util.retrieve_db_info(from_env)
+      cmd = from_util.mysqldump_command
+      cmd << " #{from_params} #{from_util.database} > #{file} "
+      Util.execute_cmd(cmd)
+
+      to_util = Util.retrieve_db_info(to_env)
+      cmd = to_util.mysql_command
+      cmd << " < #{file}"
+      Util.execute_cmd(cmd)
+
+      Util.pretty_msg "#{to_env} database has been restored with #{from_env} database"
+    end
+  end
+end

data/lib/handy/dump2s3.rb

@@ -0,0 +1,9 @@
+require 'aws/s3'
+
+module Handy
+  class Dump2s3
+    def self.run(env, file)
+      ::AWS::S3::S3Object.store(file_name, file, bucket)
+    end
+  end
+end

data/lib/handy/railtie.rb

@@ -3,7 +3,6 @@ class Engine < Rails::Engine
   initializer :after_initialize do
   end
 
-
   rake_tasks do
     load 'handy/tasks.rb'
   end

data/lib/handy/restore.rb

@@ -0,0 +1,18 @@
+module Handy
+  class Restore
+    def self.run(file, env)
+      util = Util.retrieve_db_info(env)
+
+      if file =~ /\.gz/
+        puts "decompressing backup"
+        result = system("gzip -d #{file}" )
+        raise("backup decompression failed. msg: #{$?}" ) unless result
+      end
+
+      cmd = "#{util.mysql_command} < #{file.gsub('.gz','')}"
+
+      Util.execute_cmd(cmd)
+      Util.pretty_msg "database has been restored"
+    end
+  end
+end

data/lib/handy/s3.rb

@@ -0,0 +1,52 @@
+module Handy
+  class S3
+
+    attr_accessor :bucket_name, :access_key_id, :secret_access_key
+    def initialize
+      config = YAML.load_file(Rails.root.join('config', 'amazon_s3.yml'))
+      unless File.exists?(config)
+        raise "file config/amazon_s3.yml was not found. Create a file as per http://gist.github.com/619432"
+      end
+      self.new(config[env]['username'], config[env]['password'], config[env]['database'])
+      @bucket_name = config[env]['bucket_name']
+      @access_key_id = config[env]['access_key_id']
+      @secret_access_key = config[env]['secret_access_key']
+    end
+
+    def connect
+      AWS::S3::Base.establish_connection!(access_key_id, secret_access_key)
+      AWS::S3::Bucket.create(bucket)
+    end
+
+    def store
+      connect
+      AWS::S3::S3Object.store(file_name, file, bucket)
+    end
+
+    def fetch(file_name)
+      connected
+      AWS::S3::S3Object.find(file_name, bucket)
+
+      file = Tempfile.new("dump")
+      open(file.path, 'w') do |f|
+        AWS::S3::S3Object.stream(file_name, bucket) do |chunk|
+          f.write chunk
+        end
+      end
+      file
+    end
+
+    def list
+      connect
+      AWS::S3::Bucket.find(bucket).objects.collect {|x| x.path }
+    end
+
+    def delete(file_name)
+      if object = AWS::S3::S3Object.find(file_name, bucket)
+        object.delete
+      end
+    end
+
+  end
+
+end

data/lib/handy/tasks.rb

@@ -1,24 +1,3 @@
-class Util
-  attr_accessor :username, :password, :database
-  def initialize(*args)
-    @username, @password, @database = *args
-  end
-
-  def self.retrieve_db_info(database_yml_file, env)
-    config = YAML.load_file(database_yml_file)
-    [ config[env]['database'], config[env]['user'], config[env]['password'] ]
-  end
-
-  def mysql_command
-    password.blank? ? "mysql -u #{user} #{database}" : "mysql -u #{user}  -p'#{password}' #{database}"
-  end
-
-  def self.execute_cmd(cmd)
-    puts cmd
-    system cmd
-  end
-end
-
 namespace :handy do
   namespace :db do
 
@@ -27,53 +6,26 @@ namespace :handy do
       puts "Usage: rake handy:db:restore file=xxxxxxxxx.sql[.gz]"
       file_name = ENV['file']
       raise "file was not supplied. Check Usage." unless file_name
-      restore_file = File.join(Rails.root, 'tmp', file_name)
-      raise "file was not found" unless File.exists?(restore_file)
-
-      db_info = Util.retrieve_db_info("#{Rails.root}/config/database.yml", Rails.env)
-      database, user, password = db_info
-      util = Util.new(db_info)
-
-      if restore_file =~ /\.gz/
-        puts "decompressing backup"
-        result = system("gzip -d #{restore_file}" )
-        raise("backup decompression failed. msg: #{$?}" ) unless result
-      end
+      file = File.join(Rails.root, 'tmp', file_name)
+      raise "file was not found" unless File.exists?(file)
 
-      cmd = "#{util.mysql_command} < #{restore_file.gsub('.gz','')}"
-
-      Util.execute_cmd(cmd)
-      puts "database has been restored"
+      Handy::Restore.run(file, Rails.env)
     end
 
-    desc "bakup database to a file"
+    desc <<-DESC
+    This task backups the database to a file. It will keep a maximum of 10 backed up copies.
+    The files are backed up at shared directory on remote server.
+    This task should be executed before any deploy to production.
+    Files are backed at Rails.root/../../shared/db_backups on the remote server
+    DESC
     task :backup => [:environment] do
-      desc <<-DESC
-      This task backups the database to a file. It will keep a maximum of 10 backed up copies.
-      The files are backed up at shared directory on remote server.
-      This task should be executed before any deploy to production.
-      Files are backed at Rails.root/../../shared/db_backups on the remote server
-      DESC
-
       timestamp = ENV['timestamp'] || Time.zone.now.strftime("%Y-%m-%d-%H-%M-%S")
-      file_name = "#{timestamp}.sql"
+      file = "#{timestamp}.sql"
       backup_dir = File.join (Rails.root, 'tmp')
-
-      backup_file = File.join(backup_dir, "#{file_name}.gz")
-
       FileUtils.mkdir_p(backup_dir) unless File.exists?(backup_dir) && File.directory?(backup_dir)
+      backup_file = File.join(backup_dir, "#{file}.gz")
 
-      database, user, password = Util.retrieve_db_info("#{Rails.root}/config/database.yml", Rails.env)
-      cmd = "mysqldump --opt --skip-add-locks -u#{user} -p#{password} #{database} >> #{file_name}"
-      Util.execute_cmd(cmd)
-
-      #-c --stdout write on standard output, keep original files unchanged
-      #-q  quite
-      #-9 best compression
-      sh "gzip -q9 #{file_name}"
-      sh "mv #{file_name}.gz  #{backup_file}"
-      puts "Backup done at #{File.expand_path(backup_file)}"
-
+      Handy::Backup.run(Rails.env, file, backup_file)
     end
 
 
@@ -82,29 +34,19 @@ namespace :handy do
       puts "Usage: handy:db:db2db from_env=production to_env=staging"
       from_env = ENV['from_env'] || 'production'
       to_env = ENV['to_env'] || 'staging'
-      file_name = "#{Rails.root}/tmp/#{from_env}.data"
-      config_file =  "#{Rails.root}/config/database.yml"
-
-      db_config = YAML.load_file(config_file)
-
-      from_user = db_config[from_env]['username']
-      from_password = db_config[from_env]['password']
-      from_database =  db_config[from_env]['database']
-      from_params = "-Q --add-drop-table -O add-locks=FALSE -O lock-tables=FALSE"
+      file = "#{Rails.root}/tmp/#{from_env}.data"
 
-      cmd = "mysqldump -u #{from_user} -p#{from_password} #{from_params} #{from_database} > #{file_name} "
-      puts cmd
-      system cmd
-
-      to_username = db_config[to_env]['username']
-      to_password = db_config[to_env]['password']
-      to_database =  db_config[to_env]['database']
+      Handy::Db2db.run(from_env, to_env, file)
+    end
 
-      cmd = "mysql -u #{to_username} -p#{to_password} #{to_database} < #{file_name}"
-      puts cmd
-      system cmd
+    desc "Copy database dump to s3"
+    task :dump2s3 => :environment  do
+      timestamp = Time.zone.now.strftime("%Y-%m-%d-%H-%M-%S")
+      file = "#{timestamp}.sql.gz"
+      ENV['file'] = file
+      Rake::Task["handy:db:backup"].invoke
 
-      puts "#{to_env} database has been restored with #{from_env} database"
+      Handy::Dump2s3.run(Rails.env, file)
     end
 
   end

data/lib/handy/util.rb

@@ -0,0 +1,43 @@
+module Handy
+
+  class Util
+    attr_accessor :username, :password, :database
+    def initialize(*args)
+      @username, @password, @database = *args
+    end
+
+    def self.retrieve_db_info(env)
+      config = YAML.load_file(Rails.root.join('config', 'database.yml'))
+      self.new(config[env]['username'], config[env]['password'], config[env]['database'])
+    end
+
+    def mysql_command
+      a = ['mysql']
+      a << "-u #{username}"
+      a << "-p'#{password}'" unless password.blank?
+      a << database
+      a.join(' ')
+    end
+
+    def mysqldump_command
+      a = ['mysqldump']
+      a << "-u #{username}"
+      a << "-p'#{password}'" unless password.blank?
+      a.join(' ')
+    end
+
+    def self.execute_cmd(cmd)
+      puts "executing: #{cmd}"
+      system cmd
+    end
+
+    def self.pretty_msg(msg)
+      puts ''
+      puts '*'*100
+      puts ('*' << ' '*5 << msg)
+      puts '*'*100
+      puts ''
+    end
+  end
+
+end

data/lib/handy/version.rb

@@ -1,3 +1,3 @@
 module Handy
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/handy.rb

@@ -1 +1,7 @@
+require 'handy/util'
+require 'handy/backup'
+require 'handy/restore'
+require 'handy/s3'
+require 'handy/db2db'
+require 'handy/dump2s3'
 require 'handy/railtie'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: handy
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Neeraj Singh
@@ -15,10 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-07 00:00:00 -04:00
+date: 2010-10-11 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 2
+        - 3
+        - 21
+        version: 2.3.21
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 2
+        - 5
+        - 19
+        version: 2.5.19
+  type: :runtime
+  version_requirements: *id002
 description: handy tools that gets job done
 email: neerajdotname@gmail.com
 executables: []
@@ -33,8 +64,14 @@ files:
 - README.md
 - Rakefile
 - lib/handy.rb
+- lib/handy/backup.rb
+- lib/handy/db2db.rb
+- lib/handy/dump2s3.rb
 - lib/handy/railtie.rb
+- lib/handy/restore.rb
+- lib/handy/s3.rb
 - lib/handy/tasks.rb
+- lib/handy/util.rb
 - lib/handy/version.rb
 - test/helper.rb
 - test/test_handy.rb