skywriter 1.0.0

data/lib/skywriter/resource_property/elastic_beanstalk/environment_tier.rb

@@ -0,0 +1,11 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticBeanstalk
+      class EnvironmentTier < Skywriter::ResourceProperty
+        property :Name
+        property :Type
+        property :Version
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_beanstalk/option_setting.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticBeanstalk
+      class OptionSetting < Skywriter::ResourceProperty
+        property :Namespace
+        property :OptionName
+        property :Value
+      end
+
+      OptionSettings = OptionSetting
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_beanstalk/source_bundle.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticBeanstalk
+      class SourceBundle < Skywriter::ResourceProperty
+        property :S3Bucket
+        property :S3Key
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_beanstalk/source_configuration.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticBeanstalk
+      class SourceConfiguration < Skywriter::ResourceProperty
+        property :ApplicationName
+        property :TemplateName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_load_balancing/app_cookie_stickiness_policy.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticLoadBalancing
+      class AppCookieStickinessPolicy < Skywriter::ResourceProperty
+        property :CookieName
+        property :PolicyName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_load_balancing/health_check.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticLoadBalancing
+      class HealthCheck < Skywriter::ResourceProperty
+        property :HealthyThreshold
+        property :Interval
+        property :Target
+        property :Timeout
+        property :UnhealthyThreshold
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_load_balancing/lb_cookie_stickiness_policy.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticLoadBalancing
+      class LBCookieStickinessPolicy < Skywriter::ResourceProperty
+        property :CookieExpirationPeriod
+        property :PolicyName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_load_balancing/listener.rb

@@ -0,0 +1,14 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticLoadBalancing
+      class Listener < Skywriter::ResourceProperty
+        property :InstancePort
+        property :InstanceProtocol
+        property :LoadBalancerPort
+        property :PolicyNames
+        property :Protocol
+        property :SSLCertificateId
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/elastic_load_balancing/policy.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module ElasticLoadBalancing
+      class Policy < Skywriter::ResourceProperty
+        property :Attributes
+        property :InstancePorts
+        property :LoadBalancerPorts
+        property :PolicyName
+        property :PolicyType
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/rds/security_group_rule.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module RDS
+      class SecurityGroupRule < Skywriter::ResourceProperty
+        property :CIDRIP
+        property :EC2SecurityGroupId
+        property :EC2SecurityGroupName
+        property :EC2SecurityGroupOwnerId
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/redshift/parameter.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module Redshift
+      class Parameter < Skywriter::ResourceProperty
+        property :ParameterName
+        property :ParameterValue
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/route53/alias_target.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module Route53
+      class AliasTarget < Skywriter::ResourceProperty
+        property :HostedZoneId
+        property :DNSName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/s3/website_configuration_policy.rb

@@ -0,0 +1,16 @@
+module Skywriter
+  class ResourceProperty
+    module S3
+      class WebsiteConfiguration < Skywriter::ResourceProperty
+        property :IndexDocument
+        property :ErrorDocument
+      end
+    end
+
+    # This attribute looks like it should be in the 'CloudFormation' namespace, but it's actually
+    # and embedded property of a resource in the 'S3' namespace
+    module CloudFormation
+      WebsiteConfiguration = ::Skywriter::ResourceProperty::S3::WebsiteConfiguration
+    end
+  end
+end

data/lib/skywriter/resource_property/sns/subscription.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module SNS
+      class Subscription < Skywriter::ResourceProperty
+        property :Endpoint
+        property :Protocol
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/sqs/redrive_policy.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module SQS
+      class RedrivePolicy < Skywriter::ResourceProperty
+        property :deadLetterTargetArn
+        property :maxReceiveCount
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property.rb

@@ -0,0 +1,57 @@
+module Skywriter
+  class ResourceProperty
+    # Declare a ResourceProperty property
+    #
+    # @param name [Symbol] The property name as it exists in the AWS documentation
+    def self.property(name)
+      property_definitions << PropertyDefinition.new(name)
+    end
+
+    # @param [Hash] options Options hash.  Valid values depend on the implementing class - see the AWS documentation
+    #   at http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-product-property-reference.html
+    #   for details
+    def initialize(options = {})
+      @options = options.freeze
+    end
+
+    # Returns a JSON-able hash representing the Resource
+    #
+    # @return [Hash] A JSON-able hash
+    #
+    def as_json(*)
+      @as_json ||= property_definitions.each_with_object({}) do |property_definition, hash|
+        if (value = property_value(property_definition))
+          hash[property_definition.name] = value
+        end
+      end
+    end
+
+    private
+
+    attr_reader :options
+
+    def self.property_definitions
+      @property_definitions ||= []
+    end
+
+    def property_value(property_definition)
+      options[property_definition.key.to_sym] ||
+        options[property_definition.key.to_s] ||
+        options[property_definition.name.to_sym] ||
+        options[property_definition.name.to_s]
+    end
+
+    def property_definitions
+      self.class.property_definitions
+    end
+  end
+
+  class PropertyDefinition
+    attr_reader :name, :key
+
+    def initialize(name)
+      @name = name.to_s
+      @key = name.to_s.underscore.to_sym
+    end
+  end
+end

data/lib/skywriter/template.rb

@@ -0,0 +1,143 @@
+module Skywriter
+  # CloudFormation Template
+  #
+  # Represents a CloudFormation template.
+  #
+  # @example
+  #   parameters = {"foo" => "bar"}
+  #   webserver = Skywriter::Resource::EC2::Instance.new('MyWebserver')
+  #   load_balancer = Skywriter::Resource::ElasticLoadBalancing::LoadBalancer.new('MyLoadBalancer')
+  #
+  #   template = Skywriter::Template.new(
+  #     description: "My Template",
+  #     parameters: parameters,
+  #     resources: [webserver, load_balancer]
+  #   )
+  #
+  #   AWS::CloudFormation.new.stacks.create('my-stack', template.to_json)
+  #
+  class Template
+    class MergeError < StandardError; end
+
+    attr_reader :format_version, :description
+    attr_reader :parameters, :mappings, :conditions, :resources, :outputs
+
+    # Constructor
+    #
+    # See the AWS Documentation for details on the meaning of these parameters:
+    # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-template.html
+    #
+    # @param format_version [String] The AWS CloudFormation template version
+    # @param description [String] The stack description
+    # @param parameters [Hash] A hash of parameters
+    # @param mappings [Hash] A hash of mappings
+    # @param conditions [Hash] A hash of condition
+    # @param resources [Hash, Array<Skywriter::Resource>] Either a hash of
+    #   resources or an array of objects whose classwhich include 
+    #   Skywriter::Resource, for example Skywriter::Resource::EC2::Instance.
+    # @param outputs [Hash] A hash of outputs
+    def initialize(options = {})
+      @format_version   = (options[:format_version] || '2010-09-09').freeze
+      @description      = options[:description].freeze
+
+      @parameters       = (access_liberally(options, :parameters) || {}).freeze
+      @mappings         = (access_liberally(options, :mappings) || {}).freeze
+      @conditions       = (access_liberally(options, :conditions) || {}).freeze
+      @resources        = resources_as_json(access_liberally(options, :resources)).freeze
+      @outputs          = (access_liberally(options, :outputs) || {}).freeze
+    end
+
+    # Returns a JSON string representing the Template
+    #
+    # @return [String] A JSON string
+    #
+    def to_json(*)
+      JSON.pretty_generate(as_json)
+    end
+
+    # Returns a hash representing the Template
+    #
+    # @return [Hash] A JSON-able hash
+    #
+    def as_json(*)
+      {
+        'FormatVersion' => format_version,
+        'Description'   => description,
+        'Parameters'    => parameters,
+        'Mappings'      => mappings,
+        'Conditions'    => conditions,
+        'Resources'     => resources,
+        'Outputs'       => outputs,
+      }.reject { |key, value| value.nil? }
+    end
+
+    def merge(other)
+      dup.merge!(other)
+    end
+
+    protected
+
+    def merge!(other)
+      raise ArgumentError, "Don't know how to merge with a #{other.class.name}" unless other.kind_of?(Template)
+
+      merge_value!(:format_version, other.format_version)
+      merge_value!(:description, other.description)
+
+      merge_hash!(:parameters, other.parameters)
+      merge_hash!(:mappings, other.mappings)
+      merge_hash!(:conditions, other.conditions)
+      merge_hash!(:resources, other.resources)
+      merge_hash!(:outputs, other.outputs)
+
+      self
+    end
+
+    private
+
+    def access_liberally(object, key)
+      object[key.to_sym] ||
+        object[key.to_s] ||
+        object[key.to_s.camelcase.to_sym] ||
+        object[key.to_s.camelcase.to_s]
+    end
+
+    def merge_value!(attribute, other_value)
+      self_value = send(attribute)
+
+      raise MergeError, "Duplicate attribute '#{attribute}' found" if self_value && (self_value != other_value)
+
+      instance_variable_set("@#{attribute}", other_value)
+    end
+
+    def merge_hash!(attribute, other_value)
+      self_value = send(attribute)
+
+      new_hash = self_value.merge(other_value) do |key, old, new|
+        raise MergeError, "Duplicate key '#{key}' found with different value in attribute '#{attribute}'" if old != new
+        old
+      end.freeze
+
+      instance_variable_set("@#{attribute}", new_hash)
+    end
+
+    def resources_as_json(resources_option = nil)
+      case resources_option
+      when Array
+        merge_disjoint_keys_and_duplicated_values(resources_option.map(&:as_json))
+      when Hash
+        resources_option.as_json
+      else
+        {}
+      end
+    end
+
+    def merge_disjoint_keys_and_duplicated_values(hashes)
+      hashes.reduce({}) do |memo, hash|
+        memo.merge(hash) do |key, old, new|
+          raise MergeError, "Duplicate key '#{key}' has different values" unless old == new
+          old
+        end
+      end
+    end
+  end
+end

data/lib/skywriter/version.rb

@@ -0,0 +1,3 @@
+module Skywriter
+  VERSION = "1.0.0"
+end

data/lib/skywriter.rb

@@ -0,0 +1,8 @@
+require "require_all"
+require "active_support/inflector"
+require "active_support/json"
+
+require_all File.expand_path('../../lib', __FILE__)
+
+module Skywriter
+end

data/skywriter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skywriter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skywriter"
+  spec.version       = Skywriter::VERSION
+  spec.authors       = ["Ryan Michael", "Ben Hamill"]
+  spec.email         = ["ryanmichael@otherinbox.com", "ben@context.io"]
+  spec.summary       = %q{Writes cloud formations}
+  spec.description   = %q{Writes AWS CloudFormation templates.}
+  spec.homepage      = "https://github.com/otherinbox/skywriter#readme"
+  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_dependency "require_all", "~> 1.3"
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "fuubar"
+end

data/spec/skywriter/function_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Skywriter::Function do
+  describe "#ref" do
+    it "returns expected value" do
+      expect(Skywriter::Function.ref('value')).to eq("Ref" => 'value')
+    end
+  end
+
+  describe "#base64" do
+    it "returns expected value" do
+      expect(Skywriter::Function.base64('value')).to eq("Fn::Base64" => 'value')
+    end
+  end
+
+  describe "#find_in_map" do
+    it "returns expected value" do
+      expect(Skywriter::Function.find_in_map("MapName", "TopLevelKey", "SecondLevelKey")).to eq(
+        "Fn::FindInMap" => ["MapName", "TopLevelKey", "SecondLevelKey"]
+      )
+    end
+  end
+
+  describe "#get_att" do
+    it "returns expected value" do
+      expect(Skywriter::Function.get_att('resource', 'attribute')).to eq(
+        "Fn::GetAtt" => ['resource', 'attribute']
+      )
+    end
+  end
+
+  describe "#get_azs" do
+    it "returns expected value" do
+      expect(Skywriter::Function.get_azs('region')).to eq("Fn::GetAZs" => "region")
+    end
+  end
+
+  describe "#join" do
+    it "returns expected value" do
+      expect(Skywriter::Function.join('delimiter', 'value1', 'value2')).to eq(
+        "Fn::Join" => ["delimiter", ['value1', 'value2']]
+      )
+    end
+  end
+
+  describe "#select" do
+    it "returns expected value" do
+      expect(Skywriter::Function.select('1', 'apples', 'grapes', 'oranges', 'mangoes')).to eq(
+        "Fn::Select" => [ "1", [ "apples", "grapes", "oranges", "mangoes" ] ]
+      )
+    end
+
+    it "converts numeric index to string" do
+      expect(Skywriter::Function.select(1, 'apples', 'grapes', 'oranges', 'mangoes')).to eq(
+        "Fn::Select" => [ "1", [ "apples", "grapes", "oranges", "mangoes" ] ]
+      )
+    end
+  end
+
+  describe "#and" do
+    it "returns expected value" do
+      expect(Skywriter::Function.and('one', 'two')).to eq(
+        "Fn::And" => ['one', 'two']
+      )
+    end
+  end
+
+  describe "#equals" do
+    it "returns expected value" do
+      expect(Skywriter::Function.equals('value_1', 'value_2')).to eq(
+        "Fn::Equals" => ["value_1", "value_2"]
+      )
+    end
+  end
+
+  describe "#if" do
+    it "returns expected value" do
+      expect(Skywriter::Function.if('condition', 'when_true', 'when_false')).to eq(
+        "Fn::If" => ['condition', 'when_true', 'when_false']
+      )
+    end
+  end
+
+  describe "#not" do
+    it "returns expected value" do
+      expect(Skywriter::Function.not('condition')).to eq(
+        "Fn::Not" => ['condition']
+      )
+    end
+  end
+
+  describe "#or" do
+    it "returns expected value" do
+      expect(Skywriter::Function.or('condition 1', 'condition 2')).to eq(
+        "Fn::Or" => ['condition 1', 'condition 2']
+      )
+    end
+  end
+end

data/spec/skywriter/resource/cloud_formation/authentication_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Skywriter::Resource::CloudFormation::Authentication do
+  it "is a Resource" do
+    expect(Skywriter::Resource::CloudFormation::Authentication.new('name')).to be_a(Skywriter::Resource)
+  end
+
+  describe "#as_json" do
+    it "allows the user to define the keyspace" do
+      resource = Skywriter::Resource::CloudFormation::Authentication.new(
+        'name',
+        Foo: {
+          access_key_id: 'some kind of key'
+        },
+        Bar: {
+          access_key_id: 'some other kind of key'
+        }
+      )
+
+      expect(resource.as_json).to eq(
+        {
+          'name' => {
+            'Type' => "AWS::CloudFormation::Authentication",
+            'Foo' => {
+              'accessKeyId' => 'some kind of key',
+            },
+            'Bar' => {
+              'accessKeyId' => 'some other kind of key',
+            },
+            'DependsOn' => [],
+          }
+        }
+      )
+    end
+  end
+end

data/spec/skywriter/resource/cloud_formation/custom_resource_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Skywriter::Resource::CloudFormation::CustomResource do
+  it "is a Resource" do
+    expect(Skywriter::Resource::CloudFormation::CustomResource.new('name')).to be_a(Skywriter::Resource)
+  end
+
+  describe "#as_json" do
+    it "allows the user to define the keyspace" do
+      resource = Skywriter::Resource::CloudFormation::CustomResource.new(
+        'name',
+        Foo: 'some foo value',
+        Bar: { 'SomeKey' => 'some value' },
+      )
+
+      expect(resource.as_json).to eq(
+        {
+          'name' => {
+            'Type' => "AWS::CloudFormation::CustomResource",
+            'Properties' => {
+              'Foo' => 'some foo value',
+              'Bar' => { 'SomeKey' => 'some value' },
+            },
+            'DependsOn' => [],
+          }
+        }
+      )
+    end
+  end
+end

data/spec/skywriter/resource/logical_name_pointer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Skywriter::Resource::LogicalNamePointer do
+  let(:resource) { double("Resource", logical_name: "logical name") }
+
+  let(:pointer) do
+    Skywriter::Resource::LogicalNamePointer.new(resource)
+  end
+
+  describe "#as_json" do
+    it "returns the logical name" do
+      expect(pointer.as_json).to eq("logical name")
+    end
+  end
+end

data/spec/skywriter/resource/ref_pointer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Skywriter::Resource::RefPointer do
+  let(:resource) { double("Resource", logical_name: "logical name") }
+
+  let(:pointer) do
+    Skywriter::Resource::RefPointer.new(resource)
+  end
+
+  describe "#as_json" do
+    it "returns Ref" do
+      expect(pointer.as_json).to eq("Ref" => "logical name")
+    end
+  end
+end

data/spec/skywriter/resource_property/ec2/security_group_rule_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Skywriter::ResourceProperty::EC2::SecurityGroupRule do
+  it "is a ResourceProperty" do
+    expect(Skywriter::ResourceProperty::EC2::SecurityGroupRule.new).to be_a(Skywriter::ResourceProperty)
+  end
+end