cloudformation-ruby-dsl 0.5.4 → 1.0.0

data/lib/cloudformation-ruby-dsl/dsl.rb

@@ -0,0 +1,249 @@
+require 'json'
+
+############################ Utility functions
+
+# Formats a template as JSON
+def generate_template(template)
+  format_json template, !template.nopretty
+end
+
+def generate_json(data, pretty = true)
+  # Raw formatting
+  return JSON.generate(data) unless pretty
+
+  # Pretty formatting
+  JSON.pretty_generate(data)
+end
+
+
+############################# Generic DSL
+
+class JsonObjectDSL
+  def initialize(&block)
+    @dict = {}
+    instance_eval &block
+  end
+
+  def value(values)
+    @dict.update(values)
+  end
+
+  def default(key, value)
+    @dict[key] ||= value
+  end
+
+  def to_json(*args)
+    @dict.to_json(*args)
+  end
+
+  def print()
+    puts JSON.pretty_generate(self)
+  end
+end
+
+############################# CloudFormation DSL
+
+# Main entry point
+def raw_template(parameters = {}, stack_name = nil, aws_region = default_region, nopretty = false, &block)
+  TemplateDSL.new(parameters, stack_name, aws_region, nopretty, &block)
+end
+
+def default_region
+  ENV['EC2_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
+end
+
+# Core interpreter for the DSL
+class TemplateDSL < JsonObjectDSL
+  attr_reader :parameters, :aws_region, :nopretty, :stack_name
+
+  def initialize(parameters = {}, stack_name = nil, aws_region = default_region, nopretty = false)
+    @parameters = parameters
+    @stack_name = stack_name
+    @aws_region = aws_region
+    @nopretty = nopretty
+    super()
+  end
+
+  def exec!()
+    cfn(self)
+  end
+
+  def parameter(name, options)
+    default(:Parameters, {})[name] = options
+    @parameters[name] ||= options[:Default]
+  end
+
+  # Find parameters where the specified attribute is true then remove the attribute from the cfn template.
+  def excise_parameter_attribute!(attribute)
+    marked_parameters = []
+    @dict.fetch(:Parameters, {}).each do |param, options|
+      if options.delete(attribute.to_sym) or options.delete(attribute.to_s)
+        marked_parameters << param
+      end
+    end
+    marked_parameters
+  end
+
+  def mapping(name, options)
+    # if options is a string and a valid file then the script will process the external file.
+    default(:Mappings, {})[name] = \
+      if options.is_a?(Hash); options
+      elsif options.is_a?(String); load_from_file(options)['Mappings'][name]
+      else; raise("Options for mapping #{name} is neither a string or a hash.  Error!")
+    end
+  end
+
+  def load_from_file(filename)
+    file = File.open(filename)
+
+    begin
+      # Figure out what the file extension is and process accordingly.
+      contents = case File.extname(filename)
+        when ".rb"; eval(file.read, nil, filename)
+        when ".json"; JSON.load(file)
+        when ".yaml"; YAML::load(file)
+        else; raise("Do not recognize extension of #{filename}.")
+      end
+    ensure
+      file.close
+    end
+    contents
+  end
+
+  def excise_tags!
+    tags = @dict.fetch(:Tags, {})
+    @dict.delete(:Tags)
+    tags
+  end
+
+  def tag(tag)
+    tag.each do | name, value |
+      default(:Tags, {})[name] = value
+    end
+  end
+
+  def condition(name, options) default(:Conditions, {})[name] = options end
+
+  def resource(name, options) default(:Resources, {})[name] = options end
+
+  def output(name, options) default(:Outputs, {})[name] = options end
+
+  def find_in_map(map, key, name)
+    # Eagerly evaluate mappings when all keys are known at template expansion time
+    if map.is_a?(String) && key.is_a?(String) && name.is_a?(String)
+      # We don't know whether the map was built with string keys or symbol keys.  Try both.
+      def get(map, key) map[key] || map.fetch(key.to_sym) end
+      get(get(@dict.fetch(:Mappings).fetch(map), key), name)
+    else
+      { :'Fn::FindInMap' => [ map, key, name ] }
+    end
+  end
+end
+
+def base64(value) { :'Fn::Base64' => value } end
+
+def find_in_map(map, key, name) { :'Fn::FindInMap' => [ map, key, name ] } end
+
+def get_att(resource, attribute) { :'Fn::GetAtt' => [ resource, attribute ] } end
+
+def get_azs(region = '') { :'Fn::GetAZs' => region } end
+
+def join(delim, *list)
+  case list.length
+    when 0 then ''
+    when 1 then list[0]
+    else join_list(delim,list)
+  end
+end
+
+# Variant of join that matches the native CFN syntax.
+def join_list(delim, list) { :'Fn::Join' => [ delim, list ] } end
+
+def equal(one, two) { :'Fn::Equals' => [one, two] } end
+
+def fn_not(condition) { :'Fn::Not' => [condition] } end
+
+def fn_or(*condition_list)
+  case condition_list.length
+    when 0..1 then raise "fn_or needs at least 2 items."
+    when 2..10 then  { :'Fn::Or' => condition_list }
+    else raise "fn_or needs a list of 2-10 items that evaluate to true/false."
+  end
+end
+
+def fn_and(*condition_list)
+  case condition_list.length
+    when 0..1 then raise "fn_and needs at least 2 items."
+    when 2..10 then  { :'Fn::And' => condition_list }
+    else raise "fn_and needs a list of 2-10 items that evaluate to true/false."
+  end
+end
+
+def fn_if(cond, if_true, if_false) { :'Fn::If' => [cond, if_true, if_false] } end
+
+def not_equal(one, two) fn_not(equal(one,two)) end
+
+def select(index, list) { :'Fn::Select' => [ index, list ] } end
+
+def ref(name) { :Ref => name } end
+
+def aws_account_id() ref("AWS::AccountId") end
+
+def aws_notification_arns() ref("AWS::NotificationARNs") end
+
+def aws_no_value() ref("AWS::NoValue") end
+
+def aws_stack_id() ref("AWS::StackId") end
+
+def aws_stack_name() ref("AWS::StackName") end
+
+# deprecated, for backward compatibility
+def no_value()
+    warn_deprecated('no_value()', 'aws_no_value()')
+    aws_no_value()
+end
+
+# Read the specified file and return its value as a string literal
+def file(filename) File.read(File.absolute_path(filename, File.dirname($PROGRAM_NAME))) end
+
+# Interpolates a string like "NAME={{ref('Service')}}" and returns a CloudFormation "Fn::Join"
+# operation to collect the results.  Anything between {{ and }} is interpreted as a Ruby expression
+# and eval'd.  This is especially useful with Ruby "here" documents.
+# Local variables may also be exposed to the string via the `locals` hash.
+def interpolate(string, locals={})
+  list = []
+  while string.length > 0
+    head, match, string = string.partition(/\{\{.*?\}\}/)
+    list << head if head.length > 0
+    list << eval(match[2..-3], nil, 'interpolated string') if match.length > 0
+  end
+
+  # Split out strings in an array by newline, for visibility
+  list = list.flat_map {|value| value.is_a?(String) ? value.lines.to_a : value }
+  join('', *list)
+end
+
+def join_interpolate(delim, string)
+  $stderr.puts "join_interpolate(delim,string) has been deprecated; use interpolate(string) instead"
+  interpolate(string)
+end
+
+# This class is used by erb templates so they can access the parameters passed
+class Namespace
+  attr_accessor :params
+  def initialize(hash)
+    @params = hash
+  end
+  def get_binding
+    binding
+  end
+end
+
+# Combines the provided ERB template with optional parameters
+def erb_template(filename, params = {})
+  ERB.new(file(filename), nil, '-').result(Namespace.new(params).get_binding)
+end
+
+def warn_deprecated(old, new)
+    $stderr.puts "Warning: '#{old}' has been deprecated.  Please update your template to use '#{new}' instead."
+end

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "0.5.4"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Shawn Smith
@@ -15,65 +15,79 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby DSL library that provides a wrapper around the cfn-cmd.
+description: Ruby DSL library that provides a wrapper around the CloudFormation.
 email:
 - Shawn.Smith@bazaarvoice.com
 - Dave.Barcelo@bazaarvoice.com
@@ -88,7 +102,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,69 +124,10 @@ files:
 - initial_contributions.md
 - lib/cloudformation-ruby-dsl.rb
 - lib/cloudformation-ruby-dsl/cfntemplate.rb
+- lib/cloudformation-ruby-dsl/dsl.rb
 - lib/cloudformation-ruby-dsl/spotprice.rb
 - lib/cloudformation-ruby-dsl/table.rb
 - lib/cloudformation-ruby-dsl/version.rb
-- vendor/AWSCloudFormation-1.0.12/README.TXT
-- vendor/AWSCloudFormation-1.0.12/RELEASENOTES.TXT
-- vendor/AWSCloudFormation-1.0.12/THIRDPARTYLICENSE.TXT
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-cancel-update-stack
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-cancel-update-stack.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-cmd.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-create-stack
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-create-stack.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-delete-stack
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-delete-stack.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-events
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-events.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-resource
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-resource.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-resources
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stack-resources.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stacks
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-describe-stacks.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-get-template
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-get-template.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-list-stack-resources
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-list-stack-resources.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-list-stacks
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-list-stacks.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-update-stack
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-update-stack.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-validate-template
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-validate-template.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-version
-- vendor/AWSCloudFormation-1.0.12/bin/cfn-version.cmd
-- vendor/AWSCloudFormation-1.0.12/bin/service
-- vendor/AWSCloudFormation-1.0.12/bin/service.cmd
-- vendor/AWSCloudFormation-1.0.12/credential-file-path.template
-- vendor/AWSCloudFormation-1.0.12/lib/CliCommando-1.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/activation-1.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-cli-1.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-codec-1.3.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-discovery-0.2.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-httpclient-3.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-logging-1.0.4.jar
-- vendor/AWSCloudFormation-1.0.12/lib/commons-logging-api-1.1.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/httpclient-4.2.jar
-- vendor/AWSCloudFormation-1.0.12/lib/jaxb-api-2.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/jaxb-impl-2.0.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/jaxws-api-2.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/jdom-1.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/log4j.jar
-- vendor/AWSCloudFormation-1.0.12/lib/serializer.jar
-- vendor/AWSCloudFormation-1.0.12/lib/service.jar
-- vendor/AWSCloudFormation-1.0.12/lib/stax-api-1.0.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/wsdl4j-1.6.1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/wss4j-1.5.7.jar
-- vendor/AWSCloudFormation-1.0.12/lib/wstx-asl-3.2.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/xalan-j2-2.7.0.jar
-- vendor/AWSCloudFormation-1.0.12/lib/xfire-all-1.2.6.jar
-- vendor/AWSCloudFormation-1.0.12/lib/xfire-jsr181-api-1.0-M1.jar
-- vendor/AWSCloudFormation-1.0.12/lib/xmlsec-1.4.2.jar
-- vendor/AWSCloudFormation-1.0.12/license.txt
-- vendor/AWSCloudFormation-1.0.12/notice.txt
 homepage: http://github.com/bazaarvoice/cloudformation-ruby-dsl
 licenses: []
 metadata: {}
@@ -183,19 +138,19 @@ require_paths:
 - bin
 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby DSL library that provides a wrapper around the cfn-cmd.  Written by
-  [Bazaarvoice](http://www.bazaarvoice.com).
+summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written
+  by [Bazaarvoice](http://www.bazaarvoice.com).
 test_files: []