simple_worker 0.3.11 → 0.3.13

data/README.markdown

@@ -34,6 +34,17 @@ Here's an example worker that sends an email:
         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**
+
 Queue up your Worker
 --------------------
 
@@ -43,7 +54,7 @@ Let's say someone does something in your app and you want to send an email about
     worker.to = current_user.email
     worker.subject = "Here is your mail!"
     worker.body = "This is the body"
-    worker.queue
+    **worker.queue**
 
 Schedule your Worker
 --------------------
@@ -55,7 +66,12 @@ action in your application. This is almost the same as queuing your worker.
     worker.to = current_user.email
     worker.subject = "Here is your mail!"
     worker.body = "This is the body"
-    worker.schedule(:start_at=>1.hours.since)
+    **worker.schedule(:start_at=>1.hours.since)**
+
+
+
+Schedule your Worker Recurring
+------------------------------
 
 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
@@ -71,4 +87,19 @@ Create a file called 'schedule_email_worker.rb' and add this:
     worker.body = "This is the body"
     worker.schedule(:start_at=>1.hours.since, :run_every=>3600)
 
-Now your worker will be scheduled to run every hour.
+Now run it and your worker will be scheduled to run every hour.
+
+SimpleWorker on Rails
+---------------------
+
+SimpleWorker only supports Rails 3+.
+
+Setup:
+
+- Make a workers directory at RAILS_ROOT/app/workers.
+- In application.rb, uncomment config.autoload_paths and put:
+
+    config.autoload_paths += %W(#{config.paths.app}/workers)
+
+Now you can use your workers like their part of your app!
+

data/lib/simple_worker/base.rb

@@ -21,14 +21,14 @@ module SimpleWorker
             def inherited(subclass)
                 subclass.reset!
 
-                puts "subclass.inspect=" + subclass.inspect
-                puts 'existing caller=' + (subclass.instance_variable_defined?(:@caller_file) ? subclass.instance_variable_get(:@caller_file).inspect : "nil")
-                puts "caller=" + caller.inspect
+#                puts "subclass.inspect=" + subclass.inspect
+#                puts 'existing caller=' + (subclass.instance_variable_defined?(:@caller_file) ? subclass.instance_variable_get(:@caller_file).inspect : "nil")
+#                puts "caller=" + caller.inspect
 #                splits = caller[0].split(":")
 #                caller_file = splits[0] + ":" + splits[1]
                 caller_file = caller[0][0...(caller[0].index(":in"))]
                 caller_file = caller_file[0...(caller_file.rindex(":"))]
-                puts 'caller_file=' + caller_file
+#                puts 'caller_file=' + caller_file
                 # don't need these class_variables anymore probably
                 subclass.instance_variable_set(:@caller_file, caller_file)
 

data/lib/simple_worker.rb

@@ -1,178 +1,180 @@
-require 'appoxy_api'
-require File.join(File.dirname(__FILE__), 'simple_worker', 'base')
-require File.join(File.dirname(__FILE__), 'simple_worker', 'config')
-require File.join(File.dirname(__FILE__), 'simple_worker', 'used_in_worker')
-
-
-module SimpleWorker
-
-    class << self
-        attr_accessor :config,
-                      :service
-
-        def configure()
-            SimpleWorker.config ||= Config.new
-            yield(config)
-            SimpleWorker.service = Service.new(config.access_key, config.secret_key, :config=>config)
-        end
-    end
-
-    class Service < Appoxy::Api::Client
-
-        attr_accessor :config
-
-        def initialize(access_key, secret_key, options={})
-            puts 'Starting SimpleWorker::Service...'
-            self.config = options[:config] if options[:config]
-            super("http://api.simpleworkr.com/api/", access_key, secret_key, options)
-            self.host = self.config.host if self.config && self.config.host
-        end
-
-        # Options:
-        #    - :callback_url
-        #    - :merge => array of files to merge in with this file
-        def upload(filename, class_name, options={})
-
-            # check whether it should upload again
-            tmp = Dir.tmpdir()
-            puts 'tmp=' + tmp.to_s
-            md5file = "simple_workr_#{class_name.gsub("::", ".")}.md5"
-            existing_md5 = nil
-            f = File.join(tmp, md5file)
-            if File.exists?(f)
-                existing_md5 = IO.read(f)
-                puts 'existing_md5=' + existing_md5
-            end
-
-            filename = build_merged_file(filename, options[:merge]) if options[:merge]
-
-#            sys.classes[subclass].__file__
-#            puts '__FILE__=' + Base.subclass.__file__.to_s
-            md5 = Digest::MD5.hexdigest(File.read(filename))
-            puts "new md5=" + md5
-            if md5 != existing_md5
-                puts 'new code, so uploading'
-                File.open(f, 'w') { |f| f.write(md5) }
-            else
-                puts 'same code, not uploading'
-            end
-
-            mystring = nil
-            file = File.open(filename, "r") do |f|
-                mystring = f.read
-            end
-            options = {"code"=>mystring, "class_name"=>class_name}
-            ret = post("code/put", options)
-            ret
-        end
-
-        def build_merged_file(filename, merge)
-            merge = merge.dup
-            merge << filename
-            fname2 = File.join(Dir.tmpdir(), File.basename(filename))
-            puts 'fname2=' + fname2
-            puts 'merged_file_array=' + merge.inspect
-            File.open(fname2, "w") do |f|
-                merge.each do |m|
-                    f.write File.open(m, 'r') { |mo| mo.read }
-                    f.write "\n\n"
-                end
-            end
-            fname2
-        end
-
-        def add_sw_params(hash_to_send)
-            # todo: remove secret key??  Can use worker service from within a worker without it now
-            hash_to_send["sw_access_key"] = self.access_key
-            hash_to_send["sw_secret_key"] = self.secret_key
-        end
-
-        # 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={})
-            if !data.is_a?(Array)
-                data = [data]
-            end
-            hash_to_send = {}
-            hash_to_send["payload"] = data
-            hash_to_send["class_name"] = class_name
-            add_sw_params(hash_to_send)
-            if defined?(RAILS_ENV)
-                hash_to_send["rails_env"] = RAILS_ENV
-            end
-            return queue_raw(class_name, hash_to_send)
-
-        end
-
-        def queue_raw(class_name, data={})
-            params = nil
-            hash_to_send = data
-            hash_to_send["class_name"] = class_name
-            ret = post("queue/add", hash_to_send)
-            ret
-
-        end
-
-
-        #
-        # schedule: hash of scheduling options that can include:
-        #     Required:
-        #     - start_at:      Time of first run - DateTime or Time object.
-        #     Optional:
-        #     - run_every:     Time in seconds between runs. If ommitted, task will only run once.
-        #     - delay_type:    Fixed Rate or Fixed Delay. Default is fixed_delay.
-        #     - end_at:        Scheduled task will stop running after this date (optional, if ommitted, runs forever or until cancelled)
-        #     - run_times:     Task will run exactly :run_times. For instance if :run_times is 5, then the task will run 5 times.
-        #
-        def schedule(class_name, data, schedule)
-            raise "Schedule must be a hash." if !schedule.is_a? Hash
-#            if !data.is_a?(Array)
-#                data = [data]
-#            end
-            hash_to_send = {}
-            hash_to_send["payload"] = data
-            hash_to_send["class_name"] = class_name
-            hash_to_send["schedule"] = schedule
-            add_sw_params(hash_to_send)
-#            puts 'about to send ' + hash_to_send.inspect
-            ret = post("scheduler/schedule", hash_to_send)
-            ret
-        end
-
-        def cancel_schedule(scheduled_task_id)
-            raise "Must include a schedule id." if scheduled_task_id.blank?
-            hash_to_send = {}
-            hash_to_send["scheduled_task_id"] = scheduled_task_id
-            ret = post("scheduler/cancel", hash_to_send)
-            ret
-        end
-
-        def get_schedules()
-            hash_to_send = {}
-            ret = get("scheduler/list", hash_to_send)
-            ret
-        end
-
-        def status(task_id)
-            data = {"task_id"=>task_id}
-            ret = get("task/status", data)
-            ret
-        end
-
-        def schedule_status(schedule_id)
-            data = {"schedule_id"=>schedule_id}
-            ret = get("scheduler/status", data)
-            ret
-        end
-
-        def log(task_id)
-            data = {"task_id"=>task_id}
-            ret = get("task/log", data)
-            puts 'ret=' + ret.inspect
-#            ret["log"] = Base64.decode64(ret["log"])
-            ret
-        end
-
-
-    end
+require 'appoxy_api'
+require 'active_support/core_ext'
+require File.join(File.dirname(__FILE__), 'simple_worker', 'base')
+require File.join(File.dirname(__FILE__), 'simple_worker', 'config')
+require File.join(File.dirname(__FILE__), 'simple_worker', 'used_in_worker')
+
+
+module SimpleWorker
+
+    class << self
+        attr_accessor :config,
+                      :service
+
+        def configure()
+            SimpleWorker.config ||= Config.new
+            yield(config)
+            SimpleWorker.service = Service.new(config.access_key, config.secret_key, :config=>config)
+        end
+    end
+
+    class Service < Appoxy::Api::Client
+
+        attr_accessor :config
+
+        def initialize(access_key, secret_key, options={})
+            puts 'Starting SimpleWorker::Service...'
+            self.config = options[:config] if options[:config]
+            super("http://api.simpleworker.com/api/", access_key, secret_key, options)
+            self.host = self.config.host if self.config && self.config.host
+        end
+
+        # Options:
+        #    - :callback_url
+        #    - :merge => array of files to merge in with this file
+        def upload(filename, class_name, options={})
+
+            # check whether it should upload again
+            tmp = Dir.tmpdir()
+#            puts 'tmp=' + tmp.to_s
+            md5file = "simple_workr_#{class_name.gsub("::", ".")}.md5"
+            existing_md5 = nil
+            f = File.join(tmp, md5file)
+            if File.exists?(f)
+                existing_md5 = IO.read(f)
+#                puts 'existing_md5=' + existing_md5
+            end
+
+            filename = build_merged_file(filename, options[:merge]) if options[:merge]
+
+#            sys.classes[subclass].__file__
+#            puts '__FILE__=' + Base.subclass.__file__.to_s
+            md5 = Digest::MD5.hexdigest(File.read(filename))
+#            puts "new md5=" + md5
+
+            if md5 != existing_md5
+                puts "#{class_name}: new code, so uploading"
+                File.open(f, 'w') { |f| f.write(md5) }
+            else
+                puts "#{class_name}: same code, not uploading"
+            end
+
+            mystring = nil
+            file = File.open(filename, "r") do |f|
+                mystring = f.read
+            end
+            options = {"code"=>mystring, "class_name"=>class_name}
+            ret = post("code/put", options)
+            ret
+        end
+
+        def build_merged_file(filename, merge)
+            merge = merge.dup
+            merge << filename
+            fname2 = File.join(Dir.tmpdir(), File.basename(filename))
+#            puts 'fname2=' + fname2
+#            puts 'merged_file_array=' + merge.inspect
+            File.open(fname2, "w") do |f|
+                merge.each do |m|
+                    f.write File.open(m, 'r') { |mo| mo.read }
+                    f.write "\n\n"
+                end
+            end
+            fname2
+        end
+
+        def add_sw_params(hash_to_send)
+            # todo: remove secret key??  Can use worker service from within a worker without it now
+            hash_to_send["sw_access_key"] = self.access_key
+            hash_to_send["sw_secret_key"] = self.secret_key
+        end
+
+        # 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={})
+            if !data.is_a?(Array)
+                data = [data]
+            end
+            hash_to_send = {}
+            hash_to_send["payload"] = data
+            hash_to_send["class_name"] = class_name
+            add_sw_params(hash_to_send)
+            if defined?(RAILS_ENV)
+                hash_to_send["rails_env"] = RAILS_ENV
+            end
+            return queue_raw(class_name, hash_to_send)
+
+        end
+
+        def queue_raw(class_name, data={})
+            params = nil
+            hash_to_send = data
+            hash_to_send["class_name"] = class_name
+            ret = post("queue/add", hash_to_send)
+            ret
+
+        end
+
+
+        #
+        # schedule: hash of scheduling options that can include:
+        #     Required:
+        #     - start_at:      Time of first run - DateTime or Time object.
+        #     Optional:
+        #     - run_every:     Time in seconds between runs. If ommitted, task will only run once.
+        #     - delay_type:    Fixed Rate or Fixed Delay. Default is fixed_delay.
+        #     - end_at:        Scheduled task will stop running after this date (optional, if ommitted, runs forever or until cancelled)
+        #     - run_times:     Task will run exactly :run_times. For instance if :run_times is 5, then the task will run 5 times.
+        #
+        def schedule(class_name, data, schedule)
+            raise "Schedule must be a hash." if !schedule.is_a? Hash
+#            if !data.is_a?(Array)
+#                data = [data]
+#            end
+            hash_to_send = {}
+            hash_to_send["payload"] = data
+            hash_to_send["class_name"] = class_name
+            hash_to_send["schedule"] = schedule
+            add_sw_params(hash_to_send)
+#            puts 'about to send ' + hash_to_send.inspect
+            ret = post("scheduler/schedule", hash_to_send)
+            ret
+        end
+
+        def cancel_schedule(scheduled_task_id)
+            raise "Must include a schedule id." if scheduled_task_id.blank?
+            hash_to_send = {}
+            hash_to_send["scheduled_task_id"] = scheduled_task_id
+            ret = post("scheduler/cancel", hash_to_send)
+            ret
+        end
+
+        def get_schedules()
+            hash_to_send = {}
+            ret = get("scheduler/list", hash_to_send)
+            ret
+        end
+
+        def status(task_id)
+            data = {"task_id"=>task_id}
+            ret = get("task/status", data)
+            ret
+        end
+
+        def schedule_status(schedule_id)
+            data = {"schedule_id"=>schedule_id}
+            ret = get("scheduler/status", data)
+            ret
+        end
+
+        def log(task_id)
+            data = {"task_id"=>task_id}
+            ret = get("task/log", data)
+#            puts 'ret=' + ret.inspect
+#            ret["log"] = Base64.decode64(ret["log"])
+            ret
+        end
+
+
+    end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: simple_worker
 version: !ruby/object:Gem::Version 
-  hash: 5
   prerelease: false
   segments: 
   - 0
   - 3
-  - 11
-  version: 0.3.11
+  - 13
+  version: 0.3.13
 platform: ruby
 authors: 
 - Travis Reeder
@@ -15,23 +14,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-27 00:00:00 -07:00
+date: 2010-10-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: appoxy_api
+  name: active_support
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: appoxy_api
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: I could tell you, but then I'd have to...
 email: travis@appoxy.com
 executables: []
@@ -69,7 +80,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -78,7 +88,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"