web_task_runner 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3004d490f604c0e133bc23d31fd9d9383677d95b
-  data.tar.gz: 14aac705ac0f347993dcb364f588638571dbd313
+  metadata.gz: aa3d96c91c52ee015b141cdfd3a166f9ab0ae680
+  data.tar.gz: 21bd106643b4e50183b9fa5232cff82f2902fc1b
 SHA512:
-  metadata.gz: da3fa726366004f40470992d2da10d389f93e6af3dca83dcc4000de83b9f1e82e094e2944cccda708eaa49955a75bcb1d64fccf98e140e20d2989f3548257caf
-  data.tar.gz: baaa274cb01c197e4880ecaa2cf10c9a0ac5f685e83f2f8da6b1814e98cb85097c70e7bc4b43b6069fb075c0636f215be6f4cf7264853bfdbb44b813ee1de758
+  metadata.gz: 2118e07ec979f23255dcb1ab83ec17a58d131a0fcdf3033bd1ffcb0bd1e7f95ec4f7175939e5195f4863d3fb905389c67f058ef0f3e21c469cb0f3529270318d
+  data.tar.gz: a9c40f240304c6543d0d8bc6f38c14c9b3274c89223caf510c64b5514282ebb78dabcf2a4af9e0a181c0a2d6f537fdb1c823a7f6f1418d80346f1121059bf317

data/README.md

@@ -26,6 +26,78 @@ And then execute:
 Redis is required to run the background jobs. Make sure you have one, and set
 the `REDIS_URL` environment variable to the Redis URL.
 
+## Usage
+
+Just `require 'web_task_runner'` and append jobs to it
+(`WebTaskRunner.jobs << SomeWork`). Then you'll have a Rack app `WebTaskRunner`
+providing web APIs ready to be mounted. Configurations `REDIS_URL`, `API_KEY`
+and `REDIS_NAMESPACE` can be set through environment variables.
+
+Please refer the [Getting Start](#getting-start) section for more details.
+
+### API Endpoints
+
+Note that all APIs has been secured with the `API_KEY`. Each request should
+pass the matching `API_KEY` with the `key` parameter
+(e.g.: `https://example.app/?key=secreat_key`), otherwise an `401 Unauthorized`
+error will be returned.
+
+#### `GET /`
+
+Returns the information of the task runner.
+
+#### `GET /status`
+
+Returns the current (or last) status of running task.
+
+```json
+HTTP/1.1 200 OK
+
+{
+  "status": "processing",
+  "progress": 0.52,
+  "started_at": "2015-05-29 22:36:35 +0000"
+}
+```
+
+ - status: can be `processing`, `ok` or `error`
+ - progress: an float representing the current working progress, presented only
+             if the task is currently in progress
+ - started_at: time of when the task has been started
+ - finished_at: time of when the task has finished, presented only
+                if the last task is finished
+
+#### `GET /start`
+
+Start to run the task (if the task is not currently running).
+
+```json
+HTTP/1.1 202 Accepted
+
+{
+  "status": "processing",
+  "link": "https://example.app/status?key=secreat_key"
+}
+```
+
+ - status: must be `processing`, since the task will be run asynchronously
+ - link: URL for monitoring the started task
+
+#### `GET /stop`
+
+Force stop the current running task.
+
+```json
+HTTP/1.1 200 OK
+
+{
+  "status": "error",
+  "link": "https://example.app/status?key=secreat_key",
+  "started_at": "2015-05-29 22:36:35 +0000",
+  "finished_at": "2015-05-29 23:12:48 +0000"
+}
+```
+
 ## Getting Start
 
 Create and `cd` into a new folder to place the task runner app. After adding
@@ -41,6 +113,7 @@ app to run, you can set it using `$ export` or save them into a file called
 
  - `REDIS_URL`: specify the Redis to connect to
  - `API_KEY`: chose a secret key for accessing the web API
+ - `REDIS_NAMESPACE`: _(optional)_ namespacing Redis keys
 
 ### Create The App
 
@@ -106,7 +179,7 @@ class MyWorkOne < WebTaskRunner::TaskWorker
       sleep(1)
       raise if Random.rand(100) < 2  # simulate errors
       # report the current progress
-      WebTaskRunner.job_1_progress = (i + 1) / 10
+      WebTaskRunner.job_1_progress = (i + 1) / 10.0
     end
   end
 end
@@ -121,16 +194,11 @@ require 'web_task_runner'
 
 class MyWorkOne < WebTaskRunner::TaskWorker
   def exec
-    # sleep one second for ten times
-    10.times do |i|
-      sleep(1)
-      raise if Random.rand(100) < 2  # simulate errors
-      # report the current progress
-      WebTaskRunner.job_1_progress = (i + 1) / 10
-    end
+    # ...
   end
 end
 
+# append the job to task runner
 WebTaskRunner.jobs << MyWorkOne
 ```
 

data/lib/web_task_runner.rb

@@ -17,7 +17,7 @@ class WebTaskRunner < Sinatra::Application
     @@jobs
   end
 
-  # GET /?key=<api_key> - retrieve current state of the crawler
+  # GET /?key=<api_key> - retrieve current state of the task runner
   get '/' do
     # Authorize the request
     error 401, JSON.pretty_generate(error: 'Unauthorized') and \
@@ -26,7 +26,16 @@ class WebTaskRunner < Sinatra::Application
     return JSON.pretty_generate(current_info)
   end
 
-  # GET /start?key=<api_key> - start the crawler if idle
+  # GET /?key=<api_key> - retrieve current status of the task
+  get '/status' do
+    # Authorize the request
+    error 401, JSON.pretty_generate(error: 'Unauthorized') and \
+      return if ENV['API_KEY'] != params[:key]
+
+    return JSON.pretty_generate(current_status)
+  end
+
+  # GET /start?key=<api_key> - start the task if idle
   get '/start' do
     # Authorize the request
     error 401, JSON.pretty_generate(error: 'Unauthorized') and \
@@ -34,18 +43,21 @@ class WebTaskRunner < Sinatra::Application
 
     start_task_if_idle
 
-    return 'start'
+    link = "#{request.env['rack.url_scheme']}://#{request.env['HTTP_HOST']}/status?key=#{params[:key]}"
+
+    status 202
+    return JSON.pretty_generate({ status: 'processing', link: link })
   end
 
-  # GET /kill?key=<api_key> - kill the working job
-  get '/kill' do
+  # GET /stop?key=<api_key> - kill the working task
+  get '/stop' do
     # Authorize the request
     error 401, JSON.pretty_generate(error: 'Unauthorized') and \
       return if ENV['API_KEY'] != params[:key]
 
     kill_task
 
-    return 'kill'
+    return JSON.pretty_generate(current_status)
   end
 
   # Report that a job has been done, call this in each job after
@@ -61,6 +73,7 @@ class WebTaskRunner < Sinatra::Application
     # set the state to idle if all the works has been done
     if WebTaskRunner::RedisModule.redis.get('task:working_jobs').to_i < 1
       WebTaskRunner::RedisModule.redis.set('task:state', 'idle')
+      WebTaskRunner::RedisModule.redis.set('task:status', 'ok')
       WebTaskRunner::RedisModule.redis.set('task:finished_at', Time.now)
     end
   end
@@ -78,6 +91,7 @@ class WebTaskRunner < Sinatra::Application
   def self.start_task
     kill_task
     WebTaskRunner::RedisModule.redis.set('task:state', 'working')
+    WebTaskRunner::RedisModule.redis.set('task:status', 'processing')
     WebTaskRunner::RedisModule.redis.set('task:started_at', Time.now)
 
     # Set the count of jobs that should be started
@@ -113,14 +127,16 @@ class WebTaskRunner < Sinatra::Application
   # Kills the running task
   def self.kill_task
     ps = Sidekiq::ProcessSet.new
+    killed_count = 0
     ps.each do |p|
-      p.stop! if p['busy'] > 0
+      p.stop! and killed_count += 1 if p['busy'] > 0
     end
     sleep(0.5)
     Sidekiq::Queue.new.clear
     Sidekiq::ScheduledSet.new.clear
     Sidekiq::RetrySet.new.clear
     WebTaskRunner.job_ended(all: true)
+    WebTaskRunner::RedisModule.redis.set('task:status', 'error') if killed_count > 0
   end
 
   def kill_task  # :nodoc:
@@ -174,7 +190,7 @@ class WebTaskRunner < Sinatra::Application
     WebTaskRunner.task_finished_at
   end
 
-  # Get the info of the task
+  # Get the info of the task runner
   def self.current_info
     info = { state: current_state }
     info[:task_progress] = task_progress if task_progress
@@ -188,11 +204,17 @@ class WebTaskRunner < Sinatra::Application
     WebTaskRunner.current_info
   end
 
-  # Get the status of the task runner
+  # Get the status of the task
   def self.current_status
-    info = { state: current_state }
+    task_status = WebTaskRunner::RedisModule.redis.get('task:status')
+    return {} unless task_status
 
-    info
+    status = { status: task_status }
+    status[:progress] = task_progress if task_progress && task_status == 'processing'
+    status[:started_at] = task_started_at if task_started_at
+    status[:finished_at] = task_finished_at if task_finished_at
+
+    status
   end
 
   def current_status  # :nodoc:

data/lib/web_task_runner/redis_module.rb

@@ -1,10 +1,18 @@
 require 'sinatra'
 require 'sidekiq'
+require 'redis-namespace'
 
 class WebTaskRunner < Sinatra::Application
   module RedisModule
     def self.connection
-      proc { Redis.new(url: ENV['REDIS_URL']) }
+      if ENV['REDIS_NAMESPACE']
+        proc do
+          redis_c = Redis.new(url: ENV['REDIS_URL'])
+          Redis::Namespace.new(ENV['REDIS_NAMESPACE'], redis: redis_c)
+        end
+      else
+        proc { Redis.new(url: ENV['REDIS_URL']) }
+      end
     end
 
     def self.redis

data/lib/web_task_runner/version.rb

@@ -1,3 +1,3 @@
 class WebTaskRunnerVersion
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/web_task_runner.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   # Job runner
   spec.add_dependency "sidekiq", "~> 3.3.4"
   spec.add_dependency "sidekiq-status"
+  spec.add_dependency "redis-namespace"
 
   # Utilities
   spec.add_dependency "dotenv"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web_task_runner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Neson
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  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: dotenv
   requirement: !ruby/object:Gem::Requirement