delayed_job_tracer 0.9.0 → 1.0.3

data/Gemfile

@@ -1,2 +1,4 @@
-source :rubygems
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in delayed_job_tracer.gemspec
 gemspec

data/{README.md → README.textile}

@@ -1,14 +1,11 @@
-delayed_job_tracer -- Like a tracer bullet for your delayed_job queue.
-====================================
+h1. delayed_job_tracer
 
-## DESCRIPTION
-
-The delayed_job_tracer gem is designed to monitor the delayed_job gem ([https://github.com/collectiveidea/delayed_job](https://github.com/collectiveidea/delayed_job)).  It will alert you via e-mail if something goes wrong, such as if the delayed_job process crashes or one of its jobs fails or takes too long to complete.
+The delayed_job_tracer gem is designed to monitor the delayed_job gem, which was extracted from Shopify ("http://github.com/tobi/delayed_job":http://github.com/tobi/delayed_job), but is now maintained at ("https://github.com/collectiveidea/delayed_job":https://github.com/collectiveidea/delayed_job).  It will alert you via e-mail if something goes wrong, such as if the delayed_job process crashes or one of its jobs fails or takes too long to complete.
 
 This gem also detects wither e-mails sent through delayed_job are actually being delivered by sending test messages (like tracer bullets) to an e-mail account then checking that account to ensure they were processed and dispatched via the delayed_job queue.  The e-mail delivery detection allows you to be notified if e-mails can't be sent out either because of delayed_job having choked or because of an issue with the e-mail account the application uses to send e-mail.
 
 
-## Primary Features
+h2. Primary Features
 
 * Sends an e-mail notification when delayed_job crashes or is unable to complete a job in a reasonable amount of time.
 * Sends an e-mail notification when the Rails application is unable to successfully deliver e-mails via delayed_job.
@@ -16,77 +13,83 @@ This gem also detects wither e-mails sent through delayed_job are actually being
 * Keeps memory usage low by working outside of Rails.
 
 
-## Rails and delayed_job support
-
-* The master branch and all 1.x series gems work with delayed_job 2.1.x and above (Rails 3.x)
-* The 2-3-stable branch and all 0.9.x series gems work with delayed_job 2.0.7 and above (Rails 2.3)
-
-
-## Why use a Cron'd ruby process to monitor delayed_job and e-mail delivery?
+h2. Why use a Cron'd ruby process to monitor delayed_job and e-mail delivery?
 
 * Cron is often considered to be more reliable than process monitoring tools like Monit or God.
 * The Cron'd Ruby process only uses a modest amount of memory (~27MB) for a few seconds at regular intervals, whereas a rake task or runner would equate to the entire size of the Rails application, with a memory footprint that grows over time.
 
 
-## Why use a Perl Script to send alert e-mails to admins?
+h2. Why use a Perl Script to send alert e-mails to admins?
 
 * It's fast
 * It doesn't rely on the Rails application
 * It doesn't rely on the delayed_job process you're monitoring with this gem
 
 
-## Prerequisites
+h2. Prerequisites
 
 1) Install XML and SSL Packages:
 
 Note: These are for Ubuntu.  You may need to find alternate packages for your platform.
 
-  sudo apt-get install libxml2-dev libxslt-dev libnet-ssleay-perl libcrypt-ssleay-perl libio-socket-ssl-perl
+<pre>
+sudo apt-get install libxml2-dev libxslt-dev libnet-ssleay-perl libcrypt-ssleay-perl libio-socket-ssl-perl
+</pre>
 
 2) sendEmail Perl script:
 
 Download from "http://caspian.dotconf.net/menu/Software/SendEmail":http://caspian.dotconf.net/menu/Software/SendEmail and follow the setup instructions, or just follow these instructions:
 
-  wget -c http://caspian.dotconf.net/menu/Software/SendEmail/sendEmail-v1.56.tar.gz
-  tar xvfz sendEmail-v1.56.tar.gz
-  sudo cp -a sendEmail-v1.56/sendEmail /usr/local/bin
-  chmod +x /usr/local/bin/sendEmail
+<pre>
+wget -c http://caspian.dotconf.net/menu/Software/SendEmail/sendEmail-v1.56.tar.gz
+tar xvfz sendEmail-v1.56.tar.gz
+sudo cp -a sendEmail-v1.56/sendEmail /usr/local/bin
+chmod +x /usr/local/bin/sendEmail
+</pre>
 
 Run it to be sure it works:
 
-  sendEmail
+<pre>
+sendEmail
+</pre>
 
 Cleanup:
 
-  rm -rf sendEmail-v1.56*
+<pre>
+rm -rf sendEmail-v1.56*
+</pre>
+	
 
-
-## Installation
+h2. Installation
 
 1) Add the gem to your Gemfile:
 
-  gem "delayed_job_tracer"
-
+<pre>
+gem 'delayed_job_tracer'
+</pre>
+	
 2) Generate the config file:
 
-  rails g delayed_job_tracer
+<pre>
+rails g delayed_job_tracer
+</pre>
 
-## Configuration
+h2. Configuration
 
-1) Create a 'DelayedJobTracer' folder/label in the e-mail account you configure the plugin to send test messages to and a filter to move all incoming messages with '[DelayedJobTracer]' in the subject line to this folder (or label if you're using Gmail).  Set the name of this folder in the config/delayed_job_tracer_config.yml file - as it will be the folder that the Ruby process checks for test messages.
+* Create a 'DelayedJobTracer' folder/label in the e-mail account you configure the plugin to send test messages to and a filter to move all incoming messages with '[DelayedJobTracer]' in the subject line to this folder (or label if you're using Gmail).  Set the name of this folder in the config/delayed_job_tracer_config.yml file - as it will be the folder that the Ruby process checks for test messages.
 
-2) Add a Cron job on the server:
+* Add a Cron job on the server:
 
 Example for running every 15 minutes, replace with your actual app and ruby locations:
 
-  */15 * * * * /usr/local/bin/delayed_job_tracer -c /opt/apps/appname/current/config/delayed_job_tracer_config.yml
-
-Note: If you're using bundler to install gems within an application-specific gem environment, you may need to also install the gem manually on the server so that the executable is available via the location in the example cron entry above.
-
-Finish configuring your settings in the config/delayed_job_tracer_config.yml file.  Your database and ActionMailer config will be applied via the generator, but you'll still need to provide an alternate e-mail account to send administrative notifications through, provide the admin's e-mail address and so forth.
+<pre>
+*/15 * * * * /usr/local/bin/delayed_job_tracer -c /opt/apps/appname/current/config/delayed_job_tracer_config.yml
+</pre>
+	
+* Finish configuring your settings in the config/delayed_job_tracer_config.yml file.  Your database and ActionMailer config will be applied via the generator, but you'll still need to provide an alternate e-mail account to send administrative notifications through, provide the admin's e-mail address and so forth.
 
 
-## License
+h2. License
 
 The MIT License
 
@@ -108,4 +111,4 @@ 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.
+THE SOFTWARE.

data/bin/delayed_job_tracer

@@ -35,4 +35,4 @@ begin
   DelayedJobTracer.run(config)
 rescue Exception => e
   puts "Error: #{e}"
-end
+end

data/delayed_job_tracer.gemspec

@@ -10,14 +10,13 @@ Gem::Specification.new do |s|
   s.email       = ["kjohnston.ca@gmail.com"]
   s.homepage    = "https://github.com/kjohnston/delayed_job_tracer"
   s.summary     = %q{Like a tracer bullet for your delayed_job queue}
-  s.description = %q{Monitors the delayed_job queue and periodically tests its ability to deliver
-                     e-mail messages and e-mails you if something goes wrong, such as the delayed_job
+  s.description = %q{Monitors the delayed_job queue and periodically tests its ability to deliver 
+                     e-mail messages and e-mails you if something goes wrong, such as the delayed_job 
                      process crashes or one of its jobs fails or takes too long to complete.}
 
-  s.add_runtime_dependency "delayed_job", "~> 2.0.7"
-  s.add_runtime_dependency "mms2r",       "2.4.1"
-  s.add_runtime_dependency "mysql2",      ">= 0.2.6", "<= 0.4"
-  s.add_runtime_dependency "tmail",       "1.2.7.1"
+  s.add_dependency('tmail', '1.2.7.1')
+  s.add_dependency('mms2r', '2.4.1')
+  s.add_dependency('mysql', '2.7')
 
   s.files              = `git ls-files`.split("\n")
   s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/delayed_job_tracer.rb

@@ -4,7 +4,7 @@ else
   require File.dirname(__FILE__) + '/delayed_job_tracer/notifier'
   require File.dirname(__FILE__) + '/delayed_job_tracer/message_finder'
   require File.dirname(__FILE__) + '/delayed_job_tracer/mysql_interface'
-
+  
   class DelayedJobTracer
 
     def self.config

data/lib/delayed_job_tracer/delayed_job_tracer_mailer.rb

@@ -1,16 +1,18 @@
 class DelayedJobTracerMailer < ActionMailer::Base
 
   def delayed_job_tracer_test_message
-    config      = YAML.load_file(Rails.root.join('config', 'delayed_job_tracer_config.yml'))
-    @from       = ActionMailer::Base.smtp_settings[:user_name]
-    @recipients = config["monitor"]["username"]
-    @subject    = "[DelayedJobTracer] #{Time.zone.now}"
-    @sent_on    = Time.zone.now
-    @body       = "This is a test message to ensure messages are being delivered successfully via delayed_job."
+    config  = YAML.load_file(Rails.root.join('config', 'delayed_job_tracer_config.yml'))
+    to      = config['monitor']['username']
+    from    = ActionMailer::Base.smtp_settings[:user_name]
+    subject = "[DelayedJobTracer] Test message sent at: #{Time.zone.now}"
+    message = 'This is a test message to ensure messages are being delivered successfully via delayed_job.'
+    mail(:to => to, :from => from, :subject => subject) do |format|
+      format.text { render :text => message }
+    end
   end
-
+  
   def self.enqueue_delayed_job_tracer_test_message
-    delay.deliver_delayed_job_tracer_test_message
+    delay.delayed_job_tracer_test_message
   end
-
+  
 end

data/lib/delayed_job_tracer/message_finder.rb

@@ -5,22 +5,22 @@ require 'mms2r'
 require 'yaml'
 
 class MessageFinder
-
+  
   def self.found_recent_message?
     c = DelayedJobTracer.config['monitor']
-
+    
     server   = c['server']
     port     = c['port'] || 143
     ssl      = c['ssl'] || false
     username = c['username']
     password = c['password']
     folder   = c['folder']
-
+    
     imap = Net::IMAP.new server, port, ssl
     imap.login username, password
     imap.select folder
     uids = imap.search(["UNSEEN"])
-
+    
     emails = []
     times = []
 
@@ -39,12 +39,12 @@ class MessageFinder
     end
 
     imap.disconnect
-
+    
     # Delete tmp files used by mms2r
     emails.map{|m| m[:mms].purge }
 
     # Just checks to see if there was at least one recent unread message
     return true unless times.blank?
   end
-
+  
 end

data/lib/delayed_job_tracer/mysql_interface.rb

@@ -1,52 +1,52 @@
-require 'mysql2'
+require 'mysql'
 
 class MySQLInterface
-
+  
   # Connects to the db and submits a query
   def self.query(sql)
     c = DelayedJobTracer.config['database']
-    d = Mysql2::Client.new(:host => c['ip'], :database => c['database'], :username => c['user'], :password => c['password'])
+    d = Mysql::new(c['ip'], c['user'], c['password'], c['database'])
     d.query(sql)
   end
-
+  
   # Returns true if there are no stale records
   def self.delayed_job_queue_ok?
-    query(delayed_job_stale_records).count.zero?
+    query(delayed_job_stale_records).num_rows.zero?
   end
-
+  
   # Inserts a delayed_job record
   def self.queue_delayed_job
     query(delayed_job_record).to_s
   end
-
+  
   # SQL for selecting stale delayed_job records
   def self.delayed_job_stale_records
     c = DelayedJobTracer.config['delayed_job']
     "SELECT * FROM delayed_jobs WHERE created_at < '#{(Time.now-c['stale']).utc.strftime("%Y-%m-%d %H:%M:%S")}'"
   end
-
+  
   # SQL for inserting a delayed_job record
   def self.delayed_job_record
-    "INSERT INTO delayed_jobs (`handler`, `run_at`, `created_at`, `updated_at`) VALUES
+    "INSERT INTO delayed_jobs (`handler`, `run_at`, `created_at`, `updated_at`) VALUES 
       ('#{delayed_job_handler}', '#{mysql_timestamp}', '#{mysql_timestamp}', '#{mysql_timestamp}')"
   end
-
+  
   # SQL helper method for inserting a delayed_job record
   def self.delayed_job_handler
-    "--- !ruby/struct:Delayed::PerformableMethod
-object: LOAD;DelayedJobTracerMailer
-method: :deliver_delayed_job_tracer_test_message
+    "--- !ruby/struct:Delayed::PerformableMailer 
+object: !ruby/class DelayedJobTracerMailer
+method_name: :delayed_job_tracer_test_message
 args: []"
   end
-
+  
   # Timestamp in the format that e-mails expect
   def self.email_timestamp
     Time.now.strftime("%a, %e %b %Y %H:%M:%S %z")
   end
-
+  
   # Timestamp in the format that MySQL expects
   def self.mysql_timestamp
     Time.now.utc.strftime("%Y-%m-%d %H:%M:%S")
   end
-
+  
 end

data/lib/delayed_job_tracer/notifier.rb

@@ -1,19 +1,19 @@
 require 'yaml'
 
 class Notifier
-
+    
   def self.notify_admin_of_email_issue
     subject_suffix = 'E-mail Issue'
     message_suffix = 'is having trouble sending e-mail via delayed_job, please investigate.'
     send_notification(subject_suffix, message_suffix)
   end
-
+  
   def self.notify_admin_of_queue_issue
     subject_suffix = 'Queue Issue'
     message_suffix = 'has one or more stale delayed_jobs, please investigate.'
     send_notification(subject_suffix, message_suffix)
   end
-
+  
   def self.send_notification(subject_suffix, message_suffix)
     c         = DelayedJobTracer.config
     account   = c['alert']
@@ -25,5 +25,5 @@ class Notifier
                 -s #{account['server']}:#{account['port']} -xu #{account['username']} -xp #{account['password']} \
                 #{ '-o tls=yes' if c['alert']['tls'] == 'true' }"
   end
-
+  
 end

data/lib/delayed_job_tracer/version.rb

@@ -1,3 +1,3 @@
 module DelayedJobTracer
-  VERSION = "0.9.0"
+  VERSION = "1.0.3"
 end

data/lib/generators/delayed_job_tracer/delayed_job_tracer_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+ 
+class DelayedJobTracerGenerator < Rails::Generators::Base
+  
+  attr_accessor :app_name, :db_host, :db_database, :db_username, :db_password,
+                :mail_domain, :mail_username, :mail_password
+      
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+      
+  def create_config_file
+    @app_name = Dir.glob(Rails.root).to_s.split('/').last
+    
+    db_config      = YAML.load_file('config/database.yml')
+    @db_host       = db_config['production']['host']
+    @db_database   = db_config['production']['database']
+    @db_username   = db_config['production']['username']
+    @db_password   = db_config['production']['password']
+    
+    mail_config    = ActionMailer::Base.smtp_settings
+    @mail_domain   = mail_config[:address]
+    @mail_username = mail_config[:user_name]
+    @mail_password = mail_config[:password]
+    
+    template 'delayed_job_tracer_config.yml', 'config/delayed_job_tracer_config.yml'
+  end
+  
+end

data/{generators → lib/generators}/delayed_job_tracer/templates/delayed_job_tracer_config.yml

@@ -1,15 +1,15 @@
 # Application's name
 # This will be the prefix of alert e-mail subject lines, which will have brackets
-# added around it.
-# Example:  App Name => [App Name]
-app:
+# added around it. 
+# Example:  App Name => [App Name] 
+app: 
   name: <%= app_name %>
 
-
+  
 # Administrative e-mail address to send alerts to
-admin:
-  email:
-
+admin: 
+  email: 
+  
 
 # Number of seconds after a delayed_job is considered stale.
 # An e-mail will be sent to the admin if records older than this are found
@@ -19,9 +19,9 @@ admin:
 #   3) One or more jobs are taking longer than the number of seconds set here
 #      to complete
 delayed_job:
-  stale: 3600
-
-
+  stale: 3600 
+  
+  
 # Application's production database
 database:
   ip: <%= db_host %>
@@ -49,7 +49,7 @@ monitor:
 # e-mail account and Google puts it on lockdown.
 alert:
   server: smtp.gmail.com
-  username:
-  password:
+  username: 
+  password: 
   port: 25
   tls: true

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delayed_job_tracer
 version: !ruby/object:Gem::Version 
-  hash: 59
-  prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
+  version: 1.0.3
 platform: ruby
 authors: 
 - Kenny Johnston
@@ -15,83 +9,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-13 00:00:00 Z
+date: 2011-02-28 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: delayed_job
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  name: tmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 0
-        - 7
-        version: 2.0.7
-  type: :runtime
-  version_requirements: *id001
+        version: 1.2.7.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: mms2r
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 2
-        - 4
-        - 1
         version: 2.4.1
-  type: :runtime
-  version_requirements: *id002
+    version: 
 - !ruby/object:Gem::Dependency 
-  name: mysql2
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 2
-        - 6
-        version: 0.2.6
-    - - <=
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+  name: mysql
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: tmail
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 81
-        segments: 
-        - 1
-        - 2
-        - 7
-        - 1
-        version: 1.2.7.1
-  type: :runtime
-  version_requirements: *id004
+        version: "2.7"
+    version: 
 description: |-
-  Monitors the delayed_job queue and periodically tests its ability to deliver
-                       e-mail messages and e-mails you if something goes wrong, such as the delayed_job
+  Monitors the delayed_job queue and periodically tests its ability to deliver 
+                       e-mail messages and e-mails you if something goes wrong, such as the delayed_job 
                        process crashes or one of its jobs fails or takes too long to complete.
 email: 
 - kjohnston.ca@gmail.com
@@ -104,19 +57,19 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README.md
+- README.textile
 - Rakefile
 - bin/delayed_job_tracer
 - delayed_job_tracer.gemspec
-- generators/delayed_job_tracer/delayed_job_tracer_generator.rb
-- generators/delayed_job_tracer/templates/delayed_job_tracer_config.yml
 - lib/delayed_job_tracer.rb
 - lib/delayed_job_tracer/delayed_job_tracer_mailer.rb
 - lib/delayed_job_tracer/message_finder.rb
 - lib/delayed_job_tracer/mysql_interface.rb
 - lib/delayed_job_tracer/notifier.rb
 - lib/delayed_job_tracer/version.rb
-- rails/init.rb
+- lib/generators/delayed_job_tracer/delayed_job_tracer_generator.rb
+- lib/generators/delayed_job_tracer/templates/delayed_job_tracer_config.yml
+has_rdoc: true
 homepage: https://github.com/kjohnston/delayed_job_tracer
 licenses: []
 
@@ -126,27 +79,21 @@ 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"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Like a tracer bullet for your delayed_job queue

data/generators/delayed_job_tracer/delayed_job_tracer_generator.rb

@@ -1,25 +0,0 @@
-class DelayedJobTracerGenerator < Rails::Generator::Base
-
-  attr_accessor :app_name, :db_host, :db_database, :db_username, :db_password,
-                :mail_domain, :mail_username, :mail_password
-
-  def manifest
-    @app_name      = Rails.root.to_s.split('/').last
-
-    db_config      = Rails::Configuration.new
-    @db_host       = db_config.database_configuration["production"]["host"]
-    @db_database   = db_config.database_configuration["production"]["database"]
-    @db_username   = db_config.database_configuration["production"]["username"]
-    @db_password   = db_config.database_configuration["production"]["password"]
-
-    mail_config    = ActionMailer::Base.smtp_settings
-    @mail_domain   = mail_config[:address]
-    @mail_username = mail_config[:user_name]
-    @mail_password = mail_config[:password]
-
-    record do |m|
-      m.template 'delayed_job_tracer_config.yml', File.join('config', 'delayed_job_tracer_config.yml')
-    end
-  end
-
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require "delayed_job_tracer"