disc 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e27c1afc35fddfc586142db0d638d01359e2805
-  data.tar.gz: 80c10659857e47428b32b03afa824705f7a31f99
+  metadata.gz: 4c2746334c1546fd6af07dfe051d00d78dc744e6
+  data.tar.gz: 5dbb81b47fafb4b5154a6d060031d798438f7ee6
 SHA512:
-  metadata.gz: b9fc19d235cccc931573cd69bf9b8d103f6a3330632467d60ec77e5cb85963585ae11ddca194d2b63e17445e10108b5689edaec3fb2ff9c108af26a95d018250
-  data.tar.gz: 9ae8526e66733e2e7c8a91751474a9b1f0a01a9d96b8e6f1e2f9af57cf57db9d697330e9c9e4a5f08ff90faa500334edcbaf70c4f0ed903f49c6eeb7780dd38d
+  metadata.gz: b3b6e731da78fc1b71500b8e3f106c11b6594f32d24ca32e406c61a97b64c51052a4945711d01d8515d65a19b158eca3c3ef92db9428b8982664961e31ebfaca
+  data.tar.gz: 723fe3c1a28d801fe097bdbe82cff40c9e3b34147eafe6defecb70cbd802c655932c7677a9c6a4ff408f82a33e27a6e6ddce6894a2e502bcf28c77ab7e4c9395

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+### The Soveran Contribution Guidelines.
+
+(taken from some project at https://github.com/soveran)
+
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015 Pablo Astigarraga | pote <pote@tardis.com.uy>
+
+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/README.md

@@ -17,7 +17,7 @@ Disc fills the gap between your Ruby service objects and [antirez](http://antire
 2. Write your jobs
 
   ```ruby
-  requie 'disc'
+  require 'disc'
 
   class CreateGameGrid
     include Disc::Job
@@ -52,7 +52,7 @@ Disc fills the gap between your Ruby service objects and [antirez](http://antire
 6. Set your require file
 
   ```bash
-  $ export DIC_REQUIRE='./disc_init.rb'
+  $ export DISC_REQUIRE='./disc_init.rb'
   ```
 
 7. Run as many Disc Worker processes as you wish.
@@ -61,17 +61,30 @@ Disc fills the gap between your Ruby service objects and [antirez](http://antire
   $ QUEUES=urgent,default disc
   ```
 
-You're done!
+## Settings
 
+Disc takes its configuration from environment variables.
 
-### PowerUps
+| ENV Variable     |  Default Value   | Description
+|:----------------:|:-----------------|:------------|
+| DISC_REQUIRE     | null             | Ruby file that will be required by the worker processes, it should load all Disc::Job classes on your application and whatever else is needed to run them.
+| 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 workers can run just fine on their own, but sometimes you migth want to have each process spawning multiple threads doing this is trivial: just make sure you require [Celluloid](https://github.com/celluloid/celluloid) in your Disc init file!
+
+
+
+## PowerUps
+
+Disc workers can run just fine on their own, but if you're using [Celluloid](https://github.com/celluloid/celluloid) you migth want Disc to take advantage of it and spawn multiple worker threads per process, doing this is trivial! Just require Celluloid in your `DISC_REQUIRE` file.
 
 ```ruby
 # disq_init.rb
-
 require 'celluloid'
 ```
 
-Whenever Disc detects that Celluloid is available it will leverage it and spawn a number of threads equal to the `DISC_CONCURRENCY` environment variable, or 25 by default.
+Whenever Disc detects that Celluloid is available it will use it to  spawn a number of threads equal to the `DISC_CONCURRENCY` environment variable, or 25 by default.

data/bin/disc

@@ -18,7 +18,6 @@ if defined?(Celluloid)
   end
 
   Disc::WorkerGroup.run
-
 else
   STDOUT.puts(
     "[Notice] Disc running in non-threaded mode, make sure to `require 'cellulloid'`\

data/disc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'disc'
-  s.version           = '0.0.4'
+  s.version           = '0.0.5'
   s.summary           = 'A simple disque and powerful job implementation'
   s.description       = ''
   s.authors           = ['pote']

data/disc_init_example.rb

@@ -1,2 +1 @@
-require 'celluloid'
 Dir.glob('./**/*.rb') { |f| require_relative f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - pote
@@ -48,6 +48,8 @@ extra_rdoc_files: []
 files:
 - ".gems"
 - ".gitignore"
+- CONTRIBUTING.md
+- LICENSE.md
 - Makefile
 - README.md
 - bin/disc