domed-city 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc30be20e47da94a3dba7850dcbeace2d40dcd7f
-  data.tar.gz: 8e9255071a4b955afefdfc7af8dd833b7bb88778
+  metadata.gz: a7efabd99d90f998c7b6d2ad165fbd90322eea5f
+  data.tar.gz: 09504559d427ebb0a2a79e0477778a0dfdff1878
 SHA512:
-  metadata.gz: f692ed025597cbda665c7f42dc4442abc71be05d7288fdc3c30b43a5eeb20dfe08e466f0351ae473fa001584a347d45d44249059edca15cfc6189111ab5ff0ab
-  data.tar.gz: 0ca6e96eb0c50e23663c45d971ab341d2712748ba7cf982e47974a8c239fb6c5b94b9f133ca6dda4d2684c02498a0e25f1269a73bbc609b741b593577a5f7f21
+  metadata.gz: f9634171a656f5fc75030a519b9b8c5ddedd2453cb002b596ea8c527e533ce0e23cc09753bd2159df7c304ac536f8632bb84500d1a4cdd688ec4c9570f861452
+  data.tar.gz: 8e45508db4ea0260baab44e97eec4958e4d96bc855b93057948d22cce8952337883f2d166dfbf39e131c6b2f4f2caab93e0b757e54346be04f4ea721191edb8a

data/README.md

@@ -1,14 +1,50 @@
-# dome
-Simple Terraform API wrapper in Ruby.
+# domed-city
+Simple CLI application that wraps the Terraform API.
 
 ## Purpose
 
-To consolidate, improve and enforce standards around ITV's use of Terraform (via Rake) across product teams.
+To consolidate, improve and enforce standards around ITV's use of Terraform across product teams.
+
+This gem provides two main functions:
+
+1. Wrap the main Terraform functions (e.g. `plan`, `apply`).
+2. Ensure alignment to ITV's Common Platform VPC and environment policy.
+
+## Disclaimer
+
+This gem is very specific to how ITV utilise Terraform so it is unlikely to be useful to others except
+to serve as an example of how we do things.
 
 ## Naming
 
 From [Wikipedia](https://en.wikipedia.org/wiki/Domed_city):
 
+> ...the dome is airtight and pressurized, creating a habitat that can be controlled for air temperature, composition and quality, typically due to an external atmosphere (or lack thereof) that is inimical to habitation for one or more reasons.
+
+## Installation
+
+Add to your Gemfile:
+
 ```
-...the dome is airtight and pressurized, creating a habitat that can be controlled for air temperature, composition and quality, typically due to an external atmosphere (or lack thereof) that is inimical to habitation for one or more reasons.
+gem 'domed-city'
+```
+
+## Usage
+
+For ease of use, type `dome` in the CLI:
+
+```
+$ dome
+
+Dome wraps the Terraform API and performs useful stuff.
+
+Usage:
+       dome [command]
+where [commands] are:
+  -p, --plan            Creates a Terraform plan
+  -a, --apply           Applies a Terraform plan
+  -l, --plan-destroy    Creates a destructive Terraform plan
+  -s, --state           Synchronises the Terraform state
+  -v, --version         Print version and exit
+  -h, --help            Show this message
 ```

data/lib/dome/environment.rb

@@ -1,11 +1,15 @@
 module Dome
   class Environment
-    attr_reader :environment, :account, :team
+    attr_reader :environment, :account
 
     def initialize
-      @environment = Dir.pwd.split('/')[-1]
-      @account     = Dir.pwd.split('/')[-2]
-      @team        = @account.match(/(\w+)-\w+\z/)[1]
+      directories  = Dir.pwd.split('/')
+      @environment = directories[-1]
+      @account     = directories[-2]
+    end
+
+    def team
+      @account.match(/(\w+)-\w+\z/)[1]
     end
 
     def accounts
@@ -50,7 +54,8 @@ module Dome
 
     def invalid_account_message
       puts "\n'#{@account}' is not a valid account.\n".colorize(:red)
-      puts "The 'account' and 'environment' values are calculated based on your current directory.\n".colorize(:red)
+      puts "The 'account' and 'environment' variables are assigned based on your current directory.\n".colorize(:red)
+      puts "The expected directory structure is '.../<account>/<environment>'\n".colorize(:red)
       puts "Valid accounts are: #{accounts}."
       puts "\nEither:"
       puts '1. Set your .aws/config to one of the valid accounts above.'
@@ -60,7 +65,8 @@ module Dome
 
     def invalid_environment_message
       puts "\n'#{@environment}' is not a valid environment for the account: '#{@account}'.\n".colorize(:red)
-      puts "The 'account' and 'environment' values are calculated based on your current directory.\n".colorize(:red)
+      puts "The 'account' and 'environment' variables are assigned based on your current directory.\n".colorize(:red)
+      puts "The expected directory structure is '.../<account>/<environment>'\n".colorize(:red)
 
       env = if account[-4..-1] == '-dev'
               non_production_environments

data/lib/dome/state.rb

@@ -3,9 +3,15 @@ module Dome
     include Dome::Shell
 
     def initialize(environment)
-      @environment  = environment
-      @state_bucket = "#{@environment.team}-tfstate-#{@environment.environment}"
-      @state_file   = "#{@environment.environment}-terraform.tfstate"
+      @environment = environment
+    end
+
+    def state_bucket
+      "#{@environment.team}-tfstate-#{@environment.environment}"
+    end
+
+    def state_file
+      "#{@environment.environment}-terraform.tfstate"
     end
 
     def s3_client
@@ -51,17 +57,17 @@ module Dome
     end
 
     def s3_state
-      if s3_bucket_exists?(@state_bucket)
+      if s3_bucket_exists?(state_bucket)
         synchronise_s3_state
       else
-        create_remote_state_bucket(@state_bucket, @state_file)
+        create_remote_state_bucket(state_bucket, state_file)
       end
     end
 
     def synchronise_s3_state
       puts 'Synchronising the remote S3 state...'
       command         = 'terraform remote config -backend=S3'\
-            " -backend-config='bucket=#{@state_bucket}' -backend-config='key=#{@state_file}'"
+            " -backend-config='bucket=#{state_bucket}' -backend-config='key=#{state_file}'"
       failure_message = 'Something went wrong when synchronising the S3 state.'
       execute_command(command, failure_message)
     end

data/lib/dome/version.rb

@@ -1,3 +1,3 @@
 module Dome
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domed-city
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ben Snape
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler