founders_template 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d2b17da3d674c0c5b4d41ba46958fd0702cafd663753e32686cfae849343eb1
-  data.tar.gz: c952aceb8edfd4b65ca351d2761585b2e3bccda6068e25154834e697c5c234c9
+  metadata.gz: 4f778c67aa0b23fdf70d7ee41b7e989a774e7a810ada15d2f805ddf47785aec5
+  data.tar.gz: b27060bdfec354a751932afb8ba2fed4252162cef4ea4fa1e507e7ff8b8ea841
 SHA512:
-  metadata.gz: 543bd724960bbebcf8e53eaaa62128b2214517120df19b80469dbe03d009ca4fe46a2bcababc00216f675688b3350c26e44c21d7aa55a317dd270cca76fe59cb
-  data.tar.gz: 9a07ada41185a2477c936c98a4b5cc26104b4bb08c5b669266f71a7bab0c626c1b13298f1e3aaab0b216c8f3f0c586b0405e270e6b705920da222e4549699b60
+  metadata.gz: b5ea28ed9b81d17c257a3202b801fe86e25a625cd9b2a3fd756c7334bbded7c1aef7aecaeae0703046d6ea216634cf4dc25cc2da6de4f37f52c8c5826449bde4
+  data.tar.gz: 88515689c9a372a5aa3cdd38e971ecf4b22b2a1300bb2c47600695d86c1631d4e099915382df9d20150afc8a408564d85c57e1b6bb6de3349ea42c4d4650bd14

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 vendor/
 .rubocop-*
+playground/

data/Gemfile-rails6.lock

@@ -1,13 +1,43 @@
 PATH
   remote: .
   specs:
-    founders_template (0.1.2)
+    founders_template (0.1.3)
+      activesupport
+      aws-sdk-core
+      aws-sdk-ec2
+      aws-sdk-secretsmanager
       thor (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.281.0)
