resque-approve 0.0.1

data/lib/resque/server/views/_approval_key_rows.erb

@@ -0,0 +1,18 @@
+<% summary_rows.each do |pending_job| %>
+  <tr>
+    <td>
+      <a href="<%= u("approve") %>/job_list?<%= { approval_key: pending_job.approval_key }.to_param %>">
+        <%= pending_job.approval_key %>
+      </a>
+    </td>
+    <td>
+      <%= pending_job.num_jobs.to_i %>
+    </td>
+    <td>
+      <% if pending_job.first_enqueued.present? %>
+        <%= time_ago_in_words(pending_job.first_enqueued) %> ago
+        (<%= pending_job.first_enqueued %>)
+      <% end %>
+    </td>
+  </tr>
+<% end %>

data/lib/resque/server/views/_job_list_table.erb

@@ -0,0 +1,30 @@
+<div class="table_container">
+  <table>
+    <tr>
+      <th>Class</th>
+      <th>Enqueued</th>
+      <th>Parameters</th>
+      <th>Options</th>
+    </tr>
+    <% jobs.each do |job_details| %>
+      <tr>
+        <td>
+          <a href="<%= u("approve/job_details") %>?<%=
+            { job_id: job_details.id }.to_param %>">
+            <%= job_details.class_name %>
+          </a>
+        </td>
+        <td>
+          <%= time_ago_in_words(job_details.queue_time) %> ago
+          (<%= job_details.queue_time %>)
+        </td>
+        <td>
+          <pre><code><%= "".html_safe + job_details.args.to_yaml %></code></pre>
+        </td>
+        <td>
+          <pre><code><%= "".html_safe + job_details.approve_options.to_hash.to_yaml %></code></pre>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/lib/resque/server/views/_job_pagination.erb

@@ -0,0 +1,67 @@
+<div class="approve_pagination_block">
+  <% total_pages = pending_queue.num_jobs / page_size %>
+  <% total_pages += 1 if pending_queue.num_jobs % page_size > 0 %>
+  <% page_num = 1 if page_num > total_pages || page_num < 1 %>
+  <% first_page = [1, page_num - 3].max %>
+  <% last_page = [total_pages, page_num + 3].min %>
+  <% last_page = page_num < 4 ? [total_pages, last_page + (4 - page_num)].min : last_page %>
+  <% first_page = page_num > total_pages - 3 ? [1, first_page + ((total_pages - page_num) - 3)].max : first_page %>
+
+  <% if total_pages > 1 %>
+    <div class="approve_prev_links">
+      <a href="<%= u("approve/job_list") %>?<%=
+        { approval_key: approval_key,
+          page_size:    page_size,
+          page_num:     1 }.to_param %>"
+         class="approve_first_page"
+         disabled="<%= first_page > 1 %>">
+        &lt;&lt; First
+      </a>
+
+      <a href="<%= u("approve/job_list") %>?<%=
+        { approval_key: approval_key,
+          page_size:    page_size,
+          page_num:     [1, page_num - 1].max }.to_param %>"
+         class="approve_prev_page"
+         disabled="<%= page_num > 1 %>">
+        &lt; Prev
+      </a>
+    </div>
+
+    <div class="approve_pages">
+      <% (first_page..last_page).each do |page_number| %>
+        <% if page_number != page_num %>
+          <a href="<%= u("approve/job_list") %>?<%=
+            { approval_key: approval_key,
+              page_size:    page_size,
+              page_num:     page_number }.to_param %>"
+             class="approve_page">
+            <%= page_number %>
+          </a>
+        <% else %>
+          <%= page_number %>
+        <% end %>
+      <% end %>
+    </div>
+
+    <div class="approve_next_links">
+      <a href="<%= u("approve/job_list") %>?<%=
+        { approval_key: approval_key,
+          page_size:    page_size,
+          page_num:     [total_pages, page_num + 1].min }.to_param %>"
+         class="approve_next_page"
+         disabled="<%= page_num < last_page %>">
+        Next &gt;
+      </a>
+
+      <a href="<%= u("approve/job_list") %>?<%=
+        { approval_key: approval_key,
+          page_size:    page_size,
+          page_num:     total_pages }.to_param %>"
+         class="approve_last_page"
+         disabled="<%= last_page < total_pages %>">
+        Last &gt;&gt;
+      </a>
+    </div>
+  <% end %>
+</div>

data/lib/resque/server/views/approval_keys.erb

@@ -0,0 +1,66 @@
+<link href="<%= u("approve/public/approve.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<h1>Approval Keys</h1>
+
+<% approval_key_list = Resque::Plugins::Approve::ApprovalKeyList.new %>
+
+<div class="approve_reset" />
+
+<%= erb(File.read(Resque::ApproveServer.erb_path("_approval_key_list_pagination.erb")),
+        locals: { queue_list: approval_key_list, page_num: @page_num, page_size: @page_size }) %>
+
+<div class="table_container">
+  <table>
+    <tr>
+      <th><a href="<%= u("approve") %>?<%=
+        { sort:      "approval_key",
+          page_size: @page_size,
+          page_num:  @page_num,
+          order:     approval_key_list.
+              order_param("approval_key", @sort_by, @sort_order) }.to_param %>">
+        Approval Key
+      </a></th>
+      <th><a href="<%= u("approve") %>?<%=
+        { sort:      "num_jobs",
+          page_size: @page_size,
+          page_num:  @page_num,
+          order:     approval_key_list.
+              order_param("num_jobs", @sort_by, @sort_order) }.to_param %>">
+        Pending Jobs
+      </a></th>
+      <th><a href="<%= u("approve") %>?<%=
+        { sort:      "first_enqueued",
+          page_size: @page_size,
+          page_num:  @page_num,
+          order:     approval_key_list.
+              order_param("first_enqueued", @sort_by, @sort_order) }.to_param %>">
+        First Enqueued
+      </a></th>
+    </tr>
+
+    <%= erb(File.read(Resque::ApproveServer.erb_path("_approval_key_rows.erb")),
+            locals: { summary_rows: approval_key_list.queues(@sort_by, @sort_order, @page_num, @page_size) }) %>
+  </table>
+</div>
+
+<%= erb(File.read(Resque::ApproveServer.erb_path("_approval_key_list_pagination.erb")),
+        locals: { queue_list: approval_key_list, page_num: @page_num, page_size: @page_size }) %>
+
+<br/>
+
+<div>
+  <form method="POST" action="<%= u("approve/audit_jobs") %>">
+    <input type="submit" name="" value="Audit Jobs"/>
+  </form>
+  <form method="POST" action="<%= u("approve/audit_queues") %>">
+    <input type="submit" name="" value="Audit Queues"/>
+  </form>
+  <form method="POST" action="<%= u("approve/approve_all_queues") %>">
+    <input type="submit" name="" value="Approve All Queues"/>
+  </form>
+  <form method="POST" action="<%= u("approve/delete_all_queues") %>">
+    <input type="submit" name="" value="Delete All Queues"/>
+  </form>
+</div>
+<div class="approve_reset"/>
+<br/>

data/lib/resque/server/views/job_details.erb

@@ -0,0 +1,82 @@
+<link href="<%= u("approve/public/approve.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<% job_details = Resque::Plugins::Approve::PendingJob.new(@job_id) %>
+
+<h1>
+  <%= job_details.class_name %>
+</h1>
+
+<p>
+  <a href="<%= u("approve") %>">
+    Approval Keys
+  </a>
+  |
+  <a href="<%= u("approve/job_list") %>?<%= { approval_key: job_details.approval_key }.to_param %>">
+    <%= job_details.approval_key %>
+  </a>
+</p>
+
+<div class="table_container">
+  <table>
+    <tr>
+      <td>
+        Enqueued
+      </td>
+      <td>
+        <%= time_ago_in_words(job_details.queue_time) %> ago
+        (<%= job_details.queue_time %>)
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Class
+      </td>
+      <td>
+        <%= job_details.class_name %>
+      </td>
+    </tr>
+    </tr>
+    <tr>
+      <td>
+        Params
+      </td>
+      <td>
+        <pre><code><%= "".html_safe + job_details.args.to_yaml %></code></pre>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Queue
+      </td>
+      <td>
+        <%= job_details.approval_queue %>
+      </td>
+    </tr>
+    <% if job_details.approval_at.present? && job_details.approval_at > Time.now %>
+      <tr>
+        <td>
+          Enqueue After
+        </td>
+        <td>
+          <%= job_details.approval_at %>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+
+<br/>
+
+<form method="POST" action="<%= u("approve/delete_job") %>?<%=
+  { job_id: @job_id }.to_param %>">
+  <input type="submit" name="" value="Delete Job"/>
+</form>
+
+<form method="POST" action="<%= u("approve/approve_job") %>?<%=
+  { job_id: @job_id }.to_param %>">
+  <input type="submit" name="" value="Approve Job"/>
+</form>
+
+<div class="approve_reset"/>
+
+<br/>

