humidifier 1.11.0 → 1.11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 666dd5554cc35b20ad539b0c2fe0c2f72edd6060
-  data.tar.gz: 9c60c92099f44e870e65c6c717b4ec782fdd2bd0
+  metadata.gz: f63e3c8426ef72d434bc4cedf68899d4ae9e2573
+  data.tar.gz: 99cdd9a0863a786e1c72df2d8008805e70ebca0d
 SHA512:
-  metadata.gz: 7326c58c9452e78574b9901fbb893e609253fe4ea2bfefae4e72b0fcebcacb54d9b5d47151e1f207cde4f2d9e369caf141c6666157c9cfb71e6f8cf2e76242e2
-  data.tar.gz: b819cf0ac8da2fa435ba3f70ccd271c2123c010e84c6c5967140aaab4e1e40f8929b9c08656f8ed0899c961a94832587f3c1e6d83e28c7bc1ffe96e41c5dfe9d
+  metadata.gz: c19ea21dbaa03e6a0515f7f8e5c9af5d785f14549f02b021505948e25f046659dac1cd055e591299face04d19a896e7f91eb69460134df114a7a7bfc509f50d2
+  data.tar.gz: 4a64f7e5ed14d2e6441eaa565c3816f8008b2c6abfd1c6988a65c8593f5bc5eef65797ca4fa3d906f5a56f9e4d64c6d2220dbaa9e4af84c119f1614a80058f78

data/README.md

@@ -77,6 +77,23 @@ Humidifier.configure do |config|
 end
 ```
 
+### Forcing uploading
+
+You can force a stack to upload its template to S3 regardless of the size of the template. This is a useful option if you're going to be deploying multiple
+copies of a template or you just generally want a backup. You can set this option on a per-stack basis:
+
+```ruby
+stack.deploy(force_upload: true)
+```
+
+or globally, but setting the configuration option:
+
+```ruby
+Humidifier.configure do |config|
+  config.force_upload = true
+end
+```
+
 ## Development
 
 To get started, ensure you have ruby installed, version 2.1 or later. From there, install the `bundler` gem: `gem install bundler` and then `bundle install` in the root of the repository.

data/lib/humidifier/configuration.rb

@@ -15,12 +15,31 @@ Humidifier object like so:
     end
 MSG
 
-    attr_accessor :s3_bucket, :s3_prefix, :sdk_version
+    # 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 = {})
-      self.s3_bucket   = opts[:s3_bucket]
-      self.s3_prefix   = opts[:s3_prefix]
-      self.sdk_version = opts[:sdk_version]
+      @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

data/lib/humidifier/sdk_payload.rb

@@ -24,7 +24,21 @@ module Humidifier
       end
     end
 
-    attr_reader :stack, :options, :max_wait
+    # The stack on which operations are going to be performed.
+    attr_reader :stack
+
+    # Options that should be passed through to CloudFormation when the desired
+    # operation is being performed. Particularly useful for the `capabilities`
+    # option for acknowledging IAM resource changes.
+    attr_reader :options
+
+    # The maximum amount of time that `humidifier` should wait for the stack to
+    # resolve to the desired state. If your stacks are particularly large, you
+    # may need to set this to wait longer than the default `MAX_WAIT`.
+    attr_accessor :max_wait
+
+    # Force the stack to upload to S3 regardless of the size of the stack.
+    attr_accessor :force_upload
 
     extend Forwardable
     def_delegators :stack, :id=, :identifier, :name
@@ -33,6 +47,7 @@ module Humidifier
       @stack = stack
       @options = options
       @max_wait = options.delete(:max_wait) || MAX_WAIT
+      @force_upload = options.delete(:force_upload)
     end
 
     # True if the stack and options are the same as the other (used for testing)
@@ -87,9 +102,14 @@ module Humidifier
       end
     end
 
+    def should_upload?
+      return force_upload unless force_upload.nil?
+      Humidifier.config.force_upload || bytesize > MAX_TEMPLATE_BODY_SIZE
+    end
+
     def template_param
       @template_param ||=
-        if bytesize > MAX_TEMPLATE_BODY_SIZE
+        if should_upload?
           { template_url: AwsShim.upload(self) }
         else
           { template_body: template_body }

data/lib/humidifier/version.rb

@@ -1,4 +1,4 @@
 module Humidifier
   # Gem version
-  VERSION = '1.11.0'.freeze
+  VERSION = '1.11.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humidifier
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.0.1
 platform: ruby
 authors:
 - Localytics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler