expirable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 916910e100aa840628c2a8290a7e2c5125355746
+  data.tar.gz: c6075ee52e81f11758d7a8e155dd5870b14cd90f
+SHA512:
+  metadata.gz: 040aabdfa25d7f376d04275b3c2b72f9906957782655130639404d1c50b6d3a1a5da452481f6bac5e89177abb7a059cee7515e1e8d76a514309b402ae3a77377
+  data.tar.gz: bc2eac48b6fdcfba757bfa170ae8977d40245367cd28b59d42bf5c7dfbb4e26e3e0218548dc03154f8f1f09a10c78dce8530c7b8e4e3f4343972fd979c784f93

data/lib/expirable.rb

@@ -0,0 +1,60 @@
+# Rails model mixin that supports deadlines in workflows.
+#
+# It requires clients to do the following:
+#  1. Include Expirable
+#  2. define a `deadline_expired` instance method that will be invoked when the
+#     model's deadline expires
+#  3. define a class method named `newly_expired` that returns a collection of model
+#     instances that have expired, but haven't yet received a `deadline_expired`
+#     message.
+#
+# The mixin relies on an external service to periodically call
+# `Expirable.send_expired_events`, which polls for models which have expired but
+# have not yet received a `deadline_expired` message.
+#
+# @author Brendan MacDonell <brendan@macdonell.net>
+module Expirable
+  extend ActiveSupport::Concern
+
+  # @klasses is a collection holding all classes that have included Expirable.
+  # It is traversed each time 
+  @klasses = []
+
+  def self.register(klass)
+    @klasses << klass
+  end
+
+  included do
+    Expirable.register(self)
+  end
+
+  def self.send_expired_event(object)
+    Rails.logger.info "Sending deadline expired event to #{object}"
+    begin
+      object.deadline_expired
+    rescue Exception => e
+      Rails.logger.error <<-eos.strip_heredoc
+        Deadline expiration failed with #{e.message}
+        #{e.backtrace.join("\n")}
+      eos
+    end
+  end
+
+  # Called periodically to send `deadline_expired` messages. It doesn't actually
+  # send the messages sequentially, but enqueues a call to `send_expired_event` to
+  # execute the message send asynchronously.
+  #
+  # Note that this method has no notion of priority, and may enqueue calls on objects
+  # that already have method calls enqueued. It is up to the client to make sure that
+  # there are enough workers so that the processing rate of the queue exceeds the
+  # arrival rate.
+  def self.send_expired_events
+    @klasses.each do |klass|
+      klass.newly_expired.each do |object|
+        self.delay.send_expired_event(object)
+      end
+    end
+
+    nil
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: expirable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brendan MacDonell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: clockwork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Easily handle deadline-based workflow transitions in Rails
+email: brendan@macdonell.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/expirable.rb
+homepage: http://rubygems.org/gems/expirable
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Expirable
+test_files: []
+has_rdoc: