service-status 0.0.4

data/README.md

@@ -0,0 +1,80 @@
+# Service::Status
+
+[![Build Status](https://travis-ci.org/TheBookPeople/service-status-ruby.svg)](https://travis-ci.org/TheBookPeople/service-status-ruby) [![Code Climate](https://codeclimate.com/github/TheBookPeople/service-status-ruby/badges/gpa.svg)](https://codeclimate.com/github/TheBookPeople/service-status-ruby) [![Test Coverage](https://codeclimate.com/github/TheBookPeople/service-status-ruby/badges/coverage.svg)](https://codeclimate.com/github/TheBookPeople/service-status-ruby) [![Gem Version](https://badge.fury.io/rb/service-status.svg)](http://badge.fury.io/rb/service-status) [![Gem Dependency](https://img.shields.io/gemnasium/TheBookPeople/service-status-ruby.svg)](https://gemnasium.com/TheBookPeople/service-status-ruby)
+
+
+Provides an object representing the status of a service, suitable for exposing
+as JSON as part of a REST api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'service-status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service-status
+
+## Usage
+
+```ruby
+status = ServiceStatus::Status.new("windows", '3.11', boot_time)
+# boot_time is time the app was started
+
+# check that we can connect to redis
+redis_ok = true
+begin
+	Redis.new.ping
+rescue
+	redis_ok = false
+end
+
+status.add_check('redis', redis_ok)      
+
+JSON.pretty_generate(status)             # render as JSON as required
+```
+## Format
+
+As below. Checks are always part of the 'checks' array. If they have failed,
+they are included in 'errors' as well.
+
+'Status' is either "online" or "offline".
+
+```javascript
+{
+	"name": "windows",
+	"version": "3.11",
+	"hostname": "clippy",
+	"errors": [],
+	"checks": [
+		"redis"
+	],
+	"timestamp": "2015-05-07 14:35:17",
+	"uptime": "14d:23:11:21",
+	"diskusage": "64%",
+	"status": "online"
+}
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/service-status/fork )
+2. git flow init -d (assuming you have git flow)
+2. Create your feature branch (`git flow feature start my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2015 The Book People
+
+See LICENSE (GPLv3)

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/clean'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'service_status/version'
+
+desc 'Run Code quality checks and tests '
+task default: [:clean, :rubocop, :test]
+
+desc 'Run Code quality checks, tests and then create Gem File'
+task build: [:clean, :rubocop, :test, :gem]
+
+CLEAN.include("service-status-#{ServiceStatus::VERSION}.gem")
+CLEAN.include('coverage')
+
+task :test do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.verbose = false
+  end
+
+  Rake::Task['spec'].execute
+end
+
+task :rubocop do
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb']
+    task.fail_on_error = true
+  end
+end
+
+task :gem do
+  system 'gem build service-status.gemspec'
+end

data/lib/service_status/status.rb

@@ -0,0 +1,93 @@
+require 'service_status/version'
+
+require 'pp'
+require 'net/http'
+require 'uri'
+require 'socket'
+require 'sys/filesystem'
+
+module ServiceStatus
+  class Status
+    attr_reader :name, :version, :hostname, :errors, :checks, :timestamp
+
+    def initialize(name, version, boot_time)
+      @boot_time = boot_time
+      @name = name
+      @version = version
+      @hostname = Socket.gethostname
+      @checks = []
+      @timestamp = Time.now.strftime('%Y-%m-%d %T')
+      @errors = []
+    end
+
+    def add_check(name, ok)
+      @checks << name
+      @errors << name unless ok
+    end
+
+    def add_http_get_check(name, url)
+      @checks << name
+      uri = URI(url)
+      begin
+        res = Net::HTTP.get_response(uri)
+        @errors << name unless res.is_a?(Net::HTTPSuccess)
+      rescue
+        @errors << name
+      end
+    end
+
+    def status
+      online? ? 'online' : 'offline'
+    end
+
+    def online?
+      @errors.empty?
+    end
+
+    def uptime
+      total_seconds = Time.now - @boot_time
+      seconds = total_seconds % 60
+      minutes = (total_seconds / 60) % 60
+      hours = total_seconds / (60 * 60)
+      days = total_seconds / (60 * 60 * 24)
+      format('%01dd:%02d:%02d:%02d', days, hours, minutes, seconds)
+    end
+
+    def disk_usage
+      format('%01d%%', (disk_used / disk_size) * 100)
+    end
+
+    # rubocop:disable MethodLength
+    def to_json(*a)
+      {
+        name: name,
+        version: version,
+        hostname: hostname,
+        errors: errors,
+        checks: checks,
+        timestamp: timestamp,
+        uptime: uptime,
+        diskusage: disk_usage,
+        status: status
+      }.to_json(*a)
+    end
+
+    private
+
+    def disk_used
+      disk_size - disk_available
+    end
+
+    def disk_available
+      @blocks_available ||= filesystem.blocks_available.to_f
+    end
+
+    def disk_size
+      @disk_size ||= filesystem.blocks.to_f
+    end
+
+    def filesystem
+      @stats ||= Sys::Filesystem.stat('/')
+    end
+  end
+end

data/lib/service_status/version.rb

@@ -0,0 +1,3 @@
+module ServiceStatus
+  VERSION = '0.0.4'
+end

data/service-status.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service-status'
+  spec.version       = ServiceStatus::VERSION
+  spec.authors       = ['William Griffiths', 'Luke Farrar']
+  spec.email         = ['william.griffiths@thebookpeople.co.uk', 'luke.farrar@thebookpeople.co.uk']
+  spec.summary       = 'Provides a simple JSON service status report.'
+  spec.description   = 'When monitoring REST servers it is useful to have a standard /status page. This gem provides such content.'
+  spec.homepage      = 'https://github.com/TheBookPeople/service-status-ruby'
+  spec.license       = 'GPLv3'
+
+  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.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'sys-filesystem', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'rb-inotify', '~> 0.9'
+  spec.add_development_dependency 'rb-fsevent', '~> 0.9'
+  spec.add_development_dependency 'rb-fchange', '~> 0.0'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6'
+  spec.add_development_dependency 'rubocop', '~> 0.28'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'timecop', '~> 0.7'
+end