skywriter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6bcdd3dc26381dd3faf2f0d77d59796a1fba6e
+  data.tar.gz: c2cd5bb2a4bbdc44700a4a416becd8cc1b1e8b7b
+SHA512:
+  metadata.gz: 0956c5fd85eca4883d6e707756e5c8be094132a7f9c3cde9a660272db1e92fab98dfe502b93f550a619f52dd3e8df1b1349b32ae11f03b6cb174ece6a8c23bf7
+  data.tar.gz: bdb99f0ea00674303d8763dd81c2728575d15b7914feb41c2a797cd90532f3245793276ae47b986bdb2d3d1c4d0cfbe29b0a2eb51c7078708447d2f0278f5628

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+script:
+  - bundle exec rake

data/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 1.0.0
+
+* Initial release. - Ben Hamill, Ryan Michael, Josh Smith, Peter Whiteside

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Return Path
+
+# 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,139 @@
+# Skywriter
+[![Build Status](https://travis-ci.org/otherinbox/skywriter.png?branch=master)](https://travis-ci.org/otherinbox/skywriter)
+[![Code Climate](https://codeclimate.com/github/otherinbox/skywriter.png)](https://codeclimate.com/github/otherinbox/skywriter)
+
+Skywriter makes writing CloudFormation templates easier.
+
+Writing and, more importantly, maintaining large JSON files can be a real pain.
+Skywriter aims to alleviate some of that pain by letting you use code to
+generate the JSON and, instead, maintain a Ruby file. Defining your template in
+runnable code provides some benefits like variable assignment, that make the
+need to use CloudFormation's build-in functions superfluous (of course,
+Skywriter still has helpers for those functions, if you need them).
+
+
+## Features
+
+### Automatic Dependencies
+
+When you are creating a resource, references to other resources will be added to
+the `DependsOn` key automatically. If you have additional dependencies which
+should be included in this key, they can be declared like this:
+
+``` ruby
+Resource.new(
+  "ResourceName", 
+  additional_dependencies: ['foo', 'bar'],
+  some_property: other_resource.as_pointer,
+).as_json 
+  
+# yields:
+# { "ResourceName" => {
+#   "Parameters" => {
+#     "SomeProperty" => {"Ref" => "OtherResource"}
+#   },
+#   "DependsOn" => ["foo", "bar", "OtherResource"]
+# }}
+```
+
+See the example section below for some more concrete examples.
+
+
+## Examples
+
+This example will build a basic VPC with an Internet Gateway. It uses a pointer to reference the VpcId in the Gateway Attachment resource.
+It then creates a Cloudformation template from the resources.
+
+``` ruby
+my_vpc = Skywriter::Resource::EC2::VPC.new(
+  "myVPC", 
+  cidr_block: "10.10.0.0/16", 
+  tags: { network: "public" }
+)
+
+my_igw = Skywriter::Resource::EC2::InternetGateway.new(
+  "myInternetGateway", 
+  tags: { network: "public" }
+)
+
+my_gateway_attachment = Skywriter::Resource::EC2::VPCGatewayAttachment.new(
+  "myGatewayAttachment", 
+  vpc_id: my_vpc.as_pointer
+)
+
+Skywriter::Template.new(
+  description: "This is a test template",
+  resources: [my_vpc, my_igw, my_gateway_attachment]
+).as_json
+```
+
+Here we create an EC2 security group that is accessible on ports 80 and 22. The ec2 security group is added into the ingress for a database security group by using a pointer that references the logical name of the resource.
+The new database security group, as well as an old one that already exists in our account, are both applied to a database instance resource.
+
+``` ruby
+my_ec2_sg = Skywriter::Resource::EC2::SecurityGroup.new(
+  "ec2_security_group",
+  GroupDescription: "a security group for my ec2 instances",
+  SecurityGroupIngress: [
+    Skywriter::ResourceProperty::EC2::SecurityGroupRule.new(
+      FromPort: 80, 
+      ToPort: 80, 
+      IpProtocol: "tcp"
+    ),
+    Skywriter::ResourceProperty::EC2::SecurityGroupRule.new(
+      FromPort: 22, 
+      ToPort: 22, 
+      IpProtocol: "tcp"
+    )
+  ]
+)
+
+my_db_sg = Skywriter::Resource::RDS::DBSecurityGroup.new(
+  "database_security_group",
+  DBSecurityGroupIngress: Skywriter::ResourceProperty::RDS::SecurityGroupRule.new(
+    EC2SecurityGroupName: my_ec2_sg.as_pointer(with: :logical_name)
+  )
+)
+
+my_db = Skywriter::Resource::RDS::DBInstance.new(
+  "mysql_database",
+  allocated_storage: 5,
+  availability_zone: "us-east-1a",
+  db_name: "my_db",
+  engine: "MySQL",
+  db_security_groups: ["old_sg", my_db_sg.as_pointer]
+)
+
+
+Skywriter::Template.new(
+  resources: [my_ec2_sg, my_db_sg, my_db]
+).as_json
+```
+
+
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Make sure your Pull Request includes tests.
+1. Bonus points if your Pull Request updates `CHANGES.md` to include a summary
+   of your changes and your name like the other entries. If the last entry is
+   the last release, add a new `## Unreleased` heading.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.
+
+
+## Copyright
+
+Copyright © 2014 Return Path.
+
+This gem is distributed under the MIT License. See [LICENSE.md](LICENSE.md) for
+details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/skywriter/function.rb

@@ -0,0 +1,133 @@
+module Skywriter
+  module Function
+    # Intrinstic function 'Ref'
+    #
+    # @param logical_name The logical name of the resource or parameter you want to dereference
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.ref(logical_name)
+      { "Ref" => logical_name }
+    end
+
+    # Intrinsic function Fn::Base64
+    #
+    # @param value The string value you want to convert to Base64.
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.base64(value)
+      { "Fn::Base64" => value }
+    end
+
+    # Intrinsic function Fn::FindInMap
+    #
+    # @param map The logical name of a mapping declared in the Mappings section that contains the keys and values.
+    # @param *keys A list describing the n-th level keys to index
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.find_in_map(map, *keys)
+      { "Fn::FindInMap" => Array(map) + keys }
+    end
+
+    # Intrinsic function Fn::GetAtt
+    #
+    # @param resource_name The logical name of the resource that contains the attribute you want.
+    # @param attribute_name The name of the resource-specific attribute whose value you want.
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.get_att(resource_name, attribute_name)
+      { "Fn::GetAtt" => [resource_name, attribute_name] }
+    end
+
+    # Intrinsic function Fn::GetAZs
+    #
+    # @param region The name of the region for which you want to get the Availability Zones.
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.get_azs(region = nil)
+      { "Fn::GetAZs" => region.to_s }
+    end
+
+    # Intrinsic function Fn::Join
+    #
+    # @param sep The value you want to occur between values
+    # @param *values The values you wish to join
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.join(sep, *values)
+      { "Fn::Join" => [sep.to_s, values] }
+    end
+
+    # Intrinsic function Fn::Select
+    #
+    # @param index The index of the object to retrieve, zero-indexed
+    # @param *values The list of objects to select from
+    #
+    # @return [Hash] A hash describing the function
+    #
+    def self.select(index, *values)
+      { "Fn::Select" => [index.to_s, values] }
+    end
+
+
+    # Conditionals
+
+    # Intrinsic conditional function Fn::And
+    #
+    # @param *conditions Conditions that evaluate to true or false.
+    #
+    # @return [Hash] A hash describing the conditional function
+    #
+    def self.and(*conditions)
+      { "Fn::And" => conditions }
+    end
+
+    # Intrinsic conditional function Fn::Equals
+    #
+    # @param left A value of any type that you want to compare.
+    # @param right A value of any type that you want to compare.
+    #
+    # @return [Hash] A hash describing the conditional function
+    #
+    def self.equals(left, right)
+      { "Fn::Equals" => [left, right] }
+    end
+
+    # Intrinsic conditional function Fn::If
+    #
+    # @param condition A reference to a condition in the Conditions section
+    # @param when_true A value to be returned if the specified condition evaluates to true
+    # @param when_false A value to be returned if the specified condition evaluates to false
+    #
+    # @return [Hash] A hash describing the conditional function
+    #
+    def self.if(condition, when_true, when_false)
+      { "Fn::If" => [condition, when_true, when_false] }
+    end
+
+    # Intrinsic conditional function Fn::Not
+    #
+    # @param condition A condition such as Fn::Equals that evaluates to true or false
+    #
+    # @return [Hash] A hash describing the conditional function
+    #
+    def self.not(condition)
+      { "Fn::Not" => [condition] }
+    end
+
+    # Intrinsic conditional function Fn::Or
+    #
+    # @param *conditions Conditions that evaluate to true or false
+    #
+    # @return [Hash] A hash describing the conditional function
+    #
+    def self.or(*conditions)
+      { "Fn::Or" => conditions }
+    end
+  end
+end

data/lib/skywriter/resource/auto_scaling/auto_scaling_group.rb

@@ -0,0 +1,28 @@
+module Skywriter
+  module Resource
+    module AutoScaling
+      # AWS::AutoScaling::AutoScalingGroup Resource
+      #
+      # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html
+      #
+      class AutoScalingGroup
+        include Skywriter::Resource
+
+        property :AvailabilityZones
+        property :Cooldown
+        property :DesiredCapacity
+        property :HealthCheckGracePeriod
+        property :HealthCheckType
+        property :InstanceId
+        property :LaunchConfigurationName
+        property :LoadBalancerNames
+        property :MaxSize
+        property :MinSize
+        property :NotificationConfiguration
+        property :Tags
+        property :TerminationPolicies
+        property :VPCZoneIdentifier
+      end
+    end
+  end
+end

data/lib/skywriter/resource/auto_scaling/launch_configuration.rb

@@ -0,0 +1,28 @@
+module Skywriter
+  module Resource
+    module AutoScaling
+      # AWS::AutoScaling::LaunchConfiguration Resource
+      #
+      # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html
+      #
+      class LaunchConfiguration
+        include Skywriter::Resource
+
+        property :AssociatePublicIpAddress
+        property :BlockDeviceMappings
+        property :EbsOptimized
+        property :IamInstanceProfile
+        property :ImageId
+        property :InstanceId
+        property :InstanceMonitoring
+        property :InstanceType
+        property :KernelId
+        property :KeyName
+        property :RamDiskId
+        property :SecurityGroups
+        property :SpotPrice
+        property :UserData
+      end
+    end
+  end
+end

data/lib/skywriter/resource/auto_scaling/scaling_policy.rb

@@ -0,0 +1,18 @@
+module Skywriter
+  module Resource
+    module AutoScaling
+      # AWS::AutoScaling::ScalingPolicy Resource
+      #
+      # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html
+      #
+      class ScalingPolicy
+        include Skywriter::Resource
+
+        property :AdjustmentType
+        property :AutoScalingGroupName
+        property :Cooldown
+        property :ScalingAdjustment
+      end
+    end
+  end
+end

data/lib/skywriter/resource/auto_scaling/scheduled_action.rb

@@ -0,0 +1,21 @@
+module Skywriter
+  module Resource
+    module AutoScaling
+      # AWS::AutoScaling::ScheduledAction Resource
+      #
+      # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html
+      #
+      class ScheduledAction
+        include Skywriter::Resource
+
+        property :AutoScalingGroupName
+        property :DesiredCapacity
+        property :EndTime
+        property :MaxSize
+        property :MinSize
+        property :Recurrence
+        property :StartTime
+      end
+    end
+  end
+end

data/lib/skywriter/resource/auto_scaling/trigger.rb

@@ -0,0 +1,26 @@
+module Skywriter
+  module Resource
+    module AutoScaling
+      # AWS::AutoScaling::Trigger Resource
+      #
+      # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-trigger.html
+      #
+      class Trigger
+        include Skywriter::Resource
+
+        property :AutoScalingGroupName
+        property :BreachDuration
+        property :Dimensions
+        property :LowerBreachScaleIncrement
+        property :LowerThreshold
+        property :MetricName
+        property :Namespace
+        property :Period
+        property :Statistic
+        property :Unit
+        property :UpperBreachScaleIncrement
+        property :UpperThreshold
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_formation/authentication.rb

@@ -0,0 +1,46 @@
+module Skywriter
+  module Resource
+    module CloudFormation
+      # AWS::CloudFormation::Authentication Resource
+      #
+      class Authentication
+        include Skywriter::Resource
+
+        property :accessKeyId
+        property :buckets
+        property :password
+        property :secretKey
+        property :type
+        property :uris
+        property :username
+        property :roleName
+
+        def as_json
+          Thread.current[:skywriter_as_json_context] = self
+
+          as_json = { logical_name => { 'Type' => type } }
+
+          options.each do |top_level_key, properties|
+            as_json[logical_name][top_level_key.to_s] = properties(properties).as_json
+          end
+
+          as_json[logical_name]['DependsOn'] = all_dependencies
+
+          return as_json
+        ensure
+          Thread.current[:skywriter_as_json_context] = nil
+        end
+
+        private
+
+        def properties(properties)
+          property_definitions.each_with_object({}) do |property_definition, hash|
+            if (value = properties[property_definition.key])
+              hash[property_definition.name] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_formation/custom_resource.rb

@@ -0,0 +1,17 @@
+module Skywriter
+  module Resource
+    module CloudFormation
+      # AWS::CloudFormation::CustomResource Resource
+      #
+      class CustomResource
+        include Skywriter::Resource
+
+        private
+
+        def properties
+          @options
+        end
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_formation/stack.rb

@@ -0,0 +1,15 @@
+module Skywriter
+  module Resource
+    module CloudFormation
+      # AWS::CloudFormation::Stack Resource
+      #
+      class Stack
+        include Skywriter::Resource
+
+        property :TemplateURL
+        property :TimeoutInMinutes
+        property :Parameters
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_formation/wait_condition.rb

@@ -0,0 +1,15 @@
+module Skywriter
+  module Resource
+    module CloudFormation
+      # AWS::CloudFormation::WaitCondition Resource
+      #
+      class WaitCondition
+        include Skywriter::Resource
+
+        property :Count
+        property :Handle
+        property :Timeout
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_formation/wait_condition_handle.rb

@@ -0,0 +1,12 @@
+module Skywriter
+  module Resource
+    module CloudFormation
+      # AWS::CloudFormation::WaitConditionHandle Resource
+      #
+      class WaitConditionHandle
+        include Skywriter::Resource
+
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_front/distribution.rb

@@ -0,0 +1,13 @@
+module Skywriter
+  module Resource
+    module CloudFront
+      # AWS::CloudFront::Distribution Resource
+      #
+      class Distribution
+        include Skywriter::Resource
+
+        property :DistributionConfig
+      end
+    end
+  end
+end

data/lib/skywriter/resource/cloud_watch/alarm.rb

@@ -0,0 +1,27 @@
+module Skywriter
+  module Resource
+    module CloudWatch
+      # AWS::CloudWatch::Alarm Resource
+      #
+      class Alarm
+        include Skywriter::Resource
+
+        property :ActionsEnabled
+        property :AlarmActions
+        property :AlarmDescription
+        property :AlarmName
+        property :ComparisonOperator
+        property :Dimensions
+        property :EvaluationPeriods
+        property :InsufficientDataActions
+        property :MetricName
+        property :Namespace
+        property :OKActions
+        property :Period
+        property :Statistic
+        property :Threshold
+        property :Unit
+      end
+    end
+  end
+end

data/lib/skywriter/resource/dynamo_db/table.rb

@@ -0,0 +1,18 @@
+module Skywriter
+  module Resource
+    module DynamoDB
+      # AWS::DynamoDB::Table Resource
+      #
+      class Table
+        include Skywriter::Resource
+
+        property :AttributeDefinitions
+        property :GlobalSecondaryIndexes
+        property :KeySchema
+        property :LocalSecondaryIndexes
+        property :ProvisionedThroughput
+        property :TableName
+      end
+    end
+  end
+end

data/lib/skywriter/resource/ec2/customer_gateway.rb

@@ -0,0 +1,16 @@
+module Skywriter
+  module Resource
+    module EC2
+      # AWS::EC2::CustomerGateway Resource
+      #
+      class CustomerGateway
+        include Skywriter::Resource
+
+        property :BgpAsn
+        property :IpAddress
+        property :Tags
+        property :Type
+      end
+    end
+  end
+end