deify 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Monica McArthur
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+Surety
+============
+
+A lightweight guaranteed-delivery messaging system.
+
+
+Dependency Notes
+================
+
+* Surety uses ActiveRecord to persist the message requests in order to provide transactional, guaranteed-delivery requests. Requires ActiveRecord 3.0.0 or higher.
+* Surety uses Resque to underpin the message processing/retry loop. Requires Resque 1.19.0 or higher.
+
+
+Usage / Examples
+================
+
+A simple class that can send a message for guaranteed delivery:
+
+    class TestGenerator
+      include Surety::Generator
+    
+      def some_method
+        self.send_message(message_content)
+      end
+    end
+    
+
+On the server side, to start up the loop to process messages:
+
+  Surety::Processor.request_next
+
+    
+Configuration
+=============
+
+Both the prefix for the ActiveRecord database connection name (as specified in database.yml) and the class to which Surety delegates messages for processing after pulling them off the queue are configurable.
+
+Also configurable are three parameters related to failure retries: 
+ * retry interval: base amount of time to wait before a retry, in minutes. Defaults to 10. 
+ * backoff factor: factor to divide the failure count by before calculating an exponential backoff. The backoff factor is (2^floor(failure count/backoff interval)). Defaults to 2.
+ * max backoff: maximum number of powers of 2 to backoff. Defaults to 7 (which gives a backoff factor of 128; together with the default retry interval of 10, this produces a default max backoff amount of 1280 minutes ~ 1 day).
+
+Example configuration (from a sample config/initializers/surety.rb file)
+
+Surety::Configuration.database_prefix = 'surety_'
+Surety::Configuration.message_processing_delegate = MessageDistributor
+Surety::Configuration.retry_interval = 20
+Surety::Configuration.backoff_factor = 4
+Surety::Configuration.max_backoff = 5
+
+
+Install
+=======
+
+### As a gem
+
+    $ gem install surety
+
+
+Acknowledgements
+================
+
+Copyright (c) 2012 Monica McArthur, released under the MIT license.
+
+Thanks to Ryan and Steve for arguing that this gem was necessary... it is.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the surety gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/deify.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name              = 'deify'
+  s.version           = '0.0.1'
+  s.date              = Time.now.strftime('%Y-%m-%d')
+  s.summary           = 'Sets up god/resque/redis configuration for any app using resque-based gems at Revolution Prep.'
+  s.homepage          = ''
+  s.email             = 'monica@revolutionprep.com'
+  s.authors           = ['Monica McArthur']
+
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency('rails', '>= 3.0.0')
+
+  s.description       = <<-DESC
+    Sets up god/resque/redis configuration for any app using resque-based gems at Revolution Prep.
+  DESC
+end

data/lib/deify.rb

@@ -0,0 +1,5 @@
+require 'rails'
+require 'deify/engine'
+
+module Deify
+end

data/lib/deify/engine.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+module Deify
+
+  class Engine < Rails::Engine
+
+    generators do
+      require File.dirname(__FILE__) + '/../generators/install_generator.rb'
+    end
+
+  end
+
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Deify
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    def manifest
+      copy_file "resque.god", "config/god/resque.god"
+      copy_file "redis.yml", "config/redis.yml"
+      copy_file "resque.rb", "config/initializers/resque.rb"
+    end
+    
+  end
+end

data/lib/generators/templates/redis.yml

@@ -0,0 +1,16 @@
+development:
+  host: localhost
+  port: 6379
+
+test:
+  host: 127.0.0.1
+  port: 9736
+
+qa:
+  host: 172.16.136.78
+  port: 6379
+
+production:
+  host: 192.168.10.201
+  port: 6379
+

data/lib/generators/templates/resque.god

@@ -0,0 +1,55 @@
+app_name    = 'your_app_name' # This should match the app name in deploy.rb
+rails_env   = ENV['RAILS_ENV']  || "production"
+rails_root  = ENV['RAILS_ROOT'] || "/var/www/#{app_name}"
+rake_cmd    = rails_env != 'development' ? '/opt/ruby_ent/bin/rake' : '/usr/bin/rake'
+num_workers = rails_env == 'production' ? 10 : 2
+
+num_workers.times do |num|
+  God.watch do |w|
+    w.name     = "#{app_name}-resque-#{num}"
+    w.group    = "#{app_name}-resque"
+    w.interval = 30.seconds
+    w.env      = {"QUEUE"=>"*", "RAILS_ENV"=>rails_env}
+    w.start    = "#{rake_cmd} -f #{rails_root}/Rakefile environment resque:work"
+    w.stop_signal = 'QUIT'
+    w.stop_timeout = 60.seconds
+    w.log = "#{rails_root}/log/god.log"
+
+    # restart if memory gets too high
+    w.transition(:up, :restart) do |on|
+      on.condition(:memory_usage) do |c|
+        c.above = 350.megabytes
+        c.times = 2
+      end
+    end
+
+    # determine the state on startup
+    w.transition(:init, { true => :up, false => :start }) do |on|
+      on.condition(:process_running) do |c|
+        c.running = true
+      end
+    end
+
+    # determine when process has finished starting
+    w.transition([:start, :restart], :up) do |on|
+      on.condition(:process_running) do |c|
+        c.running = true
+        c.interval = 5.seconds
+      end
+
+      # failsafe
+      on.condition(:tries) do |c|
+        c.times = 5
+        c.transition = :start
+        c.interval = 5.seconds
+      end
+    end
+
+    # start if process is not running
+    w.transition(:up, :start) do |on|
+      on.condition(:process_running) do |c|
+        c.running = false
+      end
+    end
+  end
+end

data/lib/generators/templates/resque.rb

@@ -0,0 +1,18 @@
+# Put this file in config/initializers to control how resque and resque-pubsub are run
+
+rails_root = ENV['RAILS_ROOT'] || File.dirname(__FILE__) + '/../..'
+rails_env = ENV['RAILS_ENV'] || 'development'
+
+require 'resque'
+require 'resque/failure/base'
+require 'resque/failure/redis'
+require 'resque/failure/airbrake'
+require 'resque/failure/multiple'
+Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Airbrake]
+Resque::Failure.backend = Resque::Failure::Multiple
+
+REDIS_CONFIG = YAML.load_file(rails_root + '/config/redis.yml')[rails_env]
+Resque.redis = REDIS_CONFIG["host"] + ':' + REDIS_CONFIG["port"].to_s
+
+# Replace 'your_app_name' below with the actual name of the application, or some other namespace if you desire
+Resque.redis.namespace = rails_env=='test' ? 'resque:test_your_app_name' : 'resque:your_app_name'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: deify
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Monica McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: "    Sets up god/resque/redis configuration for any app using resque-based gems at Revolution Prep.\n"
+email: monica@revolutionprep.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- deify.gemspec
+- lib/deify.rb
+- lib/deify/engine.rb
+- lib/generators/install_generator.rb
+- lib/generators/templates/redis.yml
+- lib/generators/templates/resque.god
+- lib/generators/templates/resque.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Sets up god/resque/redis configuration for any app using resque-based gems at Revolution Prep.
+test_files: []
+