jets 5.0.7 → 5.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e04f05b1acc2261aa805569fce675ac41b87de70487156b625ddc1beedad957a
-  data.tar.gz: 4f89a28661441ff74bf7cb98b90eef08583fe18e20ba72472240e41f942b8ff2
+  metadata.gz: 3c9deeac005b373929e04e747ce2465b82eccc49a99a39830025228e1da199e7
+  data.tar.gz: e1e5849237312cfe6725a1d4bd163b8b17f4ef904a000b5c5323de05a7afbaf4
 SHA512:
-  metadata.gz: 189e8b589c09a258329a7f0d29ac52759a854e75ddafa312716e93359689ee87946c7cecb8cbb720e0046042e0358fd7086ef2b011ecb2929014f0c371352548
-  data.tar.gz: 5f2adbfc890b6a0346a998463fa3d297138aebe570576d1f2d3f782456da5c4384151043f9b241a966c6fcfcf3b2fb2ffda49c129ea43a3581513422f85e42fa
+  metadata.gz: c351ace071bea12bca7785140d1a3cd0abcc8750a1e06d99cbe5691af1a26a573f8ff915a1d4569dd97c736df852d83d8944161c2387c42791588f568d13e17f
+  data.tar.gz: 1bef67bd4957279b84d2315597568a78c4fe17806d659116dd59f55018e242b432fbc23d186ca4e171f97db001ac22c5f86158049b817713b2ead712158eb419

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/).
 
+## [5.0.8] - 2023-12-24
+- [#702](https://github.com/rubyonjets/jets/pull/702) prettier event helpers IE: s3_events vs s3_event_payloads
+
 ## [5.0.7] - 2023-12-24
 - [#699](https://github.com/rubyonjets/jets/pull/699) cache Stack.lookup output in class memory
 - [#700](https://github.com/rubyonjets/jets/pull/700) update s3 sns and sqs event helpers to return all events

data/lib/jets/builders/handler_generator.rb

@@ -130,7 +130,7 @@ module Jets::Builders
 
     def internal_shims
       jets_base_path if Jets.custom_domain?
-      s3_bucket_config if Jets.s3_event?
+      s3_bucket_config if Jets.s3_events?
     end
 
     def jets_base_path

data/lib/jets/commands/deploy/deploy_command.rb

@@ -35,7 +35,7 @@ module Jets::Command
 
   private
     def create_s3_event_buckets
-      buckets = Jets::Job::Base.s3_events.keys
+      buckets = Jets::Job::Base._s3_events.keys
       buckets.each do |bucket|
         Jets::AwsServices::S3Bucket.ensure_exists(bucket)
       end

data/lib/jets/core.rb

@@ -158,8 +158,8 @@ module Jets::Core
     Jets.config.domain.hosted_zone_name
   end
 
-  def s3_event?
-    !Jets::Job::Base.s3_events.empty?
+  def s3_events?
+    !Jets::Job::Base._s3_events.empty?
   end
 
   def process(event, context, handler)

data/lib/jets/generators/job/templates/event_types/sns.rb.tt

@@ -4,6 +4,8 @@ class <%= class_name %>Job < ApplicationJob
   sns_event "hello-topic"
   def <%= options[:name] %>
     puts "event #{JSON.dump(event)}"
+    puts "sns_events #{JSON.dump(sns_events)}"
+    puts "sns_events? #{JSON.dump(sns_events?)}"
   end
 end
 <% end -%>

data/lib/jets/generators/job/templates/event_types/sqs.rb.tt

@@ -4,6 +4,8 @@ class <%= class_name %>Job < ApplicationJob
   sqs_event "hello-queue"
   def <%= options[:name] %>
     puts "event #{JSON.dump(event)}"
+    puts "sqs_events #{JSON.dump(sqs_events)}"
+    puts "sqs_events? #{JSON.dump(sqs_events?)}"
   end
 end
 <% end -%>

data/lib/jets/job/base.rb

@@ -10,17 +10,17 @@ module Jets::Job
     include Dsl
 
     # non-DSL methods
-    include Helpers::KinesisEventHelper
-    include Helpers::LogEventHelper
-    include Helpers::S3EventHelper
-    include Helpers::SnsEventHelper
-    include Helpers::SqsEventHelper
+    include Helpers::KinesisEvent
+    include Helpers::LogEvent
+    include Helpers::S3Event
+    include Helpers::SnsEvent
+    include Helpers::SqsEvent
     prepend Jets::ExceptionReporting::Process
 
     # Tracks bucket each time an s3_event is declared
     # Map of bucket_name => stack_name (nested part)
-    cattr_accessor :s3_events # dont want this to be inheritable intentionally
-    self.s3_events = {}
+    cattr_accessor :_s3_events # dont want this to be inheritable intentionally
+    self._s3_events = {}
 
     class << self
       def process(event, context, meth)

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

@@ -11,7 +11,7 @@ module Jets::Job::Dsl
       # We will not generate them again. However, we still need to always
       # add the depends_on declaration to ensure that the shared stack parameters
       # are properly passed to the nested child stack.
-      stack_name = s3_events[bucket_name] # already registered
+      stack_name = _s3_events[bucket_name] # already registered
       if stack_name
         depends_on stack_name.underscore.to_sym, class_prefix: true # always add this
         return stack_name
@@ -20,7 +20,7 @@ module Jets::Job::Dsl
       # Create shared resources - one time
       stack_name = declare_shared_s3_event_resources(bucket_name)
       depends_on stack_name.underscore.to_sym, class_prefix: true # always add this
-      self.s3_events[bucket_name] = stack_name # tracks buckets already set up
+      self._s3_events[bucket_name] = stack_name # tracks buckets already set up
     end
 
     def declare_shared_s3_event_resources(bucket_name)
@@ -29,8 +29,8 @@ module Jets::Job::Dsl
       s3_stack.stack_name
     end
 
-    def s3_events
-      Jets::Job::Base.s3_events
+    def _s3_events
+      Jets::Job::Base._s3_events
     end
   end
 end

data/lib/jets/job/helpers/{kinesis_event_helper.rb → kinesis_event.rb}

@@ -1,7 +1,7 @@
 require 'base64'
 
 module Jets::Job::Helpers
-  module KinesisEventHelper
+  module KinesisEvent
     def kinesis_data
       records = event["Records"]
       records.map do |record|

data/lib/jets/job/helpers/{log_event_helper.rb → log_event.rb}

@@ -4,7 +4,7 @@ require 'stringio'
 require 'zlib'
 
 module Jets::Job::Helpers
-  module LogEventHelper
+  module LogEvent
     def log_event
       encoded = event["awslogs"]["data"]
       compressed_string = Base64.decode64(encoded)

data/lib/jets/job/helpers/s3_event.rb

@@ -0,0 +1,50 @@
+module Jets::Job::Helpers
+  module S3Event
+    def s3_events
+      encoded_messages = event["Records"].map do |record|
+        record["Sns"]["Message"] # SNS message is JSON
+      end
+      # Decode the JSON messages
+      messages = encoded_messages.map do |message|
+        JSON.load(message)
+      end
+      # Extract the S3 event records
+      messages.map do |message|
+        message["Records"].map do |record|
+          ActiveSupport::HashWithIndifferentAccess.new(record)
+        end
+      end.flatten
+    end
+    alias s3_event_payloads s3_events
+
+    def s3_events?
+      event["Records"]&.any? { |r| r.dig("Sns", "Message") }
+    end
+    alias s3_event_payloads? s3_events?
+
+    def s3_objects
+      s3_events.map do |record|
+        record["s3"]["object"]
+      end
+    end
+
+    def s3_objects?
+      s3_events.any? { |r| r.dig("s3", "object") }
+    end
+
+    # Deprecated methods below
+    def s3_event
+      puts "WARN: s3_event is deprecated".color(:yellow)
+      puts "It can possibly drop events when they come in extremely fast."
+      puts "Use s3_events instead"
+      s3_events.first
+    end
+
+    def s3_object
+      puts "WARN: s3_object is deprecated".color(:yellow)
+      puts "It can possibly drop events when they come in extremely fast."
+      puts "Use s3_objects instead"
+      s3_objects.first
+    end
+  end
+end

data/lib/jets/job/helpers/{sns_event_helper.rb → sns_event.rb}

@@ -1,6 +1,6 @@
 module Jets::Job::Helpers
-  module SnsEventHelper
-    def sns_event_payloads
+  module SnsEvent
+    def sns_events
       records = event["Records"]
       return [] unless records
       records.map do |record|
@@ -8,17 +8,19 @@ module Jets::Job::Helpers
         ActiveSupport::HashWithIndifferentAccess.new(JSON.load(message))
       end
     end
+    alias sns_event_payloads sns_events
 
-    def sns_event_payloads?
+    def sns_events?
       event["Records"]&.any? { |r| r.dig("Sns", "Message") }
     end
+    alias sns_event_payloads? sns_events?
 
     # Deprecated methods below
     def sns_event_payload
       puts "WARN: sns_event_payload is deprecated".color(:yellow)
-      puts "It can possibly drop events when come in extremely fast."
-      puts "Use sns_event_payloads instead"
-      sns_event_payloads.first
+      puts "It can possibly drop events when they come in extremely fast."
+      puts "Use sns_events instead"
+      sns_events.first
     end
   end
 end

data/lib/jets/job/helpers/{sqs_event_helper.rb → sqs_event.rb}

@@ -1,6 +1,6 @@
 module Jets::Job::Helpers
-  module SqsEventHelper
-    def sqs_event_payloads
+  module SqsEvent
+    def sqs_events
       records = event["Records"]
       return [] unless records
       records.map do |record|
@@ -8,17 +8,19 @@ module Jets::Job::Helpers
         ActiveSupport::HashWithIndifferentAccess.new(JSON.load(message))
       end
     end
+    alias sqs_event_payloads sqs_events
 
-    def sqs_event_payloads?
+    def sqs_events?
       event["Records"]&.any? { |r| r.dig("body") }
     end
+    alias sqs_event_payloads? sqs_events?
 
     # Deprecated methods below
     def sqs_event_payload
       puts "WARN: sqs_event_payload is deprecated".color(:yellow)
-      puts "It can possibly drop events when come in extremely fast."
-      puts "Use sqs_event_payloads instead"
-      sqs_event_payloads.first
+      puts "It can possibly drop events when they come in extremely fast."
+      puts "Use sqs_events instead"
+      sqs_events.first
     end
   end
 end

data/lib/jets/stack/function.rb

@@ -56,6 +56,8 @@ class Jets::Stack
 
     # Internal flag is mainly used to disable WARN messages
     def internal?
+      return true if internal_search_expression.include?("jets/base_path")
+      return true if internal_search_expression.include?("jets/s3_bucket_config")
       !!Dir.glob(internal_search_expression).first
     end
 

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "5.0.7"
+  VERSION = "5.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 5.0.7
+  version: 5.0.8
 platform: ruby
 authors:
 - Tung Nguyen
@@ -1039,11 +1039,11 @@ files:
 - lib/jets/job/dsl/s3_event.rb
 - lib/jets/job/dsl/sns_event.rb
 - lib/jets/job/dsl/sqs_event.rb
-- lib/jets/job/helpers/kinesis_event_helper.rb
-- lib/jets/job/helpers/log_event_helper.rb
-- lib/jets/job/helpers/s3_event_helper.rb
-- lib/jets/job/helpers/sns_event_helper.rb
-- lib/jets/job/helpers/sqs_event_helper.rb
+- lib/jets/job/helpers/kinesis_event.rb
+- lib/jets/job/helpers/log_event.rb
+- lib/jets/job/helpers/s3_event.rb
+- lib/jets/job/helpers/sns_event.rb
+- lib/jets/job/helpers/sqs_event.rb
 - lib/jets/klass.rb
 - lib/jets/lambda/definition.rb
 - lib/jets/lambda/dsl.rb

data/lib/jets/job/helpers/s3_event_helper.rb

@@ -1,45 +0,0 @@
-module Jets::Job::Helpers
-  module S3EventHelper
-    def s3_event_payloads
-      messages = event["Records"].map do |record|
-        record["Sns"]["Message"]
-      end
-      messages.map do |message|
-        h = JSON.load(message)
-        ActiveSupport::HashWithIndifferentAccess.new(h)
-      end
-    end
-
-    def s3_event_payloads?
-      event["Records"]&.any? { |r| r.dig("Sns", "Message") }
-    end
-
-    def s3_objects
-      s3_event_payloads.map do |payload|
-        records = payload["Records"]
-        records.map do |record|
-          record["s3"]["object"]
-        end
-      end.flatten
-    end
-
-    def s3_objects?
-      s3_event_payloads["Records"]&.any? { |r| r.dig("s3", "object") }
-    end
-
-    # Deprecated methods below
-    def s3_event
-      puts "WARN: s3_event is deprecated".color(:yellow)
-      puts "It can possibly drop events when come in extremely fast."
-      puts "Use s3_event_payloads instead"
-      s3_event_payloads.first
-    end
-
-    def s3_object
-      puts "WARN: s3_object is deprecated".color(:yellow)
-      puts "It can possibly drop events when come in extremely fast."
-      puts "Use s3_objects instead"
-      s3_objects.first
-    end
-  end
-end