humidifier 2.15.0 → 3.0.0

data/lib/humidifier/aws_adapters/sdkv1.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module AwsAdapters
-    # The adapter for v1 of aws-sdk
-    class SDKV1 < Base
-      # Cannot create change sets in V1
-      def create_change_set(*)
-        unsupported('create change set')
-      end
-
-      # Cannot deploy change sets in V1
-      def deploy_change_set(*)
-        unsupported('deploy change set')
-      end
-
-      # True if the stack exists in CFN
-      def exists?(payload)
-        base_module::CloudFormation::Stack.new(payload.identifier).exists?
-      end
-
-      private
-
-      def base_module
-        AWS
-      end
-
-      def failure_event_filtered?(event)
-        !event.resource_status.include?('FAILED') ||
-          !event.key?(:resource_status_reason)
-      end
-
-      def handle_failure(payload)
-        reasons = []
-        response = client.describe_stack_events(stack_name: payload.identifier)
-
-        response.stack_events.each do |event|
-          next if failure_event_filtered?(event)
-
-          reasons.unshift(event.resource_status_reason)
-        end
-
-        raise "#{payload.name} stack failed:\n#{reasons.join("\n")}"
-      end
-
-      def perform_and_wait(method, payload)
-        response = public_send(method, payload)
-
-        aws_stack = nil
-        Sleeper.new(payload.max_wait) do
-          response = client.describe_stacks(stack_name: payload.identifier)
-          aws_stack = response.stacks.first
-          !aws_stack.stack_status.end_with?('IN_PROGRESS')
-        end
-
-        handle_failure(payload) if aws_stack.stack_status =~ /(FAILED|ROLLBACK)/
-        response
-      end
-
-      def upload_object(payload, key)
-        base_module.config(region: AwsShim::REGION)
-        @s3 ||= base_module::S3.new
-
-        objects = @s3.buckets[Humidifier.config.s3_bucket].objects
-        objects.create(key, payload.template_body).url_for(:read)
-      end
-
-      def unsupported(method)
-        puts "WARNING: Cannot #{method} because that functionality is not " \
-             'supported in V1 of aws-sdk.'
-        false
-      end
-    end
-  end
-end

data/lib/humidifier/aws_adapters/sdkv2.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module AwsAdapters
-    # The adapter for v2 of aws-sdk
-    class SDKV2 < Base
-      # Format of the timestamp used in changeset naming
-      TIME_FORMAT = '%Y-%m-%d-%H-%M-%S'
-
-      # Create a change set in CFN
-      def create_change_set(payload)
-        change_set_name = "changeset-#{Time.now.strftime(TIME_FORMAT)}"
-        payload.merge(change_set_name: change_set_name)
-        try_valid { client.create_change_set(payload.create_change_set_params) }
-      end
-
-      # Create a change set if the stack exists, otherwise create the stack
-      def deploy_change_set(payload)
-        exists?(payload) ? create_change_set(payload) : create(payload)
-      end
-
-      # True if the stack exists in CFN
-      def exists?(payload)
-        base_module::CloudFormation::Stack.new(name: payload.identifier).exists?
-      end
-
-      private
-
-      def base_module
-        Aws
-      end
-
-      def perform_and_wait(method, payload)
-        method = exists?(payload) ? :update : :create if method == :deploy
-        response = public_send(method, payload)
-        signal = :"stack_#{method}_complete"
-
-        client.wait_until(signal, stack_name: payload.identifier) do |waiter|
-          waiter.max_attempts = payload.max_wait / 5
-          waiter.delay = 5
-        end
-
-        response
-      end
-
-      def upload_object(payload, key)
-        base_module.config.update(region: AwsShim::REGION)
-        @s3_client ||= base_module::S3::Client.new
-
-        @s3_client.put_object(
-          body: payload.template_body,
-          bucket: Humidifier.config.s3_bucket,
-          key: key
-        )
-
-        object = base_module::S3::Object.new(Humidifier.config.s3_bucket, key)
-        object.presigned_url(:get)
-      end
-    end
-  end
-end

data/lib/humidifier/aws_adapters/sdkv3.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module AwsAdapters
-    # The adapter for v3 of aws-sdk
-    class SDKV3 < SDKV2
-      # The notice to add the `aws-sdk-s3` gem when it is needed.
-      S3_SDK_MESSAGE = <<-MSG
-The AWS SDK for versions 3+ have broken out individual AWS modules into their
-own gems. Since the stack that you're attempting to use is large enough that it
-needs to be uploaded to S3, humidifier needs to load the S3 SDK. Please make
-sure that the 'aws-sdk-s3' gem is available in your load path.
-MSG
-
-      private
-
-      def upload_object(payload, key)
-        raise S3_SDK_MESSAGE unless s3_sdk_loaded?
-
-        super
-      end
-
-      def s3_sdk_loaded?
-        require 'aws-sdk-s3'
-        true
-      rescue LoadError
-        false
-      end
-    end
-  end
-end

data/lib/humidifier/aws_shim.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'humidifier/aws_adapters/base'
-require 'humidifier/aws_adapters/noop'
-require 'humidifier/aws_adapters/sdkv1'
-require 'humidifier/aws_adapters/sdkv2'
-require 'humidifier/aws_adapters/sdkv3'
-
-module Humidifier
-  # Optionally provides aws-sdk functionality if the gem is loaded
-  class AwsShim
-    # The AWS region, can be set through the environment, defaults to us-east-1
-    REGION = ENV['AWS_REGION'] || 'us-east-1'
-
-    # Methods that are sent over to the aws adapter from the stack
-    STACK_METHODS = %i[
-      create delete deploy exists? update upload valid?
-      create_and_wait delete_and_wait deploy_and_wait update_and_wait
-      create_change_set deploy_change_set
-    ].freeze
-
-    attr_reader :shim
-
-    # Either set the SDK based on the configured option or guess the SDK
-    # version by attempting to require both aws-sdk-v1 and aws-sdk, then setting
-    # the shim based on what successfully loaded
-    def initialize
-      @shim =
-        if Humidifier.config.sdk_version_1?
-          AwsAdapters::SDKV1.new
-        elsif Humidifier.config.sdk_version_2?
-          AwsAdapters::SDKV2.new
-        elsif Humidifier.config.sdk_version_3?
-          AwsAdapters::SDKV3.new
-        else
-          guess_sdk
-        end
-    end
-
-    class << self
-      extend Forwardable
-      def_delegators :shim, *STACK_METHODS
-
-      # The shim singleton
-      def instance
-        @instance ||= new
-      end
-
-      # The target of all of the forwarding
-      def shim
-        instance.shim
-      end
-    end
-
-    private
-
-    def guess_sdk
-      try_requiring_sdks
-
-      if defined?(Aws) && Aws::CORE_GEM_VERSION[0] == '3'
-        AwsAdapters::SDKV3.new
-      elsif defined?(Aws)
-        AwsAdapters::SDKV2.new
-      elsif Object.const_defined?(:AWS)
-        AwsAdapters::SDKV1.new
-      else
-        AwsAdapters::Noop.new
-      end
-    end
-
-    def try_require_sdk(name)
-      require name || true
-    rescue LoadError
-      false
-    end
-
-    def try_requiring_sdks
-      try_require_sdk('aws-sdk-cloudformation') ||
-        try_require_sdk('aws-sdk') ||
-        try_require_sdk('aws-sdk-v1')
-    end
-  end
-end

data/lib/humidifier/configuration.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  # a container for user params
-  class Configuration
-    # The message that gets displayed when the stack body is too large to use
-    # the template_body option
-    UPLOAD_MESSAGE = <<-MSG
-The %<identifier>s stack's body is too large to be use the template_body option,
-and therefore must use the template_url option instead. You can configure
-Humidifier to do this automatically by setting up the s3 config on the top-level
-Humidifier object like so:
-
-    Humidifier.configure do |config|
-      config.s3_bucket = 'my.s3.bucket'
-      config.s3_prefix = 'my-prefix/' # optional
-    end
-MSG
-
-    # If true, always upload the CloudFormation template to the configured S3
-    # destination. A useful option if you're going to be deploying multiple
-    # copies of a template or you just generally want a backup.
-    attr_accessor :force_upload
-
-    # The S3 bucket to which to deploy CloudFormation templates when
-    # `always_upload` is set to true or the template is too big for a string
-    # literal.
-    attr_accessor :s3_bucket
-
-    # An optional prefix for the stack names.
-    attr_accessor :s3_prefix
-
-    # By default, `humidifier` will attempt to determine which SDK you have
-    # loaded. (There's not really a story for peer dependencies with bundler).
-    # If you want to enforce a specific version (for instance if you have both
-    # `aws-sdk-v1` and `aws-sdk` but want to use the former) you can set this
-    # variable to `1`.
-    attr_accessor :sdk_version
-
-    def initialize(opts = {})
-      @force_upload = opts[:force_upload]
-      @s3_bucket    = opts[:s3_bucket]
-      @s3_prefix    = opts[:s3_prefix]
-      @sdk_version  = opts[:sdk_version]
-    end
-
-    # raise an error unless the s3_bucket field is set
-    def ensure_upload_configured!(payload)
-      return if s3_bucket
-
-      raise UPLOAD_MESSAGE.gsub('%<identifier>s', payload.identifier)
-    end
-
-    # true if the sdk_version option is set to 1 or '1'
-    def sdk_version_1?
-      sdk_version.to_s == '1'
-    end
-
-    # true if the sdk_version option is set to 2 or '2'
-    def sdk_version_2?
-      sdk_version.to_s == '2'
-    end
-
-    # true if the sdk_version option is set to 3 or '3'
-    def sdk_version_3?
-      sdk_version.to_s == '3'
-    end
-  end
-end

data/lib/humidifier/props/base.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # Superclass for all CFN properties
-    class Base
-      # The list of classes that are valid beyond the normal values for each
-      # prop
-      WHITELIST = [Fn, Ref].freeze
-
-      attr_reader :key, :name, :spec, :substructs
-
-      def initialize(key, spec = {}, substructs = {})
-        @key  = key
-        @name = Utils.underscore(key)
-        @spec = spec
-        after_initialize(substructs) if respond_to?(:after_initialize, true)
-      end
-
-      # the link to the AWS docs
-      def documentation
-        spec['Documentation']
-      end
-
-      # true if this property is required by the resource
-      def required?
-        spec['Required']
-      end
-
-      # CFN stack syntax
-      def to_cf(value)
-        [key, Serializer.dump(value)]
-      end
-
-      # the type of update that occurs when this property is updated on its
-      # associated resource
-      def update_type
-        spec['UpdateType']
-      end
-
-      # true if the given value is of a type contained in the whitelist
-      def whitelisted_value?(value)
-        WHITELIST.any? { |clazz| value.is_a?(clazz) }
-      end
-    end
-  end
-end

data/lib/humidifier/props/boolean_prop.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A boolean property
-    class BooleanProp < Base
-      # converts the value through `value == 'true'` unless it is valid
-      def convert(value)
-        if valid?(value) || !%w[true false].include?(value)
-          value
-        else
-          puts "WARNING: Property #{name} should be a boolean, not a string"
-          value == 'true'
-        end
-      end
-
-      # true if it is a boolean
-      def valid?(value)
-        return true if whitelisted_value?(value)
-
-        value.is_a?(TrueClass) || value.is_a?(FalseClass)
-      end
-    end
-  end
-end

data/lib/humidifier/props/double_prop.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A double property
-    class DoubleProp < Base
-      # converts the value through #to_f unless it is valid
-      def convert(value)
-        if valid?(value) || !value.respond_to?(:to_f)
-          value
-        else
-          puts "WARNING: Property #{name} should be a double"
-          value.to_f
-        end
-      end
-
-      # true if it is whitelisted, an Integer, or a Float
-      def valid?(value)
-        whitelisted_value?(value) || value.is_a?(Integer) || value.is_a?(Float)
-      end
-    end
-  end
-end

data/lib/humidifier/props/integer_prop.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # An integer property
-    class IntegerProp < Base
-      # converts the value through #to_i unless it is valid
-      def convert(value)
-        if valid?(value) || !value.respond_to?(:to_i)
-          value
-        else
-          puts "WARNING: Property #{name} should be an integer"
-          value.to_i
-        end
-      end
-
-      # true if it is whitelisted or a Integer
-      def valid?(value)
-        whitelisted_value?(value) || value.is_a?(Integer)
-      end
-    end
-  end
-end

data/lib/humidifier/props/json_prop.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A Json property
-    class JsonProp < Base
-      # converts the value through `Hash[value]` unless it is valid
-      def convert(value)
-        if valid?(value) || !convertable?(value)
-          value
-        else
-          puts "WARNING: Property #{name} should be a Hash"
-          Hash[value]
-        end
-      end
-
-      # true if the value is whitelisted, a Hash, or an Array
-      def valid?(value)
-        whitelisted_value?(value) || value.is_a?(Hash)
-      end
-
-      private
-
-      def convertable?(value)
-        Hash[value]
-      rescue ArgumentError
-        false
-      end
-    end
-  end
-end

data/lib/humidifier/props/list_prop.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A property that is contained in a list
-    class ListProp < Base
-      attr_reader :subprop
-
-      # converts the value through mapping using the subprop unless it is valid
-      def convert(list)
-        valid?(list) ? list : list.map { |value| subprop.convert(value) }
-      end
-
-      # CFN stack syntax
-      def to_cf(list)
-        cf_value =
-          if list.respond_to?(:to_cf)
-            list.to_cf
-          else
-            list.map { |value| subprop.to_cf(value).last }
-          end
-
-        [key, cf_value]
-      end
-
-      # Valid if the value is whitelisted or every value in the list is valid
-      # on the subprop
-      def valid?(list)
-        return true if whitelisted_value?(list)
-
-        list.is_a?(Enumerable) && list.all? { |value| subprop.valid?(value) }
-      end
-
-      private
-
-      # Finds the subprop that's specified in the spec
-      def after_initialize(substructs)
-        @subprop = Props.singular_from(key, spec, substructs)
-      end
-    end
-  end
-end

data/lib/humidifier/props/map_prop.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A property that is contained in a Map
-    class MapProp < Base
-      attr_reader :subprop
-
-      # converts the value through mapping using the subprop unless it is valid
-      def convert(map)
-        return map if valid?(map)
-
-        map.map { |key, value| [key, subprop.convert(value)] }.to_h
-      end
-
-      # CFN stack syntax
-      def to_cf(map)
-        cf_value =
-          if map.respond_to?(:to_cf)
-            map.to_cf
-          else
-            map.each_with_object({}) do |(subkey, subvalue), serialized|
-              serialized[subkey] = subprop.to_cf(subvalue).last
-            end
-          end
-
-        [key, cf_value]
-      end
-
-      # Valid if the value is whitelisted or every value in the map is valid on
-      # the subprop
-      def valid?(map)
-        return true if whitelisted_value?(map)
-
-        map.is_a?(Hash) && map.values.all? { |value| subprop.valid?(value) }
-      end
-
-      private
-
-      # Finds the subprop that's specified in the spec
-      def after_initialize(substructs)
-        @subprop = Props.singular_from(key, spec, substructs)
-      end
-    end
-  end
-end

data/lib/humidifier/props/string_prop.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A string property
-    class StringProp < Base
-      # converts the value through #to_s unless it is valid
-      def convert(value)
-        if valid?(value)
-          value
-        else
-          puts "WARNING: Property #{name} should be a string"
-          value.to_s
-        end
-      end
-
-      # true if it is whitelisted or a String
-      def valid?(value)
-        whitelisted_value?(value) || value.is_a?(String)
-      end
-    end
-  end
-end

data/lib/humidifier/props/structure_prop.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A structure property that references a structure from the specification
-    class StructureProp < Base
-      attr_reader :subprops
-
-      # converts the value through mapping using the subprop unless it is valid
-      def convert(struct)
-        if valid?(struct)
-          struct
-        else
-          struct.map do |subkey, subvalue|
-            subkey = Utils.underscore(subkey.to_s)
-            [subkey.to_sym, subprops[subkey].convert(subvalue)]
-          end.to_h
-        end
-      end
-
-      # CFN stack syntax
-      def to_cf(struct)
-        cf_value =
-          if struct.respond_to?(:to_cf)
-            struct.to_cf
-          else
-            struct.map do |subkey, subvalue|
-              subprops[subkey.to_s].to_cf(subvalue)
-            end.to_h
-          end
-
-        [key, cf_value]
-      end
-
-      # true if the value is whitelisted or Hash and all keys are valid for
-      # their corresponding props
-      def valid?(struct)
-        return true if whitelisted_value?(struct)
-
-        struct.is_a?(Hash) && valid_struct?(struct)
-      end
-
-      private
-
-      def after_initialize(substructs)
-        @subprops = subprops_from(substructs, spec['ItemType'] || spec['Type'])
-      end
-
-      def subprops_from(substructs, type)
-        subprop_names = substructs.fetch(type, {}).fetch('Properties', {})
-
-        subprop_names.each_with_object({}) do |(key, config), subprops|
-          subprop =
-            if config['ItemType'] == type
-              self
-            else
-              Props.from(key, config, substructs)
-            end
-
-          subprops[Utils.underscore(key)] = subprop
-        end
-      end
-
-      def valid_struct?(struct)
-        struct.all? do |key, value|
-          subprops.key?(key.to_s) && subprops[key.to_s].valid?(value)
-        end
-      end
-    end
-  end
-end

data/lib/humidifier/props/timestamp_prop.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Humidifier
-  module Props
-    # A timestamp (ISO 8601) property
-    class TimestampProp < Base
-      # converts the value through DateTime.parse(value) unless it is valid
-      def convert(value)
-        if valid?(value) || !value.is_a?(String)
-          value
-        else
-          puts "WARNING: Property #{name} should be a Date or Time"
-          DateTime.parse(value)
-        end
-      end
-
-      # true if it is whitelisted, a Time, or a Date
-      def valid?(value)
-        whitelisted_value?(value) || value.is_a?(Time) || value.is_a?(Date)
-      end
-    end
-  end
-end