aws-ec2 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42b56c4659b31e265e4cf80becf741303ea43fb9a1885724f12e6a0e76fbfb1e
-  data.tar.gz: e23f45d1462ee2897a20ad52fe2d57ed207090c8d38eee1d3869b0261f100fc7
+  metadata.gz: 0cf9927e8f80013a840c32371fdd48096c1f349002f3f9ee6141a369a326c002
+  data.tar.gz: c8985115802338c38fab0d24f7d95f1dad7021eef7d15c874b53c1b3ef2e23e3
 SHA512:
-  metadata.gz: a7b83b59c84b4da126a0d1e6ea7df4ba88c340da499edd2ef35b4d94c69c05d318e5542d0d60ba9698a5633666cfd0c81315c2a56370bb0e0dc5684b2e86ed89
-  data.tar.gz: c8e7a78cbff83c6f40366b5c90d235fc84f3605fa1a2052185a37b9bacc65373ad8b19c2af1ec8430973d7a0db78342b1809ae752a6199e208ba296507647341
+  metadata.gz: dc87b7836701be0468190525dcf22e3373f5ba0bf9dc2d7050af88ec443de2c0bd83853bfe36683030d8e653f8edf9ac854d68ede7cab351a959f82cb3db3ffb
+  data.tar.gz: 77de0393c45ccffaa18527d585465ea9864d76739b4fd73550884496fff5d0b55be51ab2a4677c64e0b75e68dd2e54315aacd21c3c07afa461fda1a4ce168fd1

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.7.0]
+- Rid of name to profile convention, check profile exists and report to user
+  if it does not exist. This is a more expected interface.
+
 ## [0.6.0]
 - add scripts_s3_bucket config option
 - halt script if hooks fail

data/README.md

@@ -3,7 +3,7 @@
 Simple tool to create AWS ec2 instances consistently with pre-configured settings.  The pre-configured settings are stored in the profiles folder of the current directory.
 Example:
 
-* profiles/default.yml: default settings.
+* profiles/default.yml: default settings. used when no profile is specified.
 * profiles/myserver.yml: myserver settings.
 
 ## Usage
@@ -30,14 +30,6 @@ The template helpers defined in:
 
 You can also define your own custom helpers in the `app/helpers` folder as ruby modules with the naming convention `'*_helper.rb`.  Example, the module FooHelper  should be defined in `app/helpers/foo_helper.rb`.  The custom helpers are first class citizens and have access to the same variables and methods as built in helpers.
 
-### Convention
-
-By convention, the profile name matches the first parameter after the create command.  So the command above could be shortened to:
-
-```
-aws-ec2 create myserver
-```
-
 ## Noop mode
 
 You can do a test run with the `--noop` flag.  This will print out what settings will be used to launch the instance.  This is a good way to inspect the generated user-data script.
@@ -96,6 +88,8 @@ scripts_s3_bucket: mybucket # enables s3 uploading of generated app/scripts
 
 The variables are accessible via the `config` helper method. Example (only showing the part of the profile), `profiles/default.yml`:
 
+The `scripts_s3_bucket` is an option that changes the behavior of aws-ec2 to automatically sync the generated scripts from app/scripts to the s3 bucket right before the internal call to run_instances to launch the instance.  If you need more custom logic, look at the hooks section.
+
 ```yaml
 image_id: ami-4fffc834 # Amazon Lambda AMI
 instance_type: t2.medium

data/lib/aws-ec2.rb

@@ -7,6 +7,7 @@ module AwsEc2
   autoload :Command, "aws_ec2/command"
   autoload :CLI, "aws_ec2/cli"
   autoload :AwsServices, "aws_ec2/aws_services"
+  autoload :Profile, "aws_ec2/profile"
   autoload :Base, "aws_ec2/base"
   autoload :Create, "aws_ec2/create"
   autoload :Ami, "aws_ec2/ami"

data/lib/aws_ec2/base.rb

@@ -3,6 +3,7 @@ module AwsEc2
     def initialize(options={})
       @options = options.clone
       AwsEc2.validate_in_project!
+      Profile.new(@options).check!
     end
   end
 end

data/lib/aws_ec2/create.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/hash'
 module AwsEc2
   class Create < Base
     autoload :Params, "aws_ec2/create/params"
+
     include AwsServices
 
     def run

data/lib/aws_ec2/create/params.rb

@@ -1,7 +1,5 @@
 class AwsEc2::Create
   class Params
-    include AwsEc2::TemplateHelper
-
     def initialize(options)
       @options = options
     end
@@ -10,7 +8,7 @@ class AwsEc2::Create
     # up until that point we're dealing with String keys.
     def generate
       cleanup
-      params = load_profiles(profile_name)
+      params = AwsEc2::Profile.new(@options).load
       decorate_params(params)
       normalize_launch_template(params).deep_symbolize_keys
     end
@@ -108,47 +106,5 @@ class AwsEc2::Create
         min_count: 1,
       }
     end
-
-    def load_profiles(profile_name)
-      return @profile_params if @profile_params
-
-      profile_file = "#{AwsEc2.root}/profiles/#{profile_name}.yml"
-      base_path = File.dirname(profile_file)
-      default_file = "#{base_path}/default.yml"
-
-      params_exit_check!(profile_file, default_file)
-
-      params = File.exist?(profile_file) ?
-                  load_profile(profile_file) :
-                  load_profile(default_file)
-      @profile_params = params
-    end
-
-    def params_exit_check!(profile_file, default_file)
-      return if File.exist?(profile_file) or File.exist?(default_file)
-
-      puts "Unable to find a #{profile_file} or #{default_file} profile file."
-      puts "Please double check."
-      exit # EXIT HERE
-    end
-
-    def load_profile(file)
-      return {} unless File.exist?(file)
-
-      puts "Using profile: #{file}"
-      data = YAML.load(erb_result(file))
-      data ? data : {} # in case the file is empty
-      data.has_key?("run_instances") ? data["run_instances"] : data
-    end
-
-    def profile_name
-      # allow user to specify the path also
-      if @options[:profile] && File.exist?(@options[:profile])
-        profile = File.basename(@options[:profile], '.yml')
-      end
-
-      # conventional profile is the name of the ec2 instance
-      profile || @options[:profile] || @options[:name]
-    end
   end
 end

data/lib/aws_ec2/profile.rb

@@ -0,0 +1,48 @@
+module AwsEc2
+  class Profile
+    include TemplateHelper
+
+    def initialize(options)
+      @options = options
+    end
+
+    def load
+      return @profile_params if @profile_params
+
+      check!
+
+      @profile_params = load_profile(profile_file)
+    end
+
+    def check!
+      return if File.exist?(profile_file)
+
+      puts "Unable to find a #{profile_file.colorize(:green)} profile file."
+      puts "Please double check that it exists or that you specified the right profile."
+      exit # EXIT HERE
+    end
+
+    def load_profile(file)
+      return {} unless File.exist?(file)
+
+      puts "Using profile: #{file}"
+      data = YAML.load(erb_result(file))
+      data ? data : {} # in case the file is empty
+      data.has_key?("run_instances") ? data["run_instances"] : data
+    end
+
+    def profile_file
+      "#{AwsEc2.root}/profiles/#{profile_name}.yml"
+    end
+
+    def profile_name
+      # allow user to specify the path also
+      if @options[:profile] && File.exist?(@options[:profile])
+        profile = File.basename(@options[:profile], '.yml')
+      end
+
+      # conventional profile is the name of the ec2 instance
+      profile || @options[:profile] || "default"
+    end
+  end
+end

data/lib/aws_ec2/version.rb

@@ -1,3 +1,3 @@
 module AwsEc2
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -215,6 +215,7 @@ files:
 - lib/aws_ec2/help/compile.md
 - lib/aws_ec2/help/create.md
 - lib/aws_ec2/hook.rb
+- lib/aws_ec2/profile.rb
 - lib/aws_ec2/s3.rb
 - lib/aws_ec2/script.rb
 - lib/aws_ec2/scripts/ami_creation.sh