bora 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de47b9b1631554ad77efc354c4447578222a53c6
-  data.tar.gz: b51627a1b45dbfbee39bca5177a27cfc6e0aa3a3
+  metadata.gz: 430ba291be8abc9a0c129e8bca4639fa29020dd0
+  data.tar.gz: c7c059203422cc63a92b775d58dddd8cf026439e
 SHA512:
-  metadata.gz: e7c30f5101af8e515e8dad0ec32dce09c4fbf57f4aedfbede036a6ccceb7ed1927ca0d10e797dee95f45b8852990b4bf554012c5b0eda36933cd2c5a2b7ef524
-  data.tar.gz: abea4067375197a723f3755fc11c86996117a650f2a40e269f1a75ade074377466580e8fb91dd6dd28680e6b7f4e906373e8f6646c2f515bf3f4b4d033e04e0a
+  metadata.gz: 7c5759c5c000c0d890c05f08bd81bf00a7b38ec398228ea2e5dc0b003113d7aa61ab5b3c87508a5d5b814e0f4b3d97b1300cf81e34f55dae534de6ca93755487
+  data.tar.gz: ba94c9c28df960b73753a45549bf8670defcb83f48b6adcfb62a1b6c507ffb3c238c4a17a1eadcc0b0e2ba9b4ace1d270f90111bbcad663b5f5d7f7e5c6b991d

data/README.md

@@ -29,11 +29,7 @@ Add this to your `Rakefile`
 ```ruby
 require 'bora'
 
-Bora::Tasks.new("example") do |t|
-  t.stack_options = {
-    template_body: File.read("example.json")
-  }
-end
+Bora::Tasks.new("example", "example.json")
 ```
 
 This will give you the following rake tasks
@@ -59,32 +55,43 @@ When you define the Bora tasks, you can pass in a number of options that control
 The available options are shown below with their default values.
 
 ```ruby
-Bora::Tasks.new("example") do |t|
-  t.colorize = true
+Bora::Tasks.new("example", "example.json") do |t|
   t.stack_options = {}
+  t.colorize = true
 end
 ```
-
+* `example.json` - this is a URL to your template. It can be anything openable by Ruby's [`open-uri`](http://ruby-doc.org/stdlib-2.3.0/libdoc/open-uri/rdoc/OpenURI.html) library (eg: a local file or http/https URL), or an `s3://` URL. This parameter is optional - if you don't supply it, you *must* specify either `template_body` or `template_url` in the `stack_options` (see below).
+* `stack_options` - A hash of options that are passed directly to the CloudFormation [`create_stack`](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#create_stack-instance_method) and [`update_stack`](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#update_stack-instance_method) APIs. If you specified a template URL in the constructor you don't need to supply `template_body` or `template_url here (you will get an error if you do).
 * `colorize` - A boolean that controls whether console output is colored or not
-* `stack_options` - A hash of options that are passed directly to the CloudFormation [create_stack](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#create_stack-instance_method) and [update_stack](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#update_stack-instance_method) APIs.
-  You must at a minimum specify either the `template_body` or `template_url` option.
 
 
 ### Dynamically Generated Templates
 If you are generating your templates dynamically using a DSL such as [cfndsl](https://github.com/stevenjack/cfndsl) you can easily hook this into the Bora tasks by defining a `generate` task within the Bora::Tasks constructor.
 
 ```ruby
-Bora::Tasks.new("example") do |t|
+Bora::Tasks.new("example", "example.json") do |t|
   desc "Generates the template"
   task :generate do
     # Generate your template and write it into "example.json" here
   end
+end
+```
+
+If you need to pass parameters from the rake command line through to your generate method,
+you can do so by using Rake's [`args.extras`](http://ruby-doc.org/stdlib-2.2.2/libdoc/rake/rdoc/Rake/TaskArguments.html#method-i-extras) functionality:
 
-  t.stack_options = {
-    template_body: File.read("example.json")
-  }
+```ruby
+Bora::Tasks.new("example", "example.json") do |t|
+  task :generate do |t, args|
+    arg1, arg2 = args.extras
+    # Generate your template and write it into "example.json" here
+  end
 end
 ```
+```shell
+$ rake stack:example:apply[arg1_value, arg2_value]
+```
+
 
 ### API
 

data/lib/bora/stack.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'open-uri'
 require 'aws-sdk'
 require 'diffy'
 require 'bora/stack_status'
@@ -55,12 +56,13 @@ module Bora
     end
 
     def new_template(options, pretty = true)
-      if options[:template_body]
-        template = options[:template_body]
+      options = resolve_options(options, true)
+      template = options[:template_body]
+      if template
         template = JSON.pretty_generate(JSON.parse(template)) if pretty
         template
       else
-        raise Exception("new_template not yet implemented for template_url stack option")
+        raise "new_template not yet implemented for URL #{options[:template_url]}"
       end
     end
 
@@ -69,7 +71,7 @@ module Bora
     end
 
     def validate(options)
-      @cfn.validate_template(options.select { |k| [:template_body, :template_url].include?(k) })
+      @cfn.validate_template(resolve_options(options).select { |k| [:template_body, :template_url].include?(k) })
     end
 
     def status
@@ -92,9 +94,9 @@ module Bora
       underlying_stack(refresh: true)
       return true if action == :delete && !exists?
       @previous_event_time = last_event_time
-      options[:stack_name] = @stack_name
       begin
-        @cfn.method("#{action.to_s.downcase}_stack").call(options)
+        action_options = {stack_name: @stack_name}.merge(resolve_options(options))
+        @cfn.method("#{action.to_s.downcase}_stack").call(action_options)
         wait_for_completion(&block)
       rescue Aws::CloudFormation::Errors::ValidationError => e
         raise e unless e.message.include?(NO_UPDATE_MESSAGE)
@@ -103,6 +105,19 @@ module Bora
       (action == :delete && !underlying_stack) || status.success?
     end
 
+    def resolve_options(options, load_all = false)
+      return options if options[:template_body] || !options[:template_url]
+      uri = URI(options[:template_url])
+      if uri.scheme != "s3" || load_all
+        resolved_options = options.clone
+        resolved_options[:template_body] = open(options[:template_url]).read
+        resolved_options.delete(:template_url)
+        resolved_options
+      else
+        options
+      end
+    end
+
     def wait_for_completion
       begin
         events = unprocessed_events

data/lib/bora/tasks.rb

@@ -4,15 +4,21 @@ require 'bora/stack'
 
 module Bora
   class Tasks < Rake::TaskLib
-    def initialize(stack_name)
+    def initialize(stack_name, template_uri = nil)
       @stack_name = stack_name
       @stack = Stack.new(stack_name)
       @colorize = true
-      if block_given?
-        within_namespace do
-          yield self
+      @stack_options = {}
+      within_namespace { yield self } if block_given?
+
+      if template_uri
+        if @stack_options[:template_body] || @stack_options[:template_url]
+          raise "You cannot specify a template in the constructor as well as in the stack_options"
+        else
+          @stack_options[:template_url] = template_uri
         end
       end
+
       define_tasks
     end
 
@@ -23,6 +29,7 @@ module Bora
       String.disable_colorization = !@colorize
     end
 
+
     private
 
     def define_tasks

data/lib/bora/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bora
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Charles Blaxland