web_task_runner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5828a4e9a9b521c206ae34e2102f30ff0cfe5b9
+  data.tar.gz: ecec3fabb1fde45795da529adef6153adb9bc514
+SHA512:
+  metadata.gz: 5b25a18f7e7f56786a4a13a617c4f70fd192db8f65be0a2638e0c40369998e7d0c1be8815ae8c962d8e39f298531ef66e21a58c901e9a40e67dc8131a4e62452
+  data.tar.gz: 3c2210c4ea5266cd889975bb4f5da9d200bd21abb9a88f8c1b111e19442489b2925ffc3add379d7acbf50cd1b0bbad7ee851cf82223f752227f0fe6c6bc8f0a9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in web_task_runner.gemspec
+gemspec

data/README.md

@@ -0,0 +1,229 @@
+# WebTaskRunner
+
+Web wrapper to run a specific task with [Sidekiq](http://sidekiq.org/).
+Provides HTTP API to start, stop, get status of the task running in background,
+and is deployable to cloud platforms like Heroku.
+
+A task is set of jobs for an specific purpose, like crawling a website, syncing
+data... etc. For easy manageability, one task runner only provides running one
+separate task.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'web_task_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Requirements
+
+Redis is required to run the background jobs. Make sure you have one, and set
+the `REDIS_URL` environment variable to the Redis URL.
+
+## Getting Start
+
+Create and `cd` into a new folder to place the task runner app. After adding
+`gem 'web_task_runner'` into your project's `Gemfile`
+(`echo "gem 'web_task_runner'" >> Gemfile`), run the `bundle` command to
+install it, then proceed on the following to set it up:
+
+### Set the Environment Variables
+
+The following environment variables should be configured for the task runner
+app to run, you can set it using `$ export` or save them into a file called
+`.env` right under the project folder.
+
+ - `REDIS_URL`: specify the Redis to connect to
+ - `API_KEY`: chose a secret key for accessing the web API
+
+### Create The App
+
+Create an file, for instance, `./app.rb` (`touch app.rb`) to place the app.
+
+Edit that file to require the `web_task_runner` gem:
+
+```ruby
+# app.rb
+
+require 'web_task_runner'
+```
+
+### Add Jobs To The Task
+
+A task may contain many jobs, which can be working on concurrently. When the
+task starts, all the jobs will be carried out, run (and rerun if faild) with
+Sidekiq. The task will end after every job has been done.
+
+You can define new jobs by creating a class inheriting
+`WebTaskRunner::TaskWorker`:
+
+```ruby
+# app.rb
+
+require 'web_task_runner'
+
+class MyWorkOne < WebTaskRunner::TaskWorker
+end
+```
+
+The actual work of that job can should defined in the instance method `#exec`
+of the class:
+
+```ruby
+# app.rb
+
+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
+    end
+  end
+end
+```
+
+Progress of that work may be reported with the `WebTaskRunner.job_n_progress=`
+method (`n` is the serial number of job, e.g.: `1`) while the job is running:
+
+```ruby
+# app.rb
+
+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
+```
+
+At last, append the job to the task using `WebTaskRunner.jobs.<<`:
+
+```ruby
+# app.rb
+
+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
+
+WebTaskRunner.jobs << MyWorkOne
+```
+
+### Construct Deployable Application
+
+You may need other files to make your application deployable, for instance,
+a `config.ru` Rack configuration file, a `Procfile` to specify process types.
+
+The `config.ru` file can be set up like this:
+
+```ruby
+# config.ru
+
+require './app'  # require your application
+run Rack::URLMap.new('/' => WebTaskRunner)
+```
+
+Sidekiq also provides an web monitoring interface that you can mount. If you
+choose to use it, your `config.ru` may be like this:
+
+```ruby
+# config.ru
+
+require './app'  # require your application
+require 'sidekiq/web'  # require sidekiq web interface
+
+# secure the web interface using the API key as password
+Sidekiq::Web.use(Rack::Auth::Basic) do |user, password|
+  [user, password] == ["admin", ENV['API_KEY']]
+end
+
+# mount both WebTaskRunner and Sidekiq::Web
+run Rack::URLMap.new('/' => WebTaskRunner, '/sidekiq' => Sidekiq::Web)
+```
+
+The next will be `Procfile`, which may be like this:
+
+```
+web: bundle exec thin start -p $PORT
+worker: bundle exec sidekiq -c 10 -t 0 -v -r ./app.rb
+```
+
+### Up And Running
+
+Now your application is ready for running, it can be deployed to heroku by a
+`git push`, add an Redis addon, and scale up both web and worker dynos. Or
+run it locally using `foreman`, or even run the processes manually:
+
+```bash
+$ bundle exec thin start -p 5000 & ; bundle exec sidekiq -c 10 -t 0 -v -r ./app.rb &
+```
+
+Then, use the API endpoints to control or monitor the task runner. Each
+request should be called with an `key` parameter containing the same API key
+specified aboved in the `API_KEY` environment variable.
+
+To get the current status, visit `/`:
+
+```http
+GET http://localhost:5000/?key=some_secret_key
+
+HTTP/1.1 200 OK
+Connection: keep-alive
+Content-Length: 122
+Content-Type: text/html;charset=utf-8
+
+{
+  "state": "idle",
+  "task_started_at": "2015-05-29 15:49:41 +0800",
+  "task_finished_at": "2015-05-29 15:49:51 +0800"
+}
+```
+
+To start running the task, visit `/start`.
+
+To kill the task that is currently running, visit `/kill`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bin/console` for an interactive prompt that will allow you
+to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/Neson/web_task_runner/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "web_task_runner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/web_task_runner/redis_module.rb

@@ -0,0 +1,23 @@
+require 'sinatra'
+require 'sidekiq'
+
+class WebTaskRunner < Sinatra::Application
+  module RedisModule
+    def self.connection
+      proc { Redis.new(url: ENV['REDIS_URL']) }
+    end
+
+    def self.redis
+      @redis ||= connection.call
+    end
+  end
+end
+
+# Set Redis connections for both Sidekiq server and client
+Sidekiq.configure_server do |config|
+  config.redis = ConnectionPool.new(&WebTaskRunner::RedisModule.connection)
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = ConnectionPool.new(&WebTaskRunner::RedisModule.connection)
+end

data/lib/web_task_runner/task_worker.rb

@@ -0,0 +1,39 @@
+require 'sinatra'
+require 'sidekiq'
+require 'sidekiq-status'
+
+require_relative '../web_task_runner.rb'
+
+class WebTaskRunner < Sinatra::Application
+  class TaskWorker
+    include Sidekiq::Worker
+    include Sidekiq::Status::Worker
+
+    def perform
+      return if WebTaskRunner.current_state == 'idle'
+
+      exec
+
+      puts "Job ##{job_number} done."
+      WebTaskRunner.work_ended
+    end
+
+    def job_number
+      job_number = 0
+      klass = self.class
+      WebTaskRunner.jobs.each_with_index do |job, i|
+        if job == klass
+          job_number = i + 1
+          break
+        end
+      end
+      job_number
+    end
+
+    def exec
+      puts <<-EOF
+        Define the work in #{self.class}#exec!
+      EOF
+    end
+  end
+end

data/lib/web_task_runner/version.rb

@@ -0,0 +1,5 @@
+require 'sinatra'
+
+class WebTaskRunner < Sinatra::Application
+  VERSION = "0.0.1"
+end

data/lib/web_task_runner.rb

@@ -0,0 +1,211 @@
+$stdout.sync = true
+
+require 'sinatra'
+require 'dotenv'
+Dotenv.load
+
+require "web_task_runner/version"
+require "web_task_runner/redis_module"
+require "web_task_runner/task_worker"
+
+class WebTaskRunner < Sinatra::Application
+  @@jobs = []
+
+  def self.jobs
+    @@jobs
+  end
+
+  # GET /?key=<api_key> - retrieve current state of the crawler
+  get '/' do
+    # Authorize the request
+    error 401, JSON.pretty_generate(error: 'Unauthorized') and \
+      return if ENV['API_KEY'] != params[:key]
+
+    return JSON.pretty_generate(current_info)
+  end
+
+  # GET /start?key=<api_key> - start the crawler if idle
+  get '/start' do
+    # Authorize the request
+    error 401, JSON.pretty_generate(error: 'Unauthorized') and \
+      return if ENV['API_KEY'] != params[:key]
+
+    start_task_if_idle
+
+    return 'start'
+  end
+
+  # GET /kill?key=<api_key> - kill the working job
+  get '/kill' do
+    # Authorize the request
+    error 401, JSON.pretty_generate(error: 'Unauthorized') and \
+      return if ENV['API_KEY'] != params[:key]
+
+    kill_task
+
+    return 'kill'
+  end
+
+  # Report that a worker has done working, call this in each worker after
+  # the work has done
+  def self.work_ended(all: false)
+    if all
+      WebTaskRunner::RedisModule.redis.set('task:working_jobs', 0)
+    else
+      # decrease the working workers count
+      WebTaskRunner::RedisModule.redis.decr('task:working_jobs')
+    end
+
+    # 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:finished_at', Time.now)
+    end
+  end
+
+  # Sets the progress of the current work
+  # It can be used like this in the worker: +WebTaskRunner.work_2_progress = 0.8+
+  1000.times do |i|
+    i += 1
+    define_singleton_method("job_#{i}_progress=") do |progress|
+      WebTaskRunner::RedisModule.redis.set("task:worker_#{i}_progress", progress)
+    end
+  end
+
+  # Starts (or kill and restart) the task
+  def self.start_task
+    kill_task
+    WebTaskRunner::RedisModule.redis.set('task:state', 'working')
+    WebTaskRunner::RedisModule.redis.set('task:started_at', Time.now)
+
+    # Set the count of worker that should be started
+    jobs_count = @@jobs.count
+
+    # Start the worker here
+    @@jobs.each(&:perform_async)
+
+    WebTaskRunner::RedisModule.redis.set('task:task_jobs', jobs_count)
+    WebTaskRunner::RedisModule.redis.set('task:working_jobs', jobs_count)
+
+    # Reset the progress of each worker
+    jobs_count.times do |i|
+      i -= 1
+      WebTaskRunner::RedisModule.redis.set("task:worker_#{i}_progress", 0)
+    end
+  end
+
+  def start_task  # :nodoc:
+    WebTaskRunner.start_task
+  end
+
+  # Starts the task if it's not running
+  def self.start_task_if_idle
+    return unless current_state == 'idle'
+    start_task
+  end
+
+  def start_task_if_idle  # :nodoc:
+    WebTaskRunner.start_task_if_idle
+  end
+
+  # Kills the running task
+  def self.kill_task
+    ps = Sidekiq::ProcessSet.new
+    ps.each do |p|
+      p.stop! if p['busy'] > 0
+    end
+    sleep(0.5)
+    Sidekiq::Queue.new.clear
+    Sidekiq::ScheduledSet.new.clear
+    Sidekiq::RetrySet.new.clear
+    WebTaskRunner.work_ended(all: true)
+  end
+
+  def kill_task  # :nodoc:
+    WebTaskRunner.kill_task
+  end
+
+  # Get the current state
+  def self.current_state
+    WebTaskRunner::RedisModule.redis.get('task:state') || 'idle'
+  end
+
+  def current_state  # :nodoc:
+    WebTaskRunner.current_state
+  end
+
+  # Get the task progress
+  def self.task_progress
+    return nil if current_state == 'idle'
+    task_jobs = WebTaskRunner::RedisModule.redis.get('task:task_jobs').to_i
+    return nil unless task_jobs
+    total_progress = 0.0
+
+    task_jobs.times do |i|
+      i += 1
+      total_progress += WebTaskRunner::RedisModule.redis.get("task:worker_#{i}_progress").to_f
+    end
+
+    total_progress / task_jobs.to_f
+  end
+
+  def task_progress  # :nodoc:
+    WebTaskRunner.task_progress
+  end
+
+  # Get the time when the task last started
+  def self.task_started_at
+    try_to_parse_date_from_redis('task:started_at')
+  end
+
+  def task_started_at  # :nodoc:
+    WebTaskRunner.task_started_at
+  end
+
+  # Get the time when the task last finished
+  def self.task_finished_at
+    return nil if current_state != 'idle'
+    try_to_parse_date_from_redis('task:finished_at')
+  end
+
+  def task_finished_at  # :nodoc:
+    WebTaskRunner.task_finished_at
+  end
+
+  # Get the info of the task
+  def self.current_info
+    info = { state: current_state }
+    info[:task_progress] = task_progress if task_progress
+    info[:task_started_at] = task_started_at if task_started_at
+    info[:task_finished_at] = task_finished_at if task_finished_at
+
+    info
+  end
+
+  def current_info  # :nodoc:
+    WebTaskRunner.current_info
+  end
+
+  # Get the status of the task runner
+  def self.current_status
+    info = { state: current_state }
+
+    info
+  end
+
+  def current_status  # :nodoc:
+    WebTaskRunner.current_status
+  end
+
+  private
+
+  def self.try_to_parse_date_from_redis(key)
+    Time.parse(WebTaskRunner::RedisModule.redis.get(key))
+  rescue
+    nil
+  end
+
+  def try_to_parse_date_from_redis(key)
+    WebTaskRunner.try_to_parse_date_from_redis(key)
+  end
+end

data/web_task_runner.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'web_task_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "web_task_runner"
+  spec.version       = WebTaskRunner::VERSION
+  spec.authors       = ["Neson"]
+  spec.email         = ["neson@dex.tw"]
+
+  spec.summary       = %q{Web wrapper to run a specific task.}
+  spec.description   = %q{Web wrapper to run a specific task with Sidekiq. Provides HTTP API to start, stop, get status of the task running in background, and is deployable to cloud platforms like Heroku.}
+  spec.homepage      = "http://github.com/Neson/web_task_runner"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Web framework and server
+  spec.add_dependency "sinatra", "~> 1.4.6"
+  spec.add_dependency "thin"
+
+  # Job runner
+  spec.add_dependency "sidekiq", "~> 3.3.4"
+  spec.add_dependency "sidekiq-status"
+
+  # Utilities
+  spec.add_dependency "dotenv"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: web_task_runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+- !ruby/object:Gem::Dependency
+  name: sidekiq-status
+  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
+    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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Web wrapper to run a specific task with Sidekiq. Provides HTTP API to
+  start, stop, get status of the task running in background, and is deployable to
+  cloud platforms like Heroku.
+email:
+- neson@dex.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/web_task_runner.rb
+- lib/web_task_runner/redis_module.rb
+- lib/web_task_runner/task_worker.rb
+- lib/web_task_runner/version.rb
+- web_task_runner.gemspec
+homepage: http://github.com/Neson/web_task_runner
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Web wrapper to run a specific task.
+test_files: []