actionable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45a9bd1c736c4e4a5ad2b7346e96604fe762252f
-  data.tar.gz: afd9fa6c64ff5ca69285019c34605ed46c3abbdd
+  metadata.gz: 59ea314ec2b4a5a5e5e9264c4c3a62b7ab012b4d
+  data.tar.gz: d05dda313d5413911dd9885811bd7863c33fd2f6
 SHA512:
-  metadata.gz: d63c6d2439e5923342173b1b998e122876c4d4533e24782fd2f4e5898ff0e57ed64dcbfe4306622684f5f1872227c203918fd0e579e5c41af2b502f27ccd61ec
-  data.tar.gz: b64f3d371ce3c95716162ed3ebf215351176253497ff7837d051b6966643aae9210101031a7d5b0b4b974738b076aa4d49a1f786327d21fc1e3d1e9eedb95df9
+  metadata.gz: a1af58fdea6f80e3be686f0423da148114462437276ae3f6c6df6abd42b27bbc60a86da5c89451ec6f69d618c4fc689043af926967fcff96531fd447ba49e458
+  data.tar.gz: a4e40d2e4426f2996741369d14aa5226468dafbea37f9442a6be168890e9bf645b0342c897816fa0f485807c15d57f0e0ee9a376340e3cf15f2e2cc2fa914894

data/README.md

@@ -5,7 +5,7 @@
 
 <img src="https://semaphoreapp.com/api/v1/projects/d32a2e65068b7b995bd9e9e2f8beb99a64c7f98d/36068/badge.png">
 
-TODO: Write a gem description
+Actionables, jobs to do later. Scheduled, not queued.
 
 ## Installation
 
@@ -23,7 +23,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Actionables
+
+Include in model:
+
+```ruby
+class Book 
+
+  include Mongoid::Document
+  include Actionable::Target
+
+  field :current_page
+
+end
+```
+
+Schedule actionable:
+
+```ruby
+mybook = Book.new
+mybook.schedule_actionable(1.hour.from_now,ReadBook,{pages:27})
+```
+
+Make sure the job exists too:
+
+```ruby
+class ReadBook < Actionable::Job
+
+  def perform
+    target.current_page = target.current_page + payload[:pages]
+    target.save
+  end
+
+end
+```
+
+`schedule_actionable` takes three arguments: when to execute the job, the job class and an optional payload hash. Inside your `Actionable::Job`-inheriting class, the model for which the actionable was created (`mybook` above) is available as `target` and the payload hash is available as `payload`.
+
+The actionables themselves are instances of `Actionable::Action` and are available as `actionables` on the model. They can have lots of stuff done to them:
+
+```ruby
+# cancel all actionables
+mybook.actionables.each(&:cancel)
+
+# reschedule the first one for two hours from now
+mybook.actionables.first.reschedule_for(2.hours.from_now)
+
+# update the payload of the last one
+mybook.actionables.last.update_attribute(:payload,{pages:32})
+```
+
+`Actionable::Actions` are also Mongoid documents.
+
+### Recurring Actionables
+
+Super simple:
+
+```ruby
+# read five pages every five minutes...forever
+Actionable::Recurrence.create({
+  recurrence_string: "*/12 * * * *",
+  job_class: ReadBook,
+  payload: {pages:5} 
+})
+```
+
+### Running Worker
+
+Same as a normal Resque worker, just `require 'actionable/tasks'` at the top of you `Rakefile` to patch Resque's worker to poll Mongoid for actionable when Redis is out of jobs.
+
+## Tests
+
+```
+$ rake spec
+```
 
 ## Contributing
 

data/lib/actionable/job.rb

@@ -7,10 +7,10 @@ module Actionable
       @queue ||= 'actionable'
     end
 
-    def self.after_enqueue(id)
-      actionable = Actionable::Action.find(id)
-      actionable.update_attributes(status: :enqueued)
-    end
+    # def self.after_enqueue(id)
+    #   actionable = Actionable::Action.find(id)
+    #   actionable.update_attributes(status: :enqueued)
+    # end
 
     def self.perform(id)
       actionable = Actionable::Action.find(id)

data/lib/actionable/memory_store/action.rb

@@ -33,9 +33,11 @@ module Actionable
       end
 
       def cancel
-        update_attributes(status: :cancelled)
+        update_attributes(status: :canceled)
       end
 
+      alias :cancel! :cancel
+
       def reschedule_for(execution_time)
         update_attributes(execution_time: execution_time)
       end

data/lib/actionable/mongoid_store/action.rb

@@ -15,12 +15,18 @@ module Actionable
       field :target_id,         type: Moped::BSON::ObjectId
       field :target_class_name, type: String
 
-      scope :scheduled, where(status: :scheduled)
       scope :scheduled_for_between, ->(from,to){ 
         between(execution_time:[from,to])
       }
       scope :scheduled_for_before, ->(to){ where(:execution_time.lt => to) }
 
+      scope :with_job_class, ->(klass) { where(job_class_name: klass.to_s.classify)}
+
+      [:scheduled,:enqueued,:working,:complete,:canceled,:failed].each do |status|
+        scope status, where(status: status)
+        define_method(:"#{status}?") { self.status == status }
+      end
+
       def self.to_do
         scheduled.scheduled_for_before(Time.now.to_datetime)
       end

data/lib/actionable/version.rb

@@ -1,3 +1,3 @@
 module Actionable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/recurrence_spec.rb

@@ -84,7 +84,7 @@ describe Actionable::Recurrence do
   context "over the course of an hour" do
 
     it "should create and perform the job 11 times" do
-      RecurringTestJob.should_receive(:go).exactly(12).times
+      RecurringTestJob.should_receive(:go).at_least(11).times
       Timecop.travel(1.hour.from_now.change(minutes:0))
       recurrence.valid?
       60.times do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Luxemburg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler