capistrano3-puma 3.1.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 056f0e760a8050adbfa58de07ea92a2cd19155f6
-  data.tar.gz: 3606335e1e591fa8ec64799560f3305537232662
+SHA256:
+  metadata.gz: 2556d3d0f9c69518e9b8fff34c4e9a5414df32421c886749c5780ea76d4a29ab
+  data.tar.gz: 346d5440671df45a98bb55b9156de333b6d75978c8370f323b8e191f87f5e84c
 SHA512:
-  metadata.gz: 33112a1a74246ab3b71228d1b0a29cf82c8a04b18408dda5607505ffb9e65519e5cb7d07d5239e75a28b73d99e7f05462d83e3a1421187316d76aa92d41247e3
-  data.tar.gz: 45cf98d18423e1bf5da1a038051ceadfc2301b008120d1106ee749536f999bbd269f3bde6978c3c13723d4faa475d0c11c119971e52b60ca09c0dbc705049462
+  metadata.gz: e223d91b3153aa0cd69ffb59ffa21f3ac4d49c98f006825930ad4ea385c6d89e79d61d2478af3314e583abcfc596dcef180fed80b7d2f6f7c5fa93f2169a76c1
+  data.tar.gz: 6f1db9884b136d4595e65f7dc2bc7eb3027e8603e74e3f985b014a912ee8729c83b223a118ea37b39aa3981a82cead762fc26c959b4b171132624708400709f6

data/CHANGELOG.md

@@ -1,16 +1,21 @@
 ## Changelog
-- 3.1.0: 
+- 5.0.0:
+  - Support puma 5.0
+  - Support SystemD service manager
+- 4.0.0:
+  - Support puma 4.x
+- 3.1.0:
   - Don't load puma hooks by default.
 - 3.0.0:
- - Require capistrano 3.7+
- - Implement the plugin system
- - don't fail if puma was already running
- - Added :puma_daemonize option (default is false)
+   - Require capistrano 3.7+
+   - Implement the plugin system
+   - don't fail if puma was already running
+   - Added :puma_daemonize option (default is false)
 
 - 2.0.0: 
- - Require puma 3.4+
- - Require Capistrano 3.5+
- - Require capistrano-bundler
+   - Require puma 3.4+
+   - Require Capistrano 3.5+
+   - Require capistrano-bundler
  
 - 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

data/CONTRIBUTORS.md

@@ -45,3 +45,4 @@
 - Suraj Shirvankar
 - marshall-lee
 - ruohan chen
+- ayaya zhao

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2017 Abdelkader Boudih
+Copyright (c) 2013-2020 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

@@ -26,6 +26,14 @@ And then execute:
     install_plugin Capistrano::Puma::Monit  # if you need the monit tasks
     install_plugin Capistrano::Puma::Nginx  # if you want to upload a nginx site template
 ```
+You will need to select your service manager
+```ruby
+install_plugin Capistrano::Puma::Daemon  # If you using puma daemonized (not supported in Puma 5+)
+```
+or
+```ruby
+install_plugin Capistrano::Puma::Systemd  # if you use SystemD 
+```
 
 To prevent loading the hooks of the plugin, add false to the load_hooks param.
 ```ruby
@@ -36,6 +44,15 @@ To prevent loading the hooks of the plugin, add false to the load_hooks param.
     install_plugin Capistrano::Puma::Monit, load_hooks: false  # Monit tasks without hooks
 ```
 
+To make it work with rvm, rbenv and chruby, install the plugin after corresponding library inclusion.
+```ruby
+    # Capfile
+    
+    require 'capistrano/rbenv'   
+    require 'capistrano/puma'
+    install_plugin Capistrano::Puma
+```
+
 ### Config
 
 To list available tasks use `cap -T`
@@ -44,7 +61,7 @@ To upload puma config use:
 ```ruby
 cap production puma:config
 ```
-By default the file located in  `shared/puma.config`
+By default the file located in  `shared/puma.rb`
 
 
 Ensure that `tmp/pids` and ` tmp/sockets log` are shared (via `linked_dirs`):
@@ -86,13 +103,26 @@ For Jungle tasks (beta), these options exist:
     set :puma_run_path, '/usr/local/bin/run-puma'
 ```
 
