checks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a96bdffc59068ee3f1a7dd91c75f25b4de485e21
+  data.tar.gz: b9788c4679a9d252d505bd5d9213aec902a0ac8a
+SHA512:
+  metadata.gz: 72eaa53df7eb13542aa63fb9392bed7f7a156f380f27209b0cf4b0d4d6247ca190fb747fe6a55d7533dfde0cb58bf6cdcdb3b9aee4a1538f22cdbef20519e33b
+  data.tar.gz: 0357c7051a8d18b5d9af9dc9b2cdfe954bfaf5c8818acfd4a0f604df832ab4809191ac4ec83431b5894d54ef6f887e501fbd4d2ccacbce7adf67a5fba8a7cf39

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sutto@sutto.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Darcy Laycock
+
+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,72 @@
+# Checks
+
+Checks is a simple API wrapper for health check services, Ala [healthchecks.io](https://healthchecks.io) and Dead Man's Snitch.
+
+Currently we only support [healthchecks.io](https://healthchecks.io), but we're open to any service you can wish to use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checks
+
+## Usage
+
+Designed for use within Rails, to use, add a file in `config/checks.yml` with roughly the following format:
+
+```YAML
+---
+group:
+  key_a: "uuid-goes-here"
+other:
+  key_b: "uuid-goes-here"
+```
+
+Where `group` and `other` are groups, and each pair underneath is a key combined with a [healthchecks.io](https://healthchecks.io) UUID. It's designed
+to be the id-relevant to the specific healthcehck service.
+
+Then, in your code, to trigger a checkin:
+
+```ruby
+Checks.checkin :other, :key_b
+```
+
+This version will fail silently with an unknown group or key. If you want to to fail with an exception,
+instead use:
+
+```ruby
+Checks.checkin! :other, :key_b
+```
+
+Finally, to invoke a manual specific id (e.g. from code):
+
+```ruby
+Checkins.manual_checkin "my-uuid-here"
+```
+
+Note that currently it is tied to [healthchecks.io](https://healthchecks.io), but the plan is to add support for other services longer term.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gyde-tv/checks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "checks"
+
+# 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/checks.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "checks"
+  spec.version       = Checks::VERSION
+  spec.authors       = ["Darcy Laycock"]
+  spec.email         = ["darcy@gyde.tv"]
+  spec.summary       = %q{Trigger-based Health Check support tools.}
+  spec.description   = %q{Helps provide trigger-based healthcheck support (e.g. for Cron tasks)}
+  spec.homepage      = "https://github.com/gyde-tv/checks"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/checks.rb

@@ -0,0 +1,71 @@
+require 'checks/version'
+require 'singleton'
+require 'net/http'
+
+class Checks
+
+  include Singleton
+
+  attr_accessor :config_path
+
+  class << self
+    def manual_checkin(*args); instance.manual_checkin(*args); end
+    def checkin(*args); instance.checkin(*args); end
+    def checkin!(*args); instance.checkin!(*args); end
+  end
+
+  def initialize
+    self.config_path = defined?(Rails) ? Rails.root : 'config/checks.yml'
+  end
+
+  def config_path=(value)
+    @config_path = value
+    reload!
+  end
+
+  def config
+    @config ||= begin
+      path = config_path.to_s
+      return {} unless ::File.exist?(path)
+      YAML.load_file(path).fetch('checks')
+    end
+  end
+
+  def reload!
+    @config = nil
+    config
+  end
+
+  def checkin(*check)
+    path = path_for *check
+    invoke "http://hchk.io/#{path}" if path
+  end
+
+  def checkin!(*check)
+    path = path_for *check
+    raise ArgumentError.new("unknown check #{check.join(".")}") unless path
+    invoke "http://hchk.io/#{path}"
+  end
+
+  def manual_checkin(path)
+    invoke "http://hchk.io/#{path}"
+  end
+
+  private
+
+  def invoke(url)
+    uri = URI.parse url
+    Net::HTTP.post_form(uri, {})
+  end
+
+  def path_for(*check)
+    return unless check.any?
+    base = config
+    check.each do |path|
+      return nil unless base.is_a?(Hash)
+      base = base[path.to_s]
+    end
+    base
+  end
+
+end

data/lib/checks/version.rb

@@ -0,0 +1,3 @@
+class Checks
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: checks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Helps provide trigger-based healthcheck support (e.g. for Cron tasks)
+email:
+- darcy@gyde.tv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- checks.gemspec
+- lib/checks.rb
+- lib/checks/version.rb
+homepage: https://github.com/gyde-tv/checks
+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: Trigger-based Health Check support tools.
+test_files: []