capistrano-nginx 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55d3192b8603820b356596f5f1c9412f0881dbd4
+  data.tar.gz: 974c08a6ae4b2476184b2bd307a647a8cb3b55b7
+SHA512:
+  metadata.gz: 8907ac4fceea95f85121caf1f9985a7d9d24795365f72efd6a85765604f6b9b90709fb4281e3cd9b42842f0092a8437526a9d95d8dcec2f2edbc19901fafa18d
+  data.tar.gz: 26ad384626cce4f1e2c044eedfd5c2484d1b5af5ed9f8d4e2d610386567c206fbfddad7d2d60dfd63c15ec6abbc8d43d21c2b0d8905adb9eb858df44c4d3e6ef

data/.gitignore

@@ -1,18 +1,3 @@
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-/vendor/ruby
+

data/Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in capistrano-nginx.gemspec
 gemspec
-
-gem 'rake'
-gem 'capistrano', '> 2.0.0'
-gem 'railties', '> 3.2.0'

data/LICENSE

@@ -1,22 +1,21 @@
-Copyright (c) 2012 Ivan Tkalin
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2012 Ivan Tkalin
+Copyright (c) 2013 Koen Punt
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,17 +1,15 @@
-# capistrano-nginx
+# Capistrano::nginx
 
-This gem provides two capistrano tasks:
-
-* `nginx:setup` -- creates /etc/nginx/sites-available/YOUR\_APP and links it to /etc/nginx/sites-enabled/YOUR\_APP
-* `nginx:reload` -- invokes `/etc/init.d/nginx reload` on server
-
-And nginx configuration file generator, that will create local copy of default nginx config for customization.
+Nginx support for Capistrano 3.x
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-nginx'
+```ruby
+gem 'capistrano', '~> 3.0.0'
+gem 'capistrano-nginx', github: 'koenpunt/capistrano-nginx'
+```
 
 And then execute:
 
@@ -23,32 +21,46 @@ Or install it yourself as:
 
 ## Usage
 
-Add this to your `config/deploy.rb` file:
+Require in `Capfile`:
 
-    require 'capistrano/nginx/tasks'
+```ruby
+require 'capistrano/nginx'
+```
 
-Make sure, following variables are defined in your `config/deploy.rb`:
+Launch new tasks:
 
-* `application` - application name
-* `server_name` - your application's server_name in nginx (e.g. `example.com`)
-* `deploy_to` - deployment path
-* `sudo_user` - user name with sudo privileges (needed to config/restart nginx)
-* `app_port` - application port (optional)
+    $ cap production nginx:setup
+    $ cap production nginx:reload
 
-Launch new tasks:
+If you want to customize the nginx configuration, you can use the Rails generator to create a local copy of the config template:
 
-    $ cap nginx:setup
-    $ cap nginx:reload
+    $ rails generate capistrano:nginx:config
 
-Or you can add hook to call this tasks after `deploy:setup`. Add to your `config/deploy.rb`:
+And then edit `config/deploy/nginx_conf.erb` as you like.
 
-    after "deploy:setup", "nginx:setup", "nginx:reload"
+Configurable options, shown here with defaults:
 
-If you want to customize nginx configuration, just generate local nginx config before running `nginx:setup`:
+```ruby
+set :nginx_path, '/etc/nginx' # directory containing sites-available and sites-enabled
+set :nginx_template, 'config/deploy/nginx_conf.erb' # configuration template
+set :nginx_server_name, 'example.com' # optional, defaults to :application
+set :nginx_upstream, 'example-app' # optional, defaults to :application
+set :nginx_listen, 80 # optional, default is not set
+set :nginx_roles, :all
+```
 
-    $ rails generate capistrano:nginx:config
+### Tasks
+
+This gem provides the following Capistrano tasks:
 
-And then edit file `config/deploy/nginx_conf.erb` as you like.
+* `nginx:setup` creates `/etc/nginx/sites-available/APPLICATION.conf` and links it to `/etc/nginx/sites-enabled/APPLICATION.conf`
+* `nginx:stop` invokes `service nginx stop` on server
+* `nginx:start` invokes `service nginx start` on server
+* `nginx:restart` invokes `service nginx restart` on server
+* `nginx:reload` invokes `service nginx reload` on server
+* `nginx:force-reload` invokes `service nginx force-reload` on server
+* `nginx:enable_site` creates symlink in sites-enabled directory
+* `nginx:disable_site` removes symlink from sites-enabled directory
 
 ## Contributing
 

data/Rakefile

@@ -1,13 +1 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Run tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+require 'bundler/gem_tasks'

data/capistrano-nginx.gemspec

