visionbundles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67412ca6dbdc960b75b67fa29105fc414b34e272
+  data.tar.gz: de90b6eb913091f29ebca51392e57086f3cb3701
+SHA512:
+  metadata.gz: 944e53ed1f29cc6cbe5e43286a5314d5fd3d9b9de0c088c87e3daa151b387ec17038f2a50f287bda9b7e3ea56f80ca6e66914d2615c4fbfe7029729649ca779b
+  data.tar.gz: ba53c9e616b22f45d059365286540fa7d65a34c60d4ee50c62f3ea3d31b59990d0b88097b98973ecece6bb10769e5759aa7e6dce89299ed834dc56a6db62a68e

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,103 @@
+## Summary
+
+This gem have basic deploy flow tasks for capistrano 2.x, that include templates (nginx / puma / sidekiq). you don't have to write deploy tasks yourself, just configuare it.
+
+## Installation
+
+
+in your `Gemfile`
+
+```ruby
+group :development do
+  gem 'capistrano', '~> 2.15.5'
+  gem 'visionbundles', path: '../demrec'
+end
+```
+
+then run `bundle install`
+
+
+## deploy.rb
+
+```ruby
+# deploy.rb
+
+# add this line on top
+require 'visionbundles'
+
+# setup recipes what your need (nginx, puma, db, dev)
+include_recipes :nginx, :puma, :db, :dev
+```
+
+once you include recipes like `db` `nginx` `puma` it will hook tasks in your deploy flow, you just need run `cap deploy:setup` at first, it will setup all you need. but you have to config your recipes setting.
+
+
+## Recipes configurations
+
+### nginx
+
+```ruby
+# Nginx (role: :web)
+set :nginx_vhost_domain, 'your.domain' # default is _, means all
+set :nginx_upstream_via_sock_file, false, # if your app server bind a unix socket file, you need setup to true
+
+set :nginx_app_servers, ['127.0.0.1:9290'] # your app server ip with port
+```
+
+`cap nginx:start`
+`cap nginx:stop`
+`cap nginx:restart`
+
+
+### puma (role: :app)
+
+```ruby
+# Puma
+set :puma_bind_for, :tcp # default is 'sock_file'
+set :puma_bind_to, '127.0.0.1' # default is '0.0.0.0'
+set :puma_bind_port, '9290' # default is 9292
+set :puma_thread_min, 32
+set :puma_thread_max, 32
+set :puma_workers, 3
+```
+
+`cap puma:start`
+`cap puma:stop`
+`cap puma:restart`
+
+
+### db (role: :app)
+
+If you include this recipe, when you run `cap deploy:setup` will copy database config file from your project `config/database.example.yml` to server site shared path.
+
+If database config file exists in remote server, will not replace. so if you change nginx / puma configuration and you want to reset again, you can run `cap deploy:setup` again.
+
+### sidekiq (role: :workers)
+
+`cap sidekiq:start`
+`cap sidekiq:stop`
+`cap sidekiq:restart`
+
+P.S this task is not test.
+
+
+### dev (role: :app)
+
+This task provide a command `cap dev:build`, it will invoke tasks `tmp:clear` `log:clear` `db:drop` `db:create` `db:migrate` `db:seed` on remote server.
+
+when you run this command, you have to type `Y` to confirm that you really want to run it.
+
+
+## Other tools
+
+[ubuntu-rails-app-installer](https://github.com/afunction/ubuntu-rails-app-installer) is a server tool for install basic rails production environment and this script write on `shellscript`, you can use it to install nginx, percona database, basic secure setting, firewall, rails deploy user ... etc.
+
+
+## Contribution
+
+Just send PR to me.
+
+
+
+
+

data/Rakefile

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

data/lib/visionbundles/base.rb

@@ -0,0 +1,44 @@
+require 'erb'
+require 'colorize'
+if defined?(Capistrano)
+  def from_template(file)
+    abs_path = File.join(File.dirname(__FILE__), file)
+    template = File.read(abs_path)
+    ERB.new(template).result(binding)
+  end
+
+  def template(erb_source, to_dir, filename)
+    mkdir(to_dir)
+    compiled_file = "#{to_dir}/#{filename}"
+    put from_template(erb_source), compiled_file
+  end
+
+  def remote_file_exists?(path)
+    results = []
+
+    invoke_command("if [ -f '#{path}' ]; then echo -n 'true'; fi") do |ch, stream, out|
+      results << (out == 'true')
+    end
+
+    !results.empty?
+  end
+
+  def mkdir(remote_path)
+    run "mkdir -p #{remote_path}"
+  end
+
+  def include_recipes(*recipes)
+    recipes.each do |recipe|
+      require "#{File.dirname(__FILE__)}/recipes/#{recipe}.rb"
+    end
+  end
+
+
+  def set_default(name, *args, &block)
+    set(name, *args, &block) unless exists?(name)
+  end
+
+  def current_server
+    capture("echo $CAPISTRANO:HOST$").strip
+  end
+end

data/lib/visionbundles/recipes/db.rb

@@ -0,0 +1,23 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :db do
+    desc "setup database configuration"
+    task :setup, roles: :app do
+      mkdir("#{shared_path}/config")
+      database_setting_path = "#{shared_path}/config/database.yml"
+      if remote_file_exists?(database_setting_path)
+        puts '[SKIP] Database configuration exists already ...'.colorize(:red)
+      else
+        puts '[Shared] Setup database configuration files ...'.colorize(:light_cyan)
+        put File.read("config/database.example.yml"), database_setting_path
+      end
+    end
+    after 'deploy:setup', 'db:setup'
+
+    desc "setup database symlink for every time deploy"
+    task :symlink_config, roles: :app do
+      run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+    after "deploy:finalize_update", "db:symlink_config"
+    before 'deploy:symlink', 'deploy:migrate'
+  end
+end

data/lib/visionbundles/recipes/dev.rb

@@ -0,0 +1,16 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set_default(:dev_sure_danger_command) {
+    Capistrano::CLI.password_prompt "Are you sure run danger command in #{current_server} if yes type Y"
+  }
+
+  namespace :dev do
+    desc "dev:build task"
+    task :build, roles: :app, except: {no_release: true} do
+      if dev_sure_danger_command == 'Y'
+        ["tmp:clear", "log:clear", "db:drop", "db:create", "db:migrate", "db:seed"].each do |rake_command|
+          run "cd #{current_path}; RAILS_ENV=#{rails_env} bundle exec rake #{rake_command}"
+        end
+      end
+    end
+  end
+end

data/lib/visionbundles/recipes/nginx.rb

@@ -0,0 +1,25 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set_default(:nginx_vhost_domain, '_')
+  set_default(:nginx_app_timeout, nil)
+  set_default(:nginx_upstream_via_sock_file, true)
+  set_default(:nginx_app_servers) {
+    nginx_upstream_via_sock_file ? "/tmp/#{application}.sock" : "127.0.0.1:9292"
+  }
+
+  namespace :nginx do
+    desc "setup nginx vhost config"
+    task :setup, roles: :web do
+      puts '[Nginx] Setup vhost configuration files ...'.colorize(:light_cyan)
+      template "templates/nginx/nginx.conf.erb", "#{shared_path}/nginx", "vhost.conf"
+      sudo "ln -nfs #{shared_path}/nginx/vhost.conf /etc/nginx/sites-enabled/#{application}"
+    end
+    after 'deploy:setup', 'nginx:setup'
+
+    %w[start stop restart reload].each do |command|
+      desc "#{command} nginx server"
+      task command, roles: :web do
+        sudo "service nginx #{command}"
+      end
+    end
+  end
+end

data/lib/visionbundles/recipes/puma.rb

@@ -0,0 +1,30 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set_default(:puma_bind_for, 'sock_file') # sock_file / tcp
+  set_default(:puma_bind_to, '0.0.0.0')
+  set_default(:puma_bind_port, '9292')
+  set_default(:puma_thread_min, 1)
+  set_default(:puma_thread_max, 16)
+  set_default(:puma_workers, 0)
+
+  namespace :puma do
+    desc "Setup Puma Scripts"
+    task :setup do
+      puts '[Puma] copying the config'.colorize(:light_cyan)
+      template "templates/puma/config.erb", "#{shared_path}/puma", "config.rb"
+    end
+    after 'deploy:setup', 'puma:setup'
+
+    %w[start stop].each do |command|
+      desc "#{command} puma server"
+      task command, roles: :app do
+        run "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec pumactl -F #{shared_path}/puma/config.rb #{command}"
+      end
+    end
+    desc "restart puma server"
+    task "restart", roles: :app do
+      %w(stop start).each do |command|
+        run "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec pumactl -F #{shared_path}/puma/config.rb #{command}"
+      end
+    end
+  end
+end

data/lib/visionbundles/recipes/sidekiq.rb

@@ -0,0 +1,10 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :sidekiq do
+    %w[start stop restart killall].each do |command|
+      desc "#{command} sidekiq"
+      task command, roles: :workers, except: {no_release: true} do
+        run "cd #{current_path}/scripts/ && RAILS_ENV=#{rails_env} ./workers.sh #{command}"
+      end
+    end
+  end
+end

data/lib/visionbundles/templates/nginx/nginx.conf.erb

@@ -0,0 +1,50 @@
+upstream <%= "app_#{application}" %> {
+  <%
+    nginx_timeout_string = ""
+    nginx_timeout_string = unless nginx_app_timeout.nil?
+      "fail_timeout=#{nginx_app_timeout}"
+    end
+  %>
+
+  <% if nginx_upstream_via_sock_file %>
+    server unix:<%= nginx_app_servers %> <%= nginx_timeout_string %>;
+  <% else %>
+
+    <% nginx_app_servers.each do |server| %>
+      server <%= server %> <%= nginx_timeout_string %>;
+    <% end %>
+  <% end %>
+}
+
+server {
+  listen 80;
+  server_name <%= nginx_vhost_domain %>;
+
+  root <%= "#{deploy_to}/current/public" %>;
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+    open_file_cache          max=1000 inactive=500s;
+    open_file_cache_valid    600s;
+    open_file_cache_errors   on;
+    break;
+  }
+
+  try_files $uri/index.html $uri @puma;
+
+  location @puma {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header Client-IP $remote_addr;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_redirect off;
+    proxy_pass http://<%= "app_#{application}" %>;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+}

data/lib/visionbundles/templates/puma/config.erb

@@ -0,0 +1,173 @@
+<% app_root = "/home/rails/apps/#{application}/current" %>
+# The directory to operate out of.
+#
+# The default is the current directory.
+#
+directory '<%= app_root %>'
+
+# Use an object or block as the rack application. This allows the
+# config file to be the application itself.
+#
+# app do |env|
+#   puts env
+#
+#   body = 'Hello, World!'
+#
+#   [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
+# end
+
+# Load “path” as a rackup file.
+#
+# The default is “config.ru”.
+#
+# rackup '/u/apps/lolcat/config.ru'
+
+# Set the environment in which the rack's app will run. The value must be a string.
+#
+# The default is “development”.
+#
+# environment 'production'
+
+# Daemonize the server into the background. Highly suggest that
+# this be combined with “pidfile” and “stdout_redirect”.
+#
+# The default is “false”.
+#
+daemonize
+# daemonize false
+
+# Store the pid of the server in the file at “path”.
+#
+pidfile "<%= app_root %>/tmp/pids/puma.pid"
+
+# Use “path” as the file to store the server info state. This is
+# used by “pumactl” to query and control the server.
+#
+# state_path '/u/apps/lolcat/tmp/pids/puma.state'
+
+# Redirect STDOUT and STDERR to files specified. The 3rd parameter
+# (“append”) specifies whether the output is appended, the default is
+# “false”.
+#
+stdout_redirect "<%= app_root %>/log/puma_stdout.log", "<%= app_root %>/log/puma_stderr.log"
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr'
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr', true
+
+# Disable request logging.
+#
+# The default is “false”.
+#
+# quiet
+
+# Configure “min” to be the minimum number of threads to use to answer
+# requests and “max” the maximum.
+#
+# The default is “0, 16”.
+#
+threads <%= puma_thread_min %>, <%= puma_thread_max %>
+
+# Bind the server to “url”. “tcp://”, “unix://” and “ssl://” are the only
+# accepted protocols.
+#
+# The default is “tcp://0.0.0.0:9292”.
+#
+<%=
+  case puma_bind_for
+  when :sock_file
+    %(bind "unix:///tmp/#{application}.sock")
+  when :tcp
+    if puma_bind_to.is_a? String
+      %(bind 'tcp://#{puma_bind_to}:#{puma_bind_port}')
+    elsif puma_bind_to.is_a? Hash
+      puma_bind_ip[current_server] ||= '0.0.0.0'
+      %(bind 'tcp://#{puma_bind_ip[current_server]}:#{puma_bind_port}')
+    end
+  end
+%>
+# bind 'tcp://0.0.0.0:9293'
+# bind 'unix:///var/run/puma.sock?umask=0777'
+# bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
+
+# Instead of “bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'” you
+# can also use the “ssl_bind” option.
+#
+# ssl_bind '127.0.0.1', '9292', { key: path_to_key, cert: path_to_cert }
+
+# Code to run before doing a restart. This code should
+# close log files, database connections, etc.
+#
+# This can be called multiple times to add code each time.
+#
+# on_restart do
+#   puts 'On restart...'
+# end
+
+# Command to use to restart puma. This should be just how to
+# load puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments
+# to puma, as those are the same as the original process.
+#
+# restart_command '/u/app/lolcat/bin/restart_puma'
+
+# === Cluster mode ===
+
+# How many worker processes to run.
+#
+# The default is “0”.
+#
+workers <%= puma_workers %>
+
+# Code to run when a worker boots to setup the process before booting
+# the app.
+#
+# This can be called multiple times to add hooks.
+#
+
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end
+
+# Code to run when a worker boots to setup the process after booting
+# the app.
+#
+# This can be called multiple times to add hooks.
+#
+# after_worker_boot do
+#   puts 'On worker boot...'
+# end
+
+# Allow workers to reload bundler context when master process is issued
+# a USR1 signal. This allows proper reloading of gems while the master
+# is preserved across a phased-restart. (incompatible with preload_app)
+# (off by default)
+
+# prune_bundler
+
+# Preload the application before starting the workers; this conflicts with
+# phased restart feature. (off by default)
+
+preload_app!
+
+# Additional text to display in process listing
+#
+# tag 'gambling'
+
+# Change the default timeout of workers
+#
+# worker_timeout 60
+
+# === Puma control rack application ===
+
+# Start the puma control rack application on “url”. This application can
+# be communicated with to control the main server. Additionally, you can
+# provide an authentication token, so all requests to the control server
+# will need to include that token as a query parameter. This allows for
+# simple authentication.
+#
+# Check out https://github.com/puma/puma/blob/master/lib/puma/app/status.rb
+# to see what the app has available.
+#
+# activate_control_app 'unix:///var/run/pumactl.sock'
+# activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
+# activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }

data/lib/visionbundles/version.rb

@@ -0,0 +1,3 @@
+module Visionbundles
+  VERSION = "0.1.0"
+end

data/lib/visionbundles.rb

@@ -0,0 +1,2 @@
+require "visionbundles/version"
+require "visionbundles/base"

data/visionbundles.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "visionbundles/version"
+
+Gem::Specification.new do |s|
+  s.name        = "visionbundles"
+  s.version     = Visionbundles::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = %q{common deploy flow tasks for capistrano 2.x.x}
+  s.description = %q{nginx, puma, sidekiq, deploy flow}
+
+  s.required_ruby_version     = ">= 1.8.7"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.authors     = ["Eddie Li"]
+  s.email       = ["eddie@visionbundles.com"]
+  s.homepage    = "https://github.com/afunction/visionbundles"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.license          = 'MIT'
+
+  s.add_dependency 'colorize', '~> 0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: visionbundles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eddie Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+description: nginx, puma, sidekiq, deploy flow
+email:
+- eddie@visionbundles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/visionbundles.rb
+- lib/visionbundles/base.rb
+- lib/visionbundles/recipes/db.rb
+- lib/visionbundles/recipes/dev.rb
+- lib/visionbundles/recipes/nginx.rb
+- lib/visionbundles/recipes/puma.rb
+- lib/visionbundles/recipes/sidekiq.rb
+- lib/visionbundles/templates/nginx/nginx.conf.erb
+- lib/visionbundles/templates/puma/config.erb
+- lib/visionbundles/version.rb
+- visionbundles.gemspec
+homepage: https://github.com/afunction/visionbundles
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: common deploy flow tasks for capistrano 2.x.x
+test_files: []