status_cat 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4d7e541b0764d848791a7a4b5d56e20de702db5
+  data.tar.gz: d072d488b05aa95fb5c2de5b6f166e81c169418d
+SHA512:
+  metadata.gz: 8db8481cfa3edcd43bfb3b369a6ae5a63f2d0201f99d95ceca48ef129a57bbd7d96f946ab2343dde8b8da7b8ee71d918c1dc2a883a8658cf34fc88cb59ffac71
+  data.tar.gz: 4bc2df86a682d5c0e1ad4567c269878345f4bffb9657c5552e33ce2da9779ca3c35c8045073c4d0e1c874c24995a6377f8f3d19e8b65158bab5679053ab381b4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 SchrodingersBox.com
+
+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,161 @@
+# schrodingersbox/status_cat README
+
+This engine makes monitoring the status of your Rails environment easier.
+
+It provides a Rails action with a green light / red light list of configured services,
+such as:
+
+ * ActionMailer
+ * ActiveRecord
+ * AWS S3
+ * Delayed Job
+ * Stripe
+
+## Getting Started
+
+1. Add this to your `Gemfile` and `bundle install`
+
+		gem 'status_cat', :git => 'https://github.com/schrodingersbox/status_cat.git'
+
+2. Add this to your `config/routes.rb`
+
+		mount StatusCat::Engine => '/status_cat'
+
+3. Restart your Rails server
+
+4. Run `rake status_cat:check` for a text status report
+
+5.  Visit http://yourapp/status_cat in a browser for an HTML status report
+
+## Configuration
+
+  All configuration should go in `config/initializers/status_cat.rb`.
+
+      Status.configure do |config|
+
+          config.authenticate_with do
+            authenticate!
+          end
+
+          config.authorize_with do
+            authorize!
+          end
+
+          config.layout = 'admin'
+
+          config.noreply = 'noreply@schrodingersbox.com'
+          config.to = 'ops@schrodingersbox.com'
+          config.from = 'ops@schrodingersbox.com'
+          config.subject = "#{Rails.env.upcase} StatusCat Failure"
+
+      end
+
+## How To
+
+### Configure Enabled Checkers
+
+By default, all subclasses of StatusCat::Checkers::Base will be run.  Do the following if you would like to limit or reorder the set of checkers
+
+Create or add to `config/initializers/status_cat.rb`
+
+    StatusCat.configure do |config|
+      config.enabled = [ :action_mailer, :active_record ]
+    end
+
+### Configure Email Settings
+
+Create or add to `config/initializers/status_cat.rb`
+
+    StatusCat.configure do |config|
+      config.noreply = 'noreply@schrodingersbox.com'
+      config.to = 'ops@schrodingersbox.com'
+      config.from = 'ops@schrodingersbox.com'
+      config.subject = "#{Rails.env.upcase} StatusCat Failure"
+    end
+
+### Run Status Checks From A Cron
+
+1. Run `rake status_cat:cron` from a cron job or other scheduling system.
+
+PLEASE NOTE: The :action_mailer checker will attempt to send a test email to your `StatusCat.config.noreply` email address.  This could cause unwanted spam or incur charges if you're using a metered mail transfer agent, like SendGrid.
+
+### Add New Checkers
+
+You can place new checkers anywhere you like, but `app/checkers` is the recommended location.
+
+1.  Add the following to `config/application.rb`
+
+    	Dir[Rails.root + 'app/checkers/**/*.rb'].each { |path| require path }
+
+2.  Create a new subclass of `StatusCat::Checkers::Base` that sets `@value` and `@status` instance variables.
+
+	    module StatusCat
+	      module Checkers
+	        class Dummy < Base
+	          def initialize
+	            @value = 'dummy'
+	            @status = 'fail'
+	          end
+	        end
+	      end
+	    end
+
+### Require authentication
+
+Create or add to `config/initializers/status_cat.rb`
+
+    StatusCat.configure do |config|
+      config.authenticate_with do
+        warden.authenticate! scope: :user
+      end
+    end
+
+### Require authorization
+
+Create or add to `config/initializers/status_cat.rb`
+
+    StatusCat.configure do |config|
+      config.authorize_with do
+        redirect_to main_app.root_path unless current_user.try(:admin?)
+      end
+    end
+
+### Apply a custom layout
+
+Create or add to `config/initializers/status_cat.rb`
+
+    StatusCat.configure do |config|
+      config.layout = 'admin'
+    end
+
+## Reference
+
+ * [Getting Started with Engines](http://edgeguides.rubyonrails.org/engines.html)
+ * [Testing Rails Engines With Rspec](http://whilefalse.net/2012/01/25/testing-rails-engines-rspec/)
+ * [How do I write a Rails 3.1 engine controller test in rspec?](http://stackoverflow.com/questions/5200654/how-do-i-write-a-rails-3-1-engine-controller-test-in-rspec)
+ * [Best practice for specifying dependencies that cannot be put in gemspec?](https://groups.google.com/forum/?fromgroups=#!topic/ruby-bundler/U7FMRAl3nJE)
+ * [Clarifying the Roles of the .gemspec and Gemfile](http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/)
+ * [The Semi-Isolated Rails Engine](http://bibwild.wordpress.com/2012/05/10/the-semi-isolated-rails-engine/)
+ * [config.reload_plugins = true only works in environment.rb](https://rails.lighthouseapp.com/projects/8994/tickets/2324-configreload_plugins-true-only-works-in-environmentrb?spam=1)
+ * [describe vs. context in rspec](http://lmws.net/describe-vs-context-in-rspec)
+ * [Add Achievement Badges to Your Gem README](http://elgalu.github.io/2013/add-achievement-badges-to-your-gem-readme/)
+ * [Publishing your gem](http://guides.rubygems.org/publishing/)
+
+## History
+
+Version 0.0.2 = Rails 3 compatible
+Version 0.0.3 = Rails 4 compatible
+
+## TODO
+
+* Add disk space checker with externally configurable limit
+* Add Zencoder checker?
+* Add NewRelic checker?
+
+* Dynamically create rake tasks for each checker
+
+* Doc
+  * General checker concept
+  * Shared spec
+
+* Publish as gem

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StatusCat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+load 'tasks/spec_cat.rake'

data/app/assets/javascripts/status-cat/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/status-cat/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/status_cat/status_controller.rb

@@ -0,0 +1,26 @@
+class StatusCat::StatusController < ApplicationController
+
+  layout :set_layout
+
+  before_filter :_authenticate!
+  before_filter :_authorize!
+
+  def index
+    @checkers = StatusCat::Status.all
+  end
+
+private
+
+  def set_layout
+    return StatusCat.config.layout
+  end
+
+  def _authenticate!
+    instance_eval( &StatusCat.config.authenticate_with )
+  end
+
+  def _authorize!
+    instance_eval( &StatusCat.config.authorize_with )
+  end
+
+end

data/app/helpers/status_cat/status_helper.rb

@@ -0,0 +1,105 @@
+module StatusCat::StatusHelper
+
+  # Constructs an HTML table header
+
+  def status_header
+    content_tag( :tr ) do
+      concat content_tag( :th, t( :name, :scope => :status_cat ) )
+      concat content_tag( :th, t( :value, :scope => :status_cat ) )
+      concat content_tag( :th, t( :status, :scope => :status_cat ) )
+    end
+  end
+
+  # Constructs an HTML table row
+
+  def status_row( checker )
+    content_tag( :tr ) do
+      concat content_tag( :td, checker.name, :style => status_style( checker ) )
+      concat content_tag( :td, checker.value )
+      concat status_cell(checker.status || t( :ok, :scope => :status_cat ))
+    end
+  end
+
+  def status_cell( status )
+    if status.kind_of?(Array)
+      return content_tag( :td ) do
+        content_tag( :table ) do
+          rows = nil
+          status.each do |s|
+            row = content_tag( :tr ) do
+              content_tag( :td, s )
+            end
+
+            if rows == nil
+              rows = row
+            else
+              rows += row
+            end
+          end
+          rows
+        end
+      end
+    end
+
+    return content_tag( :td, status )
+  end
+
+  # Returns an HTML style for the status table cell
+
+  def status_style( checker )
+    "background-color: #{checker.status.nil? ? :green : :red}"
+  end
+
+  # Returns an HTML table
+
+  def status_table( checkers )
+    content_tag( :table, :border => 1 ) do
+      concat status_header
+      checkers.each { |checker| concat status_row( checker ) }
+    end
+  end
+
+  # Returns an HTML title
+
+  def status_title
+    content_tag( :h1, t( :h1, :scope => :status_cat ) )
+  end
+
+  # Constructs a text status report
+
+  def status_report( checkers )
+    format, format_length = status_report_format( checkers )
+    header = status_report_header( format )
+    length = [ format_length, header.length ].max
+    separator = ( '-' * length ) + "\n"
+
+    result = separator + header + separator
+    checkers.each { |checker| result << checker.to_s( format ) }
+    result << separator
+
+    return result
+  end
+
+  # Generate a format string to justify all values
+
+  def status_report_format( checkers )
+    name_max = checkers.map { |c| c.name.to_s.length }.max
+    value_max = checkers.map { |c| c.value.to_s.length }.max
+    status_max = checkers.map { |c| c.status.to_s.length }.max
+
+    format = "%#{name_max}s | %#{value_max}s | %#{status_max}s\n"
+    length = name_max + 3 +  value_max + 3 + status_max
+
+    return format, length
+  end
+
+  # Generate a header string
+
+  def status_report_header( format = StatusCat::Checkers::Base::FORMAT )
+    name = I18n.t( :name, :scope => :status_cat )
+    value = I18n.t( :value, :scope => :status_cat )
+    status = I18n.t( :status, :scope => :status_cat )
+    return sprintf( format, name, value, status )
+  end
+
+end

data/app/mailers/status_cat/status_mailer.rb

@@ -0,0 +1,12 @@
+class StatusCat::StatusMailer <  ActionMailer::Base
+
+  add_template_helper( StatusCat::StatusHelper )
+
+  def failure( checkers )
+    @checkers = checkers
+
+    config = StatusCat.config
+    mail( :to => config.to, :from => config.from, :subject => config.subject )
+  end
+
+end

data/app/views/status_cat/status/index.html.erb

@@ -0,0 +1,4 @@
+<div class="status_cat">
+  <%= status_title %>
+  <%= status_table( @checkers ) %>
+</div>

data/app/views/status_cat/status_mailer/failure.html.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  </head>
+  <body>
+    <%= status_table( @checkers ) %>
+  </body>
+</html>

data/app/views/status_cat/status_mailer/failure.text.erb

@@ -0,0 +1 @@
+<%= status_report( @checkers ) %>

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  status_cat:
+    h1: Status Report
+    name: Name
+    value: Value
+    status: Status
+    ok: OK

data/config/routes.rb

@@ -0,0 +1,4 @@
+StatusCat::Engine.routes.draw do
+  root :to => 'status#index'
+  get '/status' =>  'status#index'
+end

data/lib/status_cat/checkers/action_mailer.rb

@@ -0,0 +1,31 @@
+module StatusCat
+  module Checkers
+    class ActionMailer < Base
+
+      def initialize
+        @value = "#{config[ :address ]}:#{config[ :port ]}"
+
+        unless  ::ActionMailer::Base.delivery_method == :test
+          @status = fail_on_exception do
+            address        = config[ :address ]
+            port           = config[ :port ]
+            domain         = config[ :domain ]
+            user_name      = config[ :user_name ]
+            password       = config[ :password ]
+            authentication = config[ :authentication ]
+
+            Net::SMTP.start( address, port, domain, user_name, password, authentication ) do |smtp|
+              smtp.send_message( '', StatusCat.config.from, StatusCat.config.noreply )
+            end
+            nil
+          end
+        end
+      end
+
+      def config
+        @config ||= ::ActionMailer::Base.smtp_settings
+      end
+
+    end
+  end
+end

data/lib/status_cat/checkers/active_record.rb

@@ -0,0 +1,24 @@
+module StatusCat
+  module Checkers
+    class ActiveRecord < Base
+
+      def initialize
+        @value = "#{config[ :adapter ]}:#{config[ :username ]}@#{config[ :database ]}"
+
+        @status = fail_on_exception do
+          ::ActiveRecord::Base.connection.execute( "select max(version) from schema_migrations" )
+          nil
+        end
+      end
+
+      def config
+        unless @config
+          yaml =  YAML::load( ERB.new( IO.read( File.join( Rails.root, 'config', 'database.yml' ) ) ).result )
+          @config = yaml[ Rails.env ].symbolize_keys!
+        end
+        return @config
+      end
+
+    end
+  end
+end

data/lib/status_cat/checkers/base.rb

@@ -0,0 +1,36 @@
+module StatusCat
+  module Checkers
+    class Base
+      extend ActiveSupport::DescendantsTracker
+
+      FORMAT = "%s | %s | %s\n"
+
+      attr_reader :value, :status
+
+      def self.class_to_name( klass )
+        klass.to_s.split( '::' ).last.underscore.to_sym
+      end
+
+      def name
+        Base.class_to_name( self.class )
+        #self.class.to_s.split( '::' ).last.underscore.to_sym
+      end
+
+      def to_s( format = FORMAT )
+        sprintf( format, name, value, status || I18n.t( :ok, :scope => :status_cat ) )
+      end
+
+    protected
+
+      def fail_on_exception
+        begin
+          return yield
+        rescue Exception => e
+          return e
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/lib/status_cat/checkers/delayed_job.rb

@@ -0,0 +1,28 @@
+module StatusCat
+  module Checkers
+
+    class DelayedJob < Base
+      include ActionView::Helpers::DateHelper
+
+      def initialize
+        if !defined?( ::Delayed )
+          @status = 'delayed_job gem not installed'
+        else
+          @status = fail_on_exception do
+            sql = 'select count(*) from delayed_jobs'
+            result = ::ActiveRecord::Base.connection.execute( sql ).first
+            @value = result.is_a?( Hash ) ? result[ 'count' ] : result[ 0 ]
+
+            expires = 1.day.ago
+            sql = "select count(*) from delayed_jobs where created_at < '#{expires.to_s( :db )}'"
+            result = ::ActiveRecord::Base.connection.execute( sql ).first
+            value = result.is_a?( Hash ) ? result[ 'count' ] : result[ 0 ]
+
+            ( value.to_i == 0 ) ? nil : "#{value} jobs more than #{time_ago_in_words( expires )} old"
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/status_cat/checkers/s3.rb

@@ -0,0 +1,17 @@
+module StatusCat
+  module Checkers
+    class S3 < Base
+      def initialize
+        if !defined?( ::AWS )
+          @status = 'aws-sdk gem not installed'
+        else
+          @value = AWS.config.access_key_id
+          @status = fail_on_exception do
+            s3 = AWS::S3.new
+            ( s3.buckets.count > 0 ) ? nil : 'no buckets'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/status_cat/checkers/stripe.rb

@@ -0,0 +1,19 @@
+module StatusCat
+  module Checkers
+
+    class Stripe < Base
+      def initialize
+        if !defined?( ::Stripe )
+          @status = 'stripe gem not installed'
+        else
+          @status = fail_on_exception do
+            account = ::Stripe::Account.retrieve()
+            @value = account.email
+            account.charge_enabled ? nil : 'Charge is not enabled'
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/status_cat/config.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module StatusCat
+
+  class Config
+    include Singleton
+
+    NIL_PROC = proc {}
+
+    attr_accessor :enabled
+    attr_accessor :authenticate, :authorize
+    attr_accessor :from, :to, :subject, :noreply
+    attr_accessor :layout
+
+    def initialize
+      @enabled = StatusCat::Checkers::Base.descendants.map { |klass|
+        StatusCat::Checkers::Base.class_to_name( klass )
+      }.sort
+    end
+
+    def authenticate_with(&blk)
+      @authenticate = blk if blk
+      @authenticate || NIL_PROC
+    end
+
+    def authorize_with(&block)
+      @authorize = block if block
+      @authorize || NIL_PROC
+    end
+
+  end
+
+end

data/lib/status_cat/engine.rb

@@ -0,0 +1,5 @@
+module StatusCat
+  class Engine < ::Rails::Engine
+    isolate_namespace StatusCat
+  end
+end

data/lib/status_cat/status.rb

@@ -0,0 +1,37 @@
+module StatusCat
+
+  class Status
+
+    # Returns an array of instances of StatusCat::Checkers::Base subclasses
+    def self.all
+      StatusCat::Config.instance.enabled.map { |name| factory( name ) }
+    end
+
+    # By default, returns all checkers
+    # If given a list of checker names, returns an array of those checkers
+    # If given a single checker name, just returns that checker
+    def self.check( which = :all )
+      return all if which == :all
+      return factory( which ) unless which.is_a?( Array )
+      return which.map { |name| factory( name ) }
+    end
+
+    # Emails ::failed list if it is not empty
+    def self.cron
+      checkers = self.failed
+      StatusCat::StatusMailer.failure( checkers ).deliver unless checkers.empty?
+    end
+
+    # Constructs a checker instance given it's name
+    def self.factory( name )
+      ( 'StatusCat::Checkers::' + name.to_s.classify ).constantize.new
+    end
+
+    # Returns an array of failed instances of ::all
+    def self.failed
+      self.all.map { |checker| checker.status.nil? ? nil : checker }.compact
+    end
+
+  end
+
+end

data/lib/status_cat/version.rb

@@ -0,0 +1,3 @@
+module StatusCat
+  VERSION = '0.0.8'
+end