cfer 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmZlMTM5YzllNzU0ZjJiMTliYWEyMWIwYTVmNjU1OWFmNjQ0NDk5Yw==
+  data.tar.gz: !binary |-
+    MmUxM2Y1ZjkwOWMyNDA5Mzk4OWJkZTA0Y2Y5ZTdmMjU3NzY3Nzg1Mg==
+SHA512:
+  metadata.gz: !binary |-
+    NmQyNGQyOWZmOTA1Mzc2OGQ3NmE0Mjg5YTE5MzdmYWFhNDQ4ODZkZTRjOTc1
+    ZTFmOTA5ZmJiODg3YzkwMTk0MTE5MGQzYWFlOTA0OGMxMzNlZTkyY2IwZjU4
+    NTdkMWQyZGEzYTEzMDE5MGU2YjFlMzljMzI3NzczZjJhYTJhMWY=
+  data.tar.gz: !binary |-
+    YzkzMjUzMGJjYzgzODc2MmFkZWRlZjdiMzFkZDI1NGI5YmQ5ZWQxOWQ4ZTUy
+    YWZiZDZhYmJmNGQ5YmUzNTA4MDRkNTZhMThiMDhjMmRiY2IxZTA5MzBiZDM2
+    MDgxYzA0MTE3M2M0OGVhMWI0MjYxNmM5OTA4YTE2YzQwNzU5M2U=

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*/.tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+install: bundle install --without debug --jobs=3 --retry=3
+rvm:
+- 2.1.3
+- ruby-head
+script:
+- bundle exec rspec
+- bundle exec yard
+deploy:
+  provider: rubygems
+  api_key:
+    secure: nFmXjdI+hZqU7qUByM2qcLjbz3/5Q1VaQZhL752XrjCZ+1rURLB0hJOpSbbPtdlukdOlU3svDbyh9w9uUL4tIEyHY6u4QDUgaOLPbRyJFZSQkEug367NVVd/hRB4o7qxqJDoXI4mLQQRQRCFtZyrBEY1H6m7TUmTa3B3RwNqPWoHgTIQKdgM4ws17I8wmNVnA0s08AiiMf2sxyX8kkbyo8tOs5KpQ6Uw9Y8bD8EoSTt18nGmT7arhLrinu9ZcDyaoJOtIKQYLWDfoUMAw7zzUR9Z4msfPqepiwh3VIredNVkFVtZ8P6AvF9G2+Dn2Pc93Fb8XSaUfNRBiUC4Vt/5AXEkw5w2z4ok+Xjzc4/0jlSYBEECuZIi7L0ky4+W+5c+jteo2MD5Ave/YrOe4wHehg9xdT/43EWmtYNiFnqhcxcj9ZsR+QUe93fpitb4mBmLiNVY5wT+7L0yQRWMqL6Fl6eYD8qK1PO+0O230Ukxd7kSLpCWPdAxiGCNkCl27IRGaSqiObJL1S8tLZdm2DG4gcQBANyc/A6Ghkbn7qb/qMcYDEXSfWWKTox6cSXPpW4RYXTMwisOoe5Vvn+A0lDPMBIg62FXrem1hgU7twFt4SqyOYD377M+b46Zk7G/62hdCaLtxxbBX93ZWLLusSmlNdI0+xbhc26p4x0aoV4OJiU=
+  gem: cfer
+  on:
+    tags: true
+    repo: seanedwards/cfer

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cfer.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'guard-rspec'
+  gem 'coveralls', require: false
+end
+
+group :debug do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sean Edwards
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,221 @@
+# Cfer
+
+[![Build Status](https://travis-ci.org/seanedwards/cfer.svg?branch=master)](https://travis-ci.org/seanedwards/cfer)
+[![Coverage Status](https://coveralls.io/repos/seanedwards/cfer/badge.svg)](https://coveralls.io/r/seanedwards/cfer)
+
+Cfer is a lightweight toolkit for managing CloudFormation templates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cfer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cfer
+
+## Usage
+
+To quickly see Cfer in action, try converging the example stacks:
+
+```bash
+cfer converge vpc -t examples/vpc.rb --profile [YOUR-PROFILE] --region [YOUR-REGION]
+cfer converge instance -t examples/instance.rb --profile [YOUR-PROFILE] --region [YOUR-REGION] --parameters KeyName:[YOUR-EC2-SSH-KEY]
+```
+
+You should see something like this:
+
+![Demo](cfer-demo.gif)
+
+### Command line
+
+    Commands:
+      cfer converge [OPTIONS] <stack-name>   # Converges a cloudformation stack according to the template
+      cfer generate [OPTIONS] <template.rb>  # Generates a CloudFormation template by evaluating a Cfer template
+      cfer help [COMMAND]                    # Describe available commands or one specific command
+      cfer tail <stack-name>                 # Follows stack events on standard output as they occur
+
+#### Global options
+
+* `--profile <profile>`: The AWS profile to use (from your `~/.aws/credentials` file)
+* `--region <region>`: The AWS region to use
+* `--verbose`: Also print debugging messages
+
+#### `generate <template.rb>`
+
+The `generate` subcommand evaluates the given Ruby script and prints the CloudFormation stack JSON to standard output.
+
+The following options may be used with the `generate` command:
+
+* `--no-pretty-print`: Print minified JSON
+
+#### `converge <stack-name>`
+
+Creates or updates a CloudFormation stack according to the specified template.
+
+The following options may be used with the `converge` command:
+
+* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place. 
+* `--stack-file <template.rb>`: Reads this file from the filesystem, rather than the default `<stack-name>.rb`
+* `--parameters <Key1>:<Value1> <Key2>:<Value2> ...`: Specifies input parameters, which will be available to Ruby in the `parameters` hash, or to CloudFormation by using the `Fn::ref` function
+* `--on-failure <DELETE|ROLLBACK|DO_NOTHING>`: Specifies the action to take when a stack creation fails. Has no effect if the stack already exists and is being updated.
+
+#### `tail <stack-name>`
+
+Prints the latest `n` stack events, and optionally follows events while a stack is converging.
+
+The following options may be used with the `tail` command:
+
+* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place. 
+* `--number` (`-n`): Print the last `n` stack events.
+
+### Template Anatomy
+
+See the `examples` directory for some examples of complete templates.
+
+#### Parameters
+
+Parameters may be defined using the `parameter` function:
+
+```ruby
+parameter :ParameterName,
+  type: 'String',
+  default: 'ParameterValue'
+```
+
+A parameter's value may have the form `@stack.output` to look up output values from other stacks in the same account and region. This works anywhere a parameter value is specified, including defaults and inputs. (See the SDK section on [Cfer Stacks](#cfer-stacks) for caveats.)
+
+Any parameter can be referenced either in Ruby by using the `parameters` hash:
+
+```ruby
+parameters[:ParameterName]
+```
+
+Parameters can also be used in a CloudFormation reference by using the `Fn::ref` function:
+
+```ruby
+Fn::ref(:ParameterName)
+```
+
+#### Resources
+
+Resources may be defined using the `resource` function:
+
+```ruby
+resource :ResourceName, 'AWS::CloudFormation::CustomResource', AttributeName: {:attribute_key => 'attribute_value'} do
+  property_name 'property_value'
+end
+```
+
+Gets transformed into the corresponding CloudFormation block:
+
+```json
+"ResourceName": {
+  "Type": "AWS::CloudFormation::CustomResource",
+  "AttributeName": {
+    "attribute_key": "attribute_value"
+  },
+  "Properties": {
+    "PropertyName": "property_value"
+  }
+}
+```
+
+#### Outputs
+
+Outputs may be defined using the `output` function:
+
+```ruby
+output :OutputName, Fn::ref(:ResourceName)
+```
+
+## SDK
+
+Embedding the Cfer SDK involves interacting with two components: The `Client` and the `Stack`.
+The Cfer `Client` is the interface with the Cloud provider.
+
+### Cfn Client
+
+Create a new client:
+
+```ruby
+Cfer::Cfn::Client.new(stack_name: <stack_name>)
+```
+
+`Cfer::Cfn::Client` also accepts options to be passed into the internal `Aws::CloudFormation::Client` constructor.
+
+#### `converge(stack)`
+
+Creates or updates the CloudFormation stack to match the input `stack` object. See below for how to create Cfer stack objects.
+
+```ruby
+client.converge(<stack>)
+```
+
+#### `tail(options = {})`
+
+Yields to the specified block for each CloudFormation event that qualifies given the specified options.
+
+```ruby
+client.tail number: 1, follow: true do |event|
+  # Called for each CloudFormation event, as they occur, until the stack enters a COMPLETE or FAILED state.
+end
+```
+
+### Cfer Stacks
+
+Create a new stack:
+
+#### `stack_from_file`
+
+```ruby
+stack = Cfer::stack_from_file(<file>, client: <client>)
+```
+
+#### `stack_from_block`
+
+```ruby
+stack = Cfer::stack_from_block(client: <client>) do
+  # Stack definition goes here
+end
+```
+
+Note: Specifying a client is optional, but if no client is specified, parameter mappings will not occur.
+
+## Contributing
+
+This project uses [git-flow](http://nvie.com/posts/a-successful-git-branching-model/). Please name branches and pull requests according to that convention.
+
+Always use `--no-ff` when merging into `develop` or `master`.
+
+### New features
+
+* Branch from `develop`
+* Merge into `develop`
+* Name branch `feature/<feature-name>`
+
+### Unreleased bugs
+
+* Branch from `develop`
+* Merge into `develop`
+* Name branch `bugfix/<issue-id>`
+
+### Bugfixes against releases
+
+* Branch from `master`
+* Merge into `develop` and `master`
+* Name branch `hotfix/<issue-id>`
+
+### Releases
+
+* Branch from `develop`
+* Merge into `develop` and `master`
+* Name branch `release/<major.minor>`
+

data/Rakefile

@@ -0,0 +1,41 @@
+require "bundler/gem_tasks"
+gem 'cfer'
+require 'cfer'
+require 'highline'
+
+Cfer::LOGGER.level = Logger::DEBUG
+
+task :default => [:spec]
+
+task :config_aws, [:profile] do |t, args|
+  Aws.config.update region: ENV['AWS_REGION'] || 'us-east-1',
+    credentials: Aws::SharedCredentials.new(profile_name: ENV['AWS_PROFILE'] || 'default')
+end
+
+task :vpc => :config_aws do |t, args|
+  Cfer.converge! 'vpc',
+    template: 'examples/vpc.rb',
+    follow: true
+end
+
+task :describe_vpc => :config_aws do
+  Cfer.describe! 'vpc'
+end
+
+task :instance => :config_aws do |t, args|
+  key_pair = ask("Enter your EC2 KeyPair name: ")
+
+  Cfer.converge! 'instance',
+    template: 'examples/instance.rb',
+    parameters: {
+      :KeyName => key_pair
+    },
+    follow: true
+end
+
+task :describe_instance => :config_aws do
+  Cfer.describe! 'instance'
+end
+
+task :converge => [:vpc, :instance]
+

data/bin/cfer

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+module Cfer
+  DEBUG = false
+end
+
+require 'cfer'
+
+
+Cfer::Cli::main(ARGV)
+

data/bin/cfer-dbg

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'pry'
+require 'pry-rescue'
+
+module Cfer
+  DEBUG = true
+end
+
+require 'cfer'
+
+Cfer::LOGGER.level = Logger::DEBUG
+
+Cfer::LOGGER.fatal "Showing FATAL logs"
+Cfer::LOGGER.error "Showing ERROR logs"
+Cfer::LOGGER.warn "Showing WARN logs"
+Cfer::LOGGER.info "Showing INFO logs"
+Cfer::LOGGER.debug "Showing DEBUG logs"
+
+Pry::rescue {
+  Cfer::Cli::main(ARGV)
+}
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cfer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here