@@ -1,17 +1,24 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano/nginx/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Ivan Tkalin"]
-  gem.email         = ["itkalin@gmail.com"]
-  gem.description   = "Simple nginx management with capistrano"
-  gem.summary       = "Configuration and managements capistrano tasks for nginx"
-  gem.homepage      = "https://github.com/ivalkeen/capistrano-nginx"
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-nginx'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Ivan Tkalin', 'Koen Punt']
+  spec.email         = ['itkalin@gmail.com', 'mail@koen.pt']
+  spec.description   = %q{Simple nginx management for Capistrano 3.x}
+  spec.summary       = %q{Simple nginx management for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/ivalkeen/capistrano-nginx'
+  spec.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "capistrano-nginx"
-  gem.require_paths = ["lib"]
-  gem.version       = Capistrano::Nginx::VERSION
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 end

data/lib/capistrano-nginx.rb

@@ -1 +0,0 @@
-require "capistrano/nginx/version"

data/lib/capistrano/nginx.rb

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

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,66 @@
+namespace :nginx do
+  desc <<-DESC
+        Setup nginx configuration
+
+        Configurable options are:
+
+          set :nginx_roles, :all
+          set :nginx_path, "/etc/nginx"
+          set :nginx_upstream, -> { fetch(:application) }
+          set :nginx_server_name, -> { fetch(:application) }
+          set :nginx_template, "config/deploy/nginx_conf.erb"
+    DESC
+  task :setup do
+    invoke :'nginx:create_config'
+    invoke :'nginx:enable_site'
+  end
+
+  task :create_config do
+    on roles fetch(:nginx_roles) do
+      config_file = fetch(:nginx_template)
+      unless File.exists?(config_file)
+        config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/nginx/templates/_nginx_conf.erb")
+      end
+      config = ERB.new(File.new(config_file).read, 0, '-').result(binding)
+      upload! StringIO.new(config), "#{fetch(:nginx_path)}/sites-available/#{fetch(:application)}.conf"
+    end
+  end
+
+  [:stop, :start, :restart, :reload, :'force-reload'].each do |action|
+    desc "#{action.to_s.capitalize} nginx"
+    task action do
+      on roles fetch(:nginx_roles) do
+        sudo :service, "nginx", action.to_s
+      end
+    end
+  end
+
+  desc 'Enable nginx site'
+  task :enable_site do
+    on roles fetch(:nginx_roles) do
+      execute :ln, "-sf",
+        "#{fetch(:nginx_path)}/sites-available/#{fetch(:application)}.conf",
+        "#{fetch(:nginx_path)}/sites-enabled/#{fetch(:application)}.conf"
+    end
+    invoke :'nginx:reload'
+  end
+
+  desc 'Disable nginx site'
+  task :disable_site do
+    on roles fetch(:nginx_roles) do
+      config_link = "#{fetch(:nginx_path)}/sites-enabled/#{fetch(:application)}.conf"
+      execute :unlink, config_link if test "[ -f #{config_link} ]"
+    end
+    invoke :'nginx:reload'
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :nginx_roles, :all
+    set :nginx_path, "/etc/nginx"
+    set :nginx_upstream, -> { fetch(:application) }
+    set :nginx_server_name, -> { fetch(:application) }
+    set :nginx_template, "config/deploy/nginx_conf.erb"
+  end
+end

data/lib/generators/capistrano/nginx/templates/_nginx_conf.erb

@@ -1,28 +1,27 @@
-upstream <%= application %> {
-  server unix:/tmp/<%= application %>.sock fail_timeout=0;
+upstream <%= fetch(:nginx_upstream) %> {
+  server unix:/tmp/<%= fetch(:nginx_upstream) %>.sock fail_timeout=0;
 }
 
 server {
-  <% if app_port %>
-  listen <%= app_port %> default deferred;
+  <% if fetch(:nginx_listen, false) %>
+  listen <%= fetch(:nginx_listen) %>;
   <% end %>
-  client_max_body_size 4G;
-  server_name <%= server_name %>;
-  keepalive_timeout 5;
-  root <%= "#{deploy_to}/current/public" %>;
-  try_files $uri/index.html $uri.html $uri @<%= application %>;
-  
+  server_name <%= fetch(:nginx_server_name) %>;
+  root <%= current_path.join('public') %>;
+
+  try_files $uri/index.html $uri.html $uri @<%= fetch(:nginx_upstream) %>;
+
   location ^~ /assets/ {
     gzip_static on;
     expires max;
     add_header Cache-Control public;
   }
-  
-  location @<%= application %> {
+
+  location @<%= fetch(:nginx_upstream) %> {
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header Host $http_host;
     proxy_redirect off;
-    proxy_pass http://<%= application %>;
+    proxy_pass http://<%= fetch(:nginx_upstream) %>;
   }
 
   if (-f $document_root/system/maintenance.html) {
@@ -31,11 +30,11 @@ server {
 
   error_page 500 502 504 /500.html;
   location = /500.html {
-    root <%= "#{deploy_to}/current/public" %>;
+    root <%= current_path.join('public') %>;
   }
 
   error_page 503 @maintenance;
   location @maintenance {
-    rewrite  ^(.*)$  /system/maintenance.html break;
+    rewrite ^(.*)$ /system/maintenance.html break;
   }
 }

metadata

@@ -1,70 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-nginx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Ivan Tkalin
+- Koen Punt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
-dependencies: []
-description: Simple nginx management with capistrano
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Simple nginx management for Capistrano 3.x
 email:
 - itkalin@gmail.com
+- mail@koen.pt
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- CHANGELOG.md
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - capistrano-nginx.gemspec
 - lib/capistrano-nginx.rb
-- lib/capistrano/nginx/tasks.rb
-- lib/capistrano/nginx/version.rb
+- lib/capistrano/nginx.rb
+- lib/capistrano/tasks/nginx.rake
 - lib/generators/capistrano/nginx/USAGE
 - lib/generators/capistrano/nginx/config_generator.rb
 - lib/generators/capistrano/nginx/templates/_nginx_conf.erb
-- test/generator_test.rb
-- test/tasks_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ivalkeen/capistrano-nginx
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1440542809374887780
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1440542809374887780
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: Configuration and managements capistrano tasks for nginx
-test_files:
-- test/generator_test.rb
-- test/tasks_test.rb
-- test/test_helper.rb
+specification_version: 4
+summary: Simple nginx management for Capistrano 3.x
+test_files: []
+has_rdoc: 

data/CHANGELOG.md

@@ -1,3 +0,0 @@
-# Changelog
-
-* 0.1.0 Changed socket file location

data/lib/capistrano/nginx/tasks.rb

@@ -1,22 +0,0 @@
-Capistrano::Configuration.instance.load do
-  namespace :nginx do
-    desc "Setup application in nginx"
-    task "setup", :role => :web do
-      config_file = "config/deploy/nginx_conf.erb"
-      unless File.exists?(config_file)
-        config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/nginx/templates/_nginx_conf.erb")
-      end
-      config = ERB.new(File.read(config_file)).result(binding)
-      set :user, sudo_user
-      put config, "/tmp/#{application}"
-      run "#{sudo} mv /tmp/#{application} /etc/nginx/sites-available/#{application}"
-      run "#{sudo} ln -fs /etc/nginx/sites-available/#{application} /etc/nginx/sites-enabled/#{application}"
-    end
-
-    desc "Reload nginx configuration"
-    task :reload, :role => :web do
-      set :user, sudo_user
-      run "#{sudo} /etc/init.d/nginx reload"
-    end
-  end
-end

data/lib/capistrano/nginx/version.rb

@@ -1,5 +0,0 @@
-module Capistrano
-  module Nginx
-    VERSION = "0.1.0"
-  end
-end

data/test/generator_test.rb

@@ -1,15 +0,0 @@
-require 'test_helper'
-require 'rails/generators/test_case'
-require 'generators/capistrano/nginx/config_generator'
-
-class GeneratorTest < Rails::Generators::TestCase
-  tests Capistrano::Nginx::Generators::ConfigGenerator
-  destination File.expand_path('../../tmp', __FILE__)
-  setup :prepare_destination
-  teardown { rm_rf(destination_root) }
-
-  def test_generates_local_config_file
-    run_generator
-    assert_file 'config/deploy/nginx_conf.erb'
-  end
-end

data/test/tasks_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-require 'capistrano'
-
-class TasksTest < Test::Unit::TestCase
-  def setup
-    @config = Capistrano::Configuration.new
-    Capistrano::Configuration.instance = @config
-    task = @config.find_task("nginx:setup")
-    load 'capistrano/nginx/tasks.rb'
-  end
-
-  def test_add_setup_task
-    namespace = @config.namespaces[:nginx]
-    assert_not_nil namespace
-    setup_task = namespace.tasks[:setup]
-    assert_not_nil setup_task
-  end
-
-  def test_add_reload_task
-    namespace = @config.namespaces[:nginx]
-    assert_not_nil namespace
-    setup_task = namespace.tasks[:reload]
-    assert_not_nil setup_task
-  end
-end

data/test/test_helper.rb

@@ -1,3 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'test/unit'