visionbundles 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d815ace0686f65fa24871eb6cdcbc7b49ea2adc7
-  data.tar.gz: 563de8f20eba78ffa3df7d0a8e2638046ec4dfd1
+  metadata.gz: d0c3ca7386446d5ff3f50ab5bc193f4111f489b5
+  data.tar.gz: 50c01e9a716dcbdd13f595dd8d31d86fc8cc9734
 SHA512:
-  metadata.gz: 0d5f4c7066cb7696e9f28272b2f3e757089235c2b1e9e8aab17b149903e379c7635fd2b1a1098eabb5456938a7da0ce1f71e8e77743dc8b7270178352b680b90
-  data.tar.gz: 51aa5a97884b704a0ede9af6e2096b8b52e1200302dceb80ff0893fd4083389034391d2eca2ecbb96522bf6bba3220ddf84f67dc25b5ed2f524400f28d79b8fd
+  metadata.gz: accce3319314d222393e047e5539966277c8dcc929ffa9bc19fe908a4f082a5a10bc2e036a2db0424d6c2ca69659444b57b3894848faf701b98ee5baca0bdc99
+  data.tar.gz: 1c7a12503752b49d768d5013fd17ab2ac9a1e860dbf34045606cafb0c2201b5b7e2c948fcdc52d86cec3864fea0718cd39f8f58b870495ad847f5e7a14748113

data/CHANGELOG

@@ -0,0 +1,8 @@
+0.3.0
+
+* Add base valid task `deploy:valid` include git, and remote server connection
+* Add db valid task called `db:valid` to check if all server have permission to access db
+* Add secret file rails version checker (4.0 use `secret_token.rb`, 4.1 use `secrets.yml`)
+* Add fast_assets valid task, it valid if local commit same as deploying version (because compile assets locally)
+* Add more options for puma setting (preload_app, puma_worker_timeout, puma_prune_bundler, .. etc)
+* Change method `config_from_yaml` to `load_config_from`

data/README.md

@@ -1,13 +1,16 @@
+[![Code Climate](https://codeclimate.com/github/afunction/visionbundles/badges/gpa.svg)](https://codeclimate.com/github/afunction/visionbundles) [![security](https://hakiri.io/github/afunction/visionbundles/master.svg)](https://hakiri.io/github/afunction/visionbundles/master)
+
 ## Summary
 
-This gem with basic deploy flow tasks for capistrano 2.15.5, you don't have to write deploy tasks yourself, just configuare it. And that includes recipes:
+This gem is the basic deploy recipes for capistrano 2.15.5, the recipes includes tasks hooks around capistrano deploy tasks, and configuration template for each service (like nginx, puma .. etc), you don't have to write deploy tasks yourself, just configure it. And below is all recipes:
 
 1. nginx
 2. puma
-3. db
-4. secret
-5. fast_assets 
-6. dev
+3. preconfig (new feature)
+4. db
+5. secret
+6. fast_assets 
+7. dev
 
 ## Installation
 
@@ -15,237 +18,24 @@ in your `Gemfile`
 
 ```ruby
 group :development do
-  gem 'capistrano', '~> 2.15.5'
-  gem 'visionbundles'
-  # or use latest source
-  # gem 'visionbundles', github: 'afunction/visionbundles'
+  gem 'capistrano', '~> 2.15.5', require: false
+  gem 'visionbundles', '~> 0.2.0'
+  # gem 'visionbundles', github: 'afunction/visionbundles' # or use latest source
 end
 ```
 
 then run `bundle install`
 
 
-## deploy.rb
-
-```ruby
-# Add this line on top
-require 'visionbundles'
-
-# Setup recipes what you need (include option nginx, puma, db, dev, fast_assets, secret)
-include_recipes :nginx, :puma, :db, :dev
-```
-
-Once you include recipes like `db` `nginx` `puma` ... etc, it will hook tasks in your deploy flow, and you need to run `cap deploy:setup` at first time, it will setup all you need. but you have to config your recipes setting before.
-
-
-## Recipe configurations
-
-### nginx (role: :web)
-
-```ruby
-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`
-
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/nginx.rb
-
-
-### puma (role: :app)
-
-If you have multiple app server, you should setup `puma_bind_to` to `0.0.0.0`, and use other way to avoid directly connection to your app server form internet.
-
-```ruby
-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`
-
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/puma.rb
-
-### fast_assets (locally)
-
-If you have multiple app servers, or separate servers between app and web roles, or your assets on CDN, you may concern which server is resiponsible to compile assets and upload to servers.
-
-
-This task will use least resource to compile assets and upload to remote server. it combine [Gem - AssetSync](https://github.com/rumblelabs/asset_sync) and compile assets locally instead of capistrano precompile task. 
-
-
-**Without CDN**
-
-You don't have to configure it, just add `fast_assets` recipe in your `deploy.rb`, it will compile assets locally, and upload `manifest file` to servers of app role and `assets files` to servers of web role.
-
-
-**With CDN**
-
-After include `fast_assets`recipe, you have to config your CDN access token, it will use [asset_sync](https://github.com/rumblelabs/asset_sync) to upload your assets to cloud, the example below using AWS S3:
-
-```ruby
-# CDN
-set :cdn, {
-  fog_provider: 'AWS',
-  fog_directory: 'your_bucket_name',
-  aws_access_key_id: 'your aws id', # create from IAM
-  aws_secret_access_key: 'your aws secret token',
-  fog_region: 'ap-northeast-1' # bucket region
-}
-```
-
-Once you choose upload assets to CDN, deploy task will NOT upload asset files to your web server, because web dose not need it. For more details about CDN configuration, please visit: https://github.com/rumblelabs/asset_sync
-
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/fast_assets.rb
-
-### db (role: :app)
-
-To avoid setting up db configuration manually, setup task will copy `config/database.production.yml` to your servers with `roles: :app`, and you can create the file with REAL production db configuration, and list the file to `.gitignore` to avoid sensitive data in your source control.
-
-
-**cap db:reset_config**
-
-The setup task will not overwide db config file if exists in remote server, but i also can use `cap db:reset_config` to replace your remote db config from local.
+## Wiki
 
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/db.rb
-
-### Secret (role: :app)
-
-Setup task will copy `initializers/secret_token.production.rb` to your servers which roles is app, like db recipes, you should create the file, and list in `.gitignore`.
-
-**cap secret:reset_config**
-
-Just like `db:reset_config` functionality.
-
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/secret.rb
-
-### 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 the server (same server which runs db:migrate).
-
-This command will show a prompt box to confirm that you really want to do it.
-
-Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/dev.rb
-
-
-## Maintain multiple deploy settings by yaml
-
-You may think server architecture details should not in source control, or you often update to different website in same project. you can use yaml easy to switch configuration. below is the example:
-
-
-**deploy.rb**
-
-```ruby
-config_from_yaml 'deploy/config.yml', :my_testing_production
-```
-
-**deploy/config.yml**
-
-```yaml
-# Nginx
-my_testing_production:
-  servers:
-    - host: '1.1.1.1'
-      roles: 
-        - :web
-        - :app
-        - :db
-      opts:
-        primary: yes
-    - host: '2.2.2.2'
-      roles: :app
-  config:
-    nginx_vhost_domain: 'my.domain.com'
-    nginx_upstream_via_sock_file: no
-    nginx_app_servers:
-      - 192.168.1.3:9290
-      - 192.168.1.4:9290
-    # Puma
-    puma_bind_for: :tcp
-    puma_bind_port: '9290'
-    puma_thread_min: 32
-    puma_thread_max: 32
-    puma_workers: 3
-    cdn:
-      fog_provider: 'AWS'
-      fog_directory: ''
-      aws_access_key_id: ''
-      aws_secret_access_key: ''
-      fog_region: 'ap-northeast-1'
-
-```
-
-
-### Full setting example
-
-in `Capfile`
-
-```ruby
-load 'deploy'
-load 'deploy/assets'
-load 'config/deploy'
-```
-
-in `deploy.rb`
-
-```ruby
-require 'bundler/capistrano'
-require 'rvm/capistrano'
-require 'visionbundles'
-
-# RVM Settings
-set :rvm_ruby_string, '2.1.0'
-set :rvm_type, :user
-$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
-
-# Recipes Settings
-include_recipes :nginx, :puma, :db, :dev
-
-# Nginx
-set :nginx_vhost_domain, '111.222.33.44'
-set :nginx_upstream_via_sock_file, false
-set :nginx_app_servers, ['127.0.0.1:9290']
-
-# Puma
-set :puma_bind_for, :tcp
-set :puma_bind_to, '127.0.0.1'
-set :puma_bind_port, '9290'
-set :puma_thread_min, 32
-set :puma_thread_max, 32
-set :puma_workers, 3
-
-# Role Settings
-server '11.222.33.44', :web, :app, :db, primary: true
-
-# Capistrano Base Setting
-set :application, 'my-project-name'
-set :user, 'rails'
-set :deploy_to, "/home/#{user}/apps/#{application}"
-set :deploy_via, :remote_cache
-set :use_sudo, false
-set :rails_env, 'test'
-
-# Git Settings
-set :scm, :git
-set :repository, "git@github.com:username/#{application}.git"
-set :branch, 'develop'
-
-# Others
-default_run_options[:pty] = true
-ssh_options[:forward_agent] = true
-
-# Deploy Flow
-after 'deploy', 'deploy:cleanup' # keep only the last 5 releases
-```
+* [Getting Started](https://github.com/afunction/visionbundles/wiki/Getting-Started)
+* [Recipe - nginx](https://github.com/afunction/visionbundles/wiki/%5BRecipe%5D-nginx)
+* [Recipe - puma](https://github.com/afunction/visionbundles/wiki/%5BRecipe%5D-puma)
+* [Recipe - fast_assets (compile assets locally)](https://github.com/afunction/visionbundles/wiki/%5BRecipe%5D-fast_assets)
+* [Recipe - preconfig](https://github.com/afunction/visionbundles/wiki/%5BRecipe%5D--preconfig)
+* [Recipe - db, dev](https://github.com/afunction/visionbundles/wiki/%5BRecipe%5D-db,-dev)
+* [Using yaml to define your stage with deploy.rb](https://github.com/afunction/visionbundles/wiki/Using-yaml-to-define-your-stage-with-deploy.rb)
 
 
 ## Other tools
@@ -257,4 +47,9 @@ after 'deploy', 'deploy:cleanup' # keep only the last 5 releases
 
 Just send PR to me.
 
+# Contact me
+
+eddie [at] visionbundles [dot] com 
+
 
+![Visionbundles Int'l Ltd.](http://www.visionbundles.com/assets/logo-927ee5bf7632c30e2642ddf03b607e42.png)

data/Rakefile

@@ -1 +1,13 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'bundler/gem_tasks'
+require 'visionbundles/version'
+
+task :build do
+  system "gem build visionbundles.gemspec"
+end
+
+task :release => :build do
+  gem_name = "visionbundles-#{Visionbundles::VERSION}.gem"
+  system "gem push #{gem_name}"
+  system "rm -rf #{gem_name}"
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators'
+module Visionbundles
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :deploy_template, type: :string, default: "single"
+
+      # check the argument deploy_template, should be single or mutiple
+      def check
+        unless %w(single multiple).include?(deploy_template)
+          puts "You have to choice a template: single or multiple"
+          puts "\trails g visionbundles:install single"
+          puts "\trails g visionbundles:install mutiple"
+          exit
+        end
+      end
+
+      # copy the capistrano setting from template
+      def copy_deploy_template
+        copy_file "deploy_#{deploy_template}.rb", "config/deploy.rb"
+      end
+
+      # add gem for capistrano + rvm
+      def add_capistrano_rvm
+        unless File.readlines("Gemfile").grep(/rvm-capistrano/).any?
+          gem_group :development do
+            gem 'rvm-capistrano'
+          end
+        end
+      end
+
+      # copy exists database config to predefine folder
+      def create_database_example_config
+        if File.exists?('config/database.yml')
+          copy_file "#{Rails.root}/config/database.example.yml", "preconfig/database.yml"
+        else
+          copy_file "database.yml", "preconfig/database.yml"
+        end
+      end
+    end
+  end
+end

data/lib/generators/security_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators'
+module Visionbundles
+  module Generators
+    class SecurityGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      # check and add first commit for this project
+      def git_init
+        run 'git init; git add .; git commit -m "init project"' unless File.exists?('.git')
+        run 'git reset .'
+      end
+
+      # copy exists database config to predefine folder
+      def create_database_example_config
+        if File.exists?('config/database.yml')
+          copy_file "#{Rails.root}/config/database.yml", "config/database.example.yml"
+          copy_file "#{Rails.root}/config/database.example.yml", "preconfig/database.yml"
+        else
+          copy_file "database.yml", "preconfig/database.yml"
+          copy_file "database.yml", "config/database.example.yml"
+        end
+        run 'git add config/database.example.yml'
+        run 'git commit -m "create a database config template!"'
+      end
+
+      # check and ignore database config out of source control
+      def out_of_database_config_from_source_control
+        if `git ls-files config/database.yml` != ''
+          run 'git rm config/database.yml'
+          run 'git commit -m "remove database configuration out of source control!"'
+        end
+
+        append_file ".gitignore" do
+          <<-eos
+          /preconfig/ # production preconfig folder
+          /config/database.yml" # should not in source control
+          eos
+        end
+        run 'git add .gitignore'
+        run 'git commit -m "git ignore files: preconfig, database.yml"'
+      end
+    end
+  end
+end

data/lib/generators/templates/Capfile

@@ -0,0 +1,3 @@
+load 'deploy'
+load 'deploy/assets'
+load 'config/deploy'

data/lib/generators/templates/database.yml

@@ -0,0 +1,26 @@
+development:
+  adapter: mysql2
+  encoding: utf8
+  database: your_database_name_development
+  pool: 5
+  username: root
+  password:
+  host: ''
+
+test:
+  adapter: mysql2
+  encoding: utf8
+  database: your_database_name_test
+  pool: 5
+  username: root
+  password: 
+  host: ''
+
+production:
+  adapter: mysql2
+  encoding: utf8
+  database: your_database_name_production
+  pool: 50
+  username: root
+  password:
+  host: ''

data/lib/generators/templates/deploy_multiple.rb

@@ -0,0 +1,59 @@
+require 'bundler/capistrano'
+require 'rvm/capistrano'
+require 'visionbundles'
+
+# RVM Settings
+set :rvm_ruby_string, '2.1.0'
+set :rvm_type, :user
+$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
+
+# Recipes Included
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes
+include_recipes :nginx, :puma, :db, :dev, :fast_assets
+# :fast_assets recipes will compile assets locally then upload assets files to servers
+# So if you use :fast_assets you have to make sure your local repository commit id same as you deployed.
+
+# Nginx
+# Please change `nginx_app_servers` to your app servers ip, and make sure your web server have permission to 
+# connect to the ips that you set.
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/nginx.rb
+set :nginx_vhost_domain, 'www.domain.com' # your domain that to nginx.
+set :nginx_upstream_via_sock_file, false
+set :nginx_app_servers, [ '192.168.1.100:9290', '192.168.1.101:9290' ] # upstream will point to app server.
+
+
+# Puma
+# This setting will bind puma service to each ip address (include public ip)
+# for security you may using firewall to make sure people cannot connect to your app server directly.
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/puma.rb
+set :puma_bind_for, :tcp
+set :puma_bind_to, '0.0.0.0'
+set :puma_bind_port, '9290'
+set :puma_thread_min, 32
+set :puma_thread_max, 32
+set :puma_workers, 3
+
+# Role Settings
+# The db roles mean the app server which you specify the run the db operation like `db:migrate`.
+server '11.22.33.44', :web
+server '22.33.44.55', :app
+server '33.44.55.66', :app, :db, primary: true
+
+# Capistrano Base Setting
+set :application, 'your_project_name'
+set :user, 'rails'
+set :deploy_to, "/home/#{user}/apps/#{application}"
+set :deploy_via, :remote_cache
+set :use_sudo, false
+set :rails_env, :production
+
+# Git Settings
+set :scm, :git
+set :repository, "git@github.com:username/#{application}.git" # your git source, and make sure your server have premission to access your git server
+set :branch, :master # the branch you want to deploy
+
+# Extra settings
+default_run_options[:pty] = true
+ssh_options[:forward_agent] = true
+
+after 'deploy', 'deploy:cleanup' # keep only the last 5 releases