genome 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6cc6d10ee7b5ba25627f3d129a6743478c18df27f21909a0ca8a753dbc91a94
+  data.tar.gz: d3254e10ad2679ab940d14a5d03e1644d0fbe2b73b9bfc002e26c6ea817126ad
+SHA512:
+  metadata.gz: d60d317c8ab65fa464b903ec95ad115825061dbaf341736e9cf096690962a3c30ad79037b6f7454abfcf4dd86580d5bdf75e468e9f08772be85f2c25a20d6df6
+  data.tar.gz: 5e0078157a938c7e0838a4bf4abe8c41058e2d0d79cdfcff701c4955a32b87dd94173473c314f5b5db8eee0e245eba5b72ea40925323f2cd15379e93b47531ac

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+
+/*.env
+
+# rspec failure tracking
+.rspec_status
+tmp/
+
+.rubocop-http*
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

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

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 hypernova2002@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in genome.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 hypernova2002
+
+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,110 @@
+# Genome
+
+A library for create and maintaining cloud formation stacks using a simple dsl. Remove all the complications of networking, security groups and iam roles for faster development and better security.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'genome'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install genome
+
+## Usage
+
+### Resources
+
+For a quick start setting up a stack, you can use the built in resources. Simply create a stack class, which includes a resource and then build your stack. This recommended only for testing, as the resources may be updated, causing your stack to change.
+
+```ruby
+require_relative 'lib/genome/resources/documentdb'
+require_relative 'lib/genome/stack'
+
+class TestStack
+  include Genome::Stack
+
+  stack_name :testing
+
+  resource Genome::Resources::DocumentDB
+
+end
+
+TestStack.build
+```
+
+Alternatively, you can inherit a resource in order to configure the resource for your needs, without having to build from scratch. The following prevents a new vpc and subnets from being created, so you can configure DocumentDB to use your existing subnets.
+
+```ruby
+require_relative 'lib/genome/resources/documentdb'
+require_relative 'lib/genome/stack'
+
+class MyResource < Genome::Resources::DocumentDB
+  disable_vpc
+  disable_subnets
+
+  subnet_ids [
+    'subnet-1',
+    'subnet-2',
+    'subnet-3'
+  ]
+end
+
+
+class TestStack
+  include Genome::Stack
+
+  stack_name :testing
+
+  resource MyResource
+
+end
+
+TestStack.build
+```
+
+For production environments we recommend that you configure your own resources, to ensure that templates never change. It's generally better to use existing resources for testing.
+
+### Templates
+
+Templates define the core configuration needed to generate a basic AWS resource, such as an ec2_instance. Resources can configure a set of templates and define dependency chains for each template. The following creates a basic SQS Queue with a security group
+
+```ruby
+require_relative '../resource'
+require_relative '../core/templates/ec2_security_group'
+require_relative '../core/templates/sqs_queue'
+
+class SQSQueue
+  include Resource
+
+  template :SQSSecurityGroup, Genome::Core::Templates::EC2SecurityGroup,
+    GroupDescription: 'Security Group for SQS'
+
+  template :SQSQueue, Genome::Core::Templates::SQSQueue,
+    QueueName: 'default_queue',
+    DependsOn: [ :SQSSecurityGroup ]
+
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hypernova2002/genome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 'genome'
+
+# 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(__FILE__)

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/genome.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'genome/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'genome'
+  spec.version       = Genome::VERSION
+  spec.authors       = ['hypernova2002']
+  spec.email         = ['hypernova2002@gmail.com']
+
+  spec.summary       = %q{A library for create and maintaining cloud formation stacks}
+  spec.description   = %q{A library for create and maintaining cloud formation stacks}
+  spec.homepage      = 'https://github.com/hypernova2002/genome'
+  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'] = 'https://rubygems.org'
+  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_dependency 'aws-sdk-cloudformation', '~> 1.8'
+  spec.add_dependency 'activesupport', '~> 5.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  # TODO: Remove foreman
+  spec.add_development_dependency 'foreman'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/genome/builder.rb

@@ -0,0 +1,102 @@
+require_relative 'config'
+require_relative 'resource'
+
+module Genome
+  module Builder
+    module_function
+
+    def self.template(resource)
+      resources = {}
+
+      resource.templates.each do |template_name, template|
+        parameters = evaluate_parameters(template[:parameters])
+
+        dependencies = template[:dependencies]
+
+        resource_template = template[:klass].new(template_name, parameters, dependencies)
+
+        resources.merge!(resource_template.to_h)
+      end
+
+      generate_document(resources: resources, description: resource.description)
+    end
+
+    def self.generate_document(metadata: {}, description: nil, resources: {}, parameters: {}, outputs: {})
+      {
+        AWSTemplateFormatVersion: Config.config[:AWSTemplateFormatVersion],
+        Description: [Config::DESCRIPTION_PREFIX, description].compact.join(''),
+        Metadata: metadata,
+        Resources: resources,
+        Parameters: parameters,
+        Outputs: outputs
+      }
+    end
+
+    def self.evaluate_parameters(parameters)
+      # TODO: convert classes and helper functions into appropriate parameters
+      processed_parameters = {}
+
+      parameters.each do |parameter_name, parameter_value|
+        processed_parameters[parameter_name] = evaluate_parameter_value(parameter_value)
+      end
+
+      processed_parameters
+    end
+
+    def self.evaluate_parameter_value(parameter_value)
+        case parameter_value
+        when Array
+          parameter_value.map do |single_parameter_value|
+            evaluate_parameter_value(single_parameter_value)
+          end
+        when Genome::Reference
+          { Ref: parameter_value.reference_name }
+        else
+          parameter_value
+        end
+    end
+
+    # def generate_template
+    #   resources_config = {}
+
+    #   resources = generate_resources
+
+    #   templates.each do |build_name, config|
+    #     params = evaluate_params(config[:params], resources)
+
+    #     resources[build_name].set_properties(params)
+
+    #     resources_config.merge!(resources[build_name].config)
+    #   end
+
+    #   {
+    #     AWSTemplateFormatVersion: '2010-09-09',
+    #     Metadata: {},
+    #     Resources: resources_config,
+    #     Parameters: generate_parameters,
+    #     Outputs: generate_outputs
+    #   }
+    # end
+
+    # def generate_parameters
+    #   Hash[parameters.map do |parameter_name, config|
+    #     [parameter_name, config[:klass].new(config[:params]).config]
+    #   end]
+    # end
+
+    # def generate_resources
+    #   Hash[templates.map do |build_name, config|
+    #     [build_name, config[:klass].new(build_name)]
+    #   end]
+    # end
+
+    # def generate_outputs
+    #   Hash[outputs.map do |output_name, klass|
+    #     [output_name, klass.new.config]
+    #   end]
+    # end
+
+    # def klass
+    # end
+  end
+end

data/lib/genome/config.rb

@@ -0,0 +1,25 @@
+module Genome
+  module Config
+    module_function
+
+    DESCRIPTION_PREFIX = 'Maintained by Genome: '.freeze
+
+    def self.config
+      @@configuration ||= default_config
+    end
+
+    def self.configure
+      @@configuration ||= default_config
+
+      yield @@configuration if block_given?
+
+      @@configuration
+    end
+
+    def self.default_config
+      {
+        AWSTemplateFormatVersion: '2010-09-09'
+      }
+    end
+  end
+end

data/lib/genome/core/helpers/property.rb

@@ -0,0 +1,32 @@
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+require_relative 'property_config'
+require_relative '../../error'
+
+module Genome
+  module Core
+    module Helpers
+      module Property
+        extend ActiveSupport::Concern
+
+        included do
+          class_attribute :property_configs, default: {}
+        end
+
+        module ClassMethods
+          def property(property_name, property_options = {})
+            raise Error::DuplicateProperty, "Property already defined '#{property_name}'" if self.property_configs.key?(property_name)
+
+            property_configs[property_name] = PropertyConfig.new(property_options)
+          end
+
+          def valid_property?(property_name, property_value)
+            property_configs[property_name].valid?(property_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genome/core/helpers/property_config.rb

@@ -0,0 +1,31 @@
+module Genome
+  module Core
+    module Helpers
+      class PropertyConfig
+        attr_reader :settable, :nullable
+
+        def initialize(options = {})
+          @settable = options[:settable]
+          @nullable = options[:nullable]
+        end
+
+
+        def valid?(property_value)
+          return false if !nullable && property_value == nil
+
+          true
+        end
+
+        def to_h
+          {
+            settable: settable,
+            nullable: nullable
+          }
+        end
+
+        alias :settable? :settable
+        alias :nullable? :nullable
+      end
+    end
+  end
+end

data/lib/genome/core/helpers/template.rb

@@ -0,0 +1,45 @@
+require 'active_support/concern'
+
+module Genome
+  module Core
+    module Helpers
+      module Template
+        extend ActiveSupport::Concern
+
+        attr_reader :template_name, :parameters, :dependencies
+
+        def initialize(template_name, template_parameters, dependencies)
+          @template_name = template_name
+          @parameters = {}
+          @dependencies = dependencies || []
+
+          template_parameters.each do |parameter_name, parameter_value|
+            if property_configs.key?(parameter_name)
+              @parameters[parameter_name] = parameter_value
+            end
+          end
+        end
+
+        def to_h
+          {
+            template_name => {
+              Type: self.class.aws_template,
+              Properties: parameters,
+              DependsOn: dependencies
+            }
+          }
+        end
+
+        module ClassMethods
+          def aws_template(aws_template_value = nil)
+            if aws_template_value
+              @aws_template = aws_template_value
+            else
+              @aws_template
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genome/core/templates/base.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+
+require_relative '../helpers/template'
+require_relative '../helpers/property'
+
+module Genome
+  module Core
+    module Templates
+      module Base
+        extend ActiveSupport::Concern
+
+        included do
+          include Helpers::Property
+          include Helpers::Template
+        end
+      end
+    end
+  end
+end

data/lib/genome/core/templates/documentdb_cluster.rb

@@ -0,0 +1,30 @@
+require_relative 'base'
+
+module Genome
+  module Core
+    module Templates
+      class DocumentDBCluster
+        include Base
+
+        aws_template 'AWS::DocDB::DBCluster'
+
+        property :AvailabilityZones
+        property :BackupRetentionPeriod
+        property :DBClusterIdentifier
+        property :DBClusterParameterGroupName
+        property :DBSubnetGroupName
+        property :EngineVersion
+        property :KmsKeyId
+        property :MasterUsername
+        property :MasterUserPassword
+        property :Port
+        property :PreferredBackupWindow
+        property :PreferredMaintenanceWindow
+        property :SnapshotIdentifier
+        property :StorageEncrypted
+        property :Tags
+        property :VpcSecurityGroupIds
+      end
+    end
+  end
+end

data/lib/genome/core/templates/documentdb_instance.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Genome
+  module Core
+    module Templates
+      class DocumentDBInstance
+        include Base
+
+        aws_template 'AWS::DocDB::DBInstance'
+
+        property :AutoMinorVersionUpgrade
+        property :AvailabilityZone
+        property :DBClusterIdentifier
+        property :DBInstanceClass
+        property :DBInstanceIdentifier
+        property :PreferredMaintenanceWindow
+        property :Tags
+      end
+    end
+  end
+end

data/lib/genome/core/templates/documentdb_parameter_group.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module Genome
+  module Core
+    module Templates
+      class DocumentDBParameterGroup
+        include Base
+
+        aws_template 'AWS::DocDB::DBClusterParameterGroup'
+
+        property :Description
+        property :Family
+        property :Name
+        property :Parameters
+        property :Tags
+      end
+    end
+  end
+end

data/lib/genome/core/templates/documentdb_subnet_group.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module Genome
+  module Core
+    module Templates
+      class DocumentDBSubnetGroup
+        include Base
+
+        aws_template 'AWS::DocDB::DBSubnetGroup'
+
+        property :DBSubnetGroupDescription
+        property :DBSubnetGroupName
+        property :SubnetIds
+        property :Tags
+      end
+    end
+  end
+end