jets 1.6.9 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d5b38763f2bc3d91c65b0b75084f98bd8ee7902522fdf6cf70951876f9a4f24
-  data.tar.gz: d57bfc2a503614d78a8bcfba3418c966a93e72e93f5ee27e59ed5b058878fb1a
+  metadata.gz: 6ad0f826d8ec03b2cd129b4c39d1f75daf60138e00f2b3873f4d63d1e626a8c4
+  data.tar.gz: c805db282c3e79261599a1b3cd5ab8a38ad4c60f9ea28ab2df001f8d20ac0d33
 SHA512:
-  metadata.gz: b383844f584768ec4229921889bc33dc9314f49d873ab9338632930c675c770c5bc0c55ff3116a042a8d10a02d5950cf55797a9fb9d4f635cb5ab8a92b2b2df4
-  data.tar.gz: ff0a50321768af088978d13a9367285327c568314628c5e5317510e5bb09e89fe0d89f810535ceed44bf531f32cef3a0daf013dca94153f752ef6f35413af49f
+  metadata.gz: 26e94165ad32ff3652e026dff7ef0d5ecff841e7ced9c661bf59bd8c6f04080965ca5150112f0121792d1835d31cf5f417093282c36f15adeb154df86154511e
+  data.tar.gz: ecf039c2c757df91877f81323bcf94378fe977d795f5103965f03263871190f68fbc9194f5132fd5b7c57f564ff5c6504723fba02010da4d6c89ed19bf82f068

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.7.0]
+- #188 sqs event support
+
 ## [1.6.9]
 - #184 improve default cors options request access-control-allow-methods
 

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (1.6.9)
+    jets (1.7.0)
       activerecord (~> 5.2.1)
       activesupport (~> 5.2.1)
       aws-sdk-apigateway

data/lib/jets/job/dsl.rb

@@ -8,9 +8,12 @@
 #
 module Jets::Job::Dsl
   extend ActiveSupport::Concern
+  autoload :EventSourceMapping, "jets/job/dsl/event_source_mapping"
 
   included do
     class << self
+      include EventSourceMapping
+
       # Public: Creates CloudWatch Event Rule
       #
       # expression - The rate expression.

data/lib/jets/job/dsl/event_source_mapping.rb

@@ -0,0 +1,66 @@
+module Jets::Job::Dsl
+  module EventSourceMapping
+    def declare_queue(props)
+      props ||= {} # since options.delete(:queue_properties) can be nil
+      r = Jets::Resource::Sqs::Queue.new(props)
+      with_resource_options(fresh_properties: true, multiple: true) do
+        resource(r.definition) # add associated resources immediately
+      end
+    end
+
+    def event_source_mapping(props={})
+      r = Jets::Resource::Lambda::EventSourceMapping.new(props)
+      with_resource_options(fresh_properties: true, multiple: true) do
+        resource(r.definition) # add associated resources immediately
+      end
+    end
+
+    def sqs_event(queue_name, options={})
+      if queue_name == :generate_queue
+        queue_arn = "!GetAtt {namespace}SqsQueue.Arn"
+        default_iam_policy = default_sqs_iam_policy('*') # Dont have access to full ARN on initial creation
+        declare_queue(options.delete(:queue_properties)) # delete to avoid using them for event_source_mapping
+      elsif queue_name.include?('!Ref') # reference shared resource
+        queue_arn = queue_name
+        default_iam_policy = default_sqs_iam_policy('*') # Dont have access to full ARN on initial creation
+      else # short-handle existing queue or full queue arn
+        queue_arn = full_queue_arn(queue_name)
+        default_iam_policy = default_sqs_iam_policy(queue_arn)
+      end
+
+      # Create iam policy allows access to queue
+      # Allow disabling in case use wants to add permission application-wide and not have extra IAM policy
+      iam_policy_props = options.delete(:iam_policy) || @iam_policy || default_iam_policy
+      iam_policy(iam_policy_props) unless iam_policy_props == :disable
+
+      props = options # by this time options only has EventSourceMapping properties
+      default = {
+        event_source_arn: queue_arn
+      }
+      props = default.merge(props)
+
+      event_source_mapping(props)
+    end
+
+    # Expands simple queue name to full arn. Example:
+    #
+    #   hello-queue
+    # To:
+    #   arn:aws:sqs:us-west-2:112233445566:hello-queue
+    def full_queue_arn(queue_name)
+      return queue_name if queue_name.include?("arn:aws:sqs")
+
+      "arn:aws:sqs:#{Jets.aws.region}:#{Jets.aws.account}:#{queue_name}"
+    end
+
+    def default_sqs_iam_policy(queue_name_arn='*')
+      {
+        action: ["sqs:ReceiveMessage",
+                 "sqs:DeleteMessage",
+                 "sqs:GetQueueAttributes"],
+        effect: "Allow",
+        resource: queue_name_arn,
+      }
+    end
+  end
+end

data/lib/jets/lambda/dsl.rb

@@ -141,13 +141,30 @@ module Jets::Lambda::Dsl
           @associated_resources || []
         else
           @associated_resources ||= []
-          @associated_resources << Jets::Resource::Associated.new(definitions)
+          associated_resource = Jets::Resource::Associated.new(definitions)
+          associated_resource.multiple_resources = @multiple_resources
+          @associated_resources << associated_resource
           @associated_resources.flatten!
         end
       end
       # User-friendly short resource method. Users will use this.
       alias_method :resource, :associated_resources
 
+      # Using this odd way of setting these properties so we can keep the
+      # resource(*definitions) signature simple. Using keyword arguments at the end
+      # interfere with being able to pass in any keys for the properties hash at the end.
+      #
+      # TODO: If there's a cleaner way of doing this, let me know.
+      def with_resource_options(fresh_properties: false, multiple_resources: false)
+        @associated_properties = nil if fresh_properties # dont use any current associated_properties
+        @multiple_resources = multiple_resources
+
+        yield
+
+        @multiple_resources = false
+        @associated_properties = nil if fresh_properties # reset for next definition, since we're defining eagerly
+      end
+
       # Properties belonging to the associated resource
       def associated_properties(options={})
         @associated_properties ||= {}
@@ -170,6 +187,14 @@ module Jets::Lambda::Dsl
         end
       end
 
+      def add_logical_id_counter?
+        return false unless @associated_resources
+        # Only takes one associated resource with multiple set to true to return false of this check
+        return false if @associated_resources.detect { |associated| associated.multiple_resources }
+        # Otherwise check if there is more than 1 @associated_resources
+        @associated_resources.size > 1
+      end
+
       # Loop back through the resources and add a counter to the end of the id
       # to handle multiple events.
       # Then replace @associated_resources entirely
@@ -218,7 +243,7 @@ module Jets::Lambda::Dsl
 
         # Unsure why but we have to use @associated_resources vs associated_resources
         # associated_resources is always nil
-        if @associated_resources && @associated_resources.size > 1
+        if add_logical_id_counter?
           add_logical_id_counter
         end
 

data/lib/jets/resource/associated.rb

@@ -5,8 +5,19 @@ class Jets::Resource
     extend Memoist
 
     attr_reader :definition
+    attr_accessor :multiple_resources
     def initialize(*definition)
       @definition = definition.flatten
+      # Some associated resources require multiple resources for a single Lambda function. For
+      # example `sqs_event` can create a `SQS::Queue` and `Lambda::EventSourceMapping`.  We set
+      # a `multiple` flag so `add_logical_id_counter` can use it to avoid adding counter ids to
+      # these type of resources. The `multiple` flag allows us to handle both:
+      #
+      #   1. Associated resources that contain multiple resources for a single Lambda function
+      #   2. A single Lambda function with multiple events.  In this case, a counter is added
+      #
+      # Setting `multiple` to true means the counter id will not be added.
+      @multiple_resources = false
     end
 
     def logical_id

data/lib/jets/resource/lambda.rb

@@ -1,4 +1,5 @@
 module Jets::Resource::Lambda
+  autoload :EventSourceMapping, 'jets/resource/lambda/event_source_mapping'
   autoload :Function, 'jets/resource/lambda/function'
   autoload :GemLayer, 'jets/resource/lambda/gem_layer'
   autoload :LayerVersion, 'jets/resource/lambda/layer_version'

data/lib/jets/resource/lambda/event_source_mapping.rb

@@ -0,0 +1,31 @@
+# Note the Lambda function timeout must be less than or equal to the sqs queue default timeout.
+module Jets::Resource::Lambda
+  class EventSourceMapping < Jets::Resource::Base
+    def initialize(props)
+      @props = props # associated_properties from dsl.rb
+    end
+
+    def definition
+      # CloudFormation Docs: https://amzn.to/2WM6165
+      properties = {
+        # batch_size: 10, # Defaults: Kinesis 100, DynamoDB Streams: 100, SQS: 10
+        # enabled: boolean,
+        # event_source_arn: string, # required
+        function_name: "!Ref {namespace}LambdaFunction",
+        # starting_position: string # reqiured for Required for Amazon Kinesis and Amazon DynamoDB Streams sources
+      }
+      properties.merge!(@props)
+
+      {
+        event_source_mapping_logical_id => {
+          type: "AWS::Lambda::EventSourceMapping",
+          properties: properties
+        }
+      }
+    end
+
+    def event_source_mapping_logical_id
+      "{namespace}EventSourceMapping"
+    end
+  end
+end

data/lib/jets/resource/sqs/queue.rb

@@ -0,0 +1,21 @@
+# CloudFormation SQS Queue docs: https://amzn.to/2MVWk0j
+module Jets::Resource::Sqs
+  class Queue < Jets::Resource::Base
+    def initialize(props)
+      @props = props # associated_properties from dsl.rb
+    end
+
+    def definition
+      {
+        queue_logical_id => {
+          type: "AWS::SQS::Queue",
+          properties: @props,
+        }
+      }
+    end
+
+    def queue_logical_id
+      "{namespace}_sqs_queue"
+    end
+  end
+end

data/lib/jets/stack/main/extensions/base.rb

@@ -4,6 +4,10 @@ module Jets::Stack::Main::Dsl
       "!Ref #{value.to_s.camelize}"
     end
 
+    def getatt(value, attribute=:arn)
+      "!GetAtt #{value.to_s.camelize}.#{attribute.to_s.camelize}"
+    end
+
     def logical_id(value)
       value.to_s.camelize
     end

data/lib/jets/stack/main/extensions/sqs.rb

@@ -1,8 +1,10 @@
 module Jets::Stack::Main::Dsl
   module Sqs
     def sqs_queue(id, props={})
-      resource(id, "AWS::SNS::Topic", props)
-      output(id)
+      # props[:queue_name] ||= id.to_s # comment out to allow CloudFormation to generate name
+      resource(id, "AWS::SQS::Queue", props)
+      # output(id) # normal !Ref returns the sqs url the ARN is more useful
+      output(id, getatt(id, :arn))
     end
   end
 end

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "1.6.9"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 1.6.9
+  version: 1.7.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -652,6 +652,7 @@ files:
 - lib/jets/job.rb
 - lib/jets/job/base.rb
 - lib/jets/job/dsl.rb
+- lib/jets/job/dsl/event_source_mapping.rb
 - lib/jets/klass.rb
 - lib/jets/lambda.rb
 - lib/jets/lambda/dsl.rb
@@ -732,6 +733,7 @@ files:
 - lib/jets/resource/iam/managed_policy.rb
 - lib/jets/resource/iam/policy_document.rb
 - lib/jets/resource/lambda.rb
+- lib/jets/resource/lambda/event_source_mapping.rb
 - lib/jets/resource/lambda/function.rb
 - lib/jets/resource/lambda/function/environment.rb
 - lib/jets/resource/lambda/gem_layer.rb
@@ -743,6 +745,7 @@ files:
 - lib/jets/resource/s3.rb
 - lib/jets/resource/sns.rb
 - lib/jets/resource/sqs.rb
+- lib/jets/resource/sqs/queue.rb
 - lib/jets/resource/standardizer.rb
 - lib/jets/route.rb
 - lib/jets/router.rb