status_cat 0.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ac65c223e10fd528530d66c77a8c4faa08c766f
-  data.tar.gz: 1140f72ea64a6300ccff6d24587f911d98ea13f8
+  metadata.gz: c1f24af8d2c53c9ce0f534ab8fd91cc6f56a8c1b
+  data.tar.gz: 68cfac7ad65fc2fb391384f8ee9b2094e682492f
 SHA512:
-  metadata.gz: 54b688cdeb93d39a70dd877ec14adeebb209ebed46e6f20bc5cbdcdaa3bfb437afb02e7da42cfd64107c62d1632f3978a4c0a2dba28d02bc7f28ad71cab5c93e
-  data.tar.gz: 1be6f957bfb9bf1bbb707920c501c89230ef0e15e105b53a396a21483522de10a7b61307508a87c065d9b90780bb10f4323df9988326adbe9bb6f919c3571d8f
+  metadata.gz: 8733e4562489e67b2cf667226b2dc42de2c1ffee7b75d5d470f9872081d17ce721cfd482b901869466ca112429fc9c8feea378026dea561103df700cd8dcc88d
+  data.tar.gz: b073af12cb9fbd987830e20409f50c6ec950924e394b1fd42b872bd60ba4eb295c5ed40eca1669205595226d724876dd0d68cd005b4e7668b961efd15b0666d0

data/README.md

@@ -40,7 +40,7 @@ such as:
 
 ## Configuration
 
-  All configuration should go in `config/initializers/status_cat.rb`.
+  General configuration should go in `config/initializers/status_cat.rb`.
 
       Status.configure do |config|
 
@@ -61,6 +61,14 @@ such as:
 
         config.enabled = [ :action_mailer, :active_record ]
       end
+      
+  Checker specific configuration should in the initializer it relates to, 
+  so it will be kept in sync.  i.e. `config/initializers/twilio.rb`
+  
+      Twilio.configure do |config|
+        config.account_sid = StatusCat::Checkers::Twilio.sid = ENV['TWILIO_SID']
+        config.auth_token = StatusCat::Checkers::Twilio.auth_token = ENV['TWILIO_AUTH_TOKEN']
+      end      
 
 ## How To
 
@@ -139,6 +147,11 @@ Create or add to `config/initializers/status_cat.rb`
     StatusCat.configure do |config|
       config.layout = 'admin'
     end
+    
+### Get Started Developing
+
+1.  `cp spec/dummy/config/passwords.yml.sample spec/dummy/config/passwords.yml`    
+2.  `rake app:db:create app:db:migrate app:db:test:prepare`
 
 ## Reference
 
@@ -157,16 +170,7 @@ Create or add to `config/initializers/status_cat.rb`
 
  * Version 0.0.2 = Rails 3 compatible
  * Version 0.0.3 = Rails 4 compatible
+ * Version 5.0.0 = Rails 5 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
-   * Env vars to configure services

data/app/controllers/status_cat/status_controller.rb

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

data/app/helpers/status_cat/status_helper.rb

@@ -1,90 +1,95 @@
-module StatusCat::StatusHelper
+module StatusCat
+  module StatusHelper
 
-  # Constructs an HTML table header
+    # 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 ) )
+    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
-  end
 
-  # Constructs an HTML table row
+    # 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 ))
+    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
-  end
 
-  def status_cell( status )
-    if status.kind_of?(Array)
-      list = status.map { |s| content_tag( :li, s ) }
-      status = content_tag( :ul, list.join.html_safe )
-    end
+    def status_cell(status)
+      if status.is_a?(Array)
+        list = status.map { |s| content_tag(:li, s) }
+        status = content_tag(:ul, list.join.html_safe)
+      end
 
-    return content_tag( :td, status )
-  end
+      return content_tag(:td, status)
+    end
 
-  # Returns an HTML style for the status table cell
+    # Returns an HTML style for the status table cell
 
-  def status_style( checker )
-    "background-color: #{checker.status.nil? ? :green : :red}"
-  end
+    def status_style(checker)
+      "background-color: #{checker.status.nil? ? :green : :red}"
+    end
 
-  # Returns an HTML table
+    # Returns an HTML table
 
-  def status_table( checkers )
-    content_tag( :table, :border => 1 ) do
-      concat status_header
-      checkers.each { |checker| concat status_row( checker ) }
+    def status_table(checkers)
+      content_tag(:table, border: 1) do
+        concat status_header
+        checkers.each { |checker| concat status_row(checker) }
+      end
     end
-  end
 
-  # Returns an HTML title
+    # Returns an HTML title
 
-  def status_title
-    content_tag( :h1, t( :h1, :scope => :status_cat ) )
-  end
+    def status_title
+      content_tag(:h1, t(:h1, scope: :status_cat))
+    end
 
-  # Constructs a text status report
+    # 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"
+    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
+      result = separator + header + separator
+      checkers.each { |checker| result << checker.to_s(format) }
+      result << separator
 
-    return result
-  end
+      return result
+    end
 
-  # Generate a format string to justify all values
+    # 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
+    def status_report_format(checkers)
+      name_max = status_report_format_max_length(checkers, :name)
+      value_max = status_report_format_max_length(checkers, :value)
+      status_max = status_report_format_max_length(checkers, :status)
 
-    format = "%#{name_max}s | %#{value_max}s | %#{status_max}s\n"
-    length = name_max + 3 +  value_max + 3 + status_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
+      return format, length
+    end
 
-  # Generate a header string
+    def status_report_format_max_length(checkers, column)
+      return checkers.map { |c| c.send(column).to_s.length }.max
+    end
 
-  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
+    # Generate a header string
 
-end
+    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 format(format, name, value, status)
+    end
+  end
+end

data/app/mailers/status_cat/status_mailer.rb

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

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

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

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

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

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

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

data/lib/status_cat.rb

@@ -23,4 +23,4 @@ module StatusCat
     yield config
   end
 
-end
+end

data/lib/status_cat/checkers/action_mailer.rb

@@ -3,29 +3,45 @@ module StatusCat
     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
+        @value = "#{address}:#{port}"
+        return if ::ActionMailer::Base.delivery_method == :test
+        @status = fail_on_exception { test }
+      end
+
+      def test
+        Net::SMTP.start(address, port, domain, user_name, password, authentication) do |smtp|
+          smtp.helo(domain)
         end
+        return nil
       end
 
       def config
         @config ||= ::ActionMailer::Base.smtp_settings
       end
 
+      def address
+        return config[:address]
+      end
+
+      def authentication
+        return config[:authentication]
+      end
+
+      def domain
+        return config[:domain]
+      end
+
+      def password
+        return config[:password]
+      end
+
+      def port
+        return config[:port]
+      end
+
+      def user_name
+        return config[:user_name]
+      end
     end
   end
-end
+end

data/lib/status_cat/checkers/active_record.rb

@@ -3,15 +3,30 @@ module StatusCat
     class ActiveRecord < Base
 
       def initialize
-        config = ::ActiveRecord::Base.connection_config
-        @value = "#{config[ :adapter ]}:#{config[ :username ]}@#{config[ :database ]}"
+        @value = "#{adapter}:#{username}@#{database}"
+        @status = fail_on_exception { test }
+      end
+
+      def test
+        ::ActiveRecord::Base.connection.execute('select max(version) from schema_migrations')
+        return nil
+      end
+
+      def config
+        return ::ActiveRecord::Base.connection_config
+      end
+
+      def adapter
+        return config[:adapter]
+      end
 
-        @status = fail_on_exception do
-          ::ActiveRecord::Base.connection.execute( "select max(version) from schema_migrations" )
-          nil
-        end
+      def database
+        return config[:database]
       end
 
+      def username
+        return config[:username]
+      end
     end
   end
-end
+end

data/lib/status_cat/checkers/base.rb

@@ -3,34 +3,41 @@ module StatusCat
     class Base
       extend ActiveSupport::DescendantsTracker
 
-      FORMAT = "%s | %s | %s\n"
+      FORMAT = "%s | %s | %s\n".freeze
 
       attr_reader :value, :status
 
-      def self.class_to_name( klass )
-        klass.to_s.split( '::' ).last.underscore.to_sym
+      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
+        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 ) )
+      def to_s(format = FORMAT)
+        format(format, name, value, status || I18n.t(:ok, scope: :status_cat))
       end
 
-    protected
+      protected
 
+      # rubocop:disable Lint/RescueException
       def fail_on_exception
         begin
           return yield
         rescue Exception => e
           return e
         end
-
         return nil
       end
+
+      def gem_missing?(gem, present)
+        return false if present
+
+        @status = "#{gem} gem is not installed"
+        return true
+      end
     end
   end
 end