flash_kick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4a3e7d7b69bf1530a6cb8dd7bcc5f0398fe0c0d
+  data.tar.gz: 718576dc16ab910243fbd2f7daf59548d2a156b5
+SHA512:
+  metadata.gz: abec3e82283446f6d851499aa18e0f194579e4186f427269651a6b29044126b1e316b4ecfc79945f4a3869ecef2c99b6fca6691885f11421bc31b2c9a82735fa
+  data.tar.gz: cbde8438a127018378c1949be896a64c5576a7f790b0ad71fd9e57ef29af81b3bb08f0e32760eb8c9983c69ac60f0a28906c29fd7c2889b9613e353232906cfa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hheelliioo@live.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'thor'
+gem 'fileutils'

data/LICENSE.txt

@@ -0,0 +1,14 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 3, December 2016
+
+ Copyleft (ɔ) 2016 Helio Oliveira <hheelliioo@live.com>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+  1. Same as 0

data/README.md

@@ -0,0 +1,114 @@
+![flash kick](img/Flash_Kick.gif)
+```
+_____________             ______       ______ _____      ______
+___  __/__  /_____ __________  /_      ___  /____(_)________  /__
+__  /_ __  /_  __ `/_  ___/_  __ \     __  //_/_  /_  ___/_  //_/
+_  __/ _  / / /_/ /_(__  )_  / / /     _  ,<  _  / / /__ _  ,<
+/_/    /_/  \__,_/ /____/ /_/ /_/      /_/|_| /_/  \___/ /_/|_|
+
+         Flash kick = Ansible + Mina + Nginx + Puma
+```
+This gem is a fork of [Ahoy](https://github.com/npearson72/rails-ahoy)
+
+# Flash Kick will generate everything you need to deploy your Rails application
+
+* Ansible scripts to provision your server with Nginx, Ruby, PostgreSQL, and recommended security settings (ssh hardening, firewall, fail2ban, etc.)
+* Mina scripts to deploy your Rails application
+* Puma application server configuration files
+* An *.env* directory that will use YAML to store your environment variables securely
+
+## Installation
+
+**RECOMMENDATION:** You might want to first try this using a fresh Rails application so you can see how it effects your files before running this in your existing code base.
+Add this line to your application's Gemfile:
+
+You'll need [Ansible](http://docs.ansible.com/ansible/intro_installation.html)
+and [Mina](http://nadarei.co/mina/)
+
+### Step 1
+
+Add the gem to your Gemfile and bundle
+
+```ruby
+gem 'flash_kick'
+```
+
+    $ bundle install
+
+Execute the following terminal command to launch flash_kick's interactive guide
+
+    $ rails g flash_kick:init
+
+Continue to next step AFTER you complete the interactive guide
+
+### Step 2
+
+If you don't have a production *secret_key_base*, generate one using:
+
+    $ rake secret
+
+This will produce something that looks like:
+
+    $ f67395912d0ddd0de80a734822e73b327d007809123...
+
+Now just copy and paste it into the following file:
+
+    $ <YOUR RAILS APP>/.env/production_env.yml
+
+**IMPORTANT:** At this point make sure to commit your changes and push them up to your repo!
+
+### Step 3
+
+**IMPORTANT:** For this step, you will need a freshly installed Ubuntu box with root ssh privileges. If you're not sure how to do this, contact your web hosting administrator.
+
+From the root of your Rails application...
+
+    $ cd config/ansible && ./provision.sh production
+
+Executing `provision.sh <RAILS ENVIRONMENT FOR DEPLOYED APP>` will launch the provisioning process and setup your box so it can run Rails using Nginx as the web server, Puma as your application server, and PostgreSQL as your database.
+
+**NOTE:** This process may take a while (15 mins or so), so sit back and relax.
+
+### Step 4
+Once the provisioning process is complete, log into your box with the server user (ex: deployer)
+
+    $ ssh deployer@<YOUR SERVER IP>
+
+Once in, get your server user's public key
+
+    $ cat ~/.ssh/id_rsa.pub
+
+This will print out something like this:
+
+	ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDOv2hw90hySH+41A6NVjp6GXhBS/PUVmTot...
+
+Copy the public key and paste it into your git repo [Github](https://developer.github.com/guides/using-ssh-agent-forwarding/), [Bitbucket](https://confluence.atlassian.com/bitbucket/repository-privacy-permissions-and-more-221449716.html) settings to allow SSH access.
+
+### Step 5
+Go back to the ***root of your Rails application and execute the following command:
+
+    $ mina production setup
+
+Then...
+
+    $ mina production deploy
+
+### Congratulations!
+
+If everything worked as it should have, your Rails application should be up and running on the Web. Enjoy!
+
+
+## Contributing
+
+1. Fork it ( https://github.com/heliohead/flash_kick/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 a new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/heliohead/flash_kick. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available under the terms of the [wtfpl](LICENSE.txt).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flash_kick"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flash_kick.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flash_kick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flash_kick'
+  spec.version       = FlashKick::VERSION
+  spec.authors       = ['Helio Oliveira']
+  spec.email         = ['hheelliioo@live.com']
+
+  spec.summary       = 'Quick and painless Rails deployment'
+  spec.description   = 'Generator for building ansible based provisioning scripts, and mina/puma deployment scripts'
+  spec.homepage      = 'https://github.com/heliohead/flash_kick'
+  spec.license       = 'wtfpl'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/flash_kick/version.rb

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

data/lib/flash_kick.rb

@@ -0,0 +1,14 @@
+require "flash_kick/version"
+
+module FlashKick
+  def self.load_variables
+    begin
+      env_file = File.open(Rails.root + ".env/#{Rails.env}_env.yml", 'r')
+      if env_file
+        env_yaml = YAML.load(env_file)
+        env_yaml.each { |k,v| ENV[k.to_s.upcase] = v.to_s } if env_yaml.present?
+      end
+    rescue
+    end
+  end
+end

data/lib/generators/flash_kick/base.rb

@@ -0,0 +1,29 @@
+require 'generators/flash_kick/base'
+
+module FlashKick
+  module Initialize
+    def root
+      File.dirname(__FILE__)
+    end
+
+    def temp_dir
+      File.join(File.dirname(__FILE__), 'tmp/')
+    end
+  end
+
+  module Generator
+    extend Initialize
+
+    class Base < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      private
+
+      def question(type, &block)
+        FlashKick::QuestionHelper.question(type, &block)
+      end
+    end
+  end
+end

data/lib/generators/flash_kick/deployment_generator.rb

@@ -0,0 +1,121 @@
+require 'rails/generators'
+require 'generators/flash_kick/base'
+require 'generators/flash_kick/lib/question_helper'
+require 'generators/flash_kick/lib/variable_store'
+require 'fileutils'
+
+module FlashKick
+  class DeploymentGenerator < FlashKick::Generator::Base
+
+    def prompt_user
+      question :string do
+        {
+          app_name: 'What is the name of your application? [enter for default]',
+          default: Rails.application.class.parent_name.underscore
+        }
+      end
+      question :string do
+        {
+          server_domain: 'Which domain will you be deploying to? [enter for default]',
+          required: true
+        }
+      end
+      question :string do
+        {
+          server_user: 'Enter a name for your server user',
+          required: true
+        }
+      end
+      question :string do
+        {
+          server_ssh_port: 'What SSH port would you like to use on your server? [enter for default]',
+          default: '22'
+        }
+      end
+      question :string do
+        {
+          ruby_version: 'Which version of Ruby would you like to install? [enter for default]',
+          default: '2.1.5'
+        }
+      end
+      question :string do
+        {
+          postgresql_version: 'Which version of PostgreSQL would you like to install? [enter for default]',
+          default: '9.3'
+        }
+      end
+      question :string do
+        {
+          database_name: 'Enter a name for your production database',
+          default: Rails.application.class.parent_name.underscore + '_production'
+        }
+      end
+      question :string do
+        {
+          database_user: 'Enter a name for your production database user',
+          required: true
+        }
+      end
+      question :string do
+        {
+          database_password: 'Enter a password for your production database',
+          required: true
+        }
+      end
+      question :string do
+        {
+          app_repo: 'What is the github repository for this application?',
+          required: true
+        }
+      end
+      question :string do
+        {
+          app_repo_branch: 'Which repository branch will be used for deployment? [enter for default]',
+          default: 'master'
+        }
+      end
+    end
+
+    def copy_directory
+      directory 'ansible', 'config/ansible'
+    end
+
+    def copy_files
+      copy_file 'env_templates/_development_env.yml', '.env/development_env.yml'
+      copy_file 'env_templates/_test_env.yml', '.env/test_env.yml'
+    end
+
+    def copy_templates
+      template 'ansible_templates/_hosts', 'config/ansible/hosts'
+      template 'ansible_templates/playbooks/_production.yml', 'config/ansible/playbooks/production.yml'
+      template 'ansible_templates/playbooks/group_vars/_all.yml', 'config/ansible/playbooks/group_vars/all.yml'
+      template '_puma.sh', 'bin/puma.sh'
+      template '_puma.rb', 'config/puma.rb'
+      template '_deploy.rb', 'config/deploy.rb'
+      template 'env_templates/_production_env.yml', '.env/production_env.yml'
+    end
+
+    def add_gems
+      gem 'puma'
+      gem 'rb-readline'
+    end
+
+    def modify_files
+      append_file '.gitignore', '.env/'
+      inject_into_file 'config/environment.rb', after: "require File.expand_path('../application', __FILE__)\n\n" do <<-'RUBY'
+FlashKick.load_variables
+
+      RUBY
+      end
+    end
+
+    def change_permissions
+      FileUtils.chmod 0751, 'config/ansible/provision.sh'
+      FileUtils.chmod 0751, 'bin/puma.sh'
+    end
+
+    def create_symlinks
+      FileUtils.ln_s '../../../../.env/production_env.yml', 'config/ansible/playbooks/group_vars/production.yml'
+    end
+  end
+end

data/lib/generators/flash_kick/init_generator.rb

@@ -0,0 +1,42 @@
+require 'flash_kick/version'
+require 'rails/generators'
+require 'generators/flash_kick/base'
+require 'generators/flash_kick/lib/variable_store'
+
+module FlashKick
+  class InitGenerator < FlashKick::Generator::Base
+
+    def init
+      FlashKick::VariableStore.mkdir_tmp
+      section_divider
+      masthead
+      section_divider
+      generate 'flash_kick:deployment'
+      section_divider
+      generate 'flash_kick:vagrant'
+      section_divider
+      puts 'Finalizing...'
+      section_divider
+      puts 'Finished!'
+      FlashKick::VariableStore.rm_tmp
+    end
+
+
+    private
+
+    def section_divider
+      puts '=' * 100
+    end
+
+    def masthead
+      puts '  _____________             ______       ______ _____      ______   '
+      puts '  ___  __/__  /_____ __________  /_      ___  /____(_)________  /__ ' + '         FlashKick!'
+      puts '  __  /_ __  /_  __ `/_  ___/_  __ \     __  //_/_  /_  ___/_  //_/ ' + '   Get your Rails app deployed'
+      puts '  _  __/ _  / / /_/ /_(__  )_  / / /     _  ,<  _  / / /__ _  ,<    '
+      puts '  /_/    /_/  \__,_/ /____/ /_/ /_/      /_/|_| /_/  \___/ /_/|_|   ' + "  v.#{FlashKick::VERSION}"
+      puts '  _________________________________________________________________ '
+      puts '           Flash kick = Ansible + Mina + Nginx + Puma               '
+
+    end
+  end
+end

data/lib/generators/flash_kick/lib/question_helper.rb

@@ -0,0 +1,50 @@
+require 'generators/flash_kick/lib/variable_store'
+require 'thor'
+
+module FlashKick
+  class QuestionHelper
+
+    cattr_accessor :required
+
+    def self.question(type, &block)
+      question_hash = block.call
+      @@required    = question_hash[:required]
+      default       = question_hash[:default]
+      key           = question_hash.keys[0]
+      question      = "#{question_hash[key]}:"
+
+      question_divider(default)
+
+      case type
+      when :string
+        string_question(question, key, default)
+      when :boolean
+        boolean_question(question, key, default)
+      end
+    end
+
+    def self.string_question(question, key, default=nil)
+      if @@required == true
+        answer = ''
+        until answer != ''
+          answer = Thor.new.ask(question)
+          FlashKick::VariableStore.add_variable(key, answer.empty? ? default : answer)
+          puts "Answer required, but you can always change it later!!!\n\n" if answer == ''
+        end
+      else
+        answer = Thor.new.ask(question)
+        FlashKick::VariableStore.add_variable(key, answer.empty? ? default : answer)
+      end
+    end
+
+    def self.boolean_question(question, key, default=nil)
+      answer = Thor.new.yes?(question)
+      FlashKick::VariableStore.add_variable(key, answer == true ? answer : false)
+    end
+
+    def self.question_divider(value=nil)
+      puts '-' * 100
+      puts "Default: #{value}" unless value.nil?
+    end
+  end
+end

data/lib/generators/flash_kick/lib/variable_store.rb

@@ -0,0 +1,23 @@
+require 'generators/flash_kick/base'
+require 'fileutils'
+require 'yaml'
+
+module FlashKick
+  class VariableStore
+    def self.add_variable(key, value)
+      File.open(FlashKick::Generator.temp_dir + "variables.yml", 'a') {|f| f.write("#{key}: #{value}\n") }
+    end
+
+    def self.variables
+      YAML.load(File.open(FlashKick::Generator.temp_dir + "variables.yml", 'r'))
+    end
+
+    def self.mkdir_tmp
+      FileUtils.mkdir(FlashKick::Generator.root + '/tmp')
+    end
+
+    def self.rm_tmp
+      FileUtils.remove_dir(FlashKick::Generator.root + '/tmp')
+    end
+  end
+end

data/lib/generators/flash_kick/templates/_Vagrantfile

@@ -0,0 +1,20 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+VAGRANTFILE_API_VERSION = 2
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = 'hashicorp/precise64'
+
+  config.vm.network :forwarded_port, guest: 3000, host: 3000
+
+  config.vm.provider 'virtualbox' do |v|
+    v.memory = <%= FlashKick::VariableStore.variables['vagrant_memory'].to_i * 1024 %>
+    v.cpus = <%= FlashKick::VariableStore.variables['vagrant_cpus'].to_i %>
+  end
+
+  config.vm.provision 'ansible' do |ansible|
+    ansible.playbook = 'config/ansible/playbooks/vagrant.yml'
+    ansible.limit = 'default'
+  end
+end

data/lib/generators/flash_kick/templates/_database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter: postgresql
+  host: localhost
+  encoding: unicode
+  ctype: en_US.utf8
+  collation: en_US.utf8
+  template: template0
+  pool: 5
+  username: vagrant
+  password: vagrant
+
+development:
+  <<: *default
+  database: <%= FlashKick::VariableStore.variables['app_name'] %>_development
+
+test:
+  <<: *default
+  database: <%= FlashKick::VariableStore.variables['app_name'] %>_test

data/lib/generators/flash_kick/templates/_deploy.rb

@@ -0,0 +1,59 @@
+require 'mina/bundler'
+require 'mina/rails'
+require 'mina/git'
+require 'mina/rbenv'
+
+set :deploy_to,     '/var/www/<%= FlashKick::VariableStore.variables['app_name'] %>'
+set :app_path,      '/var/www/<%= FlashKick::VariableStore.variables['app_name'] %>/current'
+set :user,          '<%= FlashKick::VariableStore.variables['server_user'] %>'
+set :port,          '<%= FlashKick::VariableStore.variables['server_ssh_port'] %>'
+set :repository,    '<%= FlashKick::VariableStore.variables['app_repo'] %>'
+set :forward_agent, true
+
+task :production do
+  set :domain,        '<%= FlashKick::VariableStore.variables['server_domain'] %>'
+  set :branch,        '<%= FlashKick::VariableStore.variables['app_repo_branch'] %>'
+  set :rails_env,     'production'
+  set :shared_paths,  ['config/database.yml', 'config/secrets.yml', 'log', 'tmp', '.env/production_env.yml']
+end
+
+task :environment do
+  queue 'export PATH=/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH'
+  queue 'source ~/.session_vars'
+end
+
+task setup: :environment do
+  queue "mkdir -m 750 -p #{deploy_to}/#{shared_path}/log"
+  queue "mkdir -m 750 -p #{deploy_to}/#{shared_path}/config"
+  queue "mkdir -m 750 -p #{deploy_to}/#{shared_path}/tmp/log"
+  queue "mkdir -m 750 -p #{deploy_to}/#{shared_path}/tmp/pids"
+  queue "mkdir -m 750 -p #{deploy_to}/#{shared_path}/tmp/sockets"
+end
+
+task deploy: :environment do
+  deploy do
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    invoke :'bundle:install'
+    invoke :'rails:db_migrate'
+    invoke :'rails:assets_precompile'
+    invoke :'deploy:cleanup'
+    to :launch do
+      invoke :'server:restart'
+    end
+  end
+end
+
+namespace :server do
+  task start: :environment do
+    queue "cd #{app_path} && rails_env=#{rails_env} && bin/puma.sh start"
+  end
+
+  task stop: :environment do
+    queue "cd #{app_path} && rails_env=#{rails_env} && bin/puma.sh stop"
+  end
+
+  task restart: :environment do
+    queue "cd #{app_path} && rails_env=#{rails_env} && bin/puma.sh restart"
+  end
+end