capun 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2a2aa39992b1871940909998ca236757f1cd4f8
+  data.tar.gz: 021cd0fd56fbee637fe0a12b27e466fb2e4d031c
+SHA512:
+  metadata.gz: 74046b4766512b64e683d0afef02148c0bde3e061f467140807901ede5f1cc865798ae42794d530a4782ddd4a9acb74884c95223a17c403f66683f018bd8dbb4
+  data.tar.gz: 09c792840e76066441b7f50135b8e33b4c3281b2e17b5fad08f645899c10040d296cf167f31db1eec5cc1c89643ba9072069fec45898a12bf4b3623fd2570032

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 capun.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ivan Zamylin
+
+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,47 @@
+# Capun
+
+
+###Prerequisites
+
+We expect you to have the following things setup before you run `cap staging|production|beta|etc deploy`:
+* linux server with a ssh user who would own a project (see the wiki page for instuctions on how to configure a user)
+* `nginx` installed in the `/etc/nginx` directory
+* dedicated host (e.g. `beta.example.com`)
+* `unicorn` gem added to a `Gemfile` 
+* rails project pushed to a git repo (you should also setup `ssh agent forwarding`, [see this article for instuctions](https://help.github.com/articles/using-ssh-agent-forwarding))
+
+
+### Getting started
+
+Deployer works with Rails 4.0 onwards. You can add it to your Gemfile with:
+
+<pre><code>gem 'devise', group: :development
+\#add unicorn as well, as we use it as application server
+gem 'unicorn', group: :production
+</pre></code>
+
+Run the bundle command to install it.
+After you install `Capun`, you need to run the generator:
+
+<pre><code>rails generate capun:install
+</pre></code>
+
+It will ask you about user, server and repo you'd like to use.
+Add stage to `capistrano` configurations:
+
+<pre><code>rails generate capun:stage beta
+</pre></code>
+
+It will ask you about application name for stage selected and application url you'd like to use. Optionally, you can add basic authentication.
+Now you are ready to make a deploy:
+
+<pre><code>cap beta deploy
+</pre></code>
+
+### Contributing
+
+1. Fork it ( http://github.com/zamylin/capun/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/capun.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capun"
+  spec.version       = Capun::VERSION
+  spec.authors       = ["Ivan Zamylin"]
+  spec.email         = ["zamylin@yandex.ru"]
+  spec.summary       = %q{Opinionated Rails deployment solution with CAPistrano, Unicorn and Nginx.}
+  spec.description   = %q{Opinionated Rails deployment solution with CAPistrano, Unicorn and Nginx.}
+  spec.homepage      = "http://oblakogroup.ru"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "capistrano"
+  spec.add_dependency "capistrano-rails"
+  spec.add_dependency "rvm1-capistrano3"
+  spec.add_dependency "capistrano-bundler"
+  spec.add_dependency "capistrano3-unicorn"
+end

data/lib/capun.rb

@@ -0,0 +1,4 @@
+require "capun/version"
+
+module Capun
+end

data/lib/capun/setup.rb

@@ -0,0 +1,96 @@
+
+set :deploy_to, -> {"/home/#{fetch(:user)}/apps/#{fetch(:application)}"}
+set :rvm1_ruby_version, "2.0.0"
+set :branch, 'master'
+# Remote caching will keep a local git repository on the server you're deploying to
+# and simply run a fetch from that rather than an entire clone
+set :deploy_via, :remote_cache
+# Capistrano would use local ssh keys to get access to git repo
+set :ssh_options, { :forward_agent => true }
+set :pty, true
+
+set :keep_releases, 2
+set :bundle_flags, "--quiet"
+
+set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets public/system}
+set :unicorn_config_path, -> { "#{shared_path}/config/unicorn.config.rb" }
+
+set :uploads, []
+set :std_uploads, [
+  #basic_authenticatable.rb
+  {what: "config/deploy/basic_authenticatable.rb.erb", where: '#{release_path}/app/controllers/concerns/basic_authenticatable.rb'},
+  #nginx.conf
+  {what: "config/deploy/nginx.conf.erb", where: '#{shared_path}/config/nginx.conf'},
+  #unicorn.config.rb
+  {what: "config/deploy/unicorn.config.rb.erb", where: '#{shared_path}/config/unicorn.config.rb'},
+  #secret_token.rb
+  {what: "config/initializers/secret_token.rb", where: '#{release_path}/config/initializers/secret_token.rb'},
+  #database.yml
+  {what: "config/deploy/database.yml.erb", where: '#{shared_path}/config/database.yml'}
+]
+
+set :symlinks, []
+set :std_symlinks, [
+  {what: "nginx.conf", where: '/etc/nginx/sites-enabled/#{fetch(:application)}'},
+  {what: "database.yml", where: '#{release_path}/config/database.yml'}
+]
+
+before 'deploy', 'rvm1:install:rvm'  # install/update RVM
+before 'deploy', 'rvm1:install:ruby' # install Ruby and create gemset
+
+namespace :deploy do
+
+  desc 'Uploads files to app based on stage'
+  task :upload do
+    on roles(:app) do
+      #create /home/[user]/apps/[app]/shared/config directory, if it doesn't exist yet
+      execute :mkdir, "-p", "#{shared_path}/config"
+      uploads = fetch(:uploads).concat(fetch(:std_uploads))
+      uploads.each do |file_hash|
+        what = file_hash[:what]
+        next if !File.exists?(what)
+        where = eval "\"" + file_hash[:where] + "\""
+        #compile temlate if it ends with .erb before upload
+        upload! (what.end_with?(".erb") ? StringIO.new(ERB.new(File.read(what)).result(binding)) : what), where
+        info "copying: #{what} to: #{where}"
+      end
+    end
+  end
+
+  desc "Makes files executable and creates symlinks according to rules specified in symlinks array"
+  task :add_symlinks do
+    on roles(:app) do
+      symlinks = fetch(:symlinks).concat(fetch(:std_symlinks))
+      fetch(:symlinks).each do |file_hash|
+        if test("[ -f #{shared_path}/config/#{file_hash[:what]} ]")
+          where = eval "\"" + file_hash[:where] + "\""
+          execute :chmod, "+x #{shared_path}/config/#{file_hash[:what]}"
+          info "making #{file_hash[:what]} executable"
+          execute :sudo, :ln, "-nfs", "#{shared_path}/config/#{file_hash[:what]} #{where}"
+          info "creating symlink for #{file_hash[:what]} to #{where}"
+        end
+      end
+    end
+  end
+
+  desc "Creates necessary directory structury for application"
+  task :make_dirs do
+    on roles(:app) do
+      execute :mkdir, "-p", "/home/#{fetch(:user)}/apps/#{fetch(:application)}"
+    end
+  end
+
+  desc 'Restart nginx'
+  task :restart do
+    on roles(:app) do
+      execute :sudo, "service nginx restart"
+    end
+  end
+
+end
+
+before "deploy:updating", "deploy:make_dirs"
+after "deploy:symlink:linked_dirs", "deploy:upload"
+after "deploy:symlink:linked_dirs", "deploy:add_symlinks"
+after "deploy:publishing", "deploy:restart"
+after "deploy:publishing", "unicorn:restart"

data/lib/capun/version.rb

@@ -0,0 +1,3 @@
+module Capun
+  VERSION = "0.0.1"
+end

data/lib/generators/capun/install_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators/base'
+
+module Capun
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Adds files and dependencies for complete Capistrano deployment mechanism"
+
+      def opts
+        @user = ask("The SSH username you are logging into the server(s) as [ex.: mike]:")
+        @server = ask("Server ip-address [ex.: 92.134.223.012]:")
+        @repo = ask("The URL of the repository that hosts the code [ex.: git@github.com/capistrano/capistrano.git]:")
+      end
+
+      def copy_files
+        empty_directory "config/deploy"
+        copy_file "database.yml.erb", "config/deploy/database.yml.erb"
+        copy_file "nginx.conf.erb", "config/deploy/nginx.conf.erb"
+        copy_file "unicorn.config.rb.erb", "config/deploy/unicorn.config.rb.erb"
+        copy_file "Capfile", "Capfile"
+      end
+
+      def add_to_gitignore
+        gsub_file ".gitignore", "\nconfig/initializers/secret_token.rb", '' if File.exists?("./.gitignore")
+        gsub_file ".gitignore", "\nconfig/deploy/database.yml.erb", '' if File.exists?("./.gitignore")
+        append_to_file ".gitignore", "\nconfig/initializers/secret_token.rb" if File.exists?("./.gitignore")
+        append_to_file ".gitignore", "\nconfig/deploy/database.yml.erb" if File.exists?("./.gitignore")
+      end
+
+      def remove_production_from_database
+        text2remove = "production:\n  adapter: sqlite3\n  database: db/production.sqlite3\n  pool: 5\n  timeout: 5000"
+        gsub_file "config/database.yml", text2remove, '' if File.exists?("./config/database.yml")
+      end
+
+      def compile_and_add_deploy
+        template "deploy.rb.erb", "config/deploy.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/capun/stage_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/base'
+
+module Capun
+  module Generators
+    class StageGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Adds stage to capistrano configuration"
+
+      def opts
+        @appname = ask("Application name for stage \"#{singular_name}\" [ex.: beta.myapp]:")
+        @url = ask("Domain name where application for stage \"#{singular_name}\" would be deployed [ex.: beta.myapp.com]:")
+        @addauth = ask("Would you like to add basic authentication to stage? [Y/n]").capitalize == 'Y'
+        if @addauth
+          @username = ask("Basic authentication username [ex.: mike]:")
+          @password = ask("Basic authentication password [ex.: secret]:")
+        end
+      end
+
+      def add_stage
+        template "stage.rb.erb", "config/deploy/#{singular_name}.rb"
+      end
+
+      def copy_env_file
+        copy_file Rails.root.join('config', 'environments', 'production.rb'), "config/environments/#{singular_name}.rb"
+      end
+
+      def add_authentication
+        if @addauth
+          template "basic_authenticatable.rb.erb", "config/deploy/basic_authenticatable.rb.erb"
+          # inject include directive
+          app_controller = "app/controllers/application_controller.rb"
+          this_text = "  include BasicAuthenticatable if File.exists?( File.expand_path('../concerns/basic_authenticatable.rb', __FILE__) )\n"
+          this_line = "class ApplicationController < ActionController::Base\n"
+          gsub_file app_controller, this_text, ''
+          inject_into_file app_controller, this_text, after: this_line
+          #inject use auth flag into stage
+          gsub_file "config/deploy/#{singular_name}.rb", "\nset :use_basic_auth, true", '' if File.exists?("./config/deploy/#{singular_name}.rb")
+          append_to_file "config/deploy/#{singular_name}.rb", "\nset :use_basic_auth, true" if File.exists?("./config/deploy/#{singular_name}.rb")
+        end
+      end
+
+
+    end
+  end
+end

data/lib/generators/capun/templates/Capfile

@@ -0,0 +1,12 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+#capistrano-rails tasks
+require 'capistrano/rails'
+require 'rvm1/capistrano3'
+require 'capistrano3/unicorn'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/lib/generators/capun/templates/basic_authenticatable.rb.erb

@@ -0,0 +1,11 @@
+module BasicAuthenticatable
+
+	extend ActiveSupport::Concern
+
+	included do
+		<%% if fetch(:use_basic_auth) %>
+			http_basic_authenticate_with name: "<%= @username %>", password: "<%= @password %>"
+		<%% end %>
+	end
+
+end

data/lib/generators/capun/templates/database.yml.erb

@@ -0,0 +1,5 @@
+<%= fetch(:stage) %>:
+  adapter: sqlite3
+  database: /home/<%= fetch(:user) %>/apps/<%= fetch(:application) %>/shared/<%= fetch(:stage) %>.sqlite3
+  pool: 5
+  timeout: 5000

data/lib/generators/capun/templates/deploy.rb.erb

@@ -0,0 +1,14 @@
+require 'capun/setup'
+
+# name of the user at server who would own the project
+set :user, '<%= @user %>'
+# ip for the server where the project would be deployed
+server '<%= @server %>', user: fetch(:user), roles: %w{web app db}
+
+# path to the git repository
+set :repo_url, '<%= @repo %>'
+# set :branch, 'master'
+
+# set :rvm1_ruby_version, "ruby-2.0.0-p353"
+
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets public/system}

data/lib/generators/capun/templates/nginx.conf.erb

@@ -0,0 +1,32 @@
+upstream unicorn_<%= fetch(:application) %> {
+  server unix:/tmp/unicorn.<%= fetch(:application) %>.sock fail_timeout=0;
+}
+
+server {
+  server_name <%= fetch(:url) %> www.<%= fetch(:url) %>;
+  listen 91.228.154.188;
+
+  location / {
+    root /home/<%= fetch(:user) %>/apps/<%= fetch(:application) %>/current/public;
+    try_files $uri/index.html $uri @unicorn_<%= fetch(:application) %>;
+  }
+
+  location ^~ /assets/ {
+    root /home/<%= fetch(:user) %>/apps/<%= fetch(:application) %>/current/public;
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  location @unicorn_<%= fetch(:application) %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://unicorn_<%= fetch(:application) %>;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+}

data/lib/generators/capun/templates/stage.rb.erb

@@ -0,0 +1,2 @@
+set :application, "<%= @appname %>"
+set :url, "<%= @url %>"

data/lib/generators/capun/templates/unicorn.config.rb.erb

@@ -0,0 +1,10 @@
+root = "/home/<%= fetch(:user) %>/apps/<%= fetch(:application) %>/current"
+working_directory root
+pid "#{root}/tmp/pids/unicorn.pid"
+stderr_path "#{root}/log/unicorn.log"
+stdout_path "#{root}/log/unicorn.log"
+
+listen "/tmp/unicorn.<%= fetch(:application) %>.sock"
+worker_processes 2
+timeout 30
+preload_app true

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: capun
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Zamylin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  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: capistrano-rails
+  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: rvm1-capistrano3
+  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: capistrano-bundler
+  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: capistrano3-unicorn
+  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: Opinionated Rails deployment solution with CAPistrano, Unicorn and Nginx.
+email:
+- zamylin@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capun.gemspec
+- lib/capun.rb
+- lib/capun/setup.rb
+- lib/capun/version.rb
+- lib/generators/capun/install_generator.rb
+- lib/generators/capun/stage_generator.rb
+- lib/generators/capun/templates/Capfile
+- lib/generators/capun/templates/basic_authenticatable.rb.erb
+- lib/generators/capun/templates/database.yml.erb
+- lib/generators/capun/templates/deploy.rb.erb
+- lib/generators/capun/templates/nginx.conf.erb
+- lib/generators/capun/templates/stage.rb.erb
+- lib/generators/capun/templates/unicorn.config.rb.erb
+homepage: http://oblakogroup.ru
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Opinionated Rails deployment solution with CAPistrano, Unicorn and Nginx.
+test_files: []