ops 0.0.1

data/examples/rails3/spec/functional/ops_routes_spec.rb

@@ -0,0 +1,63 @@
+require 'rspec'
+require 'rack/test'
+require 'spec_helper'
+require 'json'
+
+RSpec::Matchers.define :have_content_type do |content_type|
+  CONTENT_HEADER_MATCHER = /^([A-Za-z]+\/[\w\-+\.]+)(;charset=(.*))?/
+
+  chain :with_charset do |charset|
+    @charset = charset
+  end
+
+  match do |response|
+    _, content, _, charset = *content_type_header.match(CONTENT_HEADER_MATCHER).to_a
+
+    if @charset
+      @charset == charset && content == content_type
+    else
+      content == content_type
+    end
+  end
+
+  failure_message_for_should do |response|
+    if @charset
+      "Content type #{content_type_header.inspect} should match #{content_type.inspect} with charset #{@charset}"
+    else
+      "Content type #{content_type_header.inspect} should match #{content_type.inspect}"
+    end
+  end
+
+  failure_message_for_should_not do |model|
+    if @charset
+      "Content type #{content_type_header.inspect} should not match #{content_type.inspect} with charset #{@charset}"
+    else
+      "Content type #{content_type_header.inspect} should not match #{content_type.inspect}"
+    end
+  end
+
+  def content_type_header
+    last_response.headers['Content-Type']
+  end
+end
+
+describe 'routes', :type => :controller do
+  include Rack::Test::Methods
+
+  it 'renders a version page' do
+    get "/ops/version"
+    last_response.should be_ok
+  end
+
+  it 'renders a json version page' do
+    get "/ops/version.json"
+    last_response.should be_ok
+    last_response.should have_content_type('application/json').with_charset('utf-8')
+  end
+
+  it 'renders a heartbeat page' do
+    get "/ops/heartbeat"
+    last_response.should be_ok
+  end
+
+end

data/examples/rails3/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path("../../config/environment", __FILE__)
+
+def app
+  Rails3::Application
+end

data/examples/sample_deploys/1234/REVISION

@@ -0,0 +1 @@
+1234567890

data/examples/sample_deploys/1234/VERSION

@@ -0,0 +1 @@
+v1.0.0^{}

data/examples/sample_deploys/2341/REVISION

@@ -0,0 +1 @@
+2345678901

data/examples/sample_deploys/2341/VERSION

@@ -0,0 +1 @@
+v1.0.1^{}

data/examples/sample_deploys/3412/REVISION

@@ -0,0 +1 @@
+3456789012

data/examples/sample_deploys/3412/VERSION

@@ -0,0 +1 @@
+v1.1.1^{}

data/examples/sample_deploys/4123/REVISION

@@ -0,0 +1 @@
+4567890123

data/examples/sample_deploys/4123/VERSION

@@ -0,0 +1 @@
+v2.0.0^{}

data/examples/sinatra/.rspec

@@ -0,0 +1,3 @@
+--color
+-fn
+--tty

data/examples/sinatra/Rakefile

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+
+require 'rspec/core/rake_task'
+
+desc "Start the demo using `rackup`"
+task :start do 
+  exec "rackup config.ru"
+end
+
+task default: [:start]
+
+RSpec::Core::RakeTask.new('test:ops') do |test|
+  test.pattern = "spec/functional/*_spec.rb"
+end

data/examples/sinatra/app.rb

@@ -0,0 +1,14 @@
+require 'sinatra/base'
+
+module Demo
+  class App < Sinatra::Base
+    get '/' do
+      "Hello, world. I'm a demo app."
+    end
+
+    get '/test' do
+      "Still me, the demo app."
+    end
+
+  end
+end

data/examples/sinatra/config.ru

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'logger'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+require 'app'
+require 'ops'
+
+use Rack::ShowExceptions
+
+Ops.setup do |config|
+  config.file_root = '../sample_deploys/4123'
+  config.environment = ENV['RACK_ENV']
+end
+
+run Rack::URLMap.new \
+  "/"       => Demo::App.new,
+  "/ops"    => Ops::Server.new

data/examples/sinatra/spec/functional/ops_routes_spec.rb

@@ -0,0 +1,63 @@
+require 'rspec'
+require 'rack/test'
+require 'spec_helper'
+require 'json'
+
+RSpec::Matchers.define :have_content_type do |content_type|
+  CONTENT_HEADER_MATCHER = /^([A-Za-z]+\/[\w\-+\.]+)(;charset=(.*))?/
+
+  chain :with_charset do |charset|
+    @charset = charset
+  end
+
+  match do |response|
+    _, content, _, charset = *content_type_header.match(CONTENT_HEADER_MATCHER).to_a
+
+    if @charset
+      @charset == charset && content == content_type
+    else
+      content == content_type
+    end
+  end
+
+  failure_message_for_should do |response|
+    if @charset
+      "Content type #{content_type_header.inspect} should match #{content_type.inspect} with charset #{@charset}"
+    else
+      "Content type #{content_type_header.inspect} should match #{content_type.inspect}"
+    end
+  end
+
+  failure_message_for_should_not do |model|
+    if @charset
+      "Content type #{content_type_header.inspect} should not match #{content_type.inspect} with charset #{@charset}"
+    else
+      "Content type #{content_type_header.inspect} should not match #{content_type.inspect}"
+    end
+  end
+
+  def content_type_header
+    last_response.headers['Content-Type']
+  end
+end
+
+describe 'routes', :type => :controller do
+  include Rack::Test::Methods
+
+  it 'renders a version page' do
+    get "/ops/version"
+    last_response.should be_ok
+  end
+
+  it 'renders a json version page' do
+    get "/ops/version.json"
+    last_response.should be_ok
+    last_response.should have_content_type('application/json').with_charset('utf-8')
+  end
+
+  it 'renders a heartbeat page' do
+    get "/ops/heartbeat"
+    last_response.should be_ok
+  end
+
+end

data/examples/sinatra/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+def app
+  eval "Rack::Builder.new {( " + File.read(File.dirname(__FILE__) + '/../config.ru') + "\n )}"
+end

data/lib/ops/config.rb

@@ -0,0 +1,43 @@
+module Ops
+  class Config
+    def initialize(data={})
+      @data = {}
+      update!(data)
+    end
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      if value.class == Hash
+        @data[key.to_sym] = Config.new(value)
+      else
+        @data[key.to_sym] = value
+      end
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :config
+
+    def setup
+      self.config ||= Config.new
+      yield config
+    end
+  end
+end

data/lib/ops/heartbeat.rb

@@ -0,0 +1,41 @@
+module Ops
+  class Heartbeat
+    class << self
+      def add(name, &block)
+        instance.add name, &block
+      end
+
+      def check(name)
+        instance.check(name)
+      end
+
+      def instance
+        @singleton ||= new
+      end
+    end
+
+    def heartbeats
+      @heartbeats ||= {}
+    end
+
+    def add(name, &block)
+      heartbeats[name] = block
+    end
+
+    def check(name)
+      begin
+        return heartbeats[name.to_sym].call
+      rescue Exception => e
+        # print stacktrace for error raised by executing block
+        puts "Exception: #{e}\n#{e.backtrace[2..-1].join("\n")}" unless heartbeats[name.to_sym].nil?
+        return false
+      end
+    end
+  end
+
+  class << self
+    def add_heartbeat(name, &block)
+      Heartbeat.add name, &block
+    end
+  end
+end

data/lib/ops/revision.rb

