skyrunner 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e461062f35d1a7661bb61f88be54376b55d0d319
-  data.tar.gz: d346ab60394937f9cdef921cb069c14f0d69fb27
+  metadata.gz: de70e60abe085c386c83a7c28304636680a2f6dd
+  data.tar.gz: d80cbea2d0674077f3d731f4de3402f7ff2045c2
 SHA512:
-  metadata.gz: 04db8b4daecb7d9f56ea0e420bbf259446fbb4264b23306dcc52fa032187fd0ccc9f2ca8c4ce9f2c4a7b332e6e66bde182756cbd2ed969fd7a079a59eef4701b
-  data.tar.gz: 9d66b4674b4199c5323ec1d70fcfc00d45113d9b7ef75492c4f833908a9bc748d5d1d75b70e8b3dbcdc580ea68b9a7e177414b1eb14e5f5a04bdaa635ef4e5ce
+  metadata.gz: 9408f2d9daf8e8b644625a5e77f9fd933cc734ae611c2a293a27b7b44605c78fc52caca4205e8d5e450bb6d361e27839e5d0ac8033829b3d5dfaead674f915e9
+  data.tar.gz: 8b5410deae5c32154e343e6e09c481d167d01f6c56fe8e3911a1d20dedb27465c963b8fcd97657ac062638f1b6d4bb062b71703694e401e7ebe9ea57918098e1

data/README.md

@@ -1,4 +1,37 @@
-skyrunner
+SkyRunner
 =========
 
-Skyrunner lets you run logical jobs using AWS SQS and DynamoDB
+SkyRunner is a simple job execution framework that lets you run jobs which are composed of small tasks using AWS SQS and DynamoDB. 
+
+The key feature provided is that once a job's last task completes, a completion method can be called so you can perform a post-processing step. For example, you may run a job that has 100 tasks that process image frames in parallel, and then when these tasks are completed you compose the frames into a video and upload it to S3.
+
+Add to your Gemfile:
+
+```
+gem "skyrunner"
+```
+
+To set up with Rails:
+
+```
+bundle exec rails g sky_runner:install
+```
+
+And customize `config/initializers/skyrunner.rb`
+
+To initialize DynamoDB & SQS:
+
+``
+bundle exec rake skyrunner:init
+``
+
+To start a consumer
+
+``
+bundle exec rake skyrunner:consume
+``
+
+See `jobs/example_job.rb` for an example job. To run a job, just call `execute!` on the job, passing any named job arguments you want. The job class should implement the method `run`. This method will get passed the job arguments. For each task you want consumers to run, `run` should yield an array of two elements, the first being the name of the method on the job class to run for the task, and the second a Hash of method arguments.
+
+You can specify `on_complete` and `on_failure` methods to call when the tasks are all completed, or if any of them fail, respectively. These methods will also be passed the original job arguments.
+

data/jobs/example_job.rb

@@ -1,5 +1,11 @@
 require "skyrunner"
 
+# Example job.
+#
+# To run:
+#
+# ExampleJobModule::ExampleJob.new.execute!(number_of_tasks: 7)
+#
 module ExampleJobModule
   class ExampleJob
     include SkyRunner::Job
@@ -8,21 +14,25 @@ module ExampleJobModule
     on_failed :print_failed
 
     def run(number_of_tasks: nil)
+      # Yield the method and arguments you want to call for each task. 
+      # 
+      # The number of times this method yields is the number of tasks that consumers
+      # will run.
       1.upto(number_of_tasks).each do |n|
         yield :print_number, task_number: n
       end
     end
 
     def print_number(task_number: nil)
-      puts "Ran rask #{task_number}"
+      puts "Ran task #{task_number}"
     end
 
     def print_completed(number_of_tasks: nil)
-      puts "Completed with #{number_of_tasks}"
+      puts "Completed with #{number_of_tasks} tasks requested."
     end
 
     def print_failed(number_of_tasks: nil)
-      puts "Failed with #{number_of_tasks}"
+      puts "Example Job Failed."
     end
   end
 end

data/lib/generators/sky_runner/install/install_generator.rb

@@ -21,6 +21,10 @@ module SkyRunner
       def create_initializer_file
         copy_file "skyrunner.rb", "config/initializers/skyrunner.rb"
       end
+
+      def create_rake_tasks
+        copy_file "skyrunner.rake", "lib/tasks/skyrunner.rake"
+      end
     end
   end
 end

data/lib/generators/sky_runner/install/templates/skyrunner.rake

@@ -0,0 +1,16 @@
+namespace :skyrunner do
+  desc "Starts consuming SkyRunner tasks."
+  task init: :environment do
+    SkyRunner.init!
+  end
+
+  desc "Creates DynamoDB table and SQS queue for SkyRunner."
+  task consume: :environment do
+    SkyRunner.consume!
+  end
+
+  desc "Purges and re-creates DynamoDB table and SQS queue for SkyRunner. (Warning: destructive!)"
+  task purge: :environment do
+    SkyRunner.purge!
+  end
+end

data/lib/generators/sky_runner/install/templates/skyrunner.rb

@@ -1,4 +1,6 @@
 SkyRunner.setup do |config|
+  config.logger = Rails.logger
+
   # Customize these to change the name of the table & queue used for job and task management.
   config.dynamo_db_table_name = "skyrunner_jobs_#{Rails.env}"
   config.sqs_queue_name = "skyrunner_tasks_#{Rails.env}"

data/lib/skyrunner/version.rb

@@ -1,3 +1,3 @@
 module Skyrunner
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skyrunner
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Greg Fodor
@@ -111,6 +111,7 @@ files:
 - bin/skyrunner
 - jobs/example_job.rb
 - lib/generators/sky_runner/install/install_generator.rb
+- lib/generators/sky_runner/install/templates/skyrunner.rake
 - lib/generators/sky_runner/install/templates/skyrunner.rb
 - lib/skyrunner.rb
 - lib/skyrunner/engine.rb