has_heartbeat 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+= HasHeartbeat Change Log
+
+This document details notable changes between versions in the gem.
+
+=== v0.1 (this version)
+
+* Initial gem build
+* HeartbeatController with index action
+* Database model search test
+* HTTP Status Code appropriate response (200, 500)
+* Airbrake notification for heartbeat failures
+

data/Gemfile

@@ -0,0 +1,24 @@
+# AWEXOME LABS
+# HasHeartbeat -- Gem dependencies
+
+source "http://rubygems.org"
+
+# Runtime dependencies:
+
+# This gem adds functionality to Rails applications:
+gem "rails", ">= 3.1.0"
+
+# And requires Airbrake notification for some features:
+gem "airbrake", "~> 3.1.4"
+
+
+# Development dependencies:
+group :development do
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "rdoc", "~> 3.12"
+  gem "rspec", ">= 2.11.0"
+  # gem "rspec-rails", ">= 2.11.0"
+  # gem "capybara", "~> 1.1.2"
+  # gem "combustion", "~> 0.3.2"
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    airbrake (3.1.4)
+      builder
+      girl_friday
+    arel (3.0.2)
+    builder (3.0.3)
+    connection_pool (0.9.2)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    girl_friday (0.10.0)
+      connection_pool (~> 0.9.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.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)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  airbrake (~> 3.1.4)
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rails (>= 3.1.0)
+  rdoc (~> 3.12)
+  rspec (>= 2.11.0)

data/README.rdoc

@@ -0,0 +1,85 @@
+= HasHeartbeat
+
+Controller with target for heartbeat monitoring with body, HTTP status code, and Airbrake
+issue identification.
+
+
+== Install
+
+HasHeartbeat is intended for use in Rails applications. To add a heartbeat endpoint to your
+application, add HasHeartbeat to your Gemfile:
+
+  gem "has_heartbeat"
+
+The gem has dependencies on versions of Rails from 3.1 and upward, as well as a dependency
+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 
+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
+successfully beating heart:
+
+  HTTP Status:   200 OK
+  Response Body: 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
+
+Configure your monitoring service to check against status codes and/or response body text to
+properly triage responses.
+
+
+== Options
+
+By default, HasHeartbeat simply responds with success or failure and can be used for up/down
+verification. 
+
+=== 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:
+
+  HasHeartbeat.configure do |config|
+    config.check_model = User
+  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.
+
+=== External Notifications 
+
+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:
+
+  HasHeartbeat.configure do |config|
+    config.use_airbrake!
+  end
+
+By specifying +use_airbrake!+, HasHeartbeat will use any existing Airbrake configuration and send
+a notification to your Airbrake service in the following form:
+
+  {
+    :error_class   => "Heartbeat Failure",                    # <= Generic title
+    :error_message => "Heartbeat Failure: #{e.message}",      # <= Raised error message
+    :parameters    => params                                  # <= Request parameters
+  }
+
+If you don't wish to use Airbrake, simply leave out the call to +use_airbrake!+ and all is well.
+
+
+
+== Copyright
+
+Copyright 2012 Awexome Labs, LLC 
+http://awexomelabs.com
+http://facebook.com/AwexomeLabs
+http://twitter.com/awexomelabs
+

data/ROADMAP.rdoc

@@ -0,0 +1,10 @@
+= HasHeartbeat Road Map
+
+
+== v0.1
+
+Expected release October 2012.
+
+Initial features planned, pulled from previous Awexome Labs client
+project components.
+

data/Rakefile

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "rake"
+
+require "jeweler"
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  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.email = "engineering@awexomelabs.com"
+  gem.authors = ["Awexome Labs"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+# require "rake/testtask"
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << "lib" << "test"
+#   test.pattern = "test/**/test_*.rb"
+#   test.verbose = true
+# end
+
+# require "rcov/rcovtask"
+# Rcov::RcovTask.new do |test|
+#   test.libs << "test"
+#   test.pattern = "test/**/test_*.rb"
+#   test.verbose = true
+#   test.rcov_opts << "--exclude "gems/*""
+# end
+
+# task :default => :test
+
+require "rdoc/task"
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "DoesKeyValue #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/heartbeat_controller.rb

@@ -0,0 +1,37 @@
+# AWEXOME LABS
+# HeartbeatController
+#
+# Useful endpoints for ping and availability services.
+#
+
+class HeartbeatController < ActionController::Base
+
+  def index
+    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)
+      else
+        Rails.logger.info "Heartbeat not checking against database"
+      end
+      raise Exception.new("Funky error occurred in your systemz")
+      Rails.logger.info "Application Heart Beating OK"
+      render :text => "Application Heart Beating OK"
+    rescue Exception => e
+      Rails.logger.error "Heartbeat Error: #{e.message}"
+      if HasHeartbeat.configuration.use_airbrake?
+        Rails.logger.error "Heartbeat notifying Airbrake endpoint."
+        ::Airbrake.notify(
+          :error_class   => "Heartbeat Failure",
+          :error_message => "Heartbeat Failure: #{e.message}",
+          :parameters    => params
+        )
+      else
+        Rails.logger.error "Heartbeat not notifying Airbrake endpoint."
+      end
+      render :text => "500 Internet Server Error: Application Heart Palpitations", :status => 500
+    end
+  end
+
+end
+

data/config/routes.rb

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

data/has_heartbeat.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "has_heartbeat"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  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.email = "engineering@awexomelabs.com"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG.rdoc",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.rdoc",
+    "ROADMAP.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/heartbeat_controller.rb",
+    "config/routes.rb",
+    "has_heartbeat.gemspec",
+    "lib/has_heartbeat.rb",
+    "lib/has_heartbeat/configuration.rb"
+  ]
+  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."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rspec>, [">= 2.11.0"])
+    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<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rspec>, [">= 2.11.0"])
+    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<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rspec>, [">= 2.11.0"])
+  end
+end
+

data/lib/has_heartbeat/configuration.rb

@@ -0,0 +1,48 @@
+# AWEXOME LABS
+# HasHeartbeat : Configuration
+
+module HasHeartbeat
+
+  class Configuration
+
+    # Configurable options:
+    attr_accessor :check_model, :use_airbrake
+
+    # Declare defaults on load:
+    def initialize
+      @check_model = nil
+      @use_airbrake = false
+    end
+
+    # Does the heartbeat check a database model?
+    def check_model?
+      !check_model.nil?
+    end
+
+    # Set the configuration to use Airbrake notifier:
+    def use_airbrake!
+      @use_airbrake = true
+    end
+
+    # Does this heartbeat check use Airbrake notifier?
+    def use_airbrake?
+      @use_airbrake == true
+    end
+
+  end # Configuration
+
+
+  # Provide an accessor to the gem configuration:
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Yield the configuration to host:
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  HasHeartbeat.configuration = Configuration.new
+
+end # HasHeartbeat

data/lib/has_heartbeat.rb

@@ -0,0 +1,23 @@
+# AWEXOME LABS
+# HasHeartbeat
+
+require "has_heartbeat"
+require "rails"
+require "action_controller"
+require "airbrake"
+
+require "has_heartbeat/configuration"
+
+module HasHeartbeat
+
+  # Add features to Rails as an Engine:
+  class Engine < Rails::Engine
+  end
+  
+  # Return the current version of the gem:
+  def self.version
+    Gem.loaded_specs["doesopengraph"].version.to_s
+  end
+  
+end # HasHeartbeat
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: has_heartbeat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Awexome Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2155755940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155755940
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: &2155755420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155755420
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2155754820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *2155754820
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2155754300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2155754300
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2155753700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2155753700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2155753100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *2155753100
+description: Simple heartbeat monitoring target for Rails with body, HTTP status code,
+  and Airbrake issue identification.
+email: engineering@awexomelabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- ROADMAP.rdoc
+- Rakefile
+- VERSION
+- app/controllers/heartbeat_controller.rb
+- config/routes.rb
+- has_heartbeat.gemspec
+- lib/has_heartbeat.rb
+- lib/has_heartbeat/configuration.rb
+homepage: http://github.com/awexome/has_heartbeat
+licenses:
+- MIT
+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: 4356699598253285327
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Simple heartbeat monitoring target for Rails with body, HTTP status code,
+  and Airbrake issue identification.
+test_files: []