soar_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f614d97cc6591109387990846914a883667741c6
+  data.tar.gz: 7234baf0bff8e990473996f3b4c9a88d569c59ab
+SHA512:
+  metadata.gz: d643b77bfdedee9637fa4f17b9fc5364e3f4f277559179e125117b0c01a016fff878479df8f9528feb95267e5c935ded2c23ffecc2e2775f6aefca8ac739c6ae
+  data.tar.gz: a42ffb0ab7e98203499367c5744943a637450de0cafa6cc2decc40ccd22ce9441d57f902c631d7224f09e574a13c2f8e55711e60490464ad5684feeb8b4c3ada

data/.gitignore

@@ -0,0 +1,56 @@
+.byebug_history
+*tgz
+left
+test_tfa.sh
+test_production.sh
+iut-list
+juddi-distro-*
+*.swo
+*.zip
+*.tar.gz
+*.swp
+*.gem
+*.rbc
+Gemfile.lock
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/spec/support/certificates/**/*.pem
+/spec/support/certificates/**/*.pkcs12
+/spec/support/certificates/**/index*
+/spec/support/certificates/**/serial*
+/spec/support/certificates/**/crlnumber
+/spec/support/certificates/**/*.jks

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_status

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Barney de Villiers
+
+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,186 @@
+# SoarStatus
+
+This gem provides a functional and detailed status aggregator that allows decoupling of status providers in the SOAR architecture.  Functional and detailed status endpoints can then source the information from this single gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_status'
+```
+
+And then execute:
+
+```bash
+  bundle
+```
+
+Or install it yourself as:
+
+```bash
+  gem install soar_status
+  ```
+
+## Testing
+
+Behavioural driven testing can be performed by testing as follows:
+
+```bash
+  bundle exec rspec -cfd spec/*
+```
+
+## Usage
+
+### Registering release information
+
+Simply register your release information as follow on startup:
+
+```ruby
+SoarStatus::Status.release_commit_hash = '123abc'
+SoarStatus::Status.release_version = '1.2.3'
+```
+
+### Registering environment and configuration information
+
+Simply register your environment and configuration information on startup. Note that any secrets contained in here will also be exposed and must only be used in non-production modes.  
+
+```ruby
+SoarStatus::Status.configuration = @my_configuration
+SoarStatus::Status.environment = @my_environment
+```
+
+### Creating a function status provider
+
+Create/Enhance a class that can provide a functional status of the service. This is done in two parts:
+* The instance must be registered with SoarStatus. This can be done in the initializer as shown below or later by simply passing in a reference to the object.
+* It must provide a method called "functional_status" that will be called (via IOC) by SoarStatus in order to retrieve the functional status.
+
+```ruby
+class ClassThatHasFunctionalStatus
+  def initialize
+    SoarStatus::Status.register_functional_status_provider(self)
+  end
+
+  def functional_status
+    "100"
+  end
+end
+```
+
+### Creating a detailed status provider
+
+Create/Enhance a class that can provide a detailed status of the service. This is done in two parts:
+* The instance must be registered with SoarStatus. This can be done in the initializer as shown below or later by simply passing in a reference to the object.
+* It must provide a method called "detailed_status" that will be called (via IOC) by SoarStatus in order to retrieve the detailed status.
+
+```ruby
+class ClassThatHasDetailedStatus
+  def initialize
+    SoarStatus::Status.register_detailed_status_provider('class_1',self)
+  end
+
+  def detailed_status
+    { 'stuff' => 'from_class1'}
+  end
+end
+```
+
+### Accessing the functional and detailed statuses
+
+All the information can be provided via endpoints in your service.
+
+```ruby
+class Status
+  def serve(request)
+    [200, SoarStatus::Status.functional_status.to_json]
+  end
+end
+
+class StatusDetail
+  def serve(request)
+    [200, SoarStatus::Status.detailed_status.to_json]
+  end
+end
+```
+
+## Detailed example
+
+```ruby
+
+require 'soar_status'
+
+class ClassThatHasFunctionalStatus
+  def initialize
+    SoarStatus::Status.register_functional_status_provider(self)
+    @status = "100"
+  end
+
+  def functional_status
+    @status
+  end
+
+  def set_functional_status(status)
+    @status = status
+  end
+end
+
+class ClassThatHasDetailedStatus1
+  def initialize
+    SoarStatus::Status.register_detailed_status_provider('class_1',self)
+  end
+
+  def detailed_status
+    { 'stuff' => 'from_class1'}
+  end
+end
+
+class ClassThatHasDetailedStatus2
+  def initialize
+    SoarStatus::Status.register_detailed_status_provider('class_2',self)
+  end
+
+  def detailed_status
+    { 'stuff' => 'from_class2'}
+  end
+end
+
+class Main
+  def test_sanity
+    @test_configuration = { 'some' => 'configuration' }
+    @test_environment = { 'some' => 'environment' }
+
+    #registration of release information
+    SoarStatus::Status.release_commit_hash = '123abc'
+    SoarStatus::Status.release_version = '1.2.3'
+
+    #registration of configuration and environment detail
+    SoarStatus::Status.configuration = @test_configuration
+    SoarStatus::Status.environment = @test_environment
+
+    #registration of functional and detailed status providers
+    functional_status_provider = ClassThatHasFunctionalStatus.new
+    detailed_status_provider1 = ClassThatHasDetailedStatus1.new
+    detailed_status_provider2 = ClassThatHasDetailedStatus2.new
+
+    #retrieval of functional status
+    puts "Functional Status: #{SoarStatus::Status.functional_status}"
+
+    #retrieval of detailed status
+    puts "Detailed status: #{SoarStatus::Status.detailed_status}"
+  end
+end
+
+main = Main.new
+main.test_sanity
+
+
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require "bundler/setup"
+require 'soar_status'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soar_status.rb

@@ -0,0 +1,5 @@
+require 'soar_status/version'
+require 'soar_status/status'
+
+module SoarStatus
+end

data/lib/soar_status/status.rb

@@ -0,0 +1,83 @@
+module SoarStatus
+  class Status
+    @@detailed_status_providers = {}
+    @@release_version = ''
+    @@release_commit_hash = ''
+    @@detailed_status_providers = {}
+    @@functional_status_provider = nil
+    @@configuration = {}
+    @@environment = {}
+
+    def self.configuration=(configuration)
+      @@configuration = configuration
+    end
+
+    def self.configuration
+      @@configuration
+    end
+
+    def self.environment=(environment)
+      @@environment = environment
+    end
+
+    def self.environment
+      @@environment
+    end
+
+    def self.release_version=(release_version)
+      @@release_version = release_version
+    end
+
+    def self.release_version
+      @@release_version
+    end
+
+    def self.release_commit_hash=(release_commit_hash)
+      @@release_commit_hash = release_commit_hash
+    end
+
+    def self.release_commit_hash
+      @@release_commit_hash
+    end
+
+    def self.register_detailed_status_provider(name,provider)
+      @@detailed_status_providers[name] = provider
+    end
+
+    def self.register_functional_status_provider(provider)
+      @@functional_status_provider = provider
+    end
+
+    def self.functional_status
+      return @@functional_status_provider.functional_status if @@functional_status_provider
+      'no registered functional status provider'
+    end
+
+    def self.detailed_status
+      {
+        'release' => self.compile_release_information,
+        'configuration' => @@configuration,
+        'environment' => @@environment,
+        'functional' => self.functional_status,
+        'detail' => self.aggregate_detailed_statuses
+      }
+    end
+
+    private
+
+    def self.aggregate_detailed_statuses
+      aggregated_statuses = {}
+      @@detailed_status_providers.each do |name, object|
+        aggregated_statuses[name] = object.detailed_status if object.detailed_status.is_a?(Hash)
+      end
+      aggregated_statuses
+    end
+
+    def self.compile_release_information
+      {
+        'commit_hash' => @@release_commit_hash,
+        'version'     => @@release_version
+      }
+    end
+  end
+end

data/lib/soar_status/version.rb

@@ -0,0 +1,3 @@
+module SoarStatus
+  VERSION = "0.0.1"
+end

data/sanity/.ruby-gemset

@@ -0,0 +1 @@
+sanity

data/sanity/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/sanity/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'soar_status', path: '../'

data/sanity/sanity.rb

@@ -0,0 +1,65 @@
+require 'soar_status'
+
+class ClassThatHasFunctionalStatus
+  def initialize
+    SoarStatus::Status.register_functional_status_provider(self)
+    @status = "100"
+  end
+
+  def functional_status
+    @status
+  end
+
+  def set_functional_status(status)
+    @status = status
+  end
+end
+
+class ClassThatHasDetailedStatus1
+  def initialize
+    SoarStatus::Status.register_detailed_status_provider('class_1',self)
+  end
+
+  def detailed_status
+    { 'stuff' => 'from_class1'}
+  end
+end
+
+class ClassThatHasDetailedStatus2
+  def initialize
+    SoarStatus::Status.register_detailed_status_provider('class_2',self)
+  end
+
+  def detailed_status
+    { 'stuff' => 'from_class2'}
+  end
+end
+
+class Main
+  def test_sanity
+    @test_configuration = { 'some' => 'configuration' }
+    @test_environment = { 'some' => 'environment' }
+
+    #registration of release information
+    SoarStatus::Status.release_commit_hash = '123abc'
+    SoarStatus::Status.release_version = '1.2.3'
+
+    #registration of configuration and environment detail
+    SoarStatus::Status.configuration = @test_configuration
+    SoarStatus::Status.environment = @test_environment
+
+    #registration of functional and detailed status providers
+    functional_status_provider = ClassThatHasFunctionalStatus.new
+    detailed_status_provider1 = ClassThatHasDetailedStatus1.new
+    detailed_status_provider2 = ClassThatHasDetailedStatus2.new
+
+    #retrieval of functional status
+    puts "Functional Status: #{SoarStatus::Status.functional_status}"
+
+    #retrieval of detailed status
+    puts "Detailed status: #{SoarStatus::Status.detailed_status}"
+  end
+end
+
+main = Main.new
+main.test_sanity

data/soar_status.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_status"
+  spec.version       = SoarStatus::VERSION
+  spec.authors       = ["Barney de Villiers"]
+  spec.email         = ["barney.de.villiers@hetzner.co.za"]
+
+  spec.summary       = %q{Status aggregation for service components}
+  spec.description   = %q{Status aggregation for service components in order to publish detailed aggregated status}
+  spec.homepage      = "https://github.com/hetznerZA/soar_status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "byebug", "~> 9"
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: soar_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barney de Villiers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: Status aggregation for service components in order to publish detailed
+  aggregated status
+email:
+- barney.de.villiers@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_status.rb
+- lib/soar_status/status.rb
+- lib/soar_status/version.rb
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+- soar_status.gemspec
+homepage: https://github.com/hetznerZA/soar_status
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Status aggregation for service components
+test_files: []