skywriter 1.0.0

data/lib/skywriter/resource.rb

@@ -0,0 +1,165 @@
+module Skywriter
+  module Resource
+    module DSL
+      # Declare a Resource property
+      #
+      # @param name [Symbol] The property name as it exists in the AWS documentation
+      def property(name)
+        property_definitions << PropertyDefinition.new(name)
+      end
+
+      # A list of PropertyDefinition instances defined for this Resource
+      #
+      def property_definitions
+        @property_definitions ||= []
+      end
+
+      private
+
+      def self.extended(base)
+        type_name = base.name.gsub("Skywriter::Resource", "AWS")
+
+        base.send(:define_method, :type) do 
+          type_name
+        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
+
+    attr_reader :logical_name
+
+    # @param [String] logical_name The logical name of this Resource.  Will be
+    #   used as the hash key in the 'Resources' hash
+    # @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-template-resource-type-ref.html
+    #   for details. Additionally, you can pass `:additional_dependencies` as
+    #   described in the README. And `:deletion_policy`, `:metadata` and
+    #   `:update_policy`.
+    #
+    def initialize(logical_name, options = {})
+      @logical_name = logical_name
+
+      @additional_dependencies = Set.new(Array(delete_liberally(options, :additional_dependencies)))
+      @deletion_policy = delete_liberally(options, :deletion_policy)
+      @metadata = delete_liberally(options, :metadata)
+      @update_policy = delete_liberally(options, :update_policy)
+
+      @options = options.freeze
+    end
+
+    # Returns a hash representing the Resource
+    #
+    # @return [Hash] A JSON-able hash
+    #
+    def as_json(*)
+      Thread.current[:skywriter_as_json_context] = self
+
+      { logical_name =>
+        {
+          'Type' => type,
+          'Properties' => properties.as_json,
+          'DependsOn' => all_dependencies,
+          'Metadata' => metadata,
+          'DeletionPolicy' => deletion_policy,
+          'UpdatePolicy' => update_policy,
+        }.reject { |key, value| value.nil? }
+      }
+    ensure
+      Thread.current[:skywriter_as_json_context] = nil
+    end
+
+    # Returns a pointer to this Resource
+    #
+    # Pointers represent references to resources defined elsewhere in
+    # a template.  In most cases pointers serialize to something like
+    #
+    # @example
+    #   { "Ref" => "logical_name" }
+    #
+    # In some cases, you might need to refer to a resource using its
+    # logical name directly (as opposed to nested in a hash as shown),
+    # in which case you can tell `as_pointer` to point with the resource's
+    # logical name:
+    #
+    # @example
+    #   resource.as_pointer(with: :logical_name)
+    #
+    # @param with [:ref, :logical_name] How this pointer should be 
+    #   rendered in JSON.  Use `:ref` to generate {"Ref": "foo"},
+    #   and `:logical_name` to generate "foo"
+    #
+    # @return [Skywriter::Resource::Pointer] A pointer to this resource
+    #
+    def as_pointer(options = {})
+      with = options[:with] || :ref
+      case with
+      when :ref
+        Skywriter::Resource::RefPointer.new(self)
+      when :logical_name
+        Skywriter::Resource::LogicalNamePointer.new(self)
+      else
+        raise ArgumentError, "Unrecognized 'with' value '#{with}'"
+      end
+    end
+
+    # @api private
+    #
+    # @param dependency [Skywriter::Resource] A Resource upon which this resource depends.
+    #
+    def register_dependency(dependency)
+      magical_dependencies << dependency.logical_name
+    end
+
+    private
+
+    attr_reader :options, :additional_dependencies, :deletion_policy, :metadata,
+      :update_policy
+
+    def self.included(base)
+      base.extend(DSL)
+    end
+
+    def all_dependencies
+      (additional_dependencies + magical_dependencies).to_a
+    end
+
+    def delete_liberally(hash, key)
+      hash.delete(key.to_sym) ||
+        hash.delete(key.to_s) ||
+        hash.delete(key.to_s.camelcase) ||
+        hash.delete(key.to_s.camelcase.to_sym)
+    end
+
+    def magical_dependencies
+      @magical_dependencies ||= Set.new
+    end
+
+    def properties
+      @properties ||= property_definitions.each_with_object({}) do |property_definition, hash|
+        if (value = property_value(property_definition))
+          hash[property_definition.name] = value
+        end
+      end
+    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
+end

data/lib/skywriter/resource_property/README.md

@@ -0,0 +1,64 @@
+# ResourceProperty Conversions
+
+The AWS CloudFormation documentation uses inconsistent naming conventions
+for Resource Properties.  We've attempted to normalize these names, and have 
+provided the following mapping for reference.
+
+Amazon Name | Skywalker Class | Naming Comments 
+----------- | --------------- | --------------- 
+AWS CloudFormation AutoScaling Block Device Mapping Property Type | |
+AWS CloudFormation AutoScaling EBS Block Device Property Type | |
+Auto Scaling NotificationConfiguration Property Type | |
+Auto Scaling Tags Property Type | |
+CloudFormation Stack Parameters Property Type | |
+CloudFront CacheBehavior Type | |
+CloudFront ForwardedValues Type | |
+CloudFront CustomOrigin Type | *::CloudFront::CustomOrigin | dropped 'Type' 
+CloudFront DefaultCacheBehavior Type | *::CloudFront::DefaultCacheBehavior | dropped 'Type' 
+CloudFront DistributionConfig Type | *::CloudFront::DistributionConfig | dropped 'Type' 
+CloudFront Logging Type | *::CloudFront::Logging | dropped 'Type' 
+CloudFront Origin Type | *::CloudFront::Origin | dropped 'Type' 
+CloudFront S3Origin Type | *::CloudFront::S3Origin | dropped 'Type' 
+CloudWatch Metric Dimension Property Type | *::CloudWatch::MetricDimension | dropped 'Property Type' 
+DynamoDB Attribute Definitions | *::DynamoDB::AttributeDefinition | 
+DynamoDB Global Secondary Indexes | *::DynamoDB::GlobalSecondaryIndex | made singular 
+DynamoDB Key Schema | *::DynamoDB::KeySchema | 
+DynamoDB Local Secondary Indexes | *::DynamoDB::LocalSecondaryIndex | made singular 
+DynamoDB Projection Object | *::DynamoDB::Projection | dropped 'Object' 
+DynamoDB Provisioned Throughput | *::DynamoDB::ProvisionedThroughput | 
+AWS CloudFormation EC2 Block Device Mapping Property Type | *::EC2::BlockDeviceMapping | dropped 'Type' 
+AWS CloudFormation EC2 Block Device Property Type | *::EC2::EBSBlockDevice | dropped 'Type' 
+EC2 ICMP Property Type | *::EC2::ICMP | dropped 'Type' 
+EC2 MountPoint Property Type | *::EC2::MountPoint | dropped 'Type' 
+EC2 NetworkInterface Embedded Property Type | *::EC2::NetworkInterface | dropped 'Type' 
+EC2 Network Interface Association | *::EC2::NetworkInterfaceAssociation | 
+EC2 Network Interface Attachment | *::EC2::NetworkInterfaceAttachment | 
+EC2 Network Interface Group Item | *::EC2::NetworkInterfaceGroupItem | 
+EC2 Network Interface Private IP Specification | *::EC2::NetworkInterfacePrivateIPSpecification | 
+EC2 PortRange Property Type | *::EC2::PortRange | dropped 'Type' 
+EC2 Security Group Rule Property Type | *::EC2::SecurityGroupRule | dropped 'Type' 
+EC2 Tag | *::EC2::Tag | 
+AWS Elastic Beanstalk Environment Tier Property Type | *::ElasticBeanstalk::EnvironmentTier | dropped 'Property Type' 
+AWS Elastic Beanstalk OptionSettings Property Type | *::ElasticBeanstalk::OptionSetting | dropped 'Property Type', made singular
+AWS Elastic Beanstalk SourceBundle Property Type | *::ElasticBeanstalk::SourceBundle | dropped 'Property Type' 
+AWS Elastic Beanstalk SourceConfiguration Property Type | *::ElasticBeanstalk::SourceConfiguration | dropped 'Property Type' 
+ElasticLoadBalancing AppCookieStickinessPolicy Type | *::ElasticLoadBalancing::AppCookieStickinessPolicy | dropped 'Type' 
+ElasticLoadBalancing HealthCheck Type | *::ElasticLoadBalancing::HealthCheck | dropped 'Type' 
+ElasticLoadBalancing LBCookieStickinessPolicy Type | *::ElasticLoadBalancing::LBCookieStickinessPolicy | dropped 'Type' 
+ElasticLoadBalancing Listener Property Type | *::ElasticLoadBalancing::Listener | dropped 'Property Type' 
+ElasticLoadBalancing Policy Type | *::ElasticLoadBalancing::Policy | dropped 'Type' 
+Name Type | | 
+Amazon Redshift Parameter Type | *::Redshift::Parameter | dropped 'Type' 
+AWS CloudFormation Resource Tags Type | *::CloudFormation::ResourceTag | dropped 'Type', made singular
+RDS Security Group Rule | *::RDS::SecurityGroupRule | 
+Route 53 AliasTarget Property Type | *::Route53::AliasTarget | dropped 'Property Type' 
+AWS CloudFormation Website Configuration Property Type | *::S3::WebsiteConfiguration | dropped 'Property Type', inferred namespace 
+SNS Subscription Property Type | *::SNS::Subscription | dropped 'Property Type' 
+Amazon SQS RedrivePolicy | *::SQS::RedrivePolicy | 
+
+In general, Resource Property names have been stripped of `Type`, `Property Type` and 
+'Embedded Property Type', and product namespaces (ie `SQS`, `ElasticLoadBalancing`) 
+have been inferred from the documentation where possible.  When a type is called out 
+as being an 'embedded property' of namespaced resource, that namespace has been adopted for
+the Resource Property. In some cases plural forms have been made singular (where the 
+entity being described is singular).

data/lib/skywriter/resource_property/auto_scaling/block_device_mapping.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module AutoScaling
+      class BlockDeviceMapping < Skywriter::ResourceProperty
+        property :DeviceName
+        property :Ebs
+        property :NoDevice
+        property :VirtualName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/auto_scaling/ebs_block_device.rb

@@ -0,0 +1,17 @@
+module Skywriter
+  class ResourceProperty
+    module AutoScaling
+      class EBSBlockDevice < Skywriter::ResourceProperty
+        property :DeleteOnTermination
+        property :Iops
+        property :SnapshotId
+        property :VolumeSize
+        property :VolumeType
+      end
+
+    BlockDevice = EBSBlockDevice
+
+    end
+  end
+end
+

data/lib/skywriter/resource_property/auto_scaling/notification_configuration.rb

@@ -0,0 +1,11 @@
+module Skywriter
+  class ResourceProperty
+    module AutoScaling
+      class NotificationConfiguration < Skywriter::ResourceProperty
+        property :TopicARN
+        property :NotificationTypes
+      end
+    end
+  end
+end
+

data/lib/skywriter/resource_property/auto_scaling/tag.rb

@@ -0,0 +1,15 @@
+module Skywriter
+  class ResourceProperty
+    module AutoScaling
+      class Tag < Skywriter::ResourceProperty
+        property :Key
+        property :Value
+        property :PropagateAtLaunch
+      end
+
+    Tags = Tag
+
+    end
+  end
+end
+

data/lib/skywriter/resource_property/cloud_formation/resource_tag.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFormation
+      class ResourceTag < Skywriter::ResourceProperty
+        property :Key
+        property :Value
+      end
+
+      ResourceTags = ResourceTag
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/cache_behavior.rb

@@ -0,0 +1,14 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class CacheBehavior < Skywriter::ResourceProperty
+        property :TargetOriginId
+        property :ForwardedValues
+        property :TrustedSigners
+        property :ViewerProtocolPolicy
+        property :MinTTL
+        property :PathPattern
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/custom_origin.rb

@@ -0,0 +1,11 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class CustomOrigin < Skywriter::ResourceProperty
+        property :HTTPPort
+        property :HTTPSPort
+        property :OriginProtocolPolicy
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/default_cache_behavior.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class DefaultCacheBehavior < Skywriter::ResourceProperty
+        property :TargetOriginId
+        property :ForwardedValues
+        property :TrustedSigners
+        property :ViewerProtocolPolicy
+        property :MinTTL
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/distribution_config.rb

@@ -0,0 +1,16 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+     class DistributionConfig < Skywriter::ResourceProperty
+        property :Aliases
+        property :CacheBehaviors
+        property :Comment
+        property :DefaultCacheBehavior
+        property :DefaultRootObject
+        property :Enabled
+        property :Logging
+        property :Origins
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/forwarded_value.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class ForwardedValue < Skywriter::ResourceProperty
+        property :QueryString
+      end
+
+    ForwardedValues = ForwardedValue
+
+    end
+  end
+end
+

data/lib/skywriter/resource_property/cloud_front/logging.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class Logging < Skywriter::ResourceProperty
+        property :Bucket
+        property :Prefix
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/origin.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class Origin < Skywriter::ResourceProperty
+        property :DomainName
+        property :Id
+        property :S3OriginConfig
+        property :CustomOriginConfig
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_front/s3_origin.rb

@@ -0,0 +1,9 @@
+module Skywriter
+  class ResourceProperty
+    module CloudFront
+      class S3Origin < Skywriter::ResourceProperty
+        property :OriginAccessIdentity
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/cloud_watch/metric_dimension.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module CloudWatch
+      class MetricDimension < Skywriter::ResourceProperty
+        property :Name
+        property :Value
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/attribute_definition.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class AttributeDefinition < Skywriter::ResourceProperty
+        property :AttributeName
+        property :AttributeType
+      end
+
+      AttributeDefinitions = AttributeDefinition
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/global_secondary_index.rb

@@ -0,0 +1,14 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class GlobalSecondaryIndex < Skywriter::ResourceProperty
+        property :IndexName
+        property :KeySchema
+        property :Projection
+        property :ProvisionedThroughput
+      end
+
+      GlobalSecondaryIndexes = GlobalSecondaryIndex
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/key_schema.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class KeySchema < Skywriter::ResourceProperty
+        property :AttributeName
+        property :KeyType
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/local_secondary_index.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class LocalSecondaryIndex < Skywriter::ResourceProperty
+        property :IndexName
+        property :KeySchema
+        property :Projection
+      end
+
+      LocalSecondaryIndexes = LocalSecondaryIndex
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/projection.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class Projection < Skywriter::ResourceProperty
+        property :NonKeyAttributes
+        property :ProjectionType
+      end
+
+      ProjectionObject = Projection
+    end
+  end
+end

data/lib/skywriter/resource_property/dynamo_db/provisioned_throughput.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module DynamoDB
+      class ProvisionedThroughput < Skywriter::ResourceProperty
+        property :ReadCapacityUnits
+        property :WriteCapacityUnits
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/block_device_mapping.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class BlockDeviceMapping < Skywriter::ResourceProperty
+        property :DeviceName
+        property :Ebs
+        property :NoDevice
+        property :VirtualName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/ebs_block_device.rb

@@ -0,0 +1,15 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class EBSBlockDevice < Skywriter::ResourceProperty
+        property :DeleteOnTermination
+        property :Iops
+        property :SnapshotId
+        property :VolumeSize
+        property :VolumeType
+      end
+
+      BlockDevice = EBSBlockDevice
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/icmp.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class ICMP < Skywriter::ResourceProperty
+        property :Code
+        property :Type
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/mount_point.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class MountPoint < Skywriter::ResourceProperty
+        property :Device
+        property :VolumeId
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/network_interface.rb

@@ -0,0 +1,18 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class NetworkInterface < Skywriter::ResourceProperty
+        property :AssociatePublicIpAddress
+        property :DeleteOnTermination
+        property :Description
+        property :DeviceIndex
+        property :GroupSet
+        property :NetworkInterfaceId
+        property :PrivateIpAddress
+        property :PrivateIpAddresses
+        property :SecondaryPrivateIpAddressCount
+        property :SubnetId
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/network_interface_association.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class NetworkInterfaceAssociation < Skywriter::ResourceProperty
+        property :AttachmentID
+        property :InstanceID
+        property :PublicIp
+        property :IpOwnerId
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/network_interface_attachment.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class NetworkInterfaceAttachment < Skywriter::ResourceProperty
+        property :AttachmentID
+        property :InstanceID
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/network_interface_group_item.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class NetworkInterfaceGroupItem < Skywriter::ResourceProperty
+        property :GroupId
+        property :GroupName
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/network_interface_private_ip_specification.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class NetworkInterfacePrivateIPSpecification < Skywriter::ResourceProperty
+        property :PrivateIpAddress
+        property :Primary
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/port_range.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class PortRange < Skywriter::ResourceProperty
+        property :From
+        property :To
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class SecurityGroupRule < Skywriter::ResourceProperty
+        property :FromPort
+        property :ToPort
+        property :IpProtocol
+        property :CidrIp
+      end
+    end
+  end
+end

data/lib/skywriter/resource_property/ec2/tag.rb

@@ -0,0 +1,10 @@
+module Skywriter
+  class ResourceProperty
+    module EC2
+      class Tag < Skywriter::ResourceProperty
+        property :Key
+        property :Value
+      end
+    end
+  end
+end