capones_recipes 0.1.0

data/Capfile

@@ -0,0 +1,7 @@
+#
+# Capfile for running base install recipe
+#
+
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+
+require 'capones_recipes'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Roman Simecek
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= capones-recipes
+
+Description goes here.
+
+== Contributing to capones-recipes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Roman Simecek. See LICENSE.txt for
+further details.
+

data/lib/capones_recipes.rb

@@ -0,0 +1,5 @@
+require 'capistrano'
+require 'capistrano/cli'
+require 'capistrano_colors'
+
+Dir.glob(File.join(File.dirname(__FILE__), '/recipes/*.rb')).sort.each { |f| load f }

data/lib/recipes/database_yml.rb

@@ -0,0 +1,27 @@
+Capistrano::Configuration.instance.load do
+  before "deploy:setup", :db
+  after "deploy:update_code", "db:symlink"
+
+  namespace :db do
+    desc "Create database yaml in capistrano shared path"
+    task :default do
+      run "mkdir -p #{shared_path}/config"
+      upload "config/database.yml.example", "#{shared_path}/config/database.yml", :via => :scp
+    end
+
+    desc "Make symlink for shared database yaml"
+    task :symlink do
+      run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+
+    task :rake, :roles => :app do
+      run("cd #{deploy_to}/current && /usr/bin/env bundle exec rake #{rake_task} RAILS_ENV=#{rails_env}")
+    end
+
+    desc "Setup database"
+    task :setup, :roles => :app do
+      set :rake_task, 'db:setup'
+      rake
+    end
+  end
+end

data/lib/recipes/mod_rails.rb

@@ -0,0 +1,38 @@
+Capistrano::Configuration.instance.load do
+  namespace :webistrano do
+    namespace :mod_rails do
+      desc "start mod_rails & Apache"
+      task :start, :roles => :app, :except => { :no_release => true } do
+        as = fetch(:runner, "app")
+        invoke_command "#{apache_init_script} start", :via => run_method, :as => as
+      end
+
+      desc "stop mod_rails & Apache"
+      task :stop, :roles => :app, :except => { :no_release => true } do
+        as = fetch(:runner, "app")
+        invoke_command "#{apache_init_script} stop", :via => run_method, :as => as
+      end
+
+      desc "restart mod_rails"
+      task :restart, :roles => :app, :except => { :no_release => true } do
+        as = fetch(:runner, "app")
+        restart_file = fetch(:mod_rails_restart_file, "#{deploy_to}/current/tmp/restart.txt")
+        invoke_command "touch #{restart_file}", :via => run_method, :as => as
+      end
+    end
+  end
+
+  namespace :deploy do
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      webistrano.mod_rails.restart
+    end
+
+    task :start, :roles => :app, :except => { :no_release => true } do
+      webistrano.mod_rails.start
+    end
+
+    task :stop, :roles => :app, :except => { :no_release => true } do
+      webistrano.mod_rails.stop
+    end
+  end
+end

data/lib/recipes/rails31.rb

@@ -0,0 +1,6 @@
+Capistrano::Configuration.instance.load do
+  # Compile the assets in Rails 3.1
+  after 'deploy:migrate' do
+    run "cd #{release_path}; RAILS_ENV=production rake assets:precompile"
+  end
+end

data/lib/recipes/sqlite.rb

@@ -0,0 +1,29 @@
+Capistrano::Configuration.instance.load do
+  before "deploy:setup", "sqlite:setup"
+  after "db:symlink", "sqlite:symlink"
+
+  namespace :sqlite do
+    desc "Setup Sqlite3 db"
+    task :setup do
+      run "mkdir -p #{shared_path}/db"
+    end
+
+    namespace :sync do
+      desc "Sync down the production sqlite database to local development sqlite"
+      task :down do
+        download "#{shared_path}/db/#{rails_env}.sqlite3", "db/development.sqlite3", :via => :scp
+      end
+
+      desc "Sync up the development sqlite database to production sqlite"
+      task :up do
+        run "mkdir -p #{shared_path}/db"
+        upload "db/development.sqlite3", "#{shared_path}/db/#{rails_env}.sqlite3", :via => :scp
+      end
+    end
+
+    desc "Make symlink for shared database"
+    task :symlink do
+      run "ln -nfs #{shared_path}/db/#{rails_env}.sqlite3 #{release_path}/db/#{rails_env}.sqlite3"
+    end
+  end
+end

data/lib/recipes/sync.rb

@@ -0,0 +1,214 @@
+require 'yaml'
+require 'pathname'
+
+Capistrano::Configuration.instance.load do
+  #
+  # Capistrano sync.rb task for syncing databases and directories between the
+  # local development environment and different multi_stage environments. You
+  # cannot sync directly between two multi_stage environments, always use your
+  # local machine as loop way.
+  #
+  # Author: Michael Kessler aka netzpirat
+  # Gist:   111597
+  #
+  # Released under the MIT license.
+  # Kindly sponsored by Screen Concept, www.screenconcept.ch
+  #
+  namespace :sync do
+
+    after "deploy:setup", "sync:setup"
+
+    desc <<-DESC
+      Creates the sync dir in shared path. The sync directory is used to keep
+      backups of database dumps and archives from synced directories. This task will
+      be called on 'deploy:setup'
+    DESC
+    task :setup do
+      run "cd #{shared_path}; mkdir sync"
+    end
+
+    namespace :down do
+
+      desc <<-DESC
+        Syncs the database and declared directories from the selected multi_stage environment
+        to the local development environment. This task simply calls both the 'sync:down:db' and
+        'sync:down:fs' tasks.
+      DESC
+      task :default do
+        db and fs
+      end
+
+      desc <<-DESC
+        Syncs database from the selected mutli_stage environement to the local develoment environment.
+        The database credentials will be read from your local config/database.yml file and a copy of the
+        dump will be kept within the shared sync directory. The amount of backups that will be kept is
+        declared in the sync_backups variable and defaults to 5.
+      DESC
+      task :db, :roles => :db, :only => { :primary => true } do
+        # Use production on non-multistage
+        stage ||= 'production'
+
+        filename = "database.#{stage}.#{Time.now.strftime '%Y-%m-%d_%H:%M:%S'}.sql.bz2"
+        on_rollback { delete "#{shared_path}/sync/#{filename}" }
+
+        # Remote DB dump
+        username, password, database, host = database_config(stage)
+        host_option = host ? "--host='#{host}'" : ""
+        run "mysqldump -u #{username} --password='#{password}' #{host_option} #{database} | bzip2 -9 > #{shared_path}/sync/#{filename}" do |channel, stream, data|
+          puts data
+        end
+        purge_old_backups "database"
+
+        # Download dump
+        download "#{shared_path}/sync/#{filename}", filename
+
+        # Local DB import
+        username, password, database, host = database_config('development')
+        system "bzip2 -d -c #{filename} | mysql -u #{username} --password='#{password}' #{database}; rm -f #{filename}"
+
+        logger.important "sync database from the stage '#{stage}' to local finished"
+      end
+
+      desc <<-DESC
+        Sync declared directories from the selected multi_stage environment to the local development
+        environment. The synced directories must be declared as an array of Strings with the sync_directories
+        variable. The path is relative to the rails root.
+      DESC
+      task :fs, :roles => :web, :once => true do
+        # Use production on non-multistage
+        stage ||= 'production'
+
+        server, port = host_and_port
+
+        Array(fetch(:sync_directories, [])).each do |syncdir|
+          unless File.directory? "#{syncdir}"
+            logger.info "create local '#{syncdir}' folder"
+            Dir.mkdir "#{syncdir}"
+          end
+          logger.info "sync #{syncdir} from #{server}:#{port} to local"
+          destination, base = Pathname.new(syncdir).split
+          system "rsync --verbose --archive --compress --copy-links --delete --stats --rsh='ssh -p #{port}' #{user}@#{server}:#{current_path}/#{syncdir} #{destination.to_s}"
+        end
+
+        logger.important "sync filesystem from the stage '#{stage}' to local finished"
+      end
+
+    end
+
+    namespace :up do
+
+      desc <<-DESC
+        Syncs the database and declared directories from the local development environment
+        to the selected multi_stage environment. This task simply calls both the 'sync:up:db' and
+        'sync:up:fs' tasks.
+      DESC
+      task :default do
+        db and fs
+      end
+
+      desc <<-DESC
+        Syncs database from the local develoment environment to the selected mutli_stage environement.
+        The database credentials will be read from your local config/database.yml file and a copy of the
+        dump will be kept within the shared sync directory. The amount of backups that will be kept is
+        declared in the sync_backups variable and defaults to 5.
+      DESC
+      task :db, :roles => :db, :only => { :primary => true } do
+        # Use production on non-multistage
+        stage ||= 'production'
+
+        filename = "database.#{stage}.#{Time.now.strftime '%Y-%m-%d_%H:%M:%S'}.sql.bz2"
+
+        on_rollback do
+          delete "#{shared_path}/sync/#{filename}"
+          system "rm -f #{filename}"
+        end
+
+        # Make a backup before importing
+        username, password, database, host = database_config(stage)
+        host_option = host ? "--host='#{host}'" : ""
+        run "mysqldump -u #{username} --password='#{password}' #{host_option} #{database} | bzip2 -9 > #{shared_path}/sync/#{filename}" do |channel, stream, data|
+          puts data
+        end
+
+        # Local DB export
+        filename = "dump.local.#{Time.now.strftime '%Y-%m-%d_%H:%M:%S'}.sql.bz2"
+        username, password, database, host = database_config('development')
+        host_option = host ? "--host='#{host}'" : ""
+        system "mysqldump -u #{username} --password='#{password}' #{host_option} #{database} | bzip2 -9 > #{filename}"
+        upload filename, "#{shared_path}/sync/#{filename}"
+        system "rm -f #{filename}"
+
+        # Remote DB import
+        username, password, database, host = database_config(stage)
+        host_option = host ? "--host='#{host}'" : ""
+        run "bzip2 -d -c #{shared_path}/sync/#{filename} | mysql -u #{username} --password='#{password}' #{host_option} #{database}; rm -f #{shared_path}/sync/#{filename}"
+        purge_old_backups "database"
+
+        logger.important "sync database from local to the stage '#{stage}' finished"
+      end
+
+      desc <<-DESC
+        Sync declared directories from the local development environement to the selected multi_stage
+        environment. The synced directories must be declared as an array of Strings with the sync_directories
+        variable.  The path is relative to the rails root.
+      DESC
+      task :fs, :roles => :web, :once => true do
+        # Use production on non-multistage
+        stage ||= 'production'
+
+        server, port = host_and_port
+        Array(fetch(:sync_directories, [])).each do |syncdir|
+          destination, base = Pathname.new(syncdir).split
+          if File.directory? "#{syncdir}"
+            # Make a backup
+            logger.info "backup #{syncdir}"
+            run "tar cjf #{shared_path}/sync/#{base}.#{Time.now.strftime '%Y-%m-%d_%H:%M:%S'}.tar.bz2 #{current_path}/#{syncdir}"
+            purge_old_backups "#{base}"
+          else
+            logger.info "Create '#{syncdir}' directory"
+            run "mkdir #{current_path}/#{syncdir}"
+          end
+
+          # Sync directory up
+          logger.info "sync #{syncdir} to #{server}:#{port} from local"
+          system "rsync --verbose --archive --compress --keep-dirlinks --delete --stats --rsh='ssh -p #{port}' #{syncdir} #{user}@#{server}:#{current_path}/#{destination.to_s}"
+        end
+        logger.important "sync filesystem from local to the stage '#{stage}' finished"
+      end
+
+    end
+
+    #
+    # Reads the database credentials from the local config/database.yml file
+    # +db+ the name of the environment to get the credentials for
+    # Returns username, password, database
+    #
+    def database_config(db)
+      database = YAML::load_file('config/database.yml')
+      return database["#{db}"]['username'], database["#{db}"]['password'], database["#{db}"]['database'], database["#{db}"]['host']
+    end
+
+    #
+    # Returns the actual host name to sync and port
+    #
+    def host_and_port
+      return roles[:web].servers.first.host, ssh_options[:port] || roles[:web].servers.first.port || 22
+    end
+
+    #
+    # Purge old backups within the shared sync directory
+    #
+    def purge_old_backups(base)
+      count = fetch(:sync_backups, 5).to_i
+      backup_files = capture("ls -xt #{shared_path}/sync/#{base}*").split.reverse
+      if count >= backup_files.length
+        logger.important "no old backups to clean up"
+      else
+        logger.info "keeping #{count} of #{backup_files.length} sync backups"
+        delete_backups = (backup_files - backup_files.last(count)).join(" ")
+        try_sudo "rm -rf #{delete_backups}"
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: capones_recipes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Roman Simecek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cap-recipes
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: capistrano_colors
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: just for fun
+email: roman.simecek@cyt.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Capfile
+- lib/capones_recipes.rb
+- lib/recipes/database_yml.rb
+- lib/recipes/mod_rails.rb
+- lib/recipes/rails31.rb
+- lib/recipes/sqlite.rb
+- lib/recipes/sync.rb
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/raskhadafi/capones-recipes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -4253814855414718080
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Some capistrano recipes for use.
+test_files: []
+