has_heartbeat 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTU0Y2MwYjBjMWQxNTI0YTRjNjMyZDExZGZhNDk1N2FkMmI4OGUzNw==
+  data.tar.gz: !binary |-
+    OTJhYmViMDE0MzU4ZTMwZGM5MTlkMjM3ZDUzMTZmM2I2MzNlN2ViZg==
+SHA512:
+  metadata.gz: !binary |-
+    YjU4NzZhYzRlZGNhNzg3ZmQ5ZDAzMDU0OTA1NTI4ZmY2OWQ1ZWNkZWJlMzQ5
+    MmEwODk5MTUwNGRmNGY1Y2Y3NDJiMWYwMzY1ZDhkNGY3MDY4ZjY5YWFhNWNl
+    OWJlMTg4YTE2MzIwMGVkYTExZTIzYTdlMGJmZTNjZmVhNDZhMTg=
+  data.tar.gz: !binary |-
+    Y2ZlMzMxODU2ZmNlOGM3MTBmOTBiZThhZmU2YTA0NjQ0OTc5OWNlZTM3ZmRj
+    NDA3OTQ0ZWJiOTExNWY0MjBjZGZkNTE1YzMwZWYzZTZhOWY0ODIyOTAyN2Zm
+    Y2E2M2ZiN2FjYmRmZmQ4MzcwMTIwOTNiYWRiYzBkN2FmMjc0MmE=

data/Gemfile

@@ -9,15 +9,15 @@ source "http://rubygems.org"
 gem "rails", ">= 3.1.0"
 
 # And requires Airbrake notification for some features:
-gem "airbrake", "~> 3.1.4"
+gem "airbrake", "~> 3.1"
 
 
 # Development dependencies:
 group :development do
-  gem "bundler", "~> 1.1.0"
-  gem "jeweler", "~> 1.8.4"
+  gem "bundler", "~> 1"
+  gem "jeweler", "~> 2.0"  # "~> 1.8"
   gem "rdoc", "~> 3.12"
-  gem "rspec", ">= 2.11.0"
+  gem "rspec", "~> 2.11"
   # gem "rspec-rails", ">= 2.11.0"
   # gem "capybara", "~> 1.1.2"
   # gem "combustion", "~> 0.3.2"

data/Gemfile.lock

@@ -28,32 +28,64 @@ GEM
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    addressable (2.3.6)
     airbrake (3.1.4)
       builder
       girl_friday
     arel (3.0.2)
     builder (3.0.3)
     connection_pool (0.9.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.1.3)
     erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
     girl_friday (0.10.0)
       connection_pool (~> 0.9.0)
-    git (1.2.5)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.1.1)
+    highline (1.6.21)
     hike (1.2.1)
     i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
       git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
     journey (1.0.4)
     json (1.7.5)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.19)
-    multi_json (1.3.6)
+    mini_portile (0.5.3)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -77,7 +109,7 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
+    rake (10.3.0)
     rdoc (3.12)
       json (~> 1.4)
     rspec (2.11.0)
@@ -93,6 +125,7 @@ GEM
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     thor (0.16.0)
+    thread_safe (0.3.3)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot
@@ -103,9 +136,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  airbrake (~> 3.1.4)
-  bundler (~> 1.1.0)
-  jeweler (~> 1.8.4)
+  airbrake (~> 3.1)
+  bundler (~> 1)
+  jeweler (~> 2.0)
   rails (>= 3.1.0)
   rdoc (~> 3.12)
-  rspec (>= 2.11.0)
+  rspec (~> 2.11)

data/README.rdoc

@@ -1,7 +1,7 @@
 = HasHeartbeat
 
-Controller with target for heartbeat monitoring with body, HTTP status code, and Airbrake
-issue identification.
+Controller with target for heartbeat monitoring with customizable status body text, HTTP
+status codes, and optional integration with Airbrake notifier.
 
 
 == Install
@@ -18,7 +18,7 @@ on the Airbrake notification gem, which will be added to your dependency set.
 == Usage
 
 By adding the HasHeartbeat gem to your project, your project will have a "/heartbeat" endpoint
-added to your routes. You can add this URL to your heartbeat/monitring service of choice or 
+added to your routes. You can add this URL to your heartbeat/monitoring service of choice or
 strike it directly to verify that your application is alive and well.
 
 The heartbeat action responds with one of two possible responses. In the case of an app's
@@ -26,11 +26,13 @@ successfully beating heart:
 
   HTTP Status:   200 OK
   Response Body: Application Heart Beating OK
+  Logger Output: Application Heart Beating OK
 
 And the case arising from internal issue or error:
 
   HTTP Status:   500 Server Error
   Response Body: 500 Internet Server Error: Application Heart Palpitations
+  Logger Output: 500 Internet Server Error: Application Heart Palpitations
 
 Configure your monitoring service to check against status codes and/or response body text to
 properly triage responses.
@@ -39,25 +41,43 @@ properly triage responses.
 == Options
 
 By default, HasHeartbeat simply responds with success or failure and can be used for up/down
-verification. 
+verification. You can customize its behavior as follows:
 
 === Check Database Up/Down
 
-You can ask the heartbeat action to also check against a model of your database to ensure that
-your database is up and running by adding the following to a file in your config/initializers:
+You can ask the heartbeat to also check that your application is connected to your database.
+To do so, configure like so:
 
+  # config/initializers/heartbeat.rb
   HasHeartbeat.configure do |config|
-    config.check_model = User
+    config.check_db!
   end
 
-Specify any of your ActiveRecord models (in place of User) and the heartbeat will attempt to
-load the first row from the corresponding table when it is struck.
+HasHeartbeat will check against the database by default. You can turn this off, if you really
+don't need it:
 
-=== External Notifications 
+  config.check_db!(false)
 
-Further, if you'd like HasHeartbeat to notify an external service when your application is down
-or experiencing an error, you can ask it to piggy-back off an existing Airbrake configuration
-you are using. To do so, add the following to a config/initializer:
+
+=== Custom Responses
+
+By default, the heartbeat action will render text responses with the HTTP service codes as
+described above. You may wish to customize the success or failure messages or the failure
+status code. To do so, get back into your initializer:
+
+  # config/initializers/heartbeat.rb
+  HasHeartbeat.configure do |config|
+    config.ok_text = "This is my OK output"
+    config.fail_text = "This response text is output on DB connect issues"
+    config.fail_status = 404      # Change from 500 to something more specific
+  end
+
+
+=== External Notifications
+
+Further, if you'd like HasHeartbeat to notify an external service when your application is
+experiencing a database connection error, you can ask it to piggy-back off an existing Airbrake
+configuration you are using. To do so, add the following to a config/initializer:
 
   HasHeartbeat.configure do |config|
     config.use_airbrake!
@@ -78,7 +98,7 @@ If you don't wish to use Airbrake, simply leave out the call to +use_airbrake!+
 
 == Copyright
 
-Copyright 2012 Awexome Labs, LLC 
+Copyright 2014 Awexome Labs, LLC
 http://awexomelabs.com
 http://facebook.com/AwexomeLabs
 http://twitter.com/awexomelabs

data/ROADMAP.rdoc

@@ -1,10 +1,39 @@
 = HasHeartbeat Road Map
 
+== v0.2
+
+Released April 2014.
+
+  * IMPROVEMENT: Check status of database connection instead of querying model table with
+      new configuration check_db!
+  * DEPRECATED: check_model accessors deprecated. Setting a model to query/check against
+      now results in check_db! being set to true. Model name is ignored.
+  * CHANGE: Route changed to GET "heartbeat#beat" and named "heartbeat"
+  * NEW: Customizable success text output to both logs and browser
+  * NEW: Customizable fail text for database check failure to both logs and browser
+  * NEW: Customizable fail HTTP status code for database check failure
+
+Removed configuration methods:
+
+  * check_model=, check_model
+
+Added configuration methods:
+
+  * check_db!
+  * ok_text
+  * fail_text
+  * fail_status
+
 
 == v0.1
 
-Expected release October 2012.
+Released October 2012.
+
+  * Adds heartbeat/index path to Rails project routes
+  * Returns 200 OK with text response with heartbeat
+  * Returns 500 Error with text response without heartbeat
+  * Accepts name of project model to query against to test database connection
+  * Piggybacks off existing app Airbrake notifier configuration if desired
 
-Initial features planned, pulled from previous Awexome Labs client
-project components.
+Initial features planned, pulled from previous Awexome Labs client project components.
 

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "has_heartbeat"
   gem.homepage = "http://github.com/awexome/has_heartbeat"
   gem.license = "MIT"
-  gem.summary = %Q{Simple heartbeat monitoring target for Rails with body, HTTP status code, and Airbrake issue identification.}
-  gem.description = %Q{Simple heartbeat monitoring target for Rails with body, HTTP status code, and Airbrake issue identification.}
+  gem.summary = %Q{Application heartbeat monitor for Rails}
+  gem.description = %Q{Simple heartbeat monitoring target for Rails apps with database connection testing, customizable output, HTTP status code, and Airbrake notification.}
   gem.email = "engineering@awexomelabs.com"
   gem.authors = ["Awexome Labs"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/app/controllers/heartbeat_controller.rb

@@ -6,20 +6,20 @@
 
 class HeartbeatController < ActionController::Base
 
-  def index
+  def beat
     begin
-      if HasHeartbeat.configuration.check_model?
-        Rails.logger.info "Heartbeat checking database against model #{HasHeartbeat.configuration.check_model.to_s}"
-        HasHeartbeat.configuration.check_model.send(:first)
+      if HasHeartbeat.configuration.check_db?
+        Rails.logger.info "HasHeartbeat checking database connection is active."
+        raise Exception.new("HasHeartbeat: Database not connected.") unless ActiveRecord::Base.connected?
       else
-        Rails.logger.info "Heartbeat not checking against database"
+        Rails.logger.debug "HasHeartbeat not checking database connection."
       end
-      Rails.logger.info "Application Heart Beating OK"
-      render :text => "Application Heart Beating OK"
+      Rails.logger.info HasHeartbeat.configuration.ok_text
+      render text: HasHeartbeat.configuration.ok_text
+
     rescue Exception => e
-      Rails.logger.error "Heartbeat Error: #{e.message}"
       if HasHeartbeat.configuration.use_airbrake?
-        Rails.logger.error "Heartbeat notifying Airbrake endpoint."
+        Rails.logger.error "Heartbeat notifying Airbrake endpoint, if configured."
         ::Airbrake.notify(
           :error_class   => "Heartbeat Failure",
           :error_message => "Heartbeat Failure: #{e.message}",
@@ -28,8 +28,10 @@ class HeartbeatController < ActionController::Base
       else
         Rails.logger.error "Heartbeat not notifying Airbrake endpoint."
       end
-      render :text => "500 Internet Server Error: Application Heart Palpitations", :status => 500
+
+      render text: HasHeartbeat.configuration.fail_text, status: HasHeartbeat.configuration.fail_status
     end
+
   end
 
 end

data/config/routes.rb

@@ -1,6 +1,6 @@
 # AWEXOME LABS
 # HasHeartbeat - Routing the check for heartbeat
 
-Rails.application.routes.draw do 
-  get "heartbeat"=>"heartbeat#index"
+Rails.application.routes.draw do
+  get "heartbeat" => "heartbeat#beat", as:"heartbeat"
 end

data/has_heartbeat.gemspec

@@ -2,15 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: has_heartbeat 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "has_heartbeat"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Awexome Labs"]
-  s.date = "2012-10-18"
-  s.description = "Simple heartbeat monitoring target for Rails with body, HTTP status code, and Airbrake issue identification."
+  s.date = "2014-04-17"
+  s.description = "Simple heartbeat monitoring target for Rails apps with database connection testing, customizable output, HTTP status code, and Airbrake notification."
   s.email = "engineering@awexomelabs.com"
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -31,35 +33,34 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/awexome/has_heartbeat"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
-  s.summary = "Simple heartbeat monitoring target for Rails with body, HTTP status code, and Airbrake issue identification."
+  s.rubygems_version = "2.2.2"
+  s.summary = "Application heartbeat monitor for Rails"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.1.0"])
-      s.add_runtime_dependency(%q<airbrake>, ["~> 3.1.4"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_runtime_dependency(%q<airbrake>, ["~> 3.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<rspec>, [">= 2.11.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.11"])
     else
       s.add_dependency(%q<rails>, [">= 3.1.0"])
-      s.add_dependency(%q<airbrake>, ["~> 3.1.4"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<airbrake>, ["~> 3.1"])
+      s.add_dependency(%q<bundler>, ["~> 1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<rspec>, [">= 2.11.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.11"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.1.0"])
-    s.add_dependency(%q<airbrake>, ["~> 3.1.4"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<airbrake>, ["~> 3.1"])
+    s.add_dependency(%q<bundler>, ["~> 1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<rspec>, [">= 2.11.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.11"])
   end
 end
 

data/lib/has_heartbeat/configuration.rb

@@ -6,17 +6,38 @@ module HasHeartbeat
   class Configuration
 
     # Configurable options:
-    attr_accessor :check_model, :use_airbrake
+    attr_accessor :check_db, :ok_text, :fail_text, :fail_status, :use_airbrake
 
     # Declare defaults on load:
     def initialize
-      @check_model = nil
-      @use_airbrake = false
+      @check_db = true        # Can be turned off with check_db!
+      @use_airbrake = false   # Can be turned on with use_airbrake!
+
+      # Default status texts:
+      @ok_text = "Application Heart Beating OK"
+      @fail_text = "500 Internet Server Error: Application Heart Palpitations"
+      @fail_status = 500
+    end
+
+    # Set heartbeat to check that database is connected:
+    def check_db!(on=true)
+      @check_db = on
     end
 
-    # Does the heartbeat check a database model?
-    def check_model?
-      !check_model.nil?
+    # Does this heartbeat check the database connection?
+    def check_db?
+      @check_db == true
+    end
+
+    # Deprecated check_model configuration sets check_db for now:
+    def check_model=(klass)
+      ActiveSupport::Deprecation.warn("HasHeartbeat: check_model method is no longer supported and will be removed in the next version. Use check_db! instead.")
+      @check_model = klass
+      check_db!(true)
+    end
+    def check_model
+      ActiveSupport::Deprecation.warn("HasHeartbeat: check_model method is no longer supported and will be removed in the next version. Use check_db! instead.")
+      @check_model
     end
 
     # Set the configuration to use Airbrake notifier:

metadata

@@ -1,84 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: has_heartbeat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Awexome Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2163367380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2163367380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: airbrake
-  requirement: &2163366680 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2163366680
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2163365520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1'
   type: :development
   prerelease: false
-  version_requirements: *2163365520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2163364880 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2163364880
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2163364240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2163364240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2163363640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *2163363640
-description: Simple heartbeat monitoring target for Rails with body, HTTP status code,
-  and Airbrake issue identification.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: Simple heartbeat monitoring target for Rails apps with database connection
+  testing, customizable output, HTTP status code, and Airbrake notification.
 email: engineering@awexomelabs.com
 executables: []
 extensions: []
@@ -100,30 +117,25 @@ files:
 homepage: http://github.com/awexome/has_heartbeat
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4172046866987938193
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Simple heartbeat monitoring target for Rails with body, HTTP status code,
-  and Airbrake issue identification.
+specification_version: 4
+summary: Application heartbeat monitor for Rails
 test_files: []