cronitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1325aef8ddc179aaa172908cfce6f00fe3f4fa6
+  data.tar.gz: ac5be4a04f28f3adf09ea31df6e19f0c38aad83e
+SHA512:
+  metadata.gz: 7ce111c27528f60d5bee4eba5022cd53b7a9c3c0850a5912e321135a1dd8d021f44b06b93c8b5815c27dc1762e7e5c30fb3a940a308d78e987899dc54e5759e3
+  data.tar.gz: ed7571b3ba8bddba5fdf3c9a5c6067b1f370ce1965dcb17a8ebb2e8b35280e8524332004c4e1b8cfe6f509f26e812e31a54482c223b6b294743b2250084b1008

data/.editorconfig

@@ -0,0 +1,18 @@
+; EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+; UTF-8 charset
+; Unix-style newlines with a newline ending every file
+; 4 space indent
+; Trim trailing whitespace
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 4

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eric Herot
+
+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,87 @@
+# Cronitor
+
+[Cronitor](https://cronitor.io/) is a service for heartbeat-style monitoring of just about anything that can send an HTTP request.
+
+This gem provides a simple abstraction for the creation and pinging of a Cronitor monitor. For a better understanding of the API this gem talks to, please see [How Cronitor Works](https://cronitor.io/help/how-cronitor-works).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cronitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cronitor
+
+## Usage
+
+### Creating a Monitor
+
+A Cronitor monitor (hereafter referred to only as a monitor for brevity) is created if it does not already exist, and its ID returned.
+
+```ruby
+require 'cronitor'
+
+monitor_options = {
+    name: 'My Fancy Monitor',
+    notifications: {
+        emails: [],
+        slack: [],
+        pagerduty: [],
+        phones: [],
+        webhooks: []
+    },
+    rules: [
+        {
+            rule_type: 'not_run_in',
+            duration: 5
+            time_unit: 'seconds'
+        }
+    ],
+    note: 'A human-friendly description of this monitor'
+}
+my_monitor = Cronitor.new token: 'api_token', opts: monitor_options
+```
+
+### Pinging a Monitor
+
+Once you’ve created a monitor, you can continue to use the existing instance of the object to ping the monitor that your task status: `run`, `complete`, or `fail`.
+
+```ruby
+my_monitor.run
+my_monitor.complete
+my_monitor.fail 'A short description of the failure'
+```
+
+### Pinging a monitor when you have a Cronitor code
+
+You may already have the code for a monitor, in which case, the expense of `Cronitor.new` may seem unnecessary (since it makes an HTTP request to check if a monitor exists, and you already know it does).
+
+In that case:
+
+```ruby
+my_monitor = Cronitor.new code: 'abcd'
+```
+
+The aforementioned ping methods can now be used.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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
+
+1. Fork it ( https://github.com/evertrue/cronitor/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

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cronitor'
+
+require 'pry'
+Pry.start

data/bin/setup

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

data/cronitor.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cronitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'cronitor'
+  spec.version     = Cronitor::VERSION
+  spec.authors     = ['Jeff Byrnes']
+  spec.email       = ['thejeffbyrnes@gmail.com']
+
+  spec.summary     = 'An interface for the Cronitor API'
+  spec.homepage    = 'https://github.com/evertrue/cronitor'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'unirest', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+end

data/lib/cronitor.rb

@@ -0,0 +1,69 @@
+require 'cronitor/version'
+require 'cronitor/error'
+require 'net/http'
+require 'unirest'
+
+Unirest.default_header 'Accept', 'application/json'
+Unirest.default_header 'Content-Type', 'application/json'
+
+class Cronitor
+  attr_accessor :token, :opts, :code
+  API_URL = 'https://cronitor.io/v1'
+
+  def initialize(token: nil, opts: {}, code: nil)
+    @token = token
+    @opts = opts
+    @code = code
+
+    # TODO Update this to allow for tokenless usage w/ a code for an already
+    # created monitor
+    fail Cronitor::Error, 'Missing Cronitor API token' if token.nil?
+
+    create if code.nil?
+  end
+
+  def create
+    response = Unirest.post(
+      "#{API_URL}/monitors",
+      auth: { user: token },
+      parameters: opts.to_json
+    )
+
+    validate response
+    @code = response.body['code']
+  end
+
+  def validate(response)
+    return if response.code == 200
+    server_error? response
+
+    fail Cronitor::Error, error_msg(response.body)
+  end
+
+  private
+
+  def error_msg(body)
+    msg = []
+
+    body.each do |opt, value|
+      if value.respond_to? 'each'
+        value.each do |error_msg|
+          msg << "#{opt}: #{error_msg}"
+        end
+      else
+        msg << "#{opt}: #{value}"
+      end
+    end
+
+    msg.join ' '
+  end
+
+  def server_error?(response)
+    return unless [301, 302, 500, 502, 503, 504].include? response.code
+
+    fail(
+      Cronitor::Error,
+      "Something else has gone awry. HTTP status: #{response.code}"
+    )
+  end
+end

data/lib/cronitor/error.rb

@@ -0,0 +1,4 @@
+class Cronitor
+  class Error < StandardError
+  end
+end

data/lib/cronitor/version.rb

@@ -0,0 +1,3 @@
+class Cronitor
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: cronitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Byrnes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- thejeffbyrnes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cronitor.gemspec
+- lib/cronitor.rb
+- lib/cronitor/error.rb
+- lib/cronitor/version.rb
+homepage: https://github.com/evertrue/cronitor
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: An interface for the Cronitor API
+test_files: []