capistrano3-nginx 2.1.5 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37100c96a8f917608bc0981cc8ec8144973145d4
-  data.tar.gz: 4d6de10e7b03e5d7874d1fa23db043f31d534e0c
+  metadata.gz: 3804ce5785ee1dddb14d9cf3ddda85b74074bf45
+  data.tar.gz: cd007e618b312e377fa5e30bf4d1560ef8ae1ea8
 SHA512:
-  metadata.gz: 800a1bcd432da6b99babf3dac3831b1d67080d0db6df49d8895c1a3ed70358b5baba283f72c0f4ce6f726e1d43429e33ab9f9187b8fb7b34acdec4fae0c111a9
-  data.tar.gz: 8372ad6416a8e46f0c21d9a321185d3920f87b98343f4750bc837d08a8d9f0b6bfafb52d66fd058203c8c1998f9c3e612dcc3ccffa1f0d8d2318d3b627b499a9
+  metadata.gz: e79ec054bf79f0571a92472266faa742e7c7938a76f4a4ba1a29c1ca1611bee2a80a94bb698d4920a80642cb3d78e2a635a851cd70e480bd94f2542d290d8385
+  data.tar.gz: 654e4eab16f2486e071dc882495bfc5b87c5b7526c45ef9dfc09a903203e3ef01afc3e18c9c731510aec88dceb8bade37ea93fb120e57e59175740f6fafae4ab

data/.gitignore

@@ -1 +1,2 @@
 pkg/
+*.gem

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    capistrano3-nginx (2.2)
+      capistrano (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.1.2)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.8.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    i18n (0.8.6)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.1.0)
+    rake (12.3.0)
+    sshkit (1.12.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano3-nginx!
+  rake
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,13 +1,12 @@
-# Capistrano::Nginx [![Gem Version](https://badge.fury.io/rb/capistrano3-nginx.svg)](http://badge.fury.io/rb/capistrano3-nginx)
 
-Nginx support for Capistrano 3.x
+Nginx support for Capistrano 3.x, with sudo password prompt
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano3-nginx', '~> 2.0'
-    gem 'capistrano'
+    gem 'capistrano3-nginx', '~> 3.0.4'
+
 
 And then execute:
 
@@ -23,10 +22,29 @@ Require in `Capfile` to use the default task:
 
 ```ruby
 require 'capistrano/nginx'
+install_plugin Capistrano::Nginx
+```
+
+Make sure pty is enabled in deploy.rb
+
+```ruby
+set :pty, true
 ```
 
+Make sure server has sudo role
+
+```ruby
+server 'example.com',
+  user: 'with_sudo_access',
+  roles: %w{sudo}
+```  
+
 You will get the following tasks
 
+```sh
+cap -T | grep "cap nginx"
+```
+
 ```ruby
 cap nginx:start                    # Start nginx service
 cap nginx:stop                     # Stop nginx service
@@ -37,8 +55,12 @@ cap nginx:site:disable             # Disables the site removing the symbolic lin
 cap nginx:site:enable              # Enables the site creating a symbolic link into the enabled folder
 cap nginx:site:remove              # Removes the site removing the configuration file from the available folder
 cap nginx:gzip_static              # Compress all js and css files in :nginx_static_dir with gzip
+cap nginx:configtest               # Configtest nginx service
 ```
 
+
+
+
 Configurable options (copy into deploy.rb), shown here with examples:
 
 ```ruby
@@ -68,12 +90,13 @@ set :nginx_redirected_domains, "bar.com other.com"
 set :nginx_service_path, "/etc/init.d/nginx"
 
 # Roles the deploy nginx site on,
-# default value: :web
-set :nginx_roles, :web
+# default value: :sudo
+set :nginx_roles, :sudo
 
 # Path, where nginx log file will be stored
+# set it nil if don't want to override log path 
 # default value:  "#{shared_path}/log"
-# set :nginx_log_path, "#{shared_path}/log"
+set :nginx_log_path, nil
 
 # Path where to look for static files
 # default value: "public"
@@ -142,22 +165,3 @@ set :app_server_port, 8080
 ## Thanks
 Thansk for the inspiration on several nginx recipes out there
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-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
-
-## Credits
-
-Thank you [contributors](https://github.com/platanus/guides/graphs/contributors)!
-
-<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
-
-capistrano3-nginx is maintained by [platanus](http://platan.us).
-
-## License
-
-Guides is © 2014 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/capistrano3-nginx.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/nginx/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano3-nginx'
-  spec.version       = '2.1.5'
-  spec.authors       = ['Juan Ignacio Donoso']
-  spec.email         = ['jidonoso@gmail.com']
+  spec.version       = Capistrano::NGINX_VERSION
+  spec.authors       = ['Juan Ignacio Donoso', 'treenewbee']
   spec.description   = %q{Adds suuport to nginx for Capistrano 3.x}
   spec.summary       = %q{Adds suuport to nginx for Capistrano 3.x}
-  spec.homepage      = 'https://github.com/platanus/capistrano3-nginx'
+  spec.homepage      = 'https://github.com/treenewbee/capistrano3-nginx'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'capistrano', '>= 3.0.0'
+  spec.add_dependency 'capistrano', '~> 3.0'
 
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake', '~> 0'
 end

data/lib/capistrano/nginx/version.rb

@@ -0,0 +1,3 @@
+module Capistrano
+  NGINX_VERSION = '3.0.4'
+end

data/lib/capistrano/nginx.rb

@@ -1 +1,56 @@
-load File.expand_path('../tasks/nginx.rake', __FILE__)
+require "capistrano/plugin"
+module Capistrano
+  class Nginx < Capistrano::Plugin
+
+    def set_defaults
+      set :nginx_sudo_paths,          -> { [:nginx_log_path, :nginx_sites_enabled_dir, :nginx_sites_available_dir] }
+      set :nginx_sudo_tasks,          -> { ['nginx:start', 'nginx:stop', 'nginx:restart', 'nginx:reload', 'nginx:configtest', 'nginx:site:add', 'nginx:site:disable', 'nginx:site:enable', 'nginx:site:remove' ] }
+      set :nginx_log_path,            -> { "#{shared_path}/log" }
+      set :nginx_service_path,        -> { 'service nginx' }
+      set :nginx_static_dir,          -> { "public" }
+      set :nginx_application_name,    -> { fetch(:application) }
+      set :nginx_sites_enabled_dir,   -> { "/etc/nginx/sites-enabled" }
+      set :nginx_sites_available_dir, -> { "/etc/nginx/sites-available" }
+      set :nginx_roles,               -> { :sudo }
+      set :nginx_template,            -> { :default }
+      set :nginx_use_ssl,             -> { false }
+      set :nginx_ssl_certificate,          -> { "#{fetch(:application)}.crt" }
+      set :nginx_ssl_certificate_path,     -> { '/etc/ssl/certs' }
+      set :nginx_ssl_certificate_key,      -> { "#{fetch(:application)}.key" }
+      set :nginx_ssl_certificate_key_path, -> { '/etc/ssl/private' }
+      set :app_server,                     -> { true }
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../tasks/nginx.rake', __FILE__)
+    end
+
+    # prepend :sudo to list if arguments if :key is in :nginx_use_sudo_for list
+    def add_sudo_if_required argument_list, *keys
+      keys.each do | key |
+        if nginx_use_sudo? key
+          argument_list.unshift(:sudo)
+          break
+        end
+      end
+    end
+
+    def nginx_use_sudo? key
+      (fetch(:nginx_sudo_tasks).include?(key) || fetch(:nginx_sudo_paths).include?(key))
+    end
+
+    class PasswdInteractionHandler
+      def on_data(command, stream_name, data, channel)
+        if data.include?("[sudo]")
+          ask(:password, 'sudo', echo: false)
+          channel.send_data("#{fetch(:password)}\n")
+        elsif data.include?("UNIX password")
+          ask(:password, 'UNIX', echo: false)
+          channel.send_data("#{fetch(:password)}\n")
+        else
+        end
+      end
+    end
+
+  end
+end

data/lib/capistrano/tasks/nginx.rake

@@ -1,46 +1,6 @@
-namespace :load do
-  task :defaults do
-    set :nginx_sudo_paths,          -> { [:nginx_log_path, :nginx_sites_enabled_dir, :nginx_sites_available_dir] }
-    set :nginx_sudo_tasks,          -> { ['nginx:start', 'nginx:stop', 'nginx:restart', 'nginx:reload', 'nginx:configtest', 'nginx:site:add', 'nginx:site:disable', 'nginx:site:enable', 'nginx:site:remove' ] }
-    set :nginx_log_path,            -> { "#{shared_path}/log" }
-    set :nginx_service_path,        -> { 'service nginx' }
-    set :nginx_static_dir,          -> { "public" }
-    set :nginx_application_name,    -> { fetch(:application) }
-    set :nginx_sites_enabled_dir,   -> { "/etc/nginx/sites-enabled" }
-    set :nginx_sites_available_dir, -> { "/etc/nginx/sites-available" }
-    set :nginx_roles,               -> { :web }
-    set :nginx_template,            -> { :default }
-    set :nginx_use_ssl,             -> { false }
-    set :nginx_ssl_certificate,          -> { "#{fetch(:application)}.crt" }
-    set :nginx_ssl_certificate_path,     -> { '/etc/ssl/certs' }
-    set :nginx_ssl_certificate_key,      -> { "#{fetch(:application)}.key" }
-    set :nginx_ssl_certificate_key_path, -> { '/etc/ssl/private' }
-    set :app_server,                     -> { true }
-  end
-end
+git_plugin = self
 
 namespace :nginx do
-
-  # prepend :sudo to list if arguments if :key is in :nginx_use_sudo_for list
-  def add_sudo_if_required argument_list, *keys
-    keys.each do | key |
-      if use_sudo? key
-        argument_list.unshift(:sudo)
-        break
-      end
-    end
-  end
-
-  def use_sudo? key
-    return (fetch(:nginx_sudo_tasks).include?(key) || fetch(:nginx_sudo_paths).include?(key))
-  end
-
-  def valid_nginx_config?
-    test_sudo = use_sudo?('nginx:configtest') ? 'sudo ' : ''
-    nginx_service = fetch(:nginx_service_path)
-    test "[ $(#{test_sudo}#{nginx_service} configtest | grep -c 'fail') -eq 0 ]"
-  end
-
   task :load_vars do
     set :sites_available,       -> { fetch(:nginx_sites_available_dir) }
     set :sites_enabled,         -> { fetch(:nginx_sites_enabled_dir) }
@@ -48,6 +8,8 @@ namespace :nginx do
     set :available_application, -> { File.join(fetch(:sites_available), fetch(:nginx_application_name)) }
   end
 
+
+
   # validate_sudo_settings
   task :validate_user_settings do
     path_and_dir_keys = [:nginx_log_path, :nginx_sites_enabled_dir, :nginx_sites_available_dir]
@@ -64,7 +26,11 @@ namespace :nginx do
   desc "Configtest nginx service"
   task :configtest do
     on release_roles fetch(:nginx_roles) do
-      abort("nginx configuration is invalid! (Make sure nginx configuration files are readable and correctly formated.)") unless valid_nginx_config?
+      nginx_service = fetch(:nginx_service_path)
+      execute(
+          "sudo #{nginx_service} configtest",
+          interaction_handler: PasswdInteractionHandler.new
+      )
     end
   end
 
@@ -73,8 +39,8 @@ namespace :nginx do
     task command => ['nginx:validate_user_settings'] do
       on release_roles fetch(:nginx_roles) do
         arguments = fetch(:nginx_service_path), command
-        add_sudo_if_required arguments, "nginx:#{command}"
-        execute *arguments
+        git_plugin.add_sudo_if_required arguments, "nginx:#{command}"
+        execute *arguments, interaction_handler: PasswdInteractionHandler.new
       end
     end
     before "nginx:#{command}", 'nginx:configtest' unless command == 'stop'
@@ -83,17 +49,19 @@ namespace :nginx do
   task :create_log_paths do
     on release_roles fetch(:nginx_roles) do
       arguments = :mkdir, '-pv', fetch(:nginx_log_path)
-      add_sudo_if_required arguments, :nginx_log_path
-      execute *arguments
+      git_plugin.add_sudo_if_required arguments, :nginx_log_path
+      execute *arguments, interaction_handler: PasswdInteractionHandler.new
     end
   end
-  after 'deploy:check', 'nginx:create_log_paths'
+  after 'deploy:check', 'nginx:create_log_paths' if fetch(:nginx_log_path)
 
   desc 'Compress JS and CSS with gzip'
   task :gzip_static => ['nginx:load_vars'] do
     on release_roles fetch(:nginx_roles) do
       within release_path do
-        execute :find, "'#{fetch(:nginx_static_dir)}' -type f -name '*.js' -o -name '*.css' -exec gzip -v -9 -f -k {} \\;"
+        arguments = :find, "'#{fetch(:nginx_static_dir)}' -type f -name '*.js' -o -name '*.css' -exec gzip -v -9 -f -k {} \\;"
+        git_plugin.add_sudo_if_required arguments, :gzip_static
+        execute *arguments, interaction_handler: PasswdInteractionHandler.new
       end
     end
   end
@@ -105,13 +73,13 @@ namespace :nginx do
         within fetch(:sites_available) do
           config_file = fetch(:nginx_template)
           if config_file == :default
-              config_file = File.expand_path('../../../../templates/nginx.conf.erb', __FILE__)
+            config_file = File.expand_path('../../../../templates/nginx.conf.erb', __FILE__)
           end
           config = ERB.new(File.read(config_file)).result(binding)
           upload! StringIO.new(config), '/tmp/nginx.conf'
           arguments = :mv, '/tmp/nginx.conf', fetch(:nginx_application_name)
-          add_sudo_if_required arguments, 'nginx:sites:add', :nginx_sites_available_dir
-          execute *arguments
+          git_plugin.add_sudo_if_required arguments, 'nginx:sites:add', :nginx_sites_available_dir
+          execute *arguments, interaction_handler: PasswdInteractionHandler.new
         end
       end
     end
@@ -122,8 +90,8 @@ namespace :nginx do
         if test "! [ -h #{fetch(:enabled_application)} ]"
           within fetch(:sites_enabled) do
             arguments = :ln, '-nfs', fetch(:available_application), fetch(:enabled_application)
-            add_sudo_if_required arguments, 'nginx:sites:enable', :nginx_sites_enabled_dir
-            execute *arguments
+            git_plugin.add_sudo_if_required arguments, 'nginx:sites:enable', :nginx_sites_enabled_dir
+            execute *arguments, interaction_handler: PasswdInteractionHandler.new
           end
         end
       end
@@ -135,8 +103,8 @@ namespace :nginx do
         if test "[ -f #{fetch(:enabled_application)} ]"
           within fetch(:sites_enabled) do
             arguments = :rm, '-f', fetch(:nginx_application_name)
-            add_sudo_if_required arguments, 'nginx:sites:disable', :nginx_sites_enabled_dir
-            execute *arguments
+            git_plugin.add_sudo_if_required arguments, 'nginx:sites:disable', :nginx_sites_enabled_dir
+            execute *arguments, interaction_handler: PasswdInteractionHandler.new
           end
         end
       end
@@ -148,11 +116,12 @@ namespace :nginx do
         if test "[ -f #{fetch(:available_application)} ]"
           within fetch(:sites_available) do
             arguments = :rm, fetch(:nginx_application_name)
-            add_sudo_if_required arguments, 'nginx:sites:remove', :nginx_sites_available_dir
-            execute *arguments
+            git_plugin.add_sudo_if_required arguments, 'nginx:sites:remove', :nginx_sites_available_dir
+            execute *arguments, interaction_handler: PasswdInteractionHandler.new
           end
         end
       end
     end
   end
+
 end

data/templates/nginx.conf.erb

@@ -32,7 +32,9 @@ server {
 <% if fetch(:nginx_use_ssl) %>
   listen 443;
   ssl on;
-  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+  #ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+  ssl_protocols TLSv1.2;
+  ssl_ciphers HIGH:!aNULL:!MD5:!3DES;
   ssl_certificate <%= fetch(:nginx_ssl_certificate_path) %>/<%= fetch(:nginx_ssl_certificate) %>;
   ssl_certificate_key <%= fetch(:nginx_ssl_certificate_key_path) %>/<%= fetch(:nginx_ssl_certificate_key) %>;
 <% else %>
@@ -54,6 +56,11 @@ server {
   client_max_body_size 4G;
   keepalive_timeout 10;
 
+<% if fetch(:nginx_auth_basic_user_file) %>
+  auth_basic "Restricted Area";
+  auth_basic_user_file <%= fetch(:nginx_auth_basic_user_file) %>;
+<% end %>
+
 <% if fetch(:app_server) && (fetch(:app_server_socket) || fetch(:app_server_port))%>
   location ^~ /assets/ {
     gzip_static on;
@@ -66,10 +73,12 @@ server {
   location @<%= fetch(:application) %>-app-server {
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header X-FORWARDED_PROTO http;
     proxy_set_header Host $http_host;
   <% if fetch(:nginx_use_ssl) %>
     proxy_set_header X-Forwarded-Proto https;
+    proxy_set_header X-Forwarded-Ssl on;
+  <% else %>
+    proxy_set_header X-Forwarded-Proto http;
   <% end %>
   <% if fetch(:nginx_read_timeout) %>
     proxy_read_timeout <%= fetch(:nginx_read_timeout) %>;

metadata

@@ -1,62 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-nginx
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 3.0.4
 platform: ruby
 authors:
 - Juan Ignacio Donoso
+- treenewbee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Adds suuport to nginx for Capistrano 3.x
-email:
-- jidonoso@gmail.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - capistrano3-nginx.gemspec
 - lib/capistrano/nginx.rb
+- lib/capistrano/nginx/version.rb
 - lib/capistrano/tasks/nginx.rake
 - lib/capistrano3-nginx.rb
 - templates/nginx.conf.erb
-homepage: https://github.com/platanus/capistrano3-nginx
+homepage: https://github.com/treenewbee/capistrano3-nginx
 licenses:
 - MIT
 metadata: {}
@@ -76,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Adds suuport to nginx for Capistrano 3.x
 test_files: []
-has_rdoc: