capistrano-server 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-server.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wael M. Nasreddine
+
+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.md

@@ -0,0 +1,29 @@
+# Capistrano::Server
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-server'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-server
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/capistrano-server.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Wael M. Nasreddine"]
+  gem.email         = ["wael.nasreddine@gmail.com"]
+  gem.description   = 'Capistrano recipes for managing servers'
+  gem.summary       = gem.summary
+  gem.homepage      = 'http://technogate.github.com/contao'
+  gem.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+
+  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-server"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.0.2'
+
+  # Runtime dependencies
+  gem.add_dependency 'rake'
+  gem.add_dependency 'capistrano'
+  gem.add_dependency 'capistrano-utils'
+end

data/lib/capistrano/ext/nginx.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/nginx requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :web_server do
+        namespace :nginx do
+
+          _cset :nginx_init_path, "/etc/init.d/nginx"
+
+          desc "[internal] Generate Nginx configuration"
+          task :configuration, :roles => :web, :except => { :no_release => true } do
+            template = File.read File.expand_path('../../../templates/nginx.conf.erb', __FILE__)
+
+            nginx = OpenStruct.new
+            nginx.listen_port      = fetch :web_server_listen_port, 80
+            nginx.application_url  = fetch :application_url
+            nginx.indexes          = fetch :web_server_indexes, %w(index.php index.html)
+            nginx.denied_access    = fetch :denied_access, %w(.htaccess /system/logs)
+            nginx.auth_file        = fetch :web_server_auth_file, nil
+            nginx.auth_credentials = fetch :web_server_auth_credentials, nil
+            nginx.rewrite          = fetch :web_server_mod_rewrite, true
+            nginx.php_fpm_host     = fetch :php_fpm_host, 'localhost'
+            nginx.php_fpm_port     = fetch :php_fpm_port, '9000'
+            nginx.logs_path        = fetch :logs_path
+            nginx.public_path      = fetch :public_path
+
+            write ERB.new(template).result(binding),
+              fetch(:web_conf_file),
+              use_sudo: true
+          end
+
+          desc "Start nginx web server"
+          task :start, :roles => :web, :except => { :no_release => true } do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} start
+            CMD
+          end
+
+          desc "Stop nginx web server"
+          task :stop, :roles => :web, :except => { :no_release => true } do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} stop
+            CMD
+          end
+
+          desc "Restart nginx web server"
+          task :restart, :roles => :web, :except => { :no_release => true } do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} restart
+            CMD
+          end
+
+          desc "Resload nginx web server"
+          task :reload, :roles => :web, :except => { :no_release => true } do
+            run <<-CMD
+              #{try_sudo} #{fetch :nginx_init_path} reload
+            CMD
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ext/rsa.rb

@@ -0,0 +1,21 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/contao requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  desc 'Send SSH key to the server'
+  task :scp_rsa, :roles => [:app, :web, :db] do
+    rsa = "#{ENV['HOME']}/.ssh/id_rsa.pub"
+
+    begin
+      run <<-CMD
+            mkdir -p ~/.ssh; \
+            touch ~/.ssh/authorized_keys; \
+            echo '#{File.read rsa}' >> ~/.ssh/authorized_keys;
+      CMD
+    rescue Capistrano::CommandError
+      logger.import 'Cannot send the SSH key to the server'
+      abort 'Cannot send the SSH key to the server'
+    end
+  end
+end

data/lib/capistrano/ext/server.rb

@@ -0,0 +1,26 @@
+require 'capistrano/ext/helpers'
+require 'capistrano/ext/rsa'
+require 'capistrano/ext/web_server'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/server requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :setup do
+        desc 'Prepare the server (database server, web server and folders)'
+        task :default, :roles => [:app, :db, :web] do
+          # Empty task, server preparation goes into callbacks
+        end
+
+        task :finish do
+          # Empty task for callbacks
+        end
+      end
+    end
+  end
+
+  after 'deploy:server:setup', 'deploy:server:web_server:setup'
+end

data/lib/capistrano/ext/web_server.rb

@@ -0,0 +1,85 @@
+require 'capistrano/ext/nginx'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/web_server requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    namespace :server do
+      namespace :web_server do
+        desc "Prepare the web server"
+        task :setup, :roles => :web, :except => { :no_release => true } do
+          # Empty task, server preparation goes into callbacks
+        end
+
+        task :finish, :roles => :web, :except => { :no_release => true } do
+          # Empty task, server preparation goes into callbacks
+        end
+
+        desc '[internal] Setup folders'
+        task :folders, :roles => :web do
+          sudo <<-CMD
+            mkdir -p #{File.dirname fetch(:web_conf_file)} #{File.dirname fetch(:web_server_auth_file, '')}
+          CMD
+        end
+
+        desc "[internal] Generate Web configuration"
+        task :configuration, :roles => :web, :except => { :no_release => true } do
+          case fetch(:web_server_app)
+          when :nginx
+            find_and_execute_task 'deploy:server:web_server:nginx:configuration'
+          else
+            abort "I don't know how to build '#{web_server_app}' configuration."
+          end
+        end
+
+        desc "[internal] Generate authentification"
+        task :authentification, :roles => :web, :except => { :no_release => true } do
+          if exists?(:web_server_auth_credentials)
+            content = Array.new
+            unencrypted_content = Array.new
+
+            fetch(:web_server_auth_credentials).each do |credentials|
+              if credentials[:password].respond_to?(:call)
+                password = credentials[:password].call
+              else
+                password = credentials[:password]
+              end
+
+              unencrypted_content << "#{credentials[:user]}:#{password}"
+              content << "#{credentials[:user]}:#{password.crypt(gen_pass(8))}"
+            end
+
+            # Write the encrypted content
+            write content.join("\n"),
+              fetch(:web_server_auth_file),
+              use_sudo: true
+
+            # Write the unencrypted content
+            write unencrypted_content.join("\n"),
+              "#{fetch :deploy_to}/.http_basic_auth"
+
+            logger.info "This site uses http basic auth, the credentials are:"
+            unencrypted_content.each do |m|
+              logger.trace "username: #{m.split(':').first.chomp} password: #{m.split(':').last.chomp}"
+            end
+          end
+        end
+
+        desc "print authentification file"
+        task :print_http_auth, :roles => :web, :except => { :no_release => true } do
+          read("#{fetch :deploy_to}/.http_basic_auth").split("\n").each do |m|
+            logger.trace "username: #{m.split(':').first.chomp} password: #{m.split(':').last.chomp}"
+          end
+        end
+      end
+    end
+  end
+
+  # Internal Dependencies
+  before 'deploy:server:web_server:configuration', 'deploy:server:web_server:folders'
+  before 'deploy:server:web_server:configuration', 'deploy:server:web_server:authentification'
+  before 'deploy:server:web_server:setup', 'deploy:server:web_server:configuration'
+  after  'deploy:server:web_server:setup', 'deploy:server:web_server:finish'
+end

data/lib/templates/nginx.conf.erb

@@ -0,0 +1,100 @@
+server {
+  listen <%= nginx.listen_port || 80 %>;
+  server_name <%= nginx.application_url.join(' ') %>;
+
+<% if nginx.auth_file && nginx.auth_credentials %>
+  # Authentification
+  auth_basic "Valid user required to access this server";
+  auth_basic_user_file <%= nginx.auth_file %>;
+<% end %>
+
+<% if nginx.logs_path %>
+  access_log <%= nginx.logs_path %>/access.log;
+  error_log <%= nginx.logs_path %>/error.log;
+<% end %>
+
+  root <%= nginx.public_path %>;
+
+<% if nginx.indexes.present? %>
+  index <%= nginx.indexes.join(' ') %>;
+<% end %>
+
+  # Enable recursive error pages to catch 405 in a 503 error.
+  recursive_error_pages on;
+
+  # This allows people to use stylesheet, javascript and images in their
+  # maintenance html file
+  if ($request_filename ~* \.(css|js|jpg|gif|png)$) {
+    break;
+  }
+
+  # If the maintenance page exists, throw a 503 error which we'd catch later.
+  if (-f $document_root/__system__/maintenance/index.html) {
+    return 503;
+  }
+
+  # Catch the 503 error and send it to the @maintenance location
+  error_page 503 @maintenance;
+
+  # The @maintenance location
+  location @maintenance {
+    # Nginx will refuse POST requests to a static file and will throw a 405 error
+    # So we need to catch that and display again our maintenance page
+    error_page 405 = /__system__/maintenance/index.html;
+
+    # Rewrite all the requests to the maintenance page if it exists.
+    rewrite ^(.*)$ /__system__/maintenance/index.html break;
+  }
+
+  # Error Pages
+  error_page 404 /404.html;
+  error_page 500 502 504 /500.html;
+
+  # Root Location
+  location / {
+    # this serves static files that exist without running other rewrite tests
+    if (-f $request_filename) {
+      expires 30d;
+      break;
+    }
+
+  <% if nginx.rewrite %>
+    # this sends all non-existing file or directory requests to index.php
+    if (!-e $request_filename) {
+      rewrite ^(.+)$ /index.php?q=$1 last;
+    }
+  <% end %>
+  }
+
+  <% nginx.denied_access.each do |f| %>
+    location ~ <%= Regexp.escape f %> {
+      deny  all;
+    }
+  <% end if nginx.denied_access.present? %>
+
+  location ~ .php$ {
+    fastcgi_pass   <%= nginx.php_fpm_host %>:<%= nginx.php_fpm_port %>;
+    fastcgi_index  index.php;
+    fastcgi_param  SCRIPT_FILENAME    <%= nginx.public_path %>$fastcgi_script_name;
+
+    fastcgi_param  QUERY_STRING       $query_string;
+    fastcgi_param  REQUEST_METHOD     $request_method;
+    fastcgi_param  CONTENT_TYPE       $content_type;
+    fastcgi_param  CONTENT_LENGTH     $content_length;
+
+    fastcgi_param  SCRIPT_NAME        $fastcgi_script_name;
+    fastcgi_param  REQUEST_URI        $request_uri;
+    fastcgi_param  DOCUMENT_URI       $document_uri;
+    fastcgi_param  DOCUMENT_ROOT      $document_root;
+    fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+
+    fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
+    fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+
+    fastcgi_param  REMOTE_ADDR        $remote_addr;
+    fastcgi_param  REMOTE_PORT        $remote_port;
+    fastcgi_param  SERVER_ADDR        $server_addr;
+    fastcgi_param  SERVER_PORT        $server_port;
+    fastcgi_param  SERVER_NAME        $server_name;
+  }
+}

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-server
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Wael M. Nasreddine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-utils
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano recipes for managing servers
+email:
+- wael.nasreddine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-server.gemspec
+- lib/capistrano/ext/nginx.rb
+- lib/capistrano/ext/rsa.rb
+- lib/capistrano/ext/server.rb
+- lib/capistrano/ext/web_server.rb
+- lib/templates/nginx.conf.erb
+homepage: http://technogate.github.com/contao
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 933416732281928716
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []