rack-ecg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15da50402ccd3b3dcc2efab39fcdfde5a320931f
+  data.tar.gz: b0ee8b09dd75d9f25796c70a31e7477c320c38e7
+SHA512:
+  metadata.gz: 8da335a59221c75231ca7bc618748c59a2926a4a3a15326ff0246a10b19b1bcd7e2f118218f78f80adcacb65d2b4b8420f4843373805470f1fdcc77635b9a4bd
+  data.tar.gz: ba2660ec5a305e5758cee866aa0c8e466256209b82d8ad8999742b00deb739a5b8fde4cfa9a8a3153f329c2a91142273a1785e8642a84f2d58db9604ae1d4b98

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+  - ruby-head
+  - jruby
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/b627d6a74f88be59d0b9
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false - rbx-2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-ecg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Envato
+
+MIT License
+
+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,171 @@
+# Rack::ECG
+
+An easy to configure Rack middleware for Ruby web apps to provide a simple
+health check endpoint that tells you vital life signs about your app. All
+without the boilerplate service checking code you've written 10 times before.
+
+(it's ECG as in electrocardiogram - as in the machine that monitors how your
+heart works)
+
+## Features
+- simple 1 line to drop into your `config.ru` or `config/application.rb` file to
+  set up
+- reports git revision status
+- reports ActiveRecord migration schema version
+- reports errors if any check can't be executed for whatever reason
+- JSON output
+
+## Development Status [![travis ci build](https://api.travis-ci.org/envato/rack-ecg.svg)](https://travis-ci.org/envato/rack-ecg)
+
+`Rack::ECG` is extracted from production code in use at
+[Envato](http://envato.com). However, it is undergoing early development, and
+APIs and features are almost certain to be in flux.
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-ecg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-ecg
+
+### Rails
+
+In Rails you can add `Rack::ECG` to your `config/application.rb` as a middleware
+
+```ruby
+# config/application.rb
+# ...
+config.middleware.use Rack::ECG
+# ...
+```
+
+### Rack
+
+In Rack apps, you can add `Rack::ECG` to your `config.ru`
+
+```ruby
+# config.ru
+require 'rack/ecg'
+
+use Rack::ECG
+
+run MyRackApp
+```
+
+You can now hit your app and get a basic health check response from `Rack::ECG`
+
+```
+$ curl http://localhost:9292/_ecg
+{
+  "http": {
+    "status": "ok",
+    "value": "online"
+  }
+}
+```
+
+`/_ecg` will return a `200` HTTP status if all the checks are OK, or `500`
+status if any of the checks fail.
+
+
+## Configuration
+
+There are options that can be passed to `use Rack::ECG` to customise how it
+works.
+
+### `checks`
+Out of the box `Rack::ECG` doesn't do much and just checks that
+HTTP responses can be returned. There are a number of built in checks that
+`Rack::ECG` can be told to do (more to come)
+- `:git_revision` - this assumes your code is deployed via git and exists in a
+  git repo, and that the `git` command can access it
+- `:migration_version` - this assumes you are using ActiveRecord migrations. It
+  queries the `schema_versions` table and tells you what version the database is
+at.
+
+So using `git_revision` and `migration_version` would look like:
+
+```ruby
+use Rack::ECG, checks: [:git_revision, :migration_version]
+```
+
+```
+$ curl http://localhost:9292/_ecg
+{
+  "http": {
+    "status": "ok",
+    "value": "online"
+  },
+  "git_revision": {
+    "status": "ok",
+    "value": "fb16e2c3b88af671c42880e6977bba34d7b05ba6\n"
+  },
+  "migration_version": {
+    "status": "ok",
+    "value": "20150319050250"
+  }
+}
+```
+
+### `at`
+
+By default `Rack::ECG` is mapped to a URL of `/_ecg`, you can set this to
+a different path by setting the `at` option. e.g.
+
+```ruby
+use Rack::ECG, at: "/health_check"
+```
+
+More examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/master/examples)
+
+## Requirements
+- Ruby >= 1.9.3 (this may be increased to Ruby >= 2.0 if it makes sense to use
+  Ruby 2.0 features)
+- Rack
+- To use optional `git_revision` check, your deployed code needs to be in a git repo, and
+`git` command must be accessible on the server
+- To use optional `migration_version` check, you must be using ActiveRecord and
+migrations stored in `schema_versions` table
+
+## Contact
+
+- [github project](https://github.com/envato/rack-ecg)
+- [gitter chat room ![Join the chat at
+  https://gitter.im/envato/rack-ecg](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/envato/rack-ecg)
+- Bug reports and feature requests are via [github issues](https://github.com/envato/rack-ecg/issues)
+
+## Maintainers
+
+- [Julian Doherty](https://github.com/madlep)
+
+## License
+
+`Rack::ECG` uses MIT license. See
+[`LICENSE.txt`](https://github.com/envato/rack-ecg/blob/master/LICENSE.txt) for
+details.
+
+## Code of conduct
+
+We welcome contribution from everyone. Read more about it in
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/rack-ecg/blob/master/CODE_OF_CONDUCT.md)
+
+## Contributing
+
+For bug fixes, documentation changes, and small features:
+
+1. Fork it ( https://github.com/[my-github-username]/rack-ecg/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
+
+For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/basic.ru

@@ -0,0 +1,6 @@
+require 'rack/ecg'
+
+use Rack::ECG
+use Rack::Reloader
+
+run -> (env) { [200, {}, ["Hello, World"]] }

data/examples/checks.ru

@@ -0,0 +1,6 @@
+require 'rack/ecg'
+
+use Rack::ECG, checks: [:git_revision, :migration_version]
+use Rack::Reloader
+
+run -> (env) { [200, {}, ["Hello, World"]] }

data/examples/mounted_path.ru

@@ -0,0 +1,6 @@
+require 'rack/ecg'
+
+use Rack::ECG, at: "/health_check"
+use Rack::Reloader
+
+run -> (env) { [200, {}, ["Hello, World"]] }

data/lib/rack-ecg.rb

@@ -0,0 +1 @@
+require 'rack/ecg'

data/lib/rack/ecg.rb

@@ -0,0 +1,80 @@
+require "rack/ecg/version"
+require "json"
+require "open3"
+
+module Rack
+  class ECG
+    DEFAULT_MOUNT_AT = "/_ecg"
+    DEFAULT_CHECKS = [ :check_http ]
+
+    def initialize(app, options={})
+      @app = app
+      option_checks = options.delete(:checks) || []
+      option_checks = option_checks.map{|check| "check_#{check}".to_sym }
+      @checks = DEFAULT_CHECKS + option_checks
+      @at = options.delete(:at) || DEFAULT_MOUNT_AT
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == @at
+
+        check_results = @checks.inject({}){|results, check_method| results.merge(send(check_method)) }
+
+        response_status = check_results.any?{|check| check[1][:status] == "error" } ? 500 : 200
+
+        response_headers = {
+          "X-Rack-ECG-Version"  => Rack::ECG::VERSION,
+          "Content-Type"        => "application/json"
+        }
+
+        response_body = JSON.pretty_generate(check_results)
+
+        [response_status, response_headers, [response_body]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+    def check_http
+      # if rack-ecg is serving a request - http is obviously working so far...
+      # this is basically a "hello-world"
+      {http: {status: "ok", value: "online" } }
+    end
+
+    def check_error
+      # this always fails. mainly for testing
+      {error: {status: "error", value: "PC LOAD LETTER" } }
+    end
+
+    def check_git_revision
+      _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
+
+      success = wait_thread.value.success?
+      status = success ? "ok" : "error"
+      value = success ? stdout.read : stderr.read
+      value = value.strip
+      {git_revision: {status: status, value: value} }
+    end
+
+    def check_migration_version
+      value = ""
+      status = "ok"
+      begin
+        if defined?(ActiveRecord)
+          connection = ActiveRecord::Base.connection
+          result_set = connection.execute("select max(version) as version from schema_migrations")
+          version = result_set.first
+          value = version["version"]
+        else
+          status = "error"
+          value = "ActiveRecord not found"
+        end
+      rescue => e
+        status = "error"
+        value = e.message
+      end
+      {migration_version: {status: status, value: value} }
+    end
+  end
+end

data/lib/rack/ecg/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ECG
+    VERSION = "0.0.1"
+  end
+end

data/rack-ecg.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/ecg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-ecg"
+  spec.version       = Rack::ECG::VERSION
+  spec.authors       = ["Envato", "Julian Doherty"]
+  spec.email         = ["julian@envato.com"]
+  spec.summary       = %q{Rack middleware serving a health check page}
+  spec.description   = %q{rack-ecg allows you to serve a page that shows you facts about your deployed app to allow you to check that everything is running as it should: git revision, database migrations, and more}
+  spec.homepage      = "https://github.com/envato/rack-ecg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+end

data/spec/rack_middleware_spec.rb

@@ -0,0 +1,146 @@
+require "open3"
+require "stringio"
+
+RSpec.describe "when used as middleware" do
+  let(:app) {
+    opts = options
+    Rack::Builder.new do
+      use Rack::ECG, opts
+      run lambda {|env|
+        if env["PATH_INFO"] == "/hello/world"
+          [200, {}, ["Hello, World"]]
+        else
+          [404, {}, ["Goodbye, World"]]
+        end
+      }
+    end
+  }
+  let(:options) {
+    {} # empty default
+  }
+
+  context "main app" do
+    it "responds OK for normal requests" do
+      get "/hello/world"
+      expect(last_response).to be_ok
+    end
+
+    it "doesn't include an X-Rack-ECG-Version custom header" do
+      get "/hello/world"
+      expect(last_response.header["X-Rack-ECG-Version"]).to be_nil
+    end
+  end
+
+  context "ecg app" do
+    it "responds " do
+      get "/_ecg"
+      expect(last_response).to be_ok
+    end
+
+    it "includes an X-Rack-ECG-Version custom header" do
+      get "/_ecg"
+      expect(last_response.header["X-Rack-ECG-Version"]).to eq(Rack::ECG::VERSION)
+    end
+
+    context "when `at` config option is set" do
+      let(:options) {
+        {at: "/health_check"}
+      }
+
+      it "responds from that path" do
+        get "/health_check"
+        expect(last_response.header["X-Rack-ECG-Version"]).to eq(Rack::ECG::VERSION)
+      end
+    end
+
+    context "when all checks pass" do
+      it "has a success error code" do
+        get "_ecg"
+        expect(last_response.status).to eq(200)
+      end
+    end
+
+    context "when a checks errors" do
+      let(:options) {
+        { checks: [:error] }
+      }
+      it "has a success error code" do
+        get "_ecg"
+        expect(last_response.status).to eq(500)
+      end
+    end
+
+    context "git revision" do
+      let(:options) {
+        { checks: [:git_revision] }
+      }
+      context "when available" do
+        let(:sha) { "cafe1234" }
+        it "is reported" do
+          expect(Open3).to receive(:popen3).
+            with("git rev-parse HEAD").
+            and_return([
+              nil,                                                    # stdin
+              StringIO.new(sha + "\n"),                               # stdout
+              StringIO.new(),                                         # stderr
+              double(value: double(Process::Status, success?: true))  # wait thread & process status
+            ])
+          get "/_ecg"
+          expect(json_body["git_revision"]["status"]).to eq("ok")
+          expect(json_body["git_revision"]["value"]).to eq(sha)
+        end
+      end
+
+      context "when not available" do
+        let(:error_message) { "git had a sad" }
+        it "is reported" do
+          expect(Open3).to receive(:popen3).
+            with("git rev-parse HEAD").
+            and_return([
+              nil,                                                    # stdin
+              StringIO.new(),                                         # stdout
+              StringIO.new(error_message + "\n"),                     # stderr
+              double(value: double(Process::Status, success?: false)) # wait thread & process status
+            ])
+          get "/_ecg"
+          expect(json_body["git_revision"]["status"]).to eq("error")
+          expect(json_body["git_revision"]["value"]).to eq("git had a sad")
+        end
+      end
+    end
+
+    context "migration version" do
+      let(:options) {
+        { checks: [:migration_version] }
+      }
+      context "when availabile" do
+        it "is reported" do
+          class ActiveRecord
+            class Base
+              def self.connection
+              end
+            end
+          end
+          version = "123456"
+          connection = double("connection")
+          expect(ActiveRecord::Base).to receive(:connection).and_return(connection)
+          expect(connection).to receive(:execute).
+            with("select max(version) as version from schema_migrations").
+            and_return([{"version" => version}])
+          get "/_ecg"
+          expect(json_body["migration_version"]["status"]).to eq("ok")
+          expect(json_body["migration_version"]["value"]).to eq(version)
+        end
+      end
+
+      context "when not available" do
+        it "is reported" do
+          Object.send(:remove_const, :ActiveRecord) if defined?(ActiveRecord)
+          get "/_ecg"
+          expect(json_body["migration_version"]["status"]).to eq("error")
+          expect(json_body["migration_version"]["value"]).to eq("ActiveRecord not found")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'rack/test'
+require 'rack/ecg'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.include Rack::Test::Methods
+
+  def json_body
+    @json_body ||= JSON.parse(last_response.body)
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rack-ecg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Envato
+- Julian Doherty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: 'rack-ecg allows you to serve a page that shows you facts about your
+  deployed app to allow you to check that everything is running as it should: git
+  revision, database migrations, and more'
+email:
+- julian@envato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/basic.ru
+- examples/checks.ru
+- examples/mounted_path.ru
+- lib/rack-ecg.rb
+- lib/rack/ecg.rb
+- lib/rack/ecg/version.rb
+- rack-ecg.gemspec
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/envato/rack-ecg
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rack middleware serving a health check page
+test_files:
+- spec/rack_middleware_spec.rb
+- spec/spec_helper.rb