j-cap-recipes 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 086e21393f0b2b5b113d801f388aba884d6c35a9
-  data.tar.gz: 4661e17909d7b2e47c9974d2bb04715728c955e3
+  metadata.gz: 0b96c02150dff5033f67954c8625e207f08050d9
+  data.tar.gz: a9cd1381347921f258d6987953a3155127b1b725
 SHA512:
-  metadata.gz: 846b3cbe2a3c266b4783276febbef4b15e1181dd6d7283acbaea4784ae04bb5277b033c5beff98ecd7f737de2a7bcc563f6add00519d60cca0a20ceded44f673
-  data.tar.gz: 37da5b66d6d3917a885b63ae52f8b5fc3ca745d68a5c37561cc3cbe1b65b169f96773959a4b89fde7137824ff27baffa9ca8f597c20f141981432a9f52cf077c
+  metadata.gz: 1ffd8d989dcf6292e96a6a04d2d1bb02d7981a3421836af6e6c68bb3be648ca6d3eef9b03e6790a8cdd5daaa6313d6b6798adbc2fdf8d23f7ffa70ad39d026ef
+  data.tar.gz: a1ddaafa9ec4178cb3cd63990eacbadf87aa8e8101f5bbaad55eef9627decfa21625715a904255f611c969faf8939bafefa3c6afdb1b02d3ae18dfdced5dd97c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+## 0.0.15
+
+* Added new SSHKit backend called SshCommand. It adds support to run interactive commands, example like `rails console`.
+* Added rails rake task to create datbase backup and restore. You can check `rake -T`
+* Optimized to run rails console task via SshCommand backend
+* Added a new task `rails:less_log` to show the current log file via `less`
+* Update Handy with a new task `config:settings:get` to download remote stage config to local folder.
+
 ## 0.0.14
 
 * Added airbrake deploy notification task.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    j-cap-recipes (0.0.14)
+    j-cap-recipes (0.0.15)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,7 +7,7 @@ A simple number of capistrano recipes to deploy rails application using Capistra
 
 Add this line to your application's Gemfile:
 
-    gem 'j-cap-recipes', require: false, group: :development
+    gem 'j-cap-recipes', group: :development
 
 And then execute:
 
@@ -21,7 +21,7 @@ Or install it yourself as:
 
 In the `Capfile` to include all recipes add:
 
-    require 'j-cap-recipes'
+    require 'j-cap-recipes/default'
 
 If you want to load only specified recipe:
 
@@ -37,6 +37,10 @@ If you want to load only specified recipe:
     require 'j-cap-recipes/honeybadger'
     require 'j-cap-recipes/airbrake'
 
+Also you need to include rake tasks in your `Rakefile`:
+
+    require 'j-cap-recipes'
+
 ### Nginx
 ### Setup
 ### Check
@@ -91,6 +95,7 @@ There are three tasks available:
 - `cap staging config:settings` Show the current staging config files;
 - `cap staging config:settings:delete` Remove the custom env settings file;
 - `cap staging config:settings:upload` Update the remote config file with local one;
+- `cap staging config:settings:get` Download the rmote config file to local one
 
 ### Git
 
@@ -128,6 +133,45 @@ after 'deploy:finishing', 'airbrake:deploy'
 
 You can change the default api key using `ENV['API_KEY']`.
 
+
+### Rake tasks
+
+Added utility rake task to create database backup for postgresql and rails.
+
+### SSHKit addon
+
+`SSHKit::Backend::SshCommand` a new backend to invoke the ssh command using sytem command `ssh`.
+Now you can easy to execute interactive applications with similar changes. Example:
+
+```ruby
+namespace :rails do
+  desc 'Execute rails console'
+  task :console do
+    on roles(:app), in: :parallel, backend: :ssh_command do |*args|
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute(:rails, :console)
+        end
+      end
+    end
+  end
+end
+```
+
+And you have a easy and fast way to run remote interactive rails console via command `cap production rails:console`.
+
+```ruby
+task :less_log do
+  on roles(:app), in: :parallel, backend: :ssh_command do |*args|
+    within current_path.join('log') do
+      execute(:less, '-R', fetch(:rails_env)+'.log')
+    end
+  end
+end
+```
+
+And you have way to look to logs `cap production less_log`.
+
 ## Contributing
 
 1. Fork it
@@ -135,7 +179,3 @@ You can change the default api key using `ENV['API_KEY']`.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/jetthoughts/j-cap-recipes/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/lib/j-cap-recipes.rb

@@ -1,9 +1,2 @@
-require_relative 'j-cap-recipes/rails'
-require_relative 'j-cap-recipes/database'
-require_relative 'j-cap-recipes/check'
-require_relative 'j-cap-recipes/delayed_job'
-require_relative 'j-cap-recipes/monit'
-require_relative 'j-cap-recipes/nginx'
-require_relative 'j-cap-recipes/rake'
-require_relative 'j-cap-recipes/setup'
-require_relative 'j-cap-recipes/unicorn'
+require_relative 'j-cap-recipes/version'
+require_relative 'j-cap-recipes/railtie' if defined?(Rails)

data/lib/j-cap-recipes/default.rb

@@ -0,0 +1,8 @@
+require 'j-cap-recipes/database'
+require 'j-cap-recipes/check'
+require 'j-cap-recipes/delayed_job'
+require 'j-cap-recipes/monit'
+require 'j-cap-recipes/nginx'
+require 'j-cap-recipes/rake'
+require 'j-cap-recipes/setup'
+require 'j-cap-recipes/unicorn'

data/lib/j-cap-recipes/rails.rb

@@ -1,65 +1,45 @@
+require 'sshkit/backends/ssh_command'
+require 'sshkit/runners/abstract'
+
+#Patch to support backend option
+# Sent PR https://github.com/capistrano/sshkit/pull/117, except constantinize
 module SSHKit
-  module Backend
-    class Netssh
-      def execute(*args, &block)
-        _execute(*args, &block).success?
+
+  module Runner
+
+    class Abstract
+
+      attr_reader :hosts, :options, :block
+
+      def initialize(hosts, options = nil, &block)
+        @hosts   = Array(hosts)
+        @options = options || {}
+        @block   = block
       end
 
       private
-      def _execute(*args, &block)
-        command(*args).tap do |cmd|
-          output << cmd
-          cmd.started = true
-          ssh.open_channel do |chan|
-            chan.request_pty if Netssh.config.pty
-            chan.exec cmd.to_command do |ch, success|
-              chan.on_data do |ch, data|
-                if block_given?
-                  cmd.stdout = data
-                  block.call(ch, data)
-                else
-                  cmd.stdout      = data
-                  cmd.full_stdout += data
-                  output << cmd
-                end
-              end
-              chan.on_extended_data do |ch, type, data|
-                cmd.stderr = data
-                cmd.full_stderr += data
-                output << cmd
-              end
-              chan.on_request("exit-status") do |ch, data|
-                cmd.stdout = ''
-                cmd.stderr = ''
-                cmd.exit_status = data.read_long
-                output << cmd
-              end
-              #chan.on_request("exit-signal") do |ch, data|
-              #  # TODO: This gets called if the program is killed by a signal
-              #  # might also be a worthwhile thing to report
-              #  exit_signal = data.read_string.to_i
-              #  warn ">>> " + exit_signal.inspect
-              #  output << cmd
-              #end
-              chan.on_open_failed do |ch|
-                # TODO: What do do here?
-                # I think we should raise something
-              end
-              chan.on_process do |ch|
-                # TODO: I don't know if this is useful
-              end
-              chan.on_eof do |ch|
-                # TODO: chan sends EOF before the exit status has been
-                # writtend
-              end
-            end
-            chan.wait
-          end
-          ssh.loop
+
+      def backend(host, &block)
+        backend_factory.new(host, &block)
+      end
+
+      def backend_factory
+        case @options[:backend]
+        when Symbol
+          SSHKit::Backend.const_get(@options[:backend].to_s.split('_').collect(&:capitalize).join)
+        when String
+          Kernel.const_get(@options[:backend])
+        when nil
+          SSHKit.config.backend
+        else
+          @options[:backend]
         end
+
       end
     end
+
   end
+
 end
 
 load File.expand_path('../tasks/rails.rake', __FILE__)

data/lib/j-cap-recipes/railtie.rb

@@ -0,0 +1,7 @@
+module JCapRecipes
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/db.rake', __FILE__)
+    end
+  end
+end

data/lib/j-cap-recipes/tasks/db.rake

@@ -0,0 +1,74 @@
+namespace :db do
+  desc 'PG backup'
+  task backup: [:environment, :load_config] do
+    #stamp the filename
+    datestamp  = Time.now.strftime('%Y-%m-%d_%H-%M-%S')
+
+    #create backups folder
+    backup_dir = ENV['backup-path'] || Rails.root.join('db', 'backups')
+    mkdir_p(backup_dir)
+
+    config        = ActiveRecord::Base.connection_config
+    database_name = ActiveRecord::Base.connection.current_database
+    backup_file   = File.join(backup_dir, "#{database_name}_#{datestamp}.dump")
+
+    #dump the backup and zip it up
+    dump_command  = "pg_dump #{database_name} -w -F c"
+    dump_command  += " -h #{config[:hostname]}" if config[:hostname].present?
+    dump_command  += " -U #{config[:username]}" if config[:username].present?
+    dump_command  += " > #{backup_file}"
+
+    sh dump_command
+
+    safe_ln backup_file, File.join(backup_dir, "#{database_name}_latest.dump")
+
+    #send_to_amazon backup_file
+    #remove the file on completion so we don't clog up our app
+    #File.delete backup_file
+  end
+
+  desc 'PG restore from the last backup file'
+  task restore: [:environment, :load_config] do
+    config        = ActiveRecord::Base.connection_config
+    database_name = ActiveRecord::Base.connection.current_database
+    backup_dir    = ENV['backup-path'] || Rails.root.join('db', 'backups')
+    backup_file   = File.join(backup_dir, "#{database_name}_latest.dump")
+
+    Rake::Task['db:kill_postgres_connections'].invoke
+    Rake::Task['db:drop'].invoke
+    Rake::Task['db:create'].invoke
+
+    restore_command = "pg_restore -d #{database_name} -F c -w #{backup_file}"
+    restore_command = postgres_command_options restore_command, config
+    sh "#{restore_command} || echo 'done'"
+  end
+
+  task :kill_postgres_connections => :environment do
+    database_name = ActiveRecord::Base.connection.current_database
+    command = <<EOF
+ps xa \
+  | grep postgres: \
+  | grep #{database_name} \
+  | grep -v grep \
+  | awk '{print $1}' \
+  | xargs kill
+EOF
+    sh command
+  end
+
+end
+
+def postgres_command_options(str, config)
+  str += " -h #{config[:hostname]}" if config[:hostname].present?
+  str += " -U #{config[:username]}" if config[:username].present?
+  str
+end
+
+#TODO: Use setting to get S3 credentials
+def send_to_amazon(file_path)
+  bucket    = "db-backups"
+  file_name = File.basename(file_path)
+  AWS::S3::Base.establish_connection!(:access_key_id => 'YOUR KEY', :secret_access_key => 'YOUR SECRET')
+  #push the file up
+  AWS::S3::S3Object.store(file_name, File.open(file_path), bucket)
+end

data/lib/j-cap-recipes/tasks/handy.rake

@@ -20,11 +20,21 @@ namespace :config do
     desc 'Show current settings'
     task :show do
       on roles(:all) do |host|
-        within current_path do
-          execute :cat, 'config/settings.yml', "config/settings/#{fetch(:stage)}.yml"
+        within current_path.join('config') do
+          execute :cat, 'settings.yml'
+          execute :cat, "settings/#{fetch(:stage)}.yml"
         end
       end
     end
+
+    desc 'Show current settings'
+    task :get do
+      on roles(:all) do |host|
+        local_dir = File.join(Dir.pwd, 'config', 'settings')
+        FileUtils.mkdir_p local_dir
+        download! current_path.join('config', 'settings', "#{fetch(:stage)}.yml"), local_dir
+      end
+    end
   end
 
 end

data/lib/j-cap-recipes/tasks/rails.rake

@@ -1,34 +1,22 @@
 namespace :rails do
   desc 'Execute rails console'
   task :console do
-    on roles(:app) do
+    on roles(:app), in: :parallel, backend: :ssh_command do |*args|
       within release_path do
         with rails_env: fetch(:rails_env) do
-          row , command = '', nil
-          execute(:rails, :console) do |ch, data|
-            row += data
-            if command && row.include?(command)
-              row.sub!(/#{command}(\r\n)?/, '')
-              command = nil
-            end
-
-            if row.include?('irb(main):')
-              print row
-              row     = ''
-              command = $stdin.gets
-              command = "exit\n" if command == nil
-              ch.send_data command
-              command.chomp!
-            end
-
-            if row.include?("\n")
-              print row
-              row = ''
-            end
-
-          end
+          execute(:rails, :console)
         end
       end
     end
   end
+
+  desc 'Execute less on current env log file'
+  task :less_log do
+    on roles(:app), in: :parallel, backend: :ssh_command do |*args|
+      within current_path.join('log') do
+        execute(:less, '-R', fetch(:rails_env)+'.log')
+      end
+    end
+  end
+
 end

data/lib/j-cap-recipes/version.rb

@@ -1,5 +1,5 @@
 module JCap
   module Recipes
-    VERSION = '0.0.14'
+    VERSION = '0.0.15'
   end
 end

data/lib/sshkit/backends/ssh_command.rb

@@ -0,0 +1,26 @@
+module SSHKit
+
+  module Backend
+
+    class SshCommand < Printer
+
+      def run
+        instance_exec(host, &@block)
+      end
+
+      def within(directory, &block)
+        (@pwd ||= []).push directory.to_s
+        yield
+      ensure
+        @pwd.pop
+      end
+
+      def execute(*args, &block)
+        result = 'ssh %s@%s -t "%s"' % [host.username, String(host.hostname), command(*args).to_command]
+        output << Command.new(result)
+        system(result)
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: j-cap-recipes
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Michael Nikitochkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - lib/j-cap-recipes/airbrake.rb
 - lib/j-cap-recipes/check.rb
 - lib/j-cap-recipes/database.rb
+- lib/j-cap-recipes/default.rb
 - lib/j-cap-recipes/delayed_job.rb
 - lib/j-cap-recipes/deploy.rb
 - lib/j-cap-recipes/files.rb
@@ -81,11 +82,13 @@ files:
 - lib/j-cap-recipes/monit.rb
 - lib/j-cap-recipes/nginx.rb
 - lib/j-cap-recipes/rails.rb
+- lib/j-cap-recipes/railtie.rb
 - lib/j-cap-recipes/rake.rb
 - lib/j-cap-recipes/setup.rb
 - lib/j-cap-recipes/tasks/airbrake.rake
 - lib/j-cap-recipes/tasks/check.rake
 - lib/j-cap-recipes/tasks/database.rake
+- lib/j-cap-recipes/tasks/db.rake
 - lib/j-cap-recipes/tasks/delayed_job.rake
 - lib/j-cap-recipes/tasks/deploy.rake
 - lib/j-cap-recipes/tasks/files.rake
@@ -103,6 +106,7 @@ files:
 - lib/j-cap-recipes/tasks/unicorn.rake
 - lib/j-cap-recipes/unicorn.rb
 - lib/j-cap-recipes/version.rb
+- lib/sshkit/backends/ssh_command.rb
 homepage: https://github.com/jetthoughts/j-cap-recipes
 licenses:
 - MIT