capistrano3-puma 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a285319ce829244caa77fe60b0e120c41c7b07f8
-  data.tar.gz: 848e536e6d08bea1207b12ba4e01b632128efe0e
+  metadata.gz: 1755f57fc22107e5f701181029fdfb83c371f812
+  data.tar.gz: 9366f5b212d65fe58f2e9fca81ea523add36636b
 SHA512:
-  metadata.gz: b4ea06110afed0438c01329a8720fc85a99e4e6064060dde896cd2fdf4028a0a2ac76380e111febc3ec7feac0b1b1025c434e5968e6f12e077de8d4e0f2f3168
-  data.tar.gz: 4841fbeb5154fd76a6f2b44673ccb99cd695b6a2000366071c00d6553a96e3eaa7f3b2e8e41344e0b84c36f77e1d17c03b60015390268b33c2cdae9383671c41
+  metadata.gz: feccecc2474ff21ef7573ceed1fb04c050e24fb4c7be308842ca3cfc56fd9979bfd491f7c1334091dba292e34ba159692ca27d4901afec7bcc6c2a8b7f67ba8e
+  data.tar.gz: d9d1bc5fdcefb10fc9d9b594febec02baca91d0de3093425e274a2e9e4211a1ec86789328afb6d90617787ff2701b7fe10b793cfb1299b5b46256f8257f2cd45

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2014 Abdelkader Boudih
+Copyright (c) 2013-2015 Abdelkader Boudih
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -54,6 +54,7 @@ role :puma_nginx, %w{root@example.com}
 Configurable options, shown here with defaults: Please note the configuration options below are not required unless you are trying to override a default setting, for instance if you are deploying on a host on which you do not have sudo or root privileges and you need to restrict the path. These settings go in the deploy.rb file.
 
 ```ruby
+    set :puma_user, fetch(:user)
     set :puma_rackup, -> { File.join(current_path, 'config.ru') }
     set :puma_state, "#{shared_path}/tmp/pids/puma.state"
     set :puma_pid, "#{shared_path}/tmp/pids/puma.pid"
@@ -69,6 +70,7 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_worker_timeout, nil
     set :puma_init_active_record, false
     set :puma_preload_app, true
+    set :nginx_use_ssl, false
 ```
 For Jungle tasks (beta), these options exist:
 ```ruby
@@ -94,6 +96,7 @@ Ensure that the following directories are shared (via ``linked_dirs``):
     tmp/pids tmp/sockets log
 
 ## Changelog
+- 1.2.0: add support for puma user for puma user @mcb & @seuros
 - 1.1.0: Set :puma_preload_app to false; Reload Monit after uploading any monit configuration; Always refresh Gemfile @rafaelgoulart @suhailpatel @sime
 - 1.0.0: Add activate control app @askagirl
 - 0.8.5: Fix smart_restart task to check if puma preloads app
@@ -138,6 +141,7 @@ Ensure that the following directories are shared (via ``linked_dirs``):
 - [Jun Lin](https://github.com/linjunpop)
 - [fang duan](https://github.com/dfang)
 - [Steve Madere](https://github.com/stevemadere)
+- [Matias De Santi](https://github.com/mdesanti)
 
 ## Contributing
 

data/lib/capistrano/puma.rb

@@ -1 +1 @@
-load File.expand_path('../tasks/puma.cap', __FILE__)
+load File.expand_path('../tasks/puma.rake', __FILE__)

data/lib/capistrano/puma/jungle.rb

@@ -1,2 +1,2 @@
 # Load jungle tasks
-load File.expand_path('../../tasks/jungle.cap', __FILE__)
+load File.expand_path('../../tasks/jungle.rake', __FILE__)

data/lib/capistrano/puma/monit.rb

@@ -1,2 +1,2 @@
 # Load monit tasks
-load File.expand_path('../../tasks/monit.cap', __FILE__)
+load File.expand_path('../../tasks/monit.rake', __FILE__)

data/lib/capistrano/puma/nginx.rb

@@ -1 +1 @@
-load File.expand_path('../../tasks/nginx.cap', __FILE__)
+load File.expand_path('../../tasks/nginx.rake', __FILE__)

data/lib/capistrano/puma/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Puma
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/capistrano/puma/workers.rb

@@ -1,2 +1,2 @@
 # Load monit tasks
-load File.expand_path('../../tasks/workers.cap', __FILE__)
+load File.expand_path('../../tasks/workers.rake', __FILE__)

data/lib/capistrano/tasks/{monit.cap → monit.rake}

@@ -1,11 +1,11 @@
 namespace :load do
   task :defaults do
     set :puma_monit_conf_dir, -> { "/etc/monit/conf.d/#{puma_monit_service_name}.conf" }
-    set :puma_monit_bin, -> { "/usr/bin/monit" }
+    set :puma_monit_use_sudo, true
+    set :puma_monit_bin, '/usr/bin/monit'
   end
 end
 
-
 namespace :puma do
   namespace :monit do
     desc 'Config Puma monit-service'
@@ -13,49 +13,60 @@ namespace :puma do
       on roles(fetch(:puma_role)) do |role|
         @role = role
         template_puma 'puma_monit.conf', "#{fetch(:tmp_dir)}/monit.conf", @role
-        sudo "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:puma_monit_conf_dir)}"
-        sudo "#{fetch(:puma_monit_bin)} reload"
+        sudo_if_needed "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:puma_monit_conf_dir)}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)} reload"
       end
     end
 
     desc 'Monitor Puma monit-service'
     task :monitor do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_monit_bin)} monitor #{puma_monit_service_name}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)} monitor #{puma_monit_service_name}"
       end
     end
 
     desc 'Unmonitor Puma monit-service'
     task :unmonitor do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_monit_bin)}  unmonitor #{puma_monit_service_name}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)} unmonitor #{puma_monit_service_name}"
       end
     end
 
     desc 'Start Puma monit-service'
     task :start do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_monit_bin)}  start #{puma_monit_service_name}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)} start #{puma_monit_service_name}"
       end
     end
 
     desc 'Stop Puma monit-service'
     task :stop do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_monit_bin)}  stop #{puma_monit_service_name}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)}  stop #{puma_monit_service_name}"
       end
     end
 
     desc 'Restart Puma monit-service'
     task :restart do
       on roles(fetch(:puma_role)) do
-        sudo "#{fetch(:puma_monit_bin)}  restart #{puma_monit_service_name}"
+        sudo_if_needed "#{fetch(:puma_monit_bin)} restart #{puma_monit_service_name}"
       end
     end
 
+    before 'deploy:updating', 'puma:monit:unmonitor'
+    after 'deploy:published', 'puma:monit:monitor'
+
     def puma_monit_service_name
       fetch(:puma_monit_service_name, "puma_#{fetch(:application)}_#{fetch(:stage)}")
     end
 
+    def sudo_if_needed(command)
+      if fetch(:puma_monit_use_sudo)
+        sudo command
+      else
+        execute command
+      end
+    end
+
   end
 end

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,12 @@
+namespace :puma do
+  desc 'Setup nginx configuration'
+  task :nginx_config do
+    on roles(fetch(:puma_nginx, :web)) do |role|
+      puma_switch_user(role) do
+        template_puma('nginx_conf', "/tmp/nginx_#{fetch(:nginx_config_name)}", role)
+        sudo :mv, "/tmp/nginx_#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)}"
+        sudo :ln, '-fs', "#{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_enabled_path)}/#{fetch(:nginx_config_name)}"
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/{puma.cap → puma.rake}

@@ -31,6 +31,7 @@ namespace :load do
     set :nginx_flags, -> { 'fail_timeout=0' }
     set :nginx_http_flags, -> { fetch(:nginx_flags) }
     set :nginx_socket_flags, -> { fetch(:nginx_flags) }
+    set :nginx_use_ssl, false
   end
 end
 
@@ -51,16 +52,17 @@ namespace :puma do
 
   desc 'Start puma'
   task :start do
-    on roles (fetch(:puma_role)) do
-      if test "[ -f #{fetch(:puma_conf)} ]"
-        info "using conf file #{fetch(:puma_conf)}"
-      else
-        invoke 'puma:config'
-      end
-      within current_path do
-        with rack_env: fetch(:puma_env) do
-
-          execute :bundle, 'exec', :puma, "-C #{fetch(:puma_conf)} --daemon"
+    on roles (fetch(:puma_role)) do |role|
+      puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_conf)} ]"
+          info "using conf file #{fetch(:puma_conf)}"
+        else
+          invoke 'puma:config'
+        end
+        within current_path do
+          with rack_env: fetch(:puma_env) do
+            execute :bundle, 'exec', :puma, "-C #{fetch(:puma_conf)} --daemon"
+          end
         end
       end
     end
@@ -71,17 +73,19 @@ namespace :puma do
     task command do
       on roles (fetch(:puma_role)) do
         within current_path do
-          with rack_env: fetch(:puma_env) do
-            if test "[ -f #{fetch(:puma_pid)} ]"
-              if test "kill -0 $( cat #{fetch(:puma_pid)} )"
-                execute :bundle, 'exec', :pumactl, "-S #{fetch(:puma_state)} #{command}"
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]"
+                if test "kill -0 $( cat #{fetch(:puma_pid)} )"
+                  execute :bundle, 'exec', :pumactl, "-S #{fetch(:puma_state)} #{command}"
+                else
+                  # delete invalid pid file , process is not running.
+                  execute :rm, fetch(:puma_pid)
+                end
               else
-                # delete invalid pid file , process is not running.
-                execute :rm, fetch(:puma_pid)
+                #pid file not found, so puma is probably not running or it using another pidfile
+                warn 'Puma not running'
               end
-            else
-              #pid file not found, so puma is probably not running or it using another pidfile
-              warn 'Puma not running'
             end
           end
         end
@@ -92,15 +96,17 @@ namespace :puma do
   %w[phased-restart restart].map do |command|
     desc "#{command} puma"
     task command do
-      on roles (fetch(:puma_role)) do
+      on roles (fetch(:puma_role)) do |role|
         within current_path do
-          with rack_env: fetch(:puma_env) do
-            if test "[ -f #{fetch(:puma_pid)} ]" and test "kill -0 $( cat #{fetch(:puma_pid)} )"
-              # NOTE pid exist but state file is nonsense, so ignore that case
-              execute :bundle, 'exec', :pumactl, "-S #{fetch(:puma_state)} #{command}"
-            else
-              # Puma is not running or state file is not present : Run it
-              invoke 'puma:start'
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]" and test "kill -0 $( cat #{fetch(:puma_pid)} )"
+                # NOTE pid exist but state file is nonsense, so ignore that case
+                execute :bundle, 'exec', :pumactl, "-S #{fetch(:puma_state)} #{command}"
+              else
+                # Puma is not running or state file is not present : Run it
+                invoke 'puma:start'
+              end
             end
           end
         end
@@ -129,7 +135,23 @@ namespace :puma do
     end
   end
 
+  def puma_switch_user(role, &block)
+    user = puma_user(role)
+    if user == role.user
+      block.call
+    else
+      as user do
+        block.call
+      end
+    end
+  end
 
+  def puma_user(role)
+    properties = role.properties
+    properties.fetch(:puma_user) ||               # local property for puma only
+    properties.fetch(:run_as) || # global property across multiple capistrano gems
+    role.user
+  end
 
   def puma_workers
     fetch(:puma_workers, 0)

data/lib/capistrano/tasks/{workers.cap → workers.rake}

@@ -2,12 +2,14 @@ namespace :puma do
   namespace :workers do
     desc 'Add a worker'
     task :count do
-      on roles (fetch(:puma_role)) do
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
         #TODO
         # cleanup
         # add host name/ip
         workers_count = capture("ps ax | grep -c 'puma: cluster worker: `cat  #{fetch(:puma_pid)}`'").to_i - 1
         log  "Workers count : #{workers_count}"
+        end
       end
     end
 
@@ -17,18 +19,20 @@ namespace :puma do
     # Refactor
     desc 'Worker++'
     task :more do
-      on roles (fetch(:puma_role)) do
-        execute("kill -TTIN `cat  #{fetch(:puma_pid)}`")
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
+          execute("kill -TTIN `cat  #{fetch(:puma_pid)}`")
+        end
       end
     end
 
     desc 'Worker--'
     task :less do
-      on roles (fetch(:puma_role)) do
-        execute("kill -TTOU `cat  #{fetch(:puma_pid)}`")
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
+          execute("kill -TTOU `cat  #{fetch(:puma_pid)}`")
+        end
       end
     end
-
-
   end
-end
+end

data/lib/capistrano/templates/nginx_conf.erb

@@ -11,9 +11,22 @@ end
 %><% @backends.each do |server|  %>
   <%= server %><% end %>
 }
+<% if fetch(:nginx_use_ssl) %>
+server {
+  listen 80;
+  rewrite ^(.*) https://$host$1 permanent;
+}
+<% end %>
 
 server {
+<% if fetch(:nginx_use_ssl) %>
+  listen 443;
+  ssl on;
+  ssl_certificate /etc/ssl/certs/<%= fetch(:nginx_config_name) %>.crt;
+  ssl_certificate_key /etc/ssl/private/<%= fetch(:nginx_config_name) %>.key;
+<% else %>
   listen 80;
+<% end %>
 
   client_max_body_size 4G;
   keepalive_timeout 10;
@@ -29,6 +42,9 @@ server {
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header Host $http_host;
     proxy_redirect off;
+<% if fetch(:nginx_use_ssl) %>
+    proxy_set_header X-Forwarded-Proto https;
+<% end %>
     proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
     # limit_req zone=one;
     access_log <%= shared_path %>/log/nginx.access.log;

data/lib/capistrano/templates/puma.rb.erb

@@ -33,7 +33,7 @@ on_restart do
   ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{current_path}/Gemfile") %>"
 end
 
-<% if fetch(:puma_init_active_record) %>
+<% if puma_preload_app? and fetch(:puma_init_active_record) %>
 on_worker_boot do
   ActiveSupport.on_load(:active_record) do
     ActiveRecord::Base.establish_connection

data/lib/capistrano/templates/puma_monit.conf.erb

@@ -3,5 +3,5 @@
 #
 check process <%= puma_monit_service_name %>
   with pidfile "<%= fetch(:puma_pid) %>"
-  start program = "/usr/bin/sudo -u <%= @role.user %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec puma -C <%= fetch(:puma_conf) %> --daemon'"
-  stop program = "/usr/bin/sudo -u <%= @role.user %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec pumactl -S <%= fetch(:puma_state) %> stop'"
+  start program = "/usr/bin/sudo -u <%= puma_user(@role) %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec puma -C <%= fetch(:puma_conf) %> --daemon'"
+  stop program = "/usr/bin/sudo -u <%= puma_user(@role) %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec pumactl -S <%= fetch(:puma_state) %> stop'"

data/lib/capistrano/templates/run-puma.erb

@@ -3,7 +3,7 @@ app=$1;
 cd $app || exit 1
 
 if [ -e Gemfile ]; then
-    exec sh -c "exec bundle exec puma -C ../../shared/puma.rb --daemon"
+    exec <%= fetch(:puma_user) ? "sudo -u #{puma_user(@role)}" : '' %> sh -c "exec bundle exec puma -C <%= fetch(:puma_conf) %> --daemon"
 else
-    exec sh -c "exec puma -C ../../shared/puma.rb --daemon"
+    exec <%= fetch(:puma_user) ? "sudo -u #{puma_user(@role)}" : '' %> sh -c "exec puma -C <%= fetch(:puma_conf) %> --daemon"
 fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -57,11 +57,11 @@ files:
 - lib/capistrano/puma/nginx.rb
 - lib/capistrano/puma/version.rb
 - lib/capistrano/puma/workers.rb
-- lib/capistrano/tasks/jungle.cap
-- lib/capistrano/tasks/monit.cap
-- lib/capistrano/tasks/nginx.cap
-- lib/capistrano/tasks/puma.cap
-- lib/capistrano/tasks/workers.cap
+- lib/capistrano/tasks/jungle.rake
+- lib/capistrano/tasks/monit.rake
+- lib/capistrano/tasks/nginx.rake
+- lib/capistrano/tasks/puma.rake
+- lib/capistrano/tasks/workers.rake
 - lib/capistrano/templates/nginx_conf.erb
 - lib/capistrano/templates/puma-deb.erb
 - lib/capistrano/templates/puma-rpm.erb

data/lib/capistrano/tasks/nginx.cap

@@ -1,10 +0,0 @@
-namespace :puma do
-  desc "Setup nginx configuration"
-  task :nginx_config do
-    on roles(fetch(:puma_nginx, :web)) do |role|
-      template_puma("nginx_conf", "/tmp/nginx_#{fetch(:nginx_config_name)}", role)
-      sudo :mv, "/tmp/nginx_#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)}"
-      sudo :ln, '-fs', "#{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_enabled_path)}/#{fetch(:nginx_config_name)}"
-    end
-  end
-end