convox_installer 1.0.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e3e80d423ba3cf14865e0b541207471286dcfa32956bfbc22c3fd4ff0818413
-  data.tar.gz: 031f35af824c717ee140a281d22e4793c06b83a05182709a1803c60a23692ad6
+  metadata.gz: b9b7140386f111c59db16b8db7429b2fb3a5c1a48372a2559e2e2c5499d59dd2
+  data.tar.gz: 6e94e2c459c01426f8b6d2adc7d232f630e9711722947d2899b20ea509089c47
 SHA512:
-  metadata.gz: a96d285b7778b693394fd5bb7c5f7157aa74513e6302337bbfab2b9714d4b1b425f1b2033cb0fdf488625cfb9c835c09ea7a05f7426a47ab2c681ded07c3cc55
-  data.tar.gz: 368b58ededb07344ecd232838ba6229bbf93d4d3da345f5292eb4dfd213514b0b13138ea334857c54b53887eebf83b251938f5ff942bda410e7cb49ee0e46033
+  metadata.gz: 64741ea4bd8a4e03d30172d366976e7d18c99cd2dff1f27ceaf5106d86de56c46fc0302fed774669f5a513d3b5cd8212b3b94e54687a539b235e545b3a9c90cb
+  data.tar.gz: 67966065258259f0b64c7572895ee884f4e34c55e4f9c1ddbff90cf431e8da78984706955b406655d8f0128f4edd21842559129aa5b7dde73a745a121ad44ce1

data/.rubocop.yml

@@ -1,5 +1,12 @@
 require: rubocop-rspec
-TargetRubyVersion: "2.3"
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Style/MixinUsage:
+  Exclude:
+    - examples/**/*
 
 Metrics/LineLength:
   Max: 100
@@ -39,3 +46,18 @@ Metrics/BlockLength:
 
 Metrics/BlockNesting:
   Max: 7
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false

data/.vscode/settings.json

@@ -1,4 +1,4 @@
 {
-  "editor.formatOnSave": true,
+  "editor.formatOnSave": false,
   "editor.formatOnSaveTimeout": 5000
-}
+}

data/Gemfile

@@ -5,8 +5,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'pry'
-  gem 'pry-byebug'
+  gem 'pry', require: false
+  gem 'pry-byebug', require: false
   gem 'rspec'
   gem 'rubocop'
   gem 'rubocop-rspec'

data/README.md

@@ -2,9 +2,12 @@
 
 A Ruby gem that makes it easier to build a Convox installation script. This is like Chef/Ansible/Terraform for your initial Convox setup.
 
-## NOTE: This software is an alpha version
+# Requirements: Convox v2
 
-Please note that the code quality is not very good, and the test coverage needs to be improved. However, I've successfully set up a number of test and production deployments using this gem, and everything seems to work very well. The library also facilitates idempotency and crash-resistance, so you can easily re-run your installation script if something goes wrong.
+This version of `convox_installer` is only designed to work with Convox v2. Please install the v2 CLI by following the instructions at their old documentation site: https://docsv2.convox.com/introduction/installation
+## USE AT YOUR OWN RISK! THIS CODE IS PROVIDED WITHOUT ANY WARRANTIES OR GUARANTEES
+
+We have successfully set up a number of test and production deployments using this gem. Everything seems to work very well. The library also facilitates idempotency and crash-resistance, so you can easily re-run your installation script if something goes wrong. However, if anything goes wrong, then you can end up with a large AWS bill if you're not careful. If anything crashes then make sure you double-check everything in your AWS account and shut down any leftover resources. **USE THIS SOFTWARE AT YOUR OWN RISK.**
 
 ## Features
 
@@ -149,7 +152,7 @@ If there are any existing files at `~/.convox/host` or `~/.convox/rack`, this me
 
 Runs `convox rack install ...`. Has some validations to ensure that all required settings are present.
 
-#### `validate_convox_auth_and_set_host!`
+#### `validate_convox_auth_and_write_host!`
 
 After running `install_convox`, call this method to ensure that the the `~/.convox/auth` file has been updated with the correct details (checks the rack name and AWS region.) Then it sets the rack host in `~/.convox/host` (if not already set.)
 

data/convox_installer.gemspec

@@ -1,28 +1,29 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path("lib", __dir__)
-require "convox_installer/version"
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'convox_installer/version'
 
 Gem::Specification.new do |s|
-  s.name = "convox_installer"
+  s.name = 'convox_installer'
   s.version = ConvoxInstaller::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Form Applications Inc."]
-  s.email = ["support@formapi.io"]
-  s.homepage = "https://github.com/FormAPI/convox_installer"
-  s.summary = "Build a Convox installation workflow"
-  s.description = "Build a Convox installation workflow"
-  s.license = "MIT"
-  s.required_ruby_version = ">= 2.3"
+  s.authors = ['Form Applications Inc.']
+  s.email = ['support@formapi.io']
+  s.homepage = 'https://github.com/FormAPI/convox_installer'
+  s.summary = 'Build a Convox installation workflow'
+  s.description = 'Build a Convox installation workflow'
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_runtime_dependency "highline", ">= 1.7.10"
-  s.add_runtime_dependency "json", ">= 2.2.0"
-  s.add_runtime_dependency "os", ">= 1.0.1"
-  s.add_runtime_dependency "httparty", ">= 0.17.0"
-  s.add_runtime_dependency "activesupport", ">= 5.2.3"
+  s.add_runtime_dependency 'activesupport', '>= 5.2.3'
+  s.add_runtime_dependency 'highline', '>= 1.7.10'
+  s.add_runtime_dependency 'httparty', '>= 0.17.0'
+  s.add_runtime_dependency 'json', '>= 2.2.0'
+  s.add_runtime_dependency 'os', '>= 1.0.1'
 
-  s.files = `git ls-files`.split("\n").uniq.sort.reject(&:empty?) - ["Gemfile.lock"]
+  s.files = `git ls-files`.split("\n").uniq.sort.reject(&:empty?) - ['Gemfile.lock']
   s.test_files = `git ls-files spec test`.split("\n")
   s.executables = []
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/examples/full_installation.rb

@@ -9,82 +9,82 @@
 #   gem "convox_installer"
 # end
 
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-require "pry-byebug"
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+require 'pry-byebug'
 
-require "convox_installer"
+require 'convox_installer'
 include ConvoxInstaller
 
 @log_level = Logger::DEBUG
 
-MINIMAL_HEALTH_CHECK_PATH = "/health/site"
-COMPLETE_HEALTH_CHECK_PATH = "/health"
-
-S3_BUCKET_CORS_POLICY = <<-JSON
-{
-  "CORSRules": [
-    {
-      "AllowedOrigins": ["*"],
-      "AllowedHeaders": ["Authorization", "cache-control", "x-requested-with"],
-      "AllowedMethods": ["PUT", "POST", "GET"],
-      "MaxAgeSeconds": 3000
-    }
-  ]
-}
+MINIMAL_HEALTH_CHECK_PATH = '/health/site'
+COMPLETE_HEALTH_CHECK_PATH = '/health'
+
+S3_BUCKET_CORS_POLICY = <<~JSON
+  {
+    "CORSRules": [
+      {
+        "AllowedOrigins": ["*"],
+        "AllowedHeaders": ["Authorization", "cache-control", "x-requested-with"],
+        "AllowedMethods": ["PUT", "POST", "GET"],
+        "MaxAgeSeconds": 3000
+      }
+    ]
+  }
 JSON
 
 @prompts = ConvoxInstaller::Config::DEFAULT_PROMPTS + [
   {
-    section: "Docker Registry Authentication",
+    section: 'Docker Registry Authentication',
     info: "You should have received authentication details for the Docker Registry\n" \
-    "via email. If not, please contact support@example.com",
+          'via email. If not, please contact support@example.com'
   },
   {
     key: :docker_registry_url,
-    title: "Docker Registry URL",
-    value: "691950705664.dkr.ecr.us-east-1.amazonaws.com",
+    title: 'Docker Registry URL',
+    value: '691950705664.dkr.ecr.us-east-1.amazonaws.com'
   },
   {
     key: :docker_registry_username,
-    title: "Docker Registry Username",
+    title: 'Docker Registry Username'
   },
   {
     key: :docker_registry_password,
-    title: "Docker Registry Password",
+    title: 'Docker Registry Password'
   },
   {
     key: :convox_app_name,
-    title: "Convox App Name",
-    value: "convox-app",
+    title: 'Convox App Name',
+    value: 'convox-app'
   },
   {
     key: :default_service,
-    title: "Default Convox Service (for domain)",
-    value: "web",
-    hidden: true,
+    title: 'Default Convox Service (for domain)',
+    value: 'web',
+    hidden: true
   },
   {
     key: :admin_email,
-    title: "Admin User Email",
-    prompt: "Please enter the email address you would like to use " \
-    "for the default admin user",
-    default: "admin@example.com",
+    title: 'Admin User Email',
+    prompt: 'Please enter the email address you would like to use ' \
+            'for the default admin user',
+    default: 'admin@example.com'
   },
   {
     key: :admin_password,
-    title: "Admin User Password",
-    value: -> () { SecureRandom.hex(8) },
+    title: 'Admin User Password',
+    value: -> { SecureRandom.hex(8) }
   },
   {
     key: :s3_bucket_name,
-    title: "S3 Bucket for Uploads",
-    value: -> () { "app-uploads-#{SecureRandom.hex(4)}" },
+    title: 'S3 Bucket for Uploads',
+    value: -> { "app-uploads-#{SecureRandom.hex(4)}" }
   },
   {
     key: :s3_bucket_cors_policy,
     value: S3_BUCKET_CORS_POLICY,
-    hidden: true,
-  },
+    hidden: true
+  }
 ]
 
 ensure_requirements!