@@ -0,0 +1,117 @@
+module Ops
+  class Revision
+    def initialize(new_headers={}, opts = Ops.config)
+      @file_root = opts.file_root.to_s # convert to string in case they pass us a Pathname
+      @environment = opts.environment
+      @headers = new_headers
+    end
+
+    def version_or_branch
+      @version ||= if version_file?
+                     chomp(version_file).gsub('^{}', '')
+                   elsif development? && `git branch` =~ /^\* (.*)$/
+                     $1
+                   else
+                     'Unknown (VERSION file is missing)'
+                   end
+    end
+
+    def previous_versions
+      @previous_versions ||= get_previous_by_time
+    end
+
+    def get_previous_by_time
+      get_previous_versions.sort { |a, b| a[:time] <=> b[:time] }
+    end
+
+    def get_previous_versions
+      Dir["#{path}/../*"].each_with_object([]) do |dir, array|
+        next if dir =~ /#{current_dir}$/
+        version, revision = File.join(dir, 'VERSION'), File.join(dir, 'REVISION')
+        array << stats_hash(version: version, revision: revision) if File.exists?(version) && File.exists?(revision)
+      end
+    end
+
+    def path
+      File.absolute_path file_root
+    end
+
+    def current_dir
+      file_root.split('/').last
+    end
+
+    def stats_hash(files)
+      { version:  get_version(files[:version]),
+        revision: get_revision(files[:revision]),
+        time:     get_time(files[:revision]) }
+    end
+
+    def get_version(file)
+      chomp(file).gsub('^{}', '')
+    end
+
+    def get_revision(file)
+      chomp file
+    end
+
+    def chomp(file)
+      File.read(file).chomp
+    end
+
+    def get_time(file)
+      File.stat(file).mtime
+    end
+
+    def file_root
+      @file_root
+    end
+
+    def environment
+      @environment
+    end
+
+    def development?
+      environment == 'development'
+    end
+
+    def version_file
+      @version_file ||= File.join(file_root, 'VERSION')
+    end
+
+    def version_file?
+      File.exists? version_file
+    end
+
+    def revision_file
+      @revision_file ||= File.join(file_root, 'REVISION')
+    end
+
+    def revision_file?
+      File.exists? revision_file
+    end
+
+    def deploy_date
+      @deploy_date ||= if version_file?
+                         get_time version_file
+                       elsif development?
+                         'Live'
+                       else
+                         'Unknown (VERSION file is missing)'
+                       end
+    end
+
+    def last_commit
+      @last_commit ||= if revision_file?
+                         chomp revision_file
+                       elsif development? && `git show` =~ /^commit (.*)$/
+                         $1
+                       else
+                         'Unknown (REVISION file is missing)'
+                       end
+    end
+
+    def headers
+      @headers.select{|k,v| k.match(/^[-A-Z_].*$/) }
+    end
+  end
+end

data/lib/ops/server/helpers.rb

@@ -0,0 +1,44 @@
+module Ops
+  module Helpers
+    def hostname
+      @hostname ||= `/bin/hostname` || 'Unknown'
+    end
+
+    def app_name
+      @app_name ||= begin
+                      dirs = Dir.pwd.split('/')
+                      if dirs.last =~ /^\d+$/
+                        dirs[-3]
+                      else
+                        dirs.last
+                      end.sub(/\.com$/, '')
+                    end
+    end
+
+    def version_link(version)
+      github_link 'tree', version
+    end
+
+    def commit_link(commit)
+      github_link 'commit', commit
+    end
+
+    def github_link(resource, subresource)
+      "https://github.com/primedia/#{app_name}/#{resource}/#{subresource}" unless subresource =~ /^Unknown/
+    end
+
+    def print_detail(object, indent = 0)
+      output = ""
+      if object.kind_of? Hash
+        output << "{\n"
+        output << object.collect { |key, value|
+          "  " * indent + "  #{print_detail key} => #{print_detail value, indent+1}"
+        }.join(",\n") << "\n"
+        output << "  " * indent + "}"
+      else
+        output << object.inspect
+      end
+      output
+    end
+  end
+end

data/lib/ops/server/views/layout.html.slim

@@ -0,0 +1,22 @@
+doctype html
+html
+  head
+    title= app_name
+    css:
+      td {padding: 0 5px; vertical-align: top;}
+      pre {margin: 0}
+      tr.even {background: #dddddd;}
+      .container    {font-size: 20px; width: 1000px; padding-bottom: 100px;}
+      .label        {float: left; width: 400px; font-weight: bold}
+      .spacer       {clear: both; padding: 10px;}
+      .value        {float: left; width: 500px; text-align: right;}
+      td {padding: 0 5px}
+      #previous_versions .value {clear: both; width: 1000px; text-align: left;}
+      #previous_versions tr.header td {font-weight: bold}
+      #previous_versions .value tr.even {background: #dddddd;}
+      #headers .value {clear: both; width: 1000px; text-align: left;}
+      #headers .value tr.even {background: #dddddd;}
+      .clear        {clear: both;}
+  body
+    ==yield
+

data/lib/ops/server/views/version.html.slim

@@ -0,0 +1,50 @@
+.container
+  .spacer
+  #version
+    .label= "#{app_name} Version"
+    .value
+      a href=version_link(@version.version_or_branch) = @version.version_or_branch
+  .spacer
+  #date
+    .label Date Deployed
+    .value= @version.deploy_date
+  .spacer
+  #commit
+    .label Last Commit
+    .value
+      a href=commit_link(@version.last_commit) = @version.last_commit
+  .spacer
+  #host
+    .label Host
+    .value= hostname
+  .spacer
+  #environment
+    .label Environment
+    .value= @version.environment
+  .spacer
+  #previous_versions
+    .label Previous Versions
+    .value
+      - unless @previous_versions.empty?
+        table
+          tr.header
+            td Time
+            td Version
+            td Commit
+          - @previous_versions.each_with_index do |version, i|
+            tr class=(i%2==0 ? 'even' : nil)
+              td= version[:time].strftime('%x %X')
+              td
+                a href=version_link(version[:version]) = version[:version]
+              td
+                a href=commit_link(version[:revision]) = version[:revision]
+  .spacer
+  #headers
+    .label Headers
+    .value
+      table
+        - @headers.sort_by{ |h| h.first }.each_with_index do |(header, value), i|
+          tr class=(i%2==0 ? 'even' : nil)
+            td= header
+            td= value
+  .clear

data/lib/ops/server/views/version.json.rabl

@@ -0,0 +1,9 @@
+node :version do
+  @version.version_or_branch
+end
+node :previous_versions do
+  @previous_versions
+end
+node :headers do
+  @headers
+end

data/lib/ops/server.rb

@@ -0,0 +1,45 @@
+require 'sinatra/base'
+require 'sinatra/respond_to'
+require 'ops/server/helpers'
+require 'rabl'
+require 'slim'
+
+module Ops
+  class Server < Sinatra::Base
+    Rabl.register!
+    Server.register Sinatra::RespondTo
+    dir = File.dirname(File.expand_path(__FILE__))
+    set :views,  "#{dir}/server/views"
+    Slim::Engine.set_default_options shortcut: { '#' => 'id', '.' => 'class' }
+
+    helpers Ops::Helpers
+
+    def request_headers
+      env.each_with_object({}) { |(k,v), headers| headers[k] = v }
+    end
+
+    get '/version/?' do
+      @version = Revision.new request_headers
+      @previous_versions = @version.previous_versions
+      @headers = @version.headers
+      respond_to do |wants|
+        wants.html { slim :version }
+        wants.json { render :rabl, :version, format: 'json' }
+      end
+    end
+
+    get '/heartbeat/?' do
+      'OK'
+    end
+
+    get '/heartbeat/:name/?' do
+      name = params[:name]
+      if Heartbeat.check name
+        "#{name} is OK"
+      else
+        status 503
+        "#{name} does not have a heartbeat"
+      end
+    end
+  end
+end

data/lib/ops/version.rb

@@ -0,0 +1,3 @@
+module Ops
+  VERSION = '0.0.1'
+end

data/lib/ops.rb

@@ -0,0 +1,14 @@
+require 'ops/config'
+require 'ops/version'
+require 'ops/revision'
+require 'ops/heartbeat'
+require 'ops/server'
+
+module Ops
+  class << self
+    def new
+      Server.new
+    end
+  end
+end
+

data/ops.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ops/version', __FILE__)
+require 'date'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Pelz-Sherman", "Colin Rymer", "Primedia Team"]
+  gem.email         = ["mpelzsherman@gmail.com", "colin.rymer@gmail.com"]
+  gem.description   = 'This gem provides standardized support for obtaining version and heartbeat information from Sinatra or Rails-based web applications.'
+  gem.summary       = "Provide ops info endpoints."
+  gem.date          = Date.today.to_s
+  gem.homepage      = "http://github.com/primedia/ops"
+  gem.license       = 'MIT'
+  gem.executables   = []
+  gem.files         = `git ls-files | grep -v myapp`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.name          = "ops"
+  gem.require_paths = ["lib"]
+  gem.version       = Ops::VERSION
+  gem.required_ruby_version = '>= 1.9'
+  gem.add_dependency             'oj', '~> 1.4.5'
+  gem.add_dependency             'rabl', '~> 0.7.6'
+  gem.add_dependency             'slim', '~> 1.3.4'
+  gem.add_dependency             'sinatra', '~> 1.3.3'
+  gem.add_dependency             'sinatra-respond_to', '~> 0.8.0'
+end