deploy_kit 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,19 @@
+CHANGELOG
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+config/amazon_s3.yml.sample
+config/deploy_kit.yml.sample
+deploy_kit.gemspec
+init.rb
+lib/deploy_kit.rb
+lib/deploy_kit/backup_log.rb
+lib/deploy_kit/backup_mysql.rb
+lib/deploy_kit/clear_file.rb
+lib/deploy_kit/deploy_kit.rb
+lib/deploy_kit/log_monitor.rb
+lib/deploy_kit/s3_storage.rb
+tasks/deploy_kit_tasks.rake
+test/deploy_kit_test.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,42 @@
+==DeployKit
+
+Introduction
+
+  sudo gem install deploy_kit --source http://gemcutter.org
+
+or
+
+  sudo gem install gemcutter
+  sudo gem tumble
+  sudo gem install deploy_kit
+
+
+Add gem require to config/environment.rb
+
+  config.gem "deploy_kit", :source => 'http://gemcutter.org'
+
+
+Add below codes to your rails's Rakefile
+
+  Dir["#{Gem.searcher.find('deploy_kit').full_gem_path}/tasks/*.rake"].each { |ext| load ext }
+
+
+==Example
+
+  rake -T deploy # View deploy tasks
+
+  rake deploy:backup_log
+  rake deploy:backup_mysql
+  rake deploy:clear
+  rake deploy:setup
+
+
+==Reference
+
+http://github.com/gravelpup/backup_fu
+
+==Requirement
+
+http://github.com/marcel/aws-s3
+
+Copyright (c) 2009 [alvin@agideo], released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('deploy_kit', '0.1.0') do |p|
+  p.description    = "Generate a deploy kit"
+  p.url            = "http://github.com/jimjin/deploy_kit"
+  p.author         = "Jim Jin"
+  p.email          = "jim.jin2006@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/config/amazon_s3.yml.sample

@@ -0,0 +1,4 @@
+production:
+  bucket_name: <app name>
+  access_key_id: xxx
+  secret_access_key: xxx

data/config/deploy_kit.yml.sample

@@ -0,0 +1,6 @@
+production:
+  app_name: <app name>
+  allow_time_ms: 1000
+  from_mail: xxx@gmail.com
+  to_mail: xxx@googlegroups.com
+  default_clear_days: 7

data/deploy_kit.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deploy_kit}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Jin"]
+  s.date = %q{2009-11-18}
+  s.description = %q{Generate a deploy kit}
+  s.email = %q{jim.jin2006@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/deploy_kit.rb", "lib/deploy_kit/backup_log.rb", "lib/deploy_kit/backup_mysql.rb", "lib/deploy_kit/clear_file.rb", "lib/deploy_kit/deploy_kit.rb", "lib/deploy_kit/log_monitor.rb", "lib/deploy_kit/s3_storage.rb", "tasks/deploy_kit_tasks.rake"]
+  s.files = ["CHANGELOG", "MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "config/amazon_s3.yml.sample", "config/deploy_kit.yml.sample", "deploy_kit.gemspec", "init.rb", "lib/deploy_kit.rb", "lib/deploy_kit/backup_log.rb", "lib/deploy_kit/backup_mysql.rb", "lib/deploy_kit/clear_file.rb", "lib/deploy_kit/deploy_kit.rb", "lib/deploy_kit/log_monitor.rb", "lib/deploy_kit/s3_storage.rb", "tasks/deploy_kit_tasks.rake", "test/deploy_kit_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/jimjin/deploy_kit}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Deploy_kit", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{deploy_kit}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Generate a deploy kit}
+  s.test_files = ["test/test_helper.rb", "test/deploy_kit_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'deploy_kit'

data/lib/deploy_kit.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'logger'
+require 'yaml'
+require 'active_support'
+require 'mime/types'
+require 'erb'
+require 'aws/s3'
+require 'deploy_kit/deploy_kit'
+require 'deploy_kit/backup_mysql'
+require 'deploy_kit/backup_log'
+require 'deploy_kit/s3_storage'
+require 'deploy_kit/log_monitor'
+require 'deploy_kit/clear_file'

data/lib/deploy_kit/backup_log.rb

@@ -0,0 +1,15 @@
+class BackupLog < DeployKit
+  def final_filename
+    File.join(backup_path, "#{@fu_conf[:app_name]}_backup_log_#{timestamp}.tar.gz")
+  end
+
+  def cmd
+    "tar -zcf %s log/*.log" % [final_filename]
+  end
+
+  def backup(store)
+    puts cmd if @verbose
+    `#{cmd}`
+    S3storage.new.put(final_filename) if store == "s3"
+  end
+end

data/lib/deploy_kit/backup_mysql.rb

@@ -0,0 +1,29 @@
+class BackupMysql < DeployKit
+  def final_filename
+    File.join(backup_path, "#{@fu_conf[:app_name]}_backup_mysql_#{timestamp}.gz")
+  end
+
+  def cmd
+    """mysqldump -u\"#{@db_conf[:username]}\" -p\"#{@db_conf[:password]}\" \
+    --default-character-set=utf8 --opt --extended-insert=false \
+    --triggers -R --hex-blob --single-transaction #{options} #{@db_conf[:database]} | gzip \
+    > #{final_filename}
+    """
+  end
+
+  def backup(store)
+    puts cmd if @verbose
+    `#{cmd}`
+    S3storage.new.put(final_filename) if store == "s3"
+  end
+
+  def options
+    options = []
+
+    if !@db_conf[:socket].blank?
+      options << "--socket=#{@db_conf[:socket]}"
+    end
+
+    options.join(" ")
+  end
+end

data/lib/deploy_kit/clear_file.rb

@@ -0,0 +1,19 @@
+class ClearFile < DeployKit
+  def final_filename
+    File.join(backup_path, "*.gz")
+  end
+
+  def get_clear_days
+     @fu_conf[:default_clear_days].to_i
+  end
+
+  def cmd
+    "find %s -type f -mtime +%s -exec rm {} \\;"
+  end
+
+  def clear(path, days)
+    full_cmd = cmd % [path || final_filename, days || get_clear_days]
+    puts full_cmd if @verbose
+    `#{full_cmd}`
+  end
+end

data/lib/deploy_kit/deploy_kit.rb

@@ -0,0 +1,69 @@
+class DeployKitConfigError < Exception; end
+
+class DeployKit
+  def initialize
+    db_conf = YAML.load_file(File.join(RAILS_ROOT, 'config', 'database.yml'))
+    @db_conf = db_conf[RAILS_ENV].symbolize_keys
+
+    raw_config = File.read(File.join(RAILS_ROOT, 'config', 'deploy_kit.yml'))
+    erb_config = ERB.new(raw_config).result
+    fu_conf    = YAML.load(erb_config)
+    @fu_conf   = fu_conf[RAILS_ENV].symbolize_keys
+
+    @s3_conf = YAML.load_file(File.join(RAILS_ROOT, 'config', 'amazon_s3.yml'))[RAILS_ENV].symbolize_keys
+    @fu_conf[:s3_bucket] ||= @s3_conf[:bucket_name]
+    @fu_conf[:aws_access_key_id] ||= @s3_conf[:access_key_id]
+    @fu_conf[:aws_secret_access_key] ||= @s3_conf[:secret_access_key]
+
+    @fu_conf[:mysqldump_options] ||= '--complete-insert --skip-extended-insert'
+    @verbose = !@fu_conf[:verbose].nil?
+    @fu_conf[:keep_files] ||= 5
+    check_conf
+    create_dirs
+  end
+
+  def check_conf
+    @fu_conf[:s3_bucket] = ENV['s3_bucket'] unless ENV['s3_bucket'].blank?
+    if @fu_conf[:app_name] == 'replace_me'
+      raise DeployKitConfigError, 'Application name (app_name) key not set in config/deploy_kit.yml.'
+    elsif @fu_conf[:s3_bucket] == 'some-s3-bucket'
+      raise DeployKitConfigError, 'S3 bucket (s3_bucket) not set in config/deploy_kit.yml.  This bucket must be created using an external S3 tool like S3 Browser for OS X, or JetS3t (Java-based, cross-platform).'
+    else
+      # Check for access keys set as environment variables:
+      if ENV.keys.include?('AMAZON_ACCESS_KEY_ID') && ENV.keys.include?('AMAZON_SECRET_ACCESS_KEY')
+        @fu_conf[:aws_access_key_id] = ENV['AMAZON_ACCESS_KEY_ID']
+        @fu_conf[:aws_secret_access_key] = ENV['AMAZON_SECRET_ACCESS_KEY']
+      elsif @fu_conf[:aws_access_key_id].blank? || @fu_conf[:aws_access_key_id].include?('--replace me') || @fu_conf[:aws_secret_access_key].include?('--replace me')
+        raise DeployKitConfigError, 'AWS Access Key Id or AWS Secret Key not set in config/deploy_kit.yml.'
+      end
+    end
+  end
+
+  def timestamp
+    @timestamp ||= Time.now.strftime("%Y-%m-%d_%H%M%S")
+  end
+
+  def create_dirs
+    ensure_directory_exists(backup_path)
+  end
+
+  def ensure_directory_exists(dir)
+    FileUtils.mkdir_p(dir) unless File.exist?(dir)
+  end
+
+  def backup_path
+    @fu_conf[:dump_base_path] || File.join(RAILS_ROOT, 'backup')
+  end
+
+  def backup(store)
+    raise 'Called abstract method: backup'
+  end
+
+  def cmd
+    raise 'Called abstract method: cmd'
+  end
+
+  def final_filename
+    raise 'Called abstract method: final_filename'
+  end
+end

data/lib/deploy_kit/log_monitor.rb

@@ -0,0 +1,51 @@
+class LogMonitor < DeployKit
+  def check_warning(will_sent = nil)
+    cmd = "cat #{log_path} | grep \"200 OK\" | awk '{print $3 \" \" $0}' | sort -nr | head -n 10"
+    puts cmd if @verbose
+    lines = `#{cmd}`
+    return if !need_send?(lines)
+
+    if !will_sent.blank?
+      send_mail(lines)
+    else
+      puts lines
+    end
+  end
+
+  def allow_time
+    @fu_conf[:allow_time_ms].to_i
+  end
+
+  def log_path
+    File.join(RAILS_ROOT, "log", "production.log")
+  end
+
+  def need_send?(lines)
+    result = nil
+    time = lines.to_s.split(" ").first
+
+    return false if time.blank?
+    if is_ms?(time)
+      if time.to_f > allow_time
+        result = true
+      end
+    else
+      if time.to_f > (allow_time / 1000)
+        result = true
+      end
+    end
+
+    result
+  end
+
+  def send_mail(lines)
+    cmd = "echo \"#{lines}\" | mail #{@fu_conf[:to_mail]} -s \"#{@timestamp} #{@fu_conf[:app_name]} log \" -a \"From: #{@fu_conf[:from_mail]}\""
+    puts cmd if @verbose
+    `#{cmd}`
+  end
+
+  private
+    def is_ms?(time)
+      time.index("ms")
+    end
+end

data/lib/deploy_kit/s3_storage.rb

@@ -0,0 +1,23 @@
+class S3storage < DeployKit
+  def put(file)
+    s3_connection
+    file_name = File.basename(file)
+    AWS::S3::S3Object.store(
+      file_name, open(file), @fu_conf[:s3_bucket]
+    )
+  end
+
+  def s3_connection
+    @s3 ||= AWS::S3::Base.establish_connection!(
+      :access_key_id     => @fu_conf[:aws_access_key_id],
+      :secret_access_key => @fu_conf[:aws_secret_access_key]
+    )
+  end
+
+  def list
+    s3_connection
+    AWS::S3::Bucket.find(@fu_conf[:s3_bucket]).objects.each do |file|
+      puts "#{file.key.to_s.ljust(50)}  #{file.size}"
+    end
+  end
+end

data/tasks/deploy_kit_tasks.rake

@@ -0,0 +1,59 @@
+require 'fileutils'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'deploy_kit'
+
+namespace :deploy do
+  desc "rake deploy:setup copy amazon_s3.yml.sample, deploy_kit.yml.sample"
+  task :setup do
+    ['amazon_s3.yml.sample', 'deploy_kit.yml.sample'].each do |file|
+      srcfile = File.join(File.dirname(__FILE__), '..', 'config', file)
+      destfile = File.join(RAILS_ROOT, 'config', file)
+
+      if File.exist?(destfile)
+        puts "\nTarget file: #{destfile}\n ... already exists.  Aborting.\n\n"
+      else
+        FileUtils.cp(srcfile, destfile)
+        puts "cp config/#{file} config/#{file.gsub('.sample', '')}"
+      end
+    end
+  end
+
+  desc "rake deploy:backup_mysql or rake deploy:backup_mysql STORE=s3"
+  task :backup_mysql do
+    BackupMysql.new.backup(ENV["STORE"])
+  end
+
+  desc "rake deploy:backup_log or rake deploy:backup_log STORE=s3"
+  task :backup_log do
+    BackupLog.new.backup(ENV["STORE"])
+  end
+
+  desc "Clear files in date, rake deploy:clear or rake deploy:clear BACKUP_PATH=/tmp/*.log DAYS=10 defaut BACKUP_PATH: RAILS_ROOT/config/deploy_kit.yml key dump_base_path or 'RAILS_ROOT/backup/*.gz' DAYS: config key default_clear_days"
+  task :clear do
+    ClearFile.new.clear(ENV["BACKUP_PATH"], ENV["DAYS"])
+  end
+end
+
+namespace :s3 do
+  desc "list"
+  task :list do
+    S3storage.new.list
+  end
+
+  desc "store file use ENV like: rake s3:put FILE=/tmp/xx.tar.gz"
+  task :put do
+    S3storage.new.put(ENV["FILE"])
+  end
+
+  desc "download file like: rake s3:get KEY=xx.tar.gz"
+  task :get do
+    puts "..." # TODO impl
+  end
+end
+
+namespace :monitor do
+  desc "or rake monitor:slow_log SEND_MAIL=true"
+  task :slow_log do
+    LogMonitor.new.check_warning(ENV["SEND_MAIL"])
+  end
+end

data/test/deploy_kit_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class DeployKitTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: deploy_kit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jim Jin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-18 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Generate a deploy kit
+email: jim.jin2006@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README.rdoc
+- lib/deploy_kit.rb
+- lib/deploy_kit/backup_log.rb
+- lib/deploy_kit/backup_mysql.rb
+- lib/deploy_kit/clear_file.rb
+- lib/deploy_kit/deploy_kit.rb
+- lib/deploy_kit/log_monitor.rb
+- lib/deploy_kit/s3_storage.rb
+- tasks/deploy_kit_tasks.rake
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- config/amazon_s3.yml.sample
+- config/deploy_kit.yml.sample
+- deploy_kit.gemspec
+- init.rb
+- lib/deploy_kit.rb
+- lib/deploy_kit/backup_log.rb
+- lib/deploy_kit/backup_mysql.rb
+- lib/deploy_kit/clear_file.rb
+- lib/deploy_kit/deploy_kit.rb
+- lib/deploy_kit/log_monitor.rb
+- lib/deploy_kit/s3_storage.rb
+- tasks/deploy_kit_tasks.rake
+- test/deploy_kit_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jimjin/deploy_kit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Deploy_kit
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: deploy_kit
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generate a deploy kit
+test_files: 
+- test/test_helper.rb
+- test/deploy_kit_test.rb