@@ -93,7 +93,7 @@ config = prompt_for_config
 backup_convox_host_and_rack
 install_convox
 
-validate_convox_auth_and_set_host!
+validate_convox_auth_and_write_host!
 validate_convox_rack!
 
 create_convox_app!
@@ -101,70 +101,70 @@ set_default_app_for_directory!
 add_docker_registry!
 create_s3_bucket!
 
-puts "=> Generating secret keys for authentication sessions and encryption..."
+puts '=> Generating secret keys for authentication sessions and encryption...'
 secret_key_base = SecureRandom.hex(64)
 data_encryption_key = SecureRandom.hex(32)
 
 puts "======> Default domain: #{default_service_domain_name}"
-puts "        You can use this as a CNAME record after configuring a domain in convox.yml"
-puts "        (Note: SSL will be configured automatically.)"
+puts '        You can use this as a CNAME record after configuring a domain in convox.yml'
+puts '        (Note: SSL will be configured automatically.)'
 
-puts "=> Setting environment variables to configure the application..."
+puts '=> Setting environment variables to configure the application...'
 
 env = {
-  "HEALTH_CHECK_PATH" => MINIMAL_HEALTH_CHECK_PATH,
-  "DOMAIN_NAME" => default_service_domain_name,
-  "AWS_ACCESS_KEY_ID" => s3_bucket_details.fetch(:access_key_id),
-  "AWS_ACCESS_KEY_SECRET" => s3_bucket_details.fetch(:secret_access_key),
-  "AWS_UPLOADS_S3_BUCKET" => s3_bucket_details.fetch(:name),
-  "AWS_UPLOADS_S3_REGION" => config.fetch(:aws_region),
-  "SECRET_KEY_BASE" => secret_key_base,
-  "DATA_ENCRYPTION_KEY" => data_encryption_key,
-  "ADMIN_NAME" => "Admin",
-  "ADMIN_EMAIL" => config.fetch(:admin_email),
-  "ADMIN_PASSWORD" => config.fetch(:admin_password),
+  'HEALTH_CHECK_PATH' => MINIMAL_HEALTH_CHECK_PATH,
+  'DOMAIN_NAME' => default_service_domain_name,
+  'AWS_ACCESS_KEY_ID' => s3_bucket_details.fetch(:access_key_id),
+  'AWS_ACCESS_KEY_SECRET' => s3_bucket_details.fetch(:secret_access_key),
+  'AWS_UPLOADS_S3_BUCKET' => s3_bucket_details.fetch(:name),
+  'AWS_UPLOADS_S3_REGION' => config.fetch(:aws_region),
+  'SECRET_KEY_BASE' => secret_key_base,
+  'DATA_ENCRYPTION_KEY' => data_encryption_key,
+  'ADMIN_NAME' => 'Admin',
+  'ADMIN_EMAIL' => config.fetch(:admin_email),
+  'ADMIN_PASSWORD' => config.fetch(:admin_password)
 }
 
-env_command_params = env.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
+env_command_params = env.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
 run_convox_command! "env set #{env_command_params}"
 
-puts "=> Initial deploy..."
-puts "-----> Documentation: https://docs.convox.com/deployment/builds"
-run_convox_command! "deploy --wait"
+puts '=> Initial deploy...'
+puts '-----> Documentation: https://docs.convox.com/deployment/builds'
+run_convox_command! 'deploy --wait'
 
-puts "=> Setting up the database..."
-run_convox_command! "run web rake db:create db:migrate db:seed"
+puts '=> Setting up the database...'
+run_convox_command! 'run web rake db:create db:migrate db:seed'
 
-puts "=> Updating the health check path to include database tests..."
+puts '=> Updating the health check path to include database tests...'
 run_convox_command! "env set --promote --wait HEALTH_CHECK_PATH=#{COMPLETE_HEALTH_CHECK_PATH}"
 
 puts
-puts "All done!"
+puts 'All done!'
 puts
 puts "You can now visit #{default_service_domain_name} and sign in with:"
 puts
 puts "    Email:    #{config.fetch(:admin_email)}"
 puts "    Password: #{config.fetch(:admin_password)}"
 puts
-puts "You can configure a custom domain name, auto-scaling, and other options in convox.yml."
-puts "To deploy your changes, run: convox deploy --wait"
+puts 'You can configure a custom domain name, auto-scaling, and other options in convox.yml.'
+puts 'To deploy your changes, run: convox deploy --wait'
 puts
 puts "IMPORTANT: You should be very careful with the 'resources' section in convox.yml."
-puts "If you remove, rename, or change these resources, then Convox will delete"
-puts "your database. This will result in downtime and a loss of data."
-puts "To prevent this from happening, you can sign into your AWS account,"
-puts "visit the RDS and ElastiCache services, and enable \"Termination Protection\""
-puts "for your database resources."
+puts 'If you remove, rename, or change these resources, then Convox will delete'
+puts 'your database. This will result in downtime and a loss of data.'
+puts 'To prevent this from happening, you can sign into your AWS account,'
+puts 'visit the RDS and ElastiCache services, and enable "Termination Protection"'
+puts 'for your database resources.'
 puts
-puts "To learn more about the convox CLI, run: convox --help"
+puts 'To learn more about the convox CLI, run: convox --help'
 puts
-puts "  * View the Convox documentation:  https://docs.convox.com/"
+puts '  * View the Convox documentation:  https://docs.convox.com/'
 puts
 puts
-puts "To completely uninstall Convox from your AWS account,"
-puts "run the following steps (in this order):"
+puts 'To completely uninstall Convox from your AWS account,'
+puts 'run the following steps (in this order):'
 puts
-puts " 1) Disable \"Termination Protection\" for any resource where it was enabled."
+puts ' 1) Disable "Termination Protection" for any resource where it was enabled.'
 puts
 puts " 2) Delete all files from the #{config.fetch(:s3_bucket_name)} S3 bucket:"
 puts
@@ -176,7 +176,7 @@ puts " 3) Delete the #{config.fetch(:s3_bucket_name)} S3 bucket:"
 puts
 puts "    convox rack resources delete #{config.fetch(:s3_bucket_name)} --wait"
 puts
-puts " 4) Uninstall Convox (deletes all CloudFormation stacks and AWS resources):"
+puts ' 4) Uninstall Convox (deletes all CloudFormation stacks and AWS resources):'
 puts
 puts "    convox rack uninstall aws #{config.fetch(:stack_name)}"
 puts