postburner 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6faa3078340ee2bc8d90e931ee1db203114e32ff69b288ec69340e8b86a987cd
-  data.tar.gz: 0a2ddf78a320e9b01c26a0e3fbd3158b78d37a89bca04a5fdd8c64b70eada1a7
+  metadata.gz: ffbffc2cebbe2e83bfff21178b71d0b205756cd6ef05c6dc30c8029d073c70d7
+  data.tar.gz: 68136a8de901340817dcd60e0fbd3b6794eb6dea2f8da386af138576dbba6334
 SHA512:
-  metadata.gz: 5253309eb7aff502623040d49e923faff7c91df6aac407ec7a4e306a8317b1363db43a4b0408eb20fbdad6ee017ad68489480ac50d7e2ac68a612a1337488457
-  data.tar.gz: 49d0253fe3ecde9cfd4de8b48a2ce95997245bea4310f7c751ccca3685fea8a42b29310a8058f222031ee8aa91f6ec61f990ec5c330157e39853c95830236cfa
+  metadata.gz: 319ebb136625b266efe9189c8f6114ee7153ad18503b6d38343609a8bcb62dc3ea814b4b22e60f685f90f68957a2c9647ff3c958e26983796fc2c40bb8cb981c
+  data.tar.gz: 0fb16c1e08994dc7676b1546dc9d492c51243a9bcf8ffa9a2367b0a4274ecd806c322f00b6304a637fbfa20ddb2bc0872bd5ccdb357bba1d518f60f589edbf46

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.5.0 - 2021-10-27
+
+### Added
+- add mailer, action, params accessors to Mailer for easy access in subclassed jobs.
+- add logging to Mailer perform.
+- add save to #queue! job if unsaved
+- add block with logging if queued_at isn't set or isn't prior to run time.
+
 ## v0.4.0 - 2021-10-12
 
 ### Added

data/app/models/postburner/job.rb

@@ -1,4 +1,17 @@
 module Postburner
+  # Must implement a perform method, if an exception is raised the job
+  # doesn't complete.
+  #
+  # Job won't run unless queued_at is set, and is set to a time prior to
+  # the time the job runs.
+  #
+  # TODO Mailer uses ActiveJob::Arguments... probably should use that here
+  # as well. Decided how to migrate existing jobs or allow both - Opt to 
+  # allow both: rescue from ActiveJob::DeserializationError and use the
+  # plain hash, probably log it too.
+  #
+  # Add `cancelled_at` that blocks jobs performing if present.
+  #
   class Job < ApplicationRecord
     include Backburner::Queue
 
@@ -17,6 +30,8 @@ module Postburner
     def queue!(options={})
       return if self.queued_at.present? && self.bkid.present?
 
+      self.save!
+
       case
       when options[:at].present?
         # this is rudimentary, add error handling
@@ -33,14 +48,15 @@ module Postburner
     # tube: backburner.worker.queue.backburner-jobs
     #
     def self.perform(id, _={})
+      job = nil
       begin
         job = self.find(id)
-        job.perform!(job.args)
       rescue ActiveRecord::RecordNotFound => e
         Rails.logger.warn <<-MSG
 [Postburner::Job] [#{id}] Not Found.
         MSG
       end
+      job&.perform!(job.args)
     end
 
     def perform!(args={})
@@ -55,6 +71,16 @@ module Postburner
       )
 
       begin
+        if self.queued_at.nil?
+          self.log! "Not Queued", level: :error
+          return
+        end
+
+        if self.queued_at > Time.zone.now
+          self.log! "Future Queued", level: :error
+          return
+        end
+
         if self.processed_at.present?
           self.log! "Already Processed", level: :error
           self.delete!
@@ -179,7 +205,11 @@ module Postburner
     private
 
     def insert!(options={})
-      response = Backburner::Worker.enqueue(Postburner::Job, self.id, options)
+      response = Backburner::Worker.enqueue(
+        Postburner::Job,
+        self.id,
+        options
+      )
 
       self.log("QUEUED: #{response}")
 

data/app/models/postburner/mailer.rb

@@ -7,8 +7,8 @@ module Postburner
   class Mailer < Job
     #queue 'mailers'
 
-    def self.deliver(mailer, action)
-      job = self.create!(
+    def self.delivery(mailer, action)
+      job = self.new(
         args: {
           mailer: mailer.to_s,
           action: action.to_s,
@@ -17,32 +17,62 @@ module Postburner
       job
     end
 
+    def self.delivery!(mailer, action)
+      job = self.delivery(mailer, action)
+      job.save!
+      job
+    end
+
     # Similar to ActionMailer #with - set the parameters
     #
     def with(params={})
       self.args.merge!(
-        params: ActiveJob::Arguments.serialize(params)
+        'params' => ActiveJob::Arguments.serialize(params)
       )
+      self
+    end
+
+    def with!(params={})
+      self.with(params)
       self.save!
       self
     end
 
     # Build the mail but don't send.
     #
-    def assemble(args=nil)
-      _args = args || self.args
+    # Optional `args` argument for testing convenience.
+    #
+    def assemble
+      mail = self.mailer.with(self.params).send(self.action)
+      mail
+    end
 
-      cls = _args['mailer'].constantize
+    # Get the mailer class.
+    #
+    def mailer
+      self.args['mailer'].constantize
+    end
 
-      mail = cls.
-        with(ActiveJob::Arguments.deserialize(_args['params']).to_h).
-        send(_args['action'])
+    # Get the mailer action as a symbol.
+    #
+    def action
+      self.args['action']&.to_sym
+    end
 
-      mail
+    # Get the deserialized params.
+    #
+    def params
+      ActiveJob::Arguments.deserialize(self.args['params']).to_h
     end
 
     def perform(args)
-      self.assemble(args).deliver_now
+      self.log! "Building"
+      mail = self.assemble
+
+      self.log! "Delivering"
+      mail.deliver_now
+
+      self.log! "Delivered"
     end
   end
 end

data/lib/postburner/version.rb

@@ -1,3 +1,3 @@
 module Postburner
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postburner
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails