Provide API for manipulating various jobs

* Including retries, scheduled, failed, and regular jobs
* Add tests

Author: akira

lib/exq/api.ex

@@ -8,38 +8,93 @@ defmodule Exq.Api do
     Exq.start_link(Keyword.put(opts, :mode, :api))
   end
 
+  @doc """
+  List of queues with jobs (empty queues are deleted)
+
+  Expected args:
+    * `pid` - Exq.Api process
+
+  Returns:
+  * `{:ok, queues}` - list of queue
+  """
   def queues(pid) do
     GenServer.call(pid, :queues)
   end
 
+  @doc """
+  Clear / Remove queue
+
+  Expected args:
+    * `pid` - Exq.Api process
+    * `queue` - Queue name
+
+  Returns:
+  * `{:ok, queues}` - list of queue
+  """
+  def remove_queue(pid, queue) do
+    GenServer.call(pid, {:remove_queue, queue})
+  end
+
+
+  @doc """
+  Number of busy workers
+
+  Expected args:
+    * `pid` - Exq.Api process
+
+  Returns:
+  * `{:ok, num_busy}` - number of busy workers
+  """
   def busy(pid) do
     GenServer.call(pid, :busy)
   end
 
-  def stats(pid, key) do
-    GenServer.call(pid, {:stats, key})
-  end
+  @doc """
+  Number of processes
 
-  def stats(pid, key, date) do
-    GenServer.call(pid, {:stats, key, date})
-  end
+  Expected args:
+    * `pid` - Exq.Api process
+    * `key` - Key for stat
+    * `queue` - Queue name
 
+  Returns:
+  * `{:ok, stat}` stat for key
+  """
   def processes(pid) do
     GenServer.call(pid, :processes)
   end
 
+  def clear_processes(pid) do
+    GenServer.call(pid, :clear_processes)
+  end
+
+  @doc """
+  List jobs enqueued
+
+  Expected args:
+    * `pid` - Exq.Api process
+
+  Returns:
+  * `{:ok, [{queue, [jobs]}, {queue, [jobs]}]}`
+  """
   def jobs(pid) do
     GenServer.call(pid, :jobs)
   end
 
+  @doc """
+  List jobs enqueued
+
+  Expected args:
+    * `pid` - Exq.Api process
+    * `queue` - Queue name
+
+  Returns:
+  * `{:ok, [jobs]}`
+  """
   def jobs(pid, queue) do
     GenServer.call(pid, {:jobs, queue})
   end
 
-  def failed(pid) do
-    GenServer.call(pid, :failed)
-  end
-
   def retries(pid) do
     GenServer.call(pid, :retries)
   end
@@ -48,26 +103,31 @@ defmodule Exq.Api do
     GenServer.call(pid, {:jobs, :scheduled})
   end
 
+  def scheduled_with_scores(pid) do
+    GenServer.call(pid, {:jobs, :scheduled_with_scores})
+  end
+
+  def find_job(pid, queue, jid) do
+    GenServer.call(pid, {:find_job, queue, jid})
+  end
+
+  def remove_job(pid, queue, jid) do
+    GenServer.call(pid, {:remove_job, queue, jid})
+  end
+
   def queue_size(pid) do
     GenServer.call(pid, :queue_size)
   end
-  def queue_size(pid, :scheduled) do
-    GenServer.call(pid, {:queue_size, :scheduled})
-  end
   def queue_size(pid, queue) do
     GenServer.call(pid, {:queue_size, queue})
   end
 
-  def find_failed(pid, jid) do
-    GenServer.call(pid, {:find_failed, jid})
-  end
-
-  def find_job(pid, queue, jid) do
-    GenServer.call(pid, {:find_job, queue, jid})
+  def failed(pid) do
+    GenServer.call(pid, :failed)
   end
 
-  def remove_queue(pid, queue) do
-    GenServer.call(pid, {:remove_queue, queue})
+  def find_failed(pid, jid) do
+    GenServer.call(pid, {:find_failed, jid})
   end
 
   def remove_failed(pid, jid) do
@@ -78,12 +138,59 @@ defmodule Exq.Api do
     GenServer.call(pid, :clear_failed)
   end
 
-  def clear_processes(pid) do
-    GenServer.call(pid, :clear_processes)
+  def failed_size(pid) do
+    GenServer.call(pid, :failed_size)
+  end
+
+  def find_retry(pid, jid) do
+    GenServer.call(pid, {:find_retry, jid})
+  end
+
+  def remove_retry(pid, jid) do
+    GenServer.call(pid, {:remove_retry, jid})
   end
 
-  def retry_failed(pid, jid) do
-    GenServer.call(pid, {:retry_failed, jid})
+  def clear_retries(pid) do
+    GenServer.call(pid, :clear_retries)
+  end
+
+  def retry_size(pid) do
+    GenServer.call(pid, :retry_size)
+  end
+
+  def find_scheduled(pid, jid) do
+    GenServer.call(pid, {:find_scheduled, jid})
+  end
+
+  def remove_scheduled(pid, jid) do
+    GenServer.call(pid, {:remove_scheduled, jid})
+  end
+
+  def clear_scheduled(pid) do
+    GenServer.call(pid, :clear_scheduled)
+  end
+
+  def scheduled_size(pid) do
+    GenServer.call(pid, :scheduled_size)
+  end
+
+  @doc """
+  Return stat for given key
+  Examples of keys are `processed`, `failed`
+
+  Expected args:
+    * `pid` - Exq.Api process
+    * `key` - Key for stat
+    * `queue` - Queue name
+
+  Returns:
+  * `{:ok, stat}` stat for key
+  """
+  def stats(pid, key) do
+    GenServer.call(pid, {:stats, key})
+  end
+  def stats(pid, key, date) do
+    GenServer.call(pid, {:stats, key, date})
   end
 
   def realtime_stats(pid) do