capistrano-o2web-recipes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1d33e1f3422222b0cee3e5beababaa445d28f4d
+  data.tar.gz: 93f1c650d723e332610c2376e337812b2f4fe515
+SHA512:
+  metadata.gz: 9685fb12a6de1856b937b48ba0634ccbf2e6afd0fff1cbaa3a549823bab29834809a4ec55f4c4faeade9409474c374c34e5497870592c6efe59dcce4a7e12aec
+  data.tar.gz: 8f64fd4d03386f8eb4735e4f48b88a0f7199e14fdea9fe195da4c93b583d09c0f7f068daacec0f6031bc9bf7471533596530497745282f9c1eed4af3c7292104

data/.gitignore

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

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Patrice Lebel
+
+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,71 @@
+# Capistrano::O2webRecipes
+
+Common Capistrano Recipes used by O2Web.
+
+Works *only* with Capistrano 3+.
+
+### Installation
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.1'
+      gem 'capistrano-rails', '~> 1.1'
+      gem 'capistrano-o2web-recipes', '~> 0.0.1'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+Add this line to `Capfile`, after `require 'capistrano/rails/assets'`
+
+    require 'capistrano/o2web_recipes'
+    
+To install Nginx config files, run:
+
+    $ rails g capistrano:o2web_recipes:install
+    
+Available tasks:
+
+```bash
+cap [stage] git:update_repo_url           # Update new git repo url
+cap [stage] tmp_cache:clear               # Clear file system tmp cache
+cap [stage] files:server_to_local         # Import public files
+cap [stage] files:local_to_server         # Export public files
+cap [stage] files:private:server_to_local # Import private file
+cap [stage] files:private:local_to_server # Export private files
+cap [stage] db:server_to_local            # Sync local DB with server DB
+cap [stage] db:local_to_server            # Sync server DB with local DB
+cap [stage] nginx:local_to_server         # Export nginx configuration files
+```
+
+Also, tasks from 'capistrano3-nginx' are available.
+
+Configurations can be customized in your deploy file with:
+
+```ruby
+set :server, 'example.com'
+set :admin_name, 'admin'
+set :deployer_name, 'deployer'
+set :files_public_dirs, fetch(:files_public_dirs, []).push(*%W[
+  system
+])
+set :files_private_dirs, fetch(:files_private_dirs, []).push(*%W[
+])
+set :nginx_workers, 1
+set :nginx_assets_dirs, fetch(:nginx_assets_dirs, []).push(*%W[
+  assets
+  system
+])
+set :nginx_max_body_size, '10m'
+```
+
+### TODO
+
+1. Use stages (staging/production) to scope Nginx config file to allow multiple stages on the same server.
+1. Lose the dependency to capistrano3-nginx gem.
+1. Log rotate
+1. Monit

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-o2web-recipes.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/o2web_recipes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-o2web-recipes"
+  gem.version       = Capistrano::O2webRecipes::VERSION
+  gem.authors       = ["Patrice Lebel"]
+  gem.email         = ["patrice@lebel.com"]
+  gem.description   = "Common Capistrano Recipes used by O2Web."
+  gem.summary       = "Common Capistrano Recipes used by O2Web."
+  gem.homepage      = "https://github.com/o2web/capistrano-o2web-recipes"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", ">= 3.1"
+  gem.add_dependency "capistrano3-nginx", "~> 2.0"
+  gem.add_dependency "yaml_db"
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/o2web_recipes.rb

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

data/lib/capistrano/o2web_recipes/version.rb

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

data/lib/capistrano/tasks/o2web_recipes.rake

@@ -0,0 +1,133 @@
+namespace :load do
+  task :defaults do
+    set :files_public_dirs, ['system']
+    set :files_private_dirs, []
+
+    set :nginx_workers, 1
+    set :nginx_assets_dirs, %w[assets system]
+    set :nginx_max_body_size, '10m'
+  end
+end
+
+namespace :git do
+  desc 'Update new git repo url'
+  task :update_repo_url do
+    on roles :app do
+      within repo_path do
+        execute :git, 'remote', 'set-url', 'origin', fetch(:repo_url)
+      end
+    end
+  end
+end
+
+namespace :tmp_cache do
+  desc 'Clear file system tmp cache'
+  task :clear do
+    on roles :app do
+      within current_path do
+        with rails_env: fetch(:stage) do
+          execute :rake, 'tmp:cache:clear'
+        end
+      end
+    end
+  end
+end
+
+namespace :files do
+  def send_files(type, server, root = 'public')
+    raise "No server given" if !server
+    system "rsync --progress -rue 'ssh -p #{fetch(:port)}' #{root}/#{type} #{server.user}@#{server.hostname}:#{shared_path}/#{root}/"
+  end
+
+  def get_files(type, server, root = 'public')
+    raise "No server given" if !server
+    puts "Importing #{type}. Please wait..."
+    system "rsync --progress -rue 'ssh -p #{fetch(:port)}' #{server.user}@#{server.hostname}:#{shared_path}/#{root}/#{type} ./#{root}/"
+  end
+
+  desc 'Import public files'
+  task :server_to_local do
+    on roles :app do |host|
+      fetch(:files_public_dirs).each do |type|
+        get_files type, host
+      end
+    end
+  end
+
+  desc 'Export public files'
+  task :local_to_server do
+    on roles :app do |host|
+      fetch(:files_public_dirs).each do |type|
+        send_files type, host
+      end
+    end
+  end
+
+  namespace :private do
+    desc 'Import private files'
+    task :server_to_local do
+      on roles :app do |host|
+        fetch(:files_private_dirs).each do |type|
+          get_files type, host, 'private'
+        end
+      end
+    end
+
+    desc 'Export private files'
+    task :local_to_server do
+      on roles :app do |host|
+        fetch(:files_private_dirs).each do |type|
+          send_files type, host, 'private'
+        end
+      end
+    end
+  end
+end
+
+namespace :db do
+  desc "Sync local DB with server DB"
+  task :server_to_local do
+    on roles(:app) do |role|
+      within current_path do
+        with rails_env: fetch(:stage) do
+          execute :rake, 'db:data:dump'
+        end
+        run_locally do
+          execute :rsync, "-avzO -e 'ssh -p #{fetch(:port)}' --exclude='.DS_Store' #{role.user}@#{role.hostname}:#{current_path}/db/data.yml db/data.yml"
+        end
+      end
+    end
+  end
+
+  desc "Sync server DB with local DB"
+  task :local_to_server do
+    on roles(:app) do |role|
+      run_locally do
+        execute :rsync, "-avzO -e 'ssh -p #{fetch(:port)}' --exclude='.DS_Store' db/data.yml #{role.user}@#{role.hostname}:#{current_path}/db/data.yml"
+      end
+      within current_path do
+        with rails_env: fetch(:stage) do
+          execute :rake, 'db:data:load'
+        end
+      end
+    end
+  end
+end
+
+namespace :nginx do
+  def upload(server, source, destination)
+    File.open(source, 'w') do |f|
+      f.puts ERB.new(File.read("#{source}.erb")).result
+    end
+    system "rsync --rsync-path='sudo rsync' -avzO -e 'ssh -p #{fetch(:port)}' '#{source}' #{fetch(:admin_name)}@#{server.hostname}:#{destination}"
+    FileUtils.rm_f source
+  end
+
+  desc 'Export nginx configuration files'
+  task :local_to_server do
+    on roles :app do |host|
+      upload host, 'config/nginx.conf', '/etc/nginx/nginx.conf'
+      upload host, 'config/nginx.app.conf', '/etc/nginx/sites-available/default'
+    end
+  end
+end

data/lib/generators/capistrano/o2web_recipes/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  module O2webRecipes
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Install Nginx config files (templates)"
+
+      def copy_files
+        directory 'config'
+      end
+    end
+  end
+end

data/lib/generators/capistrano/o2web_recipes/install/templates/config/nginx.app.conf.erb

@@ -0,0 +1,80 @@
+##
+# You should look at the following URL's in order to grasp a solid understanding
+# of Nginx configuration files in order to fully unleash the power of Nginx.
+# http://wiki.nginx.org/Pitfalls
+# http://wiki.nginx.org/QuickStart
+# http://wiki.nginx.org/Configuration
+#
+# Generally, you will want to move this file somewhere, and start with a clean
+# file but keep this around for reference. Or just disable in sites-enabled.
+#
+# Please see /usr/share/doc/nginx-doc/examples/ for more detailed examples.
+##
+
+# Default server configuration
+#
+server {
+  listen 80 default_server;
+  listen [::]:80 default_server ipv6only=on;
+
+  # SSL configuration
+  #
+  # listen 443 ssl default_server;
+  # listen [::]:443 ssl default_server;
+  #
+  # Self signed certs generated by the ssl-cert package
+  # Don't use them in a production server!
+  #
+  # include snippets/snakeoil.conf;
+
+  server_name <%= fetch(:server) %>;
+  passenger_enabled on;
+  rails_env <%= fetch(:stage) %>;
+  root <%= fetch(:deploy_to) %>/current/public;
+
+<% if fetch(:stage) == :production -%>
+  # listen 443 ssl;
+  # ssl_certificate /etc/ssl/certs/<%= fetch(:server) %>.chained.crt;
+  # ssl_certificate_key /etc/ssl/private/<%= fetch(:server) %>.key;
+<% end -%>
+
+  client_max_body_size <%= fetch(:nginx_max_body_size) %>;
+
+  error_page 500 502 503 504 /50x.html;
+  location = /50x.html {
+    root html;
+  }
+
+  location ~ ^/(<%= fetch(:nginx_assets_dirs).join('|') %>)/  {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+    break;
+  }
+}
+
+server {
+  listen 80;
+
+  server_name www.<%= fetch(:server) %>;
+  return 301 $scheme://<%= fetch(:server) %>$request_uri;
+}
+
+# Virtual Host configuration for example.com
+#
+# You can move that to a different file under sites-available/ and symlink that
+# to sites-enabled/ to enable it.
+#
+#server {
+#  listen 80;
+#  listen [::]:80;
+#
+#  server_name example.com;
+#
+#  root /var/www/example.com;
+#  index index.html;
+#
+#  location / {
+#    try_files $uri $uri/ =404;
+#  }
+#}

data/lib/generators/capistrano/o2web_recipes/install/templates/config/nginx.conf.erb

@@ -0,0 +1,102 @@
+user <%= fetch(:deployer_name) %>;
+worker_processes <%= fetch(:nginx_workers) %>;
+pid /run/nginx.pid;
+
+events {
+  worker_connections 768;
+  # multi_accept on;
+}
+
+http {
+
+  ##
+  # Basic Settings
+  ##
+
+  sendfile on;
+  tcp_nopush on;
+  tcp_nodelay on;
+  keepalive_timeout 65;
+  types_hash_max_size 2048;
+  # server_tokens off;
+
+  # server_names_hash_bucket_size 64;
+  # server_name_in_redirect off;
+
+  include /etc/nginx/mime.types;
+  default_type application/octet-stream;
+
+  ##
+  # SSL Settings
+  ##
+
+  ssl_protocols TLSv1 TLSv1.1 TLSv1.2; # Dropping SSLv3, ref: POODLE
+  ssl_prefer_server_ciphers on;
+
+  ##
+  # Logging Settings
+  ##
+
+  access_log /var/log/nginx/access.log;
+  error_log /var/log/nginx/error.log;
+
+  ##
+  # Gzip Settings
+  ##
+
+  gzip on;
+  gzip_disable "msie6";
+
+  gzip_vary on;
+  gzip_proxied any;
+  gzip_comp_level 6;
+  gzip_buffers 16 8k;
+  gzip_http_version 1.1;
+  gzip_types
+    text/plain
+    text/css
+    text/xml
+    text/javascript
+    application/json
+    application/javascript
+    application/xml
+    application/xml+rss;
+
+  ##
+  # Phusion Passenger config
+  ##
+  # Uncomment it if you installed passenger or passenger-enterprise
+  ##
+
+  passenger_root /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini;
+  passenger_ruby /home/<%= fetch(:deployer_name) %>/.rbenv/shims/ruby;
+
+  ##
+  # Virtual Host Configs
+  ##
+
+  include /etc/nginx/conf.d/*.conf;
+  include /etc/nginx/sites-enabled/*;
+}
+
+
+#mail {
+#	# See sample authentication script at:
+#	# http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript
+#
+#	# auth_http localhost/auth.php;
+#	# pop3_capabilities "TOP" "USER";
+#	# imap_capabilities "IMAP4rev1" "UIDPLUS";
+#
+#	server {
+#		listen     localhost:110;
+#		protocol   pop3;
+#		proxy      on;
+#	}
+#
+#	server {
+#		listen     localhost:143;
+#		protocol   imap;
+#		proxy      on;
+#	}
+#}

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-o2web-recipes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrice Lebel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-17 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: capistrano3-nginx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yaml_db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: Common Capistrano Recipes used by O2Web.
+email:
+- patrice@lebel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-o2web-recipes.gemspec
+- lib/capistrano-o2web-assets.rb
+- lib/capistrano/o2web_recipes.rb
+- lib/capistrano/o2web_recipes/version.rb
+- lib/capistrano/tasks/o2web_recipes.rake
+- lib/generators/capistrano/o2web_recipes/install/USAGE.md
+- lib/generators/capistrano/o2web_recipes/install/install_generator.rb
+- lib/generators/capistrano/o2web_recipes/install/templates/config/nginx.app.conf.erb
+- lib/generators/capistrano/o2web_recipes/install/templates/config/nginx.conf.erb
+homepage: https://github.com/o2web/capistrano-o2web-recipes
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Common Capistrano Recipes used by O2Web.
+test_files: []
+has_rdoc: