deferred_request 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f42d6bf58362f626487d9c3cb0eb217458f701f7a2914f3d61eecc16e2408f8
-  data.tar.gz: aab7531ae28bf9f9f7d9b489c2295c4d3f653c51926a97040702f3243adbb1e9
+  metadata.gz: 4a12d759682c3ca5d2e1171cc6da944e80ce6a9b0f3ccfb65dcaca5d10b2a0c9
+  data.tar.gz: 6ef803175b32093e08d330caebb28d06fbd31e0c3db33f34304ec3163b31e63a
 SHA512:
-  metadata.gz: 6550b077f0211a6be67703a5532178d39c4f42e116d43f11c89b144e0c7bde7167bf0e7c1939cd4364bdc2cc5fcf0cd5e3c84533a10e10f896a4c4e9c0610223
-  data.tar.gz: d55b79b4b0e56f400aaba2b2599be015e71e153e0dc64a3cb484ae32b32aa613dbc42c870de5407b893f0aba761a5adde74e625c48c87dc14a7ecc7f8ca00382
+  metadata.gz: d2efcff67bba0f0d7fcd75ae8e08e8cb120412753cc1a1e5439ea37b13bae5323095a866e9d7671be31c13701e8c85aeeb060592537d9b1e087a658884a08cb7
+  data.tar.gz: 5004f590c976b08777e42753b19bb53588dfe54386e6470818ab366f60b363748f0c87728c963a499eba0cd6fafcbba0b422430c35353f784ff3d10921ff5399

data/README.md

@@ -62,6 +62,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/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,5 +1,5 @@
 module DeferredRequest
-  class DeferredRequest < ApplicationRecord
+  class DeferredRequest < DeferredRequest.model_parent_class.constantize
     serialize :routing
     serialize :request
     serialize :result
@@ -12,7 +12,7 @@ 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.name
       deferred_request.action = request.params["action"]
@@ -31,6 +31,8 @@ module DeferredRequest
       deferred_request.save!
 
       deferred_request.perform_later
+
+      deferred_request
     end
 
     def perform_later

data/lib/deferred_request/version.rb

@@ -1,3 +1,3 @@
 module DeferredRequest
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 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.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Austin Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails