disc 0.0.28 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5afabb650aa27d3b020674c300b2c2f198da7562
-  data.tar.gz: 309002ddceb18dbbae790371d6761330044591ef
+  metadata.gz: 7e4f52b8bcd6d2c7b0648a5943c23f41c2fc71b0
+  data.tar.gz: 45fded657cbdd9122369e9cee62a0f451fb65309
 SHA512:
-  metadata.gz: 73c4688d1d3363c68f4927bfc9096efc1ac353371d1a4f0a67bcf22c48e5bd1f7e9d57f2771d2dbb831340f939531757d160797d0915753a41ef1e11ed9ab2cb
-  data.tar.gz: c4fa2f21bb5d56b00c658aa72c3e66f307b5c86a77af9f9e9ef917794fd63faa14a2edb16d60a7bd792a78ecdc8cfc29d450a58dea8040ac9c5debd1aade71be
+  metadata.gz: 29e37f6f7c7b706345a66699beca6513f3adb1351b61d4a6d99513a207f0798af25a59542514f1728e56254c772e0df5cbfda5cab24a10efe8071abf75b8ec79
+  data.tar.gz: d8917b863ef3073e27ed2804174e8719d71d1021adc5c45eca79873a13988eadf9293b2f668936da140f311a204f8a94c57d216bb2a1f69d9ec2089694cfb94a

data/README.md

@@ -61,6 +61,20 @@ Disc fills the gap between your Ruby service objects and [antirez](http://antire
   )
   ```
 
+## Disc Configuration
+
+Disc takes its configuration from environment variables.
+
+| ENV Variable       |  Default Value   | Description
+|:------------------:|:-----------------|:------------|
+| `QUEUES`           | 'default'        | The list of queues that `Disc::Worker` will listen to, it can be a single queue name or a list of comma-separated queues |
+| `DISC_CONCURRENCY` | '25'             | Amount of threads to spawn when Celluloid is available. |
+| `DISQUE_NODES`     | 'localhost:7711' | This is the list of Disque servers to connect to, it can be a single node or a list of comma-separated nodes |
+| `DISQUE_AUTH`      | ''               | Authorization credentials for Disque. |
+| `DISQUE_TIMEOUT`   | '100'            | Time in milliseconds that the client will wait for the Disque server to acknowledge and replicate a job |
+| `DISQUE_CYCLE`     | '1000'           | The client keeps track of which nodes are providing more jobs, after the amount of operations specified in cycle it tries to connect to the preferred node. |
+
+
 ## Disc Jobs
 
 `Disc::Job` is a module you can include in your Ruby classes, this allows a Disc worker process to execute the code in them by adding a class method (`#enqueue`) with the following signature:
@@ -146,6 +160,38 @@ end
 ComplexJob.enqueue(['first argument', { second: 'argument' }])
 ```
 
+### Job Status
+
+After a job is enqueued, you can check it's current status like so:
+
+```ruby
+Echoer.enqueue('test')
+#=> "DIa18101491133639148a574eb30cd2e12f25dcf8805a0SQ"
+
+Disc["DIa18101491133639148a574eb30cd2e12f25dcf8805a0SQ"]
+#=> {
+  "arguments"=>["test"],
+  "class"=>"Echoer",
+  "id"=>"DIa18101491133639148a574eb30cd2e12f25dcf8805a0SQ",
+  "queue"=>"test",
+  "state"=>"queued",
+  "repl"=>1,
+  "ttl"=>86391,
+  "ctime"=>1462488116652000000,
+  "delay"=>0,
+  "retry"=>8640,
+  "nacks"=>0,
+  "additional-deliveries"=>0,
+  "nodes-delivered"=>["a18101496d562e412a459c6b114561efe95c57cc"],
+  "nodes-confirmed"=>[],
+  "next-requeue-within"=>8630995,
+  "next-awake-within"=>8630495,
+  "body"=>"{\"class\":\"Echoer\",\"arguments\":[\"test\"]}"
+}
+```
+
+This information might vary, as it's retreived from Disque via the [`SHOW`](https://github.com/antirez/disque#show-job-id) command, only `arguments` and `class` are filled in by Disc, which are added by using `Disc.deserialize` on the `body` value.
+
 ### Job Serialization
 
 Job information (their arguments, and class) need to be serialized in order to be stored
@@ -158,19 +204,6 @@ By default, these methods use by default the Ruby standard library json implemen
 2. You can override `Disc.serialize` and `Disc.deserialize` to use a different JSON implementation, or MessagePack, or whatever else you wish.
 
 
-## Settings
-
-Disc takes its configuration from environment variables.
-
-| ENV Variable       |  Default Value   | Description
-|:------------------:|:-----------------|:------------|
-| `QUEUES`           | 'default'        | The list of queues that `Disc::Worker` will listen to, it can be a single queue name or a list of comma-separated queues |
-| `DISC_CONCURRENCY` | '25'             | Amount of threads to spawn when Celluloid is available. |
-| `DISQUE_NODES`     | 'localhost:7711' | This is the list of Disque servers to connect to, it can be a single node or a list of comma-separated nodes |
-| `DISQUE_AUTH`      | ''               | Authorization credentials for Disque. |
-| `DISQUE_TIMEOUT`   | '100'            | Time in milliseconds that the client will wait for the Disque server to acknowledge and replicate a job |
-| `DISQUE_CYCLE`     | '1000'           | The client keeps track of which nodes are providing more jobs, after the amount of operations specified in cycle it tries to connect to the preferred node. |
-
 ## Error handling
 
 When a job raises an exception, `Disc.on_error` is invoked with the error and
@@ -222,8 +255,6 @@ Disc.queues
 
 Returner.enqueue('another test')
 #=> => {"default"=>[{:arguments=>["test argument"], :class=>"Returner", :options=>{}}, {:arguments=>["another test"], :class=>"Returner", :options=>{}}]}
-
-
 ```
 
 You can still flush the queues just as you would running on regular mode.

data/lib/disc/version.rb

@@ -1,3 +1,3 @@
 class Disc
-  VERSION = "0.0.28"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disc
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.1.0
 platform: ruby
 authors:
 - pote
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disque