deferred_request 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a9e96cf574be720de97ae91ae7f06d09b082d56ffc2aef3eae449653dbce7b9
+  data.tar.gz: f604991997404bf38fad4cae5fd40b5b00088d952f0f3d15bd1a64b4f9d4a078
+SHA512:
+  metadata.gz: ffa3d29e8e24b1c6dc48200cb6463f4facef2ded394cd820b0a5083dee8948f779b2f0e439779a8276a786dffbfc6790b20679a98d1481861a2b8bd9410677a3
+  data.tar.gz: 5bffe0fe31acd967710261f6a23925ccf48db5b9e1b573df520eec7d6d42c97df13cf92ac1d7853007d945fd3ac4ae2fb2ecee0cff8bef62eaf70dc380d08673

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Austin Miller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# 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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "deferred_request"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install deferred_request
+```
+
+### Migrations
+Copy the Deferred Request migrations to your app:
+
+```bash
+bin/rails deferred_request:install:migrations
+```
+
+Then, run the migrations:
+
+```bash
+bin/rails db:migrate
+```
+
+## Usage
+
+### Controllers
+In your controllers you can use the library like so. **Make sure you add a method with a `_deferred` suffix so that it can be processed later**
+
+```ruby
+# app/controllers/twilio.rb
+
+# ... (snipped for brevity)
+def status_callback
+  # We can go ahead and give a :ok response (fast and snappy)
+  head :ok
+
+  # Then queue the request to run later
+  deferred_request = DeferredRequest::DeferredRequest.from_request(request, params)
+  deferred_request.save!
+
+  deferred_request.peform_later
+end
+
+# Your deferred request method will be called later (via a job)
+# deferred_request will be of type DeferredRequest::DeferredRequest
+def status_callback_deferred(deferred_request)
+  # do some actual processing
+  if deferred_request.params["SmsStatus"] == "delivered"
+    # mark message as delivered
+  end
+
+  # return a status and it will be saved to the database
+  true
+end
+# ...
+```
+
+## 🙏 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.
+
+If you'd like to open a PR please make sure the following things pass:
+
+```ruby
+bin/rails db:test:prepare
+bin/rails test
+bundle exec standardrb
+```
+
+## 📝 License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/deferred_request_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/deferred_request .css

data/app/assets/stylesheets/deferred_request/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/deferred_request/application_controller.rb

@@ -0,0 +1,4 @@
+module DeferredRequest
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/deferred_request/test_controller.rb

@@ -0,0 +1,26 @@
+module DeferredRequest
+  class TestController < ApplicationController
+    skip_before_action :verify_authenticity_token
+    
+    def status_callback
+      # We can go ahead and give a :ok response (fast and snappy)
+      head :ok
+
+      # Then queue the request to run later
+      deferred_request = DeferredRequest::DeferredRequest.from_request(request, params)
+      deferred_request.save!
+
+      deferred_request.peform_later
+    end
+
+    def status_callback_deferred(deferred_request)
+      # do some actual processing
+      if deferred_request.params["SmsStatus"] == "delivered"
+        # mark message as delivered
+      end
+    
+      # return a status and it will be saved to the database
+      true
+    end
+  end
+end

data/app/helpers/deferred_request/application_helper.rb

@@ -0,0 +1,4 @@
+module DeferredRequest
+  module ApplicationHelper
+  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/application_job.rb

@@ -0,0 +1,4 @@
+module DeferredRequest
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/deferred_request/deferred_request_job.rb

@@ -0,0 +1,13 @@
+module DeferredRequest
+  class DeferredRequestJob < ApplicationJob
+    queue_as :default
+
+    def perform(*args)
+      id = args[0]
+      request = DeferredRequest.find(id)
+      request.perform!
+    rescue ActiveRecord::RecordNotFound
+      Rails.logger.error("DeferredRequest::DeferredRequestJob: Could not find DeferredRequest with id: #{id}")
+    end
+  end
+end

data/app/mailers/deferred_request/application_mailer.rb

@@ -0,0 +1,6 @@
+module DeferredRequest
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/deferred_request/application_record.rb

@@ -0,0 +1,5 @@
+module DeferredRequest
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/deferred_request/deferred_request.rb

@@ -0,0 +1,62 @@
+module DeferredRequest
+  class DeferredRequest < ApplicationRecord
+    serialize :routing, JSON, default: {}
+    serialize :request, JSON, default: {}
+
+    store_accessor :routing, "controller", "action"
+    store_accessor :request, "url", "method", "headers", "params", "remote_ip"
+
+    enum status: {queued: 0, processing: 1, complete: 2, error: 99}
+
+    # request: ActionDispatch::Request
+    # create a deferred request from a ActionDispatch::Request
+    def self.from_request(request)
+      deferred_request = DeferredRequest.new
+
+      debugger
+      deferred_request.controller = request.controller_class
+      deferred_request.action = request.params["action"]
+      
+      deferred_request.url = request.url
+      deferred_request.method = request.method
+      deferred_request.headers = get_headers(request)
+      deferred_request.params = request.params.except(:controller, :action)
+      deferred_request.remote_ip = request.remote_ip
+
+      deferred_request
+    end
+
+    def perform_later
+      DeferredRequestJob.perform_later(self.id)
+    end
+
+    def perform!
+      begin
+        self.status = :processing
+        self.save!
+
+        klass = self.controller.constantize.new
+
+        self.result = klass.try("#{self.action}_deferred".to_sym, self)
+        self.status = :complete
+      rescue => e
+        Rails.logger.error("DeferredRequest::DeferredRequestJob: #{e.message}")
+        self.result = e.message
+        self.status = :error
+      end
+      
+      self.save!
+    end
+
+    private
+
+      def self.get_headers(request)
+        # Get the request headers from the request
+        {}.tap do |t|
+          request.headers.each do |key, value|
+            t[key] = value if key.downcase.starts_with?("http")
+          end
+        end
+      end
+  end
+end

data/app/views/layouts/deferred_request/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Deferred request</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "deferred_request/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+DeferredRequest::Engine.routes.draw do
+  post 'status_callback' => 'deferred_request/test#status_callback'
+end

data/db/migrate/20220204152629_create_deferred_request_deferred_requests.rb

@@ -0,0 +1,12 @@
+class CreateDeferredRequestDeferredRequests < ActiveRecord::Migration[7.0]
+  def change
+    create_table :deferred_request_deferred_requests do |t|
+      t.text :request
+      t.text :routing
+      t.text :result
+      t.integer :status, default: 0, null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/deferred_request/engine.rb

@@ -0,0 +1,5 @@
+module DeferredRequest
+  class Engine < ::Rails::Engine
+    isolate_namespace DeferredRequest
+  end
+end

data/lib/deferred_request/version.rb

@@ -0,0 +1,3 @@
+module DeferredRequest
+  VERSION = "0.0.1"
+end

data/lib/deferred_request.rb

@@ -0,0 +1,6 @@
+require "deferred_request/version"
+require "deferred_request/engine"
+
+module DeferredRequest
+  # Your code goes here...
+end

data/lib/tasks/deferred_request_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :deferred_request do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: deferred_request
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Austin Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A simple library to defer http requests until you can actually process
+  them. (Think webhooks. Stripe webhooks, Twilio status callbacks, ect.)
+email:
+- austinrmiller1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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
+- app/models/deferred_request/application_record.rb
+- app/models/deferred_request/deferred_request.rb
+- app/views/layouts/deferred_request/application.html.erb
+- config/routes.rb
+- db/migrate/20220204152629_create_deferred_request_deferred_requests.rb
+- lib/deferred_request.rb
+- lib/deferred_request/engine.rb
+- lib/deferred_request/version.rb
+- lib/tasks/deferred_request_tasks.rake
+homepage: https://github.com/armiiller/deferred_request
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/armiiller/deferred_request
+  source_code_uri: https://github.com/armiiller/deferred_request
+  changelog_uri: https://github.com/armiiller/deferred_request/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Deferred Request
+test_files: []