livetask 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,7 @@
 # Livetask
 
-TODO: Write a gem description
+Live broadcast from your background jobs.
+Easy to use and efficient to build progress monitoring of background tasks on your web pages.
 
 ## Installation
 
@@ -18,7 +19,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Sidekiq
+#### Worker
+Include Livetask::Sidekiq::Worker inside of your sidekiq worker class
+```ruby
+    include Livetask::Sidekiq::Web
+```
+##### Task name
+```ruby
+    set_task_name('Eduard')
+```
+##### Logging
+```ruby
+    add_to_log('I were logged and successfully stored in redis!')
+```
+##### Status
+```ruby
+    set_status('in progress')
+```
+##### Progress
+```ruby
+    set_progress(100) #Completed!
+```
+
+#### Web
+Include Livetask::Sidekiq::Web inside of your controller
+```ruby
+    include Livetask::Sidekiq::Web
+```
+##### List of all recorded tasks ids
+```ruby
+    get_tasks_ids
+```
+##### Task name
+```ruby
+    get_task_name(task_id)
+```
+##### Logging
+To get a full log use:
+```ruby
+    get_log(task_id)
+```
+If you want to limit returned log, you can set 'from' and 'to' limits
+```ruby
+    get_log(task_id, 3) # Will return last 3 lines of log
+    get_log(task_id, 12, 2) # Will return last 10 lines of log except the latest 2
+```
+##### Status
+```ruby
+    get_status(task_id)
+```
+##### Progress
+```ruby
+    get_progress(task_id)
+```
 
 ## Contributing
 

data/lib/livetask.rb

@@ -1,7 +1,6 @@
 require "livetask/version"
-require "livetask/sidekiq_web"
-require "livetask/sidekiq_worker"
+require "livetask/sidekiq/web"
+require "livetask/sidekiq/worker"
 
 module Livetask
-  # Your code goes here...
 end

data/lib/livetask/sidekiq/web.rb

@@ -0,0 +1,53 @@
+module Livetask
+  module Sidekiq
+    module Web
+
+      def self.show_tasks
+        "<div id='livetask'>Loading tasks...</div>"
+      end
+
+      def get_tasks_ids
+        Sidekiq.redis do |conn|
+          conn.zrevrange("livetask-tasks", 0, (2**(0.size * 8 -2) -1))
+        end
+      end
+
+      def get_task_name(jid)
+        Sidekiq.redis do |conn|
+          conn.hget("livetask-#{jid}-info", "name")
+        end
+      end
+
+      def get_progress(jid)
+        Sidekiq.redis do |conn|
+          conn.hget("livetask-#{jid}-info", "progress")
+        end
+      end
+
+      def get_status(jid)
+        Sidekiq.redis do |conn|
+          conn.hget("livetask-#{jid}-info", "status")
+        end
+      end
+
+      def get_log(jid, to = (2**(0.size * 8 -2) -1), from = 0)
+        log_array = []
+        Sidekiq.redis do |conn|
+          log_array = conn.zrevrange("livetask-#{jid}-log", from, to, :with_scores => true)
+        end
+        log = ""
+        log_array.each do |line|
+          log += "#{Time.at(line.last)} #{line.first[5..-1]}\n"
+        end
+        log
+      end
+
+      def get_last_changed_at(jid)
+        Sidekiq.redis do |conn|
+          Time.at(conn.zscore("livetask-tasks", jid)).to_datetime
+        end
+      end
+
+    end
+  end
+end

data/lib/livetask/sidekiq/worker.rb

@@ -0,0 +1,46 @@
+module Livetask
+  module Sidekiq
+    module Worker
+
+      def set_task_name(name)
+        return false unless @jid
+        register_task(@jid)
+        Sidekiq.redis do |conn|
+          conn.hset("livetask-#{@jid}-info", "name", name)
+        end
+      end
+
+      def set_progress(progress)
+        return false unless @jid
+        register_task(@jid)
+        Sidekiq.redis do |conn|
+          conn.hset("livetask-#{@jid}-info", "progress", progress)
+        end
+      end
+
+      def set_status(status)
+        return false unless @jid
+        register_task(@jid)
+        Sidekiq.redis do |conn|
+          conn.hset("livetask-#{@jid}-info", "status", status)
+        end
+      end
+
+      def add_to_log(string)
+        return false unless @jid
+        register_task(@jid)
+        Sidekiq.redis do |conn|
+          conn.zadd("livetask-#{@jid}-log", Time.now.to_i, "#{Time.now.to_i.to_s[-5..-1]}#{string}")
+        end
+      end
+
+      private
+      def register_task(jid)
+        Sidekiq.redis do |conn|
+          conn.zadd("livetask-tasks", Time.now.to_i, jid.to_s)
+        end
+      end
+
+    end
+  end
+end

data/lib/livetask/version.rb

@@ -1,3 +1,3 @@
 module Livetask
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/livetask.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/livetask/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Alexey Krasnoperov"]
   gem.email         = ["Alexey.Krasnoperov@gmail.com"]
-  gem.description   = %q{Live broadcast from a background job}
+  gem.description   = %q{Live broadcast from a background jobs}
   gem.summary       = %q{Gem that displays real-time progress of background job on your page}
   gem.homepage      = ""
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livetask
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies: []
-description: Live broadcast from a background job
+description: Live broadcast from a background jobs
 email:
 - Alexey.Krasnoperov@gmail.com
 executables: []
@@ -24,8 +24,8 @@ files:
 - README.md
 - Rakefile
 - lib/livetask.rb
-- lib/livetask/sidekiq_web.rb
-- lib/livetask/sidekiq_worker.rb
+- lib/livetask/sidekiq/web.rb
+- lib/livetask/sidekiq/worker.rb
 - lib/livetask/version.rb
 - livetask.gemspec
 homepage: ''

data/lib/livetask/sidekiq_web.rb

@@ -1,51 +0,0 @@
-module Livetask
-  module SidekiqWeb
-
-    def self.show_tasks
-      "<div id='livetask'>Loading tasks...</div>"
-    end
-
-    def get_tasks_ids
-      Sidekiq.redis do |conn|
-        conn.zrevrange("livetask-tasks", 0, (2**(0.size * 8 -2) -1))
-      end
-    end
-
-    def get_task_name(jid)
-      Sidekiq.redis do |conn|
-        conn.hget("livetask-#{jid}-info", "name")
-      end
-    end
-
-    def get_progress(jid)
-      Sidekiq.redis do |conn|
-        conn.hget("livetask-#{jid}-info", "progress")
-      end
-    end
-
-    def get_status(jid)
-      Sidekiq.redis do |conn|
-        conn.hget("livetask-#{jid}-info", "status")
-      end
-    end
-
-    def get_log(jid)
-      log_array = []
-      Sidekiq.redis do |conn|
-        log_array = conn.zrevrangebyscore("livetask-#{jid}-log", '+inf', 0, :with_scores => true)
-      end
-      log = ""
-      log_array.each do |line|
-        log += "#{Time.at(line.last)} #{line.first[5..-1]}\n"
-      end
-      log
-    end
-
-    def get_last_changed_at(jid)
-      Sidekiq.redis do |conn|
-        Time.at(conn.zscore("livetask-tasks", jid)).to_datetime
-      end
-    end
-
-  end
-end

data/lib/livetask/sidekiq_worker.rb

@@ -1,44 +0,0 @@
-module Livetask
-  module SidekiqWorker
-
-    def set_task_name(name)
-      return false unless @jid
-      register_task(@jid)
-      Sidekiq.redis do |conn|
-        conn.hset("livetask-#{@jid}-info", "name", name)
-      end
-    end
-
-    def set_progress(progress)
-      return false unless @jid
-      register_task(@jid)
-      Sidekiq.redis do |conn|
-        conn.hset("livetask-#{@jid}-info", "progress", progress)
-      end
-    end
-
-    def set_status(status)
-      return false unless @jid
-      register_task(@jid)
-      Sidekiq.redis do |conn|
-        conn.hset("livetask-#{@jid}-info", "status", status)
-      end
-    end
-
-    def add_to_log(string)
-      return false unless @jid
-      register_task(@jid)
-      Sidekiq.redis do |conn|
-        conn.zadd("livetask-#{@jid}-log", Time.now.to_i, "#{Time.now.to_i.to_s[-5..-1]}#{string}")
-      end
-    end
-
-    private
-    def register_task(jid)
-      Sidekiq.redis do |conn|
-        conn.zadd("livetask-tasks", Time.now.to_i, jid.to_s)
-      end
-    end
-
-  end
-end