data/lib/resque/server/views/job_list.erb

@@ -0,0 +1,58 @@
+<link href="<%= u("approve/public/approve.css") %>" media="screen" rel="stylesheet" type="text/css">
+
+<% pending_queue = Resque::Plugins::Approve::PendingJobQueue.new(@approval_key) %>
+
+<h1>
+  <%= pending_queue.approval_key %>
+</h1>
+
+<p>
+  <a href="<%= u("approve") %>">
+    Approval Keys
+  </a>
+</p>
+
+<% if pending_queue.num_jobs > 0 %>
+  <h1>Jobs</h1>
+
+  <% jobs = pending_queue.paged_jobs(@page_num, @page_size) %>
+  <%= erb(File.read(Resque::ApproveServer.erb_path("_job_pagination.erb")),
+          locals: { pending_queue: pending_queue,
+                    approval_key:  @approval_key,
+                    page_num:      @page_num,
+                    page_size:     @page_size }) %>
+
+  <%= erb(File.read(Resque::ApproveServer.erb_path("_job_list_table.erb")),
+          locals: { jobs: jobs, show_class: false }) %>
+
+  <%= erb(File.read(Resque::ApproveServer.erb_path("_job_pagination.erb")),
+          locals: { pending_queue: pending_queue,
+                    approval_key:  @approval_key,
+                    page_num:      @page_num,
+                    page_size:     @page_size }) %>
+
+  <br/>
+
+  <form method="POST" action="<%= u("approve/delete_queue") %>?<%=
+    { approval_key: pending_queue.approval_key }.to_param %>">
+    <input type="submit" name="" value="Delete All"/>
+  </form>
+
+  <form method="POST" action="<%= u("approve/delete_one_queue") %>?<%=
+    { approval_key: pending_queue.approval_key }.to_param %>">
+    <input type="submit" name="" value="Delete One"/>
+  </form>
+
+  <form method="POST" action="<%= u("approve/approve_queue") %>?<%=
+    { approval_key: pending_queue.approval_key }.to_param %>">
+    <input type="submit" name="" value="Approve All"/>
+  </form>
+
+  <form method="POST" action="<%= u("approve/approve_one_queue") %>?<%=
+    { approval_key: pending_queue.approval_key }.to_param %>">
+    <input type="submit" name="" value="Approve One"/>
+  </form>
+<% end %>
+
+<div class="approve_reset"/>
+<br/>

data/lib/tasks/resque-approve_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :resque do
+#   # Task goes here
+# end

data/spec/approve/approval_key_list_spec.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Resque::Plugins::Approve::ApprovalKeyList do
+  let(:key_list) { Resque::Plugins::Approve::ApprovalKeyList.new }
+  let!(:key) { Faker::Lorem.sentence }
+  let(:job) { Resque::Plugins::Approve::PendingJob.new SecureRandom.uuid, class_name: BasicJob, args: [approval_key: key] }
+  let(:job_queue) { Resque::Plugins::Approve::PendingJobQueue.new(key) }
+  let(:multiple_queues) { Array.new(3) { Faker::Lorem.sentence } }
+  let(:multiple_jobs) do
+    index = 0
+    multiple_queues.map do |approval_key|
+      Array.new(4) do
+        job = Resque::Plugins::Approve::PendingJob.new(SecureRandom.uuid, class_name: BasicJob, args: [index, approval_key: approval_key])
+
+        index += 1
+        key_list.add_job(job)
+
+        job
+      end
+    end
+  end
+
+  describe "#order_param" do
+    it "returns asc for any column other than the current one" do
+      expect(key_list.order_param("sort_option",
+                                  "current_sort",
+                                  %w[asc desc].sample)).to eq "asc"
+    end
+
+    it "returns desc for the current column if it is asc" do
+      expect(key_list.order_param("sort_option", "sort_option", "asc")).to eq "desc"
+    end
+
+    it "returns asc for the current column if it is desc" do
+      expect(key_list.order_param("sort_option", "sort_option", "desc")).to eq "asc"
+    end
+  end
+
+  describe "remove_key" do
+    it "removes the key if it is in the list" do
+      key_list.add_key key
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.remove_key key }.to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues }.by(-1))
+    end
+
+    it "does nothing if it is not in the list" do
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.remove_key key }.not_to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues })
+    end
+  end
+
+  describe "add_key" do
+    it "adds the key if it is not in the list" do
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.add_key key }.to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues }.by(1))
+    end
+
+    it "does nothing if it is in the list" do
+      key_list.add_key key
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.add_key key }.not_to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues })
+    end
+  end
+
+  describe "add_job" do
+    it "adds the key if it is not in the list" do
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.add_job job }.to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues }.by(1))
+    end
+
+    it "does not add the key if it is in the list" do
+      key_list.add_key key
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      expect { key_list.add_job job }.not_to(change { Resque::Plugins::Approve::ApprovalKeyList.new.num_queues })
+    end
+
+    it "adds the job to the queue if it isn't already there" do
+      10.times do
+        key_list.add_key(Faker::Lorem.sentence)
+      end
+
+      key_list.add_job job
+
+      expect(job_queue.jobs.last.id).to eq job.id
+      expect(job_queue.jobs.last).to eq job
+    end
+  end
+
+  describe "delete_all" do
+    before(:each) do
+      multiple_jobs
+    end
+
+    it "deletes all jobs for all queues" do
+      key_list.delete_all
+
+      multiple_jobs.flatten.each do |job|
+        expect(Resque::Plugins::Approve::PendingJob.new(job.id).class_name).to be_blank
+      end
+    end
+
+    it "deletes all queues" do
+      queues = key_list.queues
+
+      key_list.delete_all
+
+      queues.each do |queue|
+        expect(queue.num_jobs).to be_zero
+      end
+    end
+
+    it "deletes all keys" do
+      key_list.delete_all
+
+      expect(Resque::Plugins::Approve::ApprovalKeyList.new.num_queues).to be_zero
+    end
+  end
+
+  describe "approve_all" do
+    before(:each) do
+      multiple_jobs
+
+      allow(Resque).to receive(:enqueue_to).and_call_original
+    end
+
+    it "approves all jobs for all queues" do
+      key_list.approve_all
+
+      index = 0
+      multiple_jobs.flatten.each do |job|
+        expect(Resque::Plugins::Approve::PendingJob.new(job.id).class_name).to be_blank
+        expect(Resque).to have_received(:enqueue_to).with "Some_Queue", BasicJob, index
+
+        index += 1
+      end
+    end
+
+    it "approves all queues" do
+      queues = key_list.queues
+
+      key_list.approve_all
+
+      queues.each do |queue|
+        expect(queue.num_jobs).to be_zero
+      end
+    end
+
+    it "does not delete any keys" do
+      key_list.approve_all
+
+      expect(Resque::Plugins::Approve::ApprovalKeyList.new.num_queues).to eq 3
+    end
+  end
+
+  describe "queues" do
+    let(:sorted_queue_names) { Array.new(30) { |index| "#{index.to_s.rjust(3, "0")} - #{Faker::Lorem.sentence}" } }
+    let(:sorted_age) { Array.new(30) { |index| sorted_queue_names[ages.find_index(index)] }.reverse }
+    let(:sorted_counts) { Array.new(30) { |index| sorted_queue_names[counts.find_index(index)] } }
+    let(:ages) { Array.new(30) { |index| index }.sample(100) }
+    let(:counts) { Array.new(30) { |index| index }.sample(100) }
+    let!(:jobs) do
+      index = 0
+
+      sorted_queue_names.map do |approval_key|
+        Timecop.freeze(ages[index].hours.ago) do
+          Array.new(1 + counts[index]) do
+            job = Resque::Plugins::Approve::PendingJob.new(SecureRandom.uuid, class_name: BasicJob, args: [approval_key: approval_key])
+
+            key_list.add_job(job)
+
+            job
+          end
+        end
+
+        index += 1
+      end
+    end
+
+    RSpec.shared_examples("pages queues") do
+      it "defaults to return the first 20 queues ascending" do
+        expect(key_list.queues(sort_key).map(&:approval_key)).to eq sorted_values[0..19]
+      end
+
+      it "does not allow negative page sizes" do
+        expect(key_list.queues(sort_key, 0, 0).map(&:approval_key)).to eq sorted_values[0..19]
+      end
+
+      it "pages ascending" do
+        expect(key_list.queues(sort_key, "asc", 4, 3).map(&:approval_key)).
+            to eq sorted_values[9..11]
+      end
+
+      it "sorts descending" do
+        expect(key_list.queues(sort_key, "desc").map(&:approval_key)).
+            to eq sorted_values.reverse[0..19]
+      end
+
+      it "pages descending" do
+        expect(key_list.queues(sort_key, "desc", 4, 3).map(&:approval_key)).
+            to eq sorted_values.reverse[9..11]
+      end
+
+      it "does not do negative pages" do
+        expect(key_list.queues(sort_key, "desc", -4, 3).map(&:approval_key)).
+            to eq sorted_values.reverse[0..2]
+      end
+
+      it "does not do to large pages" do
+        expect(key_list.queues(sort_key, "desc", 400, 3).map(&:approval_key)).
+            to eq sorted_values.reverse[0..2]
+      end
+    end
+
+    describe "approval_key" do
+      let(:sort_key) { :approval_key }
+      let(:sorted_values) { sorted_queue_names }
+
+      it_behaves_like "pages queues"
+    end
+
+    describe "num_jobs" do
+      let(:sort_key) { :num_jobs }
+      let(:sorted_values) { sorted_counts }
+
+      it_behaves_like "pages queues"
+    end
+
+    describe "first_enqueued" do
+      let(:sort_key) { :first_enqueued }
+      let(:sorted_values) { sorted_age }
+
+      it_behaves_like "pages queues"
+    end
+  end
+
+  describe "job_queues" do
+    let(:sorted_queue_names) { Array.new(30) { |index| "#{index.to_s.rjust(3, "0")} - #{Faker::Lorem.sentence}" } }
+    let!(:jobs) do
+      sorted_queue_names.map do |approval_key|
+        job = Resque::Plugins::Approve::PendingJob.new(SecureRandom.uuid, class_name: BasicJob, args: [approval_key: approval_key])
+
+        key_list.add_job(job)
+
+        job
+      end
+    end
+
+    it "returns all queues unsorted" do
+      expect(key_list.job_queues.map(&:approval_key).sort).to eq sorted_queue_names
+    end
+  end
+
+  describe "num_queues" do
+    let(:sorted_queue_names) { Array.new(30) { |index| "#{index.to_s.rjust(3, "0")} - #{Faker::Lorem.sentence}" } }
+    let!(:jobs) do
+      sorted_queue_names.map do |approval_key|
+        job = Resque::Plugins::Approve::PendingJob.new(SecureRandom.uuid, class_name: BasicJob, args: [approval_key: approval_key])
+
+        key_list.add_job(job)
+
+        job
+      end
+    end
+
+    it "returns the total number of queues" do
+      expect(key_list.num_queues).to eq 30
+    end
+  end
+end