jackal-cfn 0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/carnivore-rb/jackal-cfn/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/carnivore-rb/jackal-cfn/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,26 @@
+# Jackal CFN
+
+CFN proxy to the jackal subsystem.
+
+## Supported payload generation
+
+### Events
+
+Stack events are injected with the following
+payload structure:
+
+```json
+```
+
+### Resources
+
+Custom stack resources are injected with the
+following structure:
+
+```json
+```
+
+## Info
+
+* Repository: https://github.com/carnviore-rb/jackal-cfn
+* IRC: Freenode @ #carnivore

data/jackal-cfn.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-cfn/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-cfn'
+  s.version = Jackal::Cfn::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/carnivore-rb/jackal-cfn'
+  s.description = 'CFN callback helpers'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_dependency 'jackal'
+  s.add_dependency 'patron'
+  s.files = Dir['lib/**/*'] + %w(jackal-cfn.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/jackal-cfn.rb

@@ -0,0 +1,10 @@
+require 'jackal'
+require 'jackal-cfn/version'
+
+module Jackal
+  # Cfn entry system
+  module Cfn
+    autoload :Event, 'jackal-cfn/event'
+    autoload :Resource, 'jackal-cfn/resource'
+  end
+end

data/lib/jackal-cfn/event.rb

@@ -0,0 +1,76 @@
+require 'jackal-cfn'
+
+module Jackal
+  module Cfn
+    # Callback for event types
+    class Event < Jackal::Callback
+
+      # Unpack message and create payload
+      #
+      # @param message [Carnivore::Message]
+      # @return [Smash]
+      def unpack(message)
+        payload = super
+        payload = format_event(payload.fetch('Body', 'Message', payload))
+        payload[:origin_type] = message[:message].get('Body', 'Type')
+        payload[:origin_subject] = message[:message].get('Body', 'Subject')
+      end
+
+      # Determine message validity
+      #
+      # @param message [Carnivore::Message]
+      # @return [TrueClass, FalseClass]
+      def valid?(message)
+        super do |payload|
+          result = payload[:origin_type] == 'Notification' &&
+            payload[:origin_subject].downcase.include?('cloudformation notification')
+          if(result && block_given?)
+            yield payload
+          else
+            result
+          end
+        end
+      end
+
+      # Format payload into proper event structure
+      #
+      # @param evt [Hash]
+      # @return [Smash]
+      def format_event(evt)
+        parts = evt.split("\n").map do |entry|
+          chunks = entry.split('=')
+          key = parts.unshift.strip
+          value = parts.join.strip.sub(/^'/, '').sub(/'$/, '').strip
+          [key, value]
+        end
+        event = Smash[parts]
+        unless(event['ResourceProperties'].to_s.empty?)
+          begin
+            event['ResourceProperties'] = MultiJson.load(event['ResourceProperties'])
+          rescue MultiJson::LoadError => e
+            error "Failed to load `ResourceProperties`: #{e.class} - #{e}"
+            debug "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+          end
+        else
+          event['ResourceProperties'] = {}
+        end
+        Smash.new(Carnivore::Utils.symbolize_hash(event))
+      end
+
+      # Generate payload and drop
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap do |payload|
+          job_completed(
+            new_payload(
+              config[:name],
+              :cfn_event => payload
+            )
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/jackal-cfn/resource.rb

@@ -0,0 +1,144 @@
+require 'jackal-cfn'
+
+module Jackal
+  module Cfn
+    # Callback for resource types
+    class Resource < Jackal::Callback
+
+      VALID_RESOURCE_STATUS = ['SUCCESS', 'FAILED']
+
+      autoload :HashExtractor, 'jackal-cfn/resource/hash_extractor'
+
+      # Physical ID of the resource created
+      #
+      # @return [String]
+      # @note this should be overridden in subclasses when actual
+      #   resources are being created
+      def physical_resource_id
+        "#{self.class.name}-#{Celluloid.uuid}"
+      end
+
+      # Generate response hash
+      #
+      # @param payload [Hash]
+      # @return [Hash] default response content
+      def build_response(payload)
+        args = transform_parameters(payload)
+        Smash.new(
+          'LogicalResourceId' => args[:logical_resource_id],
+          'PhysicalResourceId' => args.fetch(:physical_resource_id, physical_resource_id),
+          'StackId' => args[:stack_id],
+          'Status' => 'SUCCESS',
+          'Reason' => nil,
+          'Data' => Smash.new
+        )
+      end
+
+      # Provide remote endpoint session for sending response
+      #
+      # @param host [String] end point host
+      # @param scheme [String] end point scheme
+      # @return [Patron::Session]
+      def response_endpoint(host, scheme)
+        session = Patron::Session.new
+        session.timeout = config.fetch(:response_timeout, 20)
+        session.connect_timeout = config.fetch(:connection_timeout, 10)
+        session.base_url = "#{scheme}://#{host}"
+        session.headers['User-Agent'] = "JackalCfn/#{Jackal::Cfn::VERSION.version}"
+        session
+      end
+
+      # Send response to the waiting stack
+      #
+      # @param response [Hash]
+      # @param response_url [String] response endpoint
+      # @return [TrueClass, FalseClass]
+      def respond_to_stack(response, response_url)
+        unless(VALID_RESOURCE_STATUS.include?(response['Status']))
+          raise ArgumentError.new "Invalid resource status provided. Got: #{response['Status']}. Allowed: #{VALID_RESOURCE_STATUS.join(', ')}"
+        end
+        if(response['Status'] == 'FAILED' && !response['Reason'])
+          response['Reason'] = 'Unknown'
+        end
+        url = URI.parse(response_url)
+        connection = response_endpoint(url.host, url.scheme)
+        path = "#{url.path}?#{url.query}"
+        debug "Custom resource response data: #{response.inspect}"
+        complete = connection.request(:put, path, {}, :data => JSON.dump(response))
+        case complete.status
+        when 200
+          info "Custom resource response complete! (Sent to: #{url})"
+          true
+        when 403
+          error "Custom resource response failed. Endpoint is forbidden (403): #{url}"
+          false
+        when 404
+          error "Custom resource response failed. Endpoint is not found (404): #{url}"
+          false
+        else
+          raise "Response failed. Received status: #{complete.status} endpoint: #{url}"
+        end
+      end
+
+      # Unpack message and create payload
+      #
+      # @param message [Carnivore::Message]
+      # @return [Smash]
+      def unpack(message)
+        payload = super
+        payload = Smash.new(
+          MultiJson.load(
+            payload.fetch('Body', 'Message', payload)
+          )
+        )
+        payload[:origin_type] = message[:message].get('Body', 'Type')
+        payload[:origin_subject] = message[:message].get('Body', 'Subject')
+        payload
+      end
+
+      # Determine message validity
+      #
+      # @param message [Carnivore::Message]
+      # @return [TrueClass, FalseClass]
+      def valid?(message)
+        super do |payload|
+          result = payload[:origin_type] == 'Notification' &&
+            payload[:origin_subject].downcase.include?('cloudformation custom resource')
+          if(result && block_given?)
+            yield payload
+          else
+            result
+          end
+        end
+      end
+
+      # Generate payload and drop
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |payload|
+          job_completed(
+            new_payload(
+              config[:name],
+              :cfn_resource => payload
+            )
+          )
+        end
+      end
+
+      # Snake case top level keys in hash
+      #
+      # @param params [Hash]
+      # @return [Hash] new hash with snake cased toplevel keys
+      def transform_parameters(params)
+        Smash.new.tap do |new_hash|
+          params.each do |key, value|
+            key = key.gsub(/(?<![A-Z])([A-Z])/, '_\1').sub(/^_/, '').downcase.to_sym
+            new_hash[key] = value
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/jackal-cfn/resource/hash_extractor.rb

@@ -0,0 +1,66 @@
+require 'jackal-cfn'
+
+module Jackal
+  module Cfn
+    class Resource
+      # Extract value from hash
+      #
+      # Expected resource properties:
+      #   {
+      #     "Properties": {
+      #       "Parameters": {
+      #         "Key": "path.to.value.in.hash",
+      #         "Value": Hash_or_JSON_string
+      #       }
+      #     }
+      #   }
+      class HashExtractor < Resource
+
+        # Setup the dependency requirements for the callback
+        def setup(*_)
+          require 'patron'
+        end
+
+        # Validity of message
+        #
+        # @param message [Carnivore::Message]
+        # @return [Truthy, Falsey]
+        def valid?(message)
+          super do |payload|
+            payload.get('ResourceProperties', 'Action') == 'hash_extractor'
+          end
+        end
+
+        # Process message, send value back to CFN
+        #
+        # @param message [Carnivore::Message]
+        def execute(message)
+          payload = transform_parameters(unpack(message))
+          debug "Processing payload: #{payload.inspect}"
+          properties = transform_parameters(payload[:resource_properties])
+          cfn_response = build_response(payload)
+          parameters = transform_parameters(properties[:parameters])
+          key = parameters[:key].split('.')
+          value = parameters[:value]
+          if(value.is_a?(String))
+            value = MultiJson.load(value).to_smash
+          end
+          return_value = value.get(*key)
+          if(return_value.is_a?(Enumerable))
+            return_value = MultiJson.dump(return_value)
+          end
+          cfn_response['Data']['Payload'] = return_value
+          respond_to_stack(cfn_response, payload[:response_url])
+          completed(
+            new_payload(
+              config.fetch(:name, :hash_extractor),
+              :cfn_resource => payload
+            ),
+            message
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/jackal-cfn/version.rb

@@ -0,0 +1,6 @@
+module Jackal
+  module Cfn
+    # Current version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: jackal-cfn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jackal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CFN callback helpers
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jackal-cfn.rb
+- lib/jackal-cfn/event.rb
+- lib/jackal-cfn/version.rb
+- lib/jackal-cfn/resource.rb
+- lib/jackal-cfn/resource/hash_extractor.rb
+- jackal-cfn.gemspec
+- README.md
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+homepage: https://github.com/carnivore-rb/jackal-cfn
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Message processing helper
+test_files: []
+has_rdoc: