capistrano-nginx 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Tkalin
+
+MIT License
+
+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 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.markdown

@@ -0,0 +1,54 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-nginx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-nginx
+
+## Usage
+
+Add this to your `config/deploy.rb` file:
+
+    require 'capistrano/nginx/tasks'
+
+Make sure, following variables are defined in your `config/deploy.rb`:
+
+* `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)
+
+Launch new tasks:
+
+    $ cap nginx:setup
+    $ cap nginx:reload
+
+If you want to customize nginx configuration, just generate local nginx config before running `nginx:setup`:
+
+    $ rails generate capistrano:nginx:config
+
+And then edit file `config/deploy/nginx_conf.erb` as you like.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+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

data/capistrano-nginx.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano/nginx/version', __FILE__)
+
+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.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
+end

data/lib/capistrano-nginx.rb

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

data/lib/capistrano/nginx/tasks.rb

@@ -0,0 +1,22 @@
+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

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

data/lib/generators/capistrano/nginx/USAGE

@@ -0,0 +1,3 @@
+To create local nginx configuration file call
+
+    rails generate capistrano:nginx:config

data/lib/generators/capistrano/nginx/config_generator.rb

@@ -0,0 +1,14 @@
+module Capistrano
+  module Nginx
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local nginx configuration file for customization"
+        source_root File.expand_path('../templates', __FILE__)
+
+        def copy_template
+          copy_file "_nginx_conf.erb", "config/deploy/nginx_conf.erb"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+upstream <%= application %> {
+  server <%= "unix:#{deploy_to}/current/tmp/sockets/unicorn.sock fail_timeout=0" %>;
+}
+
+server {
+  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 %>;
+
+  location @<%= application %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://<%= application %>;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+
+  error_page 500 502 504 /500.html;
+  location = /500.html {
+    root <%= "#{deploy_to}/current/public" %>;
+  }
+
+  error_page 503 @maintenance;
+  location @maintenance {
+    rewrite  ^(.*)$  /system/maintenance.html break;
+  }
+}

data/test/generator_test.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,26 @@
+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

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-nginx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Tkalin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000 Z
+dependencies: []
+description: Simple nginx management with capistrano
+email:
+- itkalin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- capistrano-nginx.gemspec
+- lib/capistrano-nginx.rb
+- lib/capistrano/nginx/tasks.rb
+- lib/capistrano/nginx/version.rb
+- 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: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 327813363107567374
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 327813363107567374
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+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