humidifier 2.15.0 → 3.0.0

data/lib/humidifier/resource.rb

@@ -5,14 +5,16 @@ module Humidifier
   class Resource
     # Attributes that are available to every stack
     COMMON_ATTRIBUTES =
-      Utils.underscored(%w[Condition CreationPolicy DeletionPolicy DependsOn
-                           Metadata UpdatePolicy])
+      Humidifier.underscore(
+        %w[Condition CreationPolicy DeletionPolicy DependsOn Metadata
+           UpdatePolicy]
+      )
 
     attr_accessor :properties, *COMMON_ATTRIBUTES.values
 
-    def initialize(properties = {}, raw = false)
+    def initialize(properties = {})
       self.properties = {}
-      update(properties, raw)
+      update(properties)
     end
 
     # Patches method_missing to include property accessors
@@ -49,9 +51,9 @@ module Humidifier
     end
 
     # Update a set of properties defined by the given properties hash
-    def update(properties, raw = false)
+    def update(properties)
       properties.each do |property, value|
-        update_property(property, value, raw)
+        update_property(property, value)
       end
     end
 
@@ -67,10 +69,10 @@ module Humidifier
     end
 
     # Update an individual property on this resource
-    def update_property(property, value, raw = false)
+    def update_property(property, value)
       property = property.to_s
-      property = validate_property(property, raw)
-      value = validate_value(property, value, raw)
+      property = validate_property(property)
+      value = validate_value(property, value)
       properties[property] = value
     end
 
@@ -110,9 +112,7 @@ module Humidifier
       (self.class.props.keys & [method.to_s, method.to_s[0..-2]]).any?
     end
 
-    def validate_property(property, raw)
-      property = Utils.underscore(property) if raw
-
+    def validate_property(property)
       unless self.class.prop?(property)
         raise ArgumentError, 'Attempting to set invalid property for ' \
                              "#{self.class.name}: #{property}"
@@ -121,9 +121,8 @@ module Humidifier
       property
     end
 
-    def validate_value(property, value, raw)
+    def validate_value(property, value)
       prop = self.class.props[property]
-      value = prop.convert(value) if raw
 
       unless prop.valid?(value)
         raise ArgumentError, "Invalid value for #{property}: #{value.inspect}"

data/lib/humidifier/stack.rb

@@ -3,16 +3,45 @@
 module Humidifier
   # Represents a CFN stack
   class Stack
-    # Single settings on the stack
-    STATIC_RESOURCES =
-      Utils.underscored(%w[AWSTemplateFormatVersion Description Metadata])
+    class TemplateTooLargeError < StandardError
+      def initialize(bytesize)
+        super(
+          "Cannot use a template > #{MAX_TEMPLATE_URL_SIZE} bytes " \
+          "(currently #{bytesize} bytes), consider using nested stacks " \
+          '(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide' \
+          '/aws-properties-stack.html)'
+        )
+      end
+    end
+
+    # The AWS region, can be set through the environment, defaults to us-east-1
+    AWS_REGION = ENV['AWS_REGION'] || 'us-east-1'
 
     # Lists of objects linked to the stack
     ENUMERABLE_RESOURCES =
-      Utils.underscored(%w[Conditions Mappings Outputs Parameters Resources])
+      Humidifier.underscore(
+        %w[Conditions Mappings Outputs Parameters Resources]
+      )
+
+    # The maximum size a template body can be before it has to be put somewhere
+    # and referenced through a URL
+    MAX_TEMPLATE_BODY_SIZE = 51_200
+
+    # The maximum size a template body can be inside of an S3 bucket
+    MAX_TEMPLATE_URL_SIZE = 460_800
+
+    # The maximum amount of time that Humidifier should wait for a stack to
+    # complete a CRUD operation
+    MAX_WAIT = 600
+
+    # Single settings on the stack
+    STATIC_RESOURCES =
+      Humidifier.underscore(%w[AWSTemplateFormatVersion Description Metadata])
 
     attr_accessor :id
-    attr_reader(:name, *ENUMERABLE_RESOURCES.values, *STATIC_RESOURCES.values)
+    attr_writer :client
+
+    attr_reader :name, *ENUMERABLE_RESOURCES.values, *STATIC_RESOURCES.values
 
     def initialize(opts = {})
       @name = opts[:name]
@@ -28,22 +57,38 @@ module Humidifier
       end
     end
 
-    # Add a resource to the stack and optionally set its attributes
     def add(name, resource, attributes = {})
       resources[name] = resource
       resource.update_attributes(attributes) if attributes.any?
       resource
     end
 
-    # The identifier used by the shim to find the stack in CFN, prefers id to
-    # name
+    def add_condition(name, opts = {})
+      conditions[name] = Condition.new(opts)
+    end
+
+    def add_mapping(name, opts = {})
+      mappings[name] = Mapping.new(opts)
+    end
+
+    def add_output(name, opts = {})
+      outputs[name] = Output.new(opts)
+    end
+
+    def add_parameter(name, opts = {})
+      parameters[name] = Parameter.new(opts)
+    end
+
+    def client
+      @client ||= Aws::CloudFormation::Client.new(region: AWS_REGION)
+    end
+
     def identifier
       id || name || default_identifier
     end
 
-    # A string representation of the stack that's valid for CFN
     def to_cf(serializer = :json)
-      resources = static_resources.merge(enumerable_resources)
+      resources = static_resources.merge!(enumerable_resources)
 
       case serializer
       when :json then JSON.pretty_generate(resources)
@@ -51,20 +96,75 @@ module Humidifier
       end
     end
 
-    %i[condition mapping output parameter].each do |resource_type|
-      define_method(:"add_#{resource_type}") do |name, opts = {}|
-        send(:"#{resource_type}s")[name] =
-          Humidifier.const_get(resource_type.capitalize).new(opts)
+    def create(opts = {})
+      params = { stack_name: name }.merge!(template_for(opts)).merge!(opts)
+
+      try_valid do
+        client.create_stack(params).tap { |response| @id = response.stack_id }
       end
     end
 
-    AwsShim::STACK_METHODS.each do |method|
-      define_method(method) do |opts = {}|
-        AwsShim.send(method, SdkPayload.new(self, opts))
-      end
+    def create_and_wait(opts = {})
+      perform_and_wait(:create, opts)
+    end
+
+    def create_change_set(opts = {})
+      params = {
+        stack_name: identifier,
+        change_set_name: "changeset-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
+      }
+      params.merge!(template_for(opts)).merge!(opts)
+
+      try_valid { client.create_change_set(params) }
+    end
+
+    def delete(opts = {})
+      client.delete_stack({ stack_name: identifier }.merge!(opts))
+      true
+    end
+
+    def delete_and_wait(opts = {})
+      perform_and_wait(:delete, opts)
+    end
+
+    def deploy(opts = {})
+      exists? ? update(opts) : create(opts)
+    end
+
+    def deploy_and_wait(opts = {})
+      perform_and_wait(exists? ? :update : :create, opts)
+    end
+
+    def deploy_change_set(opts = {})
+      exists? ? create_change_set(opts) : create(opts)
+    end
+
+    def exists?
+      Aws::CloudFormation::Stack.new(name: identifier).exists?
+    end
+
+    def update(opts = {})
+      params =
+        { stack_name: identifier }.merge!(template_for(opts)).merge!(opts)
+
+      try_valid { client.update_stack(params) }
+    end
+
+    def update_and_wait(opts = {})
+      perform_and_wait(:update, opts)
+    end
+
+    def upload
+      Humidifier.config.ensure_upload_configured!(identifier)
+      upload_object("#{Humidifier.config.s3_prefix}#{identifier}.json")
+    end
+
+    def valid?(opts = {})
+      params = template_for(opts).merge!(opts)
+
+      try_valid { client.validate_template(params) }
     end
 
-    # Increment the default identifier
     def self.next_default_identifier
       @count ||= 0
       @count += 1
@@ -75,9 +175,36 @@ module Humidifier
 
     attr_reader :default_identifier
 
+    def perform_and_wait(method, opts)
+      public_send(method, opts).tap do
+        signal = :"stack_#{method}_complete"
+
+        client.wait_until(signal, stack_name: identifier) do |waiter|
+          waiter.max_attempts = (opts.delete(:max_wait) || MAX_WAIT) / 5
+          waiter.delay = 5
+        end
+      end
+    end
+
+    def try_valid
+      yield || true
+    rescue Aws::CloudFormation::Errors::ValidationError => error
+      warn(error.message)
+      warn(error.backtrace)
+      false
+    end
+
+    def upload_object(key)
+      Aws.config.update(region: AWS_REGION)
+      bucket = Humidifier.config.s3_bucket
+
+      Aws::S3::Client.new.put_object(body: to_cf, bucket: bucket, key: key)
+      Aws::S3::Object.new(bucket, key).presigned_url(:get)
+    end
+
     def enumerable_resources
       ENUMERABLE_RESOURCES.each_with_object({}) do |(name, prop), list|
-        resources = send(prop)
+        resources = public_send(prop)
         next if resources.empty?
 
         list[name] =
@@ -89,9 +216,27 @@ module Humidifier
 
     def static_resources
       STATIC_RESOURCES.each_with_object({}) do |(name, prop), list|
-        resource = send(prop)
+        resource = public_send(prop)
         list[name] = resource if resource
       end
     end
+
+    def bytesize
+      to_cf.bytesize.tap do |size|
+        raise TemplateTooLargeError, size if size > MAX_TEMPLATE_URL_SIZE
+      end
+    end
+
+    def template_for(opts)
+      @template ||=
+        if opts.delete(:force_upload) ||
+           Humidifier.config.force_upload ||
+           bytesize > MAX_TEMPLATE_BODY_SIZE
+
+          { template_url: upload }
+        else
+          { template_body: to_cf }
+        end
+    end
   end
 end

data/lib/humidifier/version.rb

@@ -2,5 +2,5 @@
 
 module Humidifier
   # Gem version
-  VERSION = '2.15.0'
+  VERSION = '3.0.0'
 end

data/lib/humidifier.rb

@@ -1,41 +1,29 @@
 # frozen_string_literal: true
 
 require 'date'
-require 'forwardable'
 require 'json'
 require 'pathname'
 require 'yaml'
 
-require 'humidifier/utils'
-require 'humidifier/fn'
-require 'humidifier/ref'
-require 'humidifier/props'
-
-require 'humidifier/props/base'
+require 'aws-sdk-cloudformation'
+require 'aws-sdk-s3'
+require 'fast_underscore'
 
-prop_types = %w[boolean double integer json list map string structure timestamp]
-prop_types.each { |type| require "humidifier/props/#{type}_prop" }
-
-require 'humidifier/aws_shim'
-require 'humidifier/condition'
-require 'humidifier/configuration'
-require 'humidifier/loader'
-require 'humidifier/mapping'
-require 'humidifier/output'
-require 'humidifier/parameter'
-require 'humidifier/resource'
-require 'humidifier/sdk_payload'
-require 'humidifier/serializer'
-require 'humidifier/sleeper'
-require 'humidifier/stack'
-require 'humidifier/version'
+# Hook into the string extension and ensure it works for certain AWS acronyms
+String.prepend(
+  Module.new do
+    def underscore
+      FastUnderscore.underscore(gsub(/(ARNs|AZs|VPCs)/) { $1.capitalize })
+    end
+  end
+)
 
 # container module for all gem classes
 module Humidifier
   class << self
     # the configuration instance
     def config
-      @config ||= Configuration.new
+      @config ||= Config.new
     end
 
     # yield the config object to the block for setting user params
@@ -62,7 +50,26 @@ module Humidifier
     def [](aws_name)
       registry[aws_name]
     end
+
+    # a frozen hash of the given names mapped to their underscored version
+    def underscore(names)
+      names.map { |name| [name, name.underscore.to_sym] }.to_h.freeze
+    end
   end
 end
 
+require 'humidifier/condition'
+require 'humidifier/config'
+require 'humidifier/fn'
+require 'humidifier/loader'
+require 'humidifier/mapping'
+require 'humidifier/output'
+require 'humidifier/parameter'
+require 'humidifier/ref'
+require 'humidifier/resource'
+require 'humidifier/serializer'
+require 'humidifier/stack'
+require 'humidifier/version'
+require 'humidifier/props'
+
 Humidifier::Loader.load

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: humidifier
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Localytics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudformation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: fast_underscore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '0.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -120,37 +176,18 @@ files:
 - LICENSE
 - README.md
 - lib/humidifier.rb
-- lib/humidifier/aws_adapters/base.rb
-- lib/humidifier/aws_adapters/noop.rb
-- lib/humidifier/aws_adapters/sdkv1.rb
-- lib/humidifier/aws_adapters/sdkv2.rb
-- lib/humidifier/aws_adapters/sdkv3.rb
-- lib/humidifier/aws_shim.rb
 - lib/humidifier/condition.rb
-- lib/humidifier/configuration.rb
+- lib/humidifier/config.rb
 - lib/humidifier/fn.rb
 - lib/humidifier/loader.rb
 - lib/humidifier/mapping.rb
 - lib/humidifier/output.rb
 - lib/humidifier/parameter.rb
 - lib/humidifier/props.rb
-- lib/humidifier/props/base.rb
-- lib/humidifier/props/boolean_prop.rb
-- lib/humidifier/props/double_prop.rb
-- lib/humidifier/props/integer_prop.rb
-- lib/humidifier/props/json_prop.rb
-- lib/humidifier/props/list_prop.rb
-- lib/humidifier/props/map_prop.rb
-- lib/humidifier/props/string_prop.rb
-- lib/humidifier/props/structure_prop.rb
-- lib/humidifier/props/timestamp_prop.rb
 - lib/humidifier/ref.rb
 - lib/humidifier/resource.rb
-- lib/humidifier/sdk_payload.rb
 - lib/humidifier/serializer.rb
-- lib/humidifier/sleeper.rb
 - lib/humidifier/stack.rb
-- lib/humidifier/utils.rb
 - lib/humidifier/version.rb
 homepage: https://github.com/localytics/humidifier
 licenses:
@@ -164,15 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CloudFormation made easy

data/lib/humidifier/aws_adapters/base.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  # A container module for all adapters for the SDK
-  module AwsAdapters
-    # The parent class for the adapters for both versions of the SDK
-    class Base
-      # Create a CFN stack
-      def create(payload)
-        try_valid do
-          response = client.create_stack(payload.create_params)
-          payload.id = response.stack_id
-          response
-        end
-      end
-
-      # Delete a CFN stack
-      def delete(payload)
-        client.delete_stack(payload.delete_params)
-        true
-      end
-
-      # Update a CFN stack if it exists, otherwise create it
-      def deploy(payload)
-        exists?(payload) ? update(payload) : create(payload)
-      end
-
-      # Update a CFN stack
-      def update(payload)
-        try_valid { client.update_stack(payload.update_params) }
-      end
-
-      # Upload a CFN stack to S3 so that it can be referenced via template_url
-      def upload(payload)
-        Humidifier.config.ensure_upload_configured!(payload)
-        filename = "#{Humidifier.config.s3_prefix}#{payload.identifier}.json"
-        upload_object(payload, filename)
-      end
-
-      # Validate a template in CFN
-      def valid?(payload)
-        try_valid { client.validate_template(payload.validate_params) }
-      end
-
-      %i[create delete deploy update].each do |method|
-        define_method(:"#{method}_and_wait") do |payload|
-          perform_and_wait(method, payload)
-        end
-      end
-
-      private
-
-      def client
-        @client ||=
-          base_module::CloudFormation::Client.new(region: AwsShim::REGION)
-      end
-
-      def try_valid
-        yield || true
-      rescue base_module::CloudFormation::Errors::ValidationError => error
-        warn(error.message)
-        warn(error.backtrace)
-        false
-      end
-    end
-  end
-end

data/lib/humidifier/aws_adapters/noop.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module AwsAdapters
-    # An adapter used when neither SDK is loaded
-    class Noop
-      # Capture all STACK_METHODS method calls and warn that they will not be
-      # run
-      def method_missing(method, *)
-        if AwsShim::STACK_METHODS.include?(method)
-          puts "WARNING: Cannot run #{method} because aws-sdk not loaded."
-          false
-        else
-          super
-        end
-      end
-
-      # We capture stack methods and warn about them but don't actually respond
-      # to them
-      def respond_to_missing?(method, *)
-        AwsShim::STACK_METHODS.include?(method) ? false : super
-      end
-    end
-  end
-end