delivery_uncle 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c82ca7fd6f9519d2be47f9a80ebc224ddaaee316
+  data.tar.gz: 567fa4e2d40269dd757215fe540ed4a7f624735c
+SHA512:
+  metadata.gz: fdbc42aeff0635ddcc6400a82f6cfa8767cc7cd251d4a30bd5f1f6327c1620cac42af7053c9327acb1bef8fff5c9335acc7c880decef4e236548ff8e70134350
+  data.tar.gz: 0a477d7668f1714688f562f61845de9287216a65314ef4956eb4d95333a2a7cd5fbe946cdffb30a0581801c32cce02eb6b0cd814e2f86596180aff09625153e7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeliveryUncle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/delivery_uncle/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/delivery_uncle/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 vendor/assets/stylesheets of plugins, if any, 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/delivery_uncle/application_controller.rb

@@ -0,0 +1,3 @@
+class DeliveryUncle::ApplicationController < ApplicationController
+  MAILERS = []
+end

data/app/controllers/delivery_uncle/email_requests_controller.rb

@@ -0,0 +1,108 @@
+require_dependency "delivery_uncle/application_controller"
+
+module DeliveryUncle
+  class EmailRequestsController < ApplicationController
+
+    def index
+      requests = EmailRequest.order_by_latest
+      pagination = paginate.page(requests, params)
+     
+      @requests = pagination.data
+      @pagination = pagination
+    end
+
+    def show
+      @request = email_request 
+    end
+
+    def pause
+      EmailQueue.pause(email_request) if email_request.present?
+      redirect_to email_requests_url
+    end
+
+    def pause_all
+      if email_request.present?
+        EmailRequest.
+          not_sent.
+          with_mailer_method(email_request.mailer, email_request.mailer_method).
+          each do |entry|
+            EmailQueue.pause(entry)
+          end
+      end
+      redirect_to email_requests_url
+    end
+
+    def retry
+      EmailQueue.retry(email_request) if email_request.present?
+      redirect_to email_requests_url
+    end
+
+    def retry_all
+      if email_request.present?
+        EmailRequest.
+          not_sent.
+          with_mailer_method(email_request.mailer, email_request.mailer_method).
+          each do |entry|
+            EmailQueue.retry(entry)
+          end
+      end
+      redirect_to email_requests_url
+    end
+  
+    def configure
+      @mailers = union_of_mailers - Activity.blocked_mailers
+      @blocked_mailers = Activity.blocked_mailers
+    end
+
+    def block
+      mailer ? 
+        act_on_mailer(:block_mailer, mailer) :
+        error_mailer_not_found
+      redirect_to action: :configure
+    end
+
+    def unblock
+      mailer ? 
+        act_on_mailer(:unblock_mailer, mailer) : 
+        error_mailer_not_found
+      redirect_to action: :configure
+    end
+    
+    private
+    def error_mailer_not_found
+      flash[:error] = "Mailer not found."
+    end
+      
+    def mailer
+      return nil if params[:mailer].blank?
+      union_of_mailers.include?(params[:mailer]) ? 
+        params[:mailer] : nil
+    end
+    
+    def union_of_mailers
+      (MAILERS | EmailRequest.mailers).sort
+    end
+
+    def act_on_mailer(verb, mailer)
+      activity = Activity.new
+      activity.actor = current_user_email
+      activity.verb = verb
+      activity.object_type = mailer
+      activity.save!
+    end
+
+    def current_user_email
+      :user
+    end
+
+    def email_request
+      return nil if params[:id].blank?
+      @email_request ||= EmailRequest.find(params[:id])
+    end
+    
+    PER_PAGE = 20
+    def paginate
+      Paginate.new(PER_PAGE)
+    end
+  end
+end

data/app/helpers/delivery_uncle/application_helper.rb

@@ -0,0 +1,4 @@
+module DeliveryUncle
+  module ApplicationHelper
+  end
+end

data/app/models/delivery_uncle/activity.rb

@@ -0,0 +1,25 @@
+module DeliveryUncle
+  class Activity < ActiveRecord::Base 
+    scope :not_expired, -> { where("expired is null or expired = 0")}
+    scope :with_object_type, ->(object_type) { where(object_type: object_type) }
+    scope :with_verb, ->(verb) { where(verb: verb) }
+    
+    validates_presence_of :actor, :verb, :object_type
+    after_create :expire_blocked_mailers
+    
+    def expire_blocked_mailers
+      case verb
+      when :unblock_mailer
+        self.class.with_verb(:block_mailer).with_object_type(object_type).each do |activity|
+          activity.expired = true
+          activity.save
+        end
+      end
+    end
+
+    def self.blocked_mailers
+      not_expired.with_verb(:block_mailer).map(&:object_type)
+    end
+
+  end
+end

data/app/models/delivery_uncle/email_request.rb

@@ -0,0 +1,23 @@
+module DeliveryUncle
+  class EmailRequest < ActiveRecord::Base 
+    scope :order_by_latest, -> { order('created_at DESC') }
+    scope :not_sent, -> { where('status != ?', 'sent') }
+    scope :with_mailer_method, ->(mailer, mailer_method) { where(mailer: mailer, mailer_method: mailer_method) }      
+    
+    def mail
+      ::Mail.new(mail_body)
+    end
+    
+    def paused?
+      status == :paused || status == 'paused'
+    end
+
+    def sent?
+      status == :sent || status == 'sent'
+    end
+    
+    def self.mailers
+      group(:mailer).order('mailer ASC').map(&:mailer)
+    end
+  end
+end

data/app/services/delivery_uncle/deliver.rb

@@ -0,0 +1,29 @@
+module DeliveryUncle
+  class Deliver
+    
+    def initialize(mailer, mailer_method, *args)
+      mail = mailer.send(mailer_method, *args)
+      
+      raise 'mail with attachment is not supported yet' if mail.has_attachments? 
+      
+      @request = DeliveryUncle::EmailRequest.new  
+      @request.mail_body = mail.to_s
+      @request.mailer = mailer.to_s
+      @request.mailer_method = mailer_method
+      @request.status = :new
+      @request.mail_type = :deliver
+      @request.request_from = caller[1][/`.*'/][1..-2]
+ 
+      deliver(@request) if @request.save!
+    end
+    
+    def request
+      @request
+    end
+
+    private
+    def deliver(request)
+      EmailQueue.queue(request)
+    end
+  end
+end

data/app/services/delivery_uncle/email_queue.rb

@@ -0,0 +1,58 @@
+module DeliveryUncle
+  class EmailQueue
+    module ClassMethods
+      def queue(request)
+        return if not_allowed?(request)
+        
+        save_status(request, :enqueue)
+        QueueRequest.new(request)
+        save_status(request, :queued)
+      end
+
+      def pause(request)
+        return if not_allowed?(request)
+        
+        save_status(request, :paused)
+      end
+
+      def retry(request)
+        return if not_allowed?(request)
+        
+        save_status(request, :retrying)
+        RetryRequest.new(request)
+        save_status(request, :queued)
+      end
+ 
+      def not_allowed?(request)
+        return true if request.blank? || request.sent?
+
+        if Activity.blocked_mailers.include?(request.mailer)
+          save_status(request, :blocked)
+          return true
+        end
+
+        return false
+      end
+     
+      private
+      def save_status(request, status)
+        request.status = status
+        request.save
+      end
+    end
+    extend ClassMethods 
+     
+    protected
+    class QueueRequest
+      def initialize(request)
+        Resque.enqueue(DeliveryUncle::SendEmailRequest, request.id)
+      end
+    end
+    
+    class RetryRequest
+      def initialize(request)
+        QueueRequest.new(request)
+      end
+    end  
+  end
+end

data/app/services/delivery_uncle/paginate.rb

@@ -0,0 +1,35 @@
+module DeliveryUncle
+  class Paginate
+    def initialize(per_page=20)
+      @per_page = per_page
+    end
+    
+    def page(model, params) 
+      @page = params[:page].present? ? params[:page].to_i :  1
+      @params = params
+      start = (@page-1) * @per_page 
+      start = 0 if start < 0
+      @size = model.count
+      @model = model.limit(@per_page).offset(start)
+      self
+    end
+    
+    def data
+      @model
+    end
+
+    def prev_page_url
+      return nil unless @page > 1
+      @params.merge({page: @page-1})
+    end
+
+    def next_page_url
+      return nil if end_of_page?
+      @params.merge(page: @page +1)
+    end
+
+    def end_of_page?
+      @page*@per_page > @size
+    end
+  end
+end

data/app/views/delivery_uncle/email_requests/configure.html.erb

@@ -0,0 +1,25 @@
+<h1>Configure</h1>
+
+<% if message = flash[:error] %>
+  <div>
+    <strong style="color: red;">Error: <%= message %></strong>
+  </div>
+<% end %>
+
+<div>
+<%= form_tag({action: :block, method: :post}, multipart: true) do %>
+  <b>Block Mailer:</b>
+  <br><%=select_tag(:mailer, options_for_select(@mailers)) %>
+  <br><%= submit_tag 'Block', class: 'btn', confirm: 'The chosen mailer will not be blocked, Continue?'%>
+<% end %>
+</div>
+
+<div>  
+<%= form_tag({action: :unblock, method: :post}, multipart: true) do %>
+  <b>Unblock Mailer:</b>
+  <br><%=select_tag(:mailer, options_for_select(@blocked_mailers)) %>
+  <br><%= submit_tag 'Unblock', class: 'btn', confirm: 'The chosen mailer will be unblocked, Continue?'%>
+<% end %>
+</div>
+
+<%=link_to '< back to mails', action: :index %> 

data/app/views/delivery_uncle/email_requests/index.html.erb

@@ -0,0 +1,44 @@
+<h1>Mails</h1>
+<div style="float:right"><%=link_to 'configure', action: :configure %></div>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Mailer</th>
+      <th>Mailer Method</th>
+      <th>Request Date</th>
+      <th>Last Update</th>
+      <th>Status</th>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% @requests.each do |request| %>
+    <tr>
+      <td><%=link_to request.id, request %></td>
+      <td><%=request.mailer %></td>
+      <td>
+        <%=request.mailer_method %>
+        <% if !request.sent? %>
+          <%=link_to('pause all', pause_all_email_request_path(request)) unless request.paused?%> &nbsp;
+          <%=link_to('retry all', retry_all_email_request_path(request)) %>
+        <% end %>
+      </td>
+      <td><%=time_ago_in_words(request.created_at) %> ago</td>
+      <td><%=time_ago_in_words(request.updated_at) %> ago</td>
+      <td><%=request.status %></td>
+      <td>
+        <% if !request.sent? %>
+          <%=link_to('pause', pause_email_request_path(request)) unless request.paused? %>&nbsp;
+          <%=link_to 'retry', retry_email_request_path(request) %>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<% if @pagination %>
+  <%=link_to '< prev', @pagination.prev_page_url if @pagination.prev_page_url%>&nbsp;
+  <%=link_to 'next >', @pagination.next_page_url if @pagination.next_page_url%> 
+<% end %>

data/app/views/delivery_uncle/email_requests/show.html.erb

@@ -0,0 +1,8 @@
+<h1>
+  <%="#{@request.mailer}::#{@request.mailer_method}" %> (id: <%=@request.id%>)
+</h1>
+
+<div>
+<%=simple_format(@request.mail.body.decoded) %>
+</div>
+<%=link_to '< back to mails', action: :index %>

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DeliveryUncle</title>
+  <%= stylesheet_link_tag    "delivery_uncle/application", media: "all" %>
+  <%= javascript_include_tag "delivery_uncle/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/workers/delivery_uncle/send_email_request.rb

@@ -0,0 +1,29 @@
+module DeliveryUncle
+  class SendEmailRequest
+    @queue = "delivery_uncle:email_request"
+
+    def self.perform(request_id)
+      request = DeliveryUncle::EmailRequest.find(request_id)
+      
+      return if request.paused? || EmailQueue.not_allowed?(request)
+      change_status(request, :processing)
+      
+      @queue = "delivery_uncle:#{request.mail_type}" if request.mail_type
+      
+      begin 
+        mail = request.mail
+        method = ActionMailer::Base.delivery_method
+        mail.delivery_method method, ActionMailer::Base.send(:"#{method}_settings")
+        mail.deliver
+        change_status(request, :sent)
+      rescue
+        change_status(request, :error_when_deliver)
+      end
+    end
+
+    def self.change_status(request, status)
+      request.status = status
+      request.save
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,13 @@
+DeliveryUncle::Engine.routes.draw do
+  resources :email_requests, only: [:index, :show] do
+    get :pause_all, on: :member
+    get :pause, on: :member
+    get :retry_all, on: :member
+    get :retry, on: :member
+    get :configure, on: :collection
+    post :block, on: :collection
+    post :unblock, on: :collection
+  end
+  
+  root to: 'email_requests#index'
+end

data/lib/delivery_uncle/engine.rb

@@ -0,0 +1,25 @@
+module DeliveryUncle
+  class Engine < ::Rails::Engine
+    isolate_namespace DeliveryUncle
+
+    config.autoload_paths << File.expand_path("../app/workers", __FILE__)
+    config.autoload_paths << File.expand_path("../app/services", __FILE__)
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+      g.factory_girl dir: 'spec/factories'
+    end
+    
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+    config.after_initialize do
+      require_dependency root.join('app/models/delivery_uncle/email_request.rb').to_s
+    end
+
+  end
+end

data/lib/delivery_uncle/version.rb

@@ -0,0 +1,3 @@
+module DeliveryUncle
+  VERSION = "0.1.2"
+end

data/lib/delivery_uncle.rb

@@ -0,0 +1,4 @@
+require "delivery_uncle/engine"
+
+module DeliveryUncle
+end

data/lib/generators/delivery_uncle/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module DeliveryUncle
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_table_email_requests.rb", "db/migrate/create_table_email_requests.rb"
+        migration_template "create_table_activities.rb", "db/migrate/create_table_activities.rb"
+      end
+    end
+  end
+end

data/lib/generators/delivery_uncle/install/templates/create_table_activities.rb

@@ -0,0 +1,18 @@
+class CreateTableActivities < ActiveRecord::Migration
+  def change
+    create_table :delivery_uncle_activities do |t|
+      t.string :actor
+      t.text :actor_desc
+
+      t.string :verb
+      t.text :verb_desc
+
+      t.string :object_type
+      t.text :object_details
+
+      t.boolean :expired
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/delivery_uncle/install/templates/create_table_email_requests.rb

@@ -0,0 +1,14 @@
+class CreateTableEmailRequests < ActiveRecord::Migration
+  def change
+    create_table :delivery_uncle_email_requests do |t|
+      t.text :mail_body
+      t.string :mailer
+      t.string :mailer_method
+      t.string :mail_type
+      t.string :request_from
+      t.string :status
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/delivery_uncle_tasks.rake

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