capistrano_misc_recipes 0.0.2 → 0.1.0

data/README.md

@@ -1,12 +1,12 @@
 # Capistrano Misc Recipes
 
-This gem provides several capistrano tasks to help to access rails application environment and log files.
+This gem provides several capistrano tasks to help to access rails application environment and log files, fetch db dump from server and manage passenger process.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano_misc_recipies'
+    gem 'capistrano_misc_recipies', group: :development
 
 And then execute:
 
@@ -18,9 +18,13 @@ Or install it yourself as:
 
 ## Usage
 
+### Console commands
+
 Add to your Capfile:
 
-    require 'capistrano_misc_recipies/console'
+```ruby
+require 'capistrano_misc_recipies/console'
+```
 
 To open rails db console on first application server:
 
@@ -42,6 +46,73 @@ To get 1000 string from application log file from server:
 
     $ cap console:tail_log1000
 
+### Fetch database dump from server
+
+Add to your Capfile:
+
+```ruby
+require 'capistrano_misc_recipies/dbfetch'
+```
+
+To fetch db dump from server run:
+
+    $ cap dbfetch
+
+Gem also includes rake task to make dump of local database:
+
+    $ rake db:sqldump
+
+### Passenger standalone manage tasks
+
+Add to your Capfile:
+
+```ruby
+require 'capistrano_misc_recipies/passenger'
+```
+
+Now you have `deploy:start`, `deploy:stop` and `deploy:restart` tasks which manage passenger process.
+Passenger starts on _127.0.0.1:3000_ by default. Add next directives to your config/deploy.rb file to
+override default:
+
+```ruby
+set :passenger_address, '127.0.0.1'
+set :passenger_port, 3000
+```
+
+Also you may bind passenger to Unix domain socket instead of TCP socket:
+
+```ruby
+set :passenger_use_socket, true
+```
+
+Socket file default location (`#{Rails.root}/tmp/pids/#{Rails.env}.sock` by default) can be changed:
+
+```ruby
+set :passenger_socket_file, '/path/to/file.sock'
+```
+
+To customise deploy task override it in `config/deploy.rb` file:
+
+```ruby
+namespace :deploy do
+  task :start do
+
+    # some logic...
+
+    passenger.start
+
+    # some other logic...
+
+  end
+end
+```
+
+`passenger.start`, `passenger.stop` and `passenger.restart` tasks can be used.
+
+### Generate sample nginx config for application
+
+Task `cap passenger:nginx_config` prints sample nginx config and saves it in file application tmp dir
+
 ## Contributing
 
 1. Fork it

data/lib/capistrano_misc_recipes/bundler.rb

@@ -0,0 +1,7 @@
+module CapistranoMiscRecipes
+  module Bundler
+    def bundlify command
+      return defined?(Bundler) ? "bundle exec #{command}" : command
+    end
+  end
+end

data/lib/capistrano_misc_recipes/console.rb

@@ -1,8 +1,12 @@
 # Recipes for run somoe useful console commands on server
 
+require 'capistrano_misc_recipes/bundler'
+
 module Capistrano
   module Console
+
     Configuration.instance(true).load do
+      extend ::CapistranoMiscRecipes::Bundler
 
       def execute_ssh_locally cmd=''
         hostname = find_servers_for_task(current_task).first
@@ -32,7 +36,7 @@ module Capistrano
         task :rails, roles: :app do
 
           console_command = "rails console %s" % rails_env
-          console_command = "bundle exec #{console_command}" if defined? Bundler
+          console_command = bundlify console_command
 
           execute_ssh_locally console_command
         end
@@ -40,7 +44,7 @@ module Capistrano
         desc "Open a rails db console the first app server"
         task :db, roles: :app do
           console_command = "rails dbconsole %s" % rails_env
-          console_command = "bundle exec #{console_command}" if defined? Bundler
+          console_command = bundlify console_command
 
           execute_ssh_locally console_command
         end

data/lib/capistrano_misc_recipes/db_dump.rb

@@ -38,6 +38,7 @@ module CapistranoMiscRecipes
         # TODO password
 
       else
+        # TODO handle error capistrano and rake way
         abort "Unknown command-line client for #{options['database']}"
       end
 

data/lib/capistrano_misc_recipes/dbfetch.rb

@@ -17,7 +17,7 @@ module Capistrano
         config = begin
                   YAML.load(ERB.new(database_yml).result)[rails_env]
                  rescue
-                   # TODO error report if database.yml not exists unreachable!
+                   # TODO error report if database.yml not reachable!
                  end
 
         dump_file = "/tmp/#{ capture("hostname").chomp }-#{ config['database'] }-#{ Time.now.strftime('%Y-%m-%d-%H-%M-%S') }.sql.bz2"

data/lib/capistrano_misc_recipes/passenger.rb

@@ -0,0 +1,126 @@
+# Recipe for manage passenger
+
+require 'capistrano_misc_recipes/bundler'
+
+module Capistrano
+  module Passenger
+    Configuration.instance(true).load do
+      namespace :passenger do
+        extend ::CapistranoMiscRecipes::Bundler
+
+        _cset :passenger_pids_dir,    Pathname.new(current_path).join('tmp', 'pids')
+        _cset :passenger_pid_file,    passenger_pids_dir.join("#{rails_env}.pid")
+        _cset :passenger_socket_file, passenger_pids_dir.join("#{rails_env}.sock")
+        _cset :passenger_address,     '127.0.0.1'
+        _cset :passenger_port,        3000
+        _cset :passenger_use_socket,  false
+
+
+        desc '[internal] Start passenger'
+        task :start, roles: :app do
+
+          command = []
+          command << "cd #{current_path}"
+          command << "&&"
+          command << "rm -f #{passenger_socket_file}" # if passenger was finished ubnormally
+          command << "&&"
+          command << "#{bundlify 'passenger'} start"
+          command << current_path
+
+          if fetch :passenger_use_socket
+            command << "--socket #{passenger_socket_file}"
+          else
+            command << "--address #{passenger_address}"
+            command << "--port #{passenger_port}"
+          end
+
+          command << "--pid-file #{passenger_pid_file}"
+          command << "--environment #{rails_env}"
+          command << "--daemonize"
+          run command.join ' '
+
+        end
+
+        desc '[internal] Stop passenger'
+        task :stop, roles: :app do
+          run "cd #{current_path} && #{bundlify 'passenger'} stop --pid-file #{passenger_pid_file} ; true"
+        end
+
+        desc '[internal] Restart passenger'
+        task :restart, roles: :app, except: { no_release: true } do
+          run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+        end
+
+        desc 'generates nginx virtual host template file'
+        task :nginx_config do
+
+          proxy_pass = if passenger_use_socket
+                         "http://unix:#{passenger_socket_file}"
+                       else
+                         "http://#{passenger_address}:#{passenger_port}"
+                       end
+
+          conf_file = <<CONF
+
+# nginx virtual host file for
+#    application: #{application}
+#{exists?(:stages) ? "#    stage: #{stage}\n" : nil}
+server {
+    listen 80;
+    server_name #{application}
+    root #{File.join current_path, 'public'};
+    client_max_body_size 15M;
+
+    location / {
+        try_files /system/maintence.html
+          $uri $uri/index.html $uri.html
+          @passenger;
+    }
+
+    location @passenger {
+        proxy_set_header Host $host;
+        proxy_set_header X-Forwarded-For $remote_addr;
+
+        proxy_pass #{proxy_pass};
+    }
+
+    error_page 500 502 503 504 /500.html;
+    error_page 404 403 /404.html;
+}
+
+CONF
+
+          puts conf_file
+          # save file in application tmp dir
+          put conf_file, Pathname.new(current_path).join('tmp', [application, exists?(:stages) ? stage : nil].compact.join(?_)).to_s
+        end
+
+      end
+
+      namespace :deploy do
+        desc 'Starts application server'
+        task :start do
+          passenger.start
+        end
+
+        desc 'Stops application server'
+        task :stop do
+          passenger.stop
+        end
+
+        desc 'Restarts application server'
+        task :restart do
+          passenger.restart
+        end
+
+        desc 'Deploys your project and runs the migrate rake task'
+        task :full do
+          stop
+          update
+          migrate
+          restart
+        end
+      end
+    end
+  end
+end

data/lib/capistrano_misc_recipes/version.rb

@@ -1,3 +1,3 @@
 module CapistranoMiscRecipes
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_misc_recipes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -75,9 +75,12 @@ files:
 - Rakefile
 - capistrano_misc_recipes.gemspec
 - lib/capistrano_misc_recipes.rb
+- lib/capistrano_misc_recipes/.passenger.rb.swo
+- lib/capistrano_misc_recipes/bundler.rb
 - lib/capistrano_misc_recipes/console.rb
 - lib/capistrano_misc_recipes/db_dump.rb
 - lib/capistrano_misc_recipes/dbfetch.rb
+- lib/capistrano_misc_recipes/passenger.rb
 - lib/capistrano_misc_recipes/tasks.rb
 - lib/capistrano_misc_recipes/version.rb
 homepage: http://github.com/corlinus/capistrano_misc_recipes
@@ -95,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 873591735516740147
+      hash: -4105244698074156849
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 873591735516740147
+      hash: -4105244698074156849
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25