cfer-groups 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8f07f00b10f226e19fc45bed18c65da99a73a6a
+  data.tar.gz: ab8163402cd03bb5b98b24da8b60da0ea4bf2b9c
+SHA512:
+  metadata.gz: 7c2d9bcb45b4f06df1cc966d64848f0f2c5e6d10ef760aaaf6bda8ace133ea82c4dc732af833b904decb016460ca6b95b23333e55448916bb2703f8bf93a15e7
+  data.tar.gz: c23d44f46a1fa1cd3c60b2a3a8967c0ed2d3edfa778a1b60268a9fce8c4b4c0fade88bfe00630ff5bfb7e6b18656d815ae65064faa63aae2d116567fc3c5a99e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stedwards87+git@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cfer-groups.gemspec
+gemspec
+
+group :debug do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+  gem 'travis'
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sean Edwards
+
+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,9 @@
+# Cfer::Groups
+
+This project needs a lot of doc work, but you can find the basic concept in the examples directory:
+
+* `network_template.rb` defines a "resource group" which can be instantiated multiple times with different arguments. It's like a function, with some DSL sugar to establish a naming convention for related resources.
+* `vpc.rb` uses the network template to create an actual network with three subnets.
+
+Give it a try: `bundle exec cfer generate examples/vpc.rb`
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cfer/groups"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cfer-groups.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cfer/groups/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfer-groups"
+  spec.version       = Cfer::Groups::VERSION
+  spec.authors       = ["Sean Edwards"]
+  spec.email         = ["stedwards87+git@gmail.com"]
+
+  spec.summary       = %q{Cfer Groups}
+  spec.description   = %q{Cfer Groups}
+  spec.homepage      = "https://github.com/seanedwards/cfer-groups"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "cfer", ">= 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/examples/network_template.rb

@@ -0,0 +1,74 @@
+require 'cfer/groups'
+
+# A resource group is a collection of interrelated resources.
+# This example includes the basic resources to construct a simple VPC.
+# The type can be anything you'd like, but must be unique.
+# The :: syntax has no specific function, but looks like it fits in with AWS resources.
+resource_group 'Cfer::Examples::Network' do |args|
+
+  # Anything created inside the resource group has something prepended to the name.
+  # In vpc.rb we can see that this resource group is created with the name "Network"
+  # Therefore, this parameter will appear as "NetworkVpcName" in the final template.
+  #
+  # The `args` is a hash containing all of the properties that were set in vpc.rb
+  parameter :VpcName, Default: args[:VpcName]
+
+  # Naming of resources works the same way as parameters.
+  # In vpc.rb this resource will be created as `NetworkVPC`
+  resource :VPC, 'AWS::EC2::VPC' do
+    cidr_block '172.42.0.0/16'
+
+    enable_dns_support true
+    enable_dns_hostnames true
+    instance_tenancy 'default'
+
+    # The ref() function translates the name into the current scope.
+    # If we were to create two networks, say `NetworkA` and `NetworkB`,
+    # the ref() function would know to reference `NetworkAVpcName` or `NetworkBVpcName`
+    tag :Name, ref(:VpcName)
+
+    # The get_att() function also exists, and works the same way as ref()
+  end
+
+  resource :DefaultIGW, 'AWS::EC2::InternetGateway'
+
+  resource :VpcIGW, 'AWS::EC2::VPCGatewayAttachment' do
+    vpc_id ref(:VPC)
+    internet_gateway_id ref(:DefaultIGW)
+  end
+
+  resource :RouteTable, 'AWS::EC2::RouteTable' do
+    vpc_id ref(:VPC)
+  end
+
+  # args are the preferred way of getting instance-specific values into your group.
+  # They work
+  subnet_count = args[:Subnets] || 2
+  (1..subnet_count).each do |i|
+    resource "Subnet#{i}", 'AWS::EC2::Subnet' do
+      availability_zone Fn::select(i, Fn::get_azs(AWS::region))
+      cidr_block "172.42.#{i}.0/24"
+      vpc_id ref(:VPC)
+    end
+
+    resource "SRTA#{i}".to_sym, 'AWS::EC2::SubnetRouteTableAssociation' do
+      subnet_id ref("Subnet#{i}")
+      route_table_id ref(:RouteTable)
+    end
+
+    output "SubnetID#{i}", ref("Subnet#{i}")
+  end
+
+
+  # If you need a scoped name directly, you can use the name_of() function.
+  # You can see this is used in the DependsOn attribute of this resource
+  # ref(:VpcName) is actually just defined as Fn::ref(name_of(:VpcName))
+  resource :DefaultRoute, 'AWS::EC2::Route', DependsOn: [ name_of(:VpcIGW) ] do
+    route_table_id ref(:RouteTable)
+    gateway_id ref(:DefaultIGW)
+    destination_cidr_block '0.0.0.0/0'
+  end
+
+  # Outputs are named the same way. This output will appear in the template as `NetworkVpcId`
+  output :VpcId, ref(:VPC)
+end

data/examples/vpc.rb

@@ -0,0 +1,57 @@
+include_template 'network_template.rb'
+
+# This is the creation of the resource group. From this statement, cfer will generate
+# a handful of resources, with names all prefixed with `Network`.
+#
+# You can create as many instances of 'Cfer::Examples::Network' as you'd like,
+# with different names.
+resource :Network, 'Cfer::Examples::Network' do
+  vpc_name "my-network"
+  subnets 3
+
+  # Tags are applied to every resource in the group.
+  tag :Name, 'My Network'
+end
+
+# Resource groups will also insert an extra CloudFormation wait condition handle
+# into your template. It's a wait condition handle because that's the only CFN
+# resource that does nothing on its own.
+#
+# This resource has a couple of properties:
+#
+# * It depend on every resource defined inside the group, so if the resource named
+#   "Network" is finished, you know that everything inside the "Network" group is
+#   also finished.
+#
+# * It includes all of the properties that you specified in your template in the
+#   resource metadata. This has no technical value, but it makes it easier to debug
+#   your resource groups with `cfer generate`
+#
+# The custom resource for this invocation looks like this:
+#
+# "Network": {
+#   "Type": "AWS::CloudFormation::WaitConditionHandle",
+#   "Properties": {
+#   },
+#   "DependsOn": [
+#     "NetworkVPC",
+#     "NetworkDefaultIGW",
+#     "NetworkVpcIGW",
+#     "NetworkRouteTable",
+#     "NetworkSubnet1",
+#     "NetworkSRTA1",
+#     "NetworkSubnet2",
+#     "NetworkSRTA2",
+#     "NetworkSubnet3",
+#     "NetworkSRTA3",
+#     "NetworkDefaultRoute"
+#   ],
+#   "Metadata": {
+#     "Type": "Cfer::Examples::Network",
+#     "Properties": {
+#       "VpcName": "my-network",
+#       "Subnets": 3
+#     }
+#   }
+# }
+

data/lib/cfer/groups/prefabs/sg_pair.rb

@@ -0,0 +1,26 @@
+require 'cfer/groups'
+
+Cfer::Groups::Stack::resource_group 'Cfer::Prefabs::SecurityGroupPair' do |args|
+  ports = args[:Ports]
+
+  resource :ClientSG, 'AWS::EC2::SecurityGroup' do
+    group_description args[:ClientGroupDescription] if args[:ClientGroupDescription]
+    vpc_id args[:VpcId]
+  end
+
+  resource :ServerSG, 'AWS::EC2::SecurityGroup' do
+    group_description args[:ServerGroupDescription] if args[:ServerGroupDescription]
+    vpc_id args[:VpcId]
+  end
+
+  ports.each_with_index do |port, i|
+    resource "ServerSGClientIngress#{i}", 'AWS::EC2::SecurityGroupIngress' do
+      group_id ref(:ServerSG)
+      ip_protocol 'tcp'
+      from_port port
+      to_port port
+      source_security_group_id ref(:ClientSG)
+    end
+  end
+
+end

data/lib/cfer/groups/resource.rb

@@ -0,0 +1,10 @@
+module Cfer
+  module Groups
+    module Resource
+      extend Forwardable
+      attr_accessor :cfer_resource_group
+      def_delegators :cfer_resource_group, :name_of, :ref, :get_att
+    end
+  end
+end
+

data/lib/cfer/groups/resource_group.rb

@@ -0,0 +1,67 @@
+module Cfer
+  module Groups
+    module ResourceGroup
+      attr_reader :stack
+
+      def initialize(name, type, stack, **options, &block)
+        @group_name = name
+        @resource_type = type
+        options = { DependsOn: [] }.merge(options)
+
+        super name, "AWS::CloudFormation::WaitConditionHandle", stack, options do
+          self.instance_exec &block if block
+          self[:Metadata] = {
+            Type: type,
+            Properties: self[:Properties]
+          }
+        end
+
+        Docile.dsl_eval self, self[:Properties] do
+          self.instance_exec self[:Properties], &self.class.block if self.class.block
+        end
+        self[:Properties] = {}
+      end
+
+      def resource(name, type, options = {}, &block)
+        rc_name = name_of(name)
+        self[:DependsOn] << rc_name
+
+        group = self
+        rc = @stack.resource rc_name, type, options do
+          self.cfer_resource_group = group
+          self.instance_eval &block
+        end
+
+        if self[:Tags]
+          self[:Tags].each do |t|
+            rc.tag t["Key"], t["Value"]
+          end
+        end
+
+        rc
+      end
+
+      def output(name, value, options = {})
+        stack.output name_of(name), value, options
+      end
+
+      def name_of(name)
+        "#{@group_name}#{name}"
+      end
+
+      def ref(obj)
+        Cfer::Core::Functions::Fn::ref name_of(obj)
+      end
+
+      def parameter(name, options = {})
+        stack.parameter name_of(name), options
+      end
+
+      def get_att(obj, att)
+        Cfer::Core::Functions::Fn::get_att name_of(obj), att
+      end
+    end
+
+  end
+end
+

data/lib/cfer/groups/stack.rb

@@ -0,0 +1,17 @@
+module Cfer
+  module Groups
+    module Stack
+      def resource_group(type, &block)
+        Cfer::Core::Resource.extend_resource(type) do
+          class << self;
+            attr_accessor :block
+          end
+          @block = block
+          include Cfer::Groups::ResourceGroup
+        end
+      end
+      module_function :resource_group
+    end
+  end
+end
+

data/lib/cfer/groups/version.rb

@@ -0,0 +1,5 @@
+module Cfer
+  module Groups
+    VERSION = "0.1.0"
+  end
+end

data/lib/cfer/groups.rb

@@ -0,0 +1,11 @@
+require 'cfer/groups/version'
+require 'cfer/groups/stack'
+require 'cfer/groups/resource'
+require 'cfer/groups/resource_group'
+
+Cfer::Core::Stack.extend_stack do
+  include Cfer::Groups::Stack
+end
+
+Cfer::Core::Resource.include(Cfer::Groups::Resource)
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: cfer-groups
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Edwards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cfer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Cfer Groups
+email:
+- stedwards87+git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cfer-groups.gemspec
+- examples/network_template.rb
+- examples/vpc.rb
+- lib/cfer/groups.rb
+- lib/cfer/groups/prefabs/sg_pair.rb
+- lib/cfer/groups/resource.rb
+- lib/cfer/groups/resource_group.rb
+- lib/cfer/groups/stack.rb
+- lib/cfer/groups/version.rb
+homepage: https://github.com/seanedwards/cfer-groups
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Cfer Groups
+test_files: []
+has_rdoc: