cfn_response 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb89442818b5322eea17cff31a7fe7dd73b8d0d32078a8661c759bec767ec12
-  data.tar.gz: bb8511d79608a0e45d7ed1696f87b140dfae01d3177cb342909f5b64f376164f
+  metadata.gz: 2f02c2b2c1e2f9496d23609923e4f05fb727f2b0f220641799f54ea619cc2503
+  data.tar.gz: ead5ce51b9ef94bc75b7ecff70f3b85fa191d5fc40999347c9c480a75cbd1363
 SHA512:
-  metadata.gz: 294b1bb9de892efb265ac9d856f63dcda2cffca81830e3e77deaa20daaf3eb398778af3b374e4234b7e6917e27333561be2d9f53c2cf3909ad0bcf541c13ec78
-  data.tar.gz: 99ac34c6979d1e175944baac0fb253e8ae5f7f814551e2c9d5c12d152a41145508cf5e9e8aa58f301e1def6541fd312035c62fa32e23af4f848c539b65986c71
+  metadata.gz: a635427683777b6bfe9dc1f90bb74615e3cee9773e95b4f3be3ee87c8d01387caacb5705fe82c1440c406d5d7fa52d686b569df381fa2146bcb40d3430140441
+  data.tar.gz: c2ea1e73f2b2279000eaaa371a1a798ae1024d5a611a13415f67db4b234bafc392d0f8df6ad912a80ae9a3690f89a7406661a9c09101ba29511ab760a637ecbe

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [0.2.0] - 2021-01-06
+- [#1](https://github.com/tongueroo/cfn_response/pull/1) improve interface with response method
+- improve interface: response method and auto send success to cloudformation
+
+## [0.1.0]
+- Initial release

data/README.md

@@ -6,7 +6,49 @@ CfnResponse helps with writing [Custom CloudFormation resources](https://docs.aw
 
 ## Usage
 
-The block form with the `safely` method will ensure a FAILED status is sent to CloudFormation in the event of an Exception in the code. This prevents us from waiting for over an hour for the stack operation to timeout and rollback. It also will call sleep 10 to provide enough time to send logs to CloudWatch.
+The block form with the `response` method will ensure a SUCCESS or FAILED status is sent to CloudFormation regardless. If there's an Exception in the code, FAILED status is automatically sent. Otherwise an implicit SUCCESS status is sent.
+
+This prevents us from waiting for over an hour for the stack operation to timeout and rollback. A `sleep 10` is also called at the end to provide enough time for the Lambda function to send logs to CloudWatch.
+
+```ruby
+require "cfn_response"
+require "json"
+
+def lambda_handler(event:, context:)
+  puts "event: #{JSON.pretty_generate(event)}"
+  cfn = CfnResponse.new(event, context)
+
+  # will call cfn.fail on Exceptions so CloudFormation can continue
+  cfn.response do
+    case event['RequestType']
+    when "Create", "Update"
+      # create or update logic
+    when "Delete"
+      # delete logic
+    end
+    # Note: cfn.success doesnt need to be called because it is called implicitly at the end
+  end
+end
+```
+
+If you always want to return a success, here's the simpliest form:
+
+```ruby
+require "cfn_response"
+require "json"
+
+def lambda_handler(event:, context:)
+  puts "event: #{JSON.pretty_generate(event)}"
+  cfn = CfnResponse.new(event, context)
+  cfn.response
+end
+```
+
+Reminder, `cfn.success` or `cfn.fail` is not called explicitly, a `cfn.success` is automatically called.
+
+### Calling success or fail explicitly
+
+You can also call `cfn.success` or `cfn.fail explicitly`, doing so gives you the ability to pass custom `Data`.
 
 ```ruby
 require "cfn_response"
@@ -14,26 +56,28 @@ require "json"
 
 def lambda_handler(event:, context:)
   puts "event: #{JSON.pretty_generate(event)}"
-  resp = CfnResponse.new(event, context)
+  cfn = CfnResponse.new(event, context)
 
-  # will call resp.fail on Exceptions so CloudFormation can continue
-  resp.safely do
+  # will call cfn.fail on Exceptions so CloudFormation can continue
+  cfn.response do
     case event['RequestType']
     when "Create", "Update"
       # create or update logic
       data = {a: 1, b: 2}
-      resp.success(Data: data)
+      cfn.success(Data: data)
       # or
-      # resp.failed
+      # cfn.failed
     when "Delete"
       # delete logic
-      resp.success
+      cfn.success # optional
     end
   end
 end
 ```
 
-You can also call `success` and `failed` methods without wrapping the in a `safely` block.  Just remember to handle Exceptions. Example:
+### Non-block form
+
+You can also call `success` and `failed` methods without wrapping the in a `response` block.  Just remember to handle Exceptions. Example:
 
 ```ruby
 require "cfn_response"
@@ -41,12 +85,12 @@ require "json"
 
 def lambda_handler(event:, context:)
   puts "event: #{JSON.pretty_generate(event)}"
-  resp = CfnResponse.new(event, context)
+  cfn = CfnResponse.new(event, context)
 
   data = {a: 1, b: 2}
-  resp.success(Data: data)
+  cfn.success(Data: data)
   # or
-  # resp.failed
+  # cfn.failed
 
   sleep 10 # a little time for logs to be sent to CloudWatch
 # Rescue all exceptions and send FAIL to CloudFormation so we don't have to
@@ -55,7 +99,7 @@ rescue Exception => e
   puts e.message
   puts e.backtrace
   sleep 10 # a little time for logs to be sent to CloudWatch
-  resp.failed
+  cfn.failed
 end
 ```
 
@@ -66,8 +110,8 @@ Ultimately, CloudFormation expects a JSON body to be sent to it with these possi
 The `success` and `failed` methods accept a Hash which is simply merged down to the final JSON body that is sent to CloudFormation. Most of the fields are prefilled conveniently by this library.  You may want to pass some values.  Example:
 
 ```ruby
-resp = CfnResponse.new(event, context)
-resp.success(Data: {a: 1, b: 2}, NoEcho: true)
+cfn = CfnResponse.new(event, context)
+cfn.success(Data: {a: 1, b: 2}, NoEcho: true)
 ```
 
 ### PhysicalResourceId
@@ -75,16 +119,16 @@ resp.success(Data: {a: 1, b: 2}, NoEcho: true)
 The default PhysicalResourceId is `PhysicalResourceId`. If your logic calls for a new physical resource and you want to tell CloudFormation to replace the resource. Then you can provide a value with the symbol `:new_id` and the library will add a counter value to end of the current physical id.
 
 ```ruby
-resp = CfnResponse.new(event, context)
-resp.success(PhysicalResourceId: :new_id)
+cfn = CfnResponse.new(event, context)
+cfn.success(PhysicalResourceId: :new_id)
 # PhysicalResourceId => PhysicalResourceId1 => PhysicalResourceId2 => etc
 ```
 
 Or you replace it with your own unique physical resource id value of course.
 
 ```ruby
-resp = CfnResponse.new(event, context)
-resp.success(PhysicalResourceId: "MyId")
+cfn = CfnResponse.new(event, context)
+cfn.success(PhysicalResourceId: "MyId")
 ```
 
 ## Installation

data/lib/cfn_response.rb

@@ -1,4 +1,5 @@
 require "cfn_response/version"
+require "json"
 
 class CfnResponse
   autoload :Base, "cfn_response/base"
@@ -11,36 +12,52 @@ class CfnResponse
     @event, @context = event, context
   end
 
-  def call(input={})
+  def response
+    show_event if show_event?
+    result = yield if block_given?
+    success unless @finished
+    pause_for_cloudwatch
+    result
+  rescue Exception => e
+    puts "ERROR #{e.message}"
+    puts "BACKTRACE:\n#{e.backtrace.join("\n")}"
+    pause_for_cloudwatch
+    failed
+  end
+  alias_method :respond, :response
+
+  def show_event?
+    ENV['CFN_RESPONSE_VERBOSE'].nil? ? true : ENV['CFN_RESPONSE_VERBOSE'] == '1'
+  end
+
+  def show_event
+    puts("event['RequestType'] #{@event['RequestType']}")
+    puts("event: #{JSON.dump(@event)}")
+    puts("context: #{JSON.dump(@context)}")
+    puts("context.log_stream_name #{@context.log_stream_name.inspect}")
+  end
+
+  def send_to_cloudformation(input={})
     builder = Builder.new(@event, @context)
     response_data = builder.call(input)
     sender = Sender.new(@event, @context)
-    sender.call(response_data)
+    result = sender.call(response_data) unless ENV['CFN_RESPONSE_SEND'] == '0'
+    @finished = true
+    result
   end
 
   def success(input={})
     input[:Status] = "SUCCESS"
-    call(input)
+    send_to_cloudformation(input)
   end
 
   def failed(input={})
     input[:Status] = "FAILED"
-    call(input)
-  end
-
-  def safely
-    result = yield
-    pause_for_cloudwatch
-    result
-  rescue Exception => e
-    puts "ERROR #{e.message}"
-    puts "BACKTRACE:\n#{e.backtrace.join("\n")}"
-    pause_for_cloudwatch
-    failed
+    send_to_cloudformation(input)
   end
 
   def pause_for_cloudwatch
-    return if ENV['CFN_RESPONSE_TEST']
+    return if ENV['CFN_RESPONSE_TEST'] || ENV['CFN_RESPONSE_SEND']
     sleep 10 # a little time for logs to be sent to CloudWatch
   end
 end

data/lib/cfn_response/version.rb

@@ -1,3 +1,3 @@
 class CfnResponse
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/cfn_response_spec.rb

@@ -22,13 +22,20 @@ RSpec.describe CfnResponse do
       expect(resp.to_s).to eq(null.to_s) # due to stub
     end
 
-    it "call" do
-      resp = subject.call
+    it "send_to_cloudformation" do
+      resp = subject.send_to_cloudformation
       expect(resp.to_s).to eq(null.to_s) # due to stub
     end
 
-    it "safely" do
-      resp = subject.safely do
+    it "response" do
+      resp = subject.response do
+        subject.success
+      end
+      expect(resp.to_s).to eq(null.to_s) # due to stub
+    end
+
+    it "respond" do
+      resp = subject.respond do
         subject.success
       end
       expect(resp.to_s).to eq(null.to_s) # due to stub

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn_response
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: CfnResponse makes it easier to build and send the CloudFormation Custom Resource