ost-scheduler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8db52f61fc13cfda5cab33f3e41308254faf5926
+  data.tar.gz: 0224270c8c9b60e2a2ea1f170e2add7edbd9bee2
+SHA512:
+  metadata.gz: e8462a3d68aa3610e86177af40a8189e83b605864c6e566a0c6dccfb04d28f4fa0a88f8cbe2804c426b5c799dce35b482b216d614483ee574dfb2421541ab367
+  data.tar.gz: 6ce97559cd1748a0855785be8e80b4fab0c50c936e5fdbcaa99214e40e06b3b9b5c55bd2c8f9db15d269f49885bcffc9b5072bb366918fe72b4ab432ce5bed14

data/README.md

@@ -0,0 +1,91 @@
+Ost Scheduler
+===
+
+Ost-Scheduler is an extension to [Ost](http://github.com/soveran/ost) that adds support for queueing items in the future.
+
+Description
+-----------
+
+Ost provides simple, lightweight background job functionality. 
+
+**Ost-Scheduler** makes it easy to enqueue object ids and process them with
+workers.
+
+Say you want to process video uploads. In your application you will
+have something like this:
+
+``` ruby
+Ost[:videos_to_process].push_at( Time.now + 60 , @video.id )
+```
+
+Then, you will have a worker that will look like this:
+
+``` ruby
+require "ost-scheduler"
+
+Ost[:videos_to_process].each_delayed do |id|
+  # Do something with it!
+end
+```
+
+Usage
+-----
+
+Ost uses a lightweight Redis client called [Redic][redic]. To connect to
+a Redis database, you will need to set an instance of `Redic`, with a URL
+of the form `redis://:<passwd>@<host>:<port>/<db>`.
+
+You can customize the connection by calling `Ost.redis=`:
+
+``` ruby
+require "ost-scheduler"
+
+Ost.redis = Redic.new("redis://127.0.0.1:6379")
+```
+
+Then you only need to refer to a queue for it to pop into existence:
+
+``` ruby
+require "ost-scheduler"
+
+Ost.redis = Redic.new("redis://127.0.0.1:6379")
+
+Ost[:event].push_at(@datetime, @feed.id)
+```
+
+Ost defaults to a Redic connection to `redis://127.0.0.1:6379`. The example
+above could be rewritten as:
+
+``` ruby
+require "ost-scheduler"
+
+Ost[:event].push_at(@datetime, @feed.id)
+```
+
+A worker is a Ruby file with this basic code:
+
+``` ruby
+require "ost-scheduler"
+
+Ost[:rss_feeds].each_delayed do |id|
+  # ...
+end
+```
+
+
+Available methods
+=================
+
+`Ost[:example].push_at(datetime, item)`: add `item` to
+the `:example` queue in a exactly `datetime`.
+
+`Ost[:example].each_delayed { |item| ... }`: consume `item` from the `:example` queue. .
+
+`Ost.stop`: halt processing for all queues.
+
+`Ost[:example].stop`: halt processing for the `example` queue.
+
+Installation
+------------
+
+    $ gem install ost-scheduler

data/lib/ost-scheduler.rb

@@ -0,0 +1,59 @@
+require "ost"
+module OstScheduler
+  TIME_PERIOD = ENV["TIME_PERIOD"] || "24"
+  TIMEOUT_SCHEDULER = ENV["OST_TIMEOUT"] || "1"
+  # /class Queue
+
+    def push_at(time,value)
+      score = time.to_i if time.class == Time
+      redis.call("ZADD", @key, score, value)
+    end
+
+
+    def each_delayed(&block)
+      loop do
+        now = Time.now.to_i
+        min_time = now - range_period
+        items = redis.call("ZRANGEBYSCORE",@key , min_time,  now)
+        if !items.count.zero?
+          items.each do |item|
+            block.call(item)
+          end
+          redis.call("ZREMRANGEBYSCORE",@key , min_time,  now)
+        end 
+        
+        sleep(TIMEOUT_SCHEDULER.to_i)
+
+        break if @stopping
+      end
+    end
+
+    def range_period
+      (TIME_PERIOD.to_i * 60 * 60)
+    end
+
+    def items
+      if redis.call("TYPE", @key) == "zset"
+        redis.call("ZRANGE", @key, 0, -1)
+      else
+        redis.call("LRANGE", @key, 0, -1)
+      end
+    end
+
+    def size
+      if redis.call("TYPE", @key) == "zset"
+        redis.call("ZCARD", @key)
+      else
+        redis.call("LLEN", @key)
+      end
+    end
+
+  # end
+end
+
+class Ost::Queue
+  remove_method :items
+  remove_method :size
+  include OstScheduler
+end
+

data/ost-scheduler.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name              = "ost-scheduler"
+  s.version           = "0.1.1"
+  s.summary           = "Redis based queues and workers in the future."
+  s.description       = "Ost-scheduler lets you manage queues and workers with Redis."
+  s.authors           = ["Leandro Rodriguez"]
+  s.email             = ["learod17@gmail.com"]
+  s.homepage          = "http://github.com/learod/ost-scheduler"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "ost"
+  s.add_development_dependency "cutest"
+end
+

data/test/access.rb

@@ -0,0 +1,22 @@
+require_relative "helper"
+
+scope do
+
+  test "access to delayed queued items" do
+    Ost[:events].push_at((Time.now + 60), 1)
+
+    assert_equal ["1"], Ost[:events].items
+  end
+
+  test "access to queue size" do
+    queue = Ost[:events]
+    assert_equal 0, queue.size
+
+    queue.push_at((Time.now), 1)
+    assert_equal 1, queue.size
+
+    queue.stop
+    queue.each_delayed { }
+    assert_equal 0, queue.size
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require "cutest"
+require "ost"
+require_relative "../lib/ost-scheduler"
+
+Ost.redis = Redic.new("redis://127.0.0.1:6379")
+
+prepare do
+  Ost.redis.call("FLUSHALL")
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ost-scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Leandro Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ost-scheduler lets you manage queues and workers with Redis.
+email:
+- learod17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ost-scheduler.rb
+- ost-scheduler.gemspec
+- test/access.rb
+- test/helper.rb
+homepage: http://github.com/learod/ost-scheduler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Redis based queues and workers in the future.
+test_files: []