convox_installer 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8e113c9a4319ce892f33540ea945422a11041a14a18c4539de5ee13e74f2da
-  data.tar.gz: 199a6eca04906a4bf456d2bd24ab04701a95a28691c66bde7f31b1bfa3b563aa
+  metadata.gz: c61afa4dfbb14346d5dc9c07eb23eca17eb1e612c8fe659c74d78fc154810479
+  data.tar.gz: b85f7bf5513cad08955f4a7ebc8c66f35ef0995d1d481bb2779af069a2980d0b
 SHA512:
-  metadata.gz: 17f21de2b431bd5c6e2f5b38540dd1ff83cab2fc897520a8b54cad5e8ab2c5172a1da792b2aff5fbda43f6a847875950b6686ef4c9d42e6b6eeeccfb46486e68
-  data.tar.gz: e410c8359a5799097a7a79b5c0985141f874c36542cff8ab9c10be21c3dcd1aaefaceb168607e05d9342577f2f2f07bf7f8885d463227d934f9a59531b080820
+  metadata.gz: f4878d00fbe6b6111a8c316f6eb6c691f11ee5b5846628b46e1dde39eea2f2b6c510951f924e1ca51002808cdaba9662af70cd2be618627d25af94e1cb8a1a67
+  data.tar.gz: 9340387ce40c3ee1d41823ccc5c959638172944161c3f6ea3c74f8048d5d53706770bffcdf08f3fc464dac5543abd8f4c3f79584555da2be2f4d684fe5f083a3

data/.bundle/config

@@ -1,2 +1,2 @@
 ---
-BUNDLE_JOBS: "8"
+BUNDLE_JOBS: "16"

data/README.md

@@ -8,13 +8,13 @@ Please note that the code quality is not very good, and the test coverage needs
 
 ## Features
 
-* Idempotent. If this script crashes, you can restart it and it will pick up
+- Idempotent. If this script crashes, you can restart it and it will pick up
   where it left off. Every step looks up the existing state, and only makes a change
   if things are not yet set up (or out of sync).
-* Ensures that the `convox` and `aws` CLI tools are installed
-* Wraps the `convox` CLI and parses JSON output from API calls
-* Add n Docker Repository (e.g. ECR registry)
-* Set up an S3 bucket with an optional CORS policy
+- Ensures that the `convox` and `aws` CLI tools are installed
+- Wraps the `convox` CLI and parses JSON output from API calls
+- Add n Docker Repository (e.g. ECR registry)
+- Set up an S3 bucket with an optional CORS policy
 
 ## Introduction
 
@@ -47,11 +47,10 @@ You should create a new git repo for your own installation script, and then use
 
 You can see a complete example in [`examples/full_installation.rb`](./examples/full_installation.rb).
 
-
 ## Config
 
 Config is loaded from ENV vars, or from saved JSON data at
-`~/.convox/installer_config`. The script will save all of the user's responses into `~/.convox/installer_config`.
+`./.installer_config`. The script will save all of the user's responses into `./.installer_config` (in the current directory).
 
 ## Customize the Config Prompts
 
@@ -97,7 +96,7 @@ Shows a heading and optional details.
 
 #### Config Prompt
 
-* A config prompt with a default value:
+- A config prompt with a default value:
 
 ```ruby
 {
@@ -108,7 +107,7 @@ Shows a heading and optional details.
 }
 ```
 
-* Set a value from a `Proc`, and don't prompt the user:
+- Set a value from a `Proc`, and don't prompt the user:
 
 ```ruby
   {
@@ -118,7 +117,7 @@ Shows a heading and optional details.
   }
 ```
 
-* Set a value, and hide this setting from the user (even in the summary):
+- Set a value, and hide this setting from the user (even in the summary):
 
 ```ruby
   {
@@ -128,7 +127,6 @@ Shows a heading and optional details.
   },
 ```
 
-
 ## `ConvoxInstaller` DSL
 
 #### `ensure_requirements!`
@@ -137,7 +135,7 @@ Makes sure that the `convox` and `aws` CLI tools are installed on this system. I
 
 #### `prompt_for_config`
 
-Loads config from ENV vars, or from saved config at `~/.convox/installer_config`.
+Loads config from ENV vars, or from saved config at `./.installer_config`.
 If any config settings are missing, it prompts the user for input. Finally, it shows a summary of the config, and asks the user if they want to proceed with the installation. If the user enters `y` (or `yes`), the `prompt_for_config` method completes. If they enter `n` (or `no`), we loop over every setting and let them press "enter" to keep the current value, or provide a new value to correct any mistakes.
 
 #### `backup_convox_host_and_rack`
@@ -146,7 +144,7 @@ If there are any existing files at `~/.convox/host` or `~/.convox/rack`, this me
 
 #### `install_convox`
 
-* **Required Config:** `aws_region`, `aws_access_key_id`, `aws_secret_access_key`,
+- **Required Config:** `aws_region`, `aws_access_key_id`, `aws_secret_access_key`,
   `stack_name`, `instance_type`
 
 Runs `convox rack install ...`. Has some validations to ensure that all required settings are present.
@@ -165,19 +163,17 @@ Returns a Ruby hash with all convox rack data.
 
 #### `create_convox_app!`
 
-* **Required Config:** `convox_app_name`
+- **Required Config:** `convox_app_name`
 
 Checks if the app already exists. If not, calls `convox apps create ... --wait` to create a new app. Then waits for the app to be ready. (Avoids an occasional race condition.)
 
-
 #### `set_default_app_for_directory!`
 
 Writes the app name into `./.convox/app` (in the current directory.) The `convox` CLI reads this file, so you don't need to specify the `--app` flag for future commands.
 
-
 #### `create_s3_bucket!`
 
-* **Required Config:** `s3_bucket_name`
+- **Required Config:** `s3_bucket_name`
 
 Creates an S3 bucket from the `:s3_bucket_name` config setting. This is not a default setting, so you can add something like this to your custom `@prompts`:
 
@@ -195,11 +191,11 @@ The `:value` `Proc` will generate a bucket name with a random suffix. (Avoids co
 
 #### `set_s3_bucket_cors_policy`
 
-* **Required Config:** `s3_bucket_name`
+- **Required Config:** `s3_bucket_name`
 
 Set up a CORS policy for your S3 bucket. (`:s3_bucket_name`)
 
-*Note: If the `:s3_bucket_cors_policy` setting is not provided, then this method does nothing.*
+_Note: If the `:s3_bucket_cors_policy` setting is not provided, then this method does nothing._
 
 You should set `:s3_bucket_cors_policy` to a JSON string. Here's how I set this up in my own `install.rb` script:
 
@@ -226,10 +222,9 @@ JSON
 ]
 ```
 
-
 #### `s3_bucket_details`
 
-* **Required Config:** `s3_bucket_name`
+- **Required Config:** `s3_bucket_name`
 
 Get the S3 bucket details for `s3_bucket_name`. Parses the URL and returns a hash:
 
@@ -243,16 +238,15 @@ Get the S3 bucket details for `s3_bucket_name`. Parses the URL and returns a has
 
 I use these S3 bucket details to set env variables for my app. (`convox env set ...`)
 
-
 #### `add_docker_registry!`
 
-* **Required Config:** `docker_registry_url`, `docker_registry_username`, `docker_registry_password`
+- **Required Config:** `docker_registry_url`, `docker_registry_username`, `docker_registry_password`
 
 Checks the list of registries to see if `docker_registry_url` has already been added. If not, runs `convox registries add ...` to add a new Docker registry (e.g. Docker Hub, ECR).
 
 #### `default_service_domain_name`
 
-* **Required Config:** `convox_app_name`, `default_service`
+- **Required Config:** `convox_app_name`, `default_service`
 
 Parses the rack router ELB name and region, and returns the default `convox.site` domain for your default service. (You can visit this URL in the browser to access your app.)
 
@@ -284,7 +278,6 @@ If you want to run `convox env set MYVAR=value`, then you would call:
 run_convox_command! 'env set MYVAR=value'
 ```
 
-
 ## License
 
 [MIT](./LICENSE)

data/lib/convox_installer/config.rb

@@ -7,10 +7,10 @@ require "securerandom"
 
 module ConvoxInstaller
   class Config
+    CONFIG_FILE = File.expand_path("./.installer_config").freeze
+    
     attr_accessor :logger, :config, :prompts, :highline
 
-    CONFIG_FILE = File.expand_path("~/.convox/installer_config").freeze
-
     DEFAULT_PROMPTS = [
       {
         key: :stack_name,

data/lib/convox_installer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvoxInstaller
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/lib/convox_installer/config_spec.rb

@@ -4,12 +4,16 @@ require "convox_installer"
 require "securerandom"
 
 RSpec.describe ConvoxInstaller::Config do
+  before(:each) do
+    stub_const('ConvoxInstaller::Config::CONFIG_FILE', '/path/to/.installer_config')
+  end
+
   after(:each) do
     ENV.delete "AWS_REGION"
     ENV.delete "AWS_ACCESS_KEY_ID"
   end
 
-  it "loads the saved config from ~/.convox/installer_config" do
+  it "loads the saved config from ./.installer_config" do
     expect(described_class).to receive(:config_file_exists?).and_return(true)
     expect(described_class).to receive(:read_config_file).and_return(
       '{ "config": { "aws_region": "us-west-2", "aws_access_key_id": "1234" } }'
@@ -88,7 +92,7 @@ Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key:
     AWS Access Key ID:       asdf
     AWS Secret Access Key:   xkcd
 
-We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+We've saved your configuration to: /path/to/.installer_config
 If anything goes wrong during the installation, you can restart the script to reload the config and continue.
 
 Please double check all of these configuration details.
@@ -110,7 +114,7 @@ Please enter your AWS Access Key ID: |asdf| Please enter your AWS Secret Access
     AWS Access Key ID:       sdfg
     AWS Secret Access Key:   xkcd
 
-We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+We've saved your configuration to: /path/to/.installer_config
 If anything goes wrong during the installation, you can restart the script to reload the config and continue.
 
 Please double check all of these configuration details.
@@ -218,7 +222,7 @@ Please enter your Docker Registry Access Key ID: Please enter your Docker Regist
     Admin Email:                         admin@test.com
     Admin Password:                      99a6f67de0c7a117
 
-We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+We've saved your configuration to: /path/to/.installer_config
 If anything goes wrong during the installation, you can restart the script to reload the config and continue.
 
 Please double check all of these configuration details.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convox_installer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Form Applications Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline