orats 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86701c9d3879d19d5be1fdae7ba6322db003c08f
-  data.tar.gz: 2eca54c7c2359e3c71da893813cd61360f484951
+  metadata.gz: ed2be672732a97ee0adf810bdef6be8e40df6415
+  data.tar.gz: caa247df80d369533b424a261ba57b254501b579
 SHA512:
-  metadata.gz: a8ee825ee47eaa23e1f240280f0d023b06c1256cb858d2c577acd822d5a744858cb5c26c2e2ec0542934aeafc5da6c8ce6096e6e1b4b373f0aa3f9f56255f94c
-  data.tar.gz: 93721d778eb7063a2b393735fbfd101d55841116972d6f72583acf0aa6b0c33dc7b229a92458abf69a0bb93053f72f8a53c396dd61aafd56a4c4326a508bf57a
+  metadata.gz: 4f26035196b05988cd3eda4a894cbd651aedb8a33a6da75eae97fb5e0d43b1df49e066945f928b2b8e7b1b21a9df1d005dbf926688ae40ecce4b70e19f81f86f
+  data.tar.gz: 67cbd89f2b3eb6a93e1a099e7b5b910f05c288a1d8f811fdbf8f8297af40727ed738ad6b18e2acf7f7509609c8f2a8a5415e33326b9297004d973385969bf2ae

data/README.md

@@ -6,6 +6,8 @@ It stands for opinionated rails application templates. The templates include sol
 projects. It handles creating a rails application with a bunch of opinions and optionally an ansible playbook so you can
 deploy your apps quickly.
 
+You can also optionally include custom rails templates to append to any template you create with orats.
+
 Everything is accessed through the [orats gem](#installation).
 
 ## What version of Rails and Ruby are you targeting?
@@ -62,7 +64,7 @@ Here is an overview of the available commands. You can find out more information
 running `orats <command name> help` from your terminal. You can also type `orats` on its own to see a list of all commands.
 
 - Create a new orats project
-    - `orats new <APP_PATH> --pg-password <development postgres db password>`
+    - `orats new <TARGET_PATH> --pg-password <development postgres db password>`
     - Configuration:
         - Optionally takes: `--pg-location [localhost]`
         - Optionally takes: `--pg-username [postgres]`
@@ -70,6 +72,7 @@ running `orats <command name> help` from your terminal. You can also type `orats
         - Optionally takes: `--redis-password []`
     - Template features:
         - Optionally takes: `--auth [false]`
+        - Optionally takes: `--template []`
     - Project features:
         - Optionally takes: `--skip-extras [false]`
         - Optionally takes: `--skip-foreman-start [false]`
@@ -78,10 +81,12 @@ running `orats <command name> help` from your terminal. You can also type `orats
         - Optionally takes: `--skip-galaxy [false]`
 
 - Create an ansible playbook
-    - `orats play <PATH>`
+    - `orats play <TARGET_PATH>`
+    - Template features:
+        - Optionally takes: `--template []`
 
 - Delete the directory and optionally all data associated to it
-    - `orats nuke <APP_PATH>`
+    - `orats nuke <TARGET_PATH>`
     - Optionally takes: `--skip-data [false]`
 
 - Detect whether or not orats, the playbook or inventory is outdated
@@ -124,10 +129,12 @@ it includes these features and when I do not want a specific thing it is much qu
 - Create development, staging and production environments.
 - Use environment variables for things that are likely to change per environment.
 - Use environment variables for anything that is sensitive and should not be included into version control.
+- Add environment variables for google analytics UI, disqus short name and S3 in addition to a bunch of typical rails values.
 - Use redis as the cache backend.
 - Use sidekiq as a background worker.
 - Use puma as the server with settings capable of doing phased restarts.
 - Use foreman in development mode to manage starting both the rails server using puma and sidekiq.
+- Add a rake task to handle upgrades using the `backup` gem.
 - Set the production asset precompiler to include fonts and png files.
 - Set the production logger to rotate the logs daily.
 - Set the timezone to EST.
@@ -140,7 +147,7 @@ it includes these features and when I do not want a specific thing it is much qu
 - Add 3 view helpers to easily set a page's title, meta description and page heading. All of which are optional.
 - Bootstrap ~3 layout file with conditionally loaded `html5shiv`, `json3` and `respondjs` libs for IE < 9 support.
 - Separate the navigation, navigation links, flash messages and footer partials.
-- Add partials and environment variables for both google analytics and disqus.
+- Add partials for both google analytics and disqus.
 - Public 404, 422, 500 and 502 pages so they can be served directly from your web server.
 - Use sass and coffeescript.
 - jquery 1.10.x loaded through a CDN.

data/lib/orats/cli.rb

@@ -1,21 +1,25 @@
 require 'thor'
-require 'orats/command'
+require 'orats/commands/new/exec'
+require 'orats/commands/outdated/exec'
+require 'orats/commands/play'
+require 'orats/commands/nuke'
 
 module Orats
   class CLI < Thor
-    option :pg_location, default: 'localhost'
-    option :pg_username, default: 'postgres'
-    option :pg_password, required: true
-    option :redis_location, default: 'localhost'
-    option :redis_password, default: ''
+    option :pg_location, default: 'localhost', aliases: '-l'
+    option :pg_username, default: 'postgres', aliases: '-u'
+    option :pg_password, required: true, aliases: '-p'
+    option :redis_location, default: 'localhost', aliases: '-n'
+    option :redis_password, default: '', aliases: '-d'
     option :auth, type: :boolean, default: false, aliases: '-a'
+    option :template, default: '', aliases: '-m'
     option :skip_extras, type: :boolean, default: false, aliases: '-E'
     option :skip_foreman_start, type: :boolean, default: false, aliases: '-F'
-    option :sudo_password, default: ''
+    option :sudo_password, default: '', aliases: '-s'
     option :skip_galaxy, type: :boolean, default: false, aliases: '-G'
-    desc 'new APP_PATH [options]', ''
+    desc 'new TARGET_PATH [options]', ''
     long_desc <<-D
-      `orats new myapp --pg-password supersecret` will create a new rails project and it will also create an ansible inventory to go with it by default.
+      `orats new target_path --pg-password supersecret` will create a new rails project and it will also create an ansible inventory to go with it by default.
 
       You must supply at least this flag:
 
@@ -35,6 +39,8 @@ module Orats
 
       `--auth` will include authentication and authorization [false]
 
+      `--template` will let you supply a custom template, a url or file is ok but urls must start with http or https []
+
       Project features:
 
       `--skip-extras` skip creating the services directory and ansible inventory/secrets [false]
@@ -47,33 +53,38 @@ module Orats
 
       `--skip-galaxy` skip automatically installing roles from the galaxy [false]
     D
-    def new(app_name)
-      Command.new(app_name, options).new
+    def new(target_path)
+      Commands::New::Exec.new(target_path, options).init
     end
 
-    desc 'play PATH', ''
+    option :template, default: '', aliases: '-m'
+    desc 'play PATH [options]', ''
     long_desc <<-D
-      `orats play path` will create an ansible playbook.
+      `orats play target_path` will create an ansible playbook.
+
+      Template features:
+
+      `--template` will let you supply a custom template, a url or file is ok but urls must start with http or https []
     D
-    def play(app_name)
-      Command.new(app_name).play
+    def play(target_path)
+      Commands::Play.new(target_path, options).init
     end
 
     option :skip_data, type: :boolean, default: false, aliases: '-D'
-    desc 'nuke APP_PATH [options]', ''
+    desc 'nuke TARGET_PATH [options]', ''
     long_desc <<-D
-      `orats nuke myapp` will delete the directory and optionally all data associated to it.
+      `orats nuke target_path` will delete the directory and optionally all data associated to it.
 
       Options:
 
       `--skip-data` will skip deleting app specific postgres databases and redis namespaces [false]
     D
-    def nuke(app_name)
-      Command.new(app_name, options).nuke
+    def nuke(target_path)
+      Commands::Nuke.new(target_path, options).init
     end
 
-    option :playbook, default: ''
-    option :inventory, default: ''
+    option :playbook, default: '', aliases: '-p'
+    option :inventory, default: '', aliases: '-i'
     desc 'outdated [options]', ''
     long_desc <<-D
       `orats outdated` will run various comparisons on orats and your ansible files.
@@ -91,7 +102,7 @@ module Orats
       `--inventory` to supply an inventory file for comparison []
     D
     def outdated
-      Command.new(nil, options).outdated
+      Commands::Outdated::Exec.new(nil, options).init
     end
 
     desc 'version', ''
@@ -99,7 +110,7 @@ module Orats
       `orats version` will print the current version.
     D
     def version
-      Command.new.version
+      puts "Orats version #{VERSION}"
     end
     map %w(-v --version) => :version
 

data/lib/orats/commands/common.rb

@@ -0,0 +1,82 @@
+require 'orats/commands/ui'
+require 'orats/commands/outdated/parse'
+
+module Orats
+  module Commands
+    class Common
+      include Thor::Base
+      include Thor::Shell
+      include Thor::Actions
+      include UI
+      include Outdated::Parse
+
+      RELATIVE_PATHS = {
+          galaxyfile: 'templates/includes/Galaxyfile',
+          hosts: 'templates/includes/inventory/hosts',
+          inventory: 'templates/includes/inventory/group_vars/all.yml',
+          playbook: 'templates/play.rb',
+          version: 'version.rb'
+      }
+
+      attr_accessor :remote_gem_version, :remote_paths, :local_paths
+
+      def initialize(target_path = '', options = {})
+        @target_path = target_path
+        @options = options
+        @active_path = @target_path
+
+        @local_paths = {}
+        @remote_paths = {}
+
+        build_common_paths
+
+        self.destination_root = Dir.pwd
+        @behavior = :invoke
+      end
+
+      private
+
+      def base_path
+        File.join(File.expand_path(File.dirname(__FILE__)), '..')
+      end
+
+      def repo_path
+        %w(https://raw.githubusercontent.com/nickjj/orats lib/orats)
+      end
+
+      def select_branch(branch, value)
+        "#{repo_path[0]}/#{branch}/#{repo_path[1]}/#{value}"
+      end
+
+      def build_common_paths
+        @remote_paths[:version] = select_branch 'master', RELATIVE_PATHS[:version]
+        @remote_gem_version = gem_version
+
+        RELATIVE_PATHS.each_pair do |key, value|
+          @local_paths[key] = "#{base_path}/#{value}"
+          @remote_paths[key] = select_branch @remote_gem_version, value
+        end
+      end
+
+      def url_to_string(url)
+        begin
+          open(url).read
+        rescue *[OpenURI::HTTPError, SocketError] => ex
+          log_error 'error', "Error accessing URL #{url}",
+                    'message', ex
+          exit 1
+        end
+      end
+
+      def file_to_string(path)
+        if File.exist?(path) && File.file?(path)
+          IO.read(path)
+        else
+          log_error 'error', 'Error finding file',
+                    'message', path
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/orats/commands/new/ansible.rb

@@ -0,0 +1,105 @@
+require 'securerandom'
+
+module Orats
+  module Commands
+    module New
+      module Ansible
+        def ansible_extras
+          create_inventory
+
+          secrets_path = "#{@target_path}/secrets"
+          create_secrets secrets_path
+
+          log_thor_task 'shell', 'Modifying secrets path in group_vars/all.yml'
+          gsub_file "#{@target_path}/#{fix_path_for_user(Commands::Common::RELATIVE_PATHS[:inventory])}",
+                    '~/tmp/testproj/secrets/', File.expand_path(secrets_path)
+
+          log_thor_task 'shell', 'Modifying the place holder app name in group_vars/all.yml'
+          gsub_file "#{@target_path}/#{fix_path_for_user(Commands::Common::RELATIVE_PATHS[:inventory])}",
+                    'testproj', File.basename(@target_path)
+
+          log_thor_task 'shell', 'Creating ssh keypair'
+          run "ssh-keygen -t rsa -P '' -f #{secrets_path}/id_rsa"
+
+          log_thor_task 'shell', 'Creating self signed ssl certificates'
+          run create_rsa_certificate(secrets_path, 'sslkey.key', 'sslcert.crt')
+
+          log_thor_task 'shell', 'Creating monit pem file'
+          run "#{create_rsa_certificate(secrets_path,
+                                        'monit.pem', 'monit.pem')} && openssl gendh 512 >> #{secrets_path}/monit.pem"
+
+          install_role_dependencies unless @options[:skip_galaxy]
+        end
+
+        private
+
+        def create_inventory
+          log_thor_task 'shell', 'Creating ansible inventory'
+          run "mkdir -p #{@target_path}/inventory/group_vars"
+
+          local_to_user Commands::Common::RELATIVE_PATHS[:hosts]
+          local_to_user Commands::Common::RELATIVE_PATHS[:inventory]
+        end
+
+        def local_to_user(file)
+          fixed_file = fix_path_for_user(file)
+
+          log_thor_task 'shell', "Creating #{fixed_file}"
+          run "cp #{base_path}/#{file} #{@target_path}/#{fixed_file}"
+        end
+
+        def create_secrets(secrets_path)
+          log_thor_task 'shell', 'Creating ansible secrets'
+          run "mkdir #{secrets_path}"
+
+          if @options[:redis_password].empty?
+            run "touch #{secrets_path}/redis_password"
+          else
+            save_secret_string "#{secrets_path}/redis_password"
+            gsub_file "#{@target_path}/#{fix_path_for_user(Commands::Common::RELATIVE_PATHS[:inventory])}",
+                      'redis_password: false', 'redis_password: true'
+          end
+
+          save_secret_string "#{secrets_path}/postgres_password"
+          save_secret_string "#{secrets_path}/mail_password"
+          save_secret_string "#{secrets_path}/rails_token"
+          save_secret_string "#{secrets_path}/devise_token"
+          save_secret_string "#{secrets_path}/devise_pepper_token"
+        end
+
+        def save_secret_string(file)
+          File.open(file, 'w+') { |f| f.write(SecureRandom.hex(64)) }
+        end
+
+        def create_rsa_certificate(secrets_path, keyout, out)
+          "openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj '/C=US/ST=Foo/L=Bar/O=Baz/CN=qux.com' -keyout #{secrets_path}/#{keyout} -out #{secrets_path}/#{out}"
+        end
+
+        def install_role_dependencies
+          log_thor_task 'shell', 'Updating ansible roles from the galaxy'
+
+          galaxy_install =
+              "ansible-galaxy install -r #{base_path}/#{Commands::Common::RELATIVE_PATHS[:galaxyfile]} --force"
+
+          galaxy_out = run(galaxy_install, capture: true)
+
+          if galaxy_out.include?('you do not have permission')
+            if @options[:sudo_password].empty?
+              sudo_galaxy_command = 'sudo'
+            else
+              sudo_galaxy_command = "echo #{@options[:sudo_password]} | sudo -S"
+            end
+
+            run("#{sudo_galaxy_command} #{galaxy_install}")
+          end
+        end
+
+        private
+
+        def fix_path_for_user(file)
+          file.sub('templates/includes/', '')
+        end
+      end
+    end
+  end
+end

data/lib/orats/commands/new/exec.rb

@@ -0,0 +1,54 @@
+require 'orats/commands/common'
+require 'orats/commands/new/ansible'
+require 'orats/commands/new/rails'
+require 'orats/commands/new/foreman'
+
+module Orats
+  module Commands
+    module New
+      class Exec < Commands::Common
+        include Ansible
+        include Rails
+        include Foreman
+
+        def initialize(target_path = '', options = {})
+          super
+
+          @active_path = services_path
+        end
+
+        def init
+          rails_template 'base' do
+            gsub_postgres_info
+            gsub_redis_info unless @options[:redis_password].empty?
+            gsub_project_path
+
+            bundle_install
+            bundle_binstubs
+            spring_binstub
+
+            create_and_migrate_database
+          end
+
+          if @options[:auth]
+            rails_template 'auth', '--skip ' do
+              run_rake 'db:migrate db:seed'
+            end
+          end
+
+          ansible_extras unless @options[:skip_extras]
+
+          custom_rails_template unless @options[:template].empty?
+
+          foreman_start unless @options[:skip_foreman_start]
+        end
+
+        private
+
+        def services_path
+          @options[:skip_extras] ?  @target_path : "#{@target_path}/services/#{File.basename @target_path}"
+        end
+      end
+    end
+  end
+end

data/lib/orats/commands/new/foreman.rb

@@ -0,0 +1,55 @@
+require 'socket'
+require 'timeout'
+
+module Orats
+  module Commands
+    module New
+      module Foreman
+        def foreman_start
+          @options[:skip_foreman_start] ? message = 'Start your' : message = 'Starting'
+
+          puts  '', '='*80
+          log_status_top 'action', "#{message} server with the following commands", :cyan
+          log_status_bottom 'command', "cd #{@active_path}", :magenta, true
+          log_status_bottom 'command', 'bundle exec foreman start', :magenta
+          puts  '='*80, ''
+
+          attempt_to_start
+        end
+
+        private
+
+        def attempt_to_start
+          while port_taken? do
+            log_status_top 'error', "Another application is using port 3000\n", :red
+
+            exit 1 if no?('Would you like to try running the server again? (y/N)', :cyan)
+          end
+
+          puts
+
+          run_from @active_path, 'bundle exec foreman start'
+        end
+
+        def port_taken?
+          begin
+            Timeout::timeout(5) do
+              begin
+                s = TCPSocket.new('localhost', 3000)
+                s.close
+
+                return true
+              rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+                return false
+              end
+            end
+          rescue Timeout::Error
+            false
+          end
+
+          false
+        end
+      end
+    end
+  end
+end