+    aws-sdk-core (3.91.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.149.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-secretsmanager (1.34.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    minitest (5.14.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -23,6 +53,10 @@ GEM
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby

data/founders_template.gemspec

@@ -27,5 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'aws-sdk-core'
+  spec.add_dependency 'aws-sdk-ec2'
+  spec.add_dependency 'aws-sdk-secretsmanager'
   spec.add_dependency 'thor', '~> 1.0'
 end

data/lib/founders_template/cli.rb

@@ -2,12 +2,27 @@
 
 require 'shellwords'
 require 'thor'
+require 'active_support/encrypted_file'
+require 'active_support/core_ext/hash/keys'
+require 'aws-sdk-ec2'
+require 'aws-sdk-secretsmanager'
+require 'yaml'
 
+require 'founders_template/utils'
+require 'founders_template/config_file'
+
+REQUIRED_SYSTEM_TOOLS = %w( direnv ).freeze
 SCRIPT_PATH = File.expand_path(File.join(__dir__, '..', '..', 'bash')).freeze
+CREDENTIALS_PATH = 'config/credentials'
+CREDENTIALS_KEY_FILE = File.join(CREDENTIALS_PATH, 'production.key').freeze
+CONFIG_PATH = 'config'
 
 module FoundersTemplate
   class CLI < Thor
     include Thor::Actions
+    source_root File.join(__dir__, '../../templates')
+
+    include Utils
 
     desc 'ci SCRIPT_NAME', 'exec the ci script SCRIPT_NAME'
     def ci(script_name, *args)
@@ -17,15 +32,146 @@ module FoundersTemplate
       exec '/usr/bin/env', 'bash', file_path, *args
     end
 
-    def self.source_root
-      File.join(__dir__, '../../templates')
+    desc 'check', 'check that all the required tooling is installed'
+    def check
+      return if REQUIRED_SYSTEM_TOOLS.all? { |command| check_command(command) }
+
+      error 'Some dependencies were missing, please check the README for instructions.'
+      exit 1
     end
 
     desc 'install', 'install the buildspec'
     def install
+      check
+
+      ensure_application_config
+      ensure_aws_credentials
+      ensure_credentials_key
+      ensure_secret_key
+
       template 'buildspec.yml.erb', 'buildspec.yml'
+      template 'docker-compose.ci.yml.erb', 'docker-compose.ci.yml'
 
       directory 'ci', 'ci'
     end
+
+    private
+
+    def ensure_aws_credentials
+      return if aws_credentials?
+
+      message = <<~TEXT
+
+        We need to setup an AWS credentials profile on your system.
+        This will add a section to ~/.aws/credentials so you will have a profile containing
+        your keys for this project. This will then configure direnv so that whenever you are
+        inside your project's directory all AWS commands will be configured to use that
+        profile.
+
+      TEXT
+      say message, :yellow
+
+      aws_access_key_id = ask 'AWS Access Key ID:'
+      aws_secret_access_key = ask 'AWS Secret Access Key (typing will be hidden):', echo: false
+
+      regions = Aws::EC2::Client.new(region: 'us-east-1',
+                                     access_key_id: aws_access_key_id,
+                                     secret_access_key: aws_secret_access_key).describe_regions
+      aws_region = ask 'AWS Region:',
+                       limited_to: regions.regions.map(&:region_name),
+                       default: 'us-east-1'
+
+      add_to_envrc AWS_REGION: aws_region
+
+      profile = <<~TEXT
+        [#{app_config.short_name}]
+        aws_access_key_id = #{aws_access_key_id}
+        aws_secret_access_key = #{aws_secret_access_key}
+      TEXT
+      append_to_file '~/.aws/credentials', profile
+      add_to_envrc AWS_PROFILE: app_config.short_name
+    end
+
+    def secrets_manager_key_exist?(key_id)
+      secrets_manager.describe_secret({ secret_id: key_id })
+      true
+    rescue Aws::SecretsManager::Errors::ResourceNotFoundException
+      false
+    end
+
+    def secrets_manager_credentials_key_id
+      "#{app_config.short_name}/rails/production/credentials_master_key"
+    end
+
+    def secrets_manager_secret_key_id
+      "#{app_config.short_name}/rails/production/secret_key_base"
+    end
+
+    def ensure_credentials_key
+      return unless credentials_supported?
+      return if secrets_manager_key_exist?(secrets_manager_credentials_key_id)
+
+      ensure_credentials_key_file
+      copy_credentials_to_secrets_manager
+    end
+
+    def credentials_supported?
+      Dir.exist?(CREDENTIALS_PATH)
+    end
+
+    def ensure_credentials_key_file
+      return if File.exist?(CREDENTIALS_KEY_FILE)
+
+      create_file CREDENTIALS_KEY_FILE, ActiveSupport::EncryptedFile.generate_key
+      chmod CREDENTIALS_KEY_FILE, 0o600
+    end
+
+    def copy_credentials_to_secrets_manager
+      return if secrets_manager_key_exist?(secrets_manager_credentials_key_id)
+
+      key = run("cat #{CREDENTIALS_KEY_FILE}")
+      secrets_manager.create_secret(
+        description: "The Rails credentials key for #{app_config.short_name}",
+        name: secrets_manager_credentials_key_id,
+        secret_string: { production: key }.to_json
+      )
+    end
+
+    def ensure_secret_key
+      return if secrets_manager_key_exist?(secrets_manager_secret_key_id)
+
+      key = ask 'Rails Secret Key (leave blank to generate a new one):'
+      key = SecureRandom.hex(64) if key == ''
+      secrets_manager.create_secret(
+        description: "The Rails secret key for #{app_config.short_name}",
+        name: secrets_manager_secret_key_id,
+        secret_string: { production: key }.to_json
+      )
+    end
+
+    def secrets_manager
+      @secrets_manager ||= Aws::SecretsManager::Client.new
+    end
+
+    def aws_credentials?
+      sts = Aws::STS::Client.new(region: 'us-east-1')
+      sts.get_caller_identity
+      true
+    rescue Aws::Errors::MissingCredentialsError
+      false
+    end
+
+    def ensure_application_config
+      return if app_config.valid?
+
+      app_config.name = ask 'Application Name:'
+      app_config.short_name = ask 'Application Short Name:', default: app_config.short_name
+
+      template_file app_config
+    end
+
+    def app_config
+      @app_config ||= ConfigFile.new(CONFIG_PATH)
+    end
   end
 end

data/lib/founders_template/config_file.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'founders_template/template_file'
+
+module FoundersTemplate
+  class ConfigFile < TemplateFile
+    root_key 'application'
+    required_keys %i( name short_name )
+
+    template_file 'ft.yml.erb'
+    output_file 'ft.yml'
+
+    attr_accessor :name
+    attr_writer :short_name
+
+    def short_name
+      @short_name ||= name.split.map(&:chr).join.downcase
+    end
+  end
+end

data/lib/founders_template/template_file.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module FoundersTemplate
+  class TemplateFile
+    def self.root_key(key = nil)
+      @root_key = key if key
+      @root_key ||= nil
+    end
+
+    def self.output_file(file_name = nil)
+      @output_file = file_name if file_name
+      @output_file ||= nil
+    end
+
+    def self.template_file(file_name = nil)
+      @template_file = file_name if file_name
+      @template_file ||= nil
+    end
+
+    def self.required_keys(keys = nil)
+      @required_keys = keys if keys
+      @required_keys ||= []
+    end
+
+    def initialize(output_directory)
+      @output_directory = output_directory
+      @data = File.exist?(output_file) && YAML.load_file(output_file)
+      return unless @data
+
+      @data = @data[self.class.root_key] if self.class.root_key
+      @data.symbolize_keys!
+      load_data
+    end
+
+    def valid?
+      self.class.required_keys.none? { |key| public_send(key).nil? }
+    end
+
+    def binding_for_render
+      binding
+    end
+
+    def template_file
+      self.class.template_file
+    end
+
+    def output_file
+      File.join(@output_directory, self.class.output_file)
+    end
+
+    private
+
+    def load_data
+      @data.each do |key, value|
+        public_send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/founders_template/utils.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module FoundersTemplate
+  module Utils
+    def add_to_envrc(variables)
+      create_file '.envrc' unless File.exist?('.envrc')
+
+      variables.each do |name, value|
+        name = name.to_s
+        append_to_file '.envrc', "export #{name}=#{value}\n"
+        ENV[name] = value
+      end
+
+      run 'direnv allow .'
+    end
+
+    def check_command(command)
+      return true if system_command?(command)
+
+      say_status :missing, command
+      false
+    end
+
+    def system_command?(command)
+      system("which #{Shellwords.escape(command)} > /dev/null 2>&1")
+    end
+
+    def template_file(template_file)
+      template template_file.template_file,
+               template_file.output_file,
+               context: template_file.binding_for_render
+    end
+  end
+end

data/lib/founders_template/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FoundersTemplate
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/templates/buildspec.yml.erb

@@ -1,5 +1,10 @@
 version: 0.2
 
+env:
+  secrets-manager:
+    RAILS_MASTER_KEY: <%= app_config.short_name %>/rails/production/credentials_master_key:production
+    RAILS_SECRET_KEY: <%= app_config.short_name %>/rails/production/secret_key_base:production
+
 phases:
   install:
     commands:

data/templates/docker-compose.ci.yml.erb

@@ -0,0 +1,23 @@
+version: '3.4'
+
+services:
+  app:
+    image: %IMAGE
+    environment:
+      DATABASE_URL: postgres://postgres@db
+      REDIS_URL: redis://redis
+      RAILS_ENV: development
+      CI: 'codebuild'
+      CIRCLECI: 1
+    volumes:
+      - ./coverage:/app/coverage
+    command: puma -C config/puma.rb
+    depends_on:
+      - db
+      - redis
+  db:
+    image: postgres:9.6-alpine
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
+  redis:
+    image: redis:5.0.5-alpine

data/templates/ft.yml.erb

@@ -0,0 +1,5 @@
+version: 1.0
+
+application:
+  name: <%= name %>
+  short_name: <%= short_name %>

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: founders_template
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Trae Robrock
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: aws-sdk-core
+  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: aws-sdk-ec2
+  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: aws-sdk-secretsmanager
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -64,11 +120,17 @@ files:
 - founders_template.gemspec
 - lib/founders_template.rb
 - lib/founders_template/cli.rb
+- lib/founders_template/config_file.rb
+- lib/founders_template/template_file.rb
+- lib/founders_template/utils.rb
 - lib/founders_template/version.rb
+- playground/config/credentials/.gitkeep
 - templates/buildspec.yml.erb
 - templates/ci/install.sh
 - templates/ci/post_build.sh
 - templates/ci/run_tests.sh
+- templates/docker-compose.ci.yml.erb
+- templates/ft.yml.erb
 homepage: https://github.com/trobrock/founders_template
 licenses:
 - MIT