bora 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d8bdb0f5c4ecf2bd52b21f4be37383916b33f11
-  data.tar.gz: e0185553a1d9600dd9b4ff546e720b78fe006003
+  metadata.gz: a3bef88ac6bd7773175b02930da53efe7de03ec7
+  data.tar.gz: 450388c3e3ffc40c353ed09af8a79b8bf2223c13
 SHA512:
-  metadata.gz: 64a03d50e228425644d439891c6f1272d12deae7d34cd0a43d6a8ef72ab2207ff5cee387413765ee24f347957851f7dc50bf8e86429c5bfcc6f7885351155292
-  data.tar.gz: b992783319a0389b1bc7a57d6cdd862349d4b032072285a045e3d3aace2edb4253ad739833c9cfc577e5b11d8b44aaaf3288502da4fb7eafd126c6a7b8a84fcc
+  metadata.gz: 0b7cc4b0e82bf2eb5c9ba59e95600f890296b7dcb1409177dccff2373a7b99b74c5664b95bacc96a3d597ff1cdfa477164489b623a05d8a20972f9e9e9abe142
+  data.tar.gz: 770f772c1df360fc90dfe7bb1efa031e537aa110a11638fb3bda947dc3c08a45b48810e28f4598bcd7ea7efc169ed35a395530c6545fbfd0a0925706af01a285

data/README.md

@@ -1,8 +1,12 @@
 # Bora
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bora`. To experiment with that code, run `bin/console` for an interactive prompt.
+> 1. A cold and often gusty katabatic wind in the Adriatic
+> 2. A tool for pushing around your cloud formations
+
+This gem contains Ruby [rake](https://github.com/ruby/rake) tasks that help you work with [CloudFormation](https://aws.amazon.com/cloudformation/) stacks.
+You don't need to use it with rake though - you can use the underlaying classes
+in any Ruby app.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,15 +26,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Quick Start
+
+Add this to your `Rakefile`
+
+```ruby
+require 'bora'
+
+Bora::Tasks.new("example") do |t|
+  t.stack_options = {
+    template_body: File.read("example.json")
+  }
+end
+```
+
+This will give you the following rake tasks
+
+```shell
+rake stack:example:apply             # Creates (or updates) the example stack
+rake stack:example:current_template  # Shows the current template for example stack
+rake stack:example:delete            # Deletes the example stack
+rake stack:example:diff              # Diffs the new template with the example stack's current template
+rake stack:example:events            # Outputs the latest events from the example stack
+rake stack:example:new_template      # Shows the new template for example stack
+```
+
+You can add as many templates as you like into your Rakefile, simply define an instance of `Bora::Tasks` for each one.
+
+### Task Options
+
+When you define the Bora tasks, you can pass in a number of options that control how Bora works and what gets passed to CloudFormation.
+The available options are shown below with their default values.
+
+```ruby
+Bora::Tasks.new("example") do |t|
+  t.colorize = true
+  t.stack_options = {}
+end
+```
+
+* `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.
+
+
+### API
+
+You can use this gem without using Rake. Most of the logic is implemented in [stack.rb](https://github.com/ampedandwired/bora/blob/master/lib/bora/stack.rb) and is fairly self-explanatory.
+
+```ruby
+require 'bora'
+
+stack = Bora::Stack.new("my-stack")
+result = stack.update({template_body: File.read("example.json")}) do |event|
+  puts event
+end
+
+puts "Update #{result ? "succeeded" : "failed"}"
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bora.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/ampedandwired/bora.

data/bora.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk", "~> 2.0"
   spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "diffy", "~> 3.0"
   spec.add_dependency "rake", "~> 10.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"

data/lib/bora/stack.rb

@@ -1,5 +1,6 @@
 require 'set'
 require 'aws-sdk'
+require 'diffy'
 
 module Bora
   class Stack
@@ -9,22 +10,49 @@ module Bora
       @processed_events = Set.new
     end
 
-    def create(params, &block)
-      call_cfn_action(:create, params, &block)
+    def create(options, &block)
+      call_cfn_action(:create, options, &block)
     end
 
-    def update(params, &block)
-      call_cfn_action(:update, params, &block)
+    def update(options, &block)
+      call_cfn_action(:update, options, &block)
     end
 
-    def create_or_update(params, &block)
-      exists? ? update(params, &block) : create(params, &block)
+    def create_or_update(options, &block)
+      exists? ? update(options, &block) : create(options, &block)
     end
 
     def delete(&block)
       call_cfn_action(:delete, &block)
     end
 
+    def events
+      return [] if !underlying_stack
+      events = @cfn.describe_stack_events({stack_name: underlying_stack.stack_id}).stack_events
+      events.reverse.map { |e| Event.new(e) }
+    end
+
+    def template(pretty = true)
+      return if !exists?
+      template = @cfn.get_template({stack_name: @stack_name}).template_body
+      template = JSON.pretty_generate(JSON.parse(template)) if pretty
+      template
+    end
+
+    def new_template(options, pretty = true)
+      if options[:template_body]
+        template = options[:template_body]
+        template = JSON.pretty_generate(JSON.parse(template)) if pretty
+        template
+      else
+        raise Exception("new_template not yet implemented for template_url stack option")
+      end
+    end
+
+    def diff(options)
+      Diffy::Diff.new(template, new_template(options))
+    end
+
     def exists?
       underlying_stack && underlying_stack.stack_status != 'DELETE_COMPLETE'
     end
@@ -32,13 +60,13 @@ module Bora
 
     private
 
-    def call_cfn_action(action, params = {}, &block)
+    def call_cfn_action(action, options = {}, &block)
       underlying_stack(refresh: true)
       return true if action == :delete && !exists?
       @previous_event_time = last_event_time
-      params[:stack_name] = @stack_name
+      options[:stack_name] = @stack_name
       begin
-        @cfn.method("#{action.to_s.downcase}_stack").call(params)
+        @cfn.method("#{action.to_s.downcase}_stack").call(options)
         wait_for_completion(&block)
       rescue Aws::CloudFormation::Errors::ValidationError => e
         raise e unless e.message.include?("No updates are to be performed")

data/lib/bora/tasks.rb

@@ -11,20 +11,34 @@ module Bora
       define_tasks
     end
 
-    attr_accessor :stack_params, :colorize
+    attr_accessor :stack_options, :colorize
 
     private
 
     def define_tasks
       define_apply_task
+      define_current_template_task
       define_delete_task
+      define_diff_task
+      define_events_task
+      define_new_template_task
     end
 
     def define_apply_task
       within_namespace do
         desc "Creates (or updates) the #{@stack_name} stack"
         task :apply do
-          invoke_action(@stack.exists? ? "update" : "create", stack_params)
+          invoke_action(@stack.exists? ? "update" : "create", stack_options)
+        end
+      end
+    end
+
+    def define_current_template_task
+      within_namespace do
+        desc "Shows the current template for #{@stack_name} stack"
+        task :current_template do
+          template = @stack.template
+          puts template ? template : "Stack #{@stack_name} does not exist"
         end
       end
     end
@@ -38,6 +52,38 @@ module Bora
       end
     end
 
+    def define_diff_task
+      within_namespace do
+        desc "Diffs the new template with the #{@stack_name} stack's current template"
+        task :diff do
+          puts @stack.diff(@stack_options).to_s(@colorize ? :color : :text)
+        end
+      end
+    end
+
+    def define_events_task
+      within_namespace do
+        desc "Outputs the latest events from the #{@stack_name} stack"
+        task :events do
+          events = @stack.events
+          if events.length > 0
+            @stack.events.each { |e| puts e }
+          else
+            puts "No events for stack #{@stack_name}"
+          end
+        end
+      end
+    end
+
+    def define_new_template_task
+      within_namespace do
+        desc "Shows the new template for #{@stack_name} stack"
+        task :new_template do
+          puts @stack.new_template(@stack_options)
+        end
+      end
+    end
+
     def invoke_action(action, *args)
       puts "#{action.capitalize} stack #{@stack_name}"
       success = @stack.send(action, *args) { |event| puts event.to_s(colorize) }

data/lib/bora/version.rb

@@ -1,3 +1,3 @@
 module Bora
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bora
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Charles Blaxland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement