init commit

Author: eliasjpr

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.cr]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.github/workflows/crystal.yml

@@ -0,0 +1,36 @@
+name: Crystal CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    container:
+      image: crystallang/crystal
+      
+    services:
+      redis:
+        image: redislabs/redistimeseries
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        
+    steps:
+    - uses: actions/checkout@v2
+      
+    - name: Install dependencies
+      run: shards install
+  
+    - name: Run tests
+      run: crystal spec
+      env:
+        REDIS_URL: redis:6379
+        REDIS_HOST: redis
+        REDIS_PORT: 6379 

.gitignore

@@ -0,0 +1,5 @@
+/docs/
+/lib/
+/bin/
+/.shards/
+*.dwarf

.travis.yml

@@ -0,0 +1,6 @@
+language: crystal
+
+# Uncomment the following if you'd like Travis to run specs and check code formatting
+# script:
+#   - crystal spec
+#   - crystal tool format --check

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Elias J. Perez
+
+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.

README.md

@@ -0,0 +1,63 @@
+# JoobQ
+
+TODO: Write a description here
+
+- [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
+- [] Expiring Jobs
+- [] Batches?
+- [] Approve Queue
+- [] Job Locking / Disable Concurrent Execution(1 Job Per Instance)
+- [] Throttle (Rate limit)
+- [] Stop running Queues
+
+## How to sell
+- By Number of Workers
+- By Worker Size
+- By Number of Queues
+
+## How To Integrate
+- API Libraries
+- Client Libraries
+- 
+## Installation
+
+```yaml
+dependencies:
+    joobq:
+        github: eliasjpr/joobq
+```
+
+```bash
+$ shards install
+```
+
+## Usage
+
+Scheduled Jobs 
+
+```crystal 
+JoobQ.scheduler.define do 
+  at("5 4 * * *") { Somejob.perform }
+end
+```
+
+## Development
+
+TODO: Write development instructions here
+
+## Contributing
+
+1. Fork it (<https://github.com/your-github-user/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/your-github-user) - creator and maintainer

bench/bench.cr

@@ -0,0 +1,43 @@
+require "../src/joobq"
+require "benchmark"
+
+struct TestJob
+  include JoobQ::Job
+
+  property x : Int32
+  @retries = 3
+  @queue = "queue:test"
+
+  def initialize(@x : Int32)
+  end
+
+  def perform
+    x + 1
+  end
+end
+
+struct FailJob
+  include JoobQ::Job
+  @queue = "queue:fail"
+  @retries = 3
+
+  def initialize
+  end
+
+  def perform
+    raise "Bad"
+  end
+end
+
+JoobQ.reset
+
+module JoobQ
+  QUEUES = {
+    "queue:test" => JoobQ::Queue(TestJob).new("queue:test", 80),
+    "queue:fail" => JoobQ::Queue(FailJob).new("queue:fail", 20),
+  }
+end
+
+JoobQ.run
+
+sleep

bench/load.cr

@@ -0,0 +1,43 @@
+require "../src/joobq"
+
+struct TestJob
+  include JoobQ::Job
+
+  property x : Int32
+  @retries = 3
+  @queue = "queue:test"
+
+  def initialize(@x : Int32)
+  end
+
+  def perform
+    x + 1
+  end
+end
+
+struct FailJob
+  include JoobQ::Job
+  @queue = "queue:fail"
+  @retries = 3
+
+  def initialize
+  end
+
+  def perform
+    raise "Bad"
+  end
+end
+
+JoobQ.reset
+
+module JoobQ
+  QUEUES = {
+    "queue:test" => JoobQ::Queue(TestJob).new("queue:test", 80),
+    "queue:fail" => JoobQ::Queue(FailJob).new("queue:fail", 20),
+  }
+end
+
+1000000.times do |i|
+  TestJob.perform(x: i)
+  FailJob.perform
+end

shard.lock

@@ -0,0 +1,14 @@
+version: 2.0
+shards:
+  cron_parser:
+    git: https://github.com/kostya/cron_parser.git
+    version: 0.3.0
+
+  pool:
+    git: https://github.com/ysbaddaden/pool.git
+    version: 0.2.3
+
+  redis:
+    git: https://github.com/stefanwille/crystal-redis.git
+    version: 2.6.0
+

shard.yml

@@ -0,0 +1,21 @@
+name: joobq
+version: 0.1.0
+
+authors:
+  - Elias J. Perez <[email protected]>
+
+targets:
+  joobq:
+    main: src/joobq.cr
+
+crystal: 0.34.0
+
+license: MIT
+
+dependencies:
+  redis:
+    github: stefanwille/crystal-redis
+    version: ~> 2.6.0
+
+  cron_parser:
+    github: kostya/cron_parser

spec/job_spec.cr

@@ -0,0 +1,57 @@
+require "./spec_helper"
+
+module JoobQ
+  describe Job do
+    context "one queue for single job type" do
+      it "works" do
+        queue = "single"
+
+        REDIS.del queue
+        REDIS.del Sets::Delayed.to_s
+        REDIS.del queue
+
+        Job1.perform
+
+        REDIS.llen(queue).should eq 1
+      end
+    end
+
+    context "one queue for multiple job types" do
+      it "works" do
+        queue = "example"
+
+        REDIS.del queue
+        REDIS.del Sets::Delayed.to_s
+        REDIS.del queue
+
+        ExampleJob.perform(x: 1)
+        FailJob.perform
+
+        REDIS.llen(queue).should eq 2
+      end
+
+      it "performs and enqueue jobs asyncronously" do
+        queue = "example"
+
+        REDIS.del queue
+        REDIS.del Sets::Delayed.to_s
+
+        job_id = ExampleJob.perform(x: 1)
+
+        job_id.should be_a UUID
+        REDIS.llen(queue).should eq 1
+      end
+
+      it "performs jobs at later time" do
+        queue = "example"
+        REDIS.del queue
+        REDIS.del Sets::Delayed.to_s
+
+        job_id = ExampleJob.perform(within: 1.hour, x: 1)
+        job_id.should be_a UUID
+
+        REDIS.zcard(Sets::Delayed.to_s).should eq 1
+      end
+    end
+  end
+end

spec/jobbq_spec.cr

@@ -0,0 +1,15 @@
+require "./spec_helper"
+
+describe JoobQ do
+  describe "#register" do
+    it "registers a queue" do
+      JoobQ.queues.size.should eq 5
+    end
+
+    it "gets queue by name" do
+      JoobQ["joobq_queue1"].should be_a JoobQ::Queue(ExampleJob)
+      JoobQ["joobq_queue2"].should be_a JoobQ::Queue(FailJob)
+      JoobQ["joobq_queue3"].should be_a JoobQ::Queue(ExampleJob | FailJob)
+    end
+  end
+end