cfnresponse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2649632ac1f6c97689ee00059a98c31cacc36d219a3fb2f37f5bfb0891a58aa2
+  data.tar.gz: 15dafe63948b5ea494712d98450785090cbfcc27cca17d1c094765e6308dbed6
+SHA512:
+  metadata.gz: 77b890be2a4c5bb503ad065f2f4d48bee2e2851c1d1ba284246b898d9c23db33e4da79118095021800786a52cd8b5c03bb610265e170cba78427dc004c62da1c
+  data.tar.gz: 7672d10f7aa461b8cd4c21ebe18d7103d7891db2cfa39824f6481da4332992784327dda5a38fe3993daf5bfcf9184c3735c8da36a40949af36a72df6bf9cf1dd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cfnresponse.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tung Nguyen
+
+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,54 @@
+# Cfnresponse
+
+Cfnresponse helps with writing [Custom CloudFormation resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html). The main method is `send_response`, which builds the response that is sent back to CloudFormation service from the Lambda function.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cfnresponse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cfnresponse
+
+## Example Usage
+
+```ruby
+require "cfnresponse"
+include Cfnresponse
+
+def lambda_handler(event:, context:)
+  print("Received event: " + json_pretty(event))
+
+  case event['RequestType']
+  when "Create"
+    # create logic
+    send_response(event, context, SUCCESS)
+  when "Update"
+    # update logic
+    send_response(event, context, SUCCESS)
+  when "Delete"
+    # delete logic
+    send_response(event, context, SUCCESS)
+  end
+
+  sleep 10 # a little time for logs to be sent to CloudWatch
+
+# We rescue all exceptions and send a message to CloudFormation so we don't have to
+# wait for over an hour for the stack operation to timeout and rollback.
+rescue Exception => e
+  puts e.message
+  puts e.backtrace
+  sleep 10 # a little time for logs to be sent to CloudWatch
+  send_response(event, context, "FAILED")
+end
+```
+
+* [Cfnresponse code](lib/cfnresponse.rb)

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 "cfnresponse"
+
+# 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/cfnresponse.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cfnresponse/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfnresponse"
+  spec.version       = Cfnresponse::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = %q{CloudFormation send_response helpers to help with custom resources}
+  spec.homepage      = "https://github.com/tongueroo/cfnresponse"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cfnresponse.rb

@@ -0,0 +1,59 @@
+require "cfnresponse/version"
+require "json"
+require "uri"
+
+module Cfnresponse
+  class Error < StandardError; end
+
+  # Debugging puts kept to help debug custom resources
+  def send_response(event, context, response_status, response_data={}, physical_id="PhysicalId", reason=nil)
+    reason ||= "See the details in CloudWatch Log Stream: #{context.log_stream_name.inspect}"
+
+    response_body = JSON.dump(
+      Status: response_status,
+      Reason: reason,
+      PhysicalResourceId: physical_id,
+      StackId: event['StackId'],
+      RequestId: event['RequestId'],
+      LogicalResourceId: event['LogicalResourceId'],
+      Data: response_data
+    )
+
+    puts "Response body:\n"
+    puts json_pretty(JSON.load(response_body))
+
+    url = event['ResponseURL']
+    uri = URI(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.open_timeout = http.read_timeout = 30
+    http.use_ssl = true if uri.scheme == 'https'
+
+    # must used url to include the AWSAccessKeyId and Signature
+    req = Net::HTTP::Put.new(url) # url includes query string and uri.path does not, must used url t
+    req.body = response_body
+    req.content_length = response_body.bytesize
+
+    # set headers
+    req['content-type'] = ''
+    req['content-length'] = response_body.bytesize
+
+    if ENV['CFNRESPONSE_TEST']
+      puts "uri #{uri.inspect}"
+      return # early return to not send the request
+    end
+
+    res = http.request(req)
+    puts "status code: #{res.code}"
+    puts "headers: #{res.each_header.to_h.inspect}"
+    puts "body: #{res.body}"
+  end
+
+  # Useful for pretty json output on cloud9 and also CloudWatch logs
+  def json_pretty(data)
+    if ENV['C9_USER']
+      JSON.pretty_generate(data)
+    else
+      JSON.dump(data) # one a single line for CloudWatch to reformat
+    end
+  end
+end

data/lib/cfnresponse/version.rb

@@ -0,0 +1,3 @@
+module Cfnresponse
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: cfnresponse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cfnresponse.gemspec
+- lib/cfnresponse.rb
+- lib/cfnresponse/version.rb
+homepage: https://github.com/tongueroo/cfnresponse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: CloudFormation send_response helpers to help with custom resources
+test_files: []