Merge pull request #3 from azutoolkit/updates

Updates

Author: eliasjpr

.travis.yml

@@ -8,20 +8,21 @@ compute environment.
 
 **Features:**
 
--   [x] Priority queues based on number of workers
--   [x] Reliable queue
--   [x] Error Handling
--   [x] Retry Jobs with automatic Delays
--   [x] Cron Like Periodic Jobs
--   [x] Delayed Jobs
--   [x] Stop execution of workers
--   [x] Jobs expiration
-
-**Help Wanted**
--   \[ ] CLI to manage queues and monitor server
--   \[ ] Rest API: Rest api to schedule jobs
--   \[ ] Throttle (Rate limit)
--   \[ ] Approve Queue?: Jobs have to manually approved to execute
+- [x] Priority queues based on number of workers
+- [x] Reliable queue
+- [x] Error Handling
+- [x] Retry Jobs with automatic Delays
+- [x] Cron Like Periodic Jobs
+- [x] Delayed Jobs
+- [x] Stop execution of workers
+- [x] Jobs expiration
+
+## Help Wanted
+
+- \[ ] CLI to manage queues and monitor server
+- \[ ] Rest API: Rest api to schedule jobs
+- \[ ] Throttle (Rate limit)
+- \[ ] Approve Queue?: Jobs have to manually approved to execute
 
 ## Installation
 
@@ -48,7 +49,29 @@ Use **DUPLICATE POLICY FIRST** to ignore duplicate stats entries
 redis-server --loadmodule ./redistimeseries.so DUPLICATE_POLICY FIRST
 ```
 
-## Configuration Options
+## Usage
+
+```crystal
+require "joobq"
+```
+
+### Environment variables
+
+```shell
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_POOL_SIZE=50
+REDIS_TIMEOUT=0.2
+```
+
+## Defining Queues
+
+Defining Queues: Queues are of type `Hash(String, Queue(T))` where the name of the key matches the name of the Queue.
+
+### Properties
+
+- **Name:** `queue:email`
+- **Number Workers:** 10
 
 ```crystal
 require "joobq"
@@ -102,7 +125,7 @@ struct EmailJob
 end
 ```
 
-**Executing Job**
+### Executing Job
 
 ```crystal
     EmailJob.perform(email_address: "[email protected]")
@@ -130,9 +153,9 @@ JoobQ.forge
 
 ## Statistics
 
-JoobQ includes a Statistics class that allow you get stats about queue performance. 
+JoobQ includes a Statistics class that allow you get stats about queue performance.
 
-**Available stats**
+### Available stats
 
 ```text
 total enqueued jobs
@@ -145,12 +168,12 @@ total delayed jobs
 
 ## Contributing
 
-1.  Fork it (<https://github.com/eliasjpr/joobq/fork>)
-2.  Create your feature branch ( `git checkout -b my-new-feature` )
-3.  Commit your changes ( `git commit -am 'Add some feature'` )
-4.  Push to the branch ( `git push origin my-new-feature` )
-5.  Create a new Pull Request
+1. Fork it (<https://github.com/eliasjpr/joobq/fork>)
+2. Create your feature branch ( `git checkout -b my-new-feature` )
+3. Commit your changes ( `git commit -am 'Add some feature'` )
+4. Push to the branch ( `git push origin my-new-feature` )
+5. Create a new Pull Request
 
 ## Contributors
 
--   [Elias J. Perez](https://github.com/eliasjpr) - creator and maintainer
+- [Elias J. Perez](https://github.com/eliasjpr) - creator and maintainer

README.md

@@ -0,0 +1,30 @@
+site_name: JoobQ
+site_url: https://eliasjpr.github.io/joobq/
+repo_url: https://github.com/eliasjpr/joobq
+edit_uri: blob/master/docs/
+
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+
+extra_css:
+  - css/mkdocstrings.css
+
+plugins:
+  - search
+  - gen-files:
+      scripts:
+        - docs/gen_doc_stubs.py
+  - mkdocstrings:
+      default_handler: crystal
+      watch: [src]
+
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.magiclink
+  - pymdownx.saneheaders
+  - pymdownx.superfences
+  - deduplicate-toc
+  - toc:
+      permalink: "#"

mkdocs.yml

@@ -2,13 +2,13 @@ version: 2.0
 shards:
   cron_parser:
     git: https://github.com/kostya/cron_parser.git
-    version: 0.3.0
+    version: 0.4.0
 
   pool:
     git: https://github.com/ysbaddaden/pool.git
-    version: 0.2.3
+    version: 0.2.4
 
   redis:
     git: https://github.com/stefanwille/crystal-redis.git
-    version: 2.6.0
+    version: 2.7.0
 

shard.lock

@@ -1,5 +1,5 @@
 name: joobq
-version: 0.2.0
+version: 0.2.1
 
 authors:
   - Elias J. Perez <[email protected]>
@@ -8,14 +8,13 @@ targets:
   joobq:
     main: src/joobq.cr
 
-crystal: 0.34.0
+crystal: ">=0.34.0"
 
 license: MIT
 
 dependencies:
   redis:
     github: stefanwille/crystal-redis
-    version: ~> 2.6.0
 
   cron_parser:
     github: kostya/cron_parser

shard.yml

@@ -7,7 +7,7 @@ require "cron_parser"
 require "./joobq/**"
 
 module JoobQ
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
   REDIS   = Redis::PooledClient.new(
     host: ENV.fetch("REDIS_HOST", "localhost"),
     port: ENV.fetch("REDIS_PORT", "6379").to_i,

src/joobq.cr

@@ -1,7 +1,7 @@
 module JoobQ
   module DeadLetter
-    DEAD_LETTER = Sets::Dead.to_s
-    REDIS       = JoobQ::REDIS
+    private DEAD_LETTER = Sets::Dead.to_s
+    private REDIS       = JoobQ::REDIS
 
     def self.add(job)
       now = Time.local.to_unix_f

src/joobq/dead_letter.cr

@@ -1,11 +1,9 @@
 module JoobQ
   module FailHandler
-    extend self
+    private FAILED_SET = Sets::Failed.to_s
+    private REDIS      = JoobQ::REDIS
 
-    FAILED_SET = Sets::Failed.to_s
-    REDIS      = JoobQ::REDIS
-
-    def call(job, latency, ex : Exception)
+    def self.call(job, latency, ex : Exception)
       track job, latency, ex
 
       if job.retries > 0
@@ -15,7 +13,7 @@ module JoobQ
       end
     end
 
-    def track(job, latency, ex)
+    private def self.track(job, latency, ex)
       now = Time.local
       expires = (Time.local - 3.days).to_unix_f
       key = "#{FAILED_SET}:#{job.jid}"

src/joobq/failed.cr

@@ -1,10 +1,9 @@
 module JoobQ
   module Retry
-    extend self
-    RETRY_SET = Sets::Retry.to_s
-    REDIS     = JoobQ.redis
+    private RETRY_SET = Sets::Retry.to_s
+    private REDIS     = JoobQ.redis
 
-    def attempt(job)
+    def self.attempt(job)
       count = job.retries
       job.retries = job.retries - 1
       at = retry_at(count)
@@ -18,7 +17,7 @@ module JoobQ
       JoobQ.scheduler.delay job, at
     end
 
-    private def retry_at(count : Int32)
+    private def self.retry_at(count : Int32)
       ((count ** 4) + 15 + (rand(30)*(count + 1))).seconds
     end
   end

src/joobq/retry.cr

@@ -1,7 +1,7 @@
 module JoobQ
   class Scheduler
     INSTANCE = new
-    REDIS    = JoobQ::REDIS
+    private REDIS    = JoobQ::REDIS
 
     record RecurringJobs, job : Job, queue : String, interval : Time::Span | CronParser
 

src/joobq/scheduler.cr

@@ -1,10 +1,10 @@
 module JoobQ
   class Statistics
     INSTANCE         = new
-    RETENTION_MILLIS = 60 * 6 * 1000
-    STATS_KEY        = "stats"
-    STATS            = %w[Errors Retries Dead Success Latency]
-    REDIS            = JoobQ::REDIS
+    private RETENTION_MILLIS = 60 * 6 * 1000
+    private STATS_KEY        = "stats"
+    private STATS            = %w[Errors Retries Dead Success Latency]
+    private REDIS            = JoobQ::REDIS
 
     def self.instance
       INSTANCE