deferred_request 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9cbe479d0ec2429ded46aacbdd786b3ba69b19dcbc32609ca7875bb51b97a5
-  data.tar.gz: fbdb8dee9068fb03bc4e5b6385968be177ad8b6e0d15149304d5876b0ec20bdc
+  metadata.gz: e70685ead353b7f372259b99b066332d915805dfbf38ddedc21078f44b74ed82
+  data.tar.gz: 39af06490c5cfa0da0c3f915e5d36a97512e0c01507cd4dc5b69bc63c2e6a6b0
 SHA512:
-  metadata.gz: db92fd506d4170270ba261ca9c3909809fd3b411b36b6141d7f207840e60abcb72fb2862b934de4c5ea72e8d7ac99453e6fe97f5e0766b95ca48435d551f9b5d
-  data.tar.gz: 0bd4f541e34984dd95f19942577e5a968c8f9b2fadf8bcf6151982fa8aea970259bf41264279aa47eb9d67abe457444973881b7a22f94652016349976ed5feb4
+  metadata.gz: cd8748279c4834f63a412102aca293c3b60ab750386057e898060a7b400467b3130b32bfc2a9840c5dfc687810a78fb4e0b351d2bd6a78148134ae3e0d25e69f
+  data.tar.gz: a85efe11d6530d6071f5562e5c8fe7920e20f0c8fccb88fa30527ec13559323ead68b5dfe46f40bea44e97fd31d464ae85351352dff5ff39be4d563ef30b0dfd

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/deferred_request.svg)](https://badge.fury.io/rb/deferred_request)
+
 # Deferred Request
 A simple plugin to defer an http request until you can actually process it. This is good in situtations where work performed is not needed immidiately (think status callbacks from services like Twilio or Stripe). This pattern can help prevent you from getting DDoS'd by services you might interact with.
 
@@ -45,10 +47,7 @@ def status_callback
   head :ok
 
   # Then queue the request to run later
-  deferred_request = DeferredRequest::DeferredRequest.from_request(request)
-  deferred_request.save!
-
-  deferred_request.peform_later
+  deferred_request = DeferredRequest::DeferredRequest.perform_later_from_request!(request)
 end
 
 # Your deferred request method will be called later (via a job)
@@ -65,6 +64,27 @@ end
 # ...
 ```
 
+### Class Methods
+- `DeferredRequest::DeferredRequest.from_request(request)` - returns a DeferredRequest::DeferredRequest object (unsaved). Returns the DeferredRequest::DeferredRequest instance.
+- `DeferredRequest::DeferredRequest.perform_later_from_request!(request)` - creates a deferred request (saved) and enqueues job to process the request. Returns the DeferredRequest::DeferredRequest instance.
+
+### Instance Methods
+- `deferred_request.perform_later` - Enqueues a job to `perform!` the deferred request later. Returns the job id.
+- `deferred_request.perform!` - Calls the `#{controller}_deferred(deferred_request)` method to be processed. Returns the deferred_request instance or raises an exception.
+
+## Configuration
+
+- `DeferredRequest.model_parent_class` - Set the parent class
+- `DeferredRequest.deferred_request_instance_class` - Set the instance class that is created (in-case you sub-class)
+- `DeferredRequest.job_queue` - Set the job queue for the deferred request job
+
+```ruby
+# config/initializers/deferred_request.rb
+DeferredRequest.model_parent_class = "MyParentClass"
+DeferredRequest.job_queue = "low"
+```
+
+
 ## 🙏 Contributing
 
 If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.

data/app/controllers/deferred_request/test_controller.rb

@@ -0,0 +1,19 @@
+module DeferredRequest
+  class TestController < ApplicationController
+    def status_callback
+      head :ok
+      DeferredRequest.perform_later_from_request!(request)
+    end
+
+    def status_callback_deferred(deferred_request)
+      # Do something with the deferred request
+      deferred_request.params.dig("answer")
+    end
+
+    def status_error
+      # don't add the "_deferred" method (used for testing)
+      head :ok
+      DeferredRequest.perform_later_from_request!(request)
+    end
+  end
+end

data/app/helpers/deferred_request/test_helper.rb

@@ -0,0 +1,4 @@
+module DeferredRequest
+  module TestHelper
+  end
+end

data/app/jobs/deferred_request/deferred_request_job.rb

@@ -1,6 +1,6 @@
 module DeferredRequest
   class DeferredRequestJob < ApplicationJob
-    queue_as :default
+    queue_as ::DeferredRequest.job_queue
 
     def perform(*args)
       id = args[0]

data/app/models/deferred_request/deferred_request.rb

@@ -1,7 +1,8 @@
 module DeferredRequest
-  class DeferredRequest < ApplicationRecord
+  class DeferredRequest < DeferredRequest.model_parent_class.constantize
     serialize :routing, JSON
     serialize :request, JSON
+    serialize :result, JSON
 
     store_accessor :routing, "controller", "action"
     store_accessor :request, "url", "method", "headers", "params", "remote_ip"
@@ -11,9 +12,9 @@ module DeferredRequest
     # request: ActionDispatch::Request
     # create a deferred request from a ActionDispatch::Request
     def self.from_request(request)
-      deferred_request = DeferredRequest.new
+      deferred_request = ::DeferredRequest.deferred_request_instance_class.constantize.new
 
-      deferred_request.controller = request.controller_class
+      deferred_request.controller = request.controller_class.name
       deferred_request.action = request.params["action"]
 
       deferred_request.url = request.url
@@ -30,6 +31,8 @@ module DeferredRequest
       deferred_request.save!
 
       deferred_request.perform_later
+
+      deferred_request
     end
 
     def perform_later
@@ -43,7 +46,7 @@ module DeferredRequest
 
         klass = controller.constantize.new
 
-        self.result = klass.try("#{action}_deferred".to_sym, self)
+        self.result = klass.send("#{action}_deferred".to_sym, self)
         self.status = :complete
       rescue => e
         Rails.logger.error("DeferredRequest::DeferredRequestJob: #{e.message}")

data/config/routes.rb

@@ -1,2 +1,4 @@
 DeferredRequest::Engine.routes.draw do
+  post "status_callback" => "test#status_callback"
+  post "status_error" => "test#status_error"
 end

data/lib/deferred_request/version.rb

@@ -1,3 +1,3 @@
 module DeferredRequest
-  VERSION = "1.0.0"
+  VERSION = "1.0.4"
 end

data/lib/deferred_request.rb

@@ -4,5 +4,11 @@ require "deferred_request/engine"
 module DeferredRequest
   # Your code goes here...
   mattr_accessor :model_parent_class
-  @@model_parent_class = "ActiveRecord::Base"
+  @@model_parent_class = "ApplicationRecord"
+
+  mattr_accessor :deferred_request_instance_class
+  @@deferred_request_instance_class = "DeferredRequest::DeferredRequest"
+
+  mattr_accessor :job_queue
+  @@job_queue = "default"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deferred_request
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Austin Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,9 @@ files:
 - app/assets/config/deferred_request_manifest.js
 - app/assets/stylesheets/deferred_request/application.css
 - app/controllers/deferred_request/application_controller.rb
+- app/controllers/deferred_request/test_controller.rb
 - app/helpers/deferred_request/application_helper.rb
+- app/helpers/deferred_request/test_helper.rb
 - app/jobs/deferred_request/application_job.rb
 - app/jobs/deferred_request/deferred_request_job.rb
 - app/mailers/deferred_request/application_mailer.rb