cloud_shaped 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6170e5e4012e478185904f5e954f66377bee856e
-  data.tar.gz: 69154dcff5fb35c7eec5e335a34404bc54b1b7f8
+  metadata.gz: 21a2049dd796e57e57bc9ad49fb45effb6340239
+  data.tar.gz: 8e445136b05818d16ff9d1a78ee61f23097d1a08
 SHA512:
-  metadata.gz: d27e67b31475234deea22c3157f6a89d8b53db9295233d6ec4af52346b6c71d4f73f19ee7dd19bb6d91771ea24c0178ed9fc23a113185a98c2fc4d02ae117bba
-  data.tar.gz: dfce6eb71652b4d01352eb74b4ca7b8c45cb281be4ac312b7d6fb3394339dc2f347f052cc3266bd72e033cec86dfefa1af4feb031263bf68156e9903428bb653
+  metadata.gz: 76e13fe7b29c92d2fec4986e886f053980a9f204fbaa1b32c74349644e4fe67b8177de4a2284b520066a4038b4aa27ba4a59b2164ccb50e7ed8f9b5d6fe9d151
+  data.tar.gz: 0f992328cba18e1393df16ed5bc00813194162b5d6beefe077ed97e896a1b6523ee0c330a762ca471a1f6b9a51d63cfc6bd4b316e69b2971b8ed1e4a6ef8156f

data/README.md

@@ -15,15 +15,49 @@ Add this line to your application's Gemfile:
 ## Example
 
     require 'cloud_shaped'
+    require 'json'
 
-    template = CloudShaped.template do |t|
-      t.def_parameter "appName"
-      t.def_resource "app", "AWS::Appity:AppApp" do |app|
-        app["Name"] = t.ref("appName")
-      end
-      t.def_output "appAddress", t.ref("app", "address")
+    template = CloudShaped.template do
+      def_parameter "appName"
+      def_resource "app", "AWS::Appity:AppApp", "Name" => ref("appName")
+      def_output "appAddress", ref("app", "address")
     end
 
+    puts JSON.pretty_generate(template)
+
+outputs
+
+    {
+      "AWSTemplateFormatVersion": "2010-09-09",
+      "Parameters": {
+        "appName": {
+          "Type": "String"
+        }
+      },
+      "Resources": {
+        "app": {
+          "Type": "AWS::Appity:AppApp",
+          "Properties": {
+            "Name": {
+              "Ref": "appName"
+            }
+          }
+        }
+      },
+      "Outputs": {
+        "appAddress": {
+          "Value": {
+            "Fn::GetAtt": ["app", "address"]
+          }
+        }
+      }
+    }
+
+For more info on the DSL, see:
+
+* {CloudShaped.template}
+* {CloudShaped::TemplateBuilder}
+
 ## Contributing
 
 It's [on GitHub][cloud_shaped]. Fork it.

data/examples/buckets.rb

@@ -0,0 +1,24 @@
+#! /usr/bin/env ruby
+
+require 'cloud_shaped'
+require 'yaml'
+
+class BucketMaker
+
+  def initialize(n_buckets = 1)
+    @n_buckets = n_buckets
+  end
+
+  def template
+    CloudShaped.template do |t|
+      1.upto(@n_buckets) do |i|
+        t.def_resource "bucket#{i}", "AWS::S3::Bucket" do |b|
+          b["BucketName"] = "my-bucket-#{i}"
+        end
+      end
+    end
+  end
+
+end
+
+puts YAML.dump(BucketMaker.new(3).template)

data/examples/macro.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+
+require 'cloud_shaped'
+require 'yaml'
+
+module ScalingMacros
+
+  def asg_adjustment(asg_resource_name, adjustment, cooldown = 120)
+    resource("AWS::AutoScaling::ScalingPolicy") do |p|
+      p["AdjustmentType"] = "ChangeInCapacity"
+      p["AutoScalingGroupName"] = ref(asg_resource_name)
+      p["ScalingAdjustment"] = adjustment
+      p["Cooldown"] = cooldown
+    end
+  end
+
+end
+
+template = CloudShaped.template do
+
+  extend(ScalingMacros)
+
+  def_resource "upOne", :asg_adjustment, "autoScalingGroup", 1
+  def_resource "downOne", :asg_adjustment, "autoScalingGroup", -1
+
+end
+
+puts YAML.dump(template)

data/lib/cloud_shaped/core_methods.rb

@@ -30,7 +30,7 @@ module CloudShaped
 
     # Returns a CloudFormation Parameter declaration.
     #
-    # @option options [String] :type ("String") the resource type
+    # @option options [String] :type ("String") the parameter type
     # @option options [String] :description parameter description
     # @option options [String] :default a default value
     #
@@ -56,16 +56,31 @@ module CloudShaped
 
     # Returns a Tag.
     #
-    # @param name [String] tag name
+    # @param key [String] tag name
     # @param value tag value
+    # @return [Hash] a Tag structure
     #
-    def tag(name, value, extra_properties = {})
+    # @example
+    #   tag("name", "bob") #=> { "Key" => "name", "Value" => "bob "}
+    #
+    def tag(key, value, extra_properties = {})
       {
-        "Key" => name,
+        "Key" => key,
         "Value" => value
       }.merge(extra_properties)
     end
 
+    # Returns a list of Tags.
+    #
+    # @param tag_map [Hash] mapping of Tag keys to values
+    #
+    # @example
+    #   tags("application" => "atlas", "version" => "1.2.3")
+    #
+    def tags(tag_map, extra_properties = {})
+      tag_map.map { |k,v| tag(k,v, extra_properties) }
+    end
+
     # Returns a resource reference.
     #
     # If attribute_name is specified, we use "Fn::GetAtt"; otherwise, we use "Ref".

data/lib/cloud_shaped/template_builder.rb

@@ -2,8 +2,7 @@ require 'cloud_shaped/dsl'
 
 module CloudShaped
 
-  # A TemplateBuilder is an object that can generate a CloudFormation template,
-  # in the form of Ruby data.
+  # A {http://en.wikipedia.org/wiki/Builder_pattern builder} for CloudFormation templates.
   #
   class TemplateBuilder
 
@@ -13,10 +12,8 @@ module CloudShaped
       @outputs = {}
     end
 
-    attr_reader :parameters
-    attr_reader :resources
-    attr_reader :outputs
-
+    # @return [Hash] a CloudFormation template as Ruby data
+    #
     def template
       {
         "AWSTemplateFormatVersion" => '2010-09-09',
@@ -28,18 +25,53 @@ module CloudShaped
 
     include CloudShaped::DSL
 
-    def def_parameter(name, *args)
-      parameters[name] = parameter(*args)
+    # Declares a Parameter.
+    #
+    # @param name [String] the parameter name
+    # @option options [String] :type ("String") the parameter type
+    # @option options [String] :description parameter description
+    # @option options [String] :default a default value
+    #
+    # @example
+    #   def_parameter "appName"
+    #   def_parameter "minInstances", :type => "Number"
+    #
+    def def_parameter(name, options = {})
+      parameters[name] = parameter(options)
     end
 
+    # Declares a Resource.
+    #
+    # @param name [String] the resource name
+    # @param type [String, Symbol] the resource type
+    # @param args [Hash] resource properties
+    #
     def def_resource(name, type, *args, &block)
-      resources[name] = resource(type, *args, &block)
+      resources[name] = if type.is_a?(Symbol)
+        send(type, *args, &block)
+      else
+        resource(type, *args, &block)
+      end
     end
 
-    def def_output(name, *args)
-      outputs[name] = output(*args)
+    # Declares an Output.
+    #
+    # @param name [String] the output name
+    # @param value the output value (usually a reference to a resource)
+    #
+    # @example
+    #   def_output "loadBalancerName", ref("loadBalancer")
+    #
+    def def_output(name, value)
+      outputs[name] = output(value)
     end
 
+    protected
+
+    attr_reader :parameters
+    attr_reader :resources
+    attr_reader :outputs
+
   end
 
 end

data/lib/cloud_shaped/version.rb

@@ -1,3 +1,3 @@
 module CloudShaped
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/cloud_shaped/core_methods_spec.rb

@@ -109,6 +109,25 @@ describe CloudShaped::CoreMethods do
 
   end
 
+  describe "#tags" do
+
+    it "generates a list of tags" do
+      expect(tags("first" => "foo", "last" => "bar")).to eq(
+        [
+          {
+            "Key" => "first",
+            "Value" => "foo"
+          },
+          {
+            "Key" => "last",
+            "Value" => "bar"
+          }
+        ]
+      )
+    end
+
+  end
+
   describe "#ref" do
 
     context "with a logical resource name" do

data/spec/cloud_shaped/template_builder_spec.rb

@@ -25,12 +25,10 @@ describe CloudShaped::TemplateBuilder do
 
   describe "#def_resource" do
 
-    before do
-      template_builder.def_resource("fooBar", "AWS::Foo::Bar", "foo" => "bar")
-    end
-
     it "defines a Resource" do
 
+      template_builder.def_resource("fooBar", "AWS::Foo::Bar", "foo" => "bar")
+
       expect(template["Resources"]).to eq(
         "fooBar" => {
           "Type" => "AWS::Foo::Bar",
@@ -40,6 +38,29 @@ describe CloudShaped::TemplateBuilder do
 
     end
 
+    context "with a symbol as the second argument" do
+
+      before do
+        def template_builder.fnord(size)
+          resource "AWS::Fnord::Fnord", "Size" => size
+        end
+      end
+
+      it "calls the method named by the symbol to define the resource" do
+
+        template_builder.def_resource("fooBar", :fnord, "3")
+
+        expect(template["Resources"]).to eq(
+          "fooBar" => {
+            "Type" => "AWS::Fnord::Fnord",
+            "Properties" => {"Size" => "3"}
+          }
+        )
+
+      end
+
+    end
+
   end
 
   describe "#def_parameter" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud_shaped
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,8 @@ files:
 - README.md
 - Rakefile
 - cloud_shaped.gemspec
+- examples/buckets.rb
+- examples/macro.rb
 - lib/cloud_shaped.rb
 - lib/cloud_shaped/camelate.rb
 - lib/cloud_shaped/core_methods.rb