disque 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ab3407c0c795f337c046fa94c96e67f9f2be51b
-  data.tar.gz: 8c0c0aedf7f7a97edf30512bc8558b8bca019bbe
+  metadata.gz: 567ba45ec3c94e38a4cdd18cc6a58db6960cb6cf
+  data.tar.gz: f6e258e52e77636493ada87f131ce8495ef97c85
 SHA512:
-  metadata.gz: bb908195fd598056f7af0f0e45834996b4ae57f479afada1b1b4e21177cc49e4083cfd2bf708736c451102656c33069ebaad29c8af3879d6b79f8b50d597338e
-  data.tar.gz: 63945a37c822eef761d2fa7f8dd5c75de68f91c54d319572a38d066481b2421feed6a4eb0de55553ba35b45e8e9e838a980ef2602a1699315f203fa89e6f3955
+  metadata.gz: 4f933756f0b4165e327f8ce4ea93315d527806bfb9b6a20a5af0c3d2dad25eb219fb06c610410a561f88446ba1c12bbac292126369c9e924ec2c8fde614e0caa
+  data.tar.gz: 8f3ad9b91c3d16703fa1d77ae1d64be07108ed59bcf3225c1782d16a773413abcd5eb63c39a1ba4dae6973eab67140443b40952b71528323438b71070060fe8e

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.0.5
+
+- Change API to receive a string of nodes
+
 0.0.4
 
 - Add AUTH option.

data/README.md

@@ -12,15 +12,60 @@ Create a new Disque client by passing a list of nodes:
 client = Disque.new(["127.0.0.1:7711", "127.0.0.1:7712", "127.0.0.1:7713"])
 ```
 
+Alternatively, you can pass a single string with comma-separated nodes:
+
+```ruby
+client = Disque.new("127.0.0.1:7711,127.0.0.1:7712,127.0.0.1:7713")
+```
+
+Using a single string is useful if you are receiving the list of nodes
+from an environment variable.
+
+If the nodes are password protected, you can pass the `AUTH` string:
+
+```ruby
+client = Disque.new("127.0.0.1:7711", auth: "e727d1464a...")
+```
+
+The client keeps track of which nodes are providing more jobs, and after
+a given number operations it tries to connect to the preferred node. The
+number of operations for each cycle defaults to 1000, but it can be
+configured:
+
+```ruby
+client = Disque.new("127.0.0.1:7711", cycle: 20000)
+```
+
 Now you can add jobs:
 
 ```ruby
 client.push("foo", "bar", 100)
 ```
 
-It will push the job "bar" to the queue "foo" with a timeout of 100
-ms, and return the id of the job if it was received and replicated
-in time.
+It will push the job `"bar"` to the queue `"foo"` with a timeout
+of 100 ms, and return the id of the job if it was received and
+replicated in time.
+
+Disque's `ADDJOB` signature is as follows:
+
+```
+ADDJOB queue_name job <ms-timeout>
+  [REPLICATE <count>]
+  [DELAY <sec>]
+  [RETRY <sec>]
+  [TTL <sec>]
+  [MAXLEN <count>]
+  [ASYNC]
+```
+
+You can pass any optional arguments as a hash, for example:
+
+```ruby
+disque.push("foo", "myjob", 1000, ttl: 1, async: true)
+```
+
+Note that `async` is a special case because it's just a flag. That's
+why `true` must be passed as its value.
 
 Then, your workers will do something like this:
 
@@ -32,6 +77,13 @@ loop do
 end
 ```
 
+The `fetch` command receives an array of queues, and optionally a
+`timeout` (in milliseconds) and the `count` of jobs to retrieve:
+
+```ruby
+client.fetch(from: ["bar", "baz"], count: 10, timeout: 2000)
+```
+
 Installation
 ------------
 

data/disque.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "disque"
-  s.version           = "0.0.4"
+  s.version           = "0.0.5"
   s.summary           = "Client for Disque"
   s.description       = "Disque client for Ruby"
   s.authors           = ["Michel Martens", "Damian Janowski"]

data/lib/disque.rb

@@ -14,16 +14,25 @@ class Disque
   #
   #   Disque.new(["127.0.0.1:7711", "127.0.0.1:7712", "127.0.0.1:7713"])
   #
+  # Alternatively, you can pass a single string with a comma-separated
+  # list of nodes:
+  #
+  #   Disque.new("127.0.0.1:7711,127.0.0.1:7712,127.0.0.1:7713")
+  #
   # For each operation, a counter is updated to signal which node was
   # the originator of the message. Based on that information, after
   # a full cycle (1000 operations, but configurable on initialization)
   # the stats are checked to see what is the most convenient node
   # to connect to in order to avoid extra jumps.
   #
-  # TODO Account for authentication
   # TODO Account for timeout
   def initialize(hosts, auth: nil, cycle: 1000)
 
+    # Split a string of hosts if necessary
+    if String === hosts
+      hosts = hosts.split(",")
+    end
+
     # Cluster password
     @auth = auth
 

data/tests/disque_test.rb

@@ -235,3 +235,12 @@ test "don't ack jobs when no block is given" do
 
   assert_equal info.fetch("state"), "active"
 end
+
+test "receive a string of comma-separated nodes" do
+  nodes = DISQUE_GOOD_NODES.join(",")
+
+  c = Disque.new(nodes, auth: "test")
+
+  assert_equal "PONG", c.call("PING")
+  assert_equal DISQUE_GOOD_NODES.size, c.nodes.size
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disque
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Michel Martens
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic