simple_worker 0.3.20 → 0.3.21

data/README.markdown

@@ -1,218 +1,237 @@
-Getting Started
-===============
-
-[Sign up for a SimpleWorker account][1], it's free to try!
-
-[1]: http://www.simpleworker.com/
-
-Configure SimpleWorker
-----------------------
-
-You really just need your access keys.
-
-    SimpleWorker.configure do |config|
-        config.access_key = ACCESS_KEY
-        config.secret_key = SECRET_KEY
-    end
-
-Write a Worker
---------------
-
-Here's an example worker that sends an email:
-
-    require 'simple_worker'
-
-    class EmailWorker < SimpleWorker::Base
-
-        attr_accessor :to, :subject, :body
-
-        # This is the method that will be run
-        def run
-            send_email(:to=>to, :subject=>subject, :body=>body)
-        end
-
-        def send_email
-            # Put sending code here
-        end
-    end
-
-Test It Locally
----------------
-
-Let's say someone does something in your app and you want to send an email about it.
-
-    worker = EmailWorker.new
-    worker.to = current_user.email
-    worker.subject = "Here is your mail!"
-    worker.body = "This is the body"
-    worker.run_local
-
-Once you've got it working locally, the next step is to run it on the SimpleWorker cloud.
-
-Queue up your Worker on the SimpleWorker Cloud
-----------------------------------------------
-
-Let's say someone does something in your app and you want to send an email about it.
-
-    worker = EmailWorker.new
-    worker.to = current_user.email
-    worker.subject = "Here is your mail!"
-    worker.body = "This is the body"
-    worker.queue
-
-This will send it off to the SimpleWorker cloud.
-
-Schedule your Worker
---------------------
-
-There are two scenarios here, one is the scenario where you want something to happen due to a user
-action in your application. This is almost the same as queuing your worker.
-
-    worker = EmailWorker.new
-    worker.to = current_user.email
-    worker.subject = "Here is your mail!"
-    worker.body = "This is the body"
-    worker.schedule(:start_at=>1.hours.since)
-
-Check Status
-------------
-
-If you still have access to the worker object, just call:
-
-    worker.status
-
-If you only have the job ID, call:
-
-    SimpleWorker.service.status(job_id)
-
-This will return a hash like:
-
-     {"task_id"=>"ece460ce-12d8-11e0-8e15-12313b0440c6",
-     "status"=>"running",
-     "msg"=>nil,
-     "start_time"=>"2010-12-28T23:19:36+00:00",
-     "end_time"=>nil,
-     "duration"=>nil,
-     "progress"=>{"percent"=>25}}
-
-
-Logging
--------
-
-In your worker, just call the log method with the string you want logged:
-
-    log "Starting to do something..."
-
-The log will be available for viewing via the SimpleWorker UI or via log in the API:
-
-    SimpleWorker.service.log(job_id)
-
-Setting Progress
-----------------
-
-This is just a way to let your users know where the job is at if required.
-
-    set_progress(:percent => 25, :message => "We are a quarter of the way there!")
-
-You can actually put anything in this hash and it will be returned with a call to status. We recommend using
-the format above for consistency and to get some additional features where we look for these values.
-
-Schedule a Recurring Job - CRON
-------------------------------
-
-The alternative is when you want to user it like Cron. In this case you'll probably
-want to write a script that will schedule, you don't want to schedule it everytime your
-app starts or anything so best to keep it external.
-
-Create a file called 'schedule_email_worker.rb' and add this:
-
-    require 'simple_worker'
-    require_relative 'email_worker'
-
-    worker = EmailWorker.new
-    worker.to = current_user.email
-    worker.subject = "Here is your mail!"
-    worker.body = "This is the body"
-    worker.schedule(:start_at=>1.hours.since, :run_every=>3600)
-
-Now run it and your worker will be scheduled to run every hour.
-
-SimpleWorker on Rails
----------------------
-
-Rails 2.X:
-
-    config.gem 'simple_worker'
-
-Rails 3.X:
-
-    gem 'simple_worker'
-
-Now you can use your workers like they're part of your app!  We recommend putting your worker classes in
-/app/workers path.
-
-Configuring a Database Connection
----------------------------------
-
-Although you could easily do this in your worker, this makes it a bit more convenient and more importantly
-it will create the connection for you. If you are using ActiveRecord, you would add the following to your
-SimpleWorker config:
-
-    config.database = {
-      :adapter => "mysql2",
-      :host => "localhost",
-      :database => "appdb",
-      :username => "appuser",
-      :password => "secret"
-    }
-
-Then before you job is run, SimpleWorker will establish the ActiveRecord connection.
-
-Including/Merging other Ruby Classes
-------------------------------------
-
-If you are using the Rails setup above, you can probably skip this as your models will automatically be merged.
-
-    class AvgWorker < SimpleWorker::Base
-
-        attr_accessor :aws_access_key,
-                      :aws_secret_key,
-                      :s3_suffix
-
-        merge File.join(File.dirname(__FILE__), "..", "app", "models", "user.rb")
-        merge File.join(File.dirname(__FILE__), "..", "app", "models", "account")
-
-Or simpler yet, try using relative paths:
-
-    merge "../app/models/user"
-    merge "../app/models/account.rb"
-
-The opposite can be done as well with "unmerge" and can be useful when using Rails to exclude classes that are automatically
-merged.
-
-
-Bringing in other Workers
----------------------
-
-merge_worker
-TODO
-
-
-Configuration Options
----------------------
-
-### Global Attributes
-
-These are attributes that can be set as part of your config block then will be set on
-all your worker objects automatically. This is particularly good for things like database
-connection info or things that you would need to use across the board.
-
-Eg:
-
-    config.global_attributes[:db_user] = "sa"
-    config.global_attributes[:db_pass] = "pass"
-
-Then in your worker, you would have the attributes defined:
-
-    attr_accessor :db_user, :db_pass
-
+Getting Started
+===============
+
+[Sign up for a SimpleWorker account][1], it's free to try!
+
+[1]: http://www.simpleworker.com/
+
+Install SimpleWorker Gem
+------------------------
+
+    gem install simple_worker
+
+Configure SimpleWorker
+----------------------
+
+You really just need your access keys.
+
+    SimpleWorker.configure do |config|
+        config.access_key = ACCESS_KEY
+        config.secret_key = SECRET_KEY
+    end
+
+Write a Worker
+--------------
+
+Here's an example worker that sends an email:
+
+    require 'simple_worker'
+
+    class EmailWorker < SimpleWorker::Base
+
+        attr_accessor :to, :subject, :body
+
+        # This is the method that will be run
+        def run
+            send_email(:to=>to, :subject=>subject, :body=>body)
+        end
+
+        def send_email
+            # Put sending code here
+        end
+    end
+
+Test It Locally
+---------------
+
+Let's say someone does something in your app and you want to send an email about it.
+
+    worker = EmailWorker.new
+    worker.to = current_user.email
+    worker.subject = "Here is your mail!"
+    worker.body = "This is the body"
+    worker.run_local
+
+Once you've got it working locally, the next step is to run it on the SimpleWorker cloud.
+
+Queue up your Worker on the SimpleWorker Cloud
+----------------------------------------------
+
+Let's say someone does something in your app and you want to send an email about it.
+
+    worker = EmailWorker.new
+    worker.to = current_user.email
+    worker.subject = "Here is your mail!"
+    worker.body = "This is the body"
+    worker.queue
+
+This will send it off to the SimpleWorker cloud.
+
+Setting Priority
+----------------------------------------------
+
+Simply define the priority in your queue command.
+
+    worker.queue(:priority=>1)
+
+Default priority is 0 and we currently support priority 0, 1, 2. See [pricing page](http://www.simpleworker.com/pricing)
+for more information on priorites.
+
+
+Schedule your Worker
+--------------------
+
+There are two scenarios here, one is the scenario where you want something to happen due to a user
+action in your application. This is almost the same as queuing your worker.
+
+    worker = EmailWorker.new
+    worker.to = current_user.email
+    worker.subject = "Here is your mail!"
+    worker.body = "This is the body"
+    worker.schedule(:start_at=>1.hours.since)
+
+Check Status
+------------
+
+If you still have access to the worker object, just call:
+
+    worker.status
+
+If you only have the job ID, call:
+
+    SimpleWorker.service.status(job_id)
+
+This will return a hash like:
+
+     {"task_id"=>"ece460ce-12d8-11e0-8e15-12313b0440c6",
+     "status"=>"running",
+     "msg"=>nil,
+     "start_time"=>"2010-12-28T23:19:36+00:00",
+     "end_time"=>nil,
+     "duration"=>nil,
+     "progress"=>{"percent"=>25}}
+
+
+Logging
+-------
+
+In your worker, just call the log method with the string you want logged:
+
+    log "Starting to do something..."
+
+The log will be available for viewing via the SimpleWorker UI or via log in the API:
+
+    SimpleWorker.service.log(job_id)
+
+Setting Progress
+----------------
+
+This is just a way to let your users know where the job is at if required.
+
+    set_progress(:percent => 25, :message => "We are a quarter of the way there!")
+
+You can actually put anything in this hash and it will be returned with a call to status. We recommend using
+the format above for consistency and to get some additional features where we look for these values.
+
+Schedule a Recurring Job - CRON
+------------------------------
+
+The alternative is when you want to user it like Cron. In this case you'll probably
+want to write a script that will schedule, you don't want to schedule it everytime your
+app starts or anything so best to keep it external.
+
+Create a file called 'schedule_email_worker.rb' and add this:
+
+    require 'simple_worker'
+    require_relative 'email_worker'
+
+    worker = EmailWorker.new
+    worker.to = current_user.email
+    worker.subject = "Here is your mail!"
+    worker.body = "This is the body"
+    worker.schedule(:start_at=>1.hours.since, :run_every=>3600)
+
+Now run it and your worker will be scheduled to run every hour.
+
+SimpleWorker on Rails
+---------------------
+
+Rails 2.X:
+
+    config.gem 'simple_worker'
+
+Rails 3.X:
+
+    gem 'simple_worker'
+
+Now you can use your workers like they're part of your app!  We recommend putting your worker classes in
+/app/workers path.
+
+Configuring an Database Connection
+---------------------------------
+
+Although you could easily do this in your worker, this makes it a bit more convenient and more importantly
+it will create the connection for you. If you are using Rails 3, you just need to add one line:
+
+    config.database = Rails.configuration.database_configuration[Rails.env]
+
+For non Rails 3, you would add the following to your SimpleWorker config:
+
+    config.database = {
+      :adapter => "mysql2",
+      :host => "localhost",
+      :database => "appdb",
+      :username => "appuser",
+      :password => "secret"
+    }
+
+Then before you job is run, SimpleWorker will establish the ActiveRecord connection.
+
+Including/Merging other Ruby Classes
+------------------------------------
+
+If you are using the Rails setup above, you can probably skip this as your models will automatically be merged.
+
+    class AvgWorker < SimpleWorker::Base
+
+        attr_accessor :aws_access_key,
+                      :aws_secret_key,
+                      :s3_suffix
+
+        merge File.join(File.dirname(__FILE__), "..", "app", "models", "user.rb")
+        merge File.join(File.dirname(__FILE__), "..", "app", "models", "account")
+
+Or simpler yet, try using relative paths:
+
+    merge "../models/user"
+    merge "../models/account.rb"
+
+The opposite can be done as well with "unmerge" and can be useful when using Rails to exclude classes that are automatically
+merged.
+
+
+Bringing in other Workers
+---------------------
+
+merge_worker
+TODO
+
+
+Configuration Options
+---------------------
+
+### Global Attributes
+
+These are attributes that can be set as part of your config block then will be set on
+all your worker objects automatically. This is particularly good for things like database
+connection info or things that you would need to use across the board.
+
+Eg:
+
+    config.global_attributes[:db_user] = "sa"
+    config.global_attributes[:db_pass] = "pass"
+
+Then in your worker, you would have the attributes defined:
+
+    attr_accessor :db_user, :db_pass
+

data/lib/railtie.rb

@@ -8,14 +8,13 @@ module SimpleWorker
 #    railtie_name :simple_worker deprecated
 
     initializer "simple_worker.configure_rails_initialization" do |app|
-      puts 'railtie'
-      puts "Initializing list of Rails models..."
+      puts "Initializing SimpleWorker for Rails 3..."
       SimpleWorker.configure do |c2|
         path = File.join(Rails.root, 'app/models/*.rb')
-        puts 'path=' + path
+#        puts 'path=' + path
         c2.models = Dir.glob(path)
         c2.extra_requires += ['active_support/core_ext', 'active_record', 'action_mailer']
-        puts 'config.models=' + c2.models.inspect
+#        puts 'config.models=' + c2.models.inspect
       end
 
     end

data/lib/simple_worker/base.rb

@@ -87,7 +87,7 @@ module SimpleWorker
       end
 
       def merge_worker(file, class_name)
-        puts 'merge_worker in ' + self.name
+#        puts 'merge_worker in ' + self.name
         merge(file)
         @merged_workers << [File.expand_path(file), class_name]
       end
@@ -126,6 +126,7 @@ module SimpleWorker
     end
 
     def set_global_attributes
+      return unless SimpleWorker.config
       ga = SimpleWorker.config.global_attributes
       if ga && ga.size > 0
         ga.each_pair do |k, v|
@@ -138,12 +139,12 @@ module SimpleWorker
     end
 
     # Will send in all instance_variables.
-    def queue
+    def queue(options={})
 #            puts 'in queue'
       set_auto_attributes
       upload_if_needed
 
-      response     = SimpleWorker.service.queue(self.class.name, sw_get_data)
+      response     = SimpleWorker.service.queue(self.class.name, sw_get_data, options)
 #            puts 'queue response=' + response.inspect
       @task_set_id = response["task_set_id"]
       @task_id     = response["tasks"][0]["task_id"]

data/lib/simple_worker/service.rb

@@ -20,7 +20,7 @@ module SimpleWorker
       puts "Uploading #{class_name}"
       # check whether it should upload again
       tmp          = Dir.tmpdir()
-      md5file      = "simple_worker_#{class_name.gsub("::", ".")}.md5"
+      md5file      = "simple_worker_#{class_name.gsub("::", ".")}_#{access_key[0,8]}.md5"
       existing_md5 = nil
       f            = File.join(tmp, md5file)
       if File.exists?(f)
@@ -66,7 +66,7 @@ module SimpleWorker
       if unmerge
         unmerge.each do |x|
           deleted = merge.delete x
-          puts "Unmerging #{x}. Success? #{deleted}"
+#          puts "Unmerging #{x}. Success? #{deleted}"
         end
       end
 
@@ -80,7 +80,7 @@ module SimpleWorker
            end
          end
         merge.each do |m|
-          puts "merging #{m} into #{filename}"
+#          puts "merging #{m} into #{filename}"
           f.write File.open(m, 'r') { |mo| mo.read }
           f.write "\n\n"
         end
@@ -96,7 +96,7 @@ module SimpleWorker
 
     # class_name: The class name of a previously upload class, eg: MySuperWorker
     # data: Arbitrary hash of your own data that your task will need to run.
-    def queue(class_name, data={})
+    def queue(class_name, data={}, options={})
       puts "Queuing #{class_name}"
       if !data.is_a?(Array)
         data = [data]
@@ -105,8 +105,10 @@ module SimpleWorker
       hash_to_send               = {}
       hash_to_send["payload"]    = data
       hash_to_send["class_name"] = class_name
+      hash_to_send["priority"] = options[:priority] if options[:priority]
       add_sw_params(hash_to_send)
       if defined?(RAILS_ENV)
+        # todo: move this to global_attributes in railtie
         hash_to_send["rails_env"] = RAILS_ENV
       end
       return queue_raw(class_name, hash_to_send)

data/lib/simple_worker.rb

@@ -26,8 +26,8 @@ module SimpleWorker
 end
 
 if defined?(Rails)
-  puts 'Rails=' + Rails.inspect
-  puts 'vers=' + Rails::VERSION::MAJOR.inspect
+#  puts 'Rails=' + Rails.inspect
+#  puts 'vers=' + Rails::VERSION::MAJOR.inspect
   if Rails::VERSION::MAJOR == 2
     require_relative 'rails2_init.rb'
   else

data/test/test_no_config.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+begin
+  require File.join(File.dirname(__FILE__), '../lib/simple_worker')
+rescue Exception => ex
+  puts ex.message
+  require 'simple_worker'
+end
+require_relative "test_worker"
+require_relative "test_worker_2"
+
+
+class SimpleWorkerTests < Test::Unit::TestCase
+
+  def test_no_conf
+    # Add something to queue, get task ID back
+    tw        = TestWorker.new
+    tw.s3_key = "active style runner"
+    tw.times  = 3
+
+    tw.run_local
+
+  end
+
+end
+

data/test/test_worker.rb

@@ -9,12 +9,10 @@ class TestWorker < SimpleWorker::Base
 
     attr_accessor :s3_key, :times
 
-    def run(data=nil)
-        log 'running the runner for leroy '.upcase + ' with data: ' + data.inspect
-
+    def run
+        log 'running the test worker for moi '.upcase
         log 's3_key instance_variable = ' + self.s3_key.to_s
 
-        @times = data["times"].to_i
         @times.times do |i|
             log 'running at ' + i.to_s
             sleep 1
@@ -26,12 +24,6 @@ class TestWorker < SimpleWorker::Base
         log 'SET COMPLETE YAY!' + params[:task_set_id]
     end
 
-    def progress
-        if @count
-            return @count / @times
-        end
-        return 0.0
-    end
 
 end
 

metadata

@@ -1,44 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple_worker
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 20
-  version: 0.3.20
+version: !ruby/object:Gem::Version
+  version: 0.3.21
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Travis Reeder
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-07 00:00:00 -08:00
+date: 2011-02-13 00:00:00.000000000 -08:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: appoxy_api
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &26617572 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: I could tell you, but then I'd have to...
+  prerelease: false
+  version_requirements: *26617572
+description: The official SimpleWorker gem for http://www.simpleworker.com
 email: travis@appoxy.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - lib/rails2_init.rb
 - lib/railtie.rb
 - lib/simple_worker.rb
@@ -55,6 +46,7 @@ files:
 - test/second_worker.rb
 - test/test_base.rb
 - test/test_inheritance.rb
+- test/test_no_config.rb
 - test/test_simple_worker.rb
 - test/test_worker.rb
 - test/test_worker_2.rb
@@ -62,36 +54,29 @@ files:
 has_rdoc: true
 homepage: http://github.com/appoxy/simple_worker
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
-summary: Classified
-test_files: 
+summary: The official SimpleWorker gem for http://www.simpleworker.com
+test_files:
 - test/models/model_1.rb
 - test/models/model_2.rb
 - test/requiring_worker.rb
@@ -99,6 +84,7 @@ test_files:
 - test/second_worker.rb
 - test/test_base.rb
 - test/test_inheritance.rb
+- test/test_no_config.rb
 - test/test_simple_worker.rb
 - test/test_worker.rb
 - test/test_worker_2.rb