cloud_formation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4945e75d75aab59b2ecfe06ab6e1a5f8851e91a1
+  data.tar.gz: cb00df496843abb306400d73fd68d78e4e3beb17
+SHA512:
+  metadata.gz: 6957921b9a415ee5bd3e4899c989995dd34ca2ea11341990a6a0913f49fde3fc247b605430fb0b541397c3c3c02fa13a654c9edb6f09110f43d7010ca5615a4a
+  data.tar.gz: ab2c7c94e6b0fdf72325e18471d2d8ded7d2b291e3fbfd262b87a893b3349d59f8894d430626c9cb9ac4567d44797cba137955890f3236ab4f5a521fccff5a47

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloud_formation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David White
+
+MIT License
+
+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,103 @@
+# CloudFormation
+
+A Ruby gem to create AWS CloudFormation descriptions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloud_formation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloud_formation
+
+## Usage
+
+### Generate a template
+
+```ruby
+template = CloudFormation::Template.new
+
+template.build do |t|
+  t.name = "stack-name"
+  t.description = "A description of the stack"
+end
+
+template.render
+```
+
+Running this will generate a nicely compacted:
+```json
+{"AWSTemplateFormatVersion":"2010-09-09","Name":"stack-name","Description":"A description of the stack","Resources":{}}
+```
+
+### Generate a DynamoDB table
+
+Generating a DynamoDB table is as simple as:
+
+```ruby
+template = CloudFormation::Template.new
+
+template.build do |t|
+  t.name = "stack-name"
+  t.description = "A description of the stack"
+end
+
+dynamo_db = CloudFormation::DynamoDB.new
+
+table = dynamo_db.build_table do |t|
+  t.name = "commentsTable"
+  t.read_capacity_units = 10
+  t.write_capacity_units = 5
+  t.hash_key = { blog_post_id: :number }
+  t.range_key = { comment_id: :number }
+end
+
+template.add_resource table
+
+puts template.render pretty: true
+```
+
+Running with the `pretty true` options will generate an easier to read version:
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Name": "stack-name",
+  "Description": "A description of the stack",
+  "Resources": {
+    "commentsTable": {
+      "Type": "AWS::DynamoDB::Table",
+      "Properties": {
+        "ProvisionedThroughput": {
+          "WriteCapacityUnits": "5",
+          "ReadCapacityUnits": "10"
+        }
+      },
+      "KeySchema": {
+        "RangeKeyElement": {
+          "AttributeName": "comment_id",
+          "AttributeType": "N"
+        },
+        "HashKeyElement": {
+          "AttributeName": "blog_post_id",
+          "AttributeType": "N"
+        }
+      }
+    }
+  }
+}
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/cloud_formation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/cloud_formation.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloud_formation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloud_formation"
+  spec.version       = CloudFormation::VERSION
+  spec.authors       = ["David White"]
+  spec.email         = ["david.white@spry-soft.com"]
+  spec.summary       = %q{A Ruby gem to create AWS CloudFormation descriptions.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/cloud_formation.rb

@@ -0,0 +1,8 @@
+require "cloud_formation/version"
+
+module CloudFormation
+  autoload :Refinements, "cloud_formation/refinements"
+  autoload :Base, "cloud_formation/base"
+  autoload :Template, "cloud_formation/template"
+  autoload :DynamoDB, "cloud_formation/dynamo_db"
+end

data/lib/cloud_formation/base.rb

@@ -0,0 +1,21 @@
+module CloudFormation
+  class Base
+    def self.attribute_list *attrs
+      attrs.each do |name|
+        define_method "#{name}=".to_sym do |value|
+          instance_variable_set "@#{name}", value
+        end
+        define_method name.to_sym do
+          instance_variable_get "@#{name}"
+        end
+      end
+      define_method :attributes do
+        attrs
+      end
+    end
+
+    def build &block
+      yield self
+    end
+  end
+end

data/lib/cloud_formation/dynamo_db.rb

@@ -0,0 +1,47 @@
+module CloudFormation
+  class DynamoDB < Base
+    attribute_list :name, :read_capacity_units, :write_capacity_units, :hash_key, :range_key
+
+    def build_table &block
+      yield self
+      self
+    end
+
+    def serialize
+      properties = {
+        "Type" => "AWS::DynamoDB::Table",
+        "Properties" => {
+          "ProvisionedThroughput" => {
+            "WriteCapacityUnits" => @write_capacity_units.to_s,
+            "ReadCapacityUnits" => @read_capacity_units.to_s
+          }
+        }
+      }
+      properties.merge add_key_schemas
+    end
+
+
+    private
+
+      def key_type_mapping type
+        case type
+          when :string then "S"
+          when :number then "N"
+          when :binary then "B"
+        end
+      end
+
+      def add_key_schemas
+        key_schema = { "KeySchema" => {}}
+        key_schema["KeySchema"]["RangeKeyElement"] = add_key_schema_for(@range_key) if @range_key
+        key_schema["KeySchema"]["HashKeyElement"] = add_key_schema_for(@hash_key) if @hash_key
+        key_schema
+      end
+
+      def add_key_schema_for key
+        k = key.keys.first
+        { "AttributeName" => k.to_s, "AttributeType" => key_type_mapping(key[k])  }
+      end
+
+  end
+end

data/lib/cloud_formation/refinements.rb

@@ -0,0 +1,14 @@
+
+module CloudFormation
+
+  module Refinements
+    refine String do
+      def camel_case
+        return self if self !~ /_/ && self =~ /[A-Z]+.*/
+        split('_').map { |e| e.capitalize }.join
+      end
+    end
+  end
+  using Refinements
+
+end

data/lib/cloud_formation/template.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module CloudFormation
+  class Template < Base
+    using Refinements
+    AWS_TEMPLATE_FORMAT_VERSION = "2010-09-09"
+
+    attribute_list :name, :description, :resources
+
+    def initialize
+      @resources = {}
+    end
+
+    def add_resource resource
+      @resources[resource.name] = resource.serialize.tap { |a| a.delete("Name") }
+    end
+
+    def render pretty: false, indentation: 2
+      pretty ? JSON.pretty_generate(serialize, indent: " "*indentation) : serialize.to_json
+    end
+
+    private
+
+      def serialize
+        attributes.inject(default_hash) do |hash, value|
+          hash[value.to_s.camel_case] = self.send value
+          hash
+        end
+      end
+
+      def default_hash
+        { "AWSTemplateFormatVersion" => AWS_TEMPLATE_FORMAT_VERSION }
+      end
+  end
+end

data/lib/cloud_formation/version.rb

@@ -0,0 +1,3 @@
+module CloudFormation
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: cloud_formation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem to create AWS CloudFormation descriptions.
+email:
+- david.white@spry-soft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cloud_formation.gemspec
+- lib/cloud_formation.rb
+- lib/cloud_formation/base.rb
+- lib/cloud_formation/dynamo_db.rb
+- lib/cloud_formation/refinements.rb
+- lib/cloud_formation/template.rb
+- lib/cloud_formation/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to create AWS CloudFormation descriptions.
+test_files: []