kratos 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61045f764eef6fc5ffdcfc250d496b31695a5437
-  data.tar.gz: b32ec368b9ea11ad6e59f595d987d834ed5c460a
+  metadata.gz: f7b3bdd730f01861415f2ffdf2981945f07fbcb5
+  data.tar.gz: 2523567b4804055c1ee62fe55a5a657113837f1e
 SHA512:
-  metadata.gz: a32eb2325a7f1f870030355a70810e0b046a556fa8b7b266d162b401cc722ef1be6b041e31ef4521259487d33328c66c61f7abe66977a4db2f3a2c7e05c22a7c
-  data.tar.gz: 8769fc3162ba927a705b862ddda36a6260cdb2c26b8c955b644fff8daf970a86ef8c6c8792a1b6a416671961016ed0f213e31e160ae29edfa83bed37b6ab95ef
+  metadata.gz: 4ecb0629c7eaf9c02e8744e107457c6b5126973b7eeb0fb24d84c42aee6691ade30f165f3c820cbd9392e0f2849bfcc2ca7b0714c0b29ec425edb04cd76e1488
+  data.tar.gz: 687a4251bcb6ebdc2ced44836b491b4503ff0b0ae54bf45798535c9f25e38ec000a1efc15598c505ef87b108dead9adf4ed34a1e80cda1c864dd6bd8d0b859fd

data/README.md

@@ -15,9 +15,19 @@ Then run:
 
 This will create a Rails app in `projectname` using the latest version of Rails.
 
-After run, configure sidekiq panel password in the
-`config/initializers/sidekiq.rb` file. The panel is accessible by the URL
-`/sidekiq`.
+After run, you must configure:
+
+- Change the sidekiq panel password in the `config/initializers/sidekiq.rb`
+  file.  The panel is accessible by the URL `/sidekiq`.
+- Setup your development environment variables: `NEW_RELIC_LICENSE_KEY`,
+  `ROLLBAR_TOKEN`, `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+- Setup your production and staging environment variables using dotgpg. You must
+  create two files on the root of your project: `env_production.gpg` and
+  `env_staging.gpg`. To initialize dotgpg on your project run `dotgpg init`.
+  It'll create a `.gpg` folder and add your public key to it. To edit the files,
+  use the `dotgpg edit env_<environment>.gpg` command. For more information look
+  at the [DotGPG](https://github.com/ConradIrwin/dotgpg).
+- Run `bin/setup` to initialize your database and files.
 
 ## License
 

data/lib/kratos/app_builder.rb

@@ -152,6 +152,18 @@ class AppBuilder < Rails::AppBuilder
     copy_file 'i18n-tasks.yml', 'config/i18n-tasks.yml'
   end
 
+  def configure_newrelic
+    template 'newrelic.yml.erb', 'config/newrelic.yml'
+  end
+
+  def configure_rollbar
+    template 'rollbar.rb.erb', 'config/initializers/rollbar.rb'
+  end
+
+  def configure_nginx
+    copy_file 'nginx.conf.erb', 'config/deploy/nginx.conf.erb'
+  end
+
   def configure_smtp
     copy_file 'smtp.rb', 'config/smtp.rb'
 
@@ -413,6 +425,11 @@ end
               force: true
   end
 
+  def use_mysql_config_template
+    template 'mysql_database.yml.erb', 'config/database.yml',
+              force: true
+  end
+
   def create_database
     bundle_command 'exec rake db:create db:migrate'
   end
@@ -428,9 +445,6 @@ end
 
   def create_capistrano_config
     template 'deploy_config.rb.erb', 'config/deploy.rb'
-  end
-
-  def create_capistrano_config
     copy_file 'cap_environment.rb', 'config/deploy/production.rb'
     copy_file 'cap_environment.rb', 'config/deploy/staging.rb'
   end

data/lib/kratos/generators/app_generator.rb

@@ -3,7 +3,7 @@ require 'rails/generators/rails/app/app_generator'
 
 module Kratos
   class AppGenerator < Rails::Generators::AppGenerator
-    class_option :database, type: :string, aliases: '-d', default: 'postgresql',
+    class_option :database, type: :string, aliases: '-d', default: 'mysql',
                             desc: "Configure for selected database (options: #{DATABASES.join('/')})"
 
     class_option :skip_test_unit, type: :boolean, aliases: '-T', default: true,
@@ -77,6 +77,9 @@ module Kratos
 
     def setup_production_environment
       say 'Setting up the production environment'
+      build :configure_newrelic
+      build :configure_rollbar
+      build :configure_nginx
       build :configure_smtp
       build :enable_rack_deflater
       build :setup_asset_host
@@ -142,6 +145,7 @@ module Kratos
       say 'Setting up database'
 
       build :use_postgres_config_template if 'postgresql' == options[:database]
+      build :use_mysql_config_template if 'mysql' == options[:database]
 
       build :create_database
     end

data/lib/kratos/version.rb

@@ -2,5 +2,5 @@
 module Kratos
   RAILS_VERSION = '~> 4.2.0'.freeze
   RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/templates/Capfile

@@ -1,3 +1,7 @@
+require 'dotenv'
+
+Dotenv.load
+
 # Load DSL and set up stages
 require 'capistrano/setup'
 
@@ -7,6 +11,10 @@ require 'capistrano/rbenv'
 require 'capistrano/bundler'
 require 'capistrano/rails/migrations'
 require 'capistrano/rails/assets'
+require 'capistrano/rails/console'
+require 'capistrano/nginx'
+require 'new_relic/recipes'
+require 'rollbar/capistrano3'
 
 # Setup Whenever tasks
 require 'whenever/capistrano'

data/templates/Gemfile.erb

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 ruby "<%= Kratos::RUBY_VERSION %>"
 
+gem 'rollbar'
 gem "email_validator"
 gem "i18n-tasks"
 gem "autoprefixer-rails"
@@ -9,7 +10,12 @@ gem "bourbon", "~> 4.2.0"
 gem "flutie"
 gem "jquery-rails"
 gem "normalize-rails", "~> 3.0.0"
+<% if options.database == 'postgresql' %>
 gem "pg"
+<% end %>
+<% if options.database == 'mysql' %>
+gem 'mysql2', '~> 0.3.20'
+<% end %>
 gem "puma"
 gem "rails", "<%= Kratos::RAILS_VERSION %>"
 gem "recipient_interceptor"
@@ -23,12 +29,11 @@ gem "sinatra", require: nil
 gem "redis-rails"
 gem "dalli"
 gem "lograge"
+gem 'newrelic_rpm', '>= 3.9.8'
 gem "whenever", require: false
-gem "premailer-rails"
 gem "nokogiri", ">= 1.6.7.2"
 gem "geocoder"
 gem "aws-sdk"
-gem "figaro"
 gem "httparty"
 
 group :development do
@@ -37,12 +42,16 @@ group :development do
   gem "capistrano", "~> 3.1"
   gem "capistrano-rails", "~> 1.1"
   gem "capistrano-rbenv", "~> 2.0"
+  gem 'capistrano3-nginx', '~> 2.0'
+  gem 'capistrano-rails-console'
 end
 
 group :development, :test do
   gem "pry-meta"
   gem "bullet"
   gem "bundler-audit", require: false
+  gem 'dotgpg'
+  gem 'dotenv-rails'
   gem "factory_girl_rails"
   gem "ffaker"
   gem "rspec-rails", "~> 3.4.0"

data/templates/bin_setup

@@ -10,10 +10,6 @@ set -e
 gem install bundler --conservative
 bundle check || bundle install
 
-if [ ! -f config/application.yml ]; then
-  cp .sample.application.yml config/application.yml
-fi
-
 # Set up database and add any development seed data
 bin/rake dev:prime
 

data/templates/deploy.rake

@@ -1,28 +1,40 @@
 namespace :deploy do
-  task :setup_env do
-    on roles(:web) do
-      within release_path do
-        execute(:cp, "~/.#{fetch(:application)}.yml config/application.yml")
-        execute(:cp, "~/.#{fetch(:application)}.env .env")
-        execute(:cp, "~/.#{fetch(:application)}.foreman .foreman")
-      end
-    end
-  end
-  before :updated, :setup_env
-
   task :restart do
     invoke 'foreman:export'
     invoke 'foreman:restart'
+    invoke 'deploy:setup_nginx'
   end
 
-  desc 'reload the database with seed data'
-  task :seed do
-    on primary :db do
-      within current_path do
-        with rails_env: fetch(:stage) do
-          execute(:rake, 'db:seed')
-        end
-      end
+  task :setup_nginx do
+    invoke 'nginx:site:add'
+    invoke 'nginx:site:enable'
+    invoke 'nginx:reload'
+  end
+
+  task :setup_env do
+    env_file = "env_#{fetch(:stage)}.gpg"
+
+    dotenv_contents = ''
+    run_locally do
+      fail "You must have a #{env_file} file on your project root " \
+           'to be able to deploy it' unless File.exist?(env_file)
+
+      dotenv_contents = `bundle exec dotgpg cat #{env_file}`
+    end
+
+    on roles(:app) do
+      dotenv = StringIO.new
+      dotenv << dotenv_contents
+      dotenv.rewind
+
+      upload! dotenv, File.join(shared_path, '.env')
     end
   end
+  after :started, :setup_env
+
+  namespace :check do
+    task linked_files: '.env'
+  end
 end
+
+remote_file '.env' => 'deploy:setup_env', roles: :app

data/templates/deploy_config.rb.erb

@@ -8,6 +8,15 @@ set :user, 'deploy'
 set :rbenv_ruby, File.read('.ruby-version').strip
 set :rbenv_type, :user
 set :rbenv_bin_path, '/home/deploy/.rbenv/shims'
+set :rbenv_prefix, -> { "#{fetch(:rbenv_path)}/bin/rbenv exec dotenv" }
+
+set :nginx_domains, '<%= app_name.dasherize %>.com.br'
+set :nginx_template, "#{stage_config_path}/nginx.conf.erb"
+set :app_server_port, 3000
+
+set :rollbar_token, ENV['ROLLBAR_TOKEN']
+set :rollbar_env, proc { fetch :stage }
+set :rollbar_role, proc { :db }
 
 # Always deploy the current branch.
 set :branch, `git rev-parse --abbrev-ref HEAD`.chomp
@@ -19,15 +28,8 @@ set :linked_dirs, fetch(:linked_dirs, []).push('log',
                                                'tmp/pids',
                                                'tmp/cache')
 
+set :linked_files, %w(.env)
+
 set :default_env, path: '/home/deploy/.rbenv/shims:$PATH'
 
-namespace :deploy do
-  after :restart, :clear_cache do
-    on roles(:web), in: :groups, limit: 3, wait: 10 do
-      # Here we can do anything such as:
-      # within release_path do
-      #   execute :rake, 'cache:clear'
-      # end
-    end
-  end
-end
+after 'deploy:updated', 'newrelic:notice_deployment'

data/templates/dotfiles/.env

@@ -1,3 +1,16 @@
 WEB_CONCURRENCY=1
 MAX_THREADS=3
 PORT=3000
+ASSET_HOST=localhost:3000
+APPLICATION_HOST=localhost:3000
+REDIS_URL=redis://127.0.0.1:6379
+SECRET_TOKEN=development_token
+SECRET_KEY_BASE=development_secret
+EXECJS_RUNTIME=Node
+SMTP_ADDRESS=smtp.example.com
+SMTP_DOMAIN=example.com
+SMTP_PASSWORD=password
+SMTP_USERNAME=username
+AWS_REGION=us-east-1
+AWS_ACCESS_KEY_ID=<put-your-key-here>
+AWS_SECRET_ACCESS_KEY=<put-your-secret-here>

data/templates/foreman.rake

@@ -3,9 +3,6 @@ namespace :foreman do
   task :export do
     on roles(:app) do
       within current_path do
-        # Add path to .env.
-        # Needed for rbenv to work properly.
-        execute(:echo, "\"PATH=#{fetch(:rbenv_bin_path)}:$PATH\" >> .env")
         # Create the upstart script
         execute(:sudo, "#{fetch(:rbenv_prefix)} " \
                 'foreman export upstart /etc/init ' \

data/templates/lograge.rb

@@ -1,7 +1,8 @@
 Rails.application.configure do
   if Rails.env.production?
     config.lograge.enabled = true
-    config.log_tags = [:uuid]
+    config.log_tags = [:uuid, :remote_ip]
+    config.lograge.formatter = Lograge::Formatters::Json.new
 
     config.lograge.custom_options = lambda do |event|
       params = event.payload[:params].reject do |k|

data/templates/mysql_database.yml.erb

@@ -0,0 +1,26 @@
+development: &default
+  adapter: mysql2
+  database: <%= app_name %>_development
+  encoding: utf8mb4
+  charset: utf8mb4
+  collation: utf8mb4_unicode_ci
+  host: localhost
+  min_messages: warning
+  pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
+  reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
+  timeout: 5000
+
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+production: &deploy
+  encoding: utf8mb4
+  charset: utf8mb4
+  collation: utf8mb4_unicode_ci
+  min_messages: warning
+  pool: <%%= [Integer(ENV.fetch("MAX_THREADS", 5)), Integer(ENV.fetch("DB_POOL", 5))].max %>
+  timeout: 5000
+  url:  <%%= ENV.fetch("DATABASE_URL", "") %>
+
+staging: *deploy

data/templates/newrelic.yml.erb

@@ -0,0 +1,34 @@
+common: &default_settings
+  app_name: "<%= app_name %>"
+  audit_log:
+    enabled: false
+  browser_monitoring:
+    auto_instrument: true
+  capture_params: false
+  developer_mode: false
+  error_collector:
+    capture_source: true
+    enabled: true
+    ignore_errors: "ActionController::RoutingError,Sinatra::NotFound"
+  license_key: "<%%= ENV["NEW_RELIC_LICENSE_KEY"] %>"
+  log_level: info
+  monitor_mode: true
+  transaction_tracer:
+    enabled: true
+    record_sql: obfuscated
+    stack_trace_threshold: 0.500
+    transaction_threshold: apdex_f
+development:
+  <<: *default_settings
+  monitor_mode: false
+  developer_mode: true
+test:
+  <<: *default_settings
+  monitor_mode: false
+production:
+  <<: *default_settings
+  monitor_mode: true
+staging:
+  <<: *default_settings
+  app_name: "<%= app_name %> (Staging)"
+  monitor_mode: true

data/templates/nginx.conf.erb

@@ -0,0 +1,86 @@
+<% if fetch(:app_server) && (fetch(:app_server_socket) || fetch(:app_server_port))%>
+# Define App Server Upstream
+upstream <%= fetch(:application) %>-app-server {
+<% if fetch(:app_server_socket) %>
+  server unix:<%= fetch(:app_server_socket) %> fail_timeout=0;
+<% elsif fetch(:app_server_port) %>
+  server <%= fetch(:app_server_host, '127.0.0.1') %>:<%= fetch(:app_server_port) %> fail_timeout=0;
+<% end %>
+}
+<% end %>
+
+# HTTP Server
+
+<% if fetch(:nginx_redirected_domains) %>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_redirected_domains) %>;
+  rewrite ^(.*) http://<%= fetch(:nginx_domains).gsub(/\s.*/,'') %> permanent;
+}
+<% end %>
+
+<% if fetch(:nginx_use_ssl) %>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_domains) %>;
+  rewrite ^(.*) https://$host$1 permanent;
+}
+<% end %>
+
+server {
+
+<% if fetch(:nginx_use_ssl) %>
+  listen 443;
+  ssl on;
+  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+  ssl_certificate <%= fetch(:nginx_ssl_certificate_path) %>/<%= fetch(:nginx_ssl_certificate) %>;
+  ssl_certificate_key <%= fetch(:nginx_ssl_certificate_key_path) %>/<%= fetch(:nginx_ssl_certificate_key) %>;
+<% else %>
+  listen 80;
+<% end %>
+
+  server_name <%= fetch(:nginx_domains) %>;
+  root        <%= fetch(:deploy_to) %>/current/<%= fetch(:nginx_static_dir) %>;
+
+  access_log <%= fetch(:nginx_log_path) %>/nginx-access.log timed_combined;
+  error_log  <%= fetch(:nginx_log_path) %>/nginx-error.log;
+
+  error_page 404 /404.html;
+  location /404.html { root <%= fetch(:deploy_to) %>/current/<%= fetch(:nginx_static_dir) %>; }
+
+  error_page 500 /500.html;
+  location /500.html { root <%= fetch  (:deploy_to) %>/current/<%= fetch(:nginx_static_dir) %>; }
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+<% if fetch(:app_server) && (fetch(:app_server_socket) || fetch(:app_server_port))%>
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  try_files $uri/index.html $uri @<%= fetch(:application) %>-app-server;
+
+  location @<%= fetch(:application) %>-app-server {
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-FORWARDED_PROTO http;
+    proxy_set_header Host $http_host;
+  <% if fetch(:nginx_use_ssl) %>
+    proxy_set_header X-Forwarded-Proto https;
+  <% end %>
+  <% if fetch(:nginx_read_timeout) %>
+    proxy_read_timeout <%= fetch(:nginx_read_timeout) %>;
+  <% end %>
+    proxy_redirect off;
+    proxy_pass http://<%= fetch(:application) %>-app-server;
+
+    proxy_cache default;
+    proxy_cache_lock on;
+    proxy_cache_use_stale updating;
+    add_header X-Cache-Status $upstream_cache_status;
+  }
+<% end %>
+}

data/templates/rollbar.rb.erb

@@ -0,0 +1,12 @@
+Rollbar.configure do |config|
+  if Rails.env.test? || Rails.env.development?
+    config.enabled = false
+  end
+
+  config.access_token = ENV['ROLLBAR_TOKEN']
+
+  config.use_sidekiq
+  config.use_sidekiq 'queue' => 'default'
+
+  config.environment = Rails.env
+end

data/templates/schedule.rb

@@ -2,6 +2,11 @@
 #
 # It's helpful, but not entirely necessary to understand cron before proceeding.
 # http://en.wikipedia.org/wiki/Cron
+#
+job_type :command, 'dotenv :task :output'
+job_type :rake,    'cd :path && dotenv bundle exec rake :task --silent :output'
+job_type :runner,  "cd :path && dotenv bin/rails runner -e :environment ':task' :output"
+job_type :script,  'cd :path && dotenv bin/:task :output'
 
 # every 1.day, at: '1:00 am' do
 # rake ...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kratos
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - jaisonerick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,7 +88,6 @@ files:
 - templates/dotfiles/.ctags
 - templates/dotfiles/.env
 - templates/dotfiles/.gitignore
-- templates/dotfiles/.sample.application.yml
 - templates/errors.rb
 - templates/factory_girl_rspec.rb
 - templates/foreman.rake
@@ -98,10 +97,14 @@ files:
 - templates/json_encoding.rb
 - templates/kratos_layout.html.erb.erb
 - templates/lograge.rb
+- templates/mysql_database.yml.erb
+- templates/newrelic.yml.erb
+- templates/nginx.conf.erb
 - templates/postgresql_database.yml.erb
 - templates/puma.rb
 - templates/rails_helper.rb
 - templates/redis.rb
+- templates/rollbar.rb.erb
 - templates/routes.rb
 - templates/rspec_api_documentation_rspec.rb.erb
 - templates/rubocop.rake
@@ -139,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A rails project generator based on thoughtbot's suspenders.

data/templates/dotfiles/.sample.application.yml

@@ -1,13 +0,0 @@
-ASSET_HOST: localhost:3000
-APPLICATION_HOST: localhost:3000
-REDIS_URL: redis://127.0.0.1:6379
-SECRET_TOKEN: development_token
-SECRET_KEY_BASE: development_secret
-EXECJS_RUNTIME: Node
-SMTP_ADDRESS: smtp.example.com
-SMTP_DOMAIN: example.com
-SMTP_PASSWORD: password
-SMTP_USERNAME: username
-AWS_REGION: us-east-1
-AWS_ACCESS_KEY_ID: <put-your-key-here>
-AWS_SECRET_ACCESS_KEY: <put-your-secret-here>