+### Systemd
+
+Install Systemd plugin in `Capfile`:
+```ruby
+install_plugin Capistrano::Puma
+install_plugin Capistrano::Puma::Systemd
+```
+
+To generate unit file use:
+```
+cap production puma:systemd:config puma:systemd:enable
+```
+
 ### Multi bind
 
 Multi-bind can be set with an array in the puma_bind variable
 ```ruby
   set :puma_bind, %w(tcp://0.0.0.0:9292 unix:///tmp/puma.sock)
 ```
-    * Listening on tcp://0.0.0.0:9220
+    * Listening on tcp://0.0.0.0:9292
     * Listening on unix:///tmp/puma.sock
 
 ### Active Record
@@ -127,6 +157,7 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_daemonize, false
     set :puma_plugins, []  #accept array of plugins
     set :puma_tag, fetch(:application)
+    set :puma_restart_command, 'bundle exec puma'
 
     set :nginx_config_name, "#{fetch(:application)}_#{fetch(:stage)}"
     set :nginx_flags, 'fail_timeout=0'
@@ -135,9 +166,11 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :nginx_sites_available_path, '/etc/nginx/sites-available'
     set :nginx_sites_enabled_path, '/etc/nginx/sites-enabled'
     set :nginx_socket_flags, fetch(:nginx_flags)
-    set :nginx_ssl_certificate, "/etc/ssl/certs/{fetch(:nginx_config_name)}.crt"
-    set :nginx_ssl_certificate_key, "/etc/ssl/private/{fetch(:nginx_config_name)}.key"
+    set :nginx_ssl_certificate, "/etc/ssl/certs/#{fetch(:nginx_config_name)}.crt"
+    set :nginx_ssl_certificate_key, "/etc/ssl/private/#{fetch(:nginx_config_name)}.key"
     set :nginx_use_ssl, false
+    set :nginx_use_http2, true
+    set :nginx_downstream_uses_ssl, false
 ```
 
 __Notes:__ If you are setting values for variables that might be used by other plugins, use `append` instead of `set`. For example:

data/capistrano3-puma.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'capistrano', '~> 3.7'
   spec.add_dependency 'capistrano-bundler'
-  spec.add_dependency 'puma' , '~> 3.4'
+  spec.add_dependency 'puma' , '>= 4.0', '< 6.0'
   spec.post_install_message = %q{
     All plugins need to be explicitly installed with install_plugin.
     Please see README.md

data/lib/capistrano/puma.rb

@@ -76,6 +76,7 @@ module Capistrano
       set_if_empty :puma_preload_app, false
       set_if_empty :puma_daemonize, false
       set_if_empty :puma_tag, ''
+      set_if_empty :puma_restart_command, 'bundle exec puma'
 
       # Chruby, Rbenv and RVM integration
       append :chruby_map_bins, 'puma', 'pumactl'
@@ -88,7 +89,6 @@ module Capistrano
 
     def register_hooks
       after 'deploy:check', 'puma:check'
-      after 'deploy:finished', 'puma:smart_restart'
     end
 
     def puma_workers
@@ -116,6 +116,8 @@ module Capistrano
 end
 
 require 'capistrano/puma/workers'
+require 'capistrano/puma/daemon'
+require 'capistrano/puma/systemd'
 require 'capistrano/puma/monit'
 require 'capistrano/puma/jungle'
 require 'capistrano/puma/nginx'

data/lib/capistrano/puma/daemon.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  class Puma::Daemon < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:smart_restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/daemon.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/puma/nginx.rb

@@ -11,6 +11,8 @@ module Capistrano
       set_if_empty :nginx_http_flags, fetch(:nginx_flags)
       set_if_empty :nginx_socket_flags, fetch(:nginx_flags)
       set_if_empty :nginx_use_ssl, false
+      set_if_empty :nginx_use_http2, true
+      set_if_empty :nginx_downstream_uses_ssl, false
     end
 
     def define_tasks

data/lib/capistrano/puma/systemd.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  class Puma::Systemd < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/systemd.rake', __FILE__)
+    end
+
+    def set_defaults
+      set_if_empty :puma_systemd_conf_dir, '/etc/systemd/system'
+      set_if_empty :puma_systemctl_bin, '/bin/systemctl'
+      set_if_empty :puma_service_unit_name, 'puma'
+    end
+  end
+end

data/lib/capistrano/puma/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  PUMAVERSION = '3.1.1'
+  PUMAVERSION = '5.0.2'
 end

data/lib/capistrano/tasks/daemon.rake

@@ -0,0 +1,74 @@
+git_plugin = self
+
+namespace :puma do
+  desc 'Start puma'
+  task :start do
+    on roles(fetch(:puma_role)) do |role|
+      git_plugin.puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+          info 'Puma is already running'
+        else
+          within current_path do
+            with rack_env: fetch(:puma_env) do
+              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w[halt stop status].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          git_plugin.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 :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+                else
+                  # delete invalid pid file , process is not running.
+                  execute :rm, fetch(:puma_pid)
+                end
+              else
+                #pid file not found, so puma is probably not running or it using another pidfile
+                warn 'Puma not running'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w[phased-restart restart].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          git_plugin.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 :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+              else
+                # Puma is not running or state file is not present : Run it
+                invoke 'puma:start'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  task :smart_restart do
+    if !fetch(:puma_preload_app) && fetch(:puma_workers, 0).to_i > 1
+      invoke 'puma:phased-restart'
+    else
+      invoke 'puma:restart'
+    end
+  end
+end

data/lib/capistrano/tasks/jungle.rake

@@ -39,7 +39,7 @@ namespace :puma do
     task :add do
       on roles(fetch(:puma_role)) do|role|
         begin
-          sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)}"
+          sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)} '#{fetch(:puma_conf)}'"
         rescue => error
           warn error
         end

data/lib/capistrano/tasks/puma.rake

@@ -8,75 +8,6 @@ namespace :puma do
     end
   end
 
-  desc 'Start puma'
-  task :start do
-    on roles(fetch(:puma_role)) do |role|
-      git_plugin.puma_switch_user(role) do
-        if test "[ -f #{fetch(:puma_conf)} ]"
-          info "using conf file #{fetch(:puma_conf)}"
-        else
-          invoke 'puma:config'
-        end
-
-        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
-          info 'Already Puma is running'
-        else
-          within current_path do
-            with rack_env: fetch(:puma_env) do
-              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
-            end
-          end
-        end
-      end
-    end
-  end
-
-  %w[halt stop status].map do |command|
-    desc "#{command} puma"
-    task command do
-      on roles (fetch(:puma_role)) do |role|
-        within current_path do
-          git_plugin.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 :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
-                else
-                  # delete invalid pid file , process is not running.
-                  execute :rm, fetch(:puma_pid)
-                end
-              else
-                #pid file not found, so puma is probably not running or it using another pidfile
-                warn 'Puma not running'
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
-  %w[phased-restart restart].map do |command|
-    desc "#{command} puma"
-    task command do
-      on roles (fetch(:puma_role)) do |role|
-        within current_path do
-          git_plugin.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 :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
-              else
-                # Puma is not running or state file is not present : Run it
-                invoke 'puma:start'
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
   task :check do
     on roles(fetch(:puma_role)) do |role|
       #Create puma.rb for new deployments
@@ -87,14 +18,4 @@ namespace :puma do
       end
     end
   end
-
-
-  task :smart_restart do
-    if !git_plugin.puma_preload_app? && git_plugin.puma_workers.to_i > 1
-      invoke 'puma:phased-restart'
-    else
-      invoke 'puma:restart'
-    end
-  end
-
 end

data/lib/capistrano/tasks/systemd.rake

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+git_plugin = self
+
+namespace :puma do
+  namespace :systemd do
+    desc 'Config Puma systemd service'
+    task :config do
+      on roles(fetch(:puma_role)) do |role|
+        unit_filename = "#{fetch(:puma_service_unit_name)}.service"
+        git_plugin.template_puma 'puma.service', "#{fetch(:tmp_dir)}/#{unit_filename}", role
+        sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{fetch(:puma_systemd_conf_dir)}"
+        sudo "#{fetch(:puma_systemctl_bin)} daemon-reload"
+      end
+    end
+
+    desc 'Enable Puma systemd service'
+    task :enable do
+      on roles(fetch(:puma_role)) do
+        sudo "#{fetch(:puma_systemctl_bin)} enable #{fetch(:puma_service_unit_name)}"
+      end
+    end
+
+    desc 'Disable Puma systemd service'
+    task :disable do
+      on roles(fetch(:puma_role)) do
+        sudo "#{fetch(:puma_systemctl_bin)} disable #{fetch(:puma_service_unit_name)}"
+      end
+    end
+  end
+
+  desc 'Start Puma service via systemd'
+  task :start do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} start #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Stop Puma service via systemd'
+  task :stop do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} stop #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Restart Puma service via systemd'
+  task :restart do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} restart #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Get Puma service status via systemd'
+  task :status do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} status #{fetch(:puma_service_unit_name)}"
+    end
+  end
+end

data/lib/capistrano/templates/nginx_conf.erb

@@ -20,8 +20,11 @@ server {
 
 server {
 <% if fetch(:nginx_use_ssl) -%>
-  listen 443;
-  ssl on;
+  <% if fetch(:nginx_use_http2) -%>
+  listen 443 ssl http2;
+  <% else -%>
+  listen 443 ssl;
+  <% end -%>
 <% if fetch(:nginx_ssl_certificate) -%>
   ssl_certificate <%= fetch(:nginx_ssl_certificate) %>;
 <% else -%>
@@ -46,6 +49,7 @@ server {
   error_page 503 @503;
 
   location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_http_version 1.1;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header Host $host;
     proxy_redirect off;
@@ -54,7 +58,11 @@ server {
 <% if fetch(:nginx_use_ssl) -%>
     proxy_set_header X-Forwarded-Proto https;
 <% else -%>
+  <% if fetch(:nginx_downstream_uses_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+  <% else -%>
     proxy_set_header X-Forwarded-Proto http;
+  <% end -%>
 <% end -%>
     proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
     # limit_req zone=one;

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

@@ -28,6 +28,8 @@ worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
 daemonize
 <% end %>
 
+restart_command '<%= fetch(:puma_restart_command) %>'
+
 <% if puma_preload_app? %>
 preload_app!
 <% else %>

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

@@ -0,0 +1,18 @@
+[Unit]
+Description=Puma HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=network.target
+
+[Service]
+Type=simple
+User=<%= puma_user(@role) %>
+WorkingDirectory=<%= current_path %>
+ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec puma -C <%= fetch(:puma_conf) %>
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+StandardOutput=append:<%= fetch(:puma_access_log) %>
+StandardError=append:<%= fetch(:puma_error_log) %>
+
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -42,16 +42,22 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
 description: Puma integration for Capistrano 3
 email:
 - Terminale@gmail.com
@@ -68,20 +74,25 @@ files:
 - Rakefile
 - capistrano3-puma.gemspec
 - lib/capistrano/puma.rb
+- lib/capistrano/puma/daemon.rb
 - lib/capistrano/puma/jungle.rb
 - lib/capistrano/puma/monit.rb
 - lib/capistrano/puma/nginx.rb
+- lib/capistrano/puma/systemd.rb
 - lib/capistrano/puma/version.rb
 - lib/capistrano/puma/workers.rb
+- lib/capistrano/tasks/daemon.rake
 - lib/capistrano/tasks/jungle.rake
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/nginx.rake
 - lib/capistrano/tasks/puma.rake
+- lib/capistrano/tasks/systemd.rake
 - lib/capistrano/tasks/workers.rake
 - lib/capistrano/templates/nginx_conf.erb
 - lib/capistrano/templates/puma-deb.erb
 - lib/capistrano/templates/puma-rpm.erb
 - lib/capistrano/templates/puma.rb.erb
+- lib/capistrano/templates/puma.service.erb
 - lib/capistrano/templates/puma_monit.conf.erb
 - lib/capistrano/templates/run-puma.erb
 - lib/capistrano3-puma.rb
@@ -107,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Puma integration for Capistrano
 